diff --git a/src/rougail/output_doc/__init__.py b/src/rougail/output_doc/__init__.py index a6e7109..9fa2e9c 100644 --- a/src/rougail/output_doc/__init__.py +++ b/src/rougail/output_doc/__init__.py @@ -1,4 +1,3 @@ -#!/usr/bin/env python3 """ Silique (https://www.silique.fr) Copyright (C) 2024 @@ -16,706 +15,7 @@ details. You should have received a copy of the GNU Lesser General Public License along with this program. If not, see . """ -# FIXME si plusieurs example dont le 1er est none tester les autres : tests/dictionaries/00_8test_none -from tiramisu import Calculation -from tiramisu.error import display_list, ConfigError -import tabulate as tabulate_module -from tabulate import tabulate -from warnings import warn -from typing import Optional - -from rougail.error import display_xmlfiles -from rougail import RougailConfig, Rougail, CONVERT_OPTION -from rougail.object_model import PROPERTY_ATTRIBUTE - -from .config import OutPuts -from .i18n import _ - -ENTER = "\n\n" - - -DocTypes = { - "domainname": { - "params": { - "allow_startswith_dot": _("the domain name can starts by a dot"), - "allow_without_dot": _("the domain name can be a hostname"), - "allow_ip": _("the domain name can be an IP"), - "allow_cidr_network": _("the domain name can be network in CIDR format"), - }, - }, - "number": { - "params": { - "min_number": _("the minimum value is {0}"), - "max_number": _("the maximum value is {0}"), - }, - }, - "ip": { - "msg": "IP", - "params": { - "cidr": _("IP must be in CIDR format"), - "private_only": _("private IP are allowed"), - "allow_reserved": _("reserved IP are allowed"), - }, - }, - "hostname": { - "params": { - "allow_ip": _("the host name can be an IP"), - }, - }, - "web_address": { - "params": { - "allow_ip": _("the domain name in web address can be an IP"), - "allow_without_dot": _( - "the domain name in web address can be only a hostname" - ), - }, - }, - "port": { - "params": { - "allow_range": _("can be range of port"), - "allow_protocol": _("can have the protocol"), - "allow_zero": _("port 0 is allowed"), - "allow_wellknown": _("ports 1 to 1023 are allowed"), - "allow_registred": _("ports 1024 to 49151 are allowed"), - "allow_private": _("ports greater than 49152 are allowed"), - }, - }, - "secret": { - "params": { - "min_len": _("minimum length for the secret"), - "max_len": _("maximum length for the secret"), - }, - }, -} - - -ROUGAIL_VARIABLE_TYPE = ( - "https://rougail.readthedocs.io/en/latest/variable.html#variables-types" -) - - -class RougailOutputDoc: - def __init__( - self, - *, - config: "Config" = None, - rougailconfig: RougailConfig = None, - **kwarg, - ): - if rougailconfig is None: - rougailconfig = RougailConfig - if rougailconfig["step.output"] != "doc": - rougailconfig["step.output"] = "doc" - if rougailconfig["step.output"] != "doc": - raise Exception("doc is not set as step.output") - self.rougailconfig = rougailconfig - outputs = OutPuts().get() - output = self.rougailconfig["doc.output_format"] - if output not in outputs: - raise Exception( - f'cannot find output "{output}", available outputs: {list(outputs)}' - ) - if config is None: - rougail = Rougail(self.rougailconfig) - rougail.converted.plugins.append("output_doc") - config = rougail.run() - self.conf = config - self.conf.property.setdefault(frozenset({"advanced"}), "read_write", "append") - self.conf.property.read_write() - self.conf.property.remove("cache") - self.dynamic_paths = {} - self.formater = outputs[output]() - self.level = self.rougailconfig["doc.title_level"] - # self.property_to_string = [('mandatory', 'obligatoire'), ('hidden', 'cachée'), ('disabled', 'désactivée'), ('unique', 'unique'), ('force_store_value', 'modifié automatiquement')] - self.property_to_string = [ - ("mandatory", _("mandatory")), - ("hidden", _("hidden")), - ("disabled", _("disabled")), - ("unique", _("unique")), - ("force_store_value", _("auto modified")), - ] - - def run(self): - print(self.gen_doc()) - - def gen_doc(self): - tabulate_module.PRESERVE_WHITESPACE = True - examples_mini = {} - examples_all = {} - return_string = self.formater.header() - if self.rougailconfig["main_namespace"]: - for namespace in self.conf.unrestraint.list(): - name = namespace.name() - examples_mini[name] = {} - examples_all[name] = {} - doc = ( - self._display_doc( - self.display_families( - namespace, - self.level + 1, - examples_mini[name], - examples_all[name], - ), - [], - ) - + "\n" - ) - if not examples_mini[name]: - del examples_mini[name] - if not examples_all[name]: - del examples_all[name] - else: - return_string += self.formater.title( - _('Variables for "{0}"').format(namespace.name()), self.level - ) - return_string += doc - else: - doc = ( - self._display_doc( - self.display_families( - self.conf.unrestraint, - self.level + 1, - examples_mini, - examples_all, - ), - [], - ) - + "\n" - ) - if examples_all: - return_string += self.formater.title(_("Variables"), self.level) - return_string += doc - if not examples_all: - return "" - if self.rougailconfig["doc.with_example"]: - if examples_mini: - return_string += self.formater.title( - _("Example with mandatory variables not filled in"), self.level - ) - return_string += self.formater.yaml(examples_mini) - if examples_all: - return_string += self.formater.title( - _("Example with all variables modifiable"), self.level - ) - return_string += self.formater.yaml(examples_all) - return return_string - - def _display_doc(self, variables, add_paths): - return_string = "" - for variable in variables: - typ = variable["type"] - path = variable["path"] - if path in add_paths: - continue - if typ == "family": - return_string += variable["title"] - return_string += self._display_doc(variable["objects"], add_paths) - else: - for idx, path in enumerate(variable["paths"]): - if path in self.dynamic_paths: - paths_msg = display_list( - [ - self.formater.bold(path_) - for path_ in self.dynamic_paths[path]["paths"] - ], - separator="or", - ) - variable["objects"][idx][0] = variable["objects"][idx][ - 0 - ].replace("{{ ROUGAIL_PATH }}", paths_msg) - identifiers = self.dynamic_paths[path]["identifiers"] - description = variable["objects"][idx][1][0] - if "{{ identifier }}" in description: - if description.endswith("."): - description = description[:-1] - comment_msg = self.to_phrase( - display_list( - [ - description.replace( - "{{ identifier }}", - self.formater.italic(identifier), - ) - for identifier in identifiers - ], - separator="or", - add_quote=True, - ) - ) - variable["objects"][idx][1][0] = comment_msg - variable["objects"][idx][1] = self.formater.join( - variable["objects"][idx][1] - ) - return_string += ( - self.formater.table( - tabulate( - variable["objects"], - headers=self.formater.table_header( - ["Variable", "Description"] - ), - tablefmt=self.formater.name, - ) - ) - + "\n\n" - ) - add_paths.append(path) - return return_string - - def is_hidden(self, child): - properties = child.property.get(uncalculated=True) - for hidden_property in ["hidden", "disabled", "advanced"]: - if hidden_property in properties: - return True - return False - - def display_families( - self, - family, - level, - examples_mini, - examples_all, - ): - variables = [] - for child in family.list(): - if self.is_hidden(child): - continue - if not child.isoptiondescription(): - if child.isfollower() and child.index() != 0: - # only add to example - self.display_variable( - child, - examples_mini, - examples_all, - ) - continue - path = child.path(uncalculated=True) - if child.isdynamic(): - self.dynamic_paths.setdefault( - path, {"paths": [], "identifiers": []} - )["paths"].append(child.path()) - self.dynamic_paths[path]["identifiers"].append( - child.identifiers()[-1] - ) - if not variables or variables[-1]["type"] != "variables": - variables.append( - { - "type": "variables", - "objects": [], - "path": path, - "paths": [], - } - ) - variables[-1]["objects"].append( - self.display_variable( - child, - examples_mini, - examples_all, - ) - ) - variables[-1]["paths"].append(path) - else: - name = child.name() - if child.isleadership(): - examples_mini[name] = [] - examples_all[name] = [] - else: - examples_mini[name] = {} - examples_all[name] = {} - variables.append( - { - "type": "family", - "title": self.display_family( - child, - level, - ), - "path": child.path(uncalculated=True), - "objects": self.display_families( - child, - level + 1, - examples_mini[name], - examples_all[name], - ), - } - ) - if not examples_mini[name]: - del examples_mini[name] - if not examples_all[name]: - del examples_all[name] - return variables - - def display_family( - self, - family, - level, - ): - if family.name() != family.description(uncalculated=True): - title = f"{family.description(uncalculated=True)}" - else: - warning = f'No attribute "description" for family "{family.path()}" in {display_xmlfiles(family.information.get("dictionaries"))}' - warn(warning) - title = f"{family.path()}" - isdynamic = family.isdynamic(only_self=True) - if isdynamic: - identifiers = family.identifiers(only_self=True) - if "{{ identifier }}" in title: - title = display_list( - [ - title.replace( - "{{ identifier }}", self.formater.italic(identifier) - ) - for identifier in identifiers - ], - separator="or", - add_quote=True, - ) - msg = self.formater.title(title, level) - subparameter = [] - self.manage_properties(family, subparameter) - if subparameter: - msg += self.subparameter_to_string(subparameter) + ENTER - comment = [] - 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 - if family.isleadership(): - 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): - identifiers = self.to_string(family, "dynamic") - if isinstance(identifiers, list): - for idx, val in enumerate(identifiers): - if not isinstance(val, Calculation): - continue - identifiers[idx] = self.to_string(family, "dynamic", f"_{idx}") - identifiers = self.formater.list(identifiers) - 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( - self, - variable, - subparameter, - ): - properties = variable.property.get(uncalculated=True) - for mode in self.rougailconfig["modes_level"]: - if mode in properties: - subparameter.append((mode, None, None, None)) - break - for prop, msg in self.property_to_string: - if prop in properties: - subparameter.append((msg, None, None, None)) - elif variable.information.get(f"{prop}_calculation", False): - subparameter.append((msg, msg, self.to_string(variable, prop), None)) - - def subparameter_to_string( - self, - subparameter, - ): - subparameter_str = "" - for param in subparameter: - if param[3]: - subparameter_str += self.formater.link(param[0], param[3]) + " " - else: - if param[1]: - italic = True - else: - italic = False - subparameter_str += self.formater.prop(param[0], italic) + " " - - return subparameter_str[:-1] - - def subparameter_to_parameter( - self, - subparameter, - comment, - ): - for param in subparameter: - if not param[1]: - continue - msg = param[2] - comment.append(f"{self.formater.bold(param[1].capitalize())}: {msg}") - - def to_phrase(self, msg): - if not msg: - return "" - msg = str(msg).strip() - if not msg.endswith("."): - msg += "." - return msg[0].upper() + msg[1:] - - def display_variable( - self, - variable, - examples_mini, - examples_all, - ): - if variable.isdynamic(): - parameter = ["{{ ROUGAIL_PATH }}"] - else: - 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.extend(help_.split("\n")) - subparameter = [] - self.type_to_string( - variable, - subparameter, - comment, - ) - self.manage_properties( - variable, - subparameter, - ) - if variable.ismulti(): - multi = not variable.isfollower() or variable.issubmulti() - else: - multi = False - if multi: - subparameter.append(("multiple", None, None, None)) - if subparameter: - parameter.append(self.subparameter_to_string(subparameter)) - if variable.name() == description: - 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, - comment, - ) - default_in_choices = False - if variable.information.get("type") == "choice": - choices = variable.value.list(uncalculated=True) - if isinstance(choices, Calculation): - choices = self.to_string(variable, "choice") - if isinstance(choices, list): - for idx, val in enumerate(choices): - if not isinstance(val, Calculation): - if default is not None and val == default: - choices[idx] = str(val) + " ← " + _("(default)") - default_in_choices = True - continue - choices[idx] = self.to_string(variable, "choice", f"_{idx}") - choices = self.formater.list(choices) - comment.append(f'{self.formater.bold(_("Choices"))}: {choices}') - # choice - if default is not None and not default_in_choices: - comment.append(f"{self.formater.bold(_('Default'))}: {default}") - self.manage_exemples( - multi, - variable, - examples_all, - examples_mini, - comment, - ) - self.subparameter_to_parameter(subparameter, comment) - self.formater.columns(parameter, comment) - return [self.formater.join(parameter), comment] - - def get_default( - self, - variable, - comment, - ): - if variable.information.get("fake_default", False): - default = None - else: - default = variable.value.get(uncalculated=True) - if default in [None, []]: - default = self.to_string(variable, "default", do_not_raise=True) - if isinstance(default, Calculation): - default = self.to_string(variable, "default") - if isinstance(default, list): - for idx, val in enumerate(default): - if not isinstance(val, Calculation): - continue - default[idx] = self.to_string(variable, "default", f"_{idx}") - default = self.formater.list(default) - return default - - def to_string( - self, - variable, - prop, - identifier="", - do_not_raise=False, - ): - calculation_type = variable.information.get( - f"{prop}_calculation_type{identifier}", None - ) - if not calculation_type: - if do_not_raise: - return - 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 - ): - return - calculation = variable.information.get(f"{prop}_calculation{identifier}") - if calculation_type == "jinja": - if calculation is not True: - 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")), - ) - warn(warning) - elif calculation_type == "variable": - if prop in PROPERTY_ATTRIBUTE: - values = self.formater.to_string(calculation) - else: - values = _('the value of the variable "{0}"').format(calculation) - elif calculation_type == "identifier": - if prop in PROPERTY_ATTRIBUTE: - values = self.formater.to_string(calculation) - else: - values = _("the value of the identifier") - elif calculation_type == "information": - values = calculation - else: - values = _("the value of the {0}").format(calculation_type) - if not values.endswith("."): - values += "." - return values - - def type_to_string( - self, - variable, - subparameter, - comment, - ): - variable_type = variable.information.get("type") - doc_type = DocTypes.get(variable_type, {"params": {}}) - subparameter.append( - ( - doc_type.get("msg", variable_type), - None, - None, - ROUGAIL_VARIABLE_TYPE, - ) - ) - option = variable.get() - validators = [] - for param, msg in doc_type["params"].items(): - value = option.impl_get_extra(f"_{param}") - if value is None: - value = option.impl_get_extra(param) - if value is not None and value is not False: - validators.append(msg.format(value)) - valids = [ - name - for name in variable.information.list() - if name.startswith("validators_calculation_type_") - ] - if valids: - for idx in range(len(valids)): - validators.append( - self.to_string( - variable, - "validators", - f"_{idx}", - ) - ) - if validators: - if len(validators) == 1: - comment.append( - self.formater.bold(_("Validator")) + _(": ") + validators[0] - ) - else: - comment.append( - self.formater.bold(_("Validators")) - + _(": ") - + self.formater.list(validators) - ) - - def manage_exemples( - self, - multi, - variable, - examples_all, - examples_mini, - comment, - ): - example_mini = None - example_all = None - example = variable.information.get("examples", None) - if example is None: - example = variable.information.get("test", None) - try: - default = variable.value.get() - except ConfigError: - default = None - if isinstance(example, tuple): - example = list(example) - mandatory = "mandatory" in variable.property.get( - uncalculated=True - ) and not variable.value.get(uncalculated=True) - if example: - if not multi: - example = example[0] - title = _("Example") - if mandatory: - example_mini = example - example_all = example - else: - if mandatory: - example_mini = "\n - example" - example_all = example - len_test = len(example) - example = self.formater.list(example) - if len_test > 1: - title = _("Examples") - else: - title = _("Example") - comment.append(f"{self.formater.bold(title)}: {example}") - elif default not in [None, []]: - example_all = default - else: - example = CONVERT_OPTION.get(variable.information.get("type"), {}).get( - "example", None - ) - if example is None: - example = "xxx" - if multi: - example = [example] - if mandatory: - example_mini = example - example_all = example - if variable.isleader(): - if example_mini is not None: - for mini in example_mini: - examples_mini.append({variable.name(): mini}) - if example_all is not None: - for mall in example_all: - examples_all.append({variable.name(): mall}) - elif variable.isfollower(): - if example_mini is not None: - for idx in range(0, len(examples_mini)): - examples_mini[idx][variable.name()] = example_mini - if example_all is not None: - for idx in range(0, len(examples_all)): - examples_all[idx][variable.name()] = example_all - else: - if example_mini is not None: - examples_mini[variable.name()] = example_mini - examples_all[variable.name()] = example_all +from .doc import RougailOutputDoc RougailOutput = RougailOutputDoc diff --git a/src/rougail/output_doc/annotator.py b/src/rougail/output_doc/annotator.py index c8d4f2a..a6b5398 100644 --- a/src/rougail/output_doc/annotator.py +++ b/src/rougail/output_doc/annotator.py @@ -20,11 +20,12 @@ along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA """ +from typing import Union + from tiramisu import undefined from rougail.annotator.variable import Walk from rougail.output_doc.i18n import _ -from rougail.error import DictConsistencyError from rougail.object_model import ( Calculation, JinjaCalculation, @@ -37,6 +38,7 @@ from rougail.object_model import ( CONVERT_OPTION, PROPERTY_ATTRIBUTE, ) +from rougail.output_doc.utils import dump class Annotator(Walk): @@ -47,7 +49,7 @@ class Annotator(Walk): def __init__( self, objectspace, - *args, + *args, # pylint: disable=unused-argument ) -> None: if not objectspace.paths: return @@ -55,45 +57,6 @@ class Annotator(Walk): self.populate_family() self.populate_variable() - def get_examples_values(self, variable): - values = self.objectspace.informations.get(variable.path).get("examples", None) - if not values: - values = self.objectspace.informations.get(variable.path).get("test", None) - if isinstance(values, tuple): - values = list(values) - return values - - def add_default_value( - self, - family, - value, - *, - inside_list=False, - ) -> None: - if isinstance(value, Calculation): - default_values = "example" - if not inside_list: - default_values = [default_values] - if isinstance(value, (VariableCalculation, VariablePropertyCalculation)): - variable, identifier = self.objectspace.paths.get_with_dynamic( - value.variable, - value.path_prefix, - family.path, - value.version, - value.namespace, - value.xmlfiles, - ) - if variable: - values = self.get_examples_values(variable) - else: - values = None - if values: - if inside_list: - default_values = list(values) - else: - default_values = values - value.default_values = default_values - def populate_family(self) -> None: """Set doc, path, ... to family""" for family in self.get_families(): @@ -104,10 +67,10 @@ class Annotator(Walk): if family.type != "dynamic": continue if not isinstance(family.dynamic, list): - self.add_default_value(family, family.dynamic) + self.dynamic_values(family, family.dynamic) else: for value in family.dynamic: - self.add_default_value(family, value, inside_list=True) + self.dynamic_values(family, value, return_a_list=False) self.calculation_to_information( family.path, "dynamic", @@ -115,6 +78,43 @@ class Annotator(Walk): family.version, ) + def dynamic_values( + self, + family, + value, + *, + return_a_list=True, + ) -> None: + """For dynamic we must have values to document it""" + if not isinstance(value, Calculation): + return + default_values = ["example"] + if isinstance(value, (VariableCalculation, VariablePropertyCalculation)): + variable = self.objectspace.paths.get_with_dynamic( + value.variable, + value.path_prefix, + family.path, + value.version, + value.namespace, + value.xmlfiles, + )[0] + if variable: + values = self.get_examples_values(variable) + if values: + default_values = values + if not return_a_list: + default_values = default_values[0] + value.default_values = default_values + + def get_examples_values(self, variable) -> list: + """Check examples or test information to define examples values""" + values = self.objectspace.informations.get(variable.path).get("examples", None) + if not values: + values = self.objectspace.informations.get(variable.path).get("test", None) + if isinstance(values, tuple): + values = list(values) + return values + def populate_variable(self) -> None: """convert variables""" for variable in self.get_variables(): @@ -156,7 +156,7 @@ class Annotator(Walk): variable: dict, ) -> None: """convert properties""" - for prop in ["hidden", "disabled", "mandatory"]: + for prop in PROPERTY_ATTRIBUTE: prop_value = getattr(variable, prop, None) if not prop_value: continue @@ -174,106 +174,158 @@ class Annotator(Walk): values, version: str, ): - self._calculation_to_information( - path, - prop, - values, - version, - ) - if isinstance(values, list): + """tranform calculation to an information""" + if not isinstance(values, list): + if not isinstance(values, Calculation): + return + self._calculation_to_information( + path, + prop, + self._calculation_to_string(path, prop, values, version), + ) + else: + datas = [] + one_is_calculation = False for idx, val in enumerate(values): + data = self._calculation_to_string(path, prop, val, version) + if data is None: + continue + if "type" in data: + one_is_calculation = True + datas.append(data) + if one_is_calculation: self._calculation_to_information( path, prop, - val, - version, - identifier=f"_{idx}", + datas, ) def _calculation_to_information( + self, + path: str, + prop: str, + datas: Union[dict, list[dict]], + ) -> None: + if datas is None: + return + self.objectspace.informations.add( + path, + f"{prop}_calculation", + datas, + ) + + def _calculation_to_string( self, path: str, prop: str, values, version: str, - *, - identifier: str = "", ): if not isinstance(values, Calculation): - return - values_calculation = True - values_optional = False + return {'value': values} if isinstance(values, JinjaCalculation): - if values.description: - values_calculation = values.description - values_calculation_type = "jinja" - elif isinstance(values, (VariableCalculation, VariablePropertyCalculation)): - values_calculation = values.variable - paths = self.objectspace.paths - if version != "1.0" and paths.regexp_relative.search(values_calculation): - values_calculation = paths.get_full_path( - values_calculation, - path, - ) - 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) - elif values.when_not is not undefined: - 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_type = "variable" - if isinstance(values, VariableCalculation): - values_optional = values.optional - elif isinstance(values, InformationCalculation): - values_calculation_type = "information" - if values.variable: - variable = values.variable - paths = self.objectspace.paths - if version != "1.0" and paths.regexp_relative.search(variable): - variable = paths.get_full_path( - variable, - path, - ) - 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) - 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 - ) - elif values.when_not is not undefined: - values_calculation = _('when the identifier is not "{0}"').format( - values.when_not - ) - values_calculation_type = "identifier" - elif isinstance(values, IndexCalculation): - values_calculation_type = "index" - self.objectspace.informations.add( - path, - f"{prop}_calculation_type{identifier}", - values_calculation_type, - ) - self.objectspace.informations.add( - path, - f"{prop}_calculation{identifier}", - values_calculation, - ) - if values_optional: - self.objectspace.informations.add( - path, - f"{prop}_calculation_optional{identifier}", - values_optional, + return {"type": "jinja", + "value": self._calculation_to_information_jinja(values), + } + if isinstance(values, (VariableCalculation, VariablePropertyCalculation)): + value = self._calculation_to_information_variable( + values, prop, version, path ) + if value is None: + return + return {"type": "variable", + "value": value, + } + if isinstance(values, InformationCalculation): + return {"type": "information", + "value": self._calculation_to_information_information( + values, version, path + ), + } + if isinstance(values, (IdentifierCalculation, IdentifierPropertyCalculation)): + return {"type": "identifier", + "value": self._calculation_to_information_identifier( + values, prop, version + ), + } + if isinstance(values, IndexCalculation): + return {"type": "index", + "value": True, + } + raise Exception('unknown calculation "{values}"') + + def _calculation_to_information_jinja(self, values): + if values.description: + return values.description + return True + + def _calculation_to_information_variable( + self, values, prop: str, version: str, path: str + ) -> str: + # is optional + if isinstance(values, VariableCalculation) and values.optional: + variable = self.objectspace.paths.get_with_dynamic( + values.variable, + values.path_prefix, + path, + values.version, + values.namespace, + values.xmlfiles, + )[0] + if not variable: + return None + variable_path = variable.path + else: + variable_path = self._get_path_from_variable(values, version, path) + if prop in PROPERTY_ATTRIBUTE: + # get comparative value + if values.when_not is not undefined: + value = values.when_not + msg = _('when the variable "{0}" hasn\'t the value "{1}"') + else: + if values.when is not undefined: + value = values.when + else: + value = True + msg = _('when the variable "{0}" has the value "{1}"') + if not isinstance(value, str): + value = dump(value) + + # set message + values_calculation = msg.format(variable_path, value) + else: + values_calculation = variable_path + + return values_calculation + + def _calculation_to_information_information( + self, values, version: str, path: str + ) -> Union[str, bool]: + if values.variable: + variable_path = self._get_path_from_variable(values, version, path) + return _('the value of the information "{0}" of the variable "{1}"').format( + values.information, variable_path + ) + return _('the value of the global information "{0}"').format( + values.information + ) + + def _calculation_to_information_identifier( + self, values, prop: str, version: str + ) -> Union[str, bool]: + if version != "1.0" and prop in PROPERTY_ATTRIBUTE: + if values.when is not undefined: + return _('when the identifier is "{0}"').format(values.when) + if values.when_not is not undefined: + return _('when the identifier is not "{0}"').format(values.when_not) + return True + + def _get_path_from_variable(self, values, version: str, path: str) -> str: + variable_path = values.variable + paths = self.objectspace.paths + if version != "1.0" and paths.regexp_relative.search(variable_path): + variable_path = paths.get_full_path( + variable_path, + path, + ) + return variable_path diff --git a/src/rougail/output_doc/config.py b/src/rougail/output_doc/config.py index 0491c54..2f1da03 100644 --- a/src/rougail/output_doc/config.py +++ b/src/rougail/output_doc/config.py @@ -19,26 +19,29 @@ along with this program. If not, see . """ from pathlib import Path -from rougail.utils import load_modules +from rougail.utils import load_modules, _ OUTPUTS = None def get_outputs() -> None: - module_name = "rougail.doc.output" + """Load all outputs""" + module_name = "rougail.output_doc.output" outputs = {} for path in (Path(__file__).parent / "output").iterdir(): name = path.name if not name.endswith(".py") or name.endswith("__.py"): continue - module = load_modules(module_name + "." + name, str(path)) + module = load_modules(module_name + "." + name[:-3], str(path)) if "Formater" not in dir(module): continue level = module.Formater.level if level in outputs: - raise Exception( - f'duplicated level rougail-doc for output "{level}": {module.Formater.name} and {outputs[level].name}' + raise ImportError( + _('duplicated level rougail-doc for output "{0}": {1} and {2}').format( + level, module.Formater.name, outputs[level].name + ) ) outputs[module.Formater.level] = module.Formater return {outputs[level].name: outputs[level] for level in sorted(outputs)} @@ -55,13 +58,15 @@ class OutPuts: # pylint: disable=R0903 OUTPUTS = get_outputs() def get(self) -> dict: + """Get all outputs""" return OUTPUTS def get_rougail_config( *, - backward_compatibility=True, + backward_compatibility=True, # pylint: disable=unused-argument ) -> dict: + """Get documentation for output_doc modules""" outputs = list(OutPuts().get()) output_format_default = outputs[0] rougail_options = """ diff --git a/src/rougail/output_doc/doc.py b/src/rougail/output_doc/doc.py new file mode 100644 index 0000000..7ffd7ed --- /dev/null +++ b/src/rougail/output_doc/doc.py @@ -0,0 +1,556 @@ +""" +Silique (https://www.silique.fr) +Copyright (C) 2024 + +This program is free software: you can redistribute it and/or modify it +under the terms of the GNU Lesser General Public License as published by the +Free Software Foundation, either version 3 of the License, or (at your +option) any later version. + +This program is distributed in the hope that it will be useful, but WITHOUT +ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS +FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more +details. + +You should have received a copy of the GNU Lesser General Public License +along with this program. If not, see . +""" + +from warnings import warn +from typing import Optional + +from tiramisu import Calculation, undefined, groups +from tiramisu.error import ConfigError +from rougail.error import display_xmlfiles +from rougail.object_model import PROPERTY_ATTRIBUTE + +from .config import OutPuts +from .i18n import _ +from .utils import to_phrase, DocTypes +from .example import Examples + + +class RougailOutputDoc(Examples): + """Rougail Output Doc: + Generate documentation from rougail description files + """ + + def __init__( + self, + *, + config: "Config" = None, + rougailconfig: "RougailConfig" = None, + **kwarg, + ): + # Import here to avoid circular import + from rougail import Rougail, CONVERT_OPTION + + self.convert_option = CONVERT_OPTION + if rougailconfig is None: + from rougail import RougailConfig + + rougailconfig = RougailConfig + if rougailconfig["step.output"] != "doc": + rougailconfig["step.output"] = "doc" + if rougailconfig["step.output"] != "doc": + raise Exception("doc is not set as step.output") + outputs = OutPuts().get() + output = rougailconfig["doc.output_format"] + if output not in outputs: + raise Exception( + f'cannot find output "{output}", available outputs: {list(outputs)}' + ) + if config is None: + rougail = Rougail(rougailconfig) + rougail.converted.plugins.append("output_doc") + config = rougail.run() + self.conf = config + self.conf.property.setdefault(frozenset({"advanced"}), "read_write", "append") + self.conf.property.read_write() + # self.conf.property.remove("cache") + self.formater = outputs[output]() + self.level = rougailconfig["doc.title_level"] + self.dynamic_paths = {} + self.with_example = rougailconfig["doc.with_example"] + self.modes_level = rougailconfig["modes_level"] + self.informations = None + try: + groups.namespace + self.support_namespace = True + except AttributeError: + self.support_namespace = False + self.property_to_string = [ + ("mandatory", _("mandatory")), + ("hidden", _("hidden")), + ("disabled", _("disabled")), + ("unique", _("unique")), + ("force_store_value", _("auto modified")), + ] + super().__init__() + + def run(self): + """Print documentation in stdout""" + print(self.gen_doc()) + + def gen_doc(self): + """Return documentation""" + self._tiramisu_to_internal_object() + return_string = self.formater.run(self.informations, self.level) + if self.with_example: + return_string += self.gen_doc_examples() + return return_string + + def _tiramisu_to_internal_object(self): + config = self.conf.unrestraint + self._populate_dynamics(config) + informations = self._parse_families(config) + if informations is None: + informations = {} + self.informations = informations + + def _populate_dynamics(self, family) -> None: + for child in family.list(): + path = child.path(uncalculated=True) + if not child.isoptiondescription(): + func = self._populate_dynamic_variable + else: + func = self._populate_dynamic_family + func(child, path) + + def _populate_dynamic_variable(self, variable, path) -> None: + if not variable.isdynamic(): + return + if path not in self.dynamic_paths: + self.dynamic_paths[path] = {"paths": [], "names": []} + self.dynamic_paths[path]["paths"].append(self._dyn_path_to_italic(variable, path)) + self.dynamic_paths[path]["names"].append(variable.name()) + + def _populate_dynamic_family(self, family, path) -> None: + if family.isdynamic(): + if path not in self.dynamic_paths: + self.dynamic_paths[path] = {"paths": [], "names": []} + self.dynamic_paths[path]["paths"].append( + self._dyn_path_to_italic(family, path) + ) + self.dynamic_paths[path]["names"].append(family.name()) + self._populate_dynamics(family) + + def _parse_families(self, family) -> dict: + informations = {} + leader = None + for child in family.list(): + if self._is_inaccessible_user_data(child): + continue + name = child.name(uncalculated=True) + path = child.path(uncalculated=True) + if not child.isoptiondescription(): + leader = self._parse_variable(child, leader, name, path, informations) + else: + self._parse_family(child, informations, name, path) + return informations + + def _is_inaccessible_user_data(self, child): + """If family is not accessible in read_write mode (to load user_data), + do not comment this family + """ + properties = child.property.get(uncalculated=True) + # FIXME advanced is hard coded + for hidden_property in ["hidden", "disabled", "advanced"]: + if hidden_property in properties: + return True + return False + + def _parse_family(self, family, informations: dict, name: str, path: str) -> None: + sub_informations = self._parse_families(family) + if not sub_informations: + return + informations[name] = { + "type": self._get_family_type(family), + "informations": self._populate_family( + family, + path, + ), + "children": sub_informations, + } + + def _parse_variable( + self, variable, leader: dict, name: str, path: str, informations: dict + ) -> Optional[dict]: + if variable.isdynamic(): + # information is already set + potential_leader = self._parse_variable_dynamic(variable, leader, name, path, informations) + elif variable.isfollower() and variable.index(): + potential_leader = self._parse_variable_follower_with_index( + variable, name, informations + ) + else: + potential_leader = self._parse_variable_normal( + variable, leader, name, path, informations + ) + if potential_leader: + leader = potential_leader + return leader + + def _parse_variable_normal( + self, variable, leader, name: str, path: str, informations: dict + ) -> Optional[dict]: + if variable.isdynamic(): + sub_informations = self.dynamic_paths[path] + else: + sub_informations = {} + self._populate_variable( + variable, + sub_informations, + ) + if self.with_example: + self._add_examples(variable, sub_informations, leader) + informations[name] = sub_informations + if variable.isleader(): + return sub_informations + return None + + def _parse_variable_follower_with_index( + self, variable, name: str, informations: dict + ) -> None: + if not self.with_example: + return None + informations[name]["example"][-1][variable.index()] = self._get_example( + variable, informations[name], None + ) + return None + + def _parse_variable_dynamic(self, variable, leader, name, path, informations) -> None: + dynamic_variable = self.dynamic_paths[path] + if "type" in dynamic_variable: + if self.with_example: + dynamic_variable["example"].append( + self._get_example(variable, dynamic_variable, leader) + ) + description = to_phrase(variable.description(uncalculated=True)) + if "{{ identifier }}" in description: + description = self._convert_description(description, variable) + dynamic_variable["descriptions"].append(to_phrase(description)) + if variable.isleader(): + return dynamic_variable + return None + return self._parse_variable_normal(variable, leader, name, path, informations) + + def _get_family_type(self, family) -> str: + if self.support_namespace and family.group_type() is groups.namespace: + return "namespace" + if family.isleadership(): + return "leadership" + if family.isdynamic(only_self=True): + return "dynamic" + return "family" + + def _dyn_path_to_italic(self, child, path: str) -> str: + for identifier in child.identifiers(): + path = path.replace("{{ identifier }}", self.formater.italic(identifier), 1) + return path + + def _populate_family( + self, + family, + path: str, + ) -> dict: + if family.isdynamic(): + informations = self.dynamic_paths[path] + else: + informations = {} + self._populate(family, informations) + if family.isleadership(): + informations.setdefault("help", []).append( + _("This family contains lists of variable blocks.") + ) + if family.isdynamic(only_self=True): + identifiers = self._to_string(family, "dynamic", do_not_raise=True) + if identifiers is None: + identifiers = family.identifiers(only_self=True) + informations["identifiers"] = identifiers + informations.setdefault("help", []).append( + _("This family builds families dynamically.") + ) + return informations + + def _populate_variable( + self, + variable, + informations: dict, + ): + informations["type"] = "variable" + default = self._get_default( + variable, + ) + if default is not None: + informations["default"] = default + self._parse_type( + variable, + informations, + ) + self._populate(variable, informations) + if "description" in informations: + informations["descriptions"] = [to_phrase(informations.pop("description"))] + if variable.ismulti(): + multi = not variable.isfollower() or variable.issubmulti() + else: + multi = False + if multi: + informations["properties"].append( + { + "type": "multiple", + "name": _("multiple"), + } + ) + informations["multiple"] = True + examples = variable.information.get("examples", None) + if examples is None: + examples = variable.information.get("test", None) + if examples is not None: + informations["examples"] = list(examples) + + def _populate( + self, + obj, + informations: dict, + ): + if not obj.isdynamic(): + informations["paths"] = [obj.path(uncalculated=True)] + informations["names"] = [obj.name()] + description = obj.description(uncalculated=True) + if obj.name(uncalculated=True) == description: + warning = _('No attribute "description" for "{0}" in {1}').format( + informations["paths"][0], + display_xmlfiles(obj.information.get("dictionaries")), + ) + warn(warning) + else: + informations["description"] = self._convert_description(description, obj) + help_ = obj.information.get("help", None) + if help_: + informations["help"] = [to_phrase(help_)] + self._parse_properties( + obj, + informations, + ) + + def _convert_description(self, description, obj): + if "{{ identifier }}" in description: + return description.replace( + "{{ identifier }}", self.formater.italic(obj.identifiers()[-1]) + ) + return description + + def _add_examples(self, variable, informations: dict, leader) -> None: + example = self._get_example(variable, informations, leader) + informations["example"] = [example] + informations["mandatory_without_value"] = "mandatory" in variable.property.get( + uncalculated=True + ) and variable.value.get(uncalculated=True) in [None, []] + + def _get_example(self, variable, informations: dict, leader): + example = informations.get("examples") + if example is not None: + if isinstance(example, tuple): + example = list(example) + if not informations.get("multiple"): + example = example[0] + else: + if variable.information.get("fake_default", False): + default = None + else: + try: + default = variable.value.get() + except ConfigError: + default = None + if default not in [None, []]: + example = default + else: + example = self.convert_option.get( + variable.information.get("type"), {} + ).get("example", None) + if example is None: + example = "xxx" + if informations.get("multiple"): + example = [example] + if leader is not None and variable.isfollower(): + example = [example] + [undefined] * (len(leader["example"][-1]) - 1) + return example + + def _parse_type( + self, + variable, + informations, + ): + variable_type = variable.information.get("type") + doc_type = DocTypes.get(variable_type, {"params": {}}) + informations["properties"] = [ + { + "type": "type", + "name": doc_type.get("msg", variable_type), + } + ] + # extra parameters for types + option = variable.get() + for param, msg in doc_type["params"].items(): + value = option.impl_get_extra(f"_{param}") + if value is None: + value = option.impl_get_extra(param) + if value is not None and value is not False: + informations.setdefault("validators", []).append(msg.format(value)) + # get validation information from annotator + for name in variable.information.list(): + if not name.startswith("validators_calculation"): + continue + informations.setdefault("validators", []).extend( + self._to_string( + variable, + "validators", + ) + ) + break + if variable.information.get("type") == "choice": + choices = self._to_string(variable, "choice", do_not_raise=True) + if choices is None: + choices = variable.value.list() + for idx, val in enumerate(choices): + if not isinstance(val, Calculation): + default = informations.get("default") + if default is not None and val == default: + choices[idx] = str(val) + " ← " + _("(default)") + informations["display_default"] = False + continue + choices[idx] = self._to_string(variable, "choice", f"_{idx}") + informations["choices"] = choices + if variable.information.get("type") == "regexp": + informations.setdefault("validators", []).append( + _('text based with regular expressions "{0}"').format( + variable.pattern() + ) + ) + + def _parse_properties( + self, + variable, + informations, + ): + properties = variable.property.get(uncalculated=True) + for mode in self.modes_level: + if mode not in properties: + continue + informations.setdefault("properties", []).append( + { + "type": "mode", + "name": mode, + } + ) + break + for prop, msg in self.property_to_string: + if prop in properties: + prop_obj = { + "type": "property", + "name": msg, + } + elif variable.information.get(f"{prop}_calculation", False): + prop_obj = { + "type": "property", + "name": msg, + "annotation": self._to_string(variable, prop), + } + else: + continue + informations.setdefault("properties", []).append(prop_obj) + + def _get_default( + self, + variable, + ): + default = self._to_string(variable, "default", do_not_raise=True) + if default is not None: + return default + if not variable.information.get("fake_default", False): + default = variable.value.get(uncalculated=True) + if default == []: + default = None + return default + + def _to_string( + self, + variable, + prop, + identifier="", + do_not_raise=False, + ): + if identifier: + raise Exception('pfff') + calculation = variable.information.get( + f"{prop}_calculation", None + ) + if not calculation: + if do_not_raise: + return None + raise Exception( + f'cannot find "{prop}_calculation" information, ' + "do you have declare doc has a plugins?" + ) +# if do_not_raise and calculation.get('optional', False): +# return None + if isinstance(calculation, list): + values = [] + for cal in calculation: + value = self._calculation_to_string(variable, cal, prop) + if value is not None: + values.append(value) + return values + return self._calculation_to_string(variable, calculation, prop) + + def _calculation_to_string(self, variable, calculation, prop): + if "type" not in calculation: + return calculation["value"] + if calculation["type"] == "jinja": + if calculation["value"] is not True: + values = calculation["value"] + 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")), + ) + warn(warning) + elif calculation["type"] == "variable": + if prop in PROPERTY_ATTRIBUTE: + values = calculation["value"] + else: + if calculation.get('optional', False): + # FIXME pas forcement dans self.dynamic_paths encore ... + path = calculation["value"] + if "{{ identifier }}" in path: + # FIXME pas forcement dans self.dynamic_paths encore ... + if path not in self.dynamic_paths: + return None + else: + try: + self.conf.option(path).get() + except AttributeError: + return None + msg = _('the value of the variable "{0}"') + if "{{ identifier }}" in calculation["value"]: + # FIXME pas forcement dans self.dynamic_paths encore ... + values = [msg.format(path) for path in self.dynamic_paths[calculation["value"]]["paths"]] + else: + values = msg.format(calculation["value"]) + elif calculation["type"] == "identifier": + if prop in PROPERTY_ATTRIBUTE: + values = calculation["value"] + else: + values = _("the value of the identifier") + elif calculation["type"] == "information": + values = calculation["value"] + else: + values = _("the value of the {0}").format(calculation["type"]) + if isinstance(values, str) and not values.endswith("."): + values += "." + return values diff --git a/src/rougail/output_doc/example.py b/src/rougail/output_doc/example.py new file mode 100644 index 0000000..f5c32d2 --- /dev/null +++ b/src/rougail/output_doc/example.py @@ -0,0 +1,137 @@ +""" +Silique (https://www.silique.fr) +Copyright (C) 2024 + +This program is free software: you can redistribute it and/or modify it +under the terms of the GNU Lesser General Public License as published by the +Free Software Foundation, either version 3 of the License, or (at your +option) any later version. + +This program is distributed in the hope that it will be useful, but WITHOUT +ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS +FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more +details. + +You should have received a copy of the GNU Lesser General Public License +along with this program. If not, see . +""" + +from typing import Optional + +from .utils import _ + + +class Examples: # pylint: disable=no-member,too-few-public-methods + """Build examples""" + def __init__(self): + self.examples = None + self.examples_mandatories = None + + def gen_doc_examples(self): + """Return examples""" + if not self.informations: + self._tiramisu_to_internal_object() + self._build_examples() + return_string = "" + if self.examples_mandatories: + return_string += self.formater.title( + _("Example with mandatory variables not filled in"), self.level + ) + return_string += self.formater.yaml(self.examples_mandatories) + if self.examples: + return_string += self.formater.title( + _("Example with all variables modifiable"), self.level + ) + return_string += self.formater.yaml(self.examples) + return return_string + + def _build_examples(self): + self.examples, self.examples_mandatories = self._parse_examples( + self.informations + ) + + def _parse_examples(self, dico, dyn_parent: Optional[str] = None) -> tuple: + examples = {} + examples_mandatories = {} + for value in dico.values(): + if value["type"] == "variable": + self._parse_examples_variable( + value, dyn_parent, examples, examples_mandatories + ) + else: + self._parse_examples_family( + value, dyn_parent, examples, examples_mandatories + ) + return examples, examples_mandatories + + def _parse_examples_variable( + self, + variable, + dyn_parent: Optional[str], + examples: dict, + examples_mandatories: dict, + ) -> None: + for idx, path in enumerate(variable["paths"]): + if dyn_parent is not None and not path.startswith(dyn_parent): + continue + name = variable["names"][idx] + value = variable["example"][idx] + examples[name] = value + if variable["mandatory_without_value"]: + examples_mandatories[name] = value + break + + def _parse_examples_family( + self, + family, + dyn_parent: Optional[str], + examples: dict, + examples_mandatories: dict, + ) -> None: + for idx, path in enumerate(family["informations"]["paths"]): + if dyn_parent is not None and not path.startswith(dyn_parent): + continue + name = family["informations"]["names"][idx] + if family["type"] == "leadership": + func = self._parse_examples_leadership + else: + func = self._parse_examples + ret_e, ret_m = func( + family["children"], + path + "." if family["type"] == "dynamic" else dyn_parent, + ) + if ret_m: + examples_mandatories[name] = ret_m + if ret_e: + examples[name] = ret_e + + def _parse_examples_leadership( + self, leadership, dyn_parent: Optional[str] = None + ) -> tuple: + examples = [] + examples_mandatories = [] + leader = next(iter(leadership.values())) + for path_idx, path in enumerate(leader["paths"]): + if dyn_parent is not None and not path.startswith(dyn_parent): + continue + for leader_idx in range(len(leader["example"][path_idx])): + examples.append( + { + follower["names"][path_idx]: follower["example"][path_idx][ + leader_idx + ] + for follower in leadership.values() + } + ) + if leader["mandatory_without_value"]: + examples_mandatories.append( + { + follower["names"][path_idx]: follower["example"][path_idx][ + leader_idx + ] + for follower in leadership.values() + if follower["mandatory_without_value"] + } + ) + break + return examples, examples_mandatories diff --git a/src/rougail/output_doc/output/asciidoc.py b/src/rougail/output_doc/output/asciidoc.py index 9ca9d0f..8b2e967 100644 --- a/src/rougail/output_doc/output/asciidoc.py +++ b/src/rougail/output_doc/output/asciidoc.py @@ -16,21 +16,17 @@ You should have received a copy of the GNU Lesser General Public License along with this program. If not, see . """ -from io import BytesIO from typing import List -from itertools import chain -from ruamel.yaml import YAML +from ..utils import CommonFormater, dump -class Formater: +class Formater(CommonFormater): + """The asciidoc formater""" name = "asciidoc" level = 40 - def __init__(self): - self._yaml = YAML() - self._yaml.indent(mapping=2, sequence=4, offset=2) - def header(self): + """Header of the documentation""" return "" def title( @@ -38,67 +34,20 @@ class Formater: title: str, level: int, ) -> str: + """Display family name as a title""" char = "=" return f"{char * (level + 1)} {title}\n\n" - def yaml(self, dump: dict) -> str: - 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 '[cols="1a,1a"]\n' + stable[1] - - def link( - self, - comment: str, - link: str, - ) -> str: - return f"`{link}[{comment}]`" - - def prop( - self, - prop: str, - italic: bool, - ) -> str: - if italic: - prop = self.italic(prop) - return f"`{prop}`" - - def list( - self, - choices: list, - ) -> str: - prefix = "\n\n* " - char = "\n* " - return prefix + char.join([self.dump(choice) for choice in choices]) - - def is_list( - self, - txt: str, - ) -> str: - return txt.startswith("* ") - - def columns( - self, - col1: List[str], - col2: List[str], - ) -> None: - self.max_line = 0 - for params in chain(col1, col2): - for param in params.split("\n"): - self.max_line = max(self.max_line, len(param)) - self.max_line += 1 - def join( self, lst: List[str], ) -> str: + """Display line in table from a list""" string = "" previous = "" for line in lst: if string: - if self.is_list(previous.split("\n")[-1]): + if self.is_list(previous.split("\n", 1)[-1]): string += "\n\n" else: string += " +\n" @@ -107,36 +56,69 @@ class Formater: previous = line return "\n" + string - def to_string( - self, - text: str, - ) -> str: - return text - - def table_header( - self, - lst, - ): - return lst[0] + " " * (self.max_line - len(lst[0])), lst[1] + " " * ( - self.max_line - len(lst[1]) - ) - def bold( self, msg: str, ) -> str: + """Set a text to bold""" return f"**{msg}**" def italic( self, msg: str, ) -> str: - return f"_{msg}_" + """Set a text to italic""" + return f"__{msg}__" - def dump(self, dico): - with BytesIO() as ymlfh: - self._yaml.dump(dico, ymlfh) - ret = ymlfh.getvalue().decode("utf-8").strip() - if ret.endswith("..."): - ret = ret[:-3].strip() - return ret + def stripped( + self, + text: str, + ) -> str: + """Return stripped text (as help)""" + return text.strip() + + def list( + self, + choices: list, + ) -> str: + """Display a liste of element""" + prefix = "\n\n* " + char = "\n* " + return prefix + char.join([dump(choice) for choice in choices]) + + def prop( + self, + prop: str, + italic: bool, + ) -> str: + """Display property""" + if italic: + prop = self.italic(prop) + return f"`{prop}`" + + def yaml(self, _dump: dict) -> str: + """Dump yaml part of documentation""" + return f"[,yaml]\n----\n---\n{dump(_dump)}\n----\n" + + def table(self, datas) -> str: + """Transform list to a table in string format + we change the first line because we want that col has the same width + """ + table = super().table(datas) + stable = table.split("\n", 1) + return '[cols="1a,1a"]\n' + stable[1] + + def link( + self, + comment: str, + link: str, + ) -> str: + """Add a link""" + return f"`{link}[{comment}]`" + + def is_list( + self, + txt: str, + ) -> str: + """verify if a text is a list""" + return txt.strip().startswith("* ") diff --git a/src/rougail/output_doc/output/github.py b/src/rougail/output_doc/output/github.py index 00f0417..652e7c8 100644 --- a/src/rougail/output_doc/output/github.py +++ b/src/rougail/output_doc/output/github.py @@ -16,22 +16,23 @@ You should have received a copy of the GNU Lesser General Public License along with this program. If not, see . """ -from io import BytesIO from typing import List -from itertools import chain -from ruamel.yaml import YAML + +from ..utils import dump, CommonFormater -class Formater: +class Formater(CommonFormater): + """The markdown (for github) formater""" name = "github" level = 50 + enter_table = "
" - def __init__(self): - self._yaml = YAML() - self._yaml.indent(mapping=2, sequence=4, offset=2) - self.header_setted = False + def __init__(self) -> None: + self.max_line = 0 + super().__init__() - def header(self): + def header(self) -> str: + """Header of the documentation""" if self.header_setted: return "" self.header_setted = True @@ -42,90 +43,85 @@ class Formater: title: str, level: int, ) -> str: + """Display family name as a title""" char = "#" return f"{char * level} {title}\n\n" - def yaml(self, dump): - return f"```yaml\n---\n{self.dump(dump)}\n```\n" - - def table(self, table): - return table - - def link( - self, - comment: str, - link: str, - ) -> str: - return f"[`{comment}`]({link})" - - def prop( - self, - prop: str, - italic: bool, - ) -> str: - prop = f"`{prop}`" - if italic: - prop = self.italic(prop) - return prop - - def list( - self, - choices, - ): - prefix = "
- " - char = "
- " - return prefix + char.join([self.dump(choice) for choice in choices]) - - def is_list( - self, - txt: str, - ) -> str: - return txt.startswith("* ") - - def columns( - self, - col1: List[str], - col2: List[str], - ) -> None: - self.max_line = 0 - for params in chain(col1, col2): - for param in params.split("\n"): - self.max_line = max(self.max_line, len(param)) - self.max_line += 1 - def join( self, lst: List[str], ) -> str: - return "
".join(lst) - - def to_string( - self, - text: str, - ) -> str: - return text.strip().replace("\n", "
") - - def table_header(self, lst): - return lst[0] + " " * (self.max_line - len(lst[0])), lst[1] + " " * ( - self.max_line - len(lst[1]) - ) + """Display line in table from a list""" + return self.enter_table.join(lst) def bold( self, msg: str, ) -> str: + """Set a text to bold""" return f"**{msg}**" def italic( self, msg: str, ) -> str: + """Set a text to italic""" return f"*{msg}*" - def dump(self, dico): - with BytesIO() as ymlfh: - self._yaml.dump(dico, ymlfh) - ret = ymlfh.getvalue().decode("utf-8").strip() - if ret.endswith("..."): - ret = ret[:-3].strip() + def stripped( + self, + text: str, + ) -> str: + """Return stripped text (as help)""" + return text.strip().replace("\n", self.enter_table) + + def list( + self, + choices, + ): + """Display a liste of element""" + char = f"{self.enter_table}- " + ret = "" + for choice in choices: + if not isinstance(choice, str): + choice = dump(choice) + ret += char + choice return ret + + def prop( + self, + prop: str, + italic: bool, + ) -> str: + """Display property""" + prop = f"`{prop}`" + if italic: + prop = self.italic(prop) + return prop + + def table_header(self, lst): + """Manage the header of a table""" + return lst[0] + " " * (self.max_line - len(lst[0])), lst[1] + " " * ( + self.max_line - len(lst[1]) + ) + + def yaml(self, _dump): + """Dump yaml part of documentation""" + return f"```yaml\n---\n{dump(_dump)}\n```\n" + + def link( + self, + comment: str, + link: str, + ) -> str: + """Add a link""" + return f"[`{comment}`]({link})" + + def columns( + self, + col: List[str], + ) -> None: + """count columns length""" + for line in col: + for l in line.split(self.enter_table): + self.max_line = max(self.max_line, len(l) + 1) diff --git a/src/rougail/output_doc/output/ojson.py b/src/rougail/output_doc/output/ojson.py new file mode 100644 index 0000000..e13f84a --- /dev/null +++ b/src/rougail/output_doc/output/ojson.py @@ -0,0 +1,34 @@ +""" +Silique (https://www.silique.fr) +Copyright (C) 2024 + +This program is free software: you can redistribute it and/or modify it +under the terms of the GNU Lesser General Public License as published by the +Free Software Foundation, either version 3 of the License, or (at your +option) any later version. + +This program is distributed in the hope that it will be useful, but WITHOUT +ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS +FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more +details. + +You should have received a copy of the GNU Lesser General Public License +along with this program. If not, see . +""" + +from json import dumps +from typing import Any + + +class Formater: + """Just return internal structure to json""" + name = "json" + level = 90 + + def run(self, dico: dict, *args) -> str: # pylint: disable=unused-argument + """Transform to string""" + return dumps(dico, ensure_ascii=False) + + def italic(self, msg: Any) -> str: + """Just return a string""" + return str(msg) diff --git a/src/rougail/output_doc/utils.py b/src/rougail/output_doc/utils.py new file mode 100644 index 0000000..18771fa --- /dev/null +++ b/src/rougail/output_doc/utils.py @@ -0,0 +1,367 @@ +""" +Silique (https://www.silique.fr) +Copyright (C) 2024 + +This program is free software: you can redistribute it and/or modify it +under the terms of the GNU Lesser General Public License as published by the +Free Software Foundation, either version 3 of the License, or (at your +option) any later version. + +This program is distributed in the hope that it will be useful, but WITHOUT +ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS +FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more +details. + +You should have received a copy of the GNU Lesser General Public License +along with this program. If not, see . +""" + +from typing import List + +from io import BytesIO +from ruamel.yaml import YAML +import tabulate as tabulate_module +from tiramisu.error import display_list +from tabulate import tabulate + +from .i18n import _ + + +ROUGAIL_VARIABLE_TYPE = ( + "https://rougail.readthedocs.io/en/latest/variable.html#variables-types" +) + + +ENTER = "\n\n" + + +DocTypes = { + "domainname": { + "params": { + "allow_startswith_dot": _("the domain name can starts by a dot"), + "allow_without_dot": _("the domain name can be a hostname"), + "allow_ip": _("the domain name can be an IP"), + "allow_cidr_network": _("the domain name can be network in CIDR format"), + }, + }, + "number": { + "params": { + "min_number": _("the minimum value is {0}"), + "max_number": _("the maximum value is {0}"), + }, + }, + "ip": { + "msg": "IP", + "params": { + "cidr": _("IP must be in CIDR format"), + "private_only": _("private IP are allowed"), + "allow_reserved": _("reserved IP are allowed"), + }, + }, + "hostname": { + "params": { + "allow_ip": _("the host name can be an IP"), + }, + }, + "web_address": { + "params": { + "allow_ip": _("the domain name in web address can be an IP"), + "allow_without_dot": _( + "the domain name in web address can be only a hostname" + ), + }, + }, + "port": { + "params": { + "allow_range": _("can be range of port"), + "allow_protocol": _("can have the protocol"), + "allow_zero": _("port 0 is allowed"), + "allow_wellknown": _("ports 1 to 1023 are allowed"), + "allow_registred": _("ports 1024 to 49151 are allowed"), + "allow_private": _("ports greater than 49152 are allowed"), + }, + }, + "secret": { + "params": { + "min_len": _("minimum length for the secret"), + "max_len": _("maximum length for the secret"), + }, + }, +} + + +_yaml = YAML() +_yaml.indent(mapping=2, sequence=4, offset=2) + + +def dump(dico): + """Dump variable, means transform bool, ... to yaml string""" + with BytesIO() as ymlfh: + _yaml.dump(dico, ymlfh) + ret = ymlfh.getvalue().decode("utf-8").strip() + if ret.endswith("..."): + ret = ret[:-3].strip() + return ret + + +def to_phrase(msg): + """Add maj for the first character and ends with dot""" + if not msg: + # replace None to empty string + return "" + msg = str(msg).strip() + # a phrase must ends with a dot + if not msg.endswith("."): + msg += "." + # and start with a maj + return msg[0].upper() + msg[1:] + + +class CommonFormater: + """Class with common function for formater""" + + enter_table = "\n" + # tabulate module name + name = None + + def __init__(self): + tabulate_module.PRESERVE_WHITESPACE = True + self.header_setted = False + + # Class you needs implement to your Formater + def header(self): + """Header of the documentation""" + raise NotImplementedError() + + def title( + self, + title: str, + level: int, + ) -> str: + """Display family name as a title""" + raise NotImplementedError() + + def join( + self, + lst: List[str], + ) -> str: + """Display line in table from a list""" + raise NotImplementedError() + + def bold( + self, + msg: str, + ) -> str: + """Set a text to bold""" + raise NotImplementedError() + + def stripped( + self, + text: str, + ) -> str: + """Return stripped text (as help)""" + raise NotImplementedError() + + def list( + self, + choices: list, + ) -> str: + """Display a liste of element""" + raise NotImplementedError() + + def prop( + self, + prop: str, + italic: bool, + ) -> str: + """Display property""" + raise NotImplementedError() + + def link( + self, + comment: str, + link: str, + ) -> str: + """Add a link""" + raise NotImplementedError() + + ################## + + def table_header( + self, + lst: list, + ) -> tuple: + """Manage the header of a table""" + return lst + + def run(self, dico: dict, level: int) -> str: + """Transform to string""" + msg = self.header() + if dico: + msg += self.dict_to_string(dico, level + 1, root=True) + return msg + + def dict_to_string(self, dico: dict, level: int, root: bool = False) -> str: + """Parse the dict to transform to dict""" + msg = "" + table_datas = [] + title_added = not root + for value in dico.values(): + if value["type"] == "namespace": + msg += self.namespace_to_string(value["informations"], level) + msg += self.dict_to_string(value["children"], level) + else: + if not title_added: + msg += self.title(_("Variables"), level - 1) + if value["type"] == "variable": + self.variable_to_string(value, table_datas) + else: + if table_datas: + msg += self.table(table_datas) + msg += self.family_to_string(value["informations"], level) + msg += self.dict_to_string(value["children"], level + 1) + title_added = True + if table_datas: + msg += self.table(table_datas) + return msg + + # FAMILY + def namespace_to_string(self, dico: dict, level: int) -> str: + """manage namespace family""" + return self.title( + _('Variables for "{0}"').format(self.family_description(dico)), level - 1 + ) + + def family_to_string(self, dico: dict, level: int) -> str: + """manage other family type""" + msg = self.title(self.family_description(dico), level) + calculated_properties = [] + msg += self.property_to_string(dico, calculated_properties) + ENTER + if calculated_properties: + msg += self.join(calculated_properties) + ENTER + helps = dico.get("help") + if helps: + for help_ in helps: + msg += help_.strip() + ENTER + if "identifiers" in dico: + msg += self.section(_("Identifiers"), dico["identifiers"]) + ENTER + return msg + + def family_description(self, dico: dict) -> str(): + """Get family name""" + if "description" in dico: + return dico["description"] + return display_list( + dico["paths"], + separator="or", + ) + + # VARIABLE + def variable_to_string(self, dico: dict, table_datas: dict) -> None: + """Manage variable""" + calculated_properties = [] + table_datas.append( + [ + self.join(self.variable_first_column(dico, calculated_properties)), + self.join(self.variable_second_column(dico, calculated_properties)), + ] + ) + + def variable_first_column(self, dico: dict, calculated_properties: list) -> list: + """Collect string for the first column""" + first_col = [ + self.join([self.bold(path_) for path_ in dico["paths"]]), + self.property_to_string(dico, calculated_properties), + ] + self.columns(first_col) + return first_col + + def variable_second_column(self, dico: dict, calculated_properties: list) -> list: + """Collect string for the second column""" + if "descriptions" in dico: + description = self.join(list(dict.fromkeys(dico["descriptions"]))) + else: + description = to_phrase( + display_list( + list(dict.fromkeys(dico["names"])), + separator="or", + ) + ) + second_col = [self.stripped(description)] + for help_ in dico.get("help", []): + second_col.append(self.stripped(help_)) + if "validators" in dico: + validators = dico["validators"] + if len(validators) == 1: + second_col.append(self.section(_("Validator"), validators[0])) + else: + second_col.append(self.section(_("Validators"), self.list(validators))) + if "choices" in dico: + second_col.append(self.section(_("Choices"), dico["choices"])) + if "default" in dico and dico.get("display_default", True): + second_col.append(self.section(_("Default"), dico["default"])) + if "examples" in dico: + examples = dico["examples"] + if len(examples) == 1: + second_col.append(self.section(_("Example"), examples[0])) + else: + second_col.append(self.section(_("Examples"), examples)) + second_col.extend(calculated_properties) + self.columns(second_col) + return second_col + + # OTHERs + def property_to_string(self, dico: dict, calculated_properties: list) -> str: + """Transform properties to string""" + properties = [] + for prop in dico.get("properties", []): + if prop["type"] == 'type': + properties.append(self.link(prop["name"], ROUGAIL_VARIABLE_TYPE)) + else: + if "annotation" in prop: + italic = True + calculated_properties.append( + self.section(prop["name"].capitalize(), prop["annotation"]) + ) + else: + italic = False + prop_str = self.prop(prop["name"], italic=italic) + properties.append(prop_str) + if not properties: + return "" + return " ".join(properties) + + def columns( + self, + col: List[str], # pylint: disable=unused-argument + ) -> None: + """Manage column""" + return + + def table(self, datas: list) -> str: + """Transform list to a table in string format""" + msg = ( + tabulate( + datas, + headers=self.table_header(["Variable", "Description"]), + tablefmt=self.name, + ) + + "\n\n" + ) + datas.clear() + return msg + + def section( + self, + name: str, + msg: str, + ) -> str: + """Return something like Name: msg""" + if isinstance(msg, list): + if len(msg) == 1: + msg = msg[0] + else: + msg = self.list(msg) + if not isinstance(msg, str): + msg = dump(msg) + return _("{0}: {1}").format(self.bold(name), msg) diff --git a/tests/docs/base/00_0empty.json b/tests/docs/base/00_0empty.json new file mode 100644 index 0000000..9e26dfe --- /dev/null +++ b/tests/docs/base/00_0empty.json @@ -0,0 +1 @@ +{} \ No newline at end of file diff --git a/tests/docs/base/00_0version_underscore.adoc b/tests/docs/base/00_0version_underscore.adoc index 0a1a708..acbdeb1 100644 --- a/tests/docs/base/00_0version_underscore.adoc +++ b/tests/docs/base/00_0version_underscore.adoc @@ -6,15 +6,15 @@ _version: '1.1' version: # a variable ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.version** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A variable. |==== - diff --git a/tests/docs/base/00_0version_underscore.json b/tests/docs/base/00_0version_underscore.json new file mode 100644 index 0000000..664cec2 --- /dev/null +++ b/tests/docs/base/00_0version_underscore.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"version": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.version"], "names": ["version"], "descriptions": ["A variable."]}}}} \ No newline at end of file diff --git a/tests/docs/base/00_0version_underscore.md b/tests/docs/base/00_0version_underscore.md index 109d13e..a7417bc 100644 --- a/tests/docs/base/00_0version_underscore.md +++ b/tests/docs/base/00_0version_underscore.md @@ -9,10 +9,9 @@ include_toc: true _version: '1.1' version: # a variable ``` -# Variables for "rougail" +# Variables for "Rougail" | Variable                                                                                                | Description                                                                                             | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.version**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | - diff --git a/tests/docs/base/00_1empty_variable.adoc b/tests/docs/base/00_1empty_variable.adoc index 17cb2e2..701a9d0 100644 --- a/tests/docs/base/00_1empty_variable.adoc +++ b/tests/docs/base/00_1empty_variable.adoc @@ -6,15 +6,15 @@ version: '1.0' empty: ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.empty** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -Empty. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +Empty. |==== - diff --git a/tests/docs/base/00_1empty_variable.json b/tests/docs/base/00_1empty_variable.json new file mode 100644 index 0000000..a84ceb4 --- /dev/null +++ b/tests/docs/base/00_1empty_variable.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"empty": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.empty"], "names": ["empty"]}}}} \ No newline at end of file diff --git a/tests/docs/base/00_1empty_variable.md b/tests/docs/base/00_1empty_variable.md index 68b0377..04e50bb 100644 --- a/tests/docs/base/00_1empty_variable.md +++ b/tests/docs/base/00_1empty_variable.md @@ -9,10 +9,9 @@ include_toc: true version: '1.0' empty: ``` -# Variables for "rougail" +# Variables for "Rougail" | Variable                                                                                                | Description                                                                                             | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.empty**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | Empty. | - diff --git a/tests/docs/base/00_2default_calculated.adoc b/tests/docs/base/00_2default_calculated.adoc index 6f64792..f61fea8 100644 --- a/tests/docs/base/00_2default_calculated.adoc +++ b/tests/docs/base/00_2default_calculated.adoc @@ -13,21 +13,22 @@ var2: {{ _.var1 }} description: the value of var1 ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A first variable. + -**Default**: no +**Default**: no | + **rougail.var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | A second variable. + -**Default**: the value of var1. +**Default**: the value of var1. |==== - diff --git a/tests/docs/base/00_2default_calculated.json b/tests/docs/base/00_2default_calculated.json new file mode 100644 index 0000000..a4d1bef --- /dev/null +++ b/tests/docs/base/00_2default_calculated.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"var1": {"type": "variable", "default": "no", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.var1"], "names": ["var1"], "descriptions": ["A first variable."]}, "var2": {"type": "variable", "default": "the value of var1.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var2"], "names": ["var2"], "descriptions": ["A second variable."], "multiple": true}}}} \ No newline at end of file diff --git a/tests/docs/base/00_2default_calculated.md b/tests/docs/base/00_2default_calculated.md index ee4ab11..c73b8d8 100644 --- a/tests/docs/base/00_2default_calculated.md +++ b/tests/docs/base/00_2default_calculated.md @@ -16,11 +16,10 @@ var2: {{ _.var1 }} description: the value of var1 ``` -# Variables for "rougail" +# Variables for "Rougail" | Variable                                                                                                                       | Description                                                                                                                    | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A first variable.
**Default**: no | | **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A second variable.
**Default**: the value of var1. | - diff --git a/tests/docs/base/00_2default_calculated_multi.adoc b/tests/docs/base/00_2default_calculated_multi.adoc index 7daefd8..b0dd12b 100644 --- a/tests/docs/base/00_2default_calculated_multi.adoc +++ b/tests/docs/base/00_2default_calculated_multi.adoc @@ -18,25 +18,26 @@ var2: {% endfor %} description: the value of _.var1 ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | A first variable. + **Default**: * no * yes -* maybe +* maybe | + **rougail.var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | A second variable. + -**Default**: the value of _.var1. +**Default**: the value of _.var1. |==== - diff --git a/tests/docs/base/00_2default_calculated_multi.json b/tests/docs/base/00_2default_calculated_multi.json new file mode 100644 index 0000000..196f5e0 --- /dev/null +++ b/tests/docs/base/00_2default_calculated_multi.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"var1": {"type": "variable", "default": ["no", "yes", "maybe"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var1"], "names": ["var1"], "descriptions": ["A first variable."], "multiple": true}, "var2": {"type": "variable", "default": "the value of _.var1.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var2"], "names": ["var2"], "descriptions": ["A second variable."], "multiple": true}}}} \ No newline at end of file diff --git a/tests/docs/base/00_2default_calculated_multi.md b/tests/docs/base/00_2default_calculated_multi.md index 528650b..03b0a23 100644 --- a/tests/docs/base/00_2default_calculated_multi.md +++ b/tests/docs/base/00_2default_calculated_multi.md @@ -21,11 +21,10 @@ var2: {% endfor %} description: the value of _.var1 ``` -# Variables for "rougail" +# Variables for "Rougail" | Variable                                                                                                                       | Description                                                                                                                    | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A first variable.
**Default**:
- no
- yes
- maybe | | **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A second variable.
**Default**: the value of _.var1. | - diff --git a/tests/docs/base/00_2default_calculated_variable_transitive.adoc b/tests/docs/base/00_2default_calculated_variable_transitive.adoc index e94a396..2001120 100644 --- a/tests/docs/base/00_2default_calculated_variable_transitive.adoc +++ b/tests/docs/base/00_2default_calculated_variable_transitive.adoc @@ -18,22 +18,23 @@ var2: type: variable variable: _.var1 ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[domainname]` `basic` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[domainname]` `basic` `mandatory` `unique` `multiple` | A first variable. + -**Validator**: the domain name can be an IP +**Validator**: the domain name can be an IP | + **rougail.var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[domainname]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[domainname]` `standard` `mandatory` `unique` `multiple` | A second variable. + **Validator**: the domain name can be an IP + -**Default**: the value of the variable "rougail.var1". +**Default**: the value of the variable "rougail.var1". |==== - diff --git a/tests/docs/base/00_2default_calculated_variable_transitive.json b/tests/docs/base/00_2default_calculated_variable_transitive.json new file mode 100644 index 0000000..1c095fa --- /dev/null +++ b/tests/docs/base/00_2default_calculated_variable_transitive.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"var1": {"type": "variable", "properties": [{"type": "type", "name": "domainname"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "validators": ["the domain name can be an IP"], "paths": ["rougail.var1"], "names": ["var1"], "descriptions": ["A first variable."], "multiple": true}, "var2": {"type": "variable", "default": "the value of the variable \"rougail.var1\".", "properties": [{"type": "type", "name": "domainname"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "validators": ["the domain name can be an IP"], "paths": ["rougail.var2"], "names": ["var2"], "descriptions": ["A second variable."], "multiple": true}}}} \ No newline at end of file diff --git a/tests/docs/base/00_2default_calculated_variable_transitive.md b/tests/docs/base/00_2default_calculated_variable_transitive.md index 8cc20c1..73d4bd5 100644 --- a/tests/docs/base/00_2default_calculated_variable_transitive.md +++ b/tests/docs/base/00_2default_calculated_variable_transitive.md @@ -21,11 +21,10 @@ var2: type: variable variable: _.var1 ``` -# Variables for "rougail" +# Variables for "Rougail" | Variable                                                                                                                           | Description                                                                                                                        | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.var1**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | A first variable.
**Validator**: the domain name can be an IP | | **rougail.var2**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A second variable.
**Validator**: the domain name can be an IP
**Default**: the value of the variable "rougail.var1". | - diff --git a/tests/docs/base/00_4load_subfolder.adoc b/tests/docs/base/00_4load_subfolder.adoc index 6227b94..1c87836 100644 --- a/tests/docs/base/00_4load_subfolder.adoc +++ b/tests/docs/base/00_4load_subfolder.adoc @@ -16,19 +16,20 @@ version: '1.0' var2: description: a variable ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A variable. | + **rougail.var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A variable. |==== - diff --git a/tests/docs/base/00_4load_subfolder.json b/tests/docs/base/00_4load_subfolder.json new file mode 100644 index 0000000..94cc156 --- /dev/null +++ b/tests/docs/base/00_4load_subfolder.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"var1": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.var1"], "names": ["var1"], "descriptions": ["A variable."]}, "var2": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.var2"], "names": ["var2"], "descriptions": ["A variable."]}}}} \ No newline at end of file diff --git a/tests/docs/base/00_4load_subfolder.md b/tests/docs/base/00_4load_subfolder.md index 30f094b..852ef2b 100644 --- a/tests/docs/base/00_4load_subfolder.md +++ b/tests/docs/base/00_4load_subfolder.md @@ -18,11 +18,10 @@ version: '1.0' var2: description: a variable ``` -# Variables for "rougail" +# Variables for "Rougail" | Variable                                                                                                | Description                                                                                             | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | | **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | - diff --git a/tests/docs/base/00_5load_notype.adoc b/tests/docs/base/00_5load_notype.adoc index adaed11..e82c61c 100644 --- a/tests/docs/base/00_5load_notype.adoc +++ b/tests/docs/base/00_5load_notype.adoc @@ -8,16 +8,16 @@ without_type: description: a variable default: non ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.without_type** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A variable. + -**Default**: non +**Default**: non |==== - diff --git a/tests/docs/base/00_5load_notype.json b/tests/docs/base/00_5load_notype.json new file mode 100644 index 0000000..64e819f --- /dev/null +++ b/tests/docs/base/00_5load_notype.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"without_type": {"type": "variable", "default": "non", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.without_type"], "names": ["without_type"], "descriptions": ["A variable."]}}}} \ No newline at end of file diff --git a/tests/docs/base/00_5load_notype.md b/tests/docs/base/00_5load_notype.md index db2a83c..316bb29 100644 --- a/tests/docs/base/00_5load_notype.md +++ b/tests/docs/base/00_5load_notype.md @@ -11,10 +11,9 @@ without_type: description: a variable default: non ``` -# Variables for "rougail" +# Variables for "Rougail" | Variable                                                                                                   | Description                                                                                                | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.without_type**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: non | - diff --git a/tests/docs/base/00_6boolean.adoc b/tests/docs/base/00_6boolean.adoc index 053105e..5a6fc59 100644 --- a/tests/docs/base/00_6boolean.adoc +++ b/tests/docs/base/00_6boolean.adoc @@ -21,41 +21,46 @@ var6: type: boolean default: false ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | The first variable. + -**Default**: True +**Default**: true | + **rougail.var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | The second variable. + -**Default**: True +**Default**: true | + **rougail.var3** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | The third variable. + -**Default**: True +**Default**: true | + **rougail.var4** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | The forth variable. + -**Default**: False +**Default**: false | + **rougail.var5** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | The fifth variable. + -**Default**: False +**Default**: false | + **rougail.var6** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | The sixth variable. + -**Default**: False +**Default**: false |==== - diff --git a/tests/docs/base/00_6boolean.json b/tests/docs/base/00_6boolean.json new file mode 100644 index 0000000..5feb965 --- /dev/null +++ b/tests/docs/base/00_6boolean.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"var1": {"type": "variable", "default": true, "properties": [{"type": "type", "name": "boolean"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.var1"], "names": ["var1"], "descriptions": ["The first variable."]}, "var2": {"type": "variable", "default": true, "properties": [{"type": "type", "name": "boolean"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.var2"], "names": ["var2"], "descriptions": ["The second variable."]}, "var3": {"type": "variable", "default": true, "properties": [{"type": "type", "name": "boolean"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.var3"], "names": ["var3"], "descriptions": ["The third variable."]}, "var4": {"type": "variable", "default": false, "properties": [{"type": "type", "name": "boolean"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.var4"], "names": ["var4"], "descriptions": ["The forth variable."]}, "var5": {"type": "variable", "default": false, "properties": [{"type": "type", "name": "boolean"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.var5"], "names": ["var5"], "descriptions": ["The fifth variable."]}, "var6": {"type": "variable", "default": false, "properties": [{"type": "type", "name": "boolean"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.var6"], "names": ["var6"], "descriptions": ["The sixth variable."]}}}} \ No newline at end of file diff --git a/tests/docs/base/00_6boolean.md b/tests/docs/base/00_6boolean.md index 121a582..3ea429a 100644 --- a/tests/docs/base/00_6boolean.md +++ b/tests/docs/base/00_6boolean.md @@ -24,15 +24,14 @@ var6: type: boolean default: false ``` -# Variables for "rougail" +# Variables for "Rougail" | Variable                                                                                                    | Description                                                                                                 | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var1**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The first variable.
**Default**: True | -| **rougail.var2**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The second variable.
**Default**: True | -| **rougail.var3**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The third variable.
**Default**: True | -| **rougail.var4**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The forth variable.
**Default**: False | -| **rougail.var5**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The fifth variable.
**Default**: False | -| **rougail.var6**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The sixth variable.
**Default**: False | - +| **rougail.var1**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The first variable.
**Default**: true | +| **rougail.var2**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The second variable.
**Default**: true | +| **rougail.var3**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The third variable.
**Default**: true | +| **rougail.var4**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The forth variable.
**Default**: false | +| **rougail.var5**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The fifth variable.
**Default**: false | +| **rougail.var6**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The sixth variable.
**Default**: false | diff --git a/tests/docs/base/00_6boolean_no_mandatory.adoc b/tests/docs/base/00_6boolean_no_mandatory.adoc index b277a32..43188ba 100644 --- a/tests/docs/base/00_6boolean_no_mandatory.adoc +++ b/tests/docs/base/00_6boolean_no_mandatory.adoc @@ -9,16 +9,16 @@ variable: type: boolean mandatory: false ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` | A variable. + -**Default**: True +**Default**: true |==== - diff --git a/tests/docs/base/00_6boolean_no_mandatory.json b/tests/docs/base/00_6boolean_no_mandatory.json new file mode 100644 index 0000000..354f477 --- /dev/null +++ b/tests/docs/base/00_6boolean_no_mandatory.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"variable": {"type": "variable", "default": true, "properties": [{"type": "type", "name": "boolean"}, {"type": "mode", "name": "standard"}], "paths": ["rougail.variable"], "names": ["variable"], "descriptions": ["A variable."]}}}} \ No newline at end of file diff --git a/tests/docs/base/00_6boolean_no_mandatory.md b/tests/docs/base/00_6boolean_no_mandatory.md index c5a43cb..de6bdf4 100644 --- a/tests/docs/base/00_6boolean_no_mandatory.md +++ b/tests/docs/base/00_6boolean_no_mandatory.md @@ -12,10 +12,9 @@ variable: type: boolean mandatory: false ``` -# Variables for "rougail" +# Variables for "Rougail" | Variable                                                                                        | Description                                                                                     | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.variable**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A variable.
**Default**: True | - +| **rougail.variable**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A variable.
**Default**: true | diff --git a/tests/docs/base/00_6choice.adoc b/tests/docs/base/00_6choice.adoc index 21d5ae3..c68cce7 100644 --- a/tests/docs/base/00_6choice.adoc +++ b/tests/docs/base/00_6choice.adoc @@ -45,66 +45,71 @@ var6: - 3 default: 1 ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `basic` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `basic` `mandatory` | The first variable. + **Choices**: * a * b -* c +* c | + **rougail.var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `basic` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `basic` `mandatory` | The second variable. + **Choices**: * a * b -* c +* c | + **rougail.var3** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` | The third variable. + **Choices**: * a * b * c -* null +* null | + **rougail.var4** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` | The forth variable. + **Choices**: * null * b -* c +* c | + **rougail.var5** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` `mandatory` | The fifth variable. + **Choices**: * a ← (default) * b -* c +* c | + **rougail.var6** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` `mandatory` | The sixth variable. + **Choices**: * 1 ← (default) * 2 -* 3 +* 3 |==== - diff --git a/tests/docs/base/00_6choice.json b/tests/docs/base/00_6choice.json new file mode 100644 index 0000000..ee78d1c --- /dev/null +++ b/tests/docs/base/00_6choice.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"var1": {"type": "variable", "properties": [{"type": "type", "name": "choice"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "choices": ["a", "b", "c"], "paths": ["rougail.var1"], "names": ["var1"], "descriptions": ["The first variable."]}, "var2": {"type": "variable", "properties": [{"type": "type", "name": "choice"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "choices": ["a", "b", "c"], "paths": ["rougail.var2"], "names": ["var2"], "descriptions": ["The second variable."]}, "var3": {"type": "variable", "properties": [{"type": "type", "name": "choice"}, {"type": "mode", "name": "standard"}], "choices": ["a", "b", "c", null], "paths": ["rougail.var3"], "names": ["var3"], "descriptions": ["The third variable."]}, "var4": {"type": "variable", "properties": [{"type": "type", "name": "choice"}, {"type": "mode", "name": "standard"}], "choices": [null, "b", "c"], "paths": ["rougail.var4"], "names": ["var4"], "descriptions": ["The forth variable."]}, "var5": {"type": "variable", "default": "a", "properties": [{"type": "type", "name": "choice"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "display_default": false, "choices": ["a ← (default)", "b", "c"], "paths": ["rougail.var5"], "names": ["var5"], "descriptions": ["The fifth variable."]}, "var6": {"type": "variable", "default": 1, "properties": [{"type": "type", "name": "choice"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "display_default": false, "choices": ["1 ← (default)", 2, 3], "paths": ["rougail.var6"], "names": ["var6"], "descriptions": ["The sixth variable."]}}}} \ No newline at end of file diff --git a/tests/docs/base/00_6choice.md b/tests/docs/base/00_6choice.md index f73083d..5f8400c 100644 --- a/tests/docs/base/00_6choice.md +++ b/tests/docs/base/00_6choice.md @@ -48,7 +48,7 @@ var6: - 3 default: 1 ``` -# Variables for "rougail" +# Variables for "Rougail" | Variable                                                                                                   | Description                                                                                                | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| @@ -59,4 +59,3 @@ var6: | **rougail.var5**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The fifth variable.
**Choices**:
- a ← (default)
- b
- c | | **rougail.var6**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The sixth variable.
**Choices**:
- 1 ← (default)
- 2
- 3 | - diff --git a/tests/docs/base/00_6choice_calculation.adoc b/tests/docs/base/00_6choice_calculation.adoc index c3c281c..38931bc 100644 --- a/tests/docs/base/00_6choice_calculation.adoc +++ b/tests/docs/base/00_6choice_calculation.adoc @@ -15,17 +15,17 @@ var: return_type: number description: choices is 0 to 9 ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` `mandatory` | A variable. + **Choices**: choices is 0 to 9. + -**Default**: 9 +**Default**: 9 |==== - diff --git a/tests/docs/base/00_6choice_calculation.json b/tests/docs/base/00_6choice_calculation.json new file mode 100644 index 0000000..61381f3 --- /dev/null +++ b/tests/docs/base/00_6choice_calculation.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"var": {"type": "variable", "default": 9, "properties": [{"type": "type", "name": "choice"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "choices": "choices is 0 to 9.", "paths": ["rougail.var"], "names": ["var"], "descriptions": ["A variable."]}}}} \ No newline at end of file diff --git a/tests/docs/base/00_6choice_calculation.md b/tests/docs/base/00_6choice_calculation.md index 310cd4a..50cd345 100644 --- a/tests/docs/base/00_6choice_calculation.md +++ b/tests/docs/base/00_6choice_calculation.md @@ -18,10 +18,9 @@ var: return_type: number description: choices is 0 to 9 ``` -# Variables for "rougail" +# Variables for "Rougail" | Variable                                                                                                   | Description                                                                                                | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.var**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Choices**: choices is 0 to 9.
**Default**: 9 | - diff --git a/tests/docs/base/00_6choice_variable.adoc b/tests/docs/base/00_6choice_variable.adoc index 7adbba6..14324ef 100644 --- a/tests/docs/base/00_6choice_variable.adoc +++ b/tests/docs/base/00_6choice_variable.adoc @@ -14,26 +14,27 @@ var2: choices: variable: _.var1 ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | A second variable. + **Default**: * a * b -* c +* c | + **rougail.var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` `mandatory` | A first variable. + **Choices**: the value of the variable "rougail.var1". + -**Default**: a +**Default**: a |==== - diff --git a/tests/docs/base/00_6choice_variable.json b/tests/docs/base/00_6choice_variable.json new file mode 100644 index 0000000..51bf457 --- /dev/null +++ b/tests/docs/base/00_6choice_variable.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"var1": {"type": "variable", "default": ["a", "b", "c"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var1"], "names": ["var1"], "descriptions": ["A second variable."], "multiple": true}, "var2": {"type": "variable", "default": "a", "properties": [{"type": "type", "name": "choice"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "choices": "the value of the variable \"rougail.var1\".", "paths": ["rougail.var2"], "names": ["var2"], "descriptions": ["A first variable."]}}}} \ No newline at end of file diff --git a/tests/docs/base/00_6choice_variable.md b/tests/docs/base/00_6choice_variable.md index a9d712a..3db36d4 100644 --- a/tests/docs/base/00_6choice_variable.md +++ b/tests/docs/base/00_6choice_variable.md @@ -17,11 +17,10 @@ var2: choices: variable: _.var1 ``` -# Variables for "rougail" - -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A second variable.
**Default**:
- a
- b
- c | -| **rougail.var2**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A first variable.
**Choices**: the value of the variable "rougail.var1".
**Default**: a | +# Variables for "Rougail" +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A second variable.
**Default**:
- a
- b
- c | +| **rougail.var2**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A first variable.
**Choices**: the value of the variable "rougail.var1".
**Default**: a | diff --git a/tests/docs/base/00_6custom.adoc b/tests/docs/base/00_6custom.adoc index f9fe14b..32d416f 100644 --- a/tests/docs/base/00_6custom.adoc +++ b/tests/docs/base/00_6custom.adoc @@ -12,20 +12,21 @@ custom2: type: custom default: value ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.custom1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[custom]` `basic` `mandatory` | -The first variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[custom]` `basic` `mandatory` | +The first variable. | + **rougail.custom2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[custom]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[custom]` `standard` `mandatory` | The seconf variable. + -**Default**: value +**Default**: value |==== - diff --git a/tests/docs/base/00_6custom.json b/tests/docs/base/00_6custom.json new file mode 100644 index 0000000..1d74ef5 --- /dev/null +++ b/tests/docs/base/00_6custom.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"custom1": {"type": "variable", "properties": [{"type": "type", "name": "custom"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.custom1"], "names": ["custom1"], "descriptions": ["The first variable."]}, "custom2": {"type": "variable", "default": "value", "properties": [{"type": "type", "name": "custom"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.custom2"], "names": ["custom2"], "descriptions": ["The seconf variable."]}}}} \ No newline at end of file diff --git a/tests/docs/base/00_6custom.md b/tests/docs/base/00_6custom.md index 309859e..f01da56 100644 --- a/tests/docs/base/00_6custom.md +++ b/tests/docs/base/00_6custom.md @@ -15,11 +15,10 @@ custom2: type: custom default: value ``` -# Variables for "rougail" +# Variables for "Rougail" | Variable                                                                                                   | Description                                                                                                | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.custom1**
[`custom`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The first variable. | | **rougail.custom2**
[`custom`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The seconf variable.
**Default**: value | - diff --git a/tests/docs/base/00_6domainname.adoc b/tests/docs/base/00_6domainname.adoc index 561477a..5a49795 100644 --- a/tests/docs/base/00_6domainname.adoc +++ b/tests/docs/base/00_6domainname.adoc @@ -9,16 +9,16 @@ variable: type: domainname default: my.domain.name ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[domainname]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[domainname]` `standard` `mandatory` | A domain name variable. + -**Default**: my.domain.name +**Default**: my.domain.name |==== - diff --git a/tests/docs/base/00_6domainname.json b/tests/docs/base/00_6domainname.json new file mode 100644 index 0000000..9a8ae68 --- /dev/null +++ b/tests/docs/base/00_6domainname.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"variable": {"type": "variable", "default": "my.domain.name", "properties": [{"type": "type", "name": "domainname"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.variable"], "names": ["variable"], "descriptions": ["A domain name variable."]}}}} \ No newline at end of file diff --git a/tests/docs/base/00_6domainname.md b/tests/docs/base/00_6domainname.md index ff7c628..1548eef 100644 --- a/tests/docs/base/00_6domainname.md +++ b/tests/docs/base/00_6domainname.md @@ -12,10 +12,9 @@ variable: type: domainname default: my.domain.name ``` -# Variables for "rougail" +# Variables for "Rougail" | Variable                                                                                                       | Description                                                                                                    | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.variable**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A domain name variable.
**Default**: my.domain.name | - diff --git a/tests/docs/base/00_6domainname_params.adoc b/tests/docs/base/00_6domainname_params.adoc index 6831946..ceaec45 100644 --- a/tests/docs/base/00_6domainname_params.adoc +++ b/tests/docs/base/00_6domainname_params.adoc @@ -11,17 +11,17 @@ variable: params: allow_ip: true ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[domainname]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[domainname]` `standard` `mandatory` | A domain name variable. + **Validator**: the domain name can be an IP + -**Default**: my.domain.name +**Default**: my.domain.name |==== - diff --git a/tests/docs/base/00_6domainname_params.json b/tests/docs/base/00_6domainname_params.json new file mode 100644 index 0000000..1001025 --- /dev/null +++ b/tests/docs/base/00_6domainname_params.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"variable": {"type": "variable", "default": "my.domain.name", "properties": [{"type": "type", "name": "domainname"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "validators": ["the domain name can be an IP"], "paths": ["rougail.variable"], "names": ["variable"], "descriptions": ["A domain name variable."]}}}} \ No newline at end of file diff --git a/tests/docs/base/00_6domainname_params.md b/tests/docs/base/00_6domainname_params.md index 56d08d5..0810f9d 100644 --- a/tests/docs/base/00_6domainname_params.md +++ b/tests/docs/base/00_6domainname_params.md @@ -14,10 +14,9 @@ variable: params: allow_ip: true ``` -# Variables for "rougail" +# Variables for "Rougail" | Variable                                                                                                       | Description                                                                                                    | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.variable**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A domain name variable.
**Validator**: the domain name can be an IP
**Default**: my.domain.name | - diff --git a/tests/docs/base/00_6float.adoc b/tests/docs/base/00_6float.adoc index 43b55c6..ae54776 100644 --- a/tests/docs/base/00_6float.adoc +++ b/tests/docs/base/00_6float.adoc @@ -21,41 +21,46 @@ var6: type: float default: 10.1 ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` | The first variable. + -**Default**: 0.0 +**Default**: 0.0 | + **rougail.var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` | The second variable. + -**Default**: 0.0 +**Default**: 0.0 | + **rougail.var3** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` | The third variable. + -**Default**: 0.0 +**Default**: 0.0 | + **rougail.var4** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` | The forth variable. + -**Default**: 10.1 +**Default**: 10.1 | + **rougail.var5** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` | The fifth variable. + -**Default**: 10.1 +**Default**: 10.1 | + **rougail.var6** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` | The sixth variable. + -**Default**: 10.1 +**Default**: 10.1 |==== - diff --git a/tests/docs/base/00_6float.json b/tests/docs/base/00_6float.json new file mode 100644 index 0000000..588e924 --- /dev/null +++ b/tests/docs/base/00_6float.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"var1": {"type": "variable", "default": 0.0, "properties": [{"type": "type", "name": "float"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.var1"], "names": ["var1"], "descriptions": ["The first variable."]}, "var2": {"type": "variable", "default": 0.0, "properties": [{"type": "type", "name": "float"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.var2"], "names": ["var2"], "descriptions": ["The second variable."]}, "var3": {"type": "variable", "default": 0.0, "properties": [{"type": "type", "name": "float"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.var3"], "names": ["var3"], "descriptions": ["The third variable."]}, "var4": {"type": "variable", "default": 10.1, "properties": [{"type": "type", "name": "float"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.var4"], "names": ["var4"], "descriptions": ["The forth variable."]}, "var5": {"type": "variable", "default": 10.1, "properties": [{"type": "type", "name": "float"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.var5"], "names": ["var5"], "descriptions": ["The fifth variable."]}, "var6": {"type": "variable", "default": 10.1, "properties": [{"type": "type", "name": "float"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.var6"], "names": ["var6"], "descriptions": ["The sixth variable."]}}}} \ No newline at end of file diff --git a/tests/docs/base/00_6float.md b/tests/docs/base/00_6float.md index 2f8ed9c..40f6cfd 100644 --- a/tests/docs/base/00_6float.md +++ b/tests/docs/base/00_6float.md @@ -24,7 +24,7 @@ var6: type: float default: 10.1 ``` -# Variables for "rougail" +# Variables for "Rougail" | Variable                                                                                                  | Description                                                                                               | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| @@ -35,4 +35,3 @@ var6: | **rougail.var5**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The fifth variable.
**Default**: 10.1 | | **rougail.var6**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The sixth variable.
**Default**: 10.1 | - diff --git a/tests/docs/base/00_6number.adoc b/tests/docs/base/00_6number.adoc index a59cf29..7307a04 100644 --- a/tests/docs/base/00_6number.adoc +++ b/tests/docs/base/00_6number.adoc @@ -21,41 +21,46 @@ var6: type: number default: 10 ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` | The first variable. + -**Default**: 0 +**Default**: 0 | + **rougail.var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` | The second variable. + -**Default**: 0 +**Default**: 0 | + **rougail.var3** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` | The third variable. + -**Default**: 0 +**Default**: 0 | + **rougail.var4** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` | This forth variable. + -**Default**: 10 +**Default**: 10 | + **rougail.var5** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` | The fifth variable. + -**Default**: 10 +**Default**: 10 | + **rougail.var6** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` | The sixth variable. + -**Default**: 10 +**Default**: 10 |==== - diff --git a/tests/docs/base/00_6number.json b/tests/docs/base/00_6number.json new file mode 100644 index 0000000..31cb688 --- /dev/null +++ b/tests/docs/base/00_6number.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"var1": {"type": "variable", "default": 0, "properties": [{"type": "type", "name": "number"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.var1"], "names": ["var1"], "descriptions": ["The first variable."]}, "var2": {"type": "variable", "default": 0, "properties": [{"type": "type", "name": "number"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.var2"], "names": ["var2"], "descriptions": ["The second variable."]}, "var3": {"type": "variable", "default": 0, "properties": [{"type": "type", "name": "number"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.var3"], "names": ["var3"], "descriptions": ["The third variable."]}, "var4": {"type": "variable", "default": 10, "properties": [{"type": "type", "name": "number"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.var4"], "names": ["var4"], "descriptions": ["This forth variable."]}, "var5": {"type": "variable", "default": 10, "properties": [{"type": "type", "name": "number"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.var5"], "names": ["var5"], "descriptions": ["The fifth variable."]}, "var6": {"type": "variable", "default": 10, "properties": [{"type": "type", "name": "number"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.var6"], "names": ["var6"], "descriptions": ["The sixth variable."]}}}} \ No newline at end of file diff --git a/tests/docs/base/00_6number.md b/tests/docs/base/00_6number.md index 8190c7c..fcb7e20 100644 --- a/tests/docs/base/00_6number.md +++ b/tests/docs/base/00_6number.md @@ -24,7 +24,7 @@ var6: type: number default: 10 ``` -# Variables for "rougail" +# Variables for "Rougail" | Variable                                                                                                   | Description                                                                                                | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| @@ -35,4 +35,3 @@ var6: | **rougail.var5**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The fifth variable.
**Default**: 10 | | **rougail.var6**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The sixth variable.
**Default**: 10 | - diff --git a/tests/docs/base/00_6port.adoc b/tests/docs/base/00_6port.adoc index dbed9ff..fcefcfa 100644 --- a/tests/docs/base/00_6port.adoc +++ b/tests/docs/base/00_6port.adoc @@ -16,25 +16,27 @@ variable3: type: port default: 8080 ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.variable1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[port]` `basic` `mandatory` | -A port variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[port]` `basic` `mandatory` | +A port variable. | + **rougail.variable2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[port]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[port]` `standard` `mandatory` | A port variable with default value. + -**Default**: 8080 +**Default**: 8080 | + **rougail.variable3** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[port]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[port]` `standard` `mandatory` | A port variable with integer default value. + -**Default**: 8080 +**Default**: 8080 |==== - diff --git a/tests/docs/base/00_6port.json b/tests/docs/base/00_6port.json new file mode 100644 index 0000000..9d87c32 --- /dev/null +++ b/tests/docs/base/00_6port.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"variable1": {"type": "variable", "properties": [{"type": "type", "name": "port"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.variable1"], "names": ["variable1"], "descriptions": ["A port variable."]}, "variable2": {"type": "variable", "default": "8080", "properties": [{"type": "type", "name": "port"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.variable2"], "names": ["variable2"], "descriptions": ["A port variable with default value."]}, "variable3": {"type": "variable", "default": "8080", "properties": [{"type": "type", "name": "port"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.variable3"], "names": ["variable3"], "descriptions": ["A port variable with integer default value."]}}}} \ No newline at end of file diff --git a/tests/docs/base/00_6port.md b/tests/docs/base/00_6port.md index b5265dd..634bfce 100644 --- a/tests/docs/base/00_6port.md +++ b/tests/docs/base/00_6port.md @@ -19,7 +19,7 @@ variable3: type: port default: 8080 ``` -# Variables for "rougail" +# Variables for "Rougail" | Variable                                                                                                 | Description                                                                                              | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| @@ -27,4 +27,3 @@ variable3: | **rougail.variable2**
[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A port variable with default value.
**Default**: 8080 | | **rougail.variable3**
[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A port variable with integer default value.
**Default**: 8080 | - diff --git a/tests/docs/base/00_6regexp.adoc b/tests/docs/base/00_6regexp.adoc index a96a914..a10d1f4 100644 --- a/tests/docs/base/00_6regexp.adoc +++ b/tests/docs/base/00_6regexp.adoc @@ -12,17 +12,21 @@ var: - '#b1b1b1' - '#b2b2b2' ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[regexp]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[regexp]` `standard` `mandatory` | A first variable. + +**Validator**: text based with regular expressions "^#(?:[0-9a-f]{3}){1,2}$" + **Default**: #a1a1a1 + -**Example**: #b1b1b1 +**Examples**: + +* '#b1b1b1' +* '#b2b2b2' |==== - diff --git a/tests/docs/base/00_6regexp.json b/tests/docs/base/00_6regexp.json new file mode 100644 index 0000000..7f968c8 --- /dev/null +++ b/tests/docs/base/00_6regexp.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"var": {"type": "variable", "default": "#a1a1a1", "properties": [{"type": "type", "name": "regexp"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "validators": ["text based with regular expressions \"^#(?:[0-9a-f]{3}){1,2}$\""], "paths": ["rougail.var"], "names": ["var"], "descriptions": ["A first variable."], "examples": ["#b1b1b1", "#b2b2b2"]}}}} \ No newline at end of file diff --git a/tests/docs/base/00_6regexp.md b/tests/docs/base/00_6regexp.md index 8b99522..f1afb7a 100644 --- a/tests/docs/base/00_6regexp.md +++ b/tests/docs/base/00_6regexp.md @@ -15,10 +15,9 @@ var: - '#b1b1b1' - '#b2b2b2' ``` -# Variables for "rougail" +# Variables for "Rougail" | Variable                                                                                                   | Description                                                                                                | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var**
[`regexp`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A first variable.
**Default**: #a1a1a1
**Example**: #b1b1b1 | - +| **rougail.var**
[`regexp`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A first variable.
**Validator**: text based with regular expressions "^#(?:[0-9a-f]{3}){1,2}$"
**Default**: #a1a1a1
**Examples**:
- #b1b1b1
- #b2b2b2 | diff --git a/tests/docs/base/00_6string.adoc b/tests/docs/base/00_6string.adoc index 63484b6..7fd0754 100644 --- a/tests/docs/base/00_6string.adoc +++ b/tests/docs/base/00_6string.adoc @@ -20,38 +20,43 @@ var6: type: string default: value ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -The first variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +The first variable. | + **rougail.var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -The second variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +The second variable. | + **rougail.var3** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -The third variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +The third variable. | + **rougail.var4** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | The forth variable. + -**Default**: value +**Default**: value | + **rougail.var5** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | The fifth variable. + -**Default**: value +**Default**: value | + **rougail.var6** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | The sixth variable. + -**Default**: value +**Default**: value |==== - diff --git a/tests/docs/base/00_6string.json b/tests/docs/base/00_6string.json new file mode 100644 index 0000000..82b024c --- /dev/null +++ b/tests/docs/base/00_6string.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"var1": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.var1"], "names": ["var1"], "descriptions": ["The first variable."]}, "var2": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.var2"], "names": ["var2"], "descriptions": ["The second variable."]}, "var3": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.var3"], "names": ["var3"], "descriptions": ["The third variable."]}, "var4": {"type": "variable", "default": "value", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.var4"], "names": ["var4"], "descriptions": ["The forth variable."]}, "var5": {"type": "variable", "default": "value", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.var5"], "names": ["var5"], "descriptions": ["The fifth variable."]}, "var6": {"type": "variable", "default": "value", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.var6"], "names": ["var6"], "descriptions": ["The sixth variable."]}}}} \ No newline at end of file diff --git a/tests/docs/base/00_6string.md b/tests/docs/base/00_6string.md index ebe5e77..5645749 100644 --- a/tests/docs/base/00_6string.md +++ b/tests/docs/base/00_6string.md @@ -23,7 +23,7 @@ var6: type: string default: value ``` -# Variables for "rougail" +# Variables for "Rougail" | Variable                                                                                                   | Description                                                                                                | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| @@ -34,4 +34,3 @@ var6: | **rougail.var5**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The fifth variable.
**Default**: value | | **rougail.var6**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The sixth variable.
**Default**: value | - diff --git a/tests/docs/base/00_7choice_quote.adoc b/tests/docs/base/00_7choice_quote.adoc index e9a1c5e..7784a1b 100644 --- a/tests/docs/base/00_7choice_quote.adoc +++ b/tests/docs/base/00_7choice_quote.adoc @@ -13,20 +13,20 @@ var: - quote" - quote"' ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` `mandatory` | A choice. + **Choices**: * quote' ← (default) * quote" -* quote"' +* quote"' |==== - diff --git a/tests/docs/base/00_7choice_quote.json b/tests/docs/base/00_7choice_quote.json new file mode 100644 index 0000000..e74475c --- /dev/null +++ b/tests/docs/base/00_7choice_quote.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"var": {"type": "variable", "default": "quote'", "properties": [{"type": "type", "name": "choice"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "display_default": false, "choices": ["quote' ← (default)", "quote\"", "quote\"'"], "paths": ["rougail.var"], "names": ["var"], "descriptions": ["A choice."]}}}} \ No newline at end of file diff --git a/tests/docs/base/00_7choice_quote.md b/tests/docs/base/00_7choice_quote.md index c2bd355..514ba79 100644 --- a/tests/docs/base/00_7choice_quote.md +++ b/tests/docs/base/00_7choice_quote.md @@ -16,10 +16,9 @@ var: - quote" - quote"' ``` -# Variables for "rougail" +# Variables for "Rougail" | Variable                                                                                                   | Description                                                                                                | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.var**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A choice.
**Choices**:
- quote' ← (default)
- quote"
- quote"' | - diff --git a/tests/docs/base/00_7help_quote.adoc b/tests/docs/base/00_7help_quote.adoc index ff68e0d..4475950 100644 --- a/tests/docs/base/00_7help_quote.adoc +++ b/tests/docs/base/00_7help_quote.adoc @@ -11,21 +11,22 @@ var2: description: the second variable help: message with " ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | The first variable. + -Message with '. +Message with '. | + **rougail.var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | The second variable. + -Message with ". +Message with ". |==== - diff --git a/tests/docs/base/00_7help_quote.json b/tests/docs/base/00_7help_quote.json new file mode 100644 index 0000000..f5fdc0c --- /dev/null +++ b/tests/docs/base/00_7help_quote.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"var1": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.var1"], "names": ["var1"], "help": ["Message with '."], "descriptions": ["The first variable."]}, "var2": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.var2"], "names": ["var2"], "help": ["Message with \"."], "descriptions": ["The second variable."]}}}} \ No newline at end of file diff --git a/tests/docs/base/00_7help_quote.md b/tests/docs/base/00_7help_quote.md index 3ea6b9c..41c3ab8 100644 --- a/tests/docs/base/00_7help_quote.md +++ b/tests/docs/base/00_7help_quote.md @@ -14,11 +14,10 @@ var2: description: the second variable help: message with " ``` -# Variables for "rougail" +# Variables for "Rougail" | Variable                                                                                                | Description                                                                                             | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The first variable.
Message with '. | | **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The second variable.
Message with ". | - diff --git a/tests/docs/base/00_7value_doublequote.adoc b/tests/docs/base/00_7value_doublequote.adoc index 6dfab6a..08da4d4 100644 --- a/tests/docs/base/00_7value_doublequote.adoc +++ b/tests/docs/base/00_7value_doublequote.adoc @@ -8,16 +8,16 @@ variable: description: a variable default: quote" ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A variable. + -**Default**: quote" +**Default**: quote" |==== - diff --git a/tests/docs/base/00_7value_doublequote.json b/tests/docs/base/00_7value_doublequote.json new file mode 100644 index 0000000..9da038c --- /dev/null +++ b/tests/docs/base/00_7value_doublequote.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"variable": {"type": "variable", "default": "quote\"", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.variable"], "names": ["variable"], "descriptions": ["A variable."]}}}} \ No newline at end of file diff --git a/tests/docs/base/00_7value_doublequote.md b/tests/docs/base/00_7value_doublequote.md index 5b0e4ad..1424ea4 100644 --- a/tests/docs/base/00_7value_doublequote.md +++ b/tests/docs/base/00_7value_doublequote.md @@ -11,10 +11,9 @@ variable: description: a variable default: quote" ``` -# Variables for "rougail" +# Variables for "Rougail" | Variable                                                                                                   | Description                                                                                                | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: quote" | - diff --git a/tests/docs/base/00_7value_doublequote2.adoc b/tests/docs/base/00_7value_doublequote2.adoc index 86d1e66..b760514 100644 --- a/tests/docs/base/00_7value_doublequote2.adoc +++ b/tests/docs/base/00_7value_doublequote2.adoc @@ -8,16 +8,16 @@ variable: description: a variable default: quote'" ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A variable. + -**Default**: quote'" +**Default**: quote'" |==== - diff --git a/tests/docs/base/00_7value_doublequote2.json b/tests/docs/base/00_7value_doublequote2.json new file mode 100644 index 0000000..a9fe72a --- /dev/null +++ b/tests/docs/base/00_7value_doublequote2.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"variable": {"type": "variable", "default": "quote'\"", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.variable"], "names": ["variable"], "descriptions": ["A variable."]}}}} \ No newline at end of file diff --git a/tests/docs/base/00_7value_doublequote2.md b/tests/docs/base/00_7value_doublequote2.md index a8de0c8..92d83dd 100644 --- a/tests/docs/base/00_7value_doublequote2.md +++ b/tests/docs/base/00_7value_doublequote2.md @@ -11,10 +11,9 @@ variable: description: a variable default: quote'" ``` -# Variables for "rougail" +# Variables for "Rougail" | Variable                                                                                                   | Description                                                                                                | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: quote'" | - diff --git a/tests/docs/base/00_7value_doublequote3.adoc b/tests/docs/base/00_7value_doublequote3.adoc index 725dd44..9329142 100644 --- a/tests/docs/base/00_7value_doublequote3.adoc +++ b/tests/docs/base/00_7value_doublequote3.adoc @@ -9,16 +9,16 @@ variable: description: a variable default: quote\"\' ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A variable. + -**Default**: quote\"\' +**Default**: quote\"\' |==== - diff --git a/tests/docs/base/00_7value_doublequote3.json b/tests/docs/base/00_7value_doublequote3.json new file mode 100644 index 0000000..4739a56 --- /dev/null +++ b/tests/docs/base/00_7value_doublequote3.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"variable": {"type": "variable", "default": "quote\\\"\\'", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.variable"], "names": ["variable"], "descriptions": ["A variable."]}}}} \ No newline at end of file diff --git a/tests/docs/base/00_7value_doublequote3.md b/tests/docs/base/00_7value_doublequote3.md index 6034396..29b2738 100644 --- a/tests/docs/base/00_7value_doublequote3.md +++ b/tests/docs/base/00_7value_doublequote3.md @@ -12,10 +12,9 @@ variable: description: a variable default: quote\"\' ``` -# Variables for "rougail" +# Variables for "Rougail" | Variable                                                                                                   | Description                                                                                                | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: quote\"\' | - diff --git a/tests/docs/base/00_7value_quote.adoc b/tests/docs/base/00_7value_quote.adoc index 3d70bc6..0a7a1aa 100644 --- a/tests/docs/base/00_7value_quote.adoc +++ b/tests/docs/base/00_7value_quote.adoc @@ -8,16 +8,16 @@ variable: description: a variable default: quote' ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A variable. + -**Default**: quote' +**Default**: quote' |==== - diff --git a/tests/docs/base/00_7value_quote.json b/tests/docs/base/00_7value_quote.json new file mode 100644 index 0000000..17417d2 --- /dev/null +++ b/tests/docs/base/00_7value_quote.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"variable": {"type": "variable", "default": "quote'", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.variable"], "names": ["variable"], "descriptions": ["A variable."]}}}} \ No newline at end of file diff --git a/tests/docs/base/00_7value_quote.md b/tests/docs/base/00_7value_quote.md index 1e77137..2ee6b16 100644 --- a/tests/docs/base/00_7value_quote.md +++ b/tests/docs/base/00_7value_quote.md @@ -11,10 +11,9 @@ variable: description: a variable default: quote' ``` -# Variables for "rougail" +# Variables for "Rougail" | Variable                                                                                                   | Description                                                                                                | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: quote' | - diff --git a/tests/docs/base/00_8calculation_information.adoc b/tests/docs/base/00_8calculation_information.adoc index 7c881cf..f73ed36 100644 --- a/tests/docs/base/00_8calculation_information.adoc +++ b/tests/docs/base/00_8calculation_information.adoc @@ -15,16 +15,16 @@ variable: information: test_information description: get information test_information ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A variable. + -**Default**: get information test_information. +**Default**: get information test_information. |==== - diff --git a/tests/docs/base/00_8calculation_information.json b/tests/docs/base/00_8calculation_information.json new file mode 100644 index 0000000..68baeb3 --- /dev/null +++ b/tests/docs/base/00_8calculation_information.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"variable": {"type": "variable", "default": "get information test_information.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.variable"], "names": ["variable"], "descriptions": ["A variable."]}}}} \ No newline at end of file diff --git a/tests/docs/base/00_8calculation_information.md b/tests/docs/base/00_8calculation_information.md index b0e148f..e9bbb52 100644 --- a/tests/docs/base/00_8calculation_information.md +++ b/tests/docs/base/00_8calculation_information.md @@ -18,10 +18,9 @@ variable: information: test_information description: get information test_information ``` -# Variables for "rougail" +# Variables for "Rougail" | Variable                                                                                                   | Description                                                                                                | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: get information test_information. | - diff --git a/tests/docs/base/00_8test.adoc b/tests/docs/base/00_8test.adoc index 5369a7e..297737f 100644 --- a/tests/docs/base/00_8test.adoc +++ b/tests/docs/base/00_8test.adoc @@ -43,46 +43,58 @@ var6: - test1 - test2 ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | The first variable. + -**Example**: test +**Example**: test | + **rougail.var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | The second variable. + **Default**: value + -**Example**: test +**Example**: test | + **rougail.var3** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | The third variable. + -**Example**: test1 +**Examples**: + +* test1 +* test2 | + **rougail.var4** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | The forth variable. + -**Example**: None +**Examples**: + +* null +* test1 +* test2 | + **rougail.var5** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | The fifth variable. + -**Default**: True + -**Example**: False +**Default**: true + +**Example**: false | + **rougail.var6** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | The sixth variable. + **Examples**: * test1 -* test2 +* test2 |==== - diff --git a/tests/docs/base/00_8test.json b/tests/docs/base/00_8test.json new file mode 100644 index 0000000..ee533e6 --- /dev/null +++ b/tests/docs/base/00_8test.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"var1": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.var1"], "names": ["var1"], "descriptions": ["The first variable."], "examples": ["test"]}, "var2": {"type": "variable", "default": "value", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.var2"], "names": ["var2"], "descriptions": ["The second variable."], "examples": ["test"]}, "var3": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.var3"], "names": ["var3"], "descriptions": ["The third variable."], "examples": ["test1", "test2"]}, "var4": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}], "paths": ["rougail.var4"], "names": ["var4"], "descriptions": ["The forth variable."], "examples": [null, "test1", "test2"]}, "var5": {"type": "variable", "default": true, "properties": [{"type": "type", "name": "boolean"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.var5"], "names": ["var5"], "descriptions": ["The fifth variable."], "examples": [false]}, "var6": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var6"], "names": ["var6"], "descriptions": ["The sixth variable."], "multiple": true, "examples": ["test1", "test2"]}}}} \ No newline at end of file diff --git a/tests/docs/base/00_8test.md b/tests/docs/base/00_8test.md index 4622dc9..469f532 100644 --- a/tests/docs/base/00_8test.md +++ b/tests/docs/base/00_8test.md @@ -46,15 +46,14 @@ var6: - test1 - test2 ``` -# Variables for "rougail" +# Variables for "Rougail" | Variable                                                                                                                    | Description                                                                                                                 | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The first variable.
**Example**: test | | **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The second variable.
**Default**: value
**Example**: test | -| **rougail.var3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The third variable.
**Example**: test1 | -| **rougail.var4**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | The forth variable.
**Example**: None | -| **rougail.var5**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The fifth variable.
**Default**: True
**Example**: False | +| **rougail.var3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The third variable.
**Examples**:
- test1
- test2 | +| **rougail.var4**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | The forth variable.
**Examples**:
- null
- test1
- test2 | +| **rougail.var5**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The fifth variable.
**Default**: true
**Example**: false | | **rougail.var6**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | The sixth variable.
**Examples**:
- test1
- test2 | - diff --git a/tests/docs/base/00_9choice_variable_multi.adoc b/tests/docs/base/00_9choice_variable_multi.adoc index 0d12d31..c6e353d 100644 --- a/tests/docs/base/00_9choice_variable_multi.adoc +++ b/tests/docs/base/00_9choice_variable_multi.adoc @@ -20,27 +20,28 @@ variable2: - val1 - val2 ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.variable1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `basic` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `basic` `mandatory` `unique` `multiple` | A first variable. + **Choices**: * val1 -* val2 +* val2 | + **rougail.variable2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` `unique` `multiple` | A second variable. + **Choices**: * val1 -* val2 +* val2 |==== - diff --git a/tests/docs/base/00_9choice_variable_multi.json b/tests/docs/base/00_9choice_variable_multi.json new file mode 100644 index 0000000..5351fe8 --- /dev/null +++ b/tests/docs/base/00_9choice_variable_multi.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"variable1": {"type": "variable", "properties": [{"type": "type", "name": "choice"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "choices": ["val1", "val2"], "paths": ["rougail.variable1"], "names": ["variable1"], "descriptions": ["A first variable."], "multiple": true}, "variable2": {"type": "variable", "properties": [{"type": "type", "name": "choice"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "choices": ["val1", "val2"], "paths": ["rougail.variable2"], "names": ["variable2"], "descriptions": ["A second variable."], "multiple": true}}}} \ No newline at end of file diff --git a/tests/docs/base/00_9choice_variable_multi.md b/tests/docs/base/00_9choice_variable_multi.md index cbb9dbf..72b5bdb 100644 --- a/tests/docs/base/00_9choice_variable_multi.md +++ b/tests/docs/base/00_9choice_variable_multi.md @@ -23,11 +23,10 @@ variable2: - val1 - val2 ``` -# Variables for "rougail" - -| Variable                                                                                                           | Description                                                                                                        | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.variable1**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | A first variable.
**Choices**:
- val1
- val2 | -| **rougail.variable2**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A second variable.
**Choices**:
- val1
- val2 | +# Variables for "Rougail" +| Variable                                                                                                                    | Description                                                                                                                 | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.variable1**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | A first variable.
**Choices**:
- val1
- val2 | +| **rougail.variable2**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A second variable.
**Choices**:
- val1
- val2 | diff --git a/tests/docs/base/00_9choice_variables.adoc b/tests/docs/base/00_9choice_variables.adoc index 8ed564d..1f093e0 100644 --- a/tests/docs/base/00_9choice_variables.adoc +++ b/tests/docs/base/00_9choice_variables.adoc @@ -14,31 +14,33 @@ my_variable: - variable: _.source_variable_2 default: val1 ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.source_variable_1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | The first source variable. + -**Default**: val1 +**Default**: val1 | + **rougail.source_variable_2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | The second source variable. + -**Default**: val2 +**Default**: val2 | + **rougail.my_variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` `mandatory` | A variable. + **Choices**: * the value of the variable "rougail.source_variable_1". * the value of the variable "rougail.source_variable_2". -**Default**: val1 +**Default**: val1 |==== - diff --git a/tests/docs/base/00_9choice_variables.json b/tests/docs/base/00_9choice_variables.json new file mode 100644 index 0000000..796679f --- /dev/null +++ b/tests/docs/base/00_9choice_variables.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"source_variable_1": {"type": "variable", "default": "val1", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.source_variable_1"], "names": ["source_variable_1"], "descriptions": ["The first source variable."]}, "source_variable_2": {"type": "variable", "default": "val2", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.source_variable_2"], "names": ["source_variable_2"], "descriptions": ["The second source variable."]}, "my_variable": {"type": "variable", "default": "val1", "properties": [{"type": "type", "name": "choice"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "choices": ["the value of the variable \"rougail.source_variable_1\".", "the value of the variable \"rougail.source_variable_2\"."], "paths": ["rougail.my_variable"], "names": ["my_variable"], "descriptions": ["A variable."]}}}} \ No newline at end of file diff --git a/tests/docs/base/00_9choice_variables.md b/tests/docs/base/00_9choice_variables.md index 7e45687..7e3e09c 100644 --- a/tests/docs/base/00_9choice_variables.md +++ b/tests/docs/base/00_9choice_variables.md @@ -17,12 +17,11 @@ my_variable: - variable: _.source_variable_2 default: val1 ``` -# Variables for "rougail" - -| Variable                                                                                                                                 | Description                                                                                                                              | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.source_variable_1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The first source variable.
**Default**: val1 | -| **rougail.source_variable_2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The second source variable.
**Default**: val2 | -| **rougail.my_variable**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Choices**:
- the value of the variable "rougail.source_variable_1".
- the value of the variable "rougail.source_variable_2".
**Default**: val1 | +# Variables for "Rougail" +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.source_variable_1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The first source variable.
**Default**: val1 | +| **rougail.source_variable_2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The second source variable.
**Default**: val2 | +| **rougail.my_variable**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Choices**:
- the value of the variable "rougail.source_variable_1".
- the value of the variable "rougail.source_variable_2".
**Default**: val1 | diff --git a/tests/docs/base/00_9default_calculation.adoc b/tests/docs/base/00_9default_calculation.adoc index b87632d..98a5588 100644 --- a/tests/docs/base/00_9default_calculation.adoc +++ b/tests/docs/base/00_9default_calculation.adoc @@ -17,16 +17,16 @@ variable: param4: description: concat all parameters ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A variable. + -**Default**: concat all parameters. +**Default**: concat all parameters. |==== - diff --git a/tests/docs/base/00_9default_calculation.json b/tests/docs/base/00_9default_calculation.json new file mode 100644 index 0000000..4a9a895 --- /dev/null +++ b/tests/docs/base/00_9default_calculation.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"variable": {"type": "variable", "default": "concat all parameters.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.variable"], "names": ["variable"], "descriptions": ["A variable."]}}}} \ No newline at end of file diff --git a/tests/docs/base/00_9default_calculation.md b/tests/docs/base/00_9default_calculation.md index 0ff3e62..f831796 100644 --- a/tests/docs/base/00_9default_calculation.md +++ b/tests/docs/base/00_9default_calculation.md @@ -20,10 +20,9 @@ variable: param4: description: concat all parameters ``` -# Variables for "rougail" +# Variables for "Rougail" | Variable                                                                                                   | Description                                                                                                | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: concat all parameters. | - diff --git a/tests/docs/base/00_9default_calculation_information.adoc b/tests/docs/base/00_9default_calculation_information.adoc index 56a5066..5124f7e 100644 --- a/tests/docs/base/00_9default_calculation_information.adoc +++ b/tests/docs/base/00_9default_calculation_information.adoc @@ -15,16 +15,16 @@ var: variable: _.var description: returns the information ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A variable. + -**Default**: returns the information. +**Default**: returns the information. |==== - diff --git a/tests/docs/base/00_9default_calculation_information.json b/tests/docs/base/00_9default_calculation_information.json new file mode 100644 index 0000000..29b9b93 --- /dev/null +++ b/tests/docs/base/00_9default_calculation_information.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"var": {"type": "variable", "default": "returns the information.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.var"], "names": ["var"], "descriptions": ["A variable."]}}}} \ No newline at end of file diff --git a/tests/docs/base/00_9default_calculation_information.md b/tests/docs/base/00_9default_calculation_information.md index 846d1e2..75109ca 100644 --- a/tests/docs/base/00_9default_calculation_information.md +++ b/tests/docs/base/00_9default_calculation_information.md @@ -18,10 +18,9 @@ var: variable: _.var description: returns the information ``` -# Variables for "rougail" +# Variables for "Rougail" | Variable                                                                                                   | Description                                                                                                | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: returns the information. | - diff --git a/tests/docs/base/00_9default_calculation_information_other_variable.adoc b/tests/docs/base/00_9default_calculation_information_other_variable.adoc index a194a2f..9a98c96 100644 --- a/tests/docs/base/00_9default_calculation_information_other_variable.adoc +++ b/tests/docs/base/00_9default_calculation_information_other_variable.adoc @@ -16,20 +16,21 @@ var2: information: test_information variable: _.var1 ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A first variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A first variable. | + **rougail.var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A second variable. + -**Default**: depends on a calculation. +**Default**: depends on a calculation. |==== - diff --git a/tests/docs/base/00_9default_calculation_information_other_variable.json b/tests/docs/base/00_9default_calculation_information_other_variable.json new file mode 100644 index 0000000..41a61af --- /dev/null +++ b/tests/docs/base/00_9default_calculation_information_other_variable.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"var1": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.var1"], "names": ["var1"], "descriptions": ["A first variable."]}, "var2": {"type": "variable", "default": "depends on a calculation.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.var2"], "names": ["var2"], "descriptions": ["A second variable."]}}}} \ No newline at end of file diff --git a/tests/docs/base/00_9default_calculation_information_other_variable.md b/tests/docs/base/00_9default_calculation_information_other_variable.md index f5c9411..d657fea 100644 --- a/tests/docs/base/00_9default_calculation_information_other_variable.md +++ b/tests/docs/base/00_9default_calculation_information_other_variable.md @@ -19,11 +19,10 @@ var2: information: test_information variable: _.var1 ``` -# Variables for "rougail" +# Variables for "Rougail" | Variable                                                                                                   | Description                                                                                                | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A first variable. | | **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second variable.
**Default**: depends on a calculation. | - diff --git a/tests/docs/base/00_9default_calculation_multi_optional.adoc b/tests/docs/base/00_9default_calculation_multi_optional.adoc index cc18bce..164e78b 100644 --- a/tests/docs/base/00_9default_calculation_multi_optional.adoc +++ b/tests/docs/base/00_9default_calculation_multi_optional.adoc @@ -14,23 +14,22 @@ my_calculated_variable: - variable: _.my_variable_unexists optional: true ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | -**rougail.my_variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | -My_variable. + -**Default**: val1 -| -**rougail.my_calculated_variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | -My_calculated_variable. + -**Default**: -* the value of the variable "rougail.my_variable". +**rougail.my_variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +My_variable. + +**Default**: val1 +| + +**rougail.my_calculated_variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +My_calculated_variable. + +**Default**: the value of the variable "rougail.my_variable". |==== - diff --git a/tests/docs/base/00_9default_calculation_multi_optional.json b/tests/docs/base/00_9default_calculation_multi_optional.json new file mode 100644 index 0000000..f908169 --- /dev/null +++ b/tests/docs/base/00_9default_calculation_multi_optional.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"my_variable": {"type": "variable", "default": "val1", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.my_variable"], "names": ["my_variable"]}, "my_calculated_variable": {"type": "variable", "default": ["the value of the variable \"rougail.my_variable\"."], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.my_calculated_variable"], "names": ["my_calculated_variable"], "multiple": true}}}} \ No newline at end of file diff --git a/tests/docs/base/00_9default_calculation_multi_optional.md b/tests/docs/base/00_9default_calculation_multi_optional.md index 8ce8d9d..575bf70 100644 --- a/tests/docs/base/00_9default_calculation_multi_optional.md +++ b/tests/docs/base/00_9default_calculation_multi_optional.md @@ -17,11 +17,10 @@ my_calculated_variable: - variable: _.my_variable_unexists optional: true ``` -# Variables for "rougail" +# Variables for "Rougail" | Variable                                                                                                                       | Description                                                                                                                    | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.my_variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | My_variable.
**Default**: val1 | -| **rougail.my_calculated_variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | My_calculated_variable.
**Default**:
- the value of the variable "rougail.my_variable". | - +| **rougail.my_calculated_variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | My_calculated_variable.
**Default**: the value of the variable "rougail.my_variable". | diff --git a/tests/docs/base/00_9default_calculation_multi_optional2.adoc b/tests/docs/base/00_9default_calculation_multi_optional2.adoc index 92b9163..4307f82 100644 --- a/tests/docs/base/00_9default_calculation_multi_optional2.adoc +++ b/tests/docs/base/00_9default_calculation_multi_optional2.adoc @@ -14,23 +14,22 @@ my_calculated_variable: - variable: _.my_variable optional: true ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | -**rougail.my_variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | -My_variable. + -**Default**: val1 -| -**rougail.my_calculated_variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | -My_calculated_variable. + -**Default**: -* the value of the variable "rougail.my_variable_unexists". +**rougail.my_variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +My_variable. + +**Default**: val1 +| + +**rougail.my_calculated_variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +My_calculated_variable. + +**Default**: the value of the variable "rougail.my_variable". |==== - diff --git a/tests/docs/base/00_9default_calculation_multi_optional2.json b/tests/docs/base/00_9default_calculation_multi_optional2.json new file mode 100644 index 0000000..f908169 --- /dev/null +++ b/tests/docs/base/00_9default_calculation_multi_optional2.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"my_variable": {"type": "variable", "default": "val1", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.my_variable"], "names": ["my_variable"]}, "my_calculated_variable": {"type": "variable", "default": ["the value of the variable \"rougail.my_variable\"."], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.my_calculated_variable"], "names": ["my_calculated_variable"], "multiple": true}}}} \ No newline at end of file diff --git a/tests/docs/base/00_9default_calculation_multi_optional2.md b/tests/docs/base/00_9default_calculation_multi_optional2.md index f465515..285b4ae 100644 --- a/tests/docs/base/00_9default_calculation_multi_optional2.md +++ b/tests/docs/base/00_9default_calculation_multi_optional2.md @@ -17,11 +17,10 @@ my_calculated_variable: - variable: _.my_variable optional: true ``` -# Variables for "rougail" +# Variables for "Rougail" | Variable                                                                                                                       | Description                                                                                                                    | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.my_variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | My_variable.
**Default**: val1 | -| **rougail.my_calculated_variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | My_calculated_variable.
**Default**:
- the value of the variable "rougail.my_variable_unexists". | - +| **rougail.my_calculated_variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | My_calculated_variable.
**Default**: the value of the variable "rougail.my_variable". | diff --git a/tests/docs/base/00_9default_calculation_optional.adoc b/tests/docs/base/00_9default_calculation_optional.adoc index 6033204..deb25d8 100644 --- a/tests/docs/base/00_9default_calculation_optional.adoc +++ b/tests/docs/base/00_9default_calculation_optional.adoc @@ -10,15 +10,15 @@ my_calculated_variable: variable: _.my_variable optional: true ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.my_calculated_variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | -My_calculated_variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +My_calculated_variable. |==== - diff --git a/tests/docs/base/00_9default_calculation_optional.json b/tests/docs/base/00_9default_calculation_optional.json new file mode 100644 index 0000000..33040ef --- /dev/null +++ b/tests/docs/base/00_9default_calculation_optional.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"my_calculated_variable": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.my_calculated_variable"], "names": ["my_calculated_variable"], "multiple": true}}}} \ No newline at end of file diff --git a/tests/docs/base/00_9default_calculation_optional.md b/tests/docs/base/00_9default_calculation_optional.md index 6028c4a..1a642a6 100644 --- a/tests/docs/base/00_9default_calculation_optional.md +++ b/tests/docs/base/00_9default_calculation_optional.md @@ -13,10 +13,9 @@ my_calculated_variable: variable: _.my_variable optional: true ``` -# Variables for "rougail" +# Variables for "Rougail" | Variable                                                                                                                       | Description                                                                                                                    | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.my_calculated_variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | My_calculated_variable. | - diff --git a/tests/docs/base/00_9default_calculation_optional_exists.adoc b/tests/docs/base/00_9default_calculation_optional_exists.adoc index 31b8abe..310e267 100644 --- a/tests/docs/base/00_9default_calculation_optional_exists.adoc +++ b/tests/docs/base/00_9default_calculation_optional_exists.adoc @@ -15,24 +15,25 @@ my_calculated_variable: variable: _.my_variable optional: true ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.my_variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | My_variable. + **Default**: * val1 -* val2 +* val2 | + **rougail.my_calculated_variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | My_calculated_variable. + -**Default**: the value of the variable "rougail.my_variable". +**Default**: the value of the variable "rougail.my_variable". |==== - diff --git a/tests/docs/base/00_9default_calculation_optional_exists.json b/tests/docs/base/00_9default_calculation_optional_exists.json new file mode 100644 index 0000000..17ad4f1 --- /dev/null +++ b/tests/docs/base/00_9default_calculation_optional_exists.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"my_variable": {"type": "variable", "default": ["val1", "val2"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.my_variable"], "names": ["my_variable"], "multiple": true}, "my_calculated_variable": {"type": "variable", "default": "the value of the variable \"rougail.my_variable\".", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.my_calculated_variable"], "names": ["my_calculated_variable"], "multiple": true}}}} \ No newline at end of file diff --git a/tests/docs/base/00_9default_calculation_optional_exists.md b/tests/docs/base/00_9default_calculation_optional_exists.md index 2872a4e..1a2acdb 100644 --- a/tests/docs/base/00_9default_calculation_optional_exists.md +++ b/tests/docs/base/00_9default_calculation_optional_exists.md @@ -18,11 +18,10 @@ my_calculated_variable: variable: _.my_variable optional: true ``` -# Variables for "rougail" +# Variables for "Rougail" | Variable                                                                                                                       | Description                                                                                                                    | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.my_variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | My_variable.
**Default**:
- val1
- val2 | | **rougail.my_calculated_variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | My_calculated_variable.
**Default**: the value of the variable "rougail.my_variable". | - diff --git a/tests/docs/base/00_9default_calculation_param_optional.adoc b/tests/docs/base/00_9default_calculation_param_optional.adoc index db094f0..950b9d4 100644 --- a/tests/docs/base/00_9default_calculation_param_optional.adoc +++ b/tests/docs/base/00_9default_calculation_param_optional.adoc @@ -23,21 +23,22 @@ var1: mandatory: false var2: no # a second variable ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | A first variable. + -**Default**: returns a value. +**Default**: returns a value. | + **rougail.var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A second variable. + -**Default**: no +**Default**: no |==== - diff --git a/tests/docs/base/00_9default_calculation_param_optional.json b/tests/docs/base/00_9default_calculation_param_optional.json new file mode 100644 index 0000000..9f11425 --- /dev/null +++ b/tests/docs/base/00_9default_calculation_param_optional.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"var1": {"type": "variable", "default": "returns a value.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}], "paths": ["rougail.var1"], "names": ["var1"], "descriptions": ["A first variable."]}, "var2": {"type": "variable", "default": "no", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.var2"], "names": ["var2"], "descriptions": ["A second variable."]}}}} \ No newline at end of file diff --git a/tests/docs/base/00_9default_calculation_param_optional.md b/tests/docs/base/00_9default_calculation_param_optional.md index 4de28ac..2ccc244 100644 --- a/tests/docs/base/00_9default_calculation_param_optional.md +++ b/tests/docs/base/00_9default_calculation_param_optional.md @@ -26,11 +26,10 @@ var1: mandatory: false var2: no # a second variable ``` -# Variables for "rougail" +# Variables for "Rougail" | Variable                                                                                                   | Description                                                                                                | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A first variable.
**Default**: returns a value. | | **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second variable.
**Default**: no | - diff --git a/tests/docs/base/00_9default_information_other_variable.adoc b/tests/docs/base/00_9default_information_other_variable.adoc index 3e5e091..6494f0a 100644 --- a/tests/docs/base/00_9default_information_other_variable.adoc +++ b/tests/docs/base/00_9default_information_other_variable.adoc @@ -12,20 +12,21 @@ var2: information: test_information variable: _.var1 ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A first variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A first variable. | + **rougail.var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A second variable. + -**Default**: the value of the information "test_information" of the variable "rougail.var1". +**Default**: the value of the information "test_information" of the variable "rougail.var1". |==== - diff --git a/tests/docs/base/00_9default_information_other_variable.json b/tests/docs/base/00_9default_information_other_variable.json new file mode 100644 index 0000000..e6cae27 --- /dev/null +++ b/tests/docs/base/00_9default_information_other_variable.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"var1": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.var1"], "names": ["var1"], "descriptions": ["A first variable."]}, "var2": {"type": "variable", "default": "the value of the information \"test_information\" of the variable \"rougail.var1\".", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.var2"], "names": ["var2"], "descriptions": ["A second variable."]}}}} \ No newline at end of file diff --git a/tests/docs/base/00_9default_information_other_variable.md b/tests/docs/base/00_9default_information_other_variable.md index 48d0d82..68cca3f 100644 --- a/tests/docs/base/00_9default_information_other_variable.md +++ b/tests/docs/base/00_9default_information_other_variable.md @@ -15,11 +15,10 @@ var2: information: test_information variable: _.var1 ``` -# Variables for "rougail" +# Variables for "Rougail" | Variable                                                                                                   | Description                                                                                                | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A first variable. | | **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second variable.
**Default**: the value of the information "test_information" of the variable "rougail.var1". | - diff --git a/tests/docs/base/00_9default_integer.adoc b/tests/docs/base/00_9default_integer.adoc index cd37a80..96c103e 100644 --- a/tests/docs/base/00_9default_integer.adoc +++ b/tests/docs/base/00_9default_integer.adoc @@ -15,17 +15,17 @@ var: return_type: number description: choice for 0 to 9 ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` `mandatory` | A variable. + **Choices**: choice for 0 to 9. + -**Default**: 9 +**Default**: 9 |==== - diff --git a/tests/docs/base/00_9default_integer.json b/tests/docs/base/00_9default_integer.json new file mode 100644 index 0000000..1f4ecb3 --- /dev/null +++ b/tests/docs/base/00_9default_integer.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"var": {"type": "variable", "default": 9, "properties": [{"type": "type", "name": "choice"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "choices": "choice for 0 to 9.", "paths": ["rougail.var"], "names": ["var"], "descriptions": ["A variable."]}}}} \ No newline at end of file diff --git a/tests/docs/base/00_9default_integer.md b/tests/docs/base/00_9default_integer.md index cc87f6d..307b0b9 100644 --- a/tests/docs/base/00_9default_integer.md +++ b/tests/docs/base/00_9default_integer.md @@ -18,10 +18,9 @@ var: return_type: number description: choice for 0 to 9 ``` -# Variables for "rougail" +# Variables for "Rougail" | Variable                                                                                                   | Description                                                                                                | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.var**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Choices**: choice for 0 to 9.
**Default**: 9 | - diff --git a/tests/docs/base/00_9extra.adoc b/tests/docs/base/00_9extra.adoc index 4be6094..561f704 100644 --- a/tests/docs/base/00_9extra.adoc +++ b/tests/docs/base/00_9extra.adoc @@ -18,29 +18,29 @@ variable: jinja: no description: return no ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | -**rougail.variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | -A variable. + -**Default**: rougail -|==== +**rougail.variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A variable. + +**Default**: rougail +|==== == Variables for "extra" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **extra.variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A variable. + -**Default**: return no. +**Default**: return no. |==== - diff --git a/tests/docs/base/00_9extra.json b/tests/docs/base/00_9extra.json new file mode 100644 index 0000000..56ae2a1 --- /dev/null +++ b/tests/docs/base/00_9extra.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"variable": {"type": "variable", "default": "rougail", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.variable"], "names": ["variable"], "descriptions": ["A variable."]}}}, "extra": {"type": "namespace", "informations": {"paths": ["extra"], "names": ["extra"], "properties": [{"type": "mode", "name": "standard"}]}, "children": {"variable": {"type": "variable", "default": "return no.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["extra.variable"], "names": ["variable"], "descriptions": ["A variable."]}}}} \ No newline at end of file diff --git a/tests/docs/base/00_9extra.md b/tests/docs/base/00_9extra.md index 71794a8..ff34512 100644 --- a/tests/docs/base/00_9extra.md +++ b/tests/docs/base/00_9extra.md @@ -20,17 +20,15 @@ variable: jinja: no description: return no ``` -# Variables for "rougail" +# Variables for "Rougail" | Variable                                                                                                   | Description                                                                                                | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: rougail | - # Variables for "extra" | Variable                                                                                                   | Description                                                                                                | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **extra.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: return no. | - diff --git a/tests/docs/base/00_9extra_calculation.adoc b/tests/docs/base/00_9extra_calculation.adoc index f23816a..b3f3588 100644 --- a/tests/docs/base/00_9extra_calculation.adoc +++ b/tests/docs/base/00_9extra_calculation.adoc @@ -32,39 +32,41 @@ variable3: variable: rougail.variable description: copy the value of rougail.variable ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | -**rougail.variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | -A variable. + -**Default**: value -|==== +**rougail.variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A variable. + +**Default**: value +|==== == Variables for "extra" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **extra.variable1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A first variable. + -**Default**: the value of the variable "rougail.variable". +**Default**: the value of the variable "rougail.variable". | + **extra.variable2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A second variable. + -**Default**: copy the value of rougail.variable. +**Default**: copy the value of rougail.variable. | + **extra.variable3** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A third variable. + -**Default**: copy the value of rougail.variable. +**Default**: copy the value of rougail.variable. |==== - diff --git a/tests/docs/base/00_9extra_calculation.json b/tests/docs/base/00_9extra_calculation.json new file mode 100644 index 0000000..18fb512 --- /dev/null +++ b/tests/docs/base/00_9extra_calculation.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"variable": {"type": "variable", "default": "value", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.variable"], "names": ["variable"], "descriptions": ["A variable."]}}}, "extra": {"type": "namespace", "informations": {"paths": ["extra"], "names": ["extra"], "properties": [{"type": "mode", "name": "standard"}]}, "children": {"variable1": {"type": "variable", "default": "the value of the variable \"rougail.variable\".", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["extra.variable1"], "names": ["variable1"], "descriptions": ["A first variable."]}, "variable2": {"type": "variable", "default": "copy the value of rougail.variable.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["extra.variable2"], "names": ["variable2"], "descriptions": ["A second variable."]}, "variable3": {"type": "variable", "default": "copy the value of rougail.variable.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["extra.variable3"], "names": ["variable3"], "descriptions": ["A third variable."]}}}} \ No newline at end of file diff --git a/tests/docs/base/00_9extra_calculation.md b/tests/docs/base/00_9extra_calculation.md index be1f59d..f6905a6 100644 --- a/tests/docs/base/00_9extra_calculation.md +++ b/tests/docs/base/00_9extra_calculation.md @@ -34,13 +34,12 @@ variable3: variable: rougail.variable description: copy the value of rougail.variable ``` -# Variables for "rougail" +# Variables for "Rougail" | Variable                                                                                                   | Description                                                                                                | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: value | - # Variables for "extra" | Variable                                                                                                   | Description                                                                                                | @@ -49,4 +48,3 @@ variable3: | **extra.variable2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second variable.
**Default**: copy the value of rougail.variable. | | **extra.variable3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A third variable.
**Default**: copy the value of rougail.variable. | - diff --git a/tests/docs/base/01_6boolean_multi.adoc b/tests/docs/base/01_6boolean_multi.adoc index b772566..0397d31 100644 --- a/tests/docs/base/01_6boolean_multi.adoc +++ b/tests/docs/base/01_6boolean_multi.adoc @@ -39,67 +39,58 @@ var8: default: - true ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` `unique` `multiple` | The first variable. + -**Default**: - -* true +**Default**: true | + **rougail.var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` `unique` `multiple` | The second variable. + -**Default**: - -* true +**Default**: true | + **rougail.var3** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` `unique` `multiple` | The third variable. + -**Default**: - -* true +**Default**: true | + **rougail.var4** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` `unique` `multiple` | The forth variable. + -**Default**: - -* false +**Default**: false | + **rougail.var5** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` `unique` `multiple` | The fifth variable. + -**Default**: - -* false +**Default**: false | + **rougail.var6** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` `unique` `multiple` | The sixth variable. + -**Default**: - -* false +**Default**: false | + **rougail.var7** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` `unique` `multiple` | The seventh variable. + -**Default**: - -* true +**Default**: true | -**rougail.var8** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` `unique` `multiple` | -The eighth variable. + -**Default**: -* true +**rougail.var8** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` `unique` `multiple` | +The eighth variable. + +**Default**: true |==== - diff --git a/tests/docs/base/01_6boolean_multi.json b/tests/docs/base/01_6boolean_multi.json new file mode 100644 index 0000000..d9fa8ff --- /dev/null +++ b/tests/docs/base/01_6boolean_multi.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"var1": {"type": "variable", "default": [true], "properties": [{"type": "type", "name": "boolean"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var1"], "names": ["var1"], "descriptions": ["The first variable."], "multiple": true}, "var2": {"type": "variable", "default": [true], "properties": [{"type": "type", "name": "boolean"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var2"], "names": ["var2"], "descriptions": ["The second variable."], "multiple": true}, "var3": {"type": "variable", "default": [true], "properties": [{"type": "type", "name": "boolean"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var3"], "names": ["var3"], "descriptions": ["The third variable."], "multiple": true}, "var4": {"type": "variable", "default": [false], "properties": [{"type": "type", "name": "boolean"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var4"], "names": ["var4"], "descriptions": ["The forth variable."], "multiple": true}, "var5": {"type": "variable", "default": [false], "properties": [{"type": "type", "name": "boolean"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var5"], "names": ["var5"], "descriptions": ["The fifth variable."], "multiple": true}, "var6": {"type": "variable", "default": [false], "properties": [{"type": "type", "name": "boolean"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var6"], "names": ["var6"], "descriptions": ["The sixth variable."], "multiple": true}, "var7": {"type": "variable", "default": [true], "properties": [{"type": "type", "name": "boolean"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var7"], "names": ["var7"], "descriptions": ["The seventh variable."], "multiple": true}, "var8": {"type": "variable", "default": [true], "properties": [{"type": "type", "name": "boolean"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var8"], "names": ["var8"], "descriptions": ["The eighth variable."], "multiple": true}}}} \ No newline at end of file diff --git a/tests/docs/base/01_6boolean_multi.md b/tests/docs/base/01_6boolean_multi.md index 949f55f..a9acd15 100644 --- a/tests/docs/base/01_6boolean_multi.md +++ b/tests/docs/base/01_6boolean_multi.md @@ -42,17 +42,16 @@ var8: default: - true ``` -# Variables for "rougail" +# Variables for "Rougail" | Variable                                                                                                                        | Description                                                                                                                     | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var1**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The first variable.
**Default**:
- true | -| **rougail.var2**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The second variable.
**Default**:
- true | -| **rougail.var3**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The third variable.
**Default**:
- true | -| **rougail.var4**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The forth variable.
**Default**:
- false | -| **rougail.var5**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The fifth variable.
**Default**:
- false | -| **rougail.var6**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The sixth variable.
**Default**:
- false | -| **rougail.var7**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The seventh variable.
**Default**:
- true | -| **rougail.var8**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The eighth variable.
**Default**:
- true | - +| **rougail.var1**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The first variable.
**Default**: true | +| **rougail.var2**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The second variable.
**Default**: true | +| **rougail.var3**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The third variable.
**Default**: true | +| **rougail.var4**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The forth variable.
**Default**: false | +| **rougail.var5**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The fifth variable.
**Default**: false | +| **rougail.var6**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The sixth variable.
**Default**: false | +| **rougail.var7**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The seventh variable.
**Default**: true | +| **rougail.var8**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The eighth variable.
**Default**: true | diff --git a/tests/docs/base/01_6custom_multi.adoc b/tests/docs/base/01_6custom_multi.adoc index c419e47..5aad39e 100644 --- a/tests/docs/base/01_6custom_multi.adoc +++ b/tests/docs/base/01_6custom_multi.adoc @@ -14,22 +14,21 @@ custom2: default: - value ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | -**rougail.custom1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[custom]` `basic` `mandatory` `unique` `multiple` | -A first custom variable. -| -**rougail.custom2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[custom]` `standard` `mandatory` `unique` `multiple` | -A second custom variable. + -**Default**: -* value +**rougail.custom1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[custom]` `basic` `mandatory` `unique` `multiple` | +A first custom variable. +| + +**rougail.custom2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[custom]` `standard` `mandatory` `unique` `multiple` | +A second custom variable. + +**Default**: value |==== - diff --git a/tests/docs/base/01_6custom_multi.json b/tests/docs/base/01_6custom_multi.json new file mode 100644 index 0000000..28613c9 --- /dev/null +++ b/tests/docs/base/01_6custom_multi.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"custom1": {"type": "variable", "properties": [{"type": "type", "name": "custom"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.custom1"], "names": ["custom1"], "descriptions": ["A first custom variable."], "multiple": true}, "custom2": {"type": "variable", "default": ["value"], "properties": [{"type": "type", "name": "custom"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.custom2"], "names": ["custom2"], "descriptions": ["A second custom variable."], "multiple": true}}}} \ No newline at end of file diff --git a/tests/docs/base/01_6custom_multi.md b/tests/docs/base/01_6custom_multi.md index f745b29..d73c197 100644 --- a/tests/docs/base/01_6custom_multi.md +++ b/tests/docs/base/01_6custom_multi.md @@ -17,11 +17,10 @@ custom2: default: - value ``` -# Variables for "rougail" +# Variables for "Rougail" | Variable                                                                                                                       | Description                                                                                                                    | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.custom1**
[`custom`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | A first custom variable. | -| **rougail.custom2**
[`custom`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A second custom variable.
**Default**:
- value | - +| **rougail.custom2**
[`custom`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A second custom variable.
**Default**: value | diff --git a/tests/docs/base/01_6float_multi.adoc b/tests/docs/base/01_6float_multi.adoc index 68ff01d..3b46081 100644 --- a/tests/docs/base/01_6float_multi.adoc +++ b/tests/docs/base/01_6float_multi.adoc @@ -39,67 +39,58 @@ var8: default: - 0.0 ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` `unique` `multiple` | The first variable. + -**Default**: - -* 0.0 +**Default**: 0.0 | + **rougail.var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` `unique` `multiple` | The second variable. + -**Default**: - -* 0.0 +**Default**: 0.0 | + **rougail.var3** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` `unique` `multiple` | The third variable. + -**Default**: - -* 0.0 +**Default**: 0.0 | + **rougail.var4** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` `unique` `multiple` | The forth variable. + -**Default**: - -* 10.1 +**Default**: 10.1 | + **rougail.var5** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` `unique` `multiple` | The fifth variable. + -**Default**: - -* 10.1 +**Default**: 10.1 | + **rougail.var6** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` `unique` `multiple` | The sixth variable. + -**Default**: - -* 10.1 +**Default**: 10.1 | + **rougail.var7** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` `unique` `multiple` | The seventh variable. + -**Default**: - -* 0.0 +**Default**: 0.0 | -**rougail.var8** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` `unique` `multiple` | -The eighth variable. + -**Default**: -* 0.0 +**rougail.var8** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` `unique` `multiple` | +The eighth variable. + +**Default**: 0.0 |==== - diff --git a/tests/docs/base/01_6float_multi.json b/tests/docs/base/01_6float_multi.json new file mode 100644 index 0000000..03a0747 --- /dev/null +++ b/tests/docs/base/01_6float_multi.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"var1": {"type": "variable", "default": [0.0], "properties": [{"type": "type", "name": "float"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var1"], "names": ["var1"], "descriptions": ["The first variable."], "multiple": true}, "var2": {"type": "variable", "default": [0.0], "properties": [{"type": "type", "name": "float"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var2"], "names": ["var2"], "descriptions": ["The second variable."], "multiple": true}, "var3": {"type": "variable", "default": [0.0], "properties": [{"type": "type", "name": "float"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var3"], "names": ["var3"], "descriptions": ["The third variable."], "multiple": true}, "var4": {"type": "variable", "default": [10.1], "properties": [{"type": "type", "name": "float"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var4"], "names": ["var4"], "descriptions": ["The forth variable."], "multiple": true}, "var5": {"type": "variable", "default": [10.1], "properties": [{"type": "type", "name": "float"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var5"], "names": ["var5"], "descriptions": ["The fifth variable."], "multiple": true}, "var6": {"type": "variable", "default": [10.1], "properties": [{"type": "type", "name": "float"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var6"], "names": ["var6"], "descriptions": ["The sixth variable."], "multiple": true}, "var7": {"type": "variable", "default": [0.0], "properties": [{"type": "type", "name": "float"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var7"], "names": ["var7"], "descriptions": ["The seventh variable."], "multiple": true}, "var8": {"type": "variable", "default": [0.0], "properties": [{"type": "type", "name": "float"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var8"], "names": ["var8"], "descriptions": ["The eighth variable."], "multiple": true}}}} \ No newline at end of file diff --git a/tests/docs/base/01_6float_multi.md b/tests/docs/base/01_6float_multi.md index 7211982..dbd356f 100644 --- a/tests/docs/base/01_6float_multi.md +++ b/tests/docs/base/01_6float_multi.md @@ -42,17 +42,16 @@ var8: default: - 0.0 ``` -# Variables for "rougail" +# Variables for "Rougail" | Variable                                                                                                                      | Description                                                                                                                   | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var1**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The first variable.
**Default**:
- 0.0 | -| **rougail.var2**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The second variable.
**Default**:
- 0.0 | -| **rougail.var3**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The third variable.
**Default**:
- 0.0 | -| **rougail.var4**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The forth variable.
**Default**:
- 10.1 | -| **rougail.var5**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The fifth variable.
**Default**:
- 10.1 | -| **rougail.var6**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The sixth variable.
**Default**:
- 10.1 | -| **rougail.var7**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The seventh variable.
**Default**:
- 0.0 | -| **rougail.var8**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The eighth variable.
**Default**:
- 0.0 | - +| **rougail.var1**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The first variable.
**Default**: 0.0 | +| **rougail.var2**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The second variable.
**Default**: 0.0 | +| **rougail.var3**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The third variable.
**Default**: 0.0 | +| **rougail.var4**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The forth variable.
**Default**: 10.1 | +| **rougail.var5**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The fifth variable.
**Default**: 10.1 | +| **rougail.var6**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The sixth variable.
**Default**: 10.1 | +| **rougail.var7**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The seventh variable.
**Default**: 0.0 | +| **rougail.var8**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The eighth variable.
**Default**: 0.0 | diff --git a/tests/docs/base/01_6number_multi.adoc b/tests/docs/base/01_6number_multi.adoc index d9ead7a..b3dc40d 100644 --- a/tests/docs/base/01_6number_multi.adoc +++ b/tests/docs/base/01_6number_multi.adoc @@ -39,67 +39,58 @@ var8: default: - 0 ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` `unique` `multiple` | The first variable. + -**Default**: - -* 0 +**Default**: 0 | + **rougail.var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` `unique` `multiple` | The second variable. + -**Default**: - -* 0 +**Default**: 0 | + **rougail.var3** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` `unique` `multiple` | The third variable. + -**Default**: - -* 0 +**Default**: 0 | + **rougail.var4** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` `unique` `multiple` | The forth variable. + -**Default**: - -* 10 +**Default**: 10 | + **rougail.var5** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` `unique` `multiple` | The fifth variable. + -**Default**: - -* 10 +**Default**: 10 | + **rougail.var6** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` `unique` `multiple` | The sixth variable. + -**Default**: - -* 10 +**Default**: 10 | + **rougail.var7** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` `unique` `multiple` | The seventh variable. + -**Default**: - -* 0 +**Default**: 0 | -**rougail.var8** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` `unique` `multiple` | -The eighth variable. + -**Default**: -* 0 +**rougail.var8** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` `unique` `multiple` | +The eighth variable. + +**Default**: 0 |==== - diff --git a/tests/docs/base/01_6number_multi.json b/tests/docs/base/01_6number_multi.json new file mode 100644 index 0000000..050db67 --- /dev/null +++ b/tests/docs/base/01_6number_multi.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"var1": {"type": "variable", "default": [0], "properties": [{"type": "type", "name": "number"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var1"], "names": ["var1"], "descriptions": ["The first variable."], "multiple": true}, "var2": {"type": "variable", "default": [0], "properties": [{"type": "type", "name": "number"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var2"], "names": ["var2"], "descriptions": ["The second variable."], "multiple": true}, "var3": {"type": "variable", "default": [0], "properties": [{"type": "type", "name": "number"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var3"], "names": ["var3"], "descriptions": ["The third variable."], "multiple": true}, "var4": {"type": "variable", "default": [10], "properties": [{"type": "type", "name": "number"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var4"], "names": ["var4"], "descriptions": ["The forth variable."], "multiple": true}, "var5": {"type": "variable", "default": [10], "properties": [{"type": "type", "name": "number"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var5"], "names": ["var5"], "descriptions": ["The fifth variable."], "multiple": true}, "var6": {"type": "variable", "default": [10], "properties": [{"type": "type", "name": "number"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var6"], "names": ["var6"], "descriptions": ["The sixth variable."], "multiple": true}, "var7": {"type": "variable", "default": [0], "properties": [{"type": "type", "name": "number"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var7"], "names": ["var7"], "descriptions": ["The seventh variable."], "multiple": true}, "var8": {"type": "variable", "default": [0], "properties": [{"type": "type", "name": "number"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var8"], "names": ["var8"], "descriptions": ["The eighth variable."], "multiple": true}}}} \ No newline at end of file diff --git a/tests/docs/base/01_6number_multi.md b/tests/docs/base/01_6number_multi.md index 3efb548..87a93c9 100644 --- a/tests/docs/base/01_6number_multi.md +++ b/tests/docs/base/01_6number_multi.md @@ -42,17 +42,16 @@ var8: default: - 0 ``` -# Variables for "rougail" +# Variables for "Rougail" | Variable                                                                                                                       | Description                                                                                                                    | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var1**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The first variable.
**Default**:
- 0 | -| **rougail.var2**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The second variable.
**Default**:
- 0 | -| **rougail.var3**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The third variable.
**Default**:
- 0 | -| **rougail.var4**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The forth variable.
**Default**:
- 10 | -| **rougail.var5**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The fifth variable.
**Default**:
- 10 | -| **rougail.var6**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The sixth variable.
**Default**:
- 10 | -| **rougail.var7**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The seventh variable.
**Default**:
- 0 | -| **rougail.var8**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The eighth variable.
**Default**:
- 0 | - +| **rougail.var1**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The first variable.
**Default**: 0 | +| **rougail.var2**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The second variable.
**Default**: 0 | +| **rougail.var3**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The third variable.
**Default**: 0 | +| **rougail.var4**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The forth variable.
**Default**: 10 | +| **rougail.var5**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The fifth variable.
**Default**: 10 | +| **rougail.var6**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The sixth variable.
**Default**: 10 | +| **rougail.var7**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The seventh variable.
**Default**: 0 | +| **rougail.var8**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The eighth variable.
**Default**: 0 | diff --git a/tests/docs/base/01_6string_empty.adoc b/tests/docs/base/01_6string_empty.adoc index 24a8f87..b0a4ab4 100644 --- a/tests/docs/base/01_6string_empty.adoc +++ b/tests/docs/base/01_6string_empty.adoc @@ -7,21 +7,23 @@ version: '1.1' var1: description: the second variable empty: false - default: [value, None] + default: + - value + - ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | The second variable. + **Default**: * value -* None +* null |==== - diff --git a/tests/docs/base/01_6string_empty.json b/tests/docs/base/01_6string_empty.json new file mode 100644 index 0000000..bc13ad1 --- /dev/null +++ b/tests/docs/base/01_6string_empty.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"var1": {"type": "variable", "default": ["value", null], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var1"], "names": ["var1"], "descriptions": ["The second variable."], "multiple": true}}}} \ No newline at end of file diff --git a/tests/docs/base/01_6string_empty.md b/tests/docs/base/01_6string_empty.md index 938c15f..18f3dac 100644 --- a/tests/docs/base/01_6string_empty.md +++ b/tests/docs/base/01_6string_empty.md @@ -10,12 +10,13 @@ version: '1.1' var1: description: the second variable empty: false - default: [value, None] + default: + - value + - ``` -# Variables for "rougail" +# Variables for "Rougail" | Variable                                                                                                                       | Description                                                                                                                    | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The second variable.
**Default**:
- value
- None | - +| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The second variable.
**Default**:
- value
- null | diff --git a/tests/docs/base/01_6string_multi.adoc b/tests/docs/base/01_6string_multi.adoc index ed011bb..dc9e1e5 100644 --- a/tests/docs/base/01_6string_multi.adoc +++ b/tests/docs/base/01_6string_multi.adoc @@ -35,58 +35,55 @@ var8: default: - value ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | -The first variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | +The first variable. | + **rougail.var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | -The second variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | +The second variable. | + **rougail.var3** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -The third variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +The third variable. | + **rougail.var4** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | The forth variable. + -**Default**: - -* value +**Default**: value | + **rougail.var5** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | The fifth variable. + -**Default**: - -* value +**Default**: value | + **rougail.var6** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | The sixth variable. + -**Default**: - -* value +**Default**: value | + **rougail.var7** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | The seventh variable. + -**Default**: - -* value +**Default**: value | -**rougail.var8** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | -The eighth variable. + -**Default**: -* value +**rougail.var8** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +The eighth variable. + +**Default**: value |==== - diff --git a/tests/docs/base/01_6string_multi.json b/tests/docs/base/01_6string_multi.json new file mode 100644 index 0000000..9fddff5 --- /dev/null +++ b/tests/docs/base/01_6string_multi.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"var1": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var1"], "names": ["var1"], "descriptions": ["The first variable."], "multiple": true}, "var2": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var2"], "names": ["var2"], "descriptions": ["The second variable."], "multiple": true}, "var3": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.var3"], "names": ["var3"], "descriptions": ["The third variable."]}, "var4": {"type": "variable", "default": ["value"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var4"], "names": ["var4"], "descriptions": ["The forth variable."], "multiple": true}, "var5": {"type": "variable", "default": ["value"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var5"], "names": ["var5"], "descriptions": ["The fifth variable."], "multiple": true}, "var6": {"type": "variable", "default": ["value"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var6"], "names": ["var6"], "descriptions": ["The sixth variable."], "multiple": true}, "var7": {"type": "variable", "default": ["value"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var7"], "names": ["var7"], "descriptions": ["The seventh variable."], "multiple": true}, "var8": {"type": "variable", "default": ["value"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var8"], "names": ["var8"], "descriptions": ["The eighth variable."], "multiple": true}}}} \ No newline at end of file diff --git a/tests/docs/base/01_6string_multi.md b/tests/docs/base/01_6string_multi.md index 325b8bf..c7135e0 100644 --- a/tests/docs/base/01_6string_multi.md +++ b/tests/docs/base/01_6string_multi.md @@ -38,17 +38,16 @@ var8: default: - value ``` -# Variables for "rougail" +# Variables for "Rougail" | Variable                                                                                                                       | Description                                                                                                                    | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | The first variable. | | **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | The second variable. | | **rougail.var3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The third variable. | -| **rougail.var4**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The forth variable.
**Default**:
- value | -| **rougail.var5**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The fifth variable.
**Default**:
- value | -| **rougail.var6**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The sixth variable.
**Default**:
- value | -| **rougail.var7**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The seventh variable.
**Default**:
- value | -| **rougail.var8**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The eighth variable.
**Default**:
- value | - +| **rougail.var4**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The forth variable.
**Default**: value | +| **rougail.var5**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The fifth variable.
**Default**: value | +| **rougail.var6**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The sixth variable.
**Default**: value | +| **rougail.var7**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The seventh variable.
**Default**: value | +| **rougail.var8**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The eighth variable.
**Default**: value | diff --git a/tests/docs/base/01_7value_multi_doublequote.adoc b/tests/docs/base/01_7value_multi_doublequote.adoc index b833ca7..4c1c7b3 100644 --- a/tests/docs/base/01_7value_multi_doublequote.adoc +++ b/tests/docs/base/01_7value_multi_doublequote.adoc @@ -9,18 +9,16 @@ variable: default: - quote" ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | -**rougail.variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | -A variable. + -**Default**: -* quote" +**rougail.variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +A variable. + +**Default**: quote" |==== - diff --git a/tests/docs/base/01_7value_multi_doublequote.json b/tests/docs/base/01_7value_multi_doublequote.json new file mode 100644 index 0000000..7933268 --- /dev/null +++ b/tests/docs/base/01_7value_multi_doublequote.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"variable": {"type": "variable", "default": ["quote\""], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.variable"], "names": ["variable"], "descriptions": ["A variable."], "multiple": true}}}} \ No newline at end of file diff --git a/tests/docs/base/01_7value_multi_doublequote.md b/tests/docs/base/01_7value_multi_doublequote.md index 8b09181..8dd2601 100644 --- a/tests/docs/base/01_7value_multi_doublequote.md +++ b/tests/docs/base/01_7value_multi_doublequote.md @@ -12,10 +12,9 @@ variable: default: - quote" ``` -# Variables for "rougail" +# Variables for "Rougail" | Variable                                                                                                                       | Description                                                                                                                    | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A variable.
**Default**:
- quote" | - +| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A variable.
**Default**: quote" | diff --git a/tests/docs/base/01_7value_multi_doublequote2.adoc b/tests/docs/base/01_7value_multi_doublequote2.adoc index 4043fe0..33542ec 100644 --- a/tests/docs/base/01_7value_multi_doublequote2.adoc +++ b/tests/docs/base/01_7value_multi_doublequote2.adoc @@ -9,18 +9,16 @@ variable: default: - quote'" ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | -**rougail.variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | -A variable. + -**Default**: -* quote'" +**rougail.variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +A variable. + +**Default**: quote'" |==== - diff --git a/tests/docs/base/01_7value_multi_doublequote2.json b/tests/docs/base/01_7value_multi_doublequote2.json new file mode 100644 index 0000000..d5555c9 --- /dev/null +++ b/tests/docs/base/01_7value_multi_doublequote2.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"variable": {"type": "variable", "default": ["quote'\""], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.variable"], "names": ["variable"], "descriptions": ["A variable."], "multiple": true}}}} \ No newline at end of file diff --git a/tests/docs/base/01_7value_multi_doublequote2.md b/tests/docs/base/01_7value_multi_doublequote2.md index b6621b8..1e4ea68 100644 --- a/tests/docs/base/01_7value_multi_doublequote2.md +++ b/tests/docs/base/01_7value_multi_doublequote2.md @@ -12,10 +12,9 @@ variable: default: - quote'" ``` -# Variables for "rougail" +# Variables for "Rougail" | Variable                                                                                                                       | Description                                                                                                                    | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A variable.
**Default**:
- quote'" | - +| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A variable.
**Default**: quote'" | diff --git a/tests/docs/base/01_7value_multi_quote.adoc b/tests/docs/base/01_7value_multi_quote.adoc index 8f3719c..1a2f6c2 100644 --- a/tests/docs/base/01_7value_multi_quote.adoc +++ b/tests/docs/base/01_7value_multi_quote.adoc @@ -9,18 +9,16 @@ variable: default: - quote' ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | -**rougail.variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | -A variable. + -**Default**: -* quote' +**rougail.variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +A variable. + +**Default**: quote' |==== - diff --git a/tests/docs/base/01_7value_multi_quote.json b/tests/docs/base/01_7value_multi_quote.json new file mode 100644 index 0000000..be57fc6 --- /dev/null +++ b/tests/docs/base/01_7value_multi_quote.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"variable": {"type": "variable", "default": ["quote'"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.variable"], "names": ["variable"], "descriptions": ["A variable."], "multiple": true}}}} \ No newline at end of file diff --git a/tests/docs/base/01_7value_multi_quote.md b/tests/docs/base/01_7value_multi_quote.md index 1e05cb3..27e6f8e 100644 --- a/tests/docs/base/01_7value_multi_quote.md +++ b/tests/docs/base/01_7value_multi_quote.md @@ -12,10 +12,9 @@ variable: default: - quote' ``` -# Variables for "rougail" +# Variables for "Rougail" | Variable                                                                                                                       | Description                                                                                                                    | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A variable.
**Default**:
- quote' | - +| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A variable.
**Default**: quote' | diff --git a/tests/docs/base/01_8calculation_information_multi.adoc b/tests/docs/base/01_8calculation_information_multi.adoc index 26730fe..62052de 100644 --- a/tests/docs/base/01_8calculation_information_multi.adoc +++ b/tests/docs/base/01_8calculation_information_multi.adoc @@ -16,16 +16,16 @@ variable: information: test_information description: get information test_information ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | A variable. + -**Default**: get information test_information. +**Default**: get information test_information. |==== - diff --git a/tests/docs/base/01_8calculation_information_multi.json b/tests/docs/base/01_8calculation_information_multi.json new file mode 100644 index 0000000..cf069dd --- /dev/null +++ b/tests/docs/base/01_8calculation_information_multi.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"variable": {"type": "variable", "default": "get information test_information.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.variable"], "names": ["variable"], "descriptions": ["A variable."], "multiple": true}}}} \ No newline at end of file diff --git a/tests/docs/base/01_8calculation_information_multi.md b/tests/docs/base/01_8calculation_information_multi.md index 323e3eb..cd3620c 100644 --- a/tests/docs/base/01_8calculation_information_multi.md +++ b/tests/docs/base/01_8calculation_information_multi.md @@ -19,10 +19,9 @@ variable: information: test_information description: get information test_information ``` -# Variables for "rougail" +# Variables for "Rougail" | Variable                                                                                                                       | Description                                                                                                                    | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A variable.
**Default**: get information test_information. | - diff --git a/tests/docs/base/01_9choice_variable_multi.adoc b/tests/docs/base/01_9choice_variable_multi.adoc index 442e5ad..0580dd0 100644 --- a/tests/docs/base/01_9choice_variable_multi.adoc +++ b/tests/docs/base/01_9choice_variable_multi.adoc @@ -13,25 +13,26 @@ variable2: choices: variable: _.variable1 ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.variable1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | A first variable. + **Default**: * a * b -* c +* c | + **rougail.variable2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `basic` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `basic` `mandatory` | A second variable. + -**Choices**: the value of the variable "rougail.variable1". +**Choices**: the value of the variable "rougail.variable1". |==== - diff --git a/tests/docs/base/01_9choice_variable_multi.json b/tests/docs/base/01_9choice_variable_multi.json new file mode 100644 index 0000000..cdf8bd3 --- /dev/null +++ b/tests/docs/base/01_9choice_variable_multi.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"variable1": {"type": "variable", "default": ["a", "b", "c"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.variable1"], "names": ["variable1"], "descriptions": ["A first variable."], "multiple": true}, "variable2": {"type": "variable", "properties": [{"type": "type", "name": "choice"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "choices": "the value of the variable \"rougail.variable1\".", "paths": ["rougail.variable2"], "names": ["variable2"], "descriptions": ["A second variable."]}}}} \ No newline at end of file diff --git a/tests/docs/base/01_9choice_variable_multi.md b/tests/docs/base/01_9choice_variable_multi.md index 933eb16..4a11bfc 100644 --- a/tests/docs/base/01_9choice_variable_multi.md +++ b/tests/docs/base/01_9choice_variable_multi.md @@ -16,11 +16,10 @@ variable2: choices: variable: _.variable1 ``` -# Variables for "rougail" - -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.variable1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A first variable.
**Default**:
- a
- b
- c | -| **rougail.variable2**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A second variable.
**Choices**: the value of the variable "rougail.variable1". | +# Variables for "Rougail" +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.variable1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A first variable.
**Default**:
- a
- b
- c | +| **rougail.variable2**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A second variable.
**Choices**: the value of the variable "rougail.variable1". | diff --git a/tests/docs/base/04_0type_param.adoc b/tests/docs/base/04_0type_param.adoc index a8e7591..ed266f1 100644 --- a/tests/docs/base/04_0type_param.adoc +++ b/tests/docs/base/04_0type_param.adoc @@ -11,21 +11,21 @@ int: min_number: 0 max_number: 100 ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.int** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` | A limited number. + **Validators**: * the minimum value is 0 * the maximum value is 100 -**Default**: 10 +**Default**: 10 |==== - diff --git a/tests/docs/base/04_0type_param.json b/tests/docs/base/04_0type_param.json new file mode 100644 index 0000000..f150514 --- /dev/null +++ b/tests/docs/base/04_0type_param.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"int": {"type": "variable", "default": 10, "properties": [{"type": "type", "name": "number"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "validators": ["the minimum value is 0", "the maximum value is 100"], "paths": ["rougail.int"], "names": ["int"], "descriptions": ["A limited number."]}}}} \ No newline at end of file diff --git a/tests/docs/base/04_0type_param.md b/tests/docs/base/04_0type_param.md index 823607a..8e4d709 100644 --- a/tests/docs/base/04_0type_param.md +++ b/tests/docs/base/04_0type_param.md @@ -14,10 +14,9 @@ int: min_number: 0 max_number: 100 ``` -# Variables for "rougail" +# Variables for "Rougail" | Variable                                                                                                   | Description                                                                                                | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.int**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A limited number.
**Validators**:
- the minimum value is 0
- the maximum value is 100
**Default**: 10 | - diff --git a/tests/docs/base/04_1auto_save.adoc b/tests/docs/base/04_1auto_save.adoc index f5acd71..a36bfd0 100644 --- a/tests/docs/base/04_1auto_save.adoc +++ b/tests/docs/base/04_1auto_save.adoc @@ -9,16 +9,16 @@ variable: auto_save: true default: no ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `auto modified` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `auto modified` | An auto save variable. + -**Default**: no +**Default**: no |==== - diff --git a/tests/docs/base/04_1auto_save.json b/tests/docs/base/04_1auto_save.json new file mode 100644 index 0000000..7ba3d04 --- /dev/null +++ b/tests/docs/base/04_1auto_save.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"variable": {"type": "variable", "default": "no", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "auto modified"}], "paths": ["rougail.variable"], "names": ["variable"], "descriptions": ["An auto save variable."]}}}} \ No newline at end of file diff --git a/tests/docs/base/04_1auto_save.md b/tests/docs/base/04_1auto_save.md index bd110db..ec85cf4 100644 --- a/tests/docs/base/04_1auto_save.md +++ b/tests/docs/base/04_1auto_save.md @@ -12,10 +12,9 @@ variable: auto_save: true default: no ``` -# Variables for "rougail" +# Variables for "Rougail" | Variable                                                                                                                | Description                                                                                                             | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `auto modified` | An auto save variable.
**Default**: no | - diff --git a/tests/docs/base/04_1auto_save_and_calculated.adoc b/tests/docs/base/04_1auto_save_and_calculated.adoc index f73ed9c..5f22800 100644 --- a/tests/docs/base/04_1auto_save_and_calculated.adoc +++ b/tests/docs/base/04_1auto_save_and_calculated.adoc @@ -11,21 +11,22 @@ var2: default: variable: _.var1 ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A first variable. + -**Default**: no +**Default**: no | + **rougail.var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `auto modified` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `auto modified` | A second variable. + -**Default**: the value of the variable "rougail.var1". +**Default**: the value of the variable "rougail.var1". |==== - diff --git a/tests/docs/base/04_1auto_save_and_calculated.json b/tests/docs/base/04_1auto_save_and_calculated.json new file mode 100644 index 0000000..fb484b9 --- /dev/null +++ b/tests/docs/base/04_1auto_save_and_calculated.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"var1": {"type": "variable", "default": "no", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.var1"], "names": ["var1"], "descriptions": ["A first variable."]}, "var2": {"type": "variable", "default": "the value of the variable \"rougail.var1\".", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "auto modified"}], "paths": ["rougail.var2"], "names": ["var2"], "descriptions": ["A second variable."]}}}} \ No newline at end of file diff --git a/tests/docs/base/04_1auto_save_and_calculated.md b/tests/docs/base/04_1auto_save_and_calculated.md index 9a2daf4..436a720 100644 --- a/tests/docs/base/04_1auto_save_and_calculated.md +++ b/tests/docs/base/04_1auto_save_and_calculated.md @@ -14,11 +14,10 @@ var2: default: variable: _.var1 ``` -# Variables for "rougail" +# Variables for "Rougail" | Variable                                                                                                                | Description                                                                                                             | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A first variable.
**Default**: no | | **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `auto modified` | A second variable.
**Default**: the value of the variable "rougail.var1". | - diff --git a/tests/docs/base/04_1auto_save_and_calculated_hidden.adoc b/tests/docs/base/04_1auto_save_and_calculated_hidden.adoc index d864e79..2fb0a2e 100644 --- a/tests/docs/base/04_1auto_save_and_calculated_hidden.adoc +++ b/tests/docs/base/04_1auto_save_and_calculated_hidden.adoc @@ -18,22 +18,23 @@ var2: jinja: yes description: the value is always yes ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A first variable. + -**Default**: no +**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". +**Hidden**: only if the variable var1 has value "yes". |==== - diff --git a/tests/docs/base/04_1auto_save_and_calculated_hidden.json b/tests/docs/base/04_1auto_save_and_calculated_hidden.json new file mode 100644 index 0000000..f7d3b8e --- /dev/null +++ b/tests/docs/base/04_1auto_save_and_calculated_hidden.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"var1": {"type": "variable", "default": "no", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.var1"], "names": ["var1"], "descriptions": ["A first variable."]}, "var2": {"type": "variable", "default": "the value is always yes.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "hidden", "annotation": "only if the variable var1 has value \"yes\"."}, {"type": "property", "name": "auto modified"}], "paths": ["rougail.var2"], "names": ["var2"], "descriptions": ["A second variable."]}}}} \ No newline at end of file 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 be36b29..0aa6e91 100644 --- a/tests/docs/base/04_1auto_save_and_calculated_hidden.md +++ b/tests/docs/base/04_1auto_save_and_calculated_hidden.md @@ -21,11 +21,10 @@ var2: jinja: yes description: the value is always yes ``` -# Variables for "rougail" +# Variables for "Rougail" | Variable                                                                                                                           | Description                                                                                                                        | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A first variable.
**Default**: no | | **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` *`hidden`* `auto modified` | A second variable.
**Default**: the value is always yes.
**Hidden**: only if the variable var1 has value "yes". | - diff --git a/tests/docs/base/04_1auto_save_and_hidden.json b/tests/docs/base/04_1auto_save_and_hidden.json new file mode 100644 index 0000000..9e26dfe --- /dev/null +++ b/tests/docs/base/04_1auto_save_and_hidden.json @@ -0,0 +1 @@ +{} \ No newline at end of file diff --git a/tests/docs/base/04_1default_calculation_hidden.adoc b/tests/docs/base/04_1default_calculation_hidden.adoc index 44697c3..d7c7b2b 100644 --- a/tests/docs/base/04_1default_calculation_hidden.adoc +++ b/tests/docs/base/04_1default_calculation_hidden.adoc @@ -23,26 +23,28 @@ var3: value {% endif %} ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A first variable. + -**Default**: value +**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". +**Disabled**: when the variable "rougail.var1" has the value "value". | + **rougail.var3** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A third variable. + -**Default**: depends on a calculation. +**Default**: depends on a calculation. |==== - diff --git a/tests/docs/base/04_1default_calculation_hidden.json b/tests/docs/base/04_1default_calculation_hidden.json new file mode 100644 index 0000000..c449696 --- /dev/null +++ b/tests/docs/base/04_1default_calculation_hidden.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"var1": {"type": "variable", "default": "value", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.var1"], "names": ["var1"], "descriptions": ["A first variable."]}, "var2": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "disabled", "annotation": "when the variable \"rougail.var1\" has the value \"value\"."}], "paths": ["rougail.var2"], "names": ["var2"], "descriptions": ["A second variable."]}, "var3": {"type": "variable", "default": "depends on a calculation.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.var3"], "names": ["var3"], "descriptions": ["A third variable."]}}}} \ No newline at end of file diff --git a/tests/docs/base/04_1default_calculation_hidden.md b/tests/docs/base/04_1default_calculation_hidden.md index 77f5254..4509ff6 100644 --- a/tests/docs/base/04_1default_calculation_hidden.md +++ b/tests/docs/base/04_1default_calculation_hidden.md @@ -26,12 +26,11 @@ var3: value {% endif %} ``` -# Variables for "rougail" - -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A first variable.
**Default**: value | -| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` *`disabled`* | A second variable.
**Disabled**: when the variable "rougail.var1" has the value "value". | -| **rougail.var3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A third variable.
**Default**: depends on a calculation. | +# Variables for "Rougail" +| Variable                                                                                                             | Description                                                                                                          | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A first variable.
**Default**: value | +| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` *`disabled`* | A second variable.
**Disabled**: when the variable "rougail.var1" has the value "value". | +| **rougail.var3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A third variable.
**Default**: depends on a calculation. | diff --git a/tests/docs/base/04_1default_calculation_hidden_2.adoc b/tests/docs/base/04_1default_calculation_hidden_2.adoc index 77870b9..db91300 100644 --- a/tests/docs/base/04_1default_calculation_hidden_2.adoc +++ b/tests/docs/base/04_1default_calculation_hidden_2.adoc @@ -23,26 +23,28 @@ var3: value {% endif %} ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A first variable. + -**Default**: value +**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". +**Disabled**: when the variable "rougail.var1" has the value "value". | + **rougail.var3** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A third variable. + -**Default**: depends on a calculation. +**Default**: depends on a calculation. |==== - diff --git a/tests/docs/base/04_1default_calculation_hidden_2.json b/tests/docs/base/04_1default_calculation_hidden_2.json new file mode 100644 index 0000000..c449696 --- /dev/null +++ b/tests/docs/base/04_1default_calculation_hidden_2.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"var1": {"type": "variable", "default": "value", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.var1"], "names": ["var1"], "descriptions": ["A first variable."]}, "var2": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "disabled", "annotation": "when the variable \"rougail.var1\" has the value \"value\"."}], "paths": ["rougail.var2"], "names": ["var2"], "descriptions": ["A second variable."]}, "var3": {"type": "variable", "default": "depends on a calculation.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.var3"], "names": ["var3"], "descriptions": ["A third variable."]}}}} \ No newline at end of file diff --git a/tests/docs/base/04_1default_calculation_hidden_2.md b/tests/docs/base/04_1default_calculation_hidden_2.md index c9d1de1..0ac0791 100644 --- a/tests/docs/base/04_1default_calculation_hidden_2.md +++ b/tests/docs/base/04_1default_calculation_hidden_2.md @@ -26,12 +26,11 @@ var3: value {% endif %} ``` -# Variables for "rougail" - -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A first variable.
**Default**: value | -| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` *`disabled`* | A second variable.
**Disabled**: when the variable "rougail.var1" has the value "value". | -| **rougail.var3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A third variable.
**Default**: depends on a calculation. | +# Variables for "Rougail" +| Variable                                                                                                             | Description                                                                                                          | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A first variable.
**Default**: value | +| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` *`disabled`* | A second variable.
**Disabled**: when the variable "rougail.var1" has the value "value". | +| **rougail.var3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A third variable.
**Default**: depends on a calculation. | diff --git a/tests/docs/base/04_5disabled_calculation.adoc b/tests/docs/base/04_5disabled_calculation.adoc index de59172..7e77c63 100644 --- a/tests/docs/base/04_5disabled_calculation.adoc +++ b/tests/docs/base/04_5disabled_calculation.adoc @@ -22,26 +22,28 @@ variable2: {% endif %} description: if condition is egal to "yes" ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.condition** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A conditional variable. + -**Default**: no +**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". +**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". +**Disabled**: if condition is egal to "yes". |==== - diff --git a/tests/docs/base/04_5disabled_calculation.json b/tests/docs/base/04_5disabled_calculation.json new file mode 100644 index 0000000..231f2e5 --- /dev/null +++ b/tests/docs/base/04_5disabled_calculation.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"condition": {"type": "variable", "default": "no", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.condition"], "names": ["condition"], "descriptions": ["A conditional variable."]}, "variable1": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "disabled", "annotation": "if condition is egal to \"yes\"."}], "paths": ["rougail.variable1"], "names": ["variable1"], "descriptions": ["A first variable."]}, "variable2": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "disabled", "annotation": "if condition is egal to \"yes\"."}], "paths": ["rougail.variable2"], "names": ["variable2"], "descriptions": ["A second variable."]}}}} \ No newline at end of file diff --git a/tests/docs/base/04_5disabled_calculation.md b/tests/docs/base/04_5disabled_calculation.md index d84a553..ce18e5b 100644 --- a/tests/docs/base/04_5disabled_calculation.md +++ b/tests/docs/base/04_5disabled_calculation.md @@ -25,7 +25,7 @@ variable2: {% endif %} description: if condition is egal to "yes" ``` -# Variables for "rougail" +# Variables for "Rougail" | Variable                                                                                                             | Description                                                                                                          | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| @@ -33,4 +33,3 @@ variable2: | **rougail.variable1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` *`disabled`* | A first variable.
**Disabled**: if condition is egal to "yes". | | **rougail.variable2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` *`disabled`* | A second variable.
**Disabled**: if condition is egal to "yes". | - diff --git a/tests/docs/base/04_5disabled_calculation_default.adoc b/tests/docs/base/04_5disabled_calculation_default.adoc index 6268c71..3541b2e 100644 --- a/tests/docs/base/04_5disabled_calculation_default.adoc +++ b/tests/docs/base/04_5disabled_calculation_default.adoc @@ -33,28 +33,30 @@ var2: {{ rougail.condition }} description: the value of condition ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.condition** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A condition. + -**Default**: no +**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. +**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. +**Disabled**: if condition is yes. |==== - diff --git a/tests/docs/base/04_5disabled_calculation_default.json b/tests/docs/base/04_5disabled_calculation_default.json new file mode 100644 index 0000000..33c385b --- /dev/null +++ b/tests/docs/base/04_5disabled_calculation_default.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"condition": {"type": "variable", "default": "no", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.condition"], "names": ["condition"], "descriptions": ["A condition."]}, "var1": {"type": "variable", "default": "the value of condition.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "disabled", "annotation": "if condition is yes."}], "paths": ["rougail.var1"], "names": ["var1"], "descriptions": ["A first variable."]}, "var2": {"type": "variable", "default": "the value of condition.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "disabled", "annotation": "if condition is yes."}], "paths": ["rougail.var2"], "names": ["var2"], "descriptions": ["A second variable."]}}}} \ No newline at end of file diff --git a/tests/docs/base/04_5disabled_calculation_default.md b/tests/docs/base/04_5disabled_calculation_default.md index 8f899f9..3beb0a4 100644 --- a/tests/docs/base/04_5disabled_calculation_default.md +++ b/tests/docs/base/04_5disabled_calculation_default.md @@ -36,7 +36,7 @@ var2: {{ rougail.condition }} description: the value of condition ``` -# Variables for "rougail" +# Variables for "Rougail" | Variable                                                                                                                | Description                                                                                                             | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| @@ -44,4 +44,3 @@ var2: | **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` *`disabled`* | A first variable.
**Default**: the value of condition.
**Disabled**: if condition is yes. | | **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` *`disabled`* | A second variable.
**Default**: the value of condition.
**Disabled**: if condition is yes. | - diff --git a/tests/docs/base/04_5disabled_calculation_optional.adoc b/tests/docs/base/04_5disabled_calculation_optional.adoc index dcc3eca..3548078 100644 --- a/tests/docs/base/04_5disabled_calculation_optional.adoc +++ b/tests/docs/base/04_5disabled_calculation_optional.adoc @@ -36,26 +36,28 @@ var2: description: calculation from an condition variable mandatory: false ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.condition** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A condition. + -**Default**: no +**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. +**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. +**Hidden**: calculation from an condition variable. |==== - diff --git a/tests/docs/base/04_5disabled_calculation_optional.json b/tests/docs/base/04_5disabled_calculation_optional.json new file mode 100644 index 0000000..3abcae3 --- /dev/null +++ b/tests/docs/base/04_5disabled_calculation_optional.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"condition": {"type": "variable", "default": "no", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.condition"], "names": ["condition"], "descriptions": ["A condition."]}, "var1": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "hidden", "annotation": "calculation from an unknown variable."}], "paths": ["rougail.var1"], "names": ["var1"], "descriptions": ["A first variable."]}, "var2": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "hidden", "annotation": "calculation from an condition variable."}], "paths": ["rougail.var2"], "names": ["var2"], "descriptions": ["A second variable."]}}}} \ No newline at end of file diff --git a/tests/docs/base/04_5disabled_calculation_optional.md b/tests/docs/base/04_5disabled_calculation_optional.md index 21056ac..e35719b 100644 --- a/tests/docs/base/04_5disabled_calculation_optional.md +++ b/tests/docs/base/04_5disabled_calculation_optional.md @@ -39,12 +39,11 @@ var2: description: calculation from an condition variable mandatory: false ``` -# Variables for "rougail" - -| Variable                                                                                                  | Description                                                                                               | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.
**Default**: no | -| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` *`hidden`* | A first variable.
**Hidden**: calculation from an unknown variable. | -| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` *`hidden`* | A second variable.
**Hidden**: calculation from an condition variable. | +# Variables for "Rougail" +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.
**Default**: no | +| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` *`hidden`* | A first variable.
**Hidden**: calculation from an unknown variable. | +| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` *`hidden`* | A second variable.
**Hidden**: calculation from an condition variable. | diff --git a/tests/docs/base/04_5disabled_calculation_variable.adoc b/tests/docs/base/04_5disabled_calculation_variable.adoc index 8c5a172..1cf8039 100644 --- a/tests/docs/base/04_5disabled_calculation_variable.adoc +++ b/tests/docs/base/04_5disabled_calculation_variable.adoc @@ -10,21 +10,22 @@ variable: disabled: variable: _.condition ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.condition** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | A condition. + -**Default**: False +**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". +**Disabled**: when the variable "rougail.condition" has the value "true". |==== - diff --git a/tests/docs/base/04_5disabled_calculation_variable.json b/tests/docs/base/04_5disabled_calculation_variable.json new file mode 100644 index 0000000..c7cff7e --- /dev/null +++ b/tests/docs/base/04_5disabled_calculation_variable.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"condition": {"type": "variable", "default": false, "properties": [{"type": "type", "name": "boolean"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.condition"], "names": ["condition"], "descriptions": ["A condition."]}, "variable": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "disabled", "annotation": "when the variable \"rougail.condition\" has the value \"true\"."}], "paths": ["rougail.variable"], "names": ["variable"], "descriptions": ["A variable."]}}}} \ No newline at end of file diff --git a/tests/docs/base/04_5disabled_calculation_variable.md b/tests/docs/base/04_5disabled_calculation_variable.md index f332985..c705909 100644 --- a/tests/docs/base/04_5disabled_calculation_variable.md +++ b/tests/docs/base/04_5disabled_calculation_variable.md @@ -13,11 +13,10 @@ variable: disabled: variable: _.condition ``` -# Variables for "rougail" +# Variables for "Rougail" | Variable                                                                                                             | Description                                                                                                          | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.condition**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.
**Default**: False | -| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` *`disabled`* | A variable.
**Disabled**: when the variable "rougail.condition" has the value "True". | - +| **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". | diff --git a/tests/docs/base/04_5disabled_calculation_variable2.adoc b/tests/docs/base/04_5disabled_calculation_variable2.adoc index 1d997ce..0593da8 100644 --- a/tests/docs/base/04_5disabled_calculation_variable2.adoc +++ b/tests/docs/base/04_5disabled_calculation_variable2.adoc @@ -10,21 +10,22 @@ variable: disabled: variable: _.condition ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.condition** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | A condition. + -**Default**: True +**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". +**Disabled**: when the variable "rougail.condition" has the value "true". |==== - diff --git a/tests/docs/base/04_5disabled_calculation_variable2.json b/tests/docs/base/04_5disabled_calculation_variable2.json new file mode 100644 index 0000000..7601f2c --- /dev/null +++ b/tests/docs/base/04_5disabled_calculation_variable2.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"condition": {"type": "variable", "default": true, "properties": [{"type": "type", "name": "boolean"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.condition"], "names": ["condition"], "descriptions": ["A condition."]}, "variable": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "disabled", "annotation": "when the variable \"rougail.condition\" has the value \"true\"."}], "paths": ["rougail.variable"], "names": ["variable"], "descriptions": ["A variable."]}}}} \ No newline at end of file diff --git a/tests/docs/base/04_5disabled_calculation_variable2.md b/tests/docs/base/04_5disabled_calculation_variable2.md index b60897f..725e2bd 100644 --- a/tests/docs/base/04_5disabled_calculation_variable2.md +++ b/tests/docs/base/04_5disabled_calculation_variable2.md @@ -13,11 +13,10 @@ variable: disabled: variable: _.condition ``` -# Variables for "rougail" +# Variables for "Rougail" | Variable                                                                                                             | Description                                                                                                          | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.condition**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.
**Default**: True | -| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` *`disabled`* | A variable.
**Disabled**: when the variable "rougail.condition" has the value "True". | - +| **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". | diff --git a/tests/docs/base/04_5disabled_calculation_variable3.adoc b/tests/docs/base/04_5disabled_calculation_variable3.adoc index 6baf57b..69eb5b1 100644 --- a/tests/docs/base/04_5disabled_calculation_variable3.adoc +++ b/tests/docs/base/04_5disabled_calculation_variable3.adoc @@ -11,21 +11,22 @@ variable: variable: _.condition when: yes ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.condition** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A condition. + -**Default**: yes +**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". +**Disabled**: when the variable "rougail.condition" has the value "yes". |==== - diff --git a/tests/docs/base/04_5disabled_calculation_variable3.json b/tests/docs/base/04_5disabled_calculation_variable3.json new file mode 100644 index 0000000..444cc4c --- /dev/null +++ b/tests/docs/base/04_5disabled_calculation_variable3.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"condition": {"type": "variable", "default": "yes", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.condition"], "names": ["condition"], "descriptions": ["A condition."]}, "variable": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "disabled", "annotation": "when the variable \"rougail.condition\" has the value \"yes\"."}], "paths": ["rougail.variable"], "names": ["variable"], "descriptions": ["A variable."]}}}} \ No newline at end of file diff --git a/tests/docs/base/04_5disabled_calculation_variable3.md b/tests/docs/base/04_5disabled_calculation_variable3.md index 7482828..f8a460a 100644 --- a/tests/docs/base/04_5disabled_calculation_variable3.md +++ b/tests/docs/base/04_5disabled_calculation_variable3.md @@ -14,11 +14,10 @@ variable: variable: _.condition when: yes ``` -# Variables for "rougail" +# Variables for "Rougail" | Variable                                                                                                             | Description                                                                                                          | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.
**Default**: yes | | **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` *`disabled`* | A variable.
**Disabled**: when the variable "rougail.condition" has the value "yes". | - diff --git a/tests/docs/base/04_5disabled_calculation_variable4.adoc b/tests/docs/base/04_5disabled_calculation_variable4.adoc index 103d5ae..09a5830 100644 --- a/tests/docs/base/04_5disabled_calculation_variable4.adoc +++ b/tests/docs/base/04_5disabled_calculation_variable4.adoc @@ -11,21 +11,22 @@ variable: variable: _.condition when_not: yes ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.condition** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A condition. + -**Default**: yes +**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". +**Disabled**: when the variable "rougail.condition" hasn't the value "yes". |==== - diff --git a/tests/docs/base/04_5disabled_calculation_variable4.json b/tests/docs/base/04_5disabled_calculation_variable4.json new file mode 100644 index 0000000..606e663 --- /dev/null +++ b/tests/docs/base/04_5disabled_calculation_variable4.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"condition": {"type": "variable", "default": "yes", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.condition"], "names": ["condition"], "descriptions": ["A condition."]}, "variable": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "disabled", "annotation": "when the variable \"rougail.condition\" hasn't the value \"yes\"."}], "paths": ["rougail.variable"], "names": ["variable"], "descriptions": ["A variable."]}}}} \ No newline at end of file diff --git a/tests/docs/base/04_5disabled_calculation_variable4.md b/tests/docs/base/04_5disabled_calculation_variable4.md index abd909a..b967749 100644 --- a/tests/docs/base/04_5disabled_calculation_variable4.md +++ b/tests/docs/base/04_5disabled_calculation_variable4.md @@ -14,11 +14,10 @@ variable: variable: _.condition when_not: yes ``` -# Variables for "rougail" +# Variables for "Rougail" | Variable                                                                                                             | Description                                                                                                          | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.
**Default**: yes | | **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` *`disabled`* | A variable.
**Disabled**: when the variable "rougail.condition" hasn't the value "yes". | - diff --git a/tests/docs/base/04_5hidden_calculation.adoc b/tests/docs/base/04_5hidden_calculation.adoc index 40bfd90..788596e 100644 --- a/tests/docs/base/04_5hidden_calculation.adoc +++ b/tests/docs/base/04_5hidden_calculation.adoc @@ -24,28 +24,30 @@ var2: {% endif %} description: if condition is yes ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.condition** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | The condition. + -**Default**: no +**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. +**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. +**Hidden**: if condition is yes. |==== - diff --git a/tests/docs/base/04_5hidden_calculation.json b/tests/docs/base/04_5hidden_calculation.json new file mode 100644 index 0000000..7fe87ad --- /dev/null +++ b/tests/docs/base/04_5hidden_calculation.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"condition": {"type": "variable", "default": "no", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.condition"], "names": ["condition"], "descriptions": ["The condition."]}, "var1": {"type": "variable", "default": "no", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "hidden", "annotation": "if condition is yes."}], "paths": ["rougail.var1"], "names": ["var1"], "descriptions": ["A first variable."]}, "var2": {"type": "variable", "default": "no", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "hidden", "annotation": "if condition is yes."}], "paths": ["rougail.var2"], "names": ["var2"], "descriptions": ["A second variable."]}}}} \ No newline at end of file diff --git a/tests/docs/base/04_5hidden_calculation.md b/tests/docs/base/04_5hidden_calculation.md index 6574af4..8caf341 100644 --- a/tests/docs/base/04_5hidden_calculation.md +++ b/tests/docs/base/04_5hidden_calculation.md @@ -27,7 +27,7 @@ var2: {% endif %} description: if condition is yes ``` -# Variables for "rougail" +# Variables for "Rougail" | Variable                                                                                                              | Description                                                                                                           | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| @@ -35,4 +35,3 @@ var2: | **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` *`hidden`* | A first variable.
**Default**: no
**Hidden**: if condition is yes. | | **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` *`hidden`* | A second variable.
**Default**: no
**Hidden**: if condition is yes. | - diff --git a/tests/docs/base/04_5hidden_calculation2.adoc b/tests/docs/base/04_5hidden_calculation2.adoc index b8d0944..d8a6291 100644 --- a/tests/docs/base/04_5hidden_calculation2.adoc +++ b/tests/docs/base/04_5hidden_calculation2.adoc @@ -30,28 +30,30 @@ var2: {{ rougail.condition }} description: the value of condition ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.condition** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A condition. + -**Default**: no +**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. +**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. +**Hidden**: if condition is yes. |==== - diff --git a/tests/docs/base/04_5hidden_calculation2.json b/tests/docs/base/04_5hidden_calculation2.json new file mode 100644 index 0000000..b5c311a --- /dev/null +++ b/tests/docs/base/04_5hidden_calculation2.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"condition": {"type": "variable", "default": "no", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.condition"], "names": ["condition"], "descriptions": ["A condition."]}, "var1": {"type": "variable", "default": "the value of condition.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "hidden", "annotation": "if condition is yes."}], "paths": ["rougail.var1"], "names": ["var1"], "descriptions": ["A first variable."]}, "var2": {"type": "variable", "default": "the value of condition.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "hidden", "annotation": "if condition is yes."}], "paths": ["rougail.var2"], "names": ["var2"], "descriptions": ["A second variable."]}}}} \ No newline at end of file diff --git a/tests/docs/base/04_5hidden_calculation2.md b/tests/docs/base/04_5hidden_calculation2.md index a2acce2..d7b2e72 100644 --- a/tests/docs/base/04_5hidden_calculation2.md +++ b/tests/docs/base/04_5hidden_calculation2.md @@ -33,7 +33,7 @@ var2: {{ rougail.condition }} description: the value of condition ``` -# Variables for "rougail" +# Variables for "Rougail" | Variable                                                                                                              | Description                                                                                                           | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| @@ -41,4 +41,3 @@ var2: | **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` *`hidden`* | A first variable.
**Default**: the value of condition.
**Hidden**: if condition is yes. | | **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` *`hidden`* | A second variable.
**Default**: the value of condition.
**Hidden**: if condition is yes. | - diff --git a/tests/docs/base/04_5hidden_calculation_default_calculation.adoc b/tests/docs/base/04_5hidden_calculation_default_calculation.adoc index f5f3652..f184b66 100644 --- a/tests/docs/base/04_5hidden_calculation_default_calculation.adoc +++ b/tests/docs/base/04_5hidden_calculation_default_calculation.adoc @@ -30,28 +30,30 @@ var2: {{ rougail.condition }} description: returns the condition value ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.condition** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A condition. + -**Default**: no +**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. +**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. +**Hidden**: if condition is yes. |==== - diff --git a/tests/docs/base/04_5hidden_calculation_default_calculation.json b/tests/docs/base/04_5hidden_calculation_default_calculation.json new file mode 100644 index 0000000..8d097d6 --- /dev/null +++ b/tests/docs/base/04_5hidden_calculation_default_calculation.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"condition": {"type": "variable", "default": "no", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.condition"], "names": ["condition"], "descriptions": ["A condition."]}, "var1": {"type": "variable", "default": "returns the condition value.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "hidden", "annotation": "if condition is yes."}], "paths": ["rougail.var1"], "names": ["var1"], "descriptions": ["A first variable."]}, "var2": {"type": "variable", "default": "returns the condition value.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "hidden", "annotation": "if condition is yes."}], "paths": ["rougail.var2"], "names": ["var2"], "descriptions": ["A second variable."]}}}} \ No newline at end of file diff --git a/tests/docs/base/04_5hidden_calculation_default_calculation.md b/tests/docs/base/04_5hidden_calculation_default_calculation.md index 70838aa..af84484 100644 --- a/tests/docs/base/04_5hidden_calculation_default_calculation.md +++ b/tests/docs/base/04_5hidden_calculation_default_calculation.md @@ -33,7 +33,7 @@ var2: {{ rougail.condition }} description: returns the condition value ``` -# Variables for "rougail" +# Variables for "Rougail" | Variable                                                                                                              | Description                                                                                                           | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| @@ -41,4 +41,3 @@ var2: | **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` *`hidden`* | A first variable.
**Default**: returns the condition value.
**Hidden**: if condition is yes. | | **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` *`hidden`* | A second variable.
**Default**: returns the condition value.
**Hidden**: if condition is yes. | - diff --git a/tests/docs/base/04_5validators.adoc b/tests/docs/base/04_5validators.adoc index 0832f47..59eda53 100644 --- a/tests/docs/base/04_5validators.adoc +++ b/tests/docs/base/04_5validators.adoc @@ -14,16 +14,16 @@ int: {% endif %} description: the max value is 100 ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.int** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `basic` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `basic` `mandatory` | A number. + -**Validator**: the max value is 100. +**Validator**: the max value is 100. |==== - diff --git a/tests/docs/base/04_5validators.json b/tests/docs/base/04_5validators.json new file mode 100644 index 0000000..44417ed --- /dev/null +++ b/tests/docs/base/04_5validators.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"int": {"type": "variable", "properties": [{"type": "type", "name": "number"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "validators": ["the max value is 100."], "paths": ["rougail.int"], "names": ["int"], "descriptions": ["A number."]}}}} \ No newline at end of file diff --git a/tests/docs/base/04_5validators.md b/tests/docs/base/04_5validators.md index a1ef14e..bfa61f7 100644 --- a/tests/docs/base/04_5validators.md +++ b/tests/docs/base/04_5validators.md @@ -17,10 +17,9 @@ int: {% endif %} description: the max value is 100 ``` -# Variables for "rougail" +# Variables for "Rougail" | Variable                                                                                                | Description                                                                                             | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.int**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A number.
**Validator**: the max value is 100. | - diff --git a/tests/docs/base/04_5validators_differ.adoc b/tests/docs/base/04_5validators_differ.adoc index c4cbb35..551b726 100644 --- a/tests/docs/base/04_5validators_differ.adoc +++ b/tests/docs/base/04_5validators_differ.adoc @@ -18,23 +18,24 @@ var1: description: var1 must be different than var2 var2: no # A second variable ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A first variable. + **Validator**: var1 must be different than var2. + **Default**: oui + -**Example**: another_value +**Example**: another_value | + **rougail.var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A second variable. + -**Default**: no +**Default**: no |==== - diff --git a/tests/docs/base/04_5validators_differ.json b/tests/docs/base/04_5validators_differ.json new file mode 100644 index 0000000..c688703 --- /dev/null +++ b/tests/docs/base/04_5validators_differ.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"var1": {"type": "variable", "default": "oui", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "validators": ["var1 must be different than var2."], "paths": ["rougail.var1"], "names": ["var1"], "descriptions": ["A first variable."], "examples": ["another_value"]}, "var2": {"type": "variable", "default": "no", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.var2"], "names": ["var2"], "descriptions": ["A second variable."]}}}} \ No newline at end of file diff --git a/tests/docs/base/04_5validators_differ.md b/tests/docs/base/04_5validators_differ.md index 9c64bf4..20c757c 100644 --- a/tests/docs/base/04_5validators_differ.md +++ b/tests/docs/base/04_5validators_differ.md @@ -21,11 +21,10 @@ var1: description: var1 must be different than var2 var2: no # A second variable ``` -# Variables for "rougail" +# Variables for "Rougail" | Variable                                                                                                   | Description                                                                                                | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A first variable.
**Validator**: var1 must be different than var2.
**Default**: oui
**Example**: another_value | | **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second variable.
**Default**: no | - diff --git a/tests/docs/base/04_5validators_multi.adoc b/tests/docs/base/04_5validators_multi.adoc index d8cb9d5..aea98f1 100644 --- a/tests/docs/base/04_5validators_multi.adoc +++ b/tests/docs/base/04_5validators_multi.adoc @@ -17,20 +17,20 @@ var1: {% endif %} description: check length is less than 10 ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | A second variable. + **Validator**: check length is less than 10. + **Default**: * no -* yes +* yes |==== - diff --git a/tests/docs/base/04_5validators_multi.json b/tests/docs/base/04_5validators_multi.json new file mode 100644 index 0000000..980b8d2 --- /dev/null +++ b/tests/docs/base/04_5validators_multi.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"var1": {"type": "variable", "default": ["no", "yes"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "validators": ["check length is less than 10."], "paths": ["rougail.var1"], "names": ["var1"], "descriptions": ["A second variable."], "multiple": true}}}} \ No newline at end of file diff --git a/tests/docs/base/04_5validators_multi.md b/tests/docs/base/04_5validators_multi.md index 1efe147..9f142cb 100644 --- a/tests/docs/base/04_5validators_multi.md +++ b/tests/docs/base/04_5validators_multi.md @@ -20,10 +20,9 @@ var1: {% endif %} description: check length is less than 10 ``` -# Variables for "rougail" +# Variables for "Rougail" | Variable                                                                                                                       | Description                                                                                                                    | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A second variable.
**Validator**: check length is less than 10.
**Default**:
- no
- yes | - diff --git a/tests/docs/base/04_5validators_multi2.adoc b/tests/docs/base/04_5validators_multi2.adoc index 5bffa31..0dc23fe 100644 --- a/tests/docs/base/04_5validators_multi2.adoc +++ b/tests/docs/base/04_5validators_multi2.adoc @@ -24,14 +24,15 @@ var1: {% endif %} description: check length is less than 3 ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | A second variable. + **Validator**: check length is less than 3. + **Default**: @@ -42,7 +43,6 @@ A second variable. + **Examples**: * val1 -* val2 +* val2 |==== - diff --git a/tests/docs/base/04_5validators_multi2.json b/tests/docs/base/04_5validators_multi2.json new file mode 100644 index 0000000..a07f0e3 --- /dev/null +++ b/tests/docs/base/04_5validators_multi2.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"var1": {"type": "variable", "default": ["no", "yes"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "validators": ["check length is less than 3."], "paths": ["rougail.var1"], "names": ["var1"], "descriptions": ["A second variable."], "multiple": true, "examples": ["val1", "val2"]}}}} \ No newline at end of file diff --git a/tests/docs/base/04_5validators_multi2.md b/tests/docs/base/04_5validators_multi2.md index 1b8ebbd..9d7f6bd 100644 --- a/tests/docs/base/04_5validators_multi2.md +++ b/tests/docs/base/04_5validators_multi2.md @@ -27,10 +27,9 @@ var1: {% endif %} description: check length is less than 3 ``` -# Variables for "rougail" +# Variables for "Rougail" | Variable                                                                                                                       | Description                                                                                                                    | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A second variable.
**Validator**: check length is less than 3.
**Default**:
- no
- yes
**Examples**:
- val1
- val2 | - diff --git a/tests/docs/base/05_0multi_not_uniq.adoc b/tests/docs/base/05_0multi_not_uniq.adoc index 99ecff1..39a4551 100644 --- a/tests/docs/base/05_0multi_not_uniq.adoc +++ b/tests/docs/base/05_0multi_not_uniq.adoc @@ -10,18 +10,16 @@ var1: default: - non ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | -**rougail.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `multiple` | -A variable. + -**Default**: -* non +**rougail.var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `multiple` | +A variable. + +**Default**: non |==== - diff --git a/tests/docs/base/05_0multi_not_uniq.json b/tests/docs/base/05_0multi_not_uniq.json new file mode 100644 index 0000000..bb17c5a --- /dev/null +++ b/tests/docs/base/05_0multi_not_uniq.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"var1": {"type": "variable", "default": ["non"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var1"], "names": ["var1"], "descriptions": ["A variable."], "multiple": true}}}} \ No newline at end of file diff --git a/tests/docs/base/05_0multi_not_uniq.md b/tests/docs/base/05_0multi_not_uniq.md index 3a0f6e5..13259e5 100644 --- a/tests/docs/base/05_0multi_not_uniq.md +++ b/tests/docs/base/05_0multi_not_uniq.md @@ -13,10 +13,9 @@ var1: default: - non ``` -# Variables for "rougail" +# Variables for "Rougail" | Variable                                                                                                              | Description                                                                                                           | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `multiple` | A variable.
**Default**:
- non | - +| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `multiple` | A variable.
**Default**: non | diff --git a/tests/docs/base/05_0multi_uniq.adoc b/tests/docs/base/05_0multi_uniq.adoc index 498c9d9..2d978b8 100644 --- a/tests/docs/base/05_0multi_uniq.adoc +++ b/tests/docs/base/05_0multi_uniq.adoc @@ -10,18 +10,16 @@ variable: default: - non ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | -**rougail.variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | -A variable. + -**Default**: -* non +**rougail.variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +A variable. + +**Default**: non |==== - diff --git a/tests/docs/base/05_0multi_uniq.json b/tests/docs/base/05_0multi_uniq.json new file mode 100644 index 0000000..2633a35 --- /dev/null +++ b/tests/docs/base/05_0multi_uniq.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"variable": {"type": "variable", "default": ["non"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.variable"], "names": ["variable"], "descriptions": ["A variable."], "multiple": true}}}} \ No newline at end of file diff --git a/tests/docs/base/05_0multi_uniq.md b/tests/docs/base/05_0multi_uniq.md index fecbea1..d930b34 100644 --- a/tests/docs/base/05_0multi_uniq.md +++ b/tests/docs/base/05_0multi_uniq.md @@ -13,10 +13,9 @@ variable: default: - non ``` -# Variables for "rougail" +# Variables for "Rougail" | Variable                                                                                                                       | Description                                                                                                                    | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A variable.
**Default**:
- non | - +| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A variable.
**Default**: non | diff --git a/tests/docs/base/12_1auto_save_expert.json b/tests/docs/base/12_1auto_save_expert.json new file mode 100644 index 0000000..9e26dfe --- /dev/null +++ b/tests/docs/base/12_1auto_save_expert.json @@ -0,0 +1 @@ +{} \ No newline at end of file diff --git a/tests/docs/base/16_0redefine_description.adoc b/tests/docs/base/16_0redefine_description.adoc index 1290f2f..1fd13e4 100644 --- a/tests/docs/base/16_0redefine_description.adoc +++ b/tests/docs/base/16_0redefine_description.adoc @@ -17,15 +17,15 @@ var: description: Redefined redefine: true ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -Redefined. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +Redefined. |==== - diff --git a/tests/docs/base/16_0redefine_description.json b/tests/docs/base/16_0redefine_description.json new file mode 100644 index 0000000..82096cd --- /dev/null +++ b/tests/docs/base/16_0redefine_description.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"var": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.var"], "names": ["var"], "descriptions": ["Redefined."]}}}} \ No newline at end of file diff --git a/tests/docs/base/16_0redefine_description.md b/tests/docs/base/16_0redefine_description.md index ebb1b69..d9457ae 100644 --- a/tests/docs/base/16_0redefine_description.md +++ b/tests/docs/base/16_0redefine_description.md @@ -19,10 +19,9 @@ var: description: Redefined redefine: true ``` -# Variables for "rougail" +# Variables for "Rougail" | Variable                                                                                                | Description                                                                                             | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | Redefined. | - diff --git a/tests/docs/base/16_2family_redefine_calculation.adoc b/tests/docs/base/16_2family_redefine_calculation.adoc index c413e97..55156d4 100644 --- a/tests/docs/base/16_2family_redefine_calculation.adoc +++ b/tests/docs/base/16_2family_redefine_calculation.adoc @@ -19,21 +19,22 @@ version: '1.0' family: var1: ---- -== Variables for "rougail" +== Variables for "Rougail" === rougail.family -`basic` `_disabled_` +`basic` `__disabled__` + **Disabled**: depends on a calculation. [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.family.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -Var1. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +Var1. |==== - diff --git a/tests/docs/base/16_2family_redefine_calculation.json b/tests/docs/base/16_2family_redefine_calculation.json new file mode 100644 index 0000000..7c5ef25 --- /dev/null +++ b/tests/docs/base/16_2family_redefine_calculation.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"family": {"type": "family", "informations": {"paths": ["rougail.family"], "names": ["family"], "properties": [{"type": "mode", "name": "basic"}, {"type": "property", "name": "disabled", "annotation": "depends on a calculation."}]}, "children": {"var1": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.family.var1"], "names": ["var1"]}}}}}} \ No newline at end of file diff --git a/tests/docs/base/16_2family_redefine_calculation.md b/tests/docs/base/16_2family_redefine_calculation.md index febf473..e37c8b5 100644 --- a/tests/docs/base/16_2family_redefine_calculation.md +++ b/tests/docs/base/16_2family_redefine_calculation.md @@ -21,7 +21,7 @@ version: '1.0' family: var1: ``` -# Variables for "rougail" +# Variables for "Rougail" ## rougail.family @@ -33,4 +33,3 @@ family: |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.family.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | Var1. | - diff --git a/tests/docs/base/16_2family_redefine_disabled.json b/tests/docs/base/16_2family_redefine_disabled.json new file mode 100644 index 0000000..9e26dfe --- /dev/null +++ b/tests/docs/base/16_2family_redefine_disabled.json @@ -0,0 +1 @@ +{} \ No newline at end of file diff --git a/tests/docs/base/16_5exists_nonexists.adoc b/tests/docs/base/16_5exists_nonexists.adoc index 56d0ea3..b806a2e 100644 --- a/tests/docs/base/16_5exists_nonexists.adoc +++ b/tests/docs/base/16_5exists_nonexists.adoc @@ -17,21 +17,22 @@ var2: version: '1.1' var1: no # a variable ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A variable. + -**Default**: no +**Default**: no | + **rougail.var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A new variable. + -**Default**: yes +**Default**: yes |==== - diff --git a/tests/docs/base/16_5exists_nonexists.json b/tests/docs/base/16_5exists_nonexists.json new file mode 100644 index 0000000..ab213c7 --- /dev/null +++ b/tests/docs/base/16_5exists_nonexists.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"var1": {"type": "variable", "default": "no", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.var1"], "names": ["var1"], "descriptions": ["A variable."]}, "var2": {"type": "variable", "default": "yes", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.var2"], "names": ["var2"], "descriptions": ["A new variable."]}}}} \ No newline at end of file diff --git a/tests/docs/base/16_5exists_nonexists.md b/tests/docs/base/16_5exists_nonexists.md index 64987e5..8758a82 100644 --- a/tests/docs/base/16_5exists_nonexists.md +++ b/tests/docs/base/16_5exists_nonexists.md @@ -19,11 +19,10 @@ var2: version: '1.1' var1: no # a variable ``` -# Variables for "rougail" +# Variables for "Rougail" | Variable                                                                                                   | Description                                                                                                | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: no | | **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A new variable.
**Default**: yes | - diff --git a/tests/docs/base/16_5exists_redefine.json b/tests/docs/base/16_5exists_redefine.json new file mode 100644 index 0000000..9e26dfe --- /dev/null +++ b/tests/docs/base/16_5exists_redefine.json @@ -0,0 +1 @@ +{} \ No newline at end of file diff --git a/tests/docs/base/16_5redefine_calculation.adoc b/tests/docs/base/16_5redefine_calculation.adoc index 9d2de81..d913fe1 100644 --- a/tests/docs/base/16_5redefine_calculation.adoc +++ b/tests/docs/base/16_5redefine_calculation.adoc @@ -22,16 +22,16 @@ variable: jinja: no description: returns no ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A variable. + -**Default**: returns yes. +**Default**: returns yes. |==== - diff --git a/tests/docs/base/16_5redefine_calculation.json b/tests/docs/base/16_5redefine_calculation.json new file mode 100644 index 0000000..65a1a5a --- /dev/null +++ b/tests/docs/base/16_5redefine_calculation.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"variable": {"type": "variable", "default": "returns yes.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.variable"], "names": ["variable"], "descriptions": ["A variable."]}}}} \ No newline at end of file diff --git a/tests/docs/base/16_5redefine_calculation.md b/tests/docs/base/16_5redefine_calculation.md index c4323cf..c6e8a3c 100644 --- a/tests/docs/base/16_5redefine_calculation.md +++ b/tests/docs/base/16_5redefine_calculation.md @@ -24,10 +24,9 @@ variable: jinja: no description: returns no ``` -# Variables for "rougail" +# Variables for "Rougail" | Variable                                                                                                   | Description                                                                                                | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: returns yes. | - diff --git a/tests/docs/base/16_5redefine_choice.adoc b/tests/docs/base/16_5redefine_choice.adoc index 79e4864..f4aec74 100644 --- a/tests/docs/base/16_5redefine_choice.adoc +++ b/tests/docs/base/16_5redefine_choice.adoc @@ -23,19 +23,19 @@ variable: - a - b ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `basic` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `basic` `mandatory` | A variable. + **Choices**: * a -* b +* b |==== - diff --git a/tests/docs/base/16_5redefine_choice.json b/tests/docs/base/16_5redefine_choice.json new file mode 100644 index 0000000..45f46fa --- /dev/null +++ b/tests/docs/base/16_5redefine_choice.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"variable": {"type": "variable", "properties": [{"type": "type", "name": "choice"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "choices": ["a", "b"], "paths": ["rougail.variable"], "names": ["variable"], "descriptions": ["A variable."]}}}} \ No newline at end of file diff --git a/tests/docs/base/16_5redefine_choice.md b/tests/docs/base/16_5redefine_choice.md index bc071d3..f6eb1d3 100644 --- a/tests/docs/base/16_5redefine_choice.md +++ b/tests/docs/base/16_5redefine_choice.md @@ -25,10 +25,9 @@ variable: - a - b ``` -# Variables for "rougail" +# Variables for "Rougail" | Variable                                                                                                | Description                                                                                             | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.variable**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable.
**Choices**:
- a
- b | - diff --git a/tests/docs/base/16_5redefine_default.adoc b/tests/docs/base/16_5redefine_default.adoc index ab7296a..72433b7 100644 --- a/tests/docs/base/16_5redefine_default.adoc +++ b/tests/docs/base/16_5redefine_default.adoc @@ -18,16 +18,16 @@ variable: redefine: true default: yes ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A variable. + -**Default**: yes +**Default**: yes |==== - diff --git a/tests/docs/base/16_5redefine_default.json b/tests/docs/base/16_5redefine_default.json new file mode 100644 index 0000000..1269277 --- /dev/null +++ b/tests/docs/base/16_5redefine_default.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"variable": {"type": "variable", "default": "yes", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.variable"], "names": ["variable"], "descriptions": ["A variable."]}}}} \ No newline at end of file diff --git a/tests/docs/base/16_5redefine_default.md b/tests/docs/base/16_5redefine_default.md index 768d6eb..e33ec23 100644 --- a/tests/docs/base/16_5redefine_default.md +++ b/tests/docs/base/16_5redefine_default.md @@ -20,10 +20,9 @@ variable: redefine: true default: yes ``` -# Variables for "rougail" +# Variables for "Rougail" | Variable                                                                                                   | Description                                                                                                | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: yes | - diff --git a/tests/docs/base/16_5redefine_default_calculation.adoc b/tests/docs/base/16_5redefine_default_calculation.adoc index beeff35..1614927 100644 --- a/tests/docs/base/16_5redefine_default_calculation.adoc +++ b/tests/docs/base/16_5redefine_default_calculation.adoc @@ -19,15 +19,15 @@ variable: default: jinja: yes ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A variable. |==== - diff --git a/tests/docs/base/16_5redefine_default_calculation.json b/tests/docs/base/16_5redefine_default_calculation.json new file mode 100644 index 0000000..c32e603 --- /dev/null +++ b/tests/docs/base/16_5redefine_default_calculation.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"variable": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.variable"], "names": ["variable"], "descriptions": ["A variable."]}}}} \ No newline at end of file diff --git a/tests/docs/base/16_5redefine_default_calculation.md b/tests/docs/base/16_5redefine_default_calculation.md index 9e2a70e..741b5af 100644 --- a/tests/docs/base/16_5redefine_default_calculation.md +++ b/tests/docs/base/16_5redefine_default_calculation.md @@ -21,10 +21,9 @@ variable: default: jinja: yes ``` -# Variables for "rougail" +# Variables for "Rougail" | Variable                                                                                                | Description                                                                                             | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | - diff --git a/tests/docs/base/16_5redefine_family.adoc b/tests/docs/base/16_5redefine_family.adoc index 18ba3d7..ea11686 100644 --- a/tests/docs/base/16_5redefine_family.adoc +++ b/tests/docs/base/16_5redefine_family.adoc @@ -17,7 +17,7 @@ version: '1.1' family: # a family variable: # a variable ---- -== Variables for "rougail" +== Variables for "Rougail" === new description @@ -25,11 +25,11 @@ family: # a family [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.family.variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A variable. |==== - diff --git a/tests/docs/base/16_5redefine_family.json b/tests/docs/base/16_5redefine_family.json new file mode 100644 index 0000000..6065e6a --- /dev/null +++ b/tests/docs/base/16_5redefine_family.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"family": {"type": "family", "informations": {"paths": ["rougail.family"], "names": ["family"], "description": "new description", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"variable": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.family.variable"], "names": ["variable"], "descriptions": ["A variable."]}}}}}} \ No newline at end of file diff --git a/tests/docs/base/16_5redefine_family.md b/tests/docs/base/16_5redefine_family.md index 544afb8..9f48308 100644 --- a/tests/docs/base/16_5redefine_family.md +++ b/tests/docs/base/16_5redefine_family.md @@ -19,7 +19,7 @@ version: '1.1' family: # a family variable: # a variable ``` -# Variables for "rougail" +# Variables for "Rougail" ## new description @@ -29,4 +29,3 @@ family: # a family |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.family.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | - diff --git a/tests/docs/base/16_5redefine_help.adoc b/tests/docs/base/16_5redefine_help.adoc index eedb5f4..87b1f2a 100644 --- a/tests/docs/base/16_5redefine_help.adoc +++ b/tests/docs/base/16_5redefine_help.adoc @@ -24,23 +24,22 @@ family: description: redefine help help: redefine help ---- -== Variables for "rougail" +== Variables for "Rougail" === a family `basic` - Redefine help family ok. [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.family.variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | Redefine help. + -Redefine help ok. +Redefine help ok. |==== - diff --git a/tests/docs/base/16_5redefine_help.json b/tests/docs/base/16_5redefine_help.json new file mode 100644 index 0000000..8029a8c --- /dev/null +++ b/tests/docs/base/16_5redefine_help.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"family": {"type": "family", "informations": {"paths": ["rougail.family"], "names": ["family"], "description": "a family", "help": ["Redefine help family ok."], "properties": [{"type": "mode", "name": "basic"}]}, "children": {"variable": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.family.variable"], "names": ["variable"], "help": ["Redefine help ok."], "descriptions": ["Redefine help."]}}}}}} \ No newline at end of file diff --git a/tests/docs/base/16_5redefine_help.md b/tests/docs/base/16_5redefine_help.md index 822e78f..b6294ff 100644 --- a/tests/docs/base/16_5redefine_help.md +++ b/tests/docs/base/16_5redefine_help.md @@ -26,17 +26,15 @@ family: description: redefine help help: redefine help ``` -# Variables for "rougail" +# Variables for "Rougail" ## a family `basic` - Redefine help family ok. | Variable                                                                                                | Description                                                                                             | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.family.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | Redefine help.
Redefine help ok. | - diff --git a/tests/docs/base/16_5redefine_hidden.json b/tests/docs/base/16_5redefine_hidden.json new file mode 100644 index 0000000..9e26dfe --- /dev/null +++ b/tests/docs/base/16_5redefine_hidden.json @@ -0,0 +1 @@ +{} \ No newline at end of file diff --git a/tests/docs/base/16_5redefine_multi.adoc b/tests/docs/base/16_5redefine_multi.adoc index b95375f..025301b 100644 --- a/tests/docs/base/16_5redefine_multi.adoc +++ b/tests/docs/base/16_5redefine_multi.adoc @@ -20,18 +20,16 @@ variable: default: - non ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | -**rougail.variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | -A variable. + -**Default**: -* non +**rougail.variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +A variable. + +**Default**: non |==== - diff --git a/tests/docs/base/16_5redefine_multi.json b/tests/docs/base/16_5redefine_multi.json new file mode 100644 index 0000000..2633a35 --- /dev/null +++ b/tests/docs/base/16_5redefine_multi.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"variable": {"type": "variable", "default": ["non"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.variable"], "names": ["variable"], "descriptions": ["A variable."], "multiple": true}}}} \ No newline at end of file diff --git a/tests/docs/base/16_5redefine_multi.md b/tests/docs/base/16_5redefine_multi.md index 793c2cf..6970055 100644 --- a/tests/docs/base/16_5redefine_multi.md +++ b/tests/docs/base/16_5redefine_multi.md @@ -22,10 +22,9 @@ variable: default: - non ``` -# Variables for "rougail" +# Variables for "Rougail" | Variable                                                                                                                       | Description                                                                                                                    | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A variable.
**Default**:
- non | - +| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A variable.
**Default**: non | diff --git a/tests/docs/base/16_5redefine_remove_disable_calculation.adoc b/tests/docs/base/16_5redefine_remove_disable_calculation.adoc index 6fbecdb..05656df 100644 --- a/tests/docs/base/16_5redefine_remove_disable_calculation.adoc +++ b/tests/docs/base/16_5redefine_remove_disable_calculation.adoc @@ -25,20 +25,21 @@ variable: false {% endif %} ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.condition** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A condition. + -**Default**: no +**Default**: no | + **rougail.variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A variable. |==== - diff --git a/tests/docs/base/16_5redefine_remove_disable_calculation.json b/tests/docs/base/16_5redefine_remove_disable_calculation.json new file mode 100644 index 0000000..799ba00 --- /dev/null +++ b/tests/docs/base/16_5redefine_remove_disable_calculation.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"condition": {"type": "variable", "default": "no", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.condition"], "names": ["condition"], "descriptions": ["A condition."]}, "variable": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.variable"], "names": ["variable"], "descriptions": ["A variable."]}}}} \ No newline at end of file diff --git a/tests/docs/base/16_5redefine_remove_disable_calculation.md b/tests/docs/base/16_5redefine_remove_disable_calculation.md index 817ff1a..8c582f6 100644 --- a/tests/docs/base/16_5redefine_remove_disable_calculation.md +++ b/tests/docs/base/16_5redefine_remove_disable_calculation.md @@ -27,11 +27,10 @@ variable: false {% endif %} ``` -# Variables for "rougail" - -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.
**Default**: no | -| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | +# Variables for "Rougail" +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.
**Default**: no | +| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | diff --git a/tests/docs/base/16_5test_redefine.adoc b/tests/docs/base/16_5test_redefine.adoc index 066f8ff..c6398d7 100644 --- a/tests/docs/base/16_5test_redefine.adoc +++ b/tests/docs/base/16_5test_redefine.adoc @@ -33,27 +33,29 @@ var3: redefine: true test: ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A first variable. + **Default**: no + -**Example**: test1 +**Example**: test1 | + **rougail.var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A second variable. + **Default**: non + -**Example**: test1 +**Example**: test1 | + **rougail.var3** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A third variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A third variable. |==== - diff --git a/tests/docs/base/16_5test_redefine.json b/tests/docs/base/16_5test_redefine.json new file mode 100644 index 0000000..dde80ca --- /dev/null +++ b/tests/docs/base/16_5test_redefine.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"var1": {"type": "variable", "default": "no", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.var1"], "names": ["var1"], "descriptions": ["A first variable."], "examples": ["test1"]}, "var2": {"type": "variable", "default": "non", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.var2"], "names": ["var2"], "descriptions": ["A second variable."], "examples": ["test1"]}, "var3": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.var3"], "names": ["var3"], "descriptions": ["A third variable."]}}}} \ No newline at end of file diff --git a/tests/docs/base/16_5test_redefine.md b/tests/docs/base/16_5test_redefine.md index b75ca9d..38a137b 100644 --- a/tests/docs/base/16_5test_redefine.md +++ b/tests/docs/base/16_5test_redefine.md @@ -35,12 +35,11 @@ var3: redefine: true test: ``` -# Variables for "rougail" - -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A first variable.
**Default**: no
**Example**: test1 | -| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second variable.
**Default**: non
**Example**: test1 | -| **rougail.var3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A third variable. | +# Variables for "Rougail" +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A first variable.
**Default**: no
**Example**: test1 | +| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second variable.
**Default**: non
**Example**: test1 | +| **rougail.var3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A third variable. | diff --git a/tests/docs/base/16_6choice_redefine.adoc b/tests/docs/base/16_6choice_redefine.adoc index dd125f6..97cfb6c 100644 --- a/tests/docs/base/16_6choice_redefine.adoc +++ b/tests/docs/base/16_6choice_redefine.adoc @@ -25,19 +25,19 @@ var: - b - c ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` `mandatory` | A choice. + **Choices**: * a -* c ← (default) +* c ← (default) |==== - diff --git a/tests/docs/base/16_6choice_redefine.json b/tests/docs/base/16_6choice_redefine.json new file mode 100644 index 0000000..c1b1f36 --- /dev/null +++ b/tests/docs/base/16_6choice_redefine.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"var": {"type": "variable", "default": "c", "properties": [{"type": "type", "name": "choice"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "display_default": false, "choices": ["a", "c ← (default)"], "paths": ["rougail.var"], "names": ["var"], "descriptions": ["A choice."]}}}} \ No newline at end of file diff --git a/tests/docs/base/16_6choice_redefine.md b/tests/docs/base/16_6choice_redefine.md index ff99bea..964d2eb 100644 --- a/tests/docs/base/16_6choice_redefine.md +++ b/tests/docs/base/16_6choice_redefine.md @@ -27,10 +27,9 @@ var: - b - c ``` -# Variables for "rougail" +# Variables for "Rougail" | Variable                                                                                                   | Description                                                                                                | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.var**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A choice.
**Choices**:
- a
- c ← (default) | - diff --git a/tests/docs/base/16exists_exists.adoc b/tests/docs/base/16exists_exists.adoc index 7810ff0..a3f69f1 100644 --- a/tests/docs/base/16exists_exists.adoc +++ b/tests/docs/base/16exists_exists.adoc @@ -17,15 +17,15 @@ version: '1.1' var: description: Description ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -Description. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +Description. |==== - diff --git a/tests/docs/base/16exists_exists.json b/tests/docs/base/16exists_exists.json new file mode 100644 index 0000000..f0d6eea --- /dev/null +++ b/tests/docs/base/16exists_exists.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"var": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.var"], "names": ["var"], "descriptions": ["Description."]}}}} \ No newline at end of file diff --git a/tests/docs/base/16exists_exists.md b/tests/docs/base/16exists_exists.md index b3e0520..c33be25 100644 --- a/tests/docs/base/16exists_exists.md +++ b/tests/docs/base/16exists_exists.md @@ -19,10 +19,9 @@ version: '1.1' var: description: Description ``` -# Variables for "rougail" +# Variables for "Rougail" | Variable                                                                                                | Description                                                                                             | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | Description. | - diff --git a/tests/docs/base/17_5redefine_leadership.json b/tests/docs/base/17_5redefine_leadership.json new file mode 100644 index 0000000..9e26dfe --- /dev/null +++ b/tests/docs/base/17_5redefine_leadership.json @@ -0,0 +1 @@ +{} \ No newline at end of file diff --git a/tests/docs/base/20_0empty_family.json b/tests/docs/base/20_0empty_family.json new file mode 100644 index 0000000..9e26dfe --- /dev/null +++ b/tests/docs/base/20_0empty_family.json @@ -0,0 +1 @@ +{} \ No newline at end of file diff --git a/tests/docs/base/20_0family_append.adoc b/tests/docs/base/20_0family_append.adoc index f2aa74a..30ba86e 100644 --- a/tests/docs/base/20_0family_append.adoc +++ b/tests/docs/base/20_0family_append.adoc @@ -19,7 +19,7 @@ family: var1: description: The first variable ---- -== Variables for "rougail" +== Variables for "Rougail" === A family @@ -27,15 +27,16 @@ family: [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.family.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -The first variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +The first variable. | + **rougail.family.var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -The second variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +The second variable. |==== - diff --git a/tests/docs/base/20_0family_append.json b/tests/docs/base/20_0family_append.json new file mode 100644 index 0000000..e71ece4 --- /dev/null +++ b/tests/docs/base/20_0family_append.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"family": {"type": "family", "informations": {"paths": ["rougail.family"], "names": ["family"], "description": "A family", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"var1": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.family.var1"], "names": ["var1"], "descriptions": ["The first variable."]}, "var2": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.family.var2"], "names": ["var2"], "descriptions": ["The second variable."]}}}}}} \ No newline at end of file diff --git a/tests/docs/base/20_0family_append.md b/tests/docs/base/20_0family_append.md index 437394c..2d0e583 100644 --- a/tests/docs/base/20_0family_append.md +++ b/tests/docs/base/20_0family_append.md @@ -21,7 +21,7 @@ family: var1: description: The first variable ``` -# Variables for "rougail" +# Variables for "Rougail" ## A family @@ -32,4 +32,3 @@ family: | **rougail.family.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The first variable. | | **rougail.family.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The second variable. | - diff --git a/tests/docs/base/20_0family_underscore.json b/tests/docs/base/20_0family_underscore.json new file mode 100644 index 0000000..9e26dfe --- /dev/null +++ b/tests/docs/base/20_0family_underscore.json @@ -0,0 +1 @@ +{} \ No newline at end of file diff --git a/tests/docs/base/20_0multi_family.adoc b/tests/docs/base/20_0multi_family.adoc index bc1af3e..0765f7d 100644 --- a/tests/docs/base/20_0multi_family.adoc +++ b/tests/docs/base/20_0multi_family.adoc @@ -10,7 +10,7 @@ family: # a family description: a variable mandatory: false ---- -== Variables for "rougail" +== Variables for "Rougail" === a family @@ -22,11 +22,11 @@ family: # a family [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.family.subfamily.variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | -A variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | +A variable. |==== - diff --git a/tests/docs/base/20_0multi_family.json b/tests/docs/base/20_0multi_family.json new file mode 100644 index 0000000..b7570dd --- /dev/null +++ b/tests/docs/base/20_0multi_family.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"family": {"type": "family", "informations": {"paths": ["rougail.family"], "names": ["family"], "description": "a family", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"subfamily": {"type": "family", "informations": {"paths": ["rougail.family.subfamily"], "names": ["subfamily"], "description": "a sub family", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"variable": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}], "paths": ["rougail.family.subfamily.variable"], "names": ["variable"], "descriptions": ["A variable."]}}}}}}}} \ No newline at end of file diff --git a/tests/docs/base/20_0multi_family.md b/tests/docs/base/20_0multi_family.md index d7e80fe..ee63139 100644 --- a/tests/docs/base/20_0multi_family.md +++ b/tests/docs/base/20_0multi_family.md @@ -13,7 +13,7 @@ family: # a family description: a variable mandatory: false ``` -# Variables for "rougail" +# Variables for "Rougail" ## a family @@ -27,4 +27,3 @@ family: # a family |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.family.subfamily.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A variable. | - diff --git a/tests/docs/base/20_0multi_family_basic.adoc b/tests/docs/base/20_0multi_family_basic.adoc index 83693d2..4cd74a5 100644 --- a/tests/docs/base/20_0multi_family_basic.adoc +++ b/tests/docs/base/20_0multi_family_basic.adoc @@ -8,7 +8,7 @@ family: # a family subfamily: # a sub family variable: # a variable ---- -== Variables for "rougail" +== Variables for "Rougail" === a family @@ -20,11 +20,11 @@ family: # a family [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.family.subfamily.variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A variable. |==== - diff --git a/tests/docs/base/20_0multi_family_basic.json b/tests/docs/base/20_0multi_family_basic.json new file mode 100644 index 0000000..d712948 --- /dev/null +++ b/tests/docs/base/20_0multi_family_basic.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"family": {"type": "family", "informations": {"paths": ["rougail.family"], "names": ["family"], "description": "a family", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"subfamily": {"type": "family", "informations": {"paths": ["rougail.family.subfamily"], "names": ["subfamily"], "description": "a sub family", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"variable": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.family.subfamily.variable"], "names": ["variable"], "descriptions": ["A variable."]}}}}}}}} \ No newline at end of file diff --git a/tests/docs/base/20_0multi_family_basic.md b/tests/docs/base/20_0multi_family_basic.md index 5bdc654..1cfed45 100644 --- a/tests/docs/base/20_0multi_family_basic.md +++ b/tests/docs/base/20_0multi_family_basic.md @@ -11,7 +11,7 @@ family: # a family subfamily: # a sub family variable: # a variable ``` -# Variables for "rougail" +# Variables for "Rougail" ## a family @@ -25,4 +25,3 @@ family: # a family |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.family.subfamily.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | - diff --git a/tests/docs/base/20_0multi_family_expert.json b/tests/docs/base/20_0multi_family_expert.json new file mode 100644 index 0000000..9e26dfe --- /dev/null +++ b/tests/docs/base/20_0multi_family_expert.json @@ -0,0 +1 @@ +{} \ No newline at end of file diff --git a/tests/docs/base/20_0multi_family_order.adoc b/tests/docs/base/20_0multi_family_order.adoc index 0520952..ff7e644 100644 --- a/tests/docs/base/20_0multi_family_order.adoc +++ b/tests/docs/base/20_0multi_family_order.adoc @@ -11,15 +11,16 @@ family: # a family variable: # a variable variable2: # a second variable ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A variable. |==== === a family @@ -28,11 +29,12 @@ A variable. [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.family.variable1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A first variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A first variable. |==== ==== a sub family @@ -41,20 +43,21 @@ A first variable. [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.family.subfamily.variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A variable. |==== [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.family.variable2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A second variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A second variable. |==== - diff --git a/tests/docs/base/20_0multi_family_order.json b/tests/docs/base/20_0multi_family_order.json new file mode 100644 index 0000000..0689751 --- /dev/null +++ b/tests/docs/base/20_0multi_family_order.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"variable": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.variable"], "names": ["variable"], "descriptions": ["A variable."]}, "family": {"type": "family", "informations": {"paths": ["rougail.family"], "names": ["family"], "description": "a family", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"variable1": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.family.variable1"], "names": ["variable1"], "descriptions": ["A first variable."]}, "subfamily": {"type": "family", "informations": {"paths": ["rougail.family.subfamily"], "names": ["subfamily"], "description": "a sub family", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"variable": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.family.subfamily.variable"], "names": ["variable"], "descriptions": ["A variable."]}}}, "variable2": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.family.variable2"], "names": ["variable2"], "descriptions": ["A second variable."]}}}}}} \ No newline at end of file diff --git a/tests/docs/base/20_0multi_family_order.md b/tests/docs/base/20_0multi_family_order.md index 09a563c..5da10d9 100644 --- a/tests/docs/base/20_0multi_family_order.md +++ b/tests/docs/base/20_0multi_family_order.md @@ -14,7 +14,7 @@ family: # a family variable: # a variable variable2: # a second variable ``` -# Variables for "rougail" +# Variables for "Rougail" | Variable                                                                                                | Description                                                                                             | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| @@ -40,4 +40,3 @@ family: # a family |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.family.variable2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A second variable. | - diff --git a/tests/docs/base/20_0validators_differ_redefine.adoc b/tests/docs/base/20_0validators_differ_redefine.adoc index 81023b0..16a7f7a 100644 --- a/tests/docs/base/20_0validators_differ_redefine.adoc +++ b/tests/docs/base/20_0validators_differ_redefine.adoc @@ -33,28 +33,30 @@ var3: {% endif %} description: var3 must be different than var1 ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A first variable. + -**Default**: no +**Default**: no | + **rougail.var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A second variable. + -**Default**: no +**Default**: no | + **rougail.var3** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A third variable. + **Validator**: var3 must be different than var2. + **Default**: yes + -**Example**: yes +**Example**: yes |==== - diff --git a/tests/docs/base/20_0validators_differ_redefine.json b/tests/docs/base/20_0validators_differ_redefine.json new file mode 100644 index 0000000..b00b3ea --- /dev/null +++ b/tests/docs/base/20_0validators_differ_redefine.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"var1": {"type": "variable", "default": "no", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.var1"], "names": ["var1"], "descriptions": ["A first variable."]}, "var2": {"type": "variable", "default": "no", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.var2"], "names": ["var2"], "descriptions": ["A second variable."]}, "var3": {"type": "variable", "default": "yes", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "validators": ["var3 must be different than var2."], "paths": ["rougail.var3"], "names": ["var3"], "descriptions": ["A third variable."], "examples": ["yes"]}}}} \ No newline at end of file diff --git a/tests/docs/base/20_0validators_differ_redefine.md b/tests/docs/base/20_0validators_differ_redefine.md index d160cb9..fc0784b 100644 --- a/tests/docs/base/20_0validators_differ_redefine.md +++ b/tests/docs/base/20_0validators_differ_redefine.md @@ -35,7 +35,7 @@ var3: {% endif %} description: var3 must be different than var1 ``` -# Variables for "rougail" +# Variables for "Rougail" | Variable                                                                                                   | Description                                                                                                | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| @@ -43,4 +43,3 @@ var3: | **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second variable.
**Default**: no | | **rougail.var3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A third variable.
**Validator**: var3 must be different than var2.
**Default**: yes
**Example**: yes | - diff --git a/tests/docs/base/20_1empty_subfamily.json b/tests/docs/base/20_1empty_subfamily.json new file mode 100644 index 0000000..9e26dfe --- /dev/null +++ b/tests/docs/base/20_1empty_subfamily.json @@ -0,0 +1 @@ +{} \ No newline at end of file diff --git a/tests/docs/base/20_9default_information_parent.adoc b/tests/docs/base/20_9default_information_parent.adoc index 0e388a5..62c1238 100644 --- a/tests/docs/base/20_9default_information_parent.adoc +++ b/tests/docs/base/20_9default_information_parent.adoc @@ -13,7 +13,7 @@ family: information: test_information variable: __.family ---- -== Variables for "rougail" +== Variables for "Rougail" === rougail.family @@ -21,16 +21,17 @@ family: [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.family.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A first variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A first variable. | + **rougail.family.var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A second variable. + -**Default**: the value of the information "test_information" of the variable "rougail.family". +**Default**: the value of the information "test_information" of the variable "rougail.family". |==== - diff --git a/tests/docs/base/20_9default_information_parent.json b/tests/docs/base/20_9default_information_parent.json new file mode 100644 index 0000000..ff3110b --- /dev/null +++ b/tests/docs/base/20_9default_information_parent.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"family": {"type": "family", "informations": {"paths": ["rougail.family"], "names": ["family"], "properties": [{"type": "mode", "name": "basic"}]}, "children": {"var1": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.family.var1"], "names": ["var1"], "descriptions": ["A first variable."]}, "var2": {"type": "variable", "default": "the value of the information \"test_information\" of the variable \"rougail.family\".", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.family.var2"], "names": ["var2"], "descriptions": ["A second variable."]}}}}}} \ No newline at end of file diff --git a/tests/docs/base/20_9default_information_parent.md b/tests/docs/base/20_9default_information_parent.md index 5ff4bd5..011e580 100644 --- a/tests/docs/base/20_9default_information_parent.md +++ b/tests/docs/base/20_9default_information_parent.md @@ -16,7 +16,7 @@ family: information: test_information variable: __.family ``` -# Variables for "rougail" +# Variables for "Rougail" ## rougail.family @@ -27,4 +27,3 @@ family: | **rougail.family.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A first variable. | | **rougail.family.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second variable.
**Default**: the value of the information "test_information" of the variable "rougail.family". | - diff --git a/tests/docs/base/24_0family_hidden_condition.adoc b/tests/docs/base/24_0family_hidden_condition.adoc index 3d7a852..a325850 100644 --- a/tests/docs/base/24_0family_hidden_condition.adoc +++ b/tests/docs/base/24_0family_hidden_condition.adoc @@ -15,31 +15,33 @@ family: description: if condition is yes var1: # a variable ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.condition** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | The variable use has condition. + -**Default**: no +**Default**: no |==== === possibly hidden family -`basic` `_hidden_` +`basic` `__hidden__` + **Hidden**: if condition is yes. [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.family.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A variable. |==== - diff --git a/tests/docs/base/24_0family_hidden_condition.json b/tests/docs/base/24_0family_hidden_condition.json new file mode 100644 index 0000000..e13169b --- /dev/null +++ b/tests/docs/base/24_0family_hidden_condition.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"condition": {"type": "variable", "default": "no", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.condition"], "names": ["condition"], "descriptions": ["The variable use has condition."]}, "family": {"type": "family", "informations": {"paths": ["rougail.family"], "names": ["family"], "description": "possibly hidden family", "properties": [{"type": "mode", "name": "basic"}, {"type": "property", "name": "hidden", "annotation": "if condition is yes."}]}, "children": {"var1": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.family.var1"], "names": ["var1"], "descriptions": ["A variable."]}}}}}} \ No newline at end of file diff --git a/tests/docs/base/24_0family_hidden_condition.md b/tests/docs/base/24_0family_hidden_condition.md index e724b29..cf670e8 100644 --- a/tests/docs/base/24_0family_hidden_condition.md +++ b/tests/docs/base/24_0family_hidden_condition.md @@ -18,11 +18,11 @@ family: description: if condition is yes var1: # a variable ``` -# Variables for "rougail" +# Variables for "Rougail" -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The variable use has condition.
**Default**: no | +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The variable use has condition.
**Default**: no | ## possibly hidden family @@ -30,8 +30,7 @@ family: **Hidden**: if condition is yes. -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.family.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | - +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.family.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | diff --git a/tests/docs/base/24_0family_hidden_condition_boolean.adoc b/tests/docs/base/24_0family_hidden_condition_boolean.adoc index 8166d5c..25fc085 100644 --- a/tests/docs/base/24_0family_hidden_condition_boolean.adoc +++ b/tests/docs/base/24_0family_hidden_condition_boolean.adoc @@ -17,31 +17,33 @@ family: description: a variable mandatory: false ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.condition** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | A conditional variable. + -**Default**: False +**Default**: false |==== === a family -`standard` `_hidden_` +`standard` `__hidden__` + **Hidden**: if not condition. [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.family.variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | -A variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | +A variable. |==== - diff --git a/tests/docs/base/24_0family_hidden_condition_boolean.json b/tests/docs/base/24_0family_hidden_condition_boolean.json new file mode 100644 index 0000000..5b1f105 --- /dev/null +++ b/tests/docs/base/24_0family_hidden_condition_boolean.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"condition": {"type": "variable", "default": false, "properties": [{"type": "type", "name": "boolean"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.condition"], "names": ["condition"], "descriptions": ["A conditional variable."]}, "family": {"type": "family", "informations": {"paths": ["rougail.family"], "names": ["family"], "description": "a family", "properties": [{"type": "mode", "name": "standard"}, {"type": "property", "name": "hidden", "annotation": "if not condition."}]}, "children": {"variable": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}], "paths": ["rougail.family.variable"], "names": ["variable"], "descriptions": ["A variable."]}}}}}} \ No newline at end of file diff --git a/tests/docs/base/24_0family_hidden_condition_boolean.md b/tests/docs/base/24_0family_hidden_condition_boolean.md index b0975d9..8778f8d 100644 --- a/tests/docs/base/24_0family_hidden_condition_boolean.md +++ b/tests/docs/base/24_0family_hidden_condition_boolean.md @@ -20,11 +20,11 @@ family: description: a variable mandatory: false ``` -# Variables for "rougail" +# Variables for "Rougail" -| Variable                                                                                       | Description                                                                                    | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.condition**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A conditional variable.
**Default**: False | +| Variable                                                                                                    | Description                                                                                                 | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.condition**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A conditional variable.
**Default**: false | ## a family @@ -32,8 +32,7 @@ family: **Hidden**: if not condition. -| Variable                                                                                       | Description                                                                                    | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.family.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A variable. | - +| Variable                                                                                                    | Description                                                                                                 | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.family.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A variable. | 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 66cf57e..06d4ad0 100644 --- a/tests/docs/base/24_0family_hidden_condition_sub_family.adoc +++ b/tests/docs/base/24_0family_hidden_condition_sub_family.adoc @@ -16,21 +16,23 @@ family: subfamily: var1: # a variable ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.condition** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | The variable use has condition. + -**Default**: no +**Default**: no |==== === possibly hidden family -`basic` `_hidden_` +`basic` `__hidden__` + **Hidden**: if condition is yes. @@ -40,11 +42,11 @@ The variable use has condition. + [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.family.subfamily.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A variable. |==== - diff --git a/tests/docs/base/24_0family_hidden_condition_sub_family.json b/tests/docs/base/24_0family_hidden_condition_sub_family.json new file mode 100644 index 0000000..d00b8e9 --- /dev/null +++ b/tests/docs/base/24_0family_hidden_condition_sub_family.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"condition": {"type": "variable", "default": "no", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.condition"], "names": ["condition"], "descriptions": ["The variable use has condition."]}, "family": {"type": "family", "informations": {"paths": ["rougail.family"], "names": ["family"], "description": "possibly hidden family", "properties": [{"type": "mode", "name": "basic"}, {"type": "property", "name": "hidden", "annotation": "if condition is yes."}]}, "children": {"subfamily": {"type": "family", "informations": {"paths": ["rougail.family.subfamily"], "names": ["subfamily"], "properties": [{"type": "mode", "name": "basic"}]}, "children": {"var1": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.family.subfamily.var1"], "names": ["var1"], "descriptions": ["A variable."]}}}}}}}} \ No newline at end of file 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 0989e2b..d8b242e 100644 --- a/tests/docs/base/24_0family_hidden_condition_sub_family.md +++ b/tests/docs/base/24_0family_hidden_condition_sub_family.md @@ -19,11 +19,11 @@ family: subfamily: var1: # a variable ``` -# Variables for "rougail" +# Variables for "Rougail" -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The variable use has condition.
**Default**: no | +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The variable use has condition.
**Default**: no | ## possibly hidden family @@ -35,8 +35,7 @@ family: `basic` -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.family.subfamily.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | - +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.family.subfamily.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | 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 a472899..c1752b8 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 @@ -14,23 +14,25 @@ family: description: a variable mandatory: false ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.condition** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | The variable use has condition. + -**Default**: True +**Default**: true |==== === possibly hidden family -`standard` `_hidden_` +`standard` `__hidden__` -**Hidden**: when the variable "rougail.condition" has the value "True". + +**Hidden**: when the variable "rougail.condition" has the value "true". ==== a subfamily @@ -38,11 +40,11 @@ The variable use has condition. + [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.family.subfamily.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | -A variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | +A variable. |==== - diff --git a/tests/docs/base/24_0family_hidden_condition_variable_sub_family.json b/tests/docs/base/24_0family_hidden_condition_variable_sub_family.json new file mode 100644 index 0000000..0f85a0b --- /dev/null +++ b/tests/docs/base/24_0family_hidden_condition_variable_sub_family.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"condition": {"type": "variable", "default": true, "properties": [{"type": "type", "name": "boolean"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.condition"], "names": ["condition"], "descriptions": ["The variable use has condition."]}, "family": {"type": "family", "informations": {"paths": ["rougail.family"], "names": ["family"], "description": "possibly hidden family", "properties": [{"type": "mode", "name": "standard"}, {"type": "property", "name": "hidden", "annotation": "when the variable \"rougail.condition\" has the value \"true\"."}]}, "children": {"subfamily": {"type": "family", "informations": {"paths": ["rougail.family.subfamily"], "names": ["subfamily"], "description": "a subfamily", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"var1": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}], "paths": ["rougail.family.subfamily.var1"], "names": ["var1"], "descriptions": ["A variable."]}}}}}}}} \ No newline at end of file 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 81d25c2..9f9423b 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 @@ -17,24 +17,23 @@ family: description: a variable mandatory: false ``` -# Variables for "rougail" +# Variables for "Rougail" -| Variable                                                                                       | Description                                                                                    | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.condition**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The variable use has condition.
**Default**: True | +| Variable                                                                                                    | Description                                                                                                 | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.condition**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The variable use has condition.
**Default**: true | ## possibly hidden family `standard` *`hidden`* -**Hidden**: when the variable "rougail.condition" has the value "True". +**Hidden**: when the variable "rougail.condition" has the value "true". ### a subfamily `standard` -| Variable                                                                                       | Description                                                                                    | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.family.subfamily.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A variable. | - +| Variable                                                                                                    | Description                                                                                                 | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.family.subfamily.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A variable. | 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 9df02a6..4a5729d 100644 --- a/tests/docs/base/24_0family_hidden_condition_with_variable.adoc +++ b/tests/docs/base/24_0family_hidden_condition_with_variable.adoc @@ -24,37 +24,40 @@ family: description: if condition2 is false mandatory: false ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.condition1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | A first conditional variable. + -**Default**: False +**Default**: false | + **rougail.condition2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | A second conditional variable. + -**Default**: False +**Default**: false |==== === a family -`standard` `_hidden_` +`standard` `__hidden__` + **Hidden**: if condition1 is false. [cols="1a,1a"] |==== -| Variable | Description +| 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. +**Hidden**: if condition2 is false. |==== - diff --git a/tests/docs/base/24_0family_hidden_condition_with_variable.json b/tests/docs/base/24_0family_hidden_condition_with_variable.json new file mode 100644 index 0000000..430d9b6 --- /dev/null +++ b/tests/docs/base/24_0family_hidden_condition_with_variable.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"condition1": {"type": "variable", "default": false, "properties": [{"type": "type", "name": "boolean"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.condition1"], "names": ["condition1"], "descriptions": ["A first conditional variable."]}, "condition2": {"type": "variable", "default": false, "properties": [{"type": "type", "name": "boolean"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.condition2"], "names": ["condition2"], "descriptions": ["A second conditional variable."]}, "family": {"type": "family", "informations": {"paths": ["rougail.family"], "names": ["family"], "description": "a family", "properties": [{"type": "mode", "name": "standard"}, {"type": "property", "name": "hidden", "annotation": "if condition1 is false."}]}, "children": {"variable": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "hidden", "annotation": "if condition2 is false."}], "paths": ["rougail.family.variable"], "names": ["variable"], "descriptions": ["A variable."]}}}}}} \ No newline at end of file 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 8e199bb..d7637c4 100644 --- a/tests/docs/base/24_0family_hidden_condition_with_variable.md +++ b/tests/docs/base/24_0family_hidden_condition_with_variable.md @@ -27,12 +27,12 @@ family: description: if condition2 is false mandatory: false ``` -# Variables for "rougail" +# Variables for "Rougail" -| Variable                                                                                                  | Description                                                                                               | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.condition1**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A first conditional variable.
**Default**: False | -| **rougail.condition2**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second conditional variable.
**Default**: False | +| Variable                                                                                                    | Description                                                                                                 | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.condition1**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A first conditional variable.
**Default**: false | +| **rougail.condition2**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second conditional variable.
**Default**: false | ## a family @@ -40,8 +40,7 @@ family: **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. | - +| Variable                                                                                                    | Description                                                                                                 | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.family.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` *`hidden`* | A variable.
**Hidden**: if condition2 is false. | diff --git a/tests/docs/base/24_0family_hidden_param_condition_sub_family.adoc b/tests/docs/base/24_0family_hidden_param_condition_sub_family.adoc index fef98e2..ff7fe6a 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 @@ -19,21 +19,23 @@ family: sub_family: # a subfamily var1: # a variable ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.condition** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | The variable use has condition. + -**Default**: no +**Default**: no |==== === possibly hidden family -`basic` `_hidden_` +`basic` `__hidden__` + **Hidden**: if condition is yes. @@ -43,11 +45,11 @@ The variable use has condition. + [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.family.sub_family.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A variable. |==== - diff --git a/tests/docs/base/24_0family_hidden_param_condition_sub_family.json b/tests/docs/base/24_0family_hidden_param_condition_sub_family.json new file mode 100644 index 0000000..b331831 --- /dev/null +++ b/tests/docs/base/24_0family_hidden_param_condition_sub_family.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"condition": {"type": "variable", "default": "no", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.condition"], "names": ["condition"], "descriptions": ["The variable use has condition."]}, "family": {"type": "family", "informations": {"paths": ["rougail.family"], "names": ["family"], "description": "possibly hidden family", "properties": [{"type": "mode", "name": "basic"}, {"type": "property", "name": "hidden", "annotation": "if condition is yes."}]}, "children": {"sub_family": {"type": "family", "informations": {"paths": ["rougail.family.sub_family"], "names": ["sub_family"], "description": "a subfamily", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"var1": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.family.sub_family.var1"], "names": ["var1"], "descriptions": ["A variable."]}}}}}}}} \ No newline at end of file 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 b9f0b6b..3c28773 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 @@ -22,11 +22,11 @@ family: sub_family: # a subfamily var1: # a variable ``` -# Variables for "rougail" +# Variables for "Rougail" -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The variable use has condition.
**Default**: no | +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The variable use has condition.
**Default**: no | ## possibly hidden family @@ -38,8 +38,7 @@ family: `basic` -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.family.sub_family.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | - +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.family.sub_family.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | diff --git a/tests/docs/base/24_0family_mandatory_condition.adoc b/tests/docs/base/24_0family_mandatory_condition.adoc index 84b8d8f..08b9f38 100644 --- a/tests/docs/base/24_0family_mandatory_condition.adoc +++ b/tests/docs/base/24_0family_mandatory_condition.adoc @@ -14,21 +14,22 @@ var: {% endif %} description: only if rougail.condition has the value "yes" ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.condition** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A condition. + -**Default**: no +**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". +**Mandatory**: only if rougail.condition has the value "yes". |==== - diff --git a/tests/docs/base/24_0family_mandatory_condition.json b/tests/docs/base/24_0family_mandatory_condition.json new file mode 100644 index 0000000..d799744 --- /dev/null +++ b/tests/docs/base/24_0family_mandatory_condition.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"condition": {"type": "variable", "default": "no", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.condition"], "names": ["condition"], "descriptions": ["A condition."]}, "var": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory", "annotation": "only if rougail.condition has the value \"yes\"."}], "paths": ["rougail.var"], "names": ["var"], "descriptions": ["A variable."]}}}} \ No newline at end of file diff --git a/tests/docs/base/24_0family_mandatory_condition.md b/tests/docs/base/24_0family_mandatory_condition.md index f22ee2d..4c7b1e7 100644 --- a/tests/docs/base/24_0family_mandatory_condition.md +++ b/tests/docs/base/24_0family_mandatory_condition.md @@ -17,11 +17,10 @@ var: {% endif %} description: only if rougail.condition has the value "yes" ``` -# Variables for "rougail" +# Variables for "Rougail" | Variable                                                                                                     | Description                                                                                                  | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.
**Default**: no | | **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` *`mandatory`* | A variable.
**Mandatory**: only if rougail.condition has the value "yes". | - diff --git a/tests/docs/base/24_0family_mandatory_condition_variable.adoc b/tests/docs/base/24_0family_mandatory_condition_variable.adoc index 3bcf1bb..4ffc0bc 100644 --- a/tests/docs/base/24_0family_mandatory_condition_variable.adoc +++ b/tests/docs/base/24_0family_mandatory_condition_variable.adoc @@ -10,21 +10,22 @@ var: mandatory: variable: _.condition ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.condition** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | A condition. + -**Default**: True +**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". +**Mandatory**: when the variable "rougail.condition" has the value "true". |==== - diff --git a/tests/docs/base/24_0family_mandatory_condition_variable.json b/tests/docs/base/24_0family_mandatory_condition_variable.json new file mode 100644 index 0000000..4d69b81 --- /dev/null +++ b/tests/docs/base/24_0family_mandatory_condition_variable.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"condition": {"type": "variable", "default": true, "properties": [{"type": "type", "name": "boolean"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.condition"], "names": ["condition"], "descriptions": ["A condition."]}, "var": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory", "annotation": "when the variable \"rougail.condition\" has the value \"true\"."}], "paths": ["rougail.var"], "names": ["var"], "descriptions": ["A variable."]}}}} \ No newline at end of file diff --git a/tests/docs/base/24_0family_mandatory_condition_variable.md b/tests/docs/base/24_0family_mandatory_condition_variable.md index 94b758f..d9f1598 100644 --- a/tests/docs/base/24_0family_mandatory_condition_variable.md +++ b/tests/docs/base/24_0family_mandatory_condition_variable.md @@ -13,11 +13,10 @@ var: mandatory: variable: _.condition ``` -# Variables for "rougail" +# Variables for "Rougail" | Variable                                                                                                     | Description                                                                                                  | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.condition**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.
**Default**: True | -| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` *`mandatory`* | A variable.
**Mandatory**: when the variable "rougail.condition" has the value "True". | - +| **rougail.condition**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.
**Default**: true | +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` *`mandatory`* | A variable.
**Mandatory**: when the variable "rougail.condition" has the value "true". | diff --git a/tests/docs/base/04_7validators_variable_optional.adoc b/tests/docs/base/24_7validators_variable_optional.adoc similarity index 58% rename from tests/docs/base/04_7validators_variable_optional.adoc rename to tests/docs/base/24_7validators_variable_optional.adoc index c8e465b..f22b2cb 100644 --- a/tests/docs/base/04_7validators_variable_optional.adoc +++ b/tests/docs/base/24_7validators_variable_optional.adoc @@ -31,7 +31,7 @@ general: # a family description: int and int3 must be different int2: 1 # a second number ---- -== Variables for "rougail" +== Variables for "Rougail" === a family @@ -39,22 +39,23 @@ general: # a family [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.general.int** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `basic` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `basic` `mandatory` | A first number. + **Validators**: * int and int2 must be different. * int and int3 must be different. -**Example**: 5 +**Example**: 5 | + **rougail.general.int2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` | A second number. + -**Default**: 1 +**Default**: 1 |==== - diff --git a/tests/docs/base/24_7validators_variable_optional.json b/tests/docs/base/24_7validators_variable_optional.json new file mode 100644 index 0000000..38902f7 --- /dev/null +++ b/tests/docs/base/24_7validators_variable_optional.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"general": {"type": "family", "informations": {"paths": ["rougail.general"], "names": ["general"], "description": "a family", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"int": {"type": "variable", "properties": [{"type": "type", "name": "number"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "validators": ["int and int2 must be different.", "int and int3 must be different."], "paths": ["rougail.general.int"], "names": ["int"], "descriptions": ["A first number."], "examples": [5]}, "int2": {"type": "variable", "default": 1, "properties": [{"type": "type", "name": "number"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.general.int2"], "names": ["int2"], "descriptions": ["A second number."]}}}}}} \ No newline at end of file diff --git a/tests/docs/base/04_7validators_variable_optional.md b/tests/docs/base/24_7validators_variable_optional.md similarity index 99% rename from tests/docs/base/04_7validators_variable_optional.md rename to tests/docs/base/24_7validators_variable_optional.md index 00c88f5..799ff74 100644 --- a/tests/docs/base/04_7validators_variable_optional.md +++ b/tests/docs/base/24_7validators_variable_optional.md @@ -34,7 +34,7 @@ general: # a family description: int and int3 must be different int2: 1 # a second number ``` -# Variables for "rougail" +# Variables for "Rougail" ## a family @@ -45,4 +45,3 @@ general: # a family | **rougail.general.int**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A first number.
**Validators**:
- int and int2 must be different.
- int and int3 must be different.
**Example**: 5 | | **rougail.general.int2**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second number.
**Default**: 1 | - diff --git a/tests/docs/base/24_family_disabled_var_hidden.json b/tests/docs/base/24_family_disabled_var_hidden.json new file mode 100644 index 0000000..9e26dfe --- /dev/null +++ b/tests/docs/base/24_family_disabled_var_hidden.json @@ -0,0 +1 @@ +{} \ No newline at end of file diff --git a/tests/docs/base/40_0leadership.adoc b/tests/docs/base/40_0leadership.adoc index a1521b8..b46233f 100644 --- a/tests/docs/base/40_0leadership.adoc +++ b/tests/docs/base/40_0leadership.adoc @@ -11,30 +11,31 @@ leader: follower1: # a follower follower2: # an other follower ---- -== Variables for "rougail" +== Variables for "Rougail" === a leadership `basic` - This family contains lists of variable blocks. [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.leader.leader** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | -A leader. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | +A leader. | + **rougail.leader.follower1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A follower. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A follower. | + **rougail.leader.follower2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -An other follower. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +An other follower. |==== - diff --git a/tests/docs/base/40_0leadership.json b/tests/docs/base/40_0leadership.json new file mode 100644 index 0000000..11c627b --- /dev/null +++ b/tests/docs/base/40_0leadership.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"leader": {"type": "leadership", "informations": {"paths": ["rougail.leader"], "names": ["leader"], "description": "a leadership", "properties": [{"type": "mode", "name": "basic"}], "help": ["This family contains lists of variable blocks."]}, "children": {"leader": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.leader.leader"], "names": ["leader"], "descriptions": ["A leader."], "multiple": true}, "follower1": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.leader.follower1"], "names": ["follower1"], "descriptions": ["A follower."]}, "follower2": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.leader.follower2"], "names": ["follower2"], "descriptions": ["An other follower."]}}}}}} \ No newline at end of file diff --git a/tests/docs/base/40_0leadership.md b/tests/docs/base/40_0leadership.md index 3923a0b..fb9b865 100644 --- a/tests/docs/base/40_0leadership.md +++ b/tests/docs/base/40_0leadership.md @@ -14,19 +14,17 @@ leader: follower1: # a follower follower2: # an other follower ``` -# Variables for "rougail" +# Variables for "Rougail" ## a leadership `basic` - This family contains lists of variable blocks. -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | A leader. | -| **rougail.leader.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A follower. | -| **rougail.leader.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | An other follower. | - +| Variable                                                                                                                    | Description                                                                                                                 | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | A leader. | +| **rougail.leader.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A follower. | +| **rougail.leader.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | An other follower. | diff --git a/tests/docs/base/40_0leadership_diff_name.adoc b/tests/docs/base/40_0leadership_diff_name.adoc index 1d86420..fac74e5 100644 --- a/tests/docs/base/40_0leadership_diff_name.adoc +++ b/tests/docs/base/40_0leadership_diff_name.adoc @@ -11,30 +11,31 @@ leadership: follower1: # a follower follower2: # an other follower ---- -== Variables for "rougail" +== Variables for "Rougail" === a leadership `basic` - This family contains lists of variable blocks. [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.leadership.leader** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | -A leader. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | +A leader. | + **rougail.leadership.follower1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A follower. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A follower. | + **rougail.leadership.follower2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -An other follower. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +An other follower. |==== - diff --git a/tests/docs/base/40_0leadership_diff_name.json b/tests/docs/base/40_0leadership_diff_name.json new file mode 100644 index 0000000..ca351c8 --- /dev/null +++ b/tests/docs/base/40_0leadership_diff_name.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"leadership": {"type": "leadership", "informations": {"paths": ["rougail.leadership"], "names": ["leadership"], "description": "a leadership", "properties": [{"type": "mode", "name": "basic"}], "help": ["This family contains lists of variable blocks."]}, "children": {"leader": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.leadership.leader"], "names": ["leader"], "descriptions": ["A leader."], "multiple": true}, "follower1": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.leadership.follower1"], "names": ["follower1"], "descriptions": ["A follower."]}, "follower2": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.leadership.follower2"], "names": ["follower2"], "descriptions": ["An other follower."]}}}}}} \ No newline at end of file diff --git a/tests/docs/base/40_0leadership_diff_name.md b/tests/docs/base/40_0leadership_diff_name.md index 080cfa0..99e9a84 100644 --- a/tests/docs/base/40_0leadership_diff_name.md +++ b/tests/docs/base/40_0leadership_diff_name.md @@ -14,19 +14,17 @@ leadership: follower1: # a follower follower2: # an other follower ``` -# Variables for "rougail" +# Variables for "Rougail" ## a leadership `basic` - This family contains lists of variable blocks. -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.leadership.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | A leader. | -| **rougail.leadership.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A follower. | -| **rougail.leadership.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | An other follower. | - +| Variable                                                                                                                    | Description                                                                                                                 | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.leadership.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | A leader. | +| **rougail.leadership.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A follower. | +| **rougail.leadership.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | An other follower. | diff --git a/tests/docs/base/40_0leadership_empty.json b/tests/docs/base/40_0leadership_empty.json new file mode 100644 index 0000000..9e26dfe --- /dev/null +++ b/tests/docs/base/40_0leadership_empty.json @@ -0,0 +1 @@ +{} \ No newline at end of file diff --git a/tests/docs/base/40_0leadership_follower_default_calculation.adoc b/tests/docs/base/40_0leadership_follower_default_calculation.adoc index 822d8bb..b390c42 100644 --- a/tests/docs/base/40_0leadership_follower_default_calculation.adoc +++ b/tests/docs/base/40_0leadership_follower_default_calculation.adoc @@ -16,32 +16,33 @@ leader: {{ _.follower1 }} description: returns follower1 value ---- -== Variables for "rougail" +== Variables for "Rougail" === a leadership `basic` - This family contains lists of variable blocks. [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.leader.leader** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | -A leader. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | +A leader. | + **rougail.leader.follower1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A follower. + -**Default**: value +**Default**: value | + **rougail.leader.follower2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A second follower. + -**Default**: returns follower1 value. +**Default**: returns follower1 value. |==== - diff --git a/tests/docs/base/40_0leadership_follower_default_calculation.json b/tests/docs/base/40_0leadership_follower_default_calculation.json new file mode 100644 index 0000000..7d42941 --- /dev/null +++ b/tests/docs/base/40_0leadership_follower_default_calculation.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"leader": {"type": "leadership", "informations": {"paths": ["rougail.leader"], "names": ["leader"], "description": "a leadership", "properties": [{"type": "mode", "name": "basic"}], "help": ["This family contains lists of variable blocks."]}, "children": {"leader": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.leader.leader"], "names": ["leader"], "descriptions": ["A leader."], "multiple": true}, "follower1": {"type": "variable", "default": "value", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.leader.follower1"], "names": ["follower1"], "descriptions": ["A follower."]}, "follower2": {"type": "variable", "default": "returns follower1 value.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.leader.follower2"], "names": ["follower2"], "descriptions": ["A second follower."]}}}}}} \ No newline at end of file diff --git a/tests/docs/base/40_0leadership_follower_default_calculation.md b/tests/docs/base/40_0leadership_follower_default_calculation.md index 5f9e004..91bfc5c 100644 --- a/tests/docs/base/40_0leadership_follower_default_calculation.md +++ b/tests/docs/base/40_0leadership_follower_default_calculation.md @@ -19,19 +19,17 @@ leader: {{ _.follower1 }} description: returns follower1 value ``` -# Variables for "rougail" +# Variables for "Rougail" ## a leadership `basic` - This family contains lists of variable blocks. -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | A leader. | -| **rougail.leader.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A follower.
**Default**: value | -| **rougail.leader.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second follower.
**Default**: returns follower1 value. | - +| Variable                                                                                                                    | Description                                                                                                                 | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | A leader. | +| **rougail.leader.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A follower.
**Default**: value | +| **rougail.leader.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second follower.
**Default**: returns follower1 value. | diff --git a/tests/docs/base/40_0leadership_follower_default_submulti.adoc b/tests/docs/base/40_0leadership_follower_default_submulti.adoc index 4e569ed..42cfc8b 100644 --- a/tests/docs/base/40_0leadership_follower_default_submulti.adoc +++ b/tests/docs/base/40_0leadership_follower_default_submulti.adoc @@ -15,40 +15,37 @@ leader: - value1 - value2 ---- -== Variables for "rougail" +== Variables for "Rougail" === a leadership `standard` - This family contains lists of variable blocks. [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.leader.leader** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | A leader. + -**Default**: - -* leader +**Default**: leader | + **rougail.leader.follower1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `multiple` | A follower1. + -**Default**: - -* value +**Default**: value | + **rougail.leader.follower2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `multiple` | A follower2. + **Default**: * value1 -* value2 +* value2 |==== - diff --git a/tests/docs/base/40_0leadership_follower_default_submulti.json b/tests/docs/base/40_0leadership_follower_default_submulti.json new file mode 100644 index 0000000..8a4c35f --- /dev/null +++ b/tests/docs/base/40_0leadership_follower_default_submulti.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"leader": {"type": "leadership", "informations": {"paths": ["rougail.leader"], "names": ["leader"], "description": "a leadership", "properties": [{"type": "mode", "name": "standard"}], "help": ["This family contains lists of variable blocks."]}, "children": {"leader": {"type": "variable", "default": ["leader"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.leader.leader"], "names": ["leader"], "descriptions": ["A leader."], "multiple": true}, "follower1": {"type": "variable", "default": ["value"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.leader.follower1"], "names": ["follower1"], "descriptions": ["A follower1."], "multiple": true}, "follower2": {"type": "variable", "default": ["value1", "value2"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.leader.follower2"], "names": ["follower2"], "descriptions": ["A follower2."], "multiple": true}}}}}} \ No newline at end of file diff --git a/tests/docs/base/40_0leadership_follower_default_submulti.md b/tests/docs/base/40_0leadership_follower_default_submulti.md index 3cd30f4..d6ff220 100644 --- a/tests/docs/base/40_0leadership_follower_default_submulti.md +++ b/tests/docs/base/40_0leadership_follower_default_submulti.md @@ -18,19 +18,17 @@ leader: - value1 - value2 ``` -# Variables for "rougail" +# Variables for "Rougail" ## a leadership `standard` - This family contains lists of variable blocks. -| Variable                                                                                                              | Description                                                                                                           | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A leader.
**Default**:
- leader | -| **rougail.leader.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `multiple` | A follower1.
**Default**:
- value | -| **rougail.leader.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `multiple` | A follower2.
**Default**:
- value1
- value2 | - +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A leader.
**Default**: leader | +| **rougail.leader.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `multiple` | A follower1.
**Default**: value | +| **rougail.leader.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `multiple` | A follower2.
**Default**:
- value1
- value2 | diff --git a/tests/docs/base/40_0leadership_follower_default_submulti_calculation.adoc b/tests/docs/base/40_0leadership_follower_default_submulti_calculation.adoc index 16d4469..210c23a 100644 --- a/tests/docs/base/40_0leadership_follower_default_submulti_calculation.adoc +++ b/tests/docs/base/40_0leadership_follower_default_submulti_calculation.adoc @@ -17,37 +17,34 @@ leader: default: variable: _.follower1 ---- -== Variables for "rougail" +== Variables for "Rougail" === a leadership `standard` - This family contains lists of variable blocks. [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.leader.leader** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | The leader. + -**Default**: - -* leader +**Default**: leader | + **rougail.leader.follower1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `multiple` | The follower1. + -**Default**: - -* value +**Default**: value | + **rougail.leader.follower2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `multiple` | The follower2. + -**Default**: the value of the variable "rougail.leader.follower1". +**Default**: the value of the variable "rougail.leader.follower1". |==== - diff --git a/tests/docs/base/40_0leadership_follower_default_submulti_calculation.json b/tests/docs/base/40_0leadership_follower_default_submulti_calculation.json new file mode 100644 index 0000000..2e04f41 --- /dev/null +++ b/tests/docs/base/40_0leadership_follower_default_submulti_calculation.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"leader": {"type": "leadership", "informations": {"paths": ["rougail.leader"], "names": ["leader"], "description": "a leadership", "properties": [{"type": "mode", "name": "standard"}], "help": ["This family contains lists of variable blocks."]}, "children": {"leader": {"type": "variable", "default": ["leader"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.leader.leader"], "names": ["leader"], "descriptions": ["The leader."], "multiple": true}, "follower1": {"type": "variable", "default": ["value"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.leader.follower1"], "names": ["follower1"], "descriptions": ["The follower1."], "multiple": true}, "follower2": {"type": "variable", "default": "the value of the variable \"rougail.leader.follower1\".", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.leader.follower2"], "names": ["follower2"], "descriptions": ["The follower2."], "multiple": true}}}}}} \ No newline at end of file diff --git a/tests/docs/base/40_0leadership_follower_default_submulti_calculation.md b/tests/docs/base/40_0leadership_follower_default_submulti_calculation.md index 09c2cc8..bef92c8 100644 --- a/tests/docs/base/40_0leadership_follower_default_submulti_calculation.md +++ b/tests/docs/base/40_0leadership_follower_default_submulti_calculation.md @@ -20,19 +20,17 @@ leader: default: variable: _.follower1 ``` -# Variables for "rougail" +# Variables for "Rougail" ## a leadership `standard` - This family contains lists of variable blocks. -| Variable                                                                                                              | Description                                                                                                           | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The leader.
**Default**:
- leader | -| **rougail.leader.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `multiple` | The follower1.
**Default**:
- value | -| **rougail.leader.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `multiple` | The follower2.
**Default**: the value of the variable "rougail.leader.follower1". | - +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The leader.
**Default**: leader | +| **rougail.leader.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `multiple` | The follower1.
**Default**: value | +| **rougail.leader.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `multiple` | The follower2.
**Default**: the value of the variable "rougail.leader.follower1". | diff --git a/tests/docs/base/40_0leadership_follower_default_value.adoc b/tests/docs/base/40_0leadership_follower_default_value.adoc index fff852e..f5ced34 100644 --- a/tests/docs/base/40_0leadership_follower_default_value.adoc +++ b/tests/docs/base/40_0leadership_follower_default_value.adoc @@ -13,27 +13,27 @@ leader: mandatory: false follower1: value # a follower with default value ---- -== Variables for "rougail" +== Variables for "Rougail" === a leadership `standard` - This family contains lists of variable blocks. [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.leader.leader** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `unique` `multiple` | -A leader. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `unique` `multiple` | +A leader. | + **rougail.leader.follower1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A follower with default value. + -**Default**: value +**Default**: value |==== - diff --git a/tests/docs/base/40_0leadership_follower_default_value.json b/tests/docs/base/40_0leadership_follower_default_value.json new file mode 100644 index 0000000..a04b49e --- /dev/null +++ b/tests/docs/base/40_0leadership_follower_default_value.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"leader": {"type": "leadership", "informations": {"paths": ["rougail.leader"], "names": ["leader"], "description": "a leadership", "properties": [{"type": "mode", "name": "standard"}], "help": ["This family contains lists of variable blocks."]}, "children": {"leader": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.leader.leader"], "names": ["leader"], "descriptions": ["A leader."], "multiple": true}, "follower1": {"type": "variable", "default": "value", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.leader.follower1"], "names": ["follower1"], "descriptions": ["A follower with default value."]}}}}}} \ No newline at end of file diff --git a/tests/docs/base/40_0leadership_follower_default_value.md b/tests/docs/base/40_0leadership_follower_default_value.md index e765fc7..fcd2592 100644 --- a/tests/docs/base/40_0leadership_follower_default_value.md +++ b/tests/docs/base/40_0leadership_follower_default_value.md @@ -16,18 +16,16 @@ leader: mandatory: false follower1: value # a follower with default value ``` -# Variables for "rougail" +# Variables for "Rougail" ## a leadership `standard` - This family contains lists of variable blocks. -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A leader. | -| **rougail.leader.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A follower with default value.
**Default**: value | - +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A leader. | +| **rougail.leader.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A follower with default value.
**Default**: value | diff --git a/tests/docs/base/40_0leadership_leader_not_multi.adoc b/tests/docs/base/40_0leadership_leader_not_multi.adoc index 06b1f3f..5dd8d72 100644 --- a/tests/docs/base/40_0leadership_leader_not_multi.adoc +++ b/tests/docs/base/40_0leadership_leader_not_multi.adoc @@ -23,7 +23,7 @@ general1: description: follower2 version: '1.0' ---- -== Variables for "rougail" +== Variables for "Rougail" === rougail.general @@ -31,12 +31,13 @@ version: '1.0' [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.general.mode_conteneur_actif** + -`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` | No change. + -**Default**: non +**Default**: non |==== === rougail.general1 @@ -47,24 +48,25 @@ No change. + `basic` - This family contains lists of variable blocks. [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.general1.leader.leader** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | -Leader. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | +Leader. | + **rougail.general1.leader.follower1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -Follower1. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +Follower1. | + **rougail.general1.leader.follower2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -Follower2. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +Follower2. |==== - diff --git a/tests/docs/base/40_0leadership_leader_not_multi.json b/tests/docs/base/40_0leadership_leader_not_multi.json new file mode 100644 index 0000000..0689d43 --- /dev/null +++ b/tests/docs/base/40_0leadership_leader_not_multi.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"general": {"type": "family", "informations": {"paths": ["rougail.general"], "names": ["general"], "properties": [{"type": "mode", "name": "standard"}]}, "children": {"mode_conteneur_actif": {"type": "variable", "default": "non", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.general.mode_conteneur_actif"], "names": ["mode_conteneur_actif"], "descriptions": ["No change."]}}}, "general1": {"type": "family", "informations": {"paths": ["rougail.general1"], "names": ["general1"], "properties": [{"type": "mode", "name": "basic"}]}, "children": {"leader": {"type": "leadership", "informations": {"paths": ["rougail.general1.leader"], "names": ["leader"], "properties": [{"type": "mode", "name": "basic"}], "help": ["This family contains lists of variable blocks."]}, "children": {"leader": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.general1.leader.leader"], "names": ["leader"], "multiple": true}, "follower1": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.general1.leader.follower1"], "names": ["follower1"]}, "follower2": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.general1.leader.follower2"], "names": ["follower2"]}}}}}}}} \ No newline at end of file diff --git a/tests/docs/base/40_0leadership_leader_not_multi.md b/tests/docs/base/40_0leadership_leader_not_multi.md index 24d9e2d..038389e 100644 --- a/tests/docs/base/40_0leadership_leader_not_multi.md +++ b/tests/docs/base/40_0leadership_leader_not_multi.md @@ -26,15 +26,15 @@ general1: description: follower2 version: '1.0' ``` -# Variables for "rougail" +# Variables for "Rougail" ## rougail.general `standard` -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.general.mode_conteneur_actif**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | No change.
**Default**: non | +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.general.mode_conteneur_actif**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | No change.
**Default**: non | ## rougail.general1 @@ -44,13 +44,11 @@ version: '1.0' `basic` - This family contains lists of variable blocks. -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.general1.leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | Leader. | -| **rougail.general1.leader.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | Follower1. | -| **rougail.general1.leader.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | Follower2. | - +| Variable                                                                                                                    | Description                                                                                                                 | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.general1.leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | Leader. | +| **rougail.general1.leader.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | Follower1. | +| **rougail.general1.leader.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | Follower2. | diff --git a/tests/docs/base/40_1leadership_append_follower.adoc b/tests/docs/base/40_1leadership_append_follower.adoc index bcf9690..954431b 100644 --- a/tests/docs/base/40_1leadership_append_follower.adoc +++ b/tests/docs/base/40_1leadership_append_follower.adoc @@ -25,34 +25,36 @@ leader: follower2: description: the follower2 ---- -== Variables for "rougail" +== Variables for "Rougail" === a leadership `basic` - This family contains lists of variable blocks. [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.leader.leader** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | -The leader. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | +The leader. | + **rougail.leader.follower1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -The follower1. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +The follower1. | + **rougail.leader.follower2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -The follower2. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +The follower2. | + **rougail.leader.follower3** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -The follower3. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +The follower3. |==== - diff --git a/tests/docs/base/40_1leadership_append_follower.json b/tests/docs/base/40_1leadership_append_follower.json new file mode 100644 index 0000000..e8785c5 --- /dev/null +++ b/tests/docs/base/40_1leadership_append_follower.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"leader": {"type": "leadership", "informations": {"paths": ["rougail.leader"], "names": ["leader"], "description": "a leadership", "properties": [{"type": "mode", "name": "basic"}], "help": ["This family contains lists of variable blocks."]}, "children": {"leader": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.leader.leader"], "names": ["leader"], "descriptions": ["The leader."], "multiple": true}, "follower1": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.leader.follower1"], "names": ["follower1"], "descriptions": ["The follower1."]}, "follower2": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.leader.follower2"], "names": ["follower2"], "descriptions": ["The follower2."]}, "follower3": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.leader.follower3"], "names": ["follower3"], "descriptions": ["The follower3."]}}}}}} \ No newline at end of file diff --git a/tests/docs/base/40_1leadership_append_follower.md b/tests/docs/base/40_1leadership_append_follower.md index 38198ec..cf0b5ce 100644 --- a/tests/docs/base/40_1leadership_append_follower.md +++ b/tests/docs/base/40_1leadership_append_follower.md @@ -27,20 +27,18 @@ leader: follower2: description: the follower2 ``` -# Variables for "rougail" +# Variables for "Rougail" ## a leadership `basic` - This family contains lists of variable blocks. -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | The leader. | -| **rougail.leader.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The follower1. | -| **rougail.leader.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The follower2. | -| **rougail.leader.follower3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The follower3. | - +| Variable                                                                                                                    | Description                                                                                                                 | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | The leader. | +| **rougail.leader.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The follower1. | +| **rougail.leader.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The follower2. | +| **rougail.leader.follower3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The follower3. | diff --git a/tests/docs/base/40_2leadership_calculation_index.adoc b/tests/docs/base/40_2leadership_calculation_index.adoc index f04006f..901f86b 100644 --- a/tests/docs/base/40_2leadership_calculation_index.adoc +++ b/tests/docs/base/40_2leadership_calculation_index.adoc @@ -17,32 +17,32 @@ leader: default: type: index ---- -== Variables for "rougail" +== Variables for "Rougail" === a leadership `standard` - This family contains lists of variable blocks. [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.leader.leader** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | A leader. + **Default**: * a * b -* c +* c | + **rougail.leader.follower1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` | A follower. + -**Default**: the value of the index. +**Default**: the value of the index. |==== - diff --git a/tests/docs/base/40_2leadership_calculation_index.json b/tests/docs/base/40_2leadership_calculation_index.json new file mode 100644 index 0000000..4fcec7d --- /dev/null +++ b/tests/docs/base/40_2leadership_calculation_index.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"leader": {"type": "leadership", "informations": {"paths": ["rougail.leader"], "names": ["leader"], "description": "a leadership", "properties": [{"type": "mode", "name": "standard"}], "help": ["This family contains lists of variable blocks."]}, "children": {"leader": {"type": "variable", "default": ["a", "b", "c"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.leader.leader"], "names": ["leader"], "descriptions": ["A leader."], "multiple": true}, "follower1": {"type": "variable", "default": "the value of the index.", "properties": [{"type": "type", "name": "number"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.leader.follower1"], "names": ["follower1"], "descriptions": ["A follower."]}}}}}} \ No newline at end of file diff --git a/tests/docs/base/40_2leadership_calculation_index.md b/tests/docs/base/40_2leadership_calculation_index.md index ec7ac6f..7da0257 100644 --- a/tests/docs/base/40_2leadership_calculation_index.md +++ b/tests/docs/base/40_2leadership_calculation_index.md @@ -20,18 +20,16 @@ leader: default: type: index ``` -# Variables for "rougail" +# Variables for "Rougail" ## a leadership `standard` - This family contains lists of variable blocks. -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A leader.
**Default**:
- a
- b
- c | -| **rougail.leader.follower1**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A follower.
**Default**: the value of the index. | - +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A leader.
**Default**:
- a
- b
- c | +| **rougail.leader.follower1**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A follower.
**Default**: the value of the index. | diff --git a/tests/docs/base/40_2leadership_calculation_param_index.adoc b/tests/docs/base/40_2leadership_calculation_param_index.adoc index e2dd0c4..d328db0 100644 --- a/tests/docs/base/40_2leadership_calculation_param_index.adoc +++ b/tests/docs/base/40_2leadership_calculation_param_index.adoc @@ -21,32 +21,32 @@ leader: type: index description: returns index ---- -== Variables for "rougail" +== Variables for "Rougail" === leadership `standard` - This family contains lists of variable blocks. [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.leader.leader** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | A leader. + **Default**: * a * b -* c +* c | + **rougail.leader.follower1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` | A follower. + -**Default**: returns index. +**Default**: returns index. |==== - diff --git a/tests/docs/base/40_2leadership_calculation_param_index.json b/tests/docs/base/40_2leadership_calculation_param_index.json new file mode 100644 index 0000000..2e3e5ff --- /dev/null +++ b/tests/docs/base/40_2leadership_calculation_param_index.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"leader": {"type": "leadership", "informations": {"paths": ["rougail.leader"], "names": ["leader"], "description": "leadership", "properties": [{"type": "mode", "name": "standard"}], "help": ["This family contains lists of variable blocks."]}, "children": {"leader": {"type": "variable", "default": ["a", "b", "c"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.leader.leader"], "names": ["leader"], "descriptions": ["A leader."], "multiple": true}, "follower1": {"type": "variable", "default": "returns index.", "properties": [{"type": "type", "name": "number"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.leader.follower1"], "names": ["follower1"], "descriptions": ["A follower."]}}}}}} \ No newline at end of file diff --git a/tests/docs/base/40_2leadership_calculation_param_index.md b/tests/docs/base/40_2leadership_calculation_param_index.md index 758bcd3..146e7f8 100644 --- a/tests/docs/base/40_2leadership_calculation_param_index.md +++ b/tests/docs/base/40_2leadership_calculation_param_index.md @@ -24,18 +24,16 @@ leader: type: index description: returns index ``` -# Variables for "rougail" +# Variables for "Rougail" ## leadership `standard` - This family contains lists of variable blocks. -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A leader.
**Default**:
- a
- b
- c | -| **rougail.leader.follower1**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A follower.
**Default**: returns index. | - +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A leader.
**Default**:
- a
- b
- c | +| **rougail.leader.follower1**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A follower.
**Default**: returns index. | diff --git a/tests/docs/base/40_2leadership_leader_calculation.adoc b/tests/docs/base/40_2leadership_leader_calculation.adoc index ee8f345..2b6bbd9 100644 --- a/tests/docs/base/40_2leadership_leader_calculation.adoc +++ b/tests/docs/base/40_2leadership_leader_calculation.adoc @@ -22,31 +22,32 @@ leader: follower2: # a second follower ---- -== Variables for "rougail" +== Variables for "Rougail" === a leadership `basic` - This family contains lists of variable blocks. [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.leader.leader** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | A leader. + -**Default**: returns val1 and val2. +**Default**: returns val1 and val2. | + **rougail.leader.follower1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A first follower. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A first follower. | + **rougail.leader.follower2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A second follower. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A second follower. |==== - diff --git a/tests/docs/base/40_2leadership_leader_calculation.json b/tests/docs/base/40_2leadership_leader_calculation.json new file mode 100644 index 0000000..a804543 --- /dev/null +++ b/tests/docs/base/40_2leadership_leader_calculation.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"leader": {"type": "leadership", "informations": {"paths": ["rougail.leader"], "names": ["leader"], "description": "a leadership", "properties": [{"type": "mode", "name": "basic"}], "help": ["This family contains lists of variable blocks."]}, "children": {"leader": {"type": "variable", "default": "returns val1 and val2.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.leader.leader"], "names": ["leader"], "descriptions": ["A leader."], "multiple": true}, "follower1": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.leader.follower1"], "names": ["follower1"], "descriptions": ["A first follower."]}, "follower2": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.leader.follower2"], "names": ["follower2"], "descriptions": ["A second follower."]}}}}}} \ No newline at end of file diff --git a/tests/docs/base/40_2leadership_leader_calculation.md b/tests/docs/base/40_2leadership_leader_calculation.md index 3e2999f..81772ba 100644 --- a/tests/docs/base/40_2leadership_leader_calculation.md +++ b/tests/docs/base/40_2leadership_leader_calculation.md @@ -25,19 +25,17 @@ leader: follower2: # a second follower ``` -# Variables for "rougail" +# Variables for "Rougail" ## a leadership `basic` - This family contains lists of variable blocks. -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A leader.
**Default**: returns val1 and val2. | -| **rougail.leader.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A first follower. | -| **rougail.leader.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A second follower. | - +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A leader.
**Default**: returns val1 and val2. | +| **rougail.leader.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A first follower. | +| **rougail.leader.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A second follower. | diff --git a/tests/docs/base/40_6leadership_follower_multi.adoc b/tests/docs/base/40_6leadership_follower_multi.adoc index e12b0fa..7bcd8ed 100644 --- a/tests/docs/base/40_6leadership_follower_multi.adoc +++ b/tests/docs/base/40_6leadership_follower_multi.adoc @@ -19,33 +19,32 @@ leadership: default: - value ---- -== Variables for "rougail" +== Variables for "Rougail" === A leadership `basic` - This family contains lists of variable blocks. [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | -**rougail.leadership.leader** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | -The leader. -| -**rougail.leadership.follower1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `multiple` | -The first follower. -| -**rougail.leadership.follower2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `multiple` | -The second follower. + -**Default**: -* value +**rougail.leadership.leader** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | +The leader. +| + +**rougail.leadership.follower1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `multiple` | +The first follower. +| + +**rougail.leadership.follower2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `multiple` | +The second follower. + +**Default**: value |==== - diff --git a/tests/docs/base/40_6leadership_follower_multi.json b/tests/docs/base/40_6leadership_follower_multi.json new file mode 100644 index 0000000..d35fac5 --- /dev/null +++ b/tests/docs/base/40_6leadership_follower_multi.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"leadership": {"type": "leadership", "informations": {"paths": ["rougail.leadership"], "names": ["leadership"], "description": "A leadership", "properties": [{"type": "mode", "name": "basic"}], "help": ["This family contains lists of variable blocks."]}, "children": {"leader": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.leadership.leader"], "names": ["leader"], "descriptions": ["The leader."], "multiple": true}, "follower1": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.leadership.follower1"], "names": ["follower1"], "descriptions": ["The first follower."], "multiple": true}, "follower2": {"type": "variable", "default": ["value"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.leadership.follower2"], "names": ["follower2"], "descriptions": ["The second follower."], "multiple": true}}}}}} \ No newline at end of file diff --git a/tests/docs/base/40_6leadership_follower_multi.md b/tests/docs/base/40_6leadership_follower_multi.md index 79056d9..baa4ca5 100644 --- a/tests/docs/base/40_6leadership_follower_multi.md +++ b/tests/docs/base/40_6leadership_follower_multi.md @@ -22,19 +22,17 @@ leadership: default: - value ``` -# Variables for "rougail" +# Variables for "Rougail" ## A leadership `basic` - This family contains lists of variable blocks. -| Variable                                                                                                              | Description                                                                                                           | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.leadership.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | The leader. | -| **rougail.leadership.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `multiple` | The first follower. | -| **rougail.leadership.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `multiple` | The second follower.
**Default**:
- value | - +| Variable                                                                                                                    | Description                                                                                                                 | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.leadership.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | The leader. | +| **rougail.leadership.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `multiple` | The first follower. | +| **rougail.leadership.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `multiple` | The second follower.
**Default**: value | diff --git a/tests/docs/base/40_8calculation_boolean.adoc b/tests/docs/base/40_8calculation_boolean.adoc index 9ff05cf..da89b77 100644 --- a/tests/docs/base/40_8calculation_boolean.adoc +++ b/tests/docs/base/40_8calculation_boolean.adoc @@ -32,26 +32,28 @@ multi2: {% endif %} description: a calculation ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.bool** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | A boolean variable. + -**Default**: False +**Default**: false | + **rougail.multi1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` `unique` `multiple` | A first multi variable. + -**Default**: a calculation. +**Default**: a calculation. | + **rougail.multi2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` `unique` `multiple` | A second multi variable. + -**Default**: a calculation. +**Default**: a calculation. |==== - diff --git a/tests/docs/base/40_8calculation_boolean.json b/tests/docs/base/40_8calculation_boolean.json new file mode 100644 index 0000000..a0400b6 --- /dev/null +++ b/tests/docs/base/40_8calculation_boolean.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"bool": {"type": "variable", "default": false, "properties": [{"type": "type", "name": "boolean"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.bool"], "names": ["bool"], "descriptions": ["A boolean variable."]}, "multi1": {"type": "variable", "default": "a calculation.", "properties": [{"type": "type", "name": "boolean"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.multi1"], "names": ["multi1"], "descriptions": ["A first multi variable."], "multiple": true}, "multi2": {"type": "variable", "default": "a calculation.", "properties": [{"type": "type", "name": "boolean"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.multi2"], "names": ["multi2"], "descriptions": ["A second multi variable."], "multiple": true}}}} \ No newline at end of file diff --git a/tests/docs/base/40_8calculation_boolean.md b/tests/docs/base/40_8calculation_boolean.md index 83aba14..a75febc 100644 --- a/tests/docs/base/40_8calculation_boolean.md +++ b/tests/docs/base/40_8calculation_boolean.md @@ -35,12 +35,11 @@ multi2: {% endif %} description: a calculation ``` -# Variables for "rougail" +# Variables for "Rougail" | Variable                                                                                                                        | Description                                                                                                                     | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.bool**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A boolean variable.
**Default**: False | +| **rougail.bool**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A boolean variable.
**Default**: false | | **rougail.multi1**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A first multi variable.
**Default**: a calculation. | | **rougail.multi2**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A second multi variable.
**Default**: a calculation. | - diff --git a/tests/docs/base/40_8calculation_boolean_return_none.adoc b/tests/docs/base/40_8calculation_boolean_return_none.adoc index 105ae5d..7d09521 100644 --- a/tests/docs/base/40_8calculation_boolean_return_none.adoc +++ b/tests/docs/base/40_8calculation_boolean_return_none.adoc @@ -15,21 +15,22 @@ var2: {% endif %} description: return false if the value of var1 is "no" ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A first variable. + -**Default**: yes +**Default**: yes | + **rougail.var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | A second variable. + -**Default**: return false if the value of var1 is "no". +**Default**: return false if the value of var1 is "no". |==== - diff --git a/tests/docs/base/40_8calculation_boolean_return_none.json b/tests/docs/base/40_8calculation_boolean_return_none.json new file mode 100644 index 0000000..ff376ca --- /dev/null +++ b/tests/docs/base/40_8calculation_boolean_return_none.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"var1": {"type": "variable", "default": "yes", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.var1"], "names": ["var1"], "descriptions": ["A first variable."]}, "var2": {"type": "variable", "default": "return false if the value of var1 is \"no\".", "properties": [{"type": "type", "name": "boolean"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.var2"], "names": ["var2"], "descriptions": ["A second variable."]}}}} \ No newline at end of file diff --git a/tests/docs/base/40_8calculation_boolean_return_none.md b/tests/docs/base/40_8calculation_boolean_return_none.md index e72eed7..e73d42c 100644 --- a/tests/docs/base/40_8calculation_boolean_return_none.md +++ b/tests/docs/base/40_8calculation_boolean_return_none.md @@ -18,11 +18,10 @@ var2: {% endif %} description: return false if the value of var1 is "no" ``` -# Variables for "rougail" +# Variables for "Rougail" | Variable                                                                                                    | Description                                                                                                 | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A first variable.
**Default**: yes | | **rougail.var2**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second variable.
**Default**: return false if the value of var1 is "no". | - diff --git a/tests/docs/base/40_8calculation_integer.adoc b/tests/docs/base/40_8calculation_integer.adoc index 1c6b405..6c56756 100644 --- a/tests/docs/base/40_8calculation_integer.adoc +++ b/tests/docs/base/40_8calculation_integer.adoc @@ -20,26 +20,28 @@ int2: {% if not rougail.bool %}3{% else %}4{% endif %} description: if bool returns 3 otherwise return 4 ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.bool** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | A boolean variable. + -**Default**: False +**Default**: false | + **rougail.int1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` | First integer variable. + -**Default**: if bool returns 1 otherwise return 2. +**Default**: if bool returns 1 otherwise return 2. | + **rougail.int2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` | Second integer variable. + -**Default**: if bool returns 3 otherwise return 4. +**Default**: if bool returns 3 otherwise return 4. |==== - diff --git a/tests/docs/base/40_8calculation_integer.json b/tests/docs/base/40_8calculation_integer.json new file mode 100644 index 0000000..f9f26e3 --- /dev/null +++ b/tests/docs/base/40_8calculation_integer.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"bool": {"type": "variable", "default": false, "properties": [{"type": "type", "name": "boolean"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.bool"], "names": ["bool"], "descriptions": ["A boolean variable."]}, "int1": {"type": "variable", "default": "if bool returns 1 otherwise return 2.", "properties": [{"type": "type", "name": "number"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.int1"], "names": ["int1"], "descriptions": ["First integer variable."]}, "int2": {"type": "variable", "default": "if bool returns 3 otherwise return 4.", "properties": [{"type": "type", "name": "number"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.int2"], "names": ["int2"], "descriptions": ["Second integer variable."]}}}} \ No newline at end of file diff --git a/tests/docs/base/40_8calculation_integer.md b/tests/docs/base/40_8calculation_integer.md index bed9cf6..4df7086 100644 --- a/tests/docs/base/40_8calculation_integer.md +++ b/tests/docs/base/40_8calculation_integer.md @@ -23,12 +23,11 @@ int2: {% if not rougail.bool %}3{% else %}4{% endif %} description: if bool returns 3 otherwise return 4 ``` -# Variables for "rougail" - -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.bool**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A boolean variable.
**Default**: False | -| **rougail.int1**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | First integer variable.
**Default**: if bool returns 1 otherwise return 2. | -| **rougail.int2**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Second integer variable.
**Default**: if bool returns 3 otherwise return 4. | +# Variables for "Rougail" +| Variable                                                                                                    | Description                                                                                                 | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.bool**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A boolean variable.
**Default**: false | +| **rougail.int1**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | First integer variable.
**Default**: if bool returns 1 otherwise return 2. | +| **rougail.int2**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Second integer variable.
**Default**: if bool returns 3 otherwise return 4. | diff --git a/tests/docs/base/40_8calculation_multi_variable.adoc b/tests/docs/base/40_8calculation_multi_variable.adoc index 06b3872..2765828 100644 --- a/tests/docs/base/40_8calculation_multi_variable.adoc +++ b/tests/docs/base/40_8calculation_multi_variable.adoc @@ -12,29 +12,31 @@ var: var2: no # a second variable var3: yes # a third variable ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | A first variable. + **Default**: * the value of the variable "rougail.var2". -* the value of the variable "rougail.var3". +* the value of the variable "rougail.var3". | + **rougail.var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A second variable. + -**Default**: no +**Default**: no | + **rougail.var3** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A third variable. + -**Default**: yes +**Default**: yes |==== - diff --git a/tests/docs/base/40_8calculation_multi_variable.json b/tests/docs/base/40_8calculation_multi_variable.json new file mode 100644 index 0000000..6a13663 --- /dev/null +++ b/tests/docs/base/40_8calculation_multi_variable.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"var": {"type": "variable", "default": ["the value of the variable \"rougail.var2\".", "the value of the variable \"rougail.var3\"."], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var"], "names": ["var"], "descriptions": ["A first variable."], "multiple": true}, "var2": {"type": "variable", "default": "no", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.var2"], "names": ["var2"], "descriptions": ["A second variable."]}, "var3": {"type": "variable", "default": "yes", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.var3"], "names": ["var3"], "descriptions": ["A third variable."]}}}} \ No newline at end of file diff --git a/tests/docs/base/40_8calculation_multi_variable.md b/tests/docs/base/40_8calculation_multi_variable.md index b48f466..40a3fb6 100644 --- a/tests/docs/base/40_8calculation_multi_variable.md +++ b/tests/docs/base/40_8calculation_multi_variable.md @@ -15,12 +15,11 @@ var: var2: no # a second variable var3: yes # a third variable ``` -# Variables for "rougail" - -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A first variable.
**Default**:
- the value of the variable "rougail.var2".
- the value of the variable "rougail.var3". | -| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second variable.
**Default**: no | -| **rougail.var3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A third variable.
**Default**: yes | +# Variables for "Rougail" +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A first variable.
**Default**:
- the value of the variable "rougail.var2".
- the value of the variable "rougail.var3". | +| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second variable.
**Default**: no | +| **rougail.var3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A third variable.
**Default**: yes | diff --git a/tests/docs/base/40_8calculation_multi_variable_parent.adoc b/tests/docs/base/40_8calculation_multi_variable_parent.adoc index aec74d5..1f56749 100644 --- a/tests/docs/base/40_8calculation_multi_variable_parent.adoc +++ b/tests/docs/base/40_8calculation_multi_variable_parent.adoc @@ -11,16 +11,17 @@ fam1: # a family default: variable: __.var ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A variable. + -**Default**: no +**Default**: no |==== === a family @@ -29,12 +30,12 @@ A variable. + [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.fam1.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A calculated variable. + -**Default**: the value of the variable "rougail.var". +**Default**: the value of the variable "rougail.var". |==== - diff --git a/tests/docs/base/40_8calculation_multi_variable_parent.json b/tests/docs/base/40_8calculation_multi_variable_parent.json new file mode 100644 index 0000000..147240f --- /dev/null +++ b/tests/docs/base/40_8calculation_multi_variable_parent.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"var": {"type": "variable", "default": "no", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.var"], "names": ["var"], "descriptions": ["A variable."]}, "fam1": {"type": "family", "informations": {"paths": ["rougail.fam1"], "names": ["fam1"], "description": "a family", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"var": {"type": "variable", "default": "the value of the variable \"rougail.var\".", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.fam1.var"], "names": ["var"], "descriptions": ["A calculated variable."]}}}}}} \ No newline at end of file diff --git a/tests/docs/base/40_8calculation_multi_variable_parent.md b/tests/docs/base/40_8calculation_multi_variable_parent.md index d4b48e0..e590890 100644 --- a/tests/docs/base/40_8calculation_multi_variable_parent.md +++ b/tests/docs/base/40_8calculation_multi_variable_parent.md @@ -14,7 +14,7 @@ fam1: # a family default: variable: __.var ``` -# Variables for "rougail" +# Variables for "Rougail" | Variable                                                                                                   | Description                                                                                                | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| @@ -28,4 +28,3 @@ fam1: # a family |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.fam1.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A calculated variable.
**Default**: the value of the variable "rougail.var". | - diff --git a/tests/docs/base/40_8calculation_multi_variable_parent2.adoc b/tests/docs/base/40_8calculation_multi_variable_parent2.adoc index 4d205a7..a7e9313 100644 --- a/tests/docs/base/40_8calculation_multi_variable_parent2.adoc +++ b/tests/docs/base/40_8calculation_multi_variable_parent2.adoc @@ -12,7 +12,7 @@ fam2: # second family default: variable: __.fam1.var ---- -== Variables for "rougail" +== Variables for "Rougail" === first family @@ -20,12 +20,13 @@ fam2: # second family [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.fam1.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A variable. + -**Default**: no +**Default**: no |==== === second family @@ -34,12 +35,12 @@ A variable. + [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.fam2.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A varaible. + -**Default**: the value of the variable "rougail.fam1.var". +**Default**: the value of the variable "rougail.fam1.var". |==== - diff --git a/tests/docs/base/40_8calculation_multi_variable_parent2.json b/tests/docs/base/40_8calculation_multi_variable_parent2.json new file mode 100644 index 0000000..f8d3639 --- /dev/null +++ b/tests/docs/base/40_8calculation_multi_variable_parent2.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"fam1": {"type": "family", "informations": {"paths": ["rougail.fam1"], "names": ["fam1"], "description": "first family", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"var": {"type": "variable", "default": "no", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.fam1.var"], "names": ["var"], "descriptions": ["A variable."]}}}, "fam2": {"type": "family", "informations": {"paths": ["rougail.fam2"], "names": ["fam2"], "description": "second family", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"var": {"type": "variable", "default": "the value of the variable \"rougail.fam1.var\".", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.fam2.var"], "names": ["var"], "descriptions": ["A varaible."]}}}}}} \ No newline at end of file diff --git a/tests/docs/base/40_8calculation_multi_variable_parent2.md b/tests/docs/base/40_8calculation_multi_variable_parent2.md index 90b1ef3..2c85fbb 100644 --- a/tests/docs/base/40_8calculation_multi_variable_parent2.md +++ b/tests/docs/base/40_8calculation_multi_variable_parent2.md @@ -15,7 +15,7 @@ fam2: # second family default: variable: __.fam1.var ``` -# Variables for "rougail" +# Variables for "Rougail" ## first family @@ -33,4 +33,3 @@ fam2: # second family |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.fam2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A varaible.
**Default**: the value of the variable "rougail.fam1.var". | - diff --git a/tests/docs/base/41_0choice_leader.adoc b/tests/docs/base/41_0choice_leader.adoc index a9de74a..40c5b8e 100644 --- a/tests/docs/base/41_0choice_leader.adoc +++ b/tests/docs/base/41_0choice_leader.adoc @@ -19,31 +19,31 @@ leader: - b - c ---- -== Variables for "rougail" +== Variables for "Rougail" === The leadership `basic` - This family contains lists of variable blocks. [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.leader.leader** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `unique` `multiple` | -The leader. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `unique` `multiple` | +The leader. | + **rougail.leader.follower1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `basic` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `basic` `mandatory` | A follower. + **Choices**: * a * b -* c +* c |==== - diff --git a/tests/docs/base/41_0choice_leader.json b/tests/docs/base/41_0choice_leader.json new file mode 100644 index 0000000..16b0ae7 --- /dev/null +++ b/tests/docs/base/41_0choice_leader.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"leader": {"type": "leadership", "informations": {"paths": ["rougail.leader"], "names": ["leader"], "description": "The leadership", "properties": [{"type": "mode", "name": "basic"}], "help": ["This family contains lists of variable blocks."]}, "children": {"leader": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.leader.leader"], "names": ["leader"], "descriptions": ["The leader."], "multiple": true}, "follower1": {"type": "variable", "properties": [{"type": "type", "name": "choice"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "choices": ["a", "b", "c"], "paths": ["rougail.leader.follower1"], "names": ["follower1"], "descriptions": ["A follower."]}}}}}} \ No newline at end of file diff --git a/tests/docs/base/41_0choice_leader.md b/tests/docs/base/41_0choice_leader.md index d4f3298..e762ca6 100644 --- a/tests/docs/base/41_0choice_leader.md +++ b/tests/docs/base/41_0choice_leader.md @@ -22,18 +22,16 @@ leader: - b - c ``` -# Variables for "rougail" +# Variables for "Rougail" ## The leadership `basic` - This family contains lists of variable blocks. -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | The leader. | -| **rougail.leader.follower1**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A follower.
**Choices**:
- a
- b
- c | - +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | The leader. | +| **rougail.leader.follower1**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A follower.
**Choices**:
- a
- b
- c | diff --git a/tests/docs/base/44_0leadership_hidden.json b/tests/docs/base/44_0leadership_hidden.json new file mode 100644 index 0000000..9e26dfe --- /dev/null +++ b/tests/docs/base/44_0leadership_hidden.json @@ -0,0 +1 @@ +{} \ No newline at end of file diff --git a/tests/docs/base/44_0leadership_leader_hidden.json b/tests/docs/base/44_0leadership_leader_hidden.json new file mode 100644 index 0000000..9e26dfe --- /dev/null +++ b/tests/docs/base/44_0leadership_leader_hidden.json @@ -0,0 +1 @@ +{} \ No newline at end of file diff --git a/tests/docs/base/44_1leadership_append_hidden_follower.json b/tests/docs/base/44_1leadership_append_hidden_follower.json new file mode 100644 index 0000000..9e26dfe --- /dev/null +++ b/tests/docs/base/44_1leadership_append_hidden_follower.json @@ -0,0 +1 @@ +{} \ No newline at end of file diff --git a/tests/docs/base/44_4disabled_calcultion_follower.adoc b/tests/docs/base/44_4disabled_calcultion_follower.adoc index 0149fab..39954dc 100644 --- a/tests/docs/base/44_4disabled_calcultion_follower.adoc +++ b/tests/docs/base/44_4disabled_calcultion_follower.adoc @@ -21,40 +21,39 @@ leader: {% endif %} description: if condition is yes ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.condition** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | A condition. + -**Default**: True +**Default**: true |==== === a leadership `basic` - This family contains lists of variable blocks. [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | -**rougail.leader.leader** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | -Aleader. + -**Default**: -* a +**rougail.leader.leader** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +Aleader. + +**Default**: 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. +**Disabled**: if condition is yes. |==== - diff --git a/tests/docs/base/44_4disabled_calcultion_follower.json b/tests/docs/base/44_4disabled_calcultion_follower.json new file mode 100644 index 0000000..2ac4220 --- /dev/null +++ b/tests/docs/base/44_4disabled_calcultion_follower.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"condition": {"type": "variable", "default": true, "properties": [{"type": "type", "name": "boolean"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.condition"], "names": ["condition"], "descriptions": ["A condition."]}, "leader": {"type": "leadership", "informations": {"paths": ["rougail.leader"], "names": ["leader"], "description": "a leadership", "properties": [{"type": "mode", "name": "basic"}], "help": ["This family contains lists of variable blocks."]}, "children": {"leader": {"type": "variable", "default": ["a"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.leader.leader"], "names": ["leader"], "descriptions": ["Aleader."], "multiple": true}, "follower": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "disabled", "annotation": "if condition is yes."}], "paths": ["rougail.leader.follower"], "names": ["follower"], "descriptions": ["A follower."]}}}}}} \ No newline at end of file diff --git a/tests/docs/base/44_4disabled_calcultion_follower.md b/tests/docs/base/44_4disabled_calcultion_follower.md index 879c003..ea02708 100644 --- a/tests/docs/base/44_4disabled_calcultion_follower.md +++ b/tests/docs/base/44_4disabled_calcultion_follower.md @@ -24,22 +24,20 @@ leader: {% endif %} description: if condition is yes ``` -# Variables for "rougail" +# Variables for "Rougail" -| Variable                                                                                                             | Description                                                                                                          | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.condition**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.
**Default**: True | +| Variable                                                                                                    | Description                                                                                                 | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.condition**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.
**Default**: true | ## a leadership `basic` - This family contains lists of variable blocks. -| Variable                                                                                                             | Description                                                                                                          | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | Aleader.
**Default**:
- a | -| **rougail.leader.follower**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` *`disabled`* | A follower.
**Disabled**: if condition is yes. | - +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | Aleader.
**Default**: a | +| **rougail.leader.follower**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` *`disabled`* | A follower.
**Disabled**: if condition is yes. | diff --git a/tests/docs/base/44_4leadership_mandatory.adoc b/tests/docs/base/44_4leadership_mandatory.adoc index e5faad6..bd6dfbf 100644 --- a/tests/docs/base/44_4leadership_mandatory.adoc +++ b/tests/docs/base/44_4leadership_mandatory.adoc @@ -15,26 +15,26 @@ leader: description: a follower mandatory: false ---- -== Variables for "rougail" +== Variables for "Rougail" === a leadership `basic` - This family contains lists of variable blocks. [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.leader.leader** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | -A leader. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | +A leader. | + **rougail.leader.follower1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | -A follower. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | +A follower. |==== - diff --git a/tests/docs/base/44_4leadership_mandatory.json b/tests/docs/base/44_4leadership_mandatory.json new file mode 100644 index 0000000..25d0564 --- /dev/null +++ b/tests/docs/base/44_4leadership_mandatory.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"leader": {"type": "leadership", "informations": {"paths": ["rougail.leader"], "names": ["leader"], "description": "a leadership", "properties": [{"type": "mode", "name": "basic"}], "help": ["This family contains lists of variable blocks."]}, "children": {"leader": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.leader.leader"], "names": ["leader"], "descriptions": ["A leader."], "multiple": true}, "follower1": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}], "paths": ["rougail.leader.follower1"], "names": ["follower1"], "descriptions": ["A follower."]}}}}}} \ No newline at end of file diff --git a/tests/docs/base/44_4leadership_mandatory.md b/tests/docs/base/44_4leadership_mandatory.md index 4a0def2..b9131b5 100644 --- a/tests/docs/base/44_4leadership_mandatory.md +++ b/tests/docs/base/44_4leadership_mandatory.md @@ -18,18 +18,16 @@ leader: description: a follower mandatory: false ``` -# Variables for "rougail" +# Variables for "Rougail" ## a leadership `basic` - This family contains lists of variable blocks. -| Variable                                                                                       | Description                                                                                    | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | A leader. | -| **rougail.leader.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A follower. | - +| Variable                                                                                                                    | Description                                                                                                                 | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | A leader. | +| **rougail.leader.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A follower. | diff --git a/tests/docs/base/44_4leadership_mandatory_follower.adoc b/tests/docs/base/44_4leadership_mandatory_follower.adoc index 7198a00..8e59206 100644 --- a/tests/docs/base/44_4leadership_mandatory_follower.adoc +++ b/tests/docs/base/44_4leadership_mandatory_follower.adoc @@ -15,26 +15,26 @@ leader: description: a follower mandatory: true ---- -== Variables for "rougail" +== Variables for "Rougail" === a leadership `basic` - This family contains lists of variable blocks. [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.leader.leader** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `unique` `multiple` | -A leader. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `unique` `multiple` | +A leader. | + **rougail.leader.follower** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A follower. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A follower. |==== - diff --git a/tests/docs/base/44_4leadership_mandatory_follower.json b/tests/docs/base/44_4leadership_mandatory_follower.json new file mode 100644 index 0000000..71af419 --- /dev/null +++ b/tests/docs/base/44_4leadership_mandatory_follower.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"leader": {"type": "leadership", "informations": {"paths": ["rougail.leader"], "names": ["leader"], "description": "a leadership", "properties": [{"type": "mode", "name": "basic"}], "help": ["This family contains lists of variable blocks."]}, "children": {"leader": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.leader.leader"], "names": ["leader"], "descriptions": ["A leader."], "multiple": true}, "follower": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.leader.follower"], "names": ["follower"], "descriptions": ["A follower."]}}}}}} \ No newline at end of file diff --git a/tests/docs/base/44_4leadership_mandatory_follower.md b/tests/docs/base/44_4leadership_mandatory_follower.md index 0171692..2b82a82 100644 --- a/tests/docs/base/44_4leadership_mandatory_follower.md +++ b/tests/docs/base/44_4leadership_mandatory_follower.md @@ -18,18 +18,16 @@ leader: description: a follower mandatory: true ``` -# Variables for "rougail" +# Variables for "Rougail" ## a leadership `basic` - This family contains lists of variable blocks. -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A leader. | -| **rougail.leader.follower**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A follower. | - +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A leader. | +| **rougail.leader.follower**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A follower. | diff --git a/tests/docs/base/44_5leadership_leader_hidden_calculation.adoc b/tests/docs/base/44_5leadership_leader_hidden_calculation.adoc index ff72621..2e34cda 100644 --- a/tests/docs/base/44_5leadership_leader_hidden_calculation.adoc +++ b/tests/docs/base/44_5leadership_leader_hidden_calculation.adoc @@ -20,38 +20,40 @@ leader: mandatory: false follower: # a follower ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.condition** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A condition. + -**Default**: no +**Default**: no |==== === a leadership -`basic` `_hidden_` +`basic` `__hidden__` + **Hidden**: if condition is no. - This family contains lists of variable blocks. [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.leader.leader** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `unique` `multiple` | -A leader. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `unique` `multiple` | +A leader. | + **rougail.leader.follower** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A follower. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A follower. |==== - diff --git a/tests/docs/base/44_5leadership_leader_hidden_calculation.json b/tests/docs/base/44_5leadership_leader_hidden_calculation.json new file mode 100644 index 0000000..bd22715 --- /dev/null +++ b/tests/docs/base/44_5leadership_leader_hidden_calculation.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"condition": {"type": "variable", "default": "no", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.condition"], "names": ["condition"], "descriptions": ["A condition."]}, "leader": {"type": "leadership", "informations": {"paths": ["rougail.leader"], "names": ["leader"], "description": "a leadership", "properties": [{"type": "mode", "name": "basic"}, {"type": "property", "name": "hidden", "annotation": "if condition is no."}], "help": ["This family contains lists of variable blocks."]}, "children": {"leader": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.leader.leader"], "names": ["leader"], "descriptions": ["A leader."], "multiple": true}, "follower": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.leader.follower"], "names": ["follower"], "descriptions": ["A follower."]}}}}}} \ No newline at end of file diff --git a/tests/docs/base/44_5leadership_leader_hidden_calculation.md b/tests/docs/base/44_5leadership_leader_hidden_calculation.md index 54778a8..8b537b1 100644 --- a/tests/docs/base/44_5leadership_leader_hidden_calculation.md +++ b/tests/docs/base/44_5leadership_leader_hidden_calculation.md @@ -23,11 +23,11 @@ leader: mandatory: false follower: # a follower ``` -# Variables for "rougail" +# Variables for "Rougail" -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.
**Default**: no | +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.
**Default**: no | ## a leadership @@ -35,12 +35,10 @@ leader: **Hidden**: if condition is no. - This family contains lists of variable blocks. -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A leader. | -| **rougail.leader.follower**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A follower. | - +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A leader. | +| **rougail.leader.follower**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A follower. | diff --git a/tests/docs/base/44_6leadership_follower_disabled_calculation.adoc b/tests/docs/base/44_6leadership_follower_disabled_calculation.adoc index 953b144..2e3460b 100644 --- a/tests/docs/base/44_6leadership_follower_disabled_calculation.adoc +++ b/tests/docs/base/44_6leadership_follower_disabled_calculation.adoc @@ -20,37 +20,38 @@ leader: {% endif %} description: if condition is yes ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.condition** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A condition. + -**Default**: yes +**Default**: yes |==== === a leadership `basic` - This family contains lists of variable blocks. [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.leader.leader** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | -A leader. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | +A leader. | + **rougail.leader.follower** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `_disabled_` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `__disabled__` | A follower. + -**Disabled**: if condition is yes. +**Disabled**: if condition is yes. |==== - diff --git a/tests/docs/base/44_6leadership_follower_disabled_calculation.json b/tests/docs/base/44_6leadership_follower_disabled_calculation.json new file mode 100644 index 0000000..3dd5d6b --- /dev/null +++ b/tests/docs/base/44_6leadership_follower_disabled_calculation.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"condition": {"type": "variable", "default": "yes", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.condition"], "names": ["condition"], "descriptions": ["A condition."]}, "leader": {"type": "leadership", "informations": {"paths": ["rougail.leader"], "names": ["leader"], "description": "a leadership", "properties": [{"type": "mode", "name": "basic"}], "help": ["This family contains lists of variable blocks."]}, "children": {"leader": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.leader.leader"], "names": ["leader"], "descriptions": ["A leader."], "multiple": true}, "follower": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "disabled", "annotation": "if condition is yes."}], "paths": ["rougail.leader.follower"], "names": ["follower"], "descriptions": ["A follower."]}}}}}} \ No newline at end of file diff --git a/tests/docs/base/44_6leadership_follower_disabled_calculation.md b/tests/docs/base/44_6leadership_follower_disabled_calculation.md index e2e878a..eeeb98e 100644 --- a/tests/docs/base/44_6leadership_follower_disabled_calculation.md +++ b/tests/docs/base/44_6leadership_follower_disabled_calculation.md @@ -23,22 +23,20 @@ leader: {% endif %} description: if condition is yes ``` -# Variables for "rougail" +# Variables for "Rougail" -| Variable                                                                                                             | Description                                                                                                          | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.
**Default**: yes | +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.
**Default**: yes | ## a leadership `basic` - This family contains lists of variable blocks. -| Variable                                                                                                             | Description                                                                                                          | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | A leader. | -| **rougail.leader.follower**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` *`disabled`* | A follower.
**Disabled**: if condition is yes. | - +| Variable                                                                                                                    | Description                                                                                                                 | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | A leader. | +| **rougail.leader.follower**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` *`disabled`* | A follower.
**Disabled**: if condition is yes. | diff --git a/tests/docs/base/44_9calculated_default_leadership_leader.adoc b/tests/docs/base/44_9calculated_default_leadership_leader.adoc index 60244aa..141fdec 100644 --- a/tests/docs/base/44_9calculated_default_leadership_leader.adoc +++ b/tests/docs/base/44_9calculated_default_leadership_leader.adoc @@ -21,32 +21,32 @@ leader: default: variable: _.leader ---- -== Variables for "rougail" +== Variables for "Rougail" === rougail.leader `standard` - This family contains lists of variable blocks. [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.leader.leader** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | A leader. + **Default**: * a -* b +* b | + **rougail.leader.follower** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `_disabled_` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `__disabled__` | A follower. + **Default**: the value of the variable "rougail.leader.leader". + -**Disabled**: if the value of "leader" is "a". +**Disabled**: if the value of "leader" is "a". |==== - diff --git a/tests/docs/base/44_9calculated_default_leadership_leader.json b/tests/docs/base/44_9calculated_default_leadership_leader.json new file mode 100644 index 0000000..8a2a1ac --- /dev/null +++ b/tests/docs/base/44_9calculated_default_leadership_leader.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"leader": {"type": "leadership", "informations": {"paths": ["rougail.leader"], "names": ["leader"], "properties": [{"type": "mode", "name": "standard"}], "help": ["This family contains lists of variable blocks."]}, "children": {"leader": {"type": "variable", "default": ["a", "b"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.leader.leader"], "names": ["leader"], "descriptions": ["A leader."], "multiple": true}, "follower": {"type": "variable", "default": "the value of the variable \"rougail.leader.leader\".", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "disabled", "annotation": "if the value of \"leader\" is \"a\"."}], "paths": ["rougail.leader.follower"], "names": ["follower"], "descriptions": ["A follower."]}}}}}} \ No newline at end of file diff --git a/tests/docs/base/44_9calculated_default_leadership_leader.md b/tests/docs/base/44_9calculated_default_leadership_leader.md index 2d2c796..d00286b 100644 --- a/tests/docs/base/44_9calculated_default_leadership_leader.md +++ b/tests/docs/base/44_9calculated_default_leadership_leader.md @@ -24,18 +24,16 @@ leader: default: variable: _.leader ``` -# Variables for "rougail" +# Variables for "Rougail" ## rougail.leader `standard` - This family contains lists of variable blocks. -| Variable                                                                                                                | Description                                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A leader.
**Default**:
- a
- b | -| **rougail.leader.follower**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` *`disabled`* | A follower.
**Default**: the value of the variable "rougail.leader.leader".
**Disabled**: if the value of "leader" is "a". | - +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A leader.
**Default**:
- a
- b | +| **rougail.leader.follower**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` *`disabled`* | A follower.
**Default**: the value of the variable "rougail.leader.leader".
**Disabled**: if the value of "leader" is "a". | diff --git a/tests/docs/base/60_0family_dynamic.adoc b/tests/docs/base/60_0family_dynamic.adoc index 0c76d2c..22b6f9d 100644 --- a/tests/docs/base/60_0family_dynamic.adoc +++ b/tests/docs/base/60_0family_dynamic.adoc @@ -15,37 +15,38 @@ dyn{{ identifier }}: variable: _.var var: # A dynamic variable ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | A suffix variable. + **Default**: * val1 -* val2 +* val2 |==== === A dynamic family `basic` - This family builds families dynamically. **Identifiers**: the value of the variable "rougail.var". [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | -**rougail.dynval1.var** or **rougail.dynval2.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A dynamic variable. + +**rougail.dyn__val1__.var** + +**rougail.dyn__val2__.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A dynamic variable. |==== - diff --git a/tests/docs/base/60_0family_dynamic.json b/tests/docs/base/60_0family_dynamic.json new file mode 100644 index 0000000..f05d749 --- /dev/null +++ b/tests/docs/base/60_0family_dynamic.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"var": {"type": "variable", "default": ["val1", "val2"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var"], "names": ["var"], "descriptions": ["A suffix variable."], "multiple": true}, "dyn{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["rougail.dynval1", "rougail.dynval2"], "names": ["dynval1", "dynval2"], "description": "A dynamic family", "properties": [{"type": "mode", "name": "basic"}], "identifiers": "the value of the variable \"rougail.var\".", "help": ["This family builds families dynamically."]}, "children": {"var": {"paths": ["rougail.dynval1.var", "rougail.dynval2.var"], "names": ["var", "var"], "type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "descriptions": ["A dynamic variable."]}}}}}} \ No newline at end of file diff --git a/tests/docs/base/60_0family_dynamic.md b/tests/docs/base/60_0family_dynamic.md index 7371625..f0649c0 100644 --- a/tests/docs/base/60_0family_dynamic.md +++ b/tests/docs/base/60_0family_dynamic.md @@ -18,23 +18,21 @@ dyn{{ identifier }}: variable: _.var var: # A dynamic variable ``` -# Variables for "rougail" +# Variables for "Rougail" -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A suffix variable.
**Default**:
- val1
- val2 | +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A suffix variable.
**Default**:
- val1
- val2 | ## A dynamic family `basic` - This family builds families dynamically. **Identifiers**: the value of the variable "rougail.var". -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.dynval1.var** or **rougail.dynval2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A dynamic variable. | - +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dyn*val1*.var**
**rougail.dyn*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A dynamic variable. | diff --git a/tests/docs/base/60_0family_dynamic_1_0.adoc b/tests/docs/base/60_0family_dynamic_1_0.adoc index 7432f58..90002ba 100644 --- a/tests/docs/base/60_0family_dynamic_1_0.adoc +++ b/tests/docs/base/60_0family_dynamic_1_0.adoc @@ -17,37 +17,38 @@ dyn: description: Dynamic variable mandatory: false ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | A suffix variable. + **Default**: * val1 -* val2 +* val2 |==== -=== "dyn_val1_" or "dyn_val2_" +=== rougail.dyn__val1__ or rougail.dyn__val2__ `standard` - This family builds families dynamically. **Identifiers**: the value of the variable "rougail.var". [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | -**rougail.dynval1.vardyn** or **rougail.dynval2.vardyn** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | -Dynamic variable. + +**rougail.dyn__val1__.vardyn** + +**rougail.dyn__val2__.vardyn** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | +Dynamic variable. |==== - diff --git a/tests/docs/base/60_0family_dynamic_1_0.json b/tests/docs/base/60_0family_dynamic_1_0.json new file mode 100644 index 0000000..7af82e4 --- /dev/null +++ b/tests/docs/base/60_0family_dynamic_1_0.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"var": {"type": "variable", "default": ["val1", "val2"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var"], "names": ["var"], "descriptions": ["A suffix variable."], "multiple": true}, "dyn{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["rougail.dynval1", "rougail.dynval2"], "names": ["dynval1", "dynval2"], "properties": [{"type": "mode", "name": "standard"}], "identifiers": "the value of the variable \"rougail.var\".", "help": ["This family builds families dynamically."]}, "children": {"vardyn": {"paths": ["rougail.dynval1.vardyn", "rougail.dynval2.vardyn"], "names": ["vardyn", "vardyn"], "type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}], "descriptions": ["Dynamic variable."]}}}}}} \ No newline at end of file diff --git a/tests/docs/base/60_0family_dynamic_1_0.md b/tests/docs/base/60_0family_dynamic_1_0.md index 10424f7..3baae68 100644 --- a/tests/docs/base/60_0family_dynamic_1_0.md +++ b/tests/docs/base/60_0family_dynamic_1_0.md @@ -20,23 +20,21 @@ dyn: description: Dynamic variable mandatory: false ``` -# Variables for "rougail" +# Variables for "Rougail" -| Variable                                                                                       | Description                                                                                    | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A suffix variable.
**Default**:
- val1
- val2 | +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A suffix variable.
**Default**:
- val1
- val2 | -## "dyn*val1*" or "dyn*val2*" +## rougail.dyn*val1* or rougail.dyn*val2* `standard` - This family builds families dynamically. **Identifiers**: the value of the variable "rougail.var". -| Variable                                                                                       | Description                                                                                    | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.dynval1.vardyn** or **rougail.dynval2.vardyn**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | Dynamic variable. | - +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dyn*val1*.vardyn**
**rougail.dyn*val2*.vardyn**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | Dynamic variable. | diff --git a/tests/docs/base/60_0family_dynamic_1_0_type.adoc b/tests/docs/base/60_0family_dynamic_1_0_type.adoc index 8c0bba8..608f80c 100644 --- a/tests/docs/base/60_0family_dynamic_1_0_type.adoc +++ b/tests/docs/base/60_0family_dynamic_1_0_type.adoc @@ -16,37 +16,38 @@ dyn: vardyn: description: A dyn variable ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | A suffix variable. + **Default**: * val1 -* val2 +* val2 |==== -=== "dyn_val1_" or "dyn_val2_" +=== rougail.dyn__val1__ or rougail.dyn__val2__ `basic` - This family builds families dynamically. **Identifiers**: the value of the variable "rougail.var". [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | -**rougail.dynval1.vardyn** or **rougail.dynval2.vardyn** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A dyn variable. + +**rougail.dyn__val1__.vardyn** + +**rougail.dyn__val2__.vardyn** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A dyn variable. |==== - diff --git a/tests/docs/base/60_0family_dynamic_1_0_type.json b/tests/docs/base/60_0family_dynamic_1_0_type.json new file mode 100644 index 0000000..2312fc9 --- /dev/null +++ b/tests/docs/base/60_0family_dynamic_1_0_type.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"var": {"type": "variable", "default": ["val1", "val2"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var"], "names": ["var"], "descriptions": ["A suffix variable."], "multiple": true}, "dyn{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["rougail.dynval1", "rougail.dynval2"], "names": ["dynval1", "dynval2"], "properties": [{"type": "mode", "name": "basic"}], "identifiers": "the value of the variable \"rougail.var\".", "help": ["This family builds families dynamically."]}, "children": {"vardyn": {"paths": ["rougail.dynval1.vardyn", "rougail.dynval2.vardyn"], "names": ["vardyn", "vardyn"], "type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "descriptions": ["A dyn variable."]}}}}}} \ No newline at end of file diff --git a/tests/docs/base/60_0family_dynamic_1_0_type.md b/tests/docs/base/60_0family_dynamic_1_0_type.md index a05ba34..f3de733 100644 --- a/tests/docs/base/60_0family_dynamic_1_0_type.md +++ b/tests/docs/base/60_0family_dynamic_1_0_type.md @@ -19,23 +19,21 @@ dyn: vardyn: description: A dyn variable ``` -# Variables for "rougail" +# Variables for "Rougail" -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A suffix variable.
**Default**:
- val1
- val2 | +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A suffix variable.
**Default**:
- val1
- val2 | -## "dyn*val1*" or "dyn*val2*" +## rougail.dyn*val1* or rougail.dyn*val2* `basic` - This family builds families dynamically. **Identifiers**: the value of the variable "rougail.var". -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.dynval1.vardyn** or **rougail.dynval2.vardyn**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A dyn variable. | - +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dyn*val1*.vardyn**
**rougail.dyn*val2*.vardyn**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A dyn variable. | diff --git a/tests/docs/base/60_0family_dynamic_1_1.adoc b/tests/docs/base/60_0family_dynamic_1_1.adoc index 86c6ee8..2952633 100644 --- a/tests/docs/base/60_0family_dynamic_1_1.adoc +++ b/tests/docs/base/60_0family_dynamic_1_1.adoc @@ -14,37 +14,38 @@ dyn: vardyn: description: A dynamic variable ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | A suffix variable. + **Default**: * val1 -* val2 +* val2 |==== === A dynamic family `basic` - This family builds families dynamically. **Identifiers**: the value of the variable "rougail.var". [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | -**rougail.dynval1.vardyn** or **rougail.dynval2.vardyn** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A dynamic variable. + +**rougail.dyn__val1__.vardyn** + +**rougail.dyn__val2__.vardyn** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A dynamic variable. |==== - diff --git a/tests/docs/base/60_0family_dynamic_1_1.json b/tests/docs/base/60_0family_dynamic_1_1.json new file mode 100644 index 0000000..f4e67a5 --- /dev/null +++ b/tests/docs/base/60_0family_dynamic_1_1.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"var": {"type": "variable", "default": ["val1", "val2"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var"], "names": ["var"], "descriptions": ["A suffix variable."], "multiple": true}, "dyn{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["rougail.dynval1", "rougail.dynval2"], "names": ["dynval1", "dynval2"], "description": "A dynamic family", "properties": [{"type": "mode", "name": "basic"}], "identifiers": "the value of the variable \"rougail.var\".", "help": ["This family builds families dynamically."]}, "children": {"vardyn": {"paths": ["rougail.dynval1.vardyn", "rougail.dynval2.vardyn"], "names": ["vardyn", "vardyn"], "type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "descriptions": ["A dynamic variable."]}}}}}} \ No newline at end of file diff --git a/tests/docs/base/60_0family_dynamic_1_1.md b/tests/docs/base/60_0family_dynamic_1_1.md index 98bb2f3..d8dbeba 100644 --- a/tests/docs/base/60_0family_dynamic_1_1.md +++ b/tests/docs/base/60_0family_dynamic_1_1.md @@ -17,23 +17,21 @@ dyn: vardyn: description: A dynamic variable ``` -# Variables for "rougail" +# Variables for "Rougail" -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A suffix variable.
**Default**:
- val1
- val2 | +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A suffix variable.
**Default**:
- val1
- val2 | ## A dynamic family `basic` - This family builds families dynamically. **Identifiers**: the value of the variable "rougail.var". -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.dynval1.vardyn** or **rougail.dynval2.vardyn**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A dynamic variable. | - +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dyn*val1*.vardyn**
**rougail.dyn*val2*.vardyn**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A dynamic variable. | diff --git a/tests/docs/base/60_0family_dynamic_jinja_number.adoc b/tests/docs/base/60_0family_dynamic_jinja_number.adoc index 3a10d28..cc90e37 100644 --- a/tests/docs/base/60_0family_dynamic_jinja_number.adoc +++ b/tests/docs/base/60_0family_dynamic_jinja_number.adoc @@ -19,48 +19,50 @@ var2: {{ rougail.dyn1.var }} description: get the value of rougail.dyn1.var ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` `unique` `multiple` | A suffix variable. + **Default**: * 1 -* 2 +* 2 |==== === a dynamic family `standard` - This family builds families dynamically. **Identifiers**: the value of the variable "rougail.var". [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | -**rougail.dyn1.var** or **rougail.dyn2.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | + +**rougail.dyn__1__.var** + +**rougail.dyn__2__.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A variable inside dynamic family. + -**Default**: val +**Default**: val |==== [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A variable. + -**Default**: get the value of rougail.dyn1.var. +**Default**: get the value of rougail.dyn1.var. |==== - diff --git a/tests/docs/base/60_0family_dynamic_jinja_number.json b/tests/docs/base/60_0family_dynamic_jinja_number.json new file mode 100644 index 0000000..8bdfa92 --- /dev/null +++ b/tests/docs/base/60_0family_dynamic_jinja_number.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"var": {"type": "variable", "default": [1, 2], "properties": [{"type": "type", "name": "number"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var"], "names": ["var"], "descriptions": ["A suffix variable."], "multiple": true}, "dyn{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["rougail.dyn1", "rougail.dyn2"], "names": ["dyn1", "dyn2"], "description": "a dynamic family", "properties": [{"type": "mode", "name": "standard"}], "identifiers": "the value of the variable \"rougail.var\".", "help": ["This family builds families dynamically."]}, "children": {"var": {"paths": ["rougail.dyn1.var", "rougail.dyn2.var"], "names": ["var", "var"], "type": "variable", "default": "val", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "descriptions": ["A variable inside dynamic family."]}}}, "var2": {"type": "variable", "default": "get the value of rougail.dyn1.var.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.var2"], "names": ["var2"], "descriptions": ["A variable."]}}}} \ No newline at end of file diff --git a/tests/docs/base/60_0family_dynamic_jinja_number.md b/tests/docs/base/60_0family_dynamic_jinja_number.md index 57e8d57..8294e13 100644 --- a/tests/docs/base/60_0family_dynamic_jinja_number.md +++ b/tests/docs/base/60_0family_dynamic_jinja_number.md @@ -22,27 +22,25 @@ var2: {{ rougail.dyn1.var }} description: get the value of rougail.dyn1.var ``` -# Variables for "rougail" +# Variables for "Rougail" -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A suffix variable.
**Default**:
- 1
- 2 | +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A suffix variable.
**Default**:
- 1
- 2 | ## a dynamic family `standard` - This family builds families dynamically. **Identifiers**: the value of the variable "rougail.var". -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.dyn1.var** or **rougail.dyn2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable inside dynamic family.
**Default**: val | - -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: get the value of rougail.dyn1.var. | +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dyn*1*.var**
**rougail.dyn*2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable inside dynamic family.
**Default**: val | +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: get the value of rougail.dyn1.var. | diff --git a/tests/docs/base/60_0family_dynamic_no_description.adoc b/tests/docs/base/60_0family_dynamic_no_description.adoc new file mode 100644 index 0000000..234996c --- /dev/null +++ b/tests/docs/base/60_0family_dynamic_no_description.adoc @@ -0,0 +1,52 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +--- +version: '1.1' + +var: # A suffix variable + - val1 + - val2 + +dyn{{ identifier }}: + description: A dynamic family + dynamic: + variable: _.var + var: +---- +== Variables for "Rougail" + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**rougail.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +A suffix variable. + +**Default**: + +* val1 +* val2 +|==== + +=== A dynamic family + +`basic` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var". + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**rougail.dyn__val1__.var** + +**rougail.dyn__val2__.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +Var. +|==== + diff --git a/tests/docs/base/60_0family_dynamic_no_description.json b/tests/docs/base/60_0family_dynamic_no_description.json new file mode 100644 index 0000000..d0f9b97 --- /dev/null +++ b/tests/docs/base/60_0family_dynamic_no_description.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"var": {"type": "variable", "default": ["val1", "val2"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var"], "names": ["var"], "descriptions": ["A suffix variable."], "multiple": true}, "dyn{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["rougail.dynval1", "rougail.dynval2"], "names": ["dynval1", "dynval2"], "description": "A dynamic family", "properties": [{"type": "mode", "name": "basic"}], "identifiers": "the value of the variable \"rougail.var\".", "help": ["This family builds families dynamically."]}, "children": {"var": {"paths": ["rougail.dynval1.var", "rougail.dynval2.var"], "names": ["var", "var"], "type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}]}}}}}} \ No newline at end of file diff --git a/tests/docs/base/60_0family_dynamic_no_description.md b/tests/docs/base/60_0family_dynamic_no_description.md new file mode 100644 index 0000000..1cfefd9 --- /dev/null +++ b/tests/docs/base/60_0family_dynamic_no_description.md @@ -0,0 +1,38 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' + +var: # A suffix variable + - val1 + - val2 + +dyn{{ identifier }}: + description: A dynamic family + dynamic: + variable: _.var + var: +``` +# Variables for "Rougail" + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A suffix variable.
**Default**:
- val1
- val2 | + +## A dynamic family + +`basic` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var". + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dyn*val1*.var**
**rougail.dyn*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | Var. | + diff --git a/tests/docs/base/60_0family_dynamic_static.adoc b/tests/docs/base/60_0family_dynamic_static.adoc index 3b517e5..3495af7 100644 --- a/tests/docs/base/60_0family_dynamic_static.adoc +++ b/tests/docs/base/60_0family_dynamic_static.adoc @@ -11,13 +11,12 @@ dyn{{ identifier }}: - val2 var: # a variable inside a dynamic family ---- -== Variables for "rougail" +== Variables for "Rougail" === a dynamic family `basic` - This family builds families dynamically. **Identifiers**: @@ -27,11 +26,12 @@ This family builds families dynamically. [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | -**rougail.dynval1.var** or **rougail.dynval2.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A variable inside a dynamic family. + +**rougail.dyn__val1__.var** + +**rougail.dyn__val2__.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A variable inside a dynamic family. |==== - diff --git a/tests/docs/base/60_0family_dynamic_static.json b/tests/docs/base/60_0family_dynamic_static.json new file mode 100644 index 0000000..abdf530 --- /dev/null +++ b/tests/docs/base/60_0family_dynamic_static.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"dyn{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["rougail.dynval1", "rougail.dynval2"], "names": ["dynval1", "dynval2"], "description": "a dynamic family", "properties": [{"type": "mode", "name": "basic"}], "identifiers": ["val1", "val2"], "help": ["This family builds families dynamically."]}, "children": {"var": {"paths": ["rougail.dynval1.var", "rougail.dynval2.var"], "names": ["var", "var"], "type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "descriptions": ["A variable inside a dynamic family."]}}}}}} \ No newline at end of file diff --git a/tests/docs/base/60_0family_dynamic_static.md b/tests/docs/base/60_0family_dynamic_static.md index a8524a9..b03ad7b 100644 --- a/tests/docs/base/60_0family_dynamic_static.md +++ b/tests/docs/base/60_0family_dynamic_static.md @@ -14,19 +14,17 @@ dyn{{ identifier }}: - val2 var: # a variable inside a dynamic family ``` -# Variables for "rougail" +# Variables for "Rougail" ## a dynamic family `basic` - This family builds families dynamically. **Identifiers**:
- val1
- val2 | Variable                                                                                                | Description                                                                                             | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.dynval1.var** or **rougail.dynval2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable inside a dynamic family. | - +| **rougail.dyn*val1*.var**
**rougail.dyn*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable inside a dynamic family. | diff --git a/tests/docs/base/60_0family_dynamic_test.adoc b/tests/docs/base/60_0family_dynamic_test.adoc index 4573703..4abe613 100644 --- a/tests/docs/base/60_0family_dynamic_test.adoc +++ b/tests/docs/base/60_0family_dynamic_test.adoc @@ -19,37 +19,38 @@ dyn{{ identifier }}: var: # A dynamic variable ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | A suffix variable. + **Examples**: * val1 -* val2 +* val2 |==== === A dynamic family `basic` - This family builds families dynamically. **Identifiers**: the value of the variable "rougail.var". [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | -**rougail.dynval1.var** or **rougail.dynval2.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A dynamic variable. + +**rougail.dyn__val1__.var** + +**rougail.dyn__val2__.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A dynamic variable. |==== - diff --git a/tests/docs/base/60_0family_dynamic_test.json b/tests/docs/base/60_0family_dynamic_test.json new file mode 100644 index 0000000..1e64b38 --- /dev/null +++ b/tests/docs/base/60_0family_dynamic_test.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"var": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var"], "names": ["var"], "descriptions": ["A suffix variable."], "multiple": true, "examples": ["val1", "val2"]}, "dyn{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["rougail.dynval1", "rougail.dynval2"], "names": ["dynval1", "dynval2"], "description": "A dynamic family", "properties": [{"type": "mode", "name": "basic"}], "identifiers": "the value of the variable \"rougail.var\".", "help": ["This family builds families dynamically."]}, "children": {"var": {"paths": ["rougail.dynval1.var", "rougail.dynval2.var"], "names": ["var", "var"], "type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "descriptions": ["A dynamic variable."]}}}}}} \ No newline at end of file diff --git a/tests/docs/base/60_0family_dynamic_test.md b/tests/docs/base/60_0family_dynamic_test.md index fd16250..7931ccd 100644 --- a/tests/docs/base/60_0family_dynamic_test.md +++ b/tests/docs/base/60_0family_dynamic_test.md @@ -22,23 +22,21 @@ dyn{{ identifier }}: var: # A dynamic variable ``` -# Variables for "rougail" +# Variables for "Rougail" -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | A suffix variable.
**Examples**:
- val1
- val2 | +| Variable                                                                                                                    | Description                                                                                                                 | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | A suffix variable.
**Examples**:
- val1
- val2 | ## A dynamic family `basic` - This family builds families dynamically. **Identifiers**: the value of the variable "rougail.var". -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.dynval1.var** or **rougail.dynval2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A dynamic variable. | - +| Variable                                                                                                                    | Description                                                                                                                 | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dyn*val1*.var**
**rougail.dyn*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A dynamic variable. | diff --git a/tests/docs/base/60_0family_dynamic_variable_empty.adoc b/tests/docs/base/60_0family_dynamic_variable_empty.adoc index acc4808..6d84077 100644 --- a/tests/docs/base/60_0family_dynamic_variable_empty.adoc +++ b/tests/docs/base/60_0family_dynamic_variable_empty.adoc @@ -11,34 +11,34 @@ dyn{{ identifier }}: variable: _.var var: val # a variable inside dynamic family ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | -A suffix variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | +A suffix variable. |==== === a dynamic family `standard` - This family builds families dynamically. **Identifiers**: the value of the variable "rougail.var". [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | -**rougail.dynexample.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | + +**rougail.dyn__example__.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A variable inside dynamic family. + -**Default**: val +**Default**: val |==== - diff --git a/tests/docs/base/60_0family_dynamic_variable_empty.json b/tests/docs/base/60_0family_dynamic_variable_empty.json new file mode 100644 index 0000000..910dcdf --- /dev/null +++ b/tests/docs/base/60_0family_dynamic_variable_empty.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"var": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var"], "names": ["var"], "descriptions": ["A suffix variable."], "multiple": true}, "dyn{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["rougail.dynexample"], "names": ["dynexample"], "description": "a dynamic family", "properties": [{"type": "mode", "name": "standard"}], "identifiers": "the value of the variable \"rougail.var\".", "help": ["This family builds families dynamically."]}, "children": {"var": {"paths": ["rougail.dynexample.var"], "names": ["var"], "type": "variable", "default": "val", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "descriptions": ["A variable inside dynamic family."]}}}}}} \ No newline at end of file diff --git a/tests/docs/base/60_0family_dynamic_variable_empty.md b/tests/docs/base/60_0family_dynamic_variable_empty.md index 50624c6..3d3d18e 100644 --- a/tests/docs/base/60_0family_dynamic_variable_empty.md +++ b/tests/docs/base/60_0family_dynamic_variable_empty.md @@ -14,23 +14,21 @@ dyn{{ identifier }}: variable: _.var var: val # a variable inside dynamic family ``` -# Variables for "rougail" +# Variables for "Rougail" -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | A suffix variable. | +| Variable                                                                                                                    | Description                                                                                                                 | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | A suffix variable. | ## a dynamic family `standard` - This family builds families dynamically. **Identifiers**: the value of the variable "rougail.var". -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.dynexample.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable inside dynamic family.
**Default**: val | - +| Variable                                                                                                                    | Description                                                                                                                 | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dyn*example*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable inside dynamic family.
**Default**: val | diff --git a/tests/docs/base/60_0family_dynamic_variable_suffix.adoc b/tests/docs/base/60_0family_dynamic_variable_suffix.adoc index 4c7f3f7..91852dd 100644 --- a/tests/docs/base/60_0family_dynamic_variable_suffix.adoc +++ b/tests/docs/base/60_0family_dynamic_variable_suffix.adoc @@ -13,38 +13,40 @@ dyn{{ identifier }}: variable: _.var var: a value # A dynamic variable with suffix {{ identifier }} ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | A suffix variable. + **Default**: * val1 -* val2 +* val2 |==== === A dynamic family `standard` - This family builds families dynamically. **Identifiers**: the value of the variable "rougail.var". [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | -**rougail.dynval1.var** or **rougail.dynval2.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | -"A dynamic variable with suffix _val1_" or "A dynamic variable with suffix _val2_". + -**Default**: a value + +**rougail.dyn__val1__.var** + +**rougail.dyn__val2__.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A dynamic variable with suffix __val1__. + +A dynamic variable with suffix __val2__. + +**Default**: a value |==== - diff --git a/tests/docs/base/60_0family_dynamic_variable_suffix.json b/tests/docs/base/60_0family_dynamic_variable_suffix.json new file mode 100644 index 0000000..35fc508 --- /dev/null +++ b/tests/docs/base/60_0family_dynamic_variable_suffix.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"var": {"type": "variable", "default": ["val1", "val2"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var"], "names": ["var"], "descriptions": ["A suffix variable."], "multiple": true}, "dyn{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["rougail.dynval1", "rougail.dynval2"], "names": ["dynval1", "dynval2"], "description": "A dynamic family", "properties": [{"type": "mode", "name": "standard"}], "identifiers": "the value of the variable \"rougail.var\".", "help": ["This family builds families dynamically."]}, "children": {"var": {"paths": ["rougail.dynval1.var", "rougail.dynval2.var"], "names": ["var", "var"], "type": "variable", "default": "a value", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "descriptions": ["A dynamic variable with suffix val1.", "A dynamic variable with suffix val2."]}}}}}} \ No newline at end of file diff --git a/tests/docs/base/60_0family_dynamic_variable_suffix.md b/tests/docs/base/60_0family_dynamic_variable_suffix.md index ca807ae..abcc3a7 100644 --- a/tests/docs/base/60_0family_dynamic_variable_suffix.md +++ b/tests/docs/base/60_0family_dynamic_variable_suffix.md @@ -16,23 +16,21 @@ dyn{{ identifier }}: variable: _.var var: a value # A dynamic variable with suffix {{ identifier }} ``` -# Variables for "rougail" +# Variables for "Rougail" -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A suffix variable.
**Default**:
- val1
- val2 | +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A suffix variable.
**Default**:
- val1
- val2 | ## A dynamic family `standard` - This family builds families dynamically. **Identifiers**: the value of the variable "rougail.var". -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.dynval1.var** or **rougail.dynval2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | "A dynamic variable with suffix *val1*" or "A dynamic variable with suffix *val2*".
**Default**: a value | - +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dyn*val1*.var**
**rougail.dyn*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A dynamic variable with suffix *val1*.
A dynamic variable with suffix *val2*.
**Default**: a value | diff --git a/tests/docs/base/60_0family_empty.json b/tests/docs/base/60_0family_empty.json new file mode 100644 index 0000000..9e26dfe --- /dev/null +++ b/tests/docs/base/60_0family_empty.json @@ -0,0 +1 @@ +{} \ No newline at end of file diff --git a/tests/docs/base/60_0family_hidden.json b/tests/docs/base/60_0family_hidden.json new file mode 100644 index 0000000..9e26dfe --- /dev/null +++ b/tests/docs/base/60_0family_hidden.json @@ -0,0 +1 @@ +{} \ No newline at end of file diff --git a/tests/docs/base/60_0family_mode.adoc b/tests/docs/base/60_0family_mode.adoc index b1fff4e..959ecc2 100644 --- a/tests/docs/base/60_0family_mode.adoc +++ b/tests/docs/base/60_0family_mode.adoc @@ -10,7 +10,7 @@ family: # a family mode: basic default: non ---- -== Variables for "rougail" +== Variables for "Rougail" === a family @@ -18,12 +18,12 @@ family: # a family [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.family.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | A variable. + -**Default**: non +**Default**: non |==== - diff --git a/tests/docs/base/60_0family_mode.json b/tests/docs/base/60_0family_mode.json new file mode 100644 index 0000000..d3bd094 --- /dev/null +++ b/tests/docs/base/60_0family_mode.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"family": {"type": "family", "informations": {"paths": ["rougail.family"], "names": ["family"], "description": "a family", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"var": {"type": "variable", "default": "non", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.family.var"], "names": ["var"], "descriptions": ["A variable."]}}}}}} \ No newline at end of file diff --git a/tests/docs/base/60_0family_mode.md b/tests/docs/base/60_0family_mode.md index 1c3c85a..3cececb 100644 --- a/tests/docs/base/60_0family_mode.md +++ b/tests/docs/base/60_0family_mode.md @@ -13,7 +13,7 @@ family: # a family mode: basic default: non ``` -# Variables for "rougail" +# Variables for "Rougail" ## a family @@ -23,4 +23,3 @@ family: # a family |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.family.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable.
**Default**: non | - diff --git a/tests/docs/base/60_1family_dynamic_jinja.adoc b/tests/docs/base/60_1family_dynamic_jinja.adoc index a5db7f4..7c21c97 100644 --- a/tests/docs/base/60_1family_dynamic_jinja.adoc +++ b/tests/docs/base/60_1family_dynamic_jinja.adoc @@ -17,38 +17,39 @@ dyn{{ identifier }}: description: index of suffix value var: val # a dynamic variable ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | A suffix variable. + **Default**: * val1 -* val2 +* val2 |==== === A dynamic family `standard` - This family builds families dynamically. **Identifiers**: index of suffix value. [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | -**rougail.dyn1.var** or **rougail.dyn2.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | + +**rougail.dyn__1__.var** + +**rougail.dyn__2__.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A dynamic variable. + -**Default**: val +**Default**: val |==== - diff --git a/tests/docs/base/60_1family_dynamic_jinja.json b/tests/docs/base/60_1family_dynamic_jinja.json new file mode 100644 index 0000000..6ca28ff --- /dev/null +++ b/tests/docs/base/60_1family_dynamic_jinja.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"var": {"type": "variable", "default": ["val1", "val2"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var"], "names": ["var"], "descriptions": ["A suffix variable."], "multiple": true}, "dyn{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["rougail.dyn1", "rougail.dyn2"], "names": ["dyn1", "dyn2"], "description": "A dynamic family", "properties": [{"type": "mode", "name": "standard"}], "identifiers": "index of suffix value.", "help": ["This family builds families dynamically."]}, "children": {"var": {"paths": ["rougail.dyn1.var", "rougail.dyn2.var"], "names": ["var", "var"], "type": "variable", "default": "val", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "descriptions": ["A dynamic variable."]}}}}}} \ No newline at end of file diff --git a/tests/docs/base/60_1family_dynamic_jinja.md b/tests/docs/base/60_1family_dynamic_jinja.md index ce59f88..52dbd9c 100644 --- a/tests/docs/base/60_1family_dynamic_jinja.md +++ b/tests/docs/base/60_1family_dynamic_jinja.md @@ -20,23 +20,21 @@ dyn{{ identifier }}: description: index of suffix value var: val # a dynamic variable ``` -# Variables for "rougail" +# Variables for "Rougail" -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A suffix variable.
**Default**:
- val1
- val2 | +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A suffix variable.
**Default**:
- val1
- val2 | ## A dynamic family `standard` - This family builds families dynamically. **Identifiers**: index of suffix value. -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.dyn1.var** or **rougail.dyn2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A dynamic variable.
**Default**: val | - +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dyn*1*.var**
**rougail.dyn*2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A dynamic variable.
**Default**: val | diff --git a/tests/docs/base/60_2family_dynamic_jinja_fill_sub_group.adoc b/tests/docs/base/60_2family_dynamic_jinja_fill_sub_group.adoc index a119b57..96c4917 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 @@ -20,26 +20,26 @@ var2: {{ _.dynval1.family.var }} description: the value of var ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | A suffix variable. + **Default**: * val1 -* val2 +* val2 |==== === a dynamic family `basic` - This family builds families dynamically. **Identifiers**: the value of the variable "rougail.var1". @@ -50,21 +50,23 @@ This family builds families dynamically. [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | -**rougail.dynval1.family.var** or **rougail.dynval2.family.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -With a variable. + +**rougail.dyn__val1__.family.var** + +**rougail.dyn__val2__.family.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +With a variable. |==== [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A second variable. + -**Default**: the value of var. +**Default**: the value of var. |==== - diff --git a/tests/docs/base/60_2family_dynamic_jinja_fill_sub_group.json b/tests/docs/base/60_2family_dynamic_jinja_fill_sub_group.json new file mode 100644 index 0000000..4ba76c4 --- /dev/null +++ b/tests/docs/base/60_2family_dynamic_jinja_fill_sub_group.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"var1": {"type": "variable", "default": ["val1", "val2"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var1"], "names": ["var1"], "descriptions": ["A suffix variable."], "multiple": true}, "dyn{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["rougail.dynval1", "rougail.dynval2"], "names": ["dynval1", "dynval2"], "description": "a dynamic family", "properties": [{"type": "mode", "name": "basic"}], "identifiers": "the value of the variable \"rougail.var1\".", "help": ["This family builds families dynamically."]}, "children": {"family": {"type": "family", "informations": {"paths": ["rougail.dynval1.family", "rougail.dynval2.family"], "names": ["family", "family"], "description": "a family", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"var": {"paths": ["rougail.dynval1.family.var", "rougail.dynval2.family.var"], "names": ["var", "var"], "type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "descriptions": ["With a variable."]}}}}}, "var2": {"type": "variable", "default": "the value of var.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.var2"], "names": ["var2"], "descriptions": ["A second variable."]}}}} \ No newline at end of file diff --git a/tests/docs/base/60_2family_dynamic_jinja_fill_sub_group.md b/tests/docs/base/60_2family_dynamic_jinja_fill_sub_group.md index 030b6a2..0d79409 100644 --- a/tests/docs/base/60_2family_dynamic_jinja_fill_sub_group.md +++ b/tests/docs/base/60_2family_dynamic_jinja_fill_sub_group.md @@ -23,17 +23,16 @@ var2: {{ _.dynval1.family.var }} description: the value of var ``` -# Variables for "rougail" +# Variables for "Rougail" -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A suffix variable.
**Default**:
- val1
- val2 | +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A suffix variable.
**Default**:
- val1
- val2 | ## a dynamic family `basic` - This family builds families dynamically. **Identifiers**: the value of the variable "rougail.var1". @@ -42,12 +41,11 @@ This family builds families dynamically. `basic` -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.dynval1.family.var** or **rougail.dynval2.family.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | With a variable. | - -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second variable.
**Default**: the value of var. | +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dyn*val1*.family.var**
**rougail.dyn*val2*.family.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | With a variable. | +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second variable.
**Default**: the value of var. | diff --git a/tests/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 d7c585c..2aa5fcb 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 @@ -24,26 +24,26 @@ var2: {{ _.dynval1.family.var }} description: the value of var ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | A identifier variable. + **Default**: * val1 -* val2 +* val2 |==== === a dynamic family `standard` - This family builds families dynamically. **Identifiers**: the value of the variable "rougail.var". @@ -54,22 +54,24 @@ This family builds families dynamically. [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | -**rougail.dynval1.family.var** or **rougail.dynval2.family.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | + +**rougail.dyn__val1__.family.var** + +**rougail.dyn__val2__.family.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A dynamic variable. + -**Default**: the value of the identifier. +**Default**: the value of the identifier. |==== [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A varible outside dynamic family. + -**Default**: the value of var. +**Default**: the value of var. |==== - diff --git a/tests/docs/base/60_2family_dynamic_jinja_fill_sub_group_2.json b/tests/docs/base/60_2family_dynamic_jinja_fill_sub_group_2.json new file mode 100644 index 0000000..9ad556f --- /dev/null +++ b/tests/docs/base/60_2family_dynamic_jinja_fill_sub_group_2.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"var": {"type": "variable", "default": ["val1", "val2"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var"], "names": ["var"], "descriptions": ["A identifier variable."], "multiple": true}, "dyn{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["rougail.dynval1", "rougail.dynval2"], "names": ["dynval1", "dynval2"], "description": "a dynamic family", "properties": [{"type": "mode", "name": "standard"}], "identifiers": "the value of the variable \"rougail.var\".", "help": ["This family builds families dynamically."]}, "children": {"family": {"type": "family", "informations": {"paths": ["rougail.dynval1.family", "rougail.dynval2.family"], "names": ["family", "family"], "description": "a family inside dynamic family", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"var": {"paths": ["rougail.dynval1.family.var", "rougail.dynval2.family.var"], "names": ["var", "var"], "type": "variable", "default": "the value of the identifier.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "descriptions": ["A dynamic variable."]}}}}}, "var2": {"type": "variable", "default": "the value of var.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.var2"], "names": ["var2"], "descriptions": ["A varible outside dynamic family."]}}}} \ No newline at end of file diff --git a/tests/docs/base/60_2family_dynamic_jinja_fill_sub_group_2.md b/tests/docs/base/60_2family_dynamic_jinja_fill_sub_group_2.md index 60e3d3e..4c02e26 100644 --- a/tests/docs/base/60_2family_dynamic_jinja_fill_sub_group_2.md +++ b/tests/docs/base/60_2family_dynamic_jinja_fill_sub_group_2.md @@ -27,17 +27,16 @@ var2: {{ _.dynval1.family.var }} description: the value of var ``` -# Variables for "rougail" +# Variables for "Rougail" -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A identifier variable.
**Default**:
- val1
- val2 | +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A identifier variable.
**Default**:
- val1
- val2 | ## a dynamic family `standard` - This family builds families dynamically. **Identifiers**: the value of the variable "rougail.var". @@ -46,12 +45,11 @@ This family builds families dynamically. `standard` -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.dynval1.family.var** or **rougail.dynval2.family.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A dynamic variable.
**Default**: the value of the identifier. | - -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A varible outside dynamic family.
**Default**: the value of var. | +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dyn*val1*.family.var**
**rougail.dyn*val2*.family.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A dynamic variable.
**Default**: the value of the identifier. | +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A varible outside dynamic family.
**Default**: the value of var. | diff --git a/tests/docs/base/60_2family_dynamic_outside_calc.adoc b/tests/docs/base/60_2family_dynamic_outside_calc.adoc index a87b1d0..4c16259 100644 --- a/tests/docs/base/60_2family_dynamic_outside_calc.adoc +++ b/tests/docs/base/60_2family_dynamic_outside_calc.adoc @@ -19,48 +19,50 @@ newvar: {{ _.dynval1.var }} description: the value of var ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | A suffx variable. + **Default**: * val1 -* val2 +* val2 |==== === a dynamic family `standard` - This family builds families dynamically. **Identifiers**: the value of the variable "rougail.var1". [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | -**rougail.dynval1.var** or **rougail.dynval2.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | + +**rougail.dyn__val1__.var** + +**rougail.dyn__val2__.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A dynamic variable. + -**Default**: val +**Default**: val |==== [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.newvar** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A second variable. + -**Default**: the value of var. +**Default**: the value of var. |==== - diff --git a/tests/docs/base/60_2family_dynamic_outside_calc.json b/tests/docs/base/60_2family_dynamic_outside_calc.json new file mode 100644 index 0000000..54dc80b --- /dev/null +++ b/tests/docs/base/60_2family_dynamic_outside_calc.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"var1": {"type": "variable", "default": ["val1", "val2"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var1"], "names": ["var1"], "descriptions": ["A suffx variable."], "multiple": true}, "dyn{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["rougail.dynval1", "rougail.dynval2"], "names": ["dynval1", "dynval2"], "description": "a dynamic family", "properties": [{"type": "mode", "name": "standard"}], "identifiers": "the value of the variable \"rougail.var1\".", "help": ["This family builds families dynamically."]}, "children": {"var": {"paths": ["rougail.dynval1.var", "rougail.dynval2.var"], "names": ["var", "var"], "type": "variable", "default": "val", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "descriptions": ["A dynamic variable."]}}}, "newvar": {"type": "variable", "default": "the value of var.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.newvar"], "names": ["newvar"], "descriptions": ["A second variable."]}}}} \ No newline at end of file diff --git a/tests/docs/base/60_2family_dynamic_outside_calc.md b/tests/docs/base/60_2family_dynamic_outside_calc.md index 1905c50..21e2edd 100644 --- a/tests/docs/base/60_2family_dynamic_outside_calc.md +++ b/tests/docs/base/60_2family_dynamic_outside_calc.md @@ -22,27 +22,25 @@ newvar: {{ _.dynval1.var }} description: the value of var ``` -# Variables for "rougail" +# Variables for "Rougail" -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A suffx variable.
**Default**:
- val1
- val2 | +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A suffx variable.
**Default**:
- val1
- val2 | ## a dynamic family `standard` - This family builds families dynamically. **Identifiers**: the value of the variable "rougail.var1". -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.dynval1.var** or **rougail.dynval2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A dynamic variable.
**Default**: val | - -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.newvar**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second variable.
**Default**: the value of var. | +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dyn*val1*.var**
**rougail.dyn*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A dynamic variable.
**Default**: val | +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.newvar**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second variable.
**Default**: the value of var. | diff --git a/tests/docs/base/60_5family_dynamic_calc2.adoc b/tests/docs/base/60_5family_dynamic_calc2.adoc index 3982389..fa97824 100644 --- a/tests/docs/base/60_5family_dynamic_calc2.adoc +++ b/tests/docs/base/60_5family_dynamic_calc2.adoc @@ -24,44 +24,47 @@ dyn{{ identifier }}: vardyn: val # a dynamic variable ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | A suffix variable. + **Default**: * val1 -* val2 +* val2 | + **rougail.var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A second variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A second variable. |==== === A dynamic family -`standard` `_hidden_` +`standard` `__hidden__` + **Hidden**: if var2 is no. - This family builds families dynamically. **Identifiers**: the value of the variable "rougail.var". [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | -**rougail.dynval1.vardyn** or **rougail.dynval2.vardyn** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | + +**rougail.dyn__val1__.vardyn** + +**rougail.dyn__val2__.vardyn** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A dynamic variable. + -**Default**: val +**Default**: val |==== - diff --git a/tests/docs/base/60_5family_dynamic_calc2.json b/tests/docs/base/60_5family_dynamic_calc2.json new file mode 100644 index 0000000..f0836f4 --- /dev/null +++ b/tests/docs/base/60_5family_dynamic_calc2.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"var": {"type": "variable", "default": ["val1", "val2"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var"], "names": ["var"], "descriptions": ["A suffix variable."], "multiple": true}, "var2": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.var2"], "names": ["var2"], "descriptions": ["A second variable."]}, "dyn{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["rougail.dynval1", "rougail.dynval2"], "names": ["dynval1", "dynval2"], "description": "A dynamic family", "properties": [{"type": "mode", "name": "standard"}, {"type": "property", "name": "hidden", "annotation": "if var2 is no."}], "identifiers": "the value of the variable \"rougail.var\".", "help": ["This family builds families dynamically."]}, "children": {"vardyn": {"paths": ["rougail.dynval1.vardyn", "rougail.dynval2.vardyn"], "names": ["vardyn", "vardyn"], "type": "variable", "default": "val", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "descriptions": ["A dynamic variable."]}}}}}} \ No newline at end of file diff --git a/tests/docs/base/60_5family_dynamic_calc2.md b/tests/docs/base/60_5family_dynamic_calc2.md index 26f51bf..17f16bd 100644 --- a/tests/docs/base/60_5family_dynamic_calc2.md +++ b/tests/docs/base/60_5family_dynamic_calc2.md @@ -27,12 +27,12 @@ dyn{{ identifier }}: vardyn: val # a dynamic variable ``` -# Variables for "rougail" +# Variables for "Rougail" -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A suffix variable.
**Default**:
- val1
- val2 | -| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A second variable. | +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A suffix variable.
**Default**:
- val1
- val2 | +| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A second variable. | ## A dynamic family @@ -40,13 +40,11 @@ dyn{{ identifier }}: **Hidden**: if var2 is no. - This family builds families dynamically. **Identifiers**: the value of the variable "rougail.var". -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.dynval1.vardyn** or **rougail.dynval2.vardyn**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A dynamic variable.
**Default**: val | - +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dyn*val1*.vardyn**
**rougail.dyn*val2*.vardyn**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A dynamic variable.
**Default**: val | diff --git a/tests/docs/base/60_5family_dynamic_calc_suffix.adoc b/tests/docs/base/60_5family_dynamic_calc_suffix.adoc index ace2e8f..72c7c05 100644 --- a/tests/docs/base/60_5family_dynamic_calc_suffix.adoc +++ b/tests/docs/base/60_5family_dynamic_calc_suffix.adoc @@ -23,47 +23,49 @@ var2: default: variable: rougail.dynval1.var ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | A suffix variable. + **Default**: * val1 -* val2 +* val2 |==== -=== "dyn_val1_" or "dyn_val2_" +=== rougail.dyn__val1__ or rougail.dyn__val2__ `basic` - This family builds families dynamically. **Identifiers**: the value of the variable "rougail.var1". [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | -**rougail.dynval1.var** or **rougail.dynval2.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A dynamic variable. + +**rougail.dyn__val1__.var** + +**rougail.dyn__val2__.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A dynamic variable. |==== [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A variable calculated. + -**Default**: the value of the variable "rougail.dynval1.var". +**Default**: the value of the variable "rougail.dynval1.var". |==== - diff --git a/tests/docs/base/60_5family_dynamic_calc_suffix.json b/tests/docs/base/60_5family_dynamic_calc_suffix.json new file mode 100644 index 0000000..5787b16 --- /dev/null +++ b/tests/docs/base/60_5family_dynamic_calc_suffix.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"var1": {"type": "variable", "default": ["val1", "val2"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var1"], "names": ["var1"], "descriptions": ["A suffix variable."], "multiple": true}, "dyn{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["rougail.dynval1", "rougail.dynval2"], "names": ["dynval1", "dynval2"], "properties": [{"type": "mode", "name": "basic"}], "identifiers": "the value of the variable \"rougail.var1\".", "help": ["This family builds families dynamically."]}, "children": {"var": {"paths": ["rougail.dynval1.var", "rougail.dynval2.var"], "names": ["var", "var"], "type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "descriptions": ["A dynamic variable."]}}}, "var2": {"type": "variable", "default": "the value of the variable \"rougail.dynval1.var\".", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.var2"], "names": ["var2"], "descriptions": ["A variable calculated."]}}}} \ No newline at end of file diff --git a/tests/docs/base/60_5family_dynamic_calc_suffix.md b/tests/docs/base/60_5family_dynamic_calc_suffix.md index d7c5221..869c8fa 100644 --- a/tests/docs/base/60_5family_dynamic_calc_suffix.md +++ b/tests/docs/base/60_5family_dynamic_calc_suffix.md @@ -26,27 +26,25 @@ var2: default: variable: rougail.dynval1.var ``` -# Variables for "rougail" +# Variables for "Rougail" -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A suffix variable.
**Default**:
- val1
- val2 | +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A suffix variable.
**Default**:
- val1
- val2 | -## "dyn*val1*" or "dyn*val2*" +## rougail.dyn*val1* or rougail.dyn*val2* `basic` - This family builds families dynamically. **Identifiers**: the value of the variable "rougail.var1". -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.dynval1.var** or **rougail.dynval2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A dynamic variable. | - -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable calculated.
**Default**: the value of the variable "rougail.dynval1.var". | +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dyn*val1*.var**
**rougail.dyn*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A dynamic variable. | +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable calculated.
**Default**: the value of the variable "rougail.dynval1.var". | diff --git a/tests/docs/base/60_5family_dynamic_calc_suffix2.adoc b/tests/docs/base/60_5family_dynamic_calc_suffix2.adoc index 6c81679..306ba62 100644 --- a/tests/docs/base/60_5family_dynamic_calc_suffix2.adoc +++ b/tests/docs/base/60_5family_dynamic_calc_suffix2.adoc @@ -16,38 +16,39 @@ dyn{{ identifier }}: default: type: identifier ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | A suffix variable. + **Default**: * val1 -* val2 +* val2 |==== === a dynamic family `standard` - This family builds families dynamically. **Identifiers**: the value of the variable "rougail.var". [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | -**rougail.dynval1.var** or **rougail.dynval2.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | + +**rougail.dyn__val1__.var** + +**rougail.dyn__val2__.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | Suffix has value. + -**Default**: the value of the identifier. +**Default**: the value of the identifier. |==== - diff --git a/tests/docs/base/60_5family_dynamic_calc_suffix2.json b/tests/docs/base/60_5family_dynamic_calc_suffix2.json new file mode 100644 index 0000000..9128399 --- /dev/null +++ b/tests/docs/base/60_5family_dynamic_calc_suffix2.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"var": {"type": "variable", "default": ["val1", "val2"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var"], "names": ["var"], "descriptions": ["A suffix variable."], "multiple": true}, "dyn{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["rougail.dynval1", "rougail.dynval2"], "names": ["dynval1", "dynval2"], "description": "a dynamic family", "properties": [{"type": "mode", "name": "standard"}], "identifiers": "the value of the variable \"rougail.var\".", "help": ["This family builds families dynamically."]}, "children": {"var": {"paths": ["rougail.dynval1.var", "rougail.dynval2.var"], "names": ["var", "var"], "type": "variable", "default": "the value of the identifier.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "descriptions": ["Suffix has value."]}}}}}} \ No newline at end of file diff --git a/tests/docs/base/60_5family_dynamic_calc_suffix2.md b/tests/docs/base/60_5family_dynamic_calc_suffix2.md index 73aebc6..3df5e8e 100644 --- a/tests/docs/base/60_5family_dynamic_calc_suffix2.md +++ b/tests/docs/base/60_5family_dynamic_calc_suffix2.md @@ -19,23 +19,21 @@ dyn{{ identifier }}: default: type: identifier ``` -# Variables for "rougail" +# Variables for "Rougail" -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A suffix variable.
**Default**:
- val1
- val2 | +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A suffix variable.
**Default**:
- val1
- val2 | ## a dynamic family `standard` - This family builds families dynamically. **Identifiers**: the value of the variable "rougail.var". -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.dynval1.var** or **rougail.dynval2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Suffix has value.
**Default**: the value of the identifier. | - +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dyn*val1*.var**
**rougail.dyn*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Suffix has value.
**Default**: the value of the identifier. | diff --git a/tests/docs/base/60_5family_dynamic_calc_suffix_disabled.adoc b/tests/docs/base/60_5family_dynamic_calc_suffix_disabled.adoc index 59f658e..b75f757 100644 --- a/tests/docs/base/60_5family_dynamic_calc_suffix_disabled.adoc +++ b/tests/docs/base/60_5family_dynamic_calc_suffix_disabled.adoc @@ -14,13 +14,12 @@ dyn{{ identifier }}: type: identifier when: val1 ---- -== Variables for "rougail" +== Variables for "Rougail" -=== "dyn_val1_" or "dyn_val2_" +=== rougail.dyn__val1__ or rougail.dyn__val2__ `basic` - This family builds families dynamically. **Identifiers**: @@ -30,12 +29,13 @@ This family builds families dynamically. [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | -**rougail.dynval1.var** or **rougail.dynval2.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `_disabled_` | + +**rougail.dyn__val1__.var** + +**rougail.dyn__val2__.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `__disabled__` | A dynamic variable. + -**Disabled**: when the identifier is "val1". +**Disabled**: when the identifier is "val1". |==== - diff --git a/tests/docs/base/60_5family_dynamic_calc_suffix_disabled.json b/tests/docs/base/60_5family_dynamic_calc_suffix_disabled.json new file mode 100644 index 0000000..7b6ee87 --- /dev/null +++ b/tests/docs/base/60_5family_dynamic_calc_suffix_disabled.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"dyn{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["rougail.dynval1", "rougail.dynval2"], "names": ["dynval1", "dynval2"], "properties": [{"type": "mode", "name": "basic"}], "identifiers": ["val1", "val2"], "help": ["This family builds families dynamically."]}, "children": {"var": {"paths": ["rougail.dynval1.var", "rougail.dynval2.var"], "names": ["var", "var"], "type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "disabled", "annotation": "when the identifier is \"val1\"."}], "descriptions": ["A dynamic variable."]}}}}}} \ No newline at end of file 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 a0182e0..4024829 100644 --- a/tests/docs/base/60_5family_dynamic_calc_suffix_disabled.md +++ b/tests/docs/base/60_5family_dynamic_calc_suffix_disabled.md @@ -17,19 +17,17 @@ dyn{{ identifier }}: type: identifier when: val1 ``` -# Variables for "rougail" +# Variables for "Rougail" -## "dyn*val1*" or "dyn*val2*" +## rougail.dyn*val1* or rougail.dyn*val2* `basic` - This family builds families dynamically. **Identifiers**:
- val1
- val2 | 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.dyn*val1*.var**
**rougail.dyn*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` *`disabled`* | A dynamic variable.
**Disabled**: when the identifier is "val1". | 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 68856a5..9f2b3ad 100644 --- a/tests/docs/base/60_5family_dynamic_calc_suffix_param.adoc +++ b/tests/docs/base/60_5family_dynamic_calc_suffix_param.adoc @@ -21,38 +21,39 @@ dyn{{ identifier }}: type: identifier description: from suffix ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | A identifier variable. + **Default**: * val1 -* val2 +* val2 |==== === A dynamic family `standard` - This family builds families dynamically. **Identifiers**: the value of the variable "rougail.var". [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | -**rougail.dynval1.var** or **rougail.dynval2.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | + +**rougail.dyn__val1__.var** + +**rougail.dyn__val2__.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A dynamic variable. + -**Default**: from suffix. +**Default**: from suffix. |==== - diff --git a/tests/docs/base/60_5family_dynamic_calc_suffix_param.json b/tests/docs/base/60_5family_dynamic_calc_suffix_param.json new file mode 100644 index 0000000..82daa66 --- /dev/null +++ b/tests/docs/base/60_5family_dynamic_calc_suffix_param.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"var": {"type": "variable", "default": ["val1", "val2"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var"], "names": ["var"], "descriptions": ["A identifier variable."], "multiple": true}, "dyn{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["rougail.dynval1", "rougail.dynval2"], "names": ["dynval1", "dynval2"], "description": "A dynamic family", "properties": [{"type": "mode", "name": "standard"}], "identifiers": "the value of the variable \"rougail.var\".", "help": ["This family builds families dynamically."]}, "children": {"var": {"paths": ["rougail.dynval1.var", "rougail.dynval2.var"], "names": ["var", "var"], "type": "variable", "default": "from suffix.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "descriptions": ["A dynamic variable."]}}}}}} \ No newline at end of file diff --git a/tests/docs/base/60_5family_dynamic_calc_suffix_param.md b/tests/docs/base/60_5family_dynamic_calc_suffix_param.md index 69d6f2e..e6b1825 100644 --- a/tests/docs/base/60_5family_dynamic_calc_suffix_param.md +++ b/tests/docs/base/60_5family_dynamic_calc_suffix_param.md @@ -24,23 +24,21 @@ dyn{{ identifier }}: type: identifier description: from suffix ``` -# Variables for "rougail" +# Variables for "Rougail" -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A identifier variable.
**Default**:
- val1
- val2 | +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A identifier variable.
**Default**:
- val1
- val2 | ## A dynamic family `standard` - This family builds families dynamically. **Identifiers**: the value of the variable "rougail.var". -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.dynval1.var** or **rougail.dynval2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A dynamic variable.
**Default**: from suffix. | - +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dyn*val1*.var**
**rougail.dyn*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A dynamic variable.
**Default**: from suffix. | diff --git a/tests/docs/base/60_5family_dynamic_calc_variable.adoc b/tests/docs/base/60_5family_dynamic_calc_variable.adoc index ce41325..49908fe 100644 --- a/tests/docs/base/60_5family_dynamic_calc_variable.adoc +++ b/tests/docs/base/60_5family_dynamic_calc_variable.adoc @@ -20,47 +20,49 @@ var2: default: variable: _.dynval1.var ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | A suffix variable. + **Default**: * val1 -* val2 +* val2 |==== -=== "dyn_val1_" or "dyn_val2_" +=== rougail.dyn__val1__ or rougail.dyn__val2__ `basic` - This family builds families dynamically. **Identifiers**: the value of the variable "rougail.var1". [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | -**rougail.dynval1.var** or **rougail.dynval2.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A dynamic variable. + +**rougail.dyn__val1__.var** + +**rougail.dyn__val2__.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A dynamic variable. |==== [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A variable calculated. + -**Default**: the value of the variable "rougail.dynval1.var". +**Default**: the value of the variable "rougail.dynval1.var". |==== - diff --git a/tests/docs/base/60_5family_dynamic_calc_variable.json b/tests/docs/base/60_5family_dynamic_calc_variable.json new file mode 100644 index 0000000..5787b16 --- /dev/null +++ b/tests/docs/base/60_5family_dynamic_calc_variable.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"var1": {"type": "variable", "default": ["val1", "val2"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var1"], "names": ["var1"], "descriptions": ["A suffix variable."], "multiple": true}, "dyn{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["rougail.dynval1", "rougail.dynval2"], "names": ["dynval1", "dynval2"], "properties": [{"type": "mode", "name": "basic"}], "identifiers": "the value of the variable \"rougail.var1\".", "help": ["This family builds families dynamically."]}, "children": {"var": {"paths": ["rougail.dynval1.var", "rougail.dynval2.var"], "names": ["var", "var"], "type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "descriptions": ["A dynamic variable."]}}}, "var2": {"type": "variable", "default": "the value of the variable \"rougail.dynval1.var\".", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.var2"], "names": ["var2"], "descriptions": ["A variable calculated."]}}}} \ No newline at end of file diff --git a/tests/docs/base/60_5family_dynamic_calc_variable.md b/tests/docs/base/60_5family_dynamic_calc_variable.md index fabf6eb..e5a49a1 100644 --- a/tests/docs/base/60_5family_dynamic_calc_variable.md +++ b/tests/docs/base/60_5family_dynamic_calc_variable.md @@ -23,27 +23,25 @@ var2: default: variable: _.dynval1.var ``` -# Variables for "rougail" +# Variables for "Rougail" -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A suffix variable.
**Default**:
- val1
- val2 | +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A suffix variable.
**Default**:
- val1
- val2 | -## "dyn*val1*" or "dyn*val2*" +## rougail.dyn*val1* or rougail.dyn*val2* `basic` - This family builds families dynamically. **Identifiers**: the value of the variable "rougail.var1". -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.dynval1.var** or **rougail.dynval2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A dynamic variable. | - -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable calculated.
**Default**: the value of the variable "rougail.dynval1.var". | +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dyn*val1*.var**
**rougail.dyn*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A dynamic variable. | +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable calculated.
**Default**: the value of the variable "rougail.dynval1.var". | diff --git a/tests/docs/base/60_5family_dynamic_hidden_suffix.adoc b/tests/docs/base/60_5family_dynamic_hidden_suffix.adoc index a8a28c1..233d75c 100644 --- a/tests/docs/base/60_5family_dynamic_hidden_suffix.adoc +++ b/tests/docs/base/60_5family_dynamic_hidden_suffix.adoc @@ -27,15 +27,15 @@ dyn{{ identifier }}: description: a new variable mandatory: false ---- -== Variables for "rougail" +== Variables for "Rougail" === a dynamic family -`standard` `_hidden_` +`standard` `__hidden__` + **Hidden**: if suffix == 'val2'. - This family builds families dynamically. **Identifiers**: @@ -45,11 +45,13 @@ This family builds families dynamically. [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | -**rougail.dynval1.var** or **rougail.dynval2.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | -A variable. + +**rougail.dyn__val1__.var** + +**rougail.dyn__val2__.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | +A variable. |==== ==== a family @@ -58,11 +60,12 @@ A variable. [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | -**rougail.dynval1.family.var** or **rougail.dynval2.family.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | -A new variable. + +**rougail.dyn__val1__.family.var** + +**rougail.dyn__val2__.family.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | +A new variable. |==== - diff --git a/tests/docs/base/60_5family_dynamic_hidden_suffix.json b/tests/docs/base/60_5family_dynamic_hidden_suffix.json new file mode 100644 index 0000000..35a9a90 --- /dev/null +++ b/tests/docs/base/60_5family_dynamic_hidden_suffix.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"dyn{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["rougail.dynval1", "rougail.dynval2"], "names": ["dynval1", "dynval2"], "description": "a dynamic family", "properties": [{"type": "mode", "name": "standard"}, {"type": "property", "name": "hidden", "annotation": "if suffix == 'val2'."}], "identifiers": ["val1", "val2"], "help": ["This family builds families dynamically."]}, "children": {"var": {"paths": ["rougail.dynval1.var", "rougail.dynval2.var"], "names": ["var", "var"], "type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}], "descriptions": ["A variable."]}, "family": {"type": "family", "informations": {"paths": ["rougail.dynval1.family", "rougail.dynval2.family"], "names": ["family", "family"], "description": "a family", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"var": {"paths": ["rougail.dynval1.family.var", "rougail.dynval2.family.var"], "names": ["var", "var"], "type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}], "descriptions": ["A new variable."]}}}}}}}} \ No newline at end of file diff --git a/tests/docs/base/60_5family_dynamic_hidden_suffix.md b/tests/docs/base/60_5family_dynamic_hidden_suffix.md index e0353d3..923e4ea 100644 --- a/tests/docs/base/60_5family_dynamic_hidden_suffix.md +++ b/tests/docs/base/60_5family_dynamic_hidden_suffix.md @@ -30,7 +30,7 @@ dyn{{ identifier }}: description: a new variable mandatory: false ``` -# Variables for "rougail" +# Variables for "Rougail" ## a dynamic family @@ -38,14 +38,13 @@ dyn{{ identifier }}: **Hidden**: if suffix == 'val2'. - This family builds families dynamically. **Identifiers**:
- val1
- val2 | Variable                                                                                       | Description                                                                                    | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.dynval1.var** or **rougail.dynval2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A variable. | +| **rougail.dyn*val1*.var**
**rougail.dyn*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A variable. | ### a family @@ -53,6 +52,5 @@ This family builds families dynamically. | Variable                                                                                       | Description                                                                                    | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.dynval1.family.var** or **rougail.dynval2.family.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A new variable. | - +| **rougail.dyn*val1*.family.var**
**rougail.dyn*val2*.family.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A new variable. | diff --git a/tests/docs/base/60_5family_dynamic_variable_outside.adoc b/tests/docs/base/60_5family_dynamic_variable_outside.adoc index f2065c7..e764687 100644 --- a/tests/docs/base/60_5family_dynamic_variable_outside.adoc +++ b/tests/docs/base/60_5family_dynamic_variable_outside.adoc @@ -22,48 +22,53 @@ var2: default: variable: rougail.my_dyn_family_{{ identifier }}.var ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | A suffix variable. + **Default**: * val1 -* val2 +* val2 |==== === a dynamic family `standard` - This family builds families dynamically. **Identifiers**: the value of the variable "rougail.var". [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | -**rougail.my_dyn_family_val1.var** or **rougail.my_dyn_family_val2.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | + +**rougail.my_dyn_family___val1__.var** + +**rougail.my_dyn_family___val2__.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | A variable inside a dynamic family. + -**Default**: the value of the identifier. +**Default**: the value of the identifier. |==== [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | A variable. + -**Default**: the value of the variable "rougail.my_dyn_family_{{ identifier }}.var". +**Default**: + +* the value of the variable "rougail.my_dyn_family___val1__.var" +* the value of the variable "rougail.my_dyn_family___val2__.var" |==== - diff --git a/tests/docs/base/60_5family_dynamic_variable_outside.json b/tests/docs/base/60_5family_dynamic_variable_outside.json new file mode 100644 index 0000000..aea5cc9 --- /dev/null +++ b/tests/docs/base/60_5family_dynamic_variable_outside.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"var": {"type": "variable", "default": ["val1", "val2"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var"], "names": ["var"], "descriptions": ["A suffix variable."], "multiple": true}, "my_dyn_family_{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["rougail.my_dyn_family_val1", "rougail.my_dyn_family_val2"], "names": ["my_dyn_family_val1", "my_dyn_family_val2"], "description": "a dynamic family", "properties": [{"type": "mode", "name": "standard"}], "identifiers": "the value of the variable \"rougail.var\".", "help": ["This family builds families dynamically."]}, "children": {"var": {"paths": ["rougail.my_dyn_family_val1.var", "rougail.my_dyn_family_val2.var"], "names": ["var", "var"], "type": "variable", "default": "the value of the identifier.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}], "descriptions": ["A variable inside a dynamic family."]}}}, "var2": {"type": "variable", "default": ["the value of the variable \"rougail.my_dyn_family_val1.var\"", "the value of the variable \"rougail.my_dyn_family_val2.var\""], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var2"], "names": ["var2"], "descriptions": ["A variable."], "multiple": true}}}} \ No newline at end of file diff --git a/tests/docs/base/60_5family_dynamic_variable_outside.md b/tests/docs/base/60_5family_dynamic_variable_outside.md index d09c7fc..4c030c4 100644 --- a/tests/docs/base/60_5family_dynamic_variable_outside.md +++ b/tests/docs/base/60_5family_dynamic_variable_outside.md @@ -25,7 +25,7 @@ var2: default: variable: rougail.my_dyn_family_{{ identifier }}.var ``` -# Variables for "rougail" +# Variables for "Rougail" | Variable                                                                                                                       | Description                                                                                                                    | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| @@ -35,17 +35,15 @@ var2: `standard` - This family builds families dynamically. **Identifiers**: the value of the variable "rougail.var". | Variable                                                                                                                       | Description                                                                                                                    | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.my_dyn_family_val1.var** or **rougail.my_dyn_family_val2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A variable inside a dynamic family.
**Default**: the value of the identifier. | +| **rougail.my_dyn_family_*val1*.var**
**rougail.my_dyn_family_*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A variable inside a dynamic family.
**Default**: the value of the identifier. | | Variable                                                                                                                       | Description                                                                                                                    | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A variable.
**Default**: the value of the variable "rougail.my_dyn_family_{{ identifier }}.var". | - +| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A variable.
**Default**:
- the value of the variable "rougail.my_dyn_family_*val1*.var"
- the value of the variable "rougail.my_dyn_family_*val2*.var" | diff --git a/tests/docs/base/60_5family_dynamic_variable_outside2.adoc b/tests/docs/base/60_5family_dynamic_variable_outside2.adoc new file mode 100644 index 0000000..36ebe36 --- /dev/null +++ b/tests/docs/base/60_5family_dynamic_variable_outside2.adoc @@ -0,0 +1,73 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +--- +version: '1.1' + +var2: + description: a variable + multi: true + default: + variable: rougail.my_dyn_family_{{ identifier }}.var + +var: # a suffix variable + - val1 + - val2 + +my_dyn_family_{{ identifier }}: + description: a dynamic family + dynamic: + variable: _.var + + var: + description: a variable inside a dynamic family + default: + type: identifier + mandatory: false +---- +== Variables for "Rougail" + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**rougail.var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +A variable. + +**Default**: + +* the value of the variable "rougail.my_dyn_family___val1__.var" +* the value of the variable "rougail.my_dyn_family___val2__.var" +| + +**rougail.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +A suffix variable. + +**Default**: + +* val1 +* val2 +|==== + +=== a dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var". + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**rougail.my_dyn_family___val1__.var** + +**rougail.my_dyn_family___val2__.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | +A variable inside a dynamic family. + +**Default**: the value of the identifier. +|==== + diff --git a/tests/docs/base/60_5family_dynamic_variable_outside2.json b/tests/docs/base/60_5family_dynamic_variable_outside2.json new file mode 100644 index 0000000..768b98c --- /dev/null +++ b/tests/docs/base/60_5family_dynamic_variable_outside2.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"var2": {"type": "variable", "default": ["the value of the variable \"rougail.my_dyn_family_val1.var\"", "the value of the variable \"rougail.my_dyn_family_val2.var\""], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var2"], "names": ["var2"], "descriptions": ["A variable."], "multiple": true}, "var": {"type": "variable", "default": ["val1", "val2"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var"], "names": ["var"], "descriptions": ["A suffix variable."], "multiple": true}, "my_dyn_family_{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["rougail.my_dyn_family_val1", "rougail.my_dyn_family_val2"], "names": ["my_dyn_family_val1", "my_dyn_family_val2"], "description": "a dynamic family", "properties": [{"type": "mode", "name": "standard"}], "identifiers": "the value of the variable \"rougail.var\".", "help": ["This family builds families dynamically."]}, "children": {"var": {"paths": ["rougail.my_dyn_family_val1.var", "rougail.my_dyn_family_val2.var"], "names": ["var", "var"], "type": "variable", "default": "the value of the identifier.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}], "descriptions": ["A variable inside a dynamic family."]}}}}}} \ No newline at end of file diff --git a/tests/docs/base/60_5family_dynamic_variable_outside2.md b/tests/docs/base/60_5family_dynamic_variable_outside2.md new file mode 100644 index 0000000..7a2a4ae --- /dev/null +++ b/tests/docs/base/60_5family_dynamic_variable_outside2.md @@ -0,0 +1,50 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' + +var2: + description: a variable + multi: true + default: + variable: rougail.my_dyn_family_{{ identifier }}.var + +var: # a suffix variable + - val1 + - val2 + +my_dyn_family_{{ identifier }}: + description: a dynamic family + dynamic: + variable: _.var + + var: + description: a variable inside a dynamic family + default: + type: identifier + mandatory: false +``` +# Variables for "Rougail" + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A variable.
**Default**:
- the value of the variable "rougail.my_dyn_family_*val1*.var"
- the value of the variable "rougail.my_dyn_family_*val2*.var" | +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A suffix variable.
**Default**:
- val1
- val2 | + +## a dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var". + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.my_dyn_family_*val1*.var**
**rougail.my_dyn_family_*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A variable inside a dynamic family.
**Default**: the value of the identifier. | + diff --git a/tests/docs/base/60_5family_dynamic_variable_outside_jinja.adoc b/tests/docs/base/60_5family_dynamic_variable_outside_jinja.adoc index 5382011..123d1ee 100644 --- a/tests/docs/base/60_5family_dynamic_variable_outside_jinja.adoc +++ b/tests/docs/base/60_5family_dynamic_variable_outside_jinja.adoc @@ -28,48 +28,50 @@ var2: var: variable: rougail.my_dyn_family_{{ identifier }}.var ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | A suffix variable. + **Default**: * val1 -* val2 +* val2 |==== === a dynamic family `standard` - This family builds families dynamically. **Identifiers**: the value of the variable "rougail.var". [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | -**rougail.my_dyn_family_val1.var** or **rougail.my_dyn_family_val2.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | + +**rougail.my_dyn_family___val1__.var** + +**rougail.my_dyn_family___val2__.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | A variable inside a dynamic family. + -**Default**: the value of the identifier. +**Default**: the value of the identifier. |==== [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | A variable. + -**Default**: depends on a calculation. +**Default**: depends on a calculation. |==== - diff --git a/tests/docs/base/60_5family_dynamic_variable_outside_jinja.json b/tests/docs/base/60_5family_dynamic_variable_outside_jinja.json new file mode 100644 index 0000000..b7ce264 --- /dev/null +++ b/tests/docs/base/60_5family_dynamic_variable_outside_jinja.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"var": {"type": "variable", "default": ["val1", "val2"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var"], "names": ["var"], "descriptions": ["A suffix variable."], "multiple": true}, "my_dyn_family_{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["rougail.my_dyn_family_val1", "rougail.my_dyn_family_val2"], "names": ["my_dyn_family_val1", "my_dyn_family_val2"], "description": "a dynamic family", "properties": [{"type": "mode", "name": "standard"}], "identifiers": "the value of the variable \"rougail.var\".", "help": ["This family builds families dynamically."]}, "children": {"var": {"paths": ["rougail.my_dyn_family_val1.var", "rougail.my_dyn_family_val2.var"], "names": ["var", "var"], "type": "variable", "default": "the value of the identifier.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}], "descriptions": ["A variable inside a dynamic family."]}}}, "var2": {"type": "variable", "default": "depends on a calculation.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var2"], "names": ["var2"], "descriptions": ["A variable."], "multiple": true}}}} \ No newline at end of file diff --git a/tests/docs/base/60_5family_dynamic_variable_outside_jinja.md b/tests/docs/base/60_5family_dynamic_variable_outside_jinja.md index 4db4b50..9a81b8b 100644 --- a/tests/docs/base/60_5family_dynamic_variable_outside_jinja.md +++ b/tests/docs/base/60_5family_dynamic_variable_outside_jinja.md @@ -31,7 +31,7 @@ var2: var: variable: rougail.my_dyn_family_{{ identifier }}.var ``` -# Variables for "rougail" +# Variables for "Rougail" | Variable                                                                                                                       | Description                                                                                                                    | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| @@ -41,17 +41,15 @@ var2: `standard` - This family builds families dynamically. **Identifiers**: the value of the variable "rougail.var". | Variable                                                                                                                       | Description                                                                                                                    | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.my_dyn_family_val1.var** or **rougail.my_dyn_family_val2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A variable inside a dynamic family.
**Default**: the value of the identifier. | +| **rougail.my_dyn_family_*val1*.var**
**rougail.my_dyn_family_*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A variable inside a dynamic family.
**Default**: the value of the identifier. | | Variable                                                                                                                       | Description                                                                                                                    | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A variable.
**Default**: depends on a calculation. | - diff --git a/tests/docs/base/60_5family_dynamic_variable_outside_suffix.adoc b/tests/docs/base/60_5family_dynamic_variable_outside_suffix.adoc index 604df18..5801584 100644 --- a/tests/docs/base/60_5family_dynamic_variable_outside_suffix.adoc +++ b/tests/docs/base/60_5family_dynamic_variable_outside_suffix.adoc @@ -20,48 +20,50 @@ var2: default: variable: _.dyn_val1.var ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | A suffix variable. + **Default**: * val1 -* val2 +* val2 |==== === a dynamic family `standard` - This family builds families dynamically. **Identifiers**: the value of the variable "rougail.var". [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | -**rougail.dyn_val1.var** or **rougail.dyn_val2.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | + +**rougail.dyn___val1__.var** + +**rougail.dyn___val2__.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A variable inside dynamic family. + -**Default**: the value of the identifier. +**Default**: the value of the identifier. |==== [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A variable. + -**Default**: the value of the variable "rougail.dyn_val1.var". +**Default**: the value of the variable "rougail.dyn_val1.var". |==== - diff --git a/tests/docs/base/60_5family_dynamic_variable_outside_suffix.json b/tests/docs/base/60_5family_dynamic_variable_outside_suffix.json new file mode 100644 index 0000000..f6e7e53 --- /dev/null +++ b/tests/docs/base/60_5family_dynamic_variable_outside_suffix.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"var": {"type": "variable", "default": ["val1", "val2"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var"], "names": ["var"], "descriptions": ["A suffix variable."], "multiple": true}, "dyn_{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["rougail.dyn_val1", "rougail.dyn_val2"], "names": ["dyn_val1", "dyn_val2"], "description": "a dynamic family", "properties": [{"type": "mode", "name": "standard"}], "identifiers": "the value of the variable \"rougail.var\".", "help": ["This family builds families dynamically."]}, "children": {"var": {"paths": ["rougail.dyn_val1.var", "rougail.dyn_val2.var"], "names": ["var", "var"], "type": "variable", "default": "the value of the identifier.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "descriptions": ["A variable inside dynamic family."]}}}, "var2": {"type": "variable", "default": "the value of the variable \"rougail.dyn_val1.var\".", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.var2"], "names": ["var2"], "descriptions": ["A variable."]}}}} \ No newline at end of file diff --git a/tests/docs/base/60_5family_dynamic_variable_outside_suffix.md b/tests/docs/base/60_5family_dynamic_variable_outside_suffix.md index 024385c..735d775 100644 --- a/tests/docs/base/60_5family_dynamic_variable_outside_suffix.md +++ b/tests/docs/base/60_5family_dynamic_variable_outside_suffix.md @@ -23,27 +23,25 @@ var2: default: variable: _.dyn_val1.var ``` -# Variables for "rougail" +# Variables for "Rougail" -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A suffix variable.
**Default**:
- val1
- val2 | +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A suffix variable.
**Default**:
- val1
- val2 | ## a dynamic family `standard` - This family builds families dynamically. **Identifiers**: the value of the variable "rougail.var". -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.dyn_val1.var** or **rougail.dyn_val2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable inside dynamic family.
**Default**: the value of the identifier. | - -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: the value of the variable "rougail.dyn_val1.var". | +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dyn_*val1*.var**
**rougail.dyn_*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable inside dynamic family.
**Default**: the value of the identifier. | +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: the value of the variable "rougail.dyn_val1.var". | diff --git a/tests/docs/base/60_6family_dynamic_inside.adoc b/tests/docs/base/60_6family_dynamic_inside.adoc index 1757fbd..e3cb4da 100644 --- a/tests/docs/base/60_6family_dynamic_inside.adoc +++ b/tests/docs/base/60_6family_dynamic_inside.adoc @@ -29,53 +29,66 @@ var: # a suffix variable default: variable: rougail.val1_dyn.var1 ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | A suffix variable. + **Default**: * val1 -* val2 +* val2 |==== === a dynamic family `standard` - This family builds families dynamically. **Identifiers**: the value of the variable "rougail.var". [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | -**rougail.val1_dyn.var1** or **rougail.val2_dyn.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | + +**rougail.__val1___dyn.var1** + +**rougail.__val2___dyn.var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | Value is suffix. + -**Default**: the value of the identifier. +**Default**: the value of the identifier. | -**rougail.val1_dyn.var2** or **rougail.val2_dyn.var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | + +**rougail.__val1___dyn.var2** + +**rougail.__val2___dyn.var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | Value is first variable. + -**Default**: the value of the variable "rougail.{{ identifier }}_dyn.var1". +**Default**: + +* the value of the variable "rougail.__val1___dyn.var1" +* the value of the variable "rougail.__val2___dyn.var1" | -**rougail.val1_dyn.var3** or **rougail.val2_dyn.var3** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | + +**rougail.__val1___dyn.var3** + +**rougail.__val2___dyn.var3** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | Value is relative first variable. + -**Default**: the value of the variable "rougail.{{ identifier }}_dyn.var1". +**Default**: + +* the value of the variable "rougail.__val1___dyn.var1" +* the value of the variable "rougail.__val2___dyn.var1" | -**rougail.val1_dyn.var4** or **rougail.val2_dyn.var4** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | + +**rougail.__val1___dyn.var4** + +**rougail.__val2___dyn.var4** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | Value is first variable of val1. + -**Default**: the value of the variable "rougail.val1_dyn.var1". +**Default**: the value of the variable "rougail.val1_dyn.var1". |==== - diff --git a/tests/docs/base/60_6family_dynamic_inside.json b/tests/docs/base/60_6family_dynamic_inside.json new file mode 100644 index 0000000..29dc84b --- /dev/null +++ b/tests/docs/base/60_6family_dynamic_inside.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"var": {"type": "variable", "default": ["val1", "val2"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var"], "names": ["var"], "descriptions": ["A suffix variable."], "multiple": true}, "{{ identifier }}_dyn": {"type": "dynamic", "informations": {"paths": ["rougail.val1_dyn", "rougail.val2_dyn"], "names": ["val1_dyn", "val2_dyn"], "description": "a dynamic family", "properties": [{"type": "mode", "name": "standard"}], "identifiers": "the value of the variable \"rougail.var\".", "help": ["This family builds families dynamically."]}, "children": {"var1": {"paths": ["rougail.val1_dyn.var1", "rougail.val2_dyn.var1"], "names": ["var1", "var1"], "type": "variable", "default": "the value of the identifier.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "descriptions": ["Value is suffix."]}, "var2": {"paths": ["rougail.val1_dyn.var2", "rougail.val2_dyn.var2"], "names": ["var2", "var2"], "type": "variable", "default": ["the value of the variable \"rougail.val1_dyn.var1\"", "the value of the variable \"rougail.val2_dyn.var1\""], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "descriptions": ["Value is first variable."]}, "var3": {"paths": ["rougail.val1_dyn.var3", "rougail.val2_dyn.var3"], "names": ["var3", "var3"], "type": "variable", "default": ["the value of the variable \"rougail.val1_dyn.var1\"", "the value of the variable \"rougail.val2_dyn.var1\""], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "descriptions": ["Value is relative first variable."]}, "var4": {"paths": ["rougail.val1_dyn.var4", "rougail.val2_dyn.var4"], "names": ["var4", "var4"], "type": "variable", "default": "the value of the variable \"rougail.val1_dyn.var1\".", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "descriptions": ["Value is first variable of val1."]}}}}}} \ No newline at end of file diff --git a/tests/docs/base/60_6family_dynamic_inside.md b/tests/docs/base/60_6family_dynamic_inside.md index 6b815ec..97a0e8e 100644 --- a/tests/docs/base/60_6family_dynamic_inside.md +++ b/tests/docs/base/60_6family_dynamic_inside.md @@ -32,26 +32,24 @@ var: # a suffix variable default: variable: rougail.val1_dyn.var1 ``` -# Variables for "rougail" +# Variables for "Rougail" -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A suffix variable.
**Default**:
- val1
- val2 | +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A suffix variable.
**Default**:
- val1
- val2 | ## a dynamic family `standard` - This family builds families dynamically. **Identifiers**: the value of the variable "rougail.var". -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.val1_dyn.var1** or **rougail.val2_dyn.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Value is suffix.
**Default**: the value of the identifier. | -| **rougail.val1_dyn.var2** or **rougail.val2_dyn.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Value is first variable.
**Default**: the value of the variable "rougail.{{ identifier }}_dyn.var1". | -| **rougail.val1_dyn.var3** or **rougail.val2_dyn.var3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Value is relative first variable.
**Default**: the value of the variable "rougail.{{ identifier }}_dyn.var1". | -| **rougail.val1_dyn.var4** or **rougail.val2_dyn.var4**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Value is first variable of val1.
**Default**: the value of the variable "rougail.val1_dyn.var1". | - +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.*val1*_dyn.var1**
**rougail.*val2*_dyn.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Value is suffix.
**Default**: the value of the identifier. | +| **rougail.*val1*_dyn.var2**
**rougail.*val2*_dyn.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Value is first variable.
**Default**:
- the value of the variable "rougail.*val1*_dyn.var1"
- the value of the variable "rougail.*val2*_dyn.var1" | +| **rougail.*val1*_dyn.var3**
**rougail.*val2*_dyn.var3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Value is relative first variable.
**Default**:
- the value of the variable "rougail.*val1*_dyn.var1"
- the value of the variable "rougail.*val2*_dyn.var1" | +| **rougail.*val1*_dyn.var4**
**rougail.*val2*_dyn.var4**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Value is first variable of val1.
**Default**: the value of the variable "rougail.val1_dyn.var1". | diff --git a/tests/docs/base/60_6family_dynamic_leadership.adoc b/tests/docs/base/60_6family_dynamic_leadership.adoc index 93b8edd..624f2fe 100644 --- a/tests/docs/base/60_6family_dynamic_leadership.adoc +++ b/tests/docs/base/60_6family_dynamic_leadership.adoc @@ -24,26 +24,26 @@ dyn{{ identifier }}: description: a follower2 mandatory: false ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | A suffix variable. + **Default**: * val1 -* val2 +* val2 |==== === a dynamic family `basic` - This family builds families dynamically. **Identifiers**: the value of the variable "rougail.var". @@ -52,24 +52,28 @@ This family builds families dynamically. `basic` - This family contains lists of variable blocks. [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | -**rougail.dynval1.leadership.leader** or **rougail.dynval2.leadership.leader** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | -A leader. + +**rougail.dyn__val1__.leadership.leader** + +**rougail.dyn__val2__.leadership.leader** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | +A leader. | -**rougail.dynval1.leadership.follower1** or **rougail.dynval2.leadership.follower1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | -A follower1. + +**rougail.dyn__val1__.leadership.follower1** + +**rougail.dyn__val2__.leadership.follower1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | +A follower1. | -**rougail.dynval1.leadership.follower2** or **rougail.dynval2.leadership.follower2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | -A follower2. + +**rougail.dyn__val1__.leadership.follower2** + +**rougail.dyn__val2__.leadership.follower2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | +A follower2. |==== - diff --git a/tests/docs/base/60_6family_dynamic_leadership.json b/tests/docs/base/60_6family_dynamic_leadership.json new file mode 100644 index 0000000..87c318c --- /dev/null +++ b/tests/docs/base/60_6family_dynamic_leadership.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"var": {"type": "variable", "default": ["val1", "val2"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var"], "names": ["var"], "descriptions": ["A suffix variable."], "multiple": true}, "dyn{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["rougail.dynval1", "rougail.dynval2"], "names": ["dynval1", "dynval2"], "description": "a dynamic family", "properties": [{"type": "mode", "name": "basic"}], "identifiers": "the value of the variable \"rougail.var\".", "help": ["This family builds families dynamically."]}, "children": {"leadership": {"type": "leadership", "informations": {"paths": ["rougail.dynval1.leadership", "rougail.dynval2.leadership"], "names": ["leadership", "leadership"], "description": "a leadership", "properties": [{"type": "mode", "name": "basic"}], "help": ["This family contains lists of variable blocks."]}, "children": {"leader": {"paths": ["rougail.dynval1.leadership.leader", "rougail.dynval2.leadership.leader"], "names": ["leader", "leader"], "type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "descriptions": ["A leader."], "multiple": true}, "follower1": {"paths": ["rougail.dynval1.leadership.follower1", "rougail.dynval2.leadership.follower1"], "names": ["follower1", "follower1"], "type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}], "descriptions": ["A follower1."]}, "follower2": {"paths": ["rougail.dynval1.leadership.follower2", "rougail.dynval2.leadership.follower2"], "names": ["follower2", "follower2"], "type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}], "descriptions": ["A follower2."]}}}}}}}} \ No newline at end of file diff --git a/tests/docs/base/60_6family_dynamic_leadership.md b/tests/docs/base/60_6family_dynamic_leadership.md index ac250f1..a053122 100644 --- a/tests/docs/base/60_6family_dynamic_leadership.md +++ b/tests/docs/base/60_6family_dynamic_leadership.md @@ -27,17 +27,16 @@ dyn{{ identifier }}: description: a follower2 mandatory: false ``` -# Variables for "rougail" +# Variables for "Rougail" -| Variable                                                                                       | Description                                                                                    | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A suffix variable.
**Default**:
- val1
- val2 | +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A suffix variable.
**Default**:
- val1
- val2 | ## a dynamic family `basic` - This family builds families dynamically. **Identifiers**: the value of the variable "rougail.var". @@ -46,13 +45,11 @@ This family builds families dynamically. `basic` - This family contains lists of variable blocks. -| Variable                                                                                       | Description                                                                                    | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.dynval1.leadership.leader** or **rougail.dynval2.leadership.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | A leader. | -| **rougail.dynval1.leadership.follower1** or **rougail.dynval2.leadership.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A follower1. | -| **rougail.dynval1.leadership.follower2** or **rougail.dynval2.leadership.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A follower2. | - +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dyn*val1*.leadership.leader**
**rougail.dyn*val2*.leadership.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | A leader. | +| **rougail.dyn*val1*.leadership.follower1**
**rougail.dyn*val2*.leadership.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A follower1. | +| **rougail.dyn*val1*.leadership.follower2**
**rougail.dyn*val2*.leadership.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A follower2. | diff --git a/tests/docs/base/60_6family_dynamic_sub_dynamic.adoc b/tests/docs/base/60_6family_dynamic_sub_dynamic.adoc index 17547bd..848f769 100644 --- a/tests/docs/base/60_6family_dynamic_sub_dynamic.adoc +++ b/tests/docs/base/60_6family_dynamic_sub_dynamic.adoc @@ -47,67 +47,82 @@ dyn{{ identifier }}: identifier: 1 description: join identifier 1 et identifier 2 ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | A identifier variable. + **Default**: * val1 -* val2 +* val2 |==== === A dynamic family `standard` - This family builds families dynamically. **Identifiers**: the value of the variable "rougail.var". [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | -**rougail.dynval1.var** or **rougail.dynval2.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | + +**rougail.dyn__val1__.var** + +**rougail.dyn__val2__.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | A dynamic variable. + -**Default**: add 't' to each var value. +**Default**: add 't' to each var value. |==== ==== a Second dynamic variable `standard` - This family builds families dynamically. -**Identifiers**: the value of the variable "rougail.dyn{{ identifier }}.var". +**Identifiers**: + +* the value of the variable "rougail.dyn__val1__.var" +* the value of the variable "rougail.dyn__val2__.var" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | -**rougail.dynval1.dyn_tval1.var**, **rougail.dynval1.dyn_tval2.var**, **rougail.dynval2.dyn_tval1.var** or **rougail.dynval2.dyn_tval2.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | + +**rougail.dyn__val1__.dyn___tval1__.var** + +**rougail.dyn__val1__.dyn___tval2__.var** + +**rougail.dyn__val2__.dyn___tval1__.var** + +**rougail.dyn__val2__.dyn___tval2__.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A variable dynamic. + -**Default**: the value of the identifier. +**Default**: the value of the identifier. | -**rougail.dynval1.dyn_tval1.var_identifier**, **rougail.dynval1.dyn_tval2.var_identifier**, **rougail.dynval2.dyn_tval1.var_identifier** or **rougail.dynval2.dyn_tval2.var_identifier** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | + +**rougail.dyn__val1__.dyn___tval1__.var_identifier** + +**rougail.dyn__val1__.dyn___tval2__.var_identifier** + +**rougail.dyn__val2__.dyn___tval1__.var_identifier** + +**rougail.dyn__val2__.dyn___tval2__.var_identifier** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | Identifier from first family. + -**Default**: the value of the identifier. +**Default**: the value of the identifier. | -**rougail.dynval1.dyn_tval1.var_identifiers**, **rougail.dynval1.dyn_tval2.var_identifiers**, **rougail.dynval2.dyn_tval1.var_identifiers** or **rougail.dynval2.dyn_tval2.var_identifiers** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | + +**rougail.dyn__val1__.dyn___tval1__.var_identifiers** + +**rougail.dyn__val1__.dyn___tval2__.var_identifiers** + +**rougail.dyn__val2__.dyn___tval1__.var_identifiers** + +**rougail.dyn__val2__.dyn___tval2__.var_identifiers** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | Merge identifiers. + -**Default**: join identifier 1 et identifier 2. +**Default**: join identifier 1 et identifier 2. |==== - diff --git a/tests/docs/base/60_6family_dynamic_sub_dynamic.json b/tests/docs/base/60_6family_dynamic_sub_dynamic.json new file mode 100644 index 0000000..ceb52a7 --- /dev/null +++ b/tests/docs/base/60_6family_dynamic_sub_dynamic.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"var": {"type": "variable", "default": ["val1", "val2"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var"], "names": ["var"], "descriptions": ["A identifier variable."], "multiple": true}, "dyn{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["rougail.dynval1", "rougail.dynval2"], "names": ["dynval1", "dynval2"], "description": "A dynamic family", "properties": [{"type": "mode", "name": "standard"}], "identifiers": "the value of the variable \"rougail.var\".", "help": ["This family builds families dynamically."]}, "children": {"var": {"paths": ["rougail.dynval1.var", "rougail.dynval2.var"], "names": ["var", "var"], "type": "variable", "default": "add 't' to each var value.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "descriptions": ["A dynamic variable."], "multiple": true}, "dyn_{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["rougail.dynval1.dyn_tval1", "rougail.dynval1.dyn_tval2", "rougail.dynval2.dyn_tval1", "rougail.dynval2.dyn_tval2"], "names": ["dyn_tval1", "dyn_tval2", "dyn_tval1", "dyn_tval2"], "description": "a Second dynamic variable", "properties": [{"type": "mode", "name": "standard"}], "identifiers": ["the value of the variable \"rougail.dynval1.var\"", "the value of the variable \"rougail.dynval2.var\""], "help": ["This family builds families dynamically."]}, "children": {"var": {"paths": ["rougail.dynval1.dyn_tval1.var", "rougail.dynval1.dyn_tval2.var", "rougail.dynval2.dyn_tval1.var", "rougail.dynval2.dyn_tval2.var"], "names": ["var", "var", "var", "var"], "type": "variable", "default": "the value of the identifier.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "descriptions": ["A variable dynamic."]}, "var_identifier": {"paths": ["rougail.dynval1.dyn_tval1.var_identifier", "rougail.dynval1.dyn_tval2.var_identifier", "rougail.dynval2.dyn_tval1.var_identifier", "rougail.dynval2.dyn_tval2.var_identifier"], "names": ["var_identifier", "var_identifier", "var_identifier", "var_identifier"], "type": "variable", "default": "the value of the identifier.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "descriptions": ["Identifier from first family."]}, "var_identifiers": {"paths": ["rougail.dynval1.dyn_tval1.var_identifiers", "rougail.dynval1.dyn_tval2.var_identifiers", "rougail.dynval2.dyn_tval1.var_identifiers", "rougail.dynval2.dyn_tval2.var_identifiers"], "names": ["var_identifiers", "var_identifiers", "var_identifiers", "var_identifiers"], "type": "variable", "default": "join identifier 1 et identifier 2.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "descriptions": ["Merge identifiers."]}}}}}}}} \ No newline at end of file diff --git a/tests/docs/base/60_6family_dynamic_sub_dynamic.md b/tests/docs/base/60_6family_dynamic_sub_dynamic.md index dd92f3e..7d972ec 100644 --- a/tests/docs/base/60_6family_dynamic_sub_dynamic.md +++ b/tests/docs/base/60_6family_dynamic_sub_dynamic.md @@ -50,38 +50,35 @@ dyn{{ identifier }}: identifier: 1 description: join identifier 1 et identifier 2 ``` -# Variables for "rougail" +# Variables for "Rougail" -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A identifier variable.
**Default**:
- val1
- val2 | +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A identifier variable.
**Default**:
- val1
- val2 | ## A dynamic family `standard` - This family builds families dynamically. **Identifiers**: the value of the variable "rougail.var". -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.dynval1.var** or **rougail.dynval2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A dynamic variable.
**Default**: add 't' to each var value. | +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dyn*val1*.var**
**rougail.dyn*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A dynamic variable.
**Default**: add 't' to each var value. | ### a Second dynamic variable `standard` - This family builds families dynamically. -**Identifiers**: the value of the variable "rougail.dyn{{ identifier }}.var". - -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.dynval1.dyn_tval1.var**, **rougail.dynval1.dyn_tval2.var**, **rougail.dynval2.dyn_tval1.var** or **rougail.dynval2.dyn_tval2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable dynamic.
**Default**: the value of the identifier. | -| **rougail.dynval1.dyn_tval1.var_identifier**, **rougail.dynval1.dyn_tval2.var_identifier**, **rougail.dynval2.dyn_tval1.var_identifier** or **rougail.dynval2.dyn_tval2.var_identifier**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Identifier from first family.
**Default**: the value of the identifier. | -| **rougail.dynval1.dyn_tval1.var_identifiers**, **rougail.dynval1.dyn_tval2.var_identifiers**, **rougail.dynval2.dyn_tval1.var_identifiers** or **rougail.dynval2.dyn_tval2.var_identifiers**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Merge identifiers.
**Default**: join identifier 1 et identifier 2. | +**Identifiers**:
- the value of the variable "rougail.dyn*val1*.var"
- the value of the variable "rougail.dyn*val2*.var" +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dyn*val1*.dyn_*tval1*.var**
**rougail.dyn*val1*.dyn_*tval2*.var**
**rougail.dyn*val2*.dyn_*tval1*.var**
**rougail.dyn*val2*.dyn_*tval2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable dynamic.
**Default**: the value of the identifier. | +| **rougail.dyn*val1*.dyn_*tval1*.var_identifier**
**rougail.dyn*val1*.dyn_*tval2*.var_identifier**
**rougail.dyn*val2*.dyn_*tval1*.var_identifier**
**rougail.dyn*val2*.dyn_*tval2*.var_identifier**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Identifier from first family.
**Default**: the value of the identifier. | +| **rougail.dyn*val1*.dyn_*tval1*.var_identifiers**
**rougail.dyn*val1*.dyn_*tval2*.var_identifiers**
**rougail.dyn*val2*.dyn_*tval1*.var_identifiers**
**rougail.dyn*val2*.dyn_*tval2*.var_identifiers**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Merge identifiers.
**Default**: join identifier 1 et identifier 2. | diff --git a/tests/docs/base/60_9extra_dynamic.adoc b/tests/docs/base/60_9extra_dynamic.adoc index ec38e55..dd2f993 100644 --- a/tests/docs/base/60_9extra_dynamic.adoc +++ b/tests/docs/base/60_9extra_dynamic.adoc @@ -18,39 +18,36 @@ dyn_{{ identifier }}: variable: rougail.var var: ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | A variable. + -**Default**: - -* a +**Default**: a |==== - == Variables for "extra" -=== "dyn__a_" +=== extra.dyn___a__ `basic` - This family builds families dynamically. **Identifiers**: the value of the variable "rougail.var". [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | -**extra.dyn_a.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -Var. + +**extra.dyn___a__.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +Var. |==== - diff --git a/tests/docs/base/60_9extra_dynamic.json b/tests/docs/base/60_9extra_dynamic.json new file mode 100644 index 0000000..0a3679a --- /dev/null +++ b/tests/docs/base/60_9extra_dynamic.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"var": {"type": "variable", "default": ["a"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var"], "names": ["var"], "descriptions": ["A variable."], "multiple": true}}}, "extra": {"type": "namespace", "informations": {"paths": ["extra"], "names": ["extra"], "properties": [{"type": "mode", "name": "basic"}]}, "children": {"dyn_{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["extra.dyn_a"], "names": ["dyn_a"], "properties": [{"type": "mode", "name": "basic"}], "identifiers": "the value of the variable \"rougail.var\".", "help": ["This family builds families dynamically."]}, "children": {"var": {"paths": ["extra.dyn_a.var"], "names": ["var"], "type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}]}}}}}} \ No newline at end of file diff --git a/tests/docs/base/60_9extra_dynamic.md b/tests/docs/base/60_9extra_dynamic.md index 6cb8160..90535db 100644 --- a/tests/docs/base/60_9extra_dynamic.md +++ b/tests/docs/base/60_9extra_dynamic.md @@ -20,26 +20,23 @@ dyn_{{ identifier }}: variable: rougail.var var: ``` -# Variables for "rougail" +# Variables for "Rougail" | Variable                                                                                                                       | Description                                                                                                                    | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A variable.
**Default**:
- a | - +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A variable.
**Default**: a | # Variables for "extra" -## "dyn_*a*" +## extra.dyn_*a* `basic` - This family builds families dynamically. **Identifiers**: the value of the variable "rougail.var". -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **extra.dyn_a.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | Var. | - +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **extra.dyn_*a*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | Var. | diff --git a/tests/docs/base/60_9extra_dynamic_extra.adoc b/tests/docs/base/60_9extra_dynamic_extra.adoc index 7d5511a..9a60a17 100644 --- a/tests/docs/base/60_9extra_dynamic_extra.adoc +++ b/tests/docs/base/60_9extra_dynamic_extra.adoc @@ -26,7 +26,7 @@ dyn_{{ identifier }}: variable: _.var var: ---- -== Variables for "rougail" +== Variables for "Rougail" === général @@ -34,47 +34,43 @@ dyn_{{ identifier }}: [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.general.varname** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | No change. + -**Default**: - -* a +**Default**: a |==== - == Variables for "extra" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | -**extra.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | -A varaible. + -**Default**: -* a +**extra.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +A varaible. + +**Default**: a |==== -=== "dyn__a_" +=== extra.dyn___a__ `basic` - This family builds families dynamically. **Identifiers**: the value of the variable "extra.var". [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | -**extra.dyn_a.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -Var. + +**extra.dyn___a__.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +Var. |==== - diff --git a/tests/docs/base/60_9extra_dynamic_extra.json b/tests/docs/base/60_9extra_dynamic_extra.json new file mode 100644 index 0000000..115c304 --- /dev/null +++ b/tests/docs/base/60_9extra_dynamic_extra.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"general": {"type": "family", "informations": {"paths": ["rougail.general"], "names": ["general"], "description": "général", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"varname": {"type": "variable", "default": ["a"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.general.varname"], "names": ["varname"], "descriptions": ["No change."], "multiple": true}}}}}, "extra": {"type": "namespace", "informations": {"paths": ["extra"], "names": ["extra"], "properties": [{"type": "mode", "name": "basic"}]}, "children": {"var": {"type": "variable", "default": ["a"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["extra.var"], "names": ["var"], "descriptions": ["A varaible."], "multiple": true}, "dyn_{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["extra.dyn_a"], "names": ["dyn_a"], "properties": [{"type": "mode", "name": "basic"}], "identifiers": "the value of the variable \"extra.var\".", "help": ["This family builds families dynamically."]}, "children": {"var": {"paths": ["extra.dyn_a.var"], "names": ["var"], "type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}]}}}}}} \ No newline at end of file diff --git a/tests/docs/base/60_9extra_dynamic_extra.md b/tests/docs/base/60_9extra_dynamic_extra.md index 53a268b..7be5f77 100644 --- a/tests/docs/base/60_9extra_dynamic_extra.md +++ b/tests/docs/base/60_9extra_dynamic_extra.md @@ -28,7 +28,7 @@ dyn_{{ identifier }}: variable: _.var var: ``` -# Variables for "rougail" +# Variables for "Rougail" ## général @@ -36,26 +36,23 @@ dyn_{{ identifier }}: | Variable                                                                                                                       | Description                                                                                                                    | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.general.varname**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | No change.
**Default**:
- a | - +| **rougail.general.varname**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | No change.
**Default**: a | # Variables for "extra" -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **extra.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A varaible.
**Default**:
- a | +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **extra.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A varaible.
**Default**: a | -## "dyn_*a*" +## extra.dyn_*a* `basic` - This family builds families dynamically. **Identifiers**: the value of the variable "extra.var". -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **extra.dyn_a.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | Var. | - +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **extra.dyn_*a*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | Var. | diff --git a/tests/docs/base/60_9family_dynamic_calc_both.adoc b/tests/docs/base/60_9family_dynamic_calc_both.adoc index ff3e9e5..e6ab818 100644 --- a/tests/docs/base/60_9family_dynamic_calc_both.adoc +++ b/tests/docs/base/60_9family_dynamic_calc_both.adoc @@ -12,23 +12,23 @@ dyn{{ identifier }}: - variable: _.var vardyn: # a dynamic variable ---- -== Variables for "rougail" +== Variables for "Rougail" [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A suffix variable. + -**Default**: val2 +**Default**: val2 |==== === a dynamic family `basic` - This family builds families dynamically. **Identifiers**: @@ -38,11 +38,12 @@ This family builds families dynamically. [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | -**rougail.dynval1.vardyn** or **rougail.dynval2.vardyn** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A dynamic variable. + +**rougail.dyn__val1__.vardyn** + +**rougail.dyn__val2__.vardyn** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A dynamic variable. |==== - diff --git a/tests/docs/base/60_9family_dynamic_calc_both.json b/tests/docs/base/60_9family_dynamic_calc_both.json new file mode 100644 index 0000000..47c9b35 --- /dev/null +++ b/tests/docs/base/60_9family_dynamic_calc_both.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"var": {"type": "variable", "default": "val2", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.var"], "names": ["var"], "descriptions": ["A suffix variable."]}, "dyn{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["rougail.dynval1", "rougail.dynval2"], "names": ["dynval1", "dynval2"], "description": "a dynamic family", "properties": [{"type": "mode", "name": "basic"}], "identifiers": ["val1", "the value of the variable \"rougail.var\"."], "help": ["This family builds families dynamically."]}, "children": {"vardyn": {"paths": ["rougail.dynval1.vardyn", "rougail.dynval2.vardyn"], "names": ["vardyn", "vardyn"], "type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "descriptions": ["A dynamic variable."]}}}}}} \ No newline at end of file diff --git a/tests/docs/base/60_9family_dynamic_calc_both.md b/tests/docs/base/60_9family_dynamic_calc_both.md index 67f9fa2..e7ae3d2 100644 --- a/tests/docs/base/60_9family_dynamic_calc_both.md +++ b/tests/docs/base/60_9family_dynamic_calc_both.md @@ -15,23 +15,21 @@ dyn{{ identifier }}: - variable: _.var vardyn: # a dynamic variable ``` -# Variables for "rougail" +# Variables for "Rougail" -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A suffix variable.
**Default**: val2 | +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A suffix variable.
**Default**: val2 | ## a dynamic family `basic` - This family builds families dynamically. **Identifiers**:
- val1
- the value of the variable "rougail.var". -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.dynval1.vardyn** or **rougail.dynval2.vardyn**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A dynamic variable. | - +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dyn*val1*.vardyn**
**rougail.dyn*val2*.vardyn**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A dynamic variable. | diff --git a/tests/docs/base/68_0family_leadership_mode.adoc b/tests/docs/base/68_0family_leadership_mode.adoc index 5d6ffb0..266217d 100644 --- a/tests/docs/base/68_0family_leadership_mode.adoc +++ b/tests/docs/base/68_0family_leadership_mode.adoc @@ -18,30 +18,31 @@ leader: description: a follower2 mode: basic ---- -== Variables for "rougail" +== Variables for "Rougail" === A leadership `basic` - This family contains lists of variable blocks. [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **rougail.leader.leader** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `unique` `multiple` | -A leader. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `unique` `multiple` | +A leader. | + **rougail.leader.follower1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | -A follower1. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | +A follower1. | + **rougail.leader.follower2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A follower2. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A follower2. |==== - diff --git a/tests/docs/base/68_0family_leadership_mode.json b/tests/docs/base/68_0family_leadership_mode.json new file mode 100644 index 0000000..7ca00f9 --- /dev/null +++ b/tests/docs/base/68_0family_leadership_mode.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"leader": {"type": "leadership", "informations": {"paths": ["rougail.leader"], "names": ["leader"], "description": "A leadership", "properties": [{"type": "mode", "name": "basic"}], "help": ["This family contains lists of variable blocks."]}, "children": {"leader": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.leader.leader"], "names": ["leader"], "descriptions": ["A leader."], "multiple": true}, "follower1": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}], "paths": ["rougail.leader.follower1"], "names": ["follower1"], "descriptions": ["A follower1."]}, "follower2": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.leader.follower2"], "names": ["follower2"], "descriptions": ["A follower2."]}}}}}} \ No newline at end of file diff --git a/tests/docs/base/68_0family_leadership_mode.md b/tests/docs/base/68_0family_leadership_mode.md index 85187ee..b7ddb54 100644 --- a/tests/docs/base/68_0family_leadership_mode.md +++ b/tests/docs/base/68_0family_leadership_mode.md @@ -21,19 +21,17 @@ leader: description: a follower2 mode: basic ``` -# Variables for "rougail" +# Variables for "Rougail" ## A leadership `basic` - This family contains lists of variable blocks. -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `unique` `multiple` | A leader. | -| **rougail.leader.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A follower1. | -| **rougail.leader.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A follower2. | - +| Variable                                                                                                        | Description                                                                                                     | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `unique` `multiple` | A leader. | +| **rougail.leader.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A follower1. | +| **rougail.leader.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A follower2. | diff --git a/tests/docs/examples/00_0empty.md b/tests/docs/examples/00_0empty.md new file mode 100644 index 0000000..3fc684d --- /dev/null +++ b/tests/docs/examples/00_0empty.md @@ -0,0 +1,4 @@ +--- +gitea: none +include_toc: true +--- diff --git a/tests/docs/examples/00_0version_underscore.md b/tests/docs/examples/00_0version_underscore.md new file mode 100644 index 0000000..d55fce6 --- /dev/null +++ b/tests/docs/examples/00_0version_underscore.md @@ -0,0 +1,25 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +_version: '1.1' +version: # a variable +``` +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + version: example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + version: example +``` diff --git a/tests/docs/examples/00_1empty_variable.md b/tests/docs/examples/00_1empty_variable.md new file mode 100644 index 0000000..402d176 --- /dev/null +++ b/tests/docs/examples/00_1empty_variable.md @@ -0,0 +1,25 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.0' +empty: +``` +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + empty: example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + empty: example +``` diff --git a/tests/docs/examples/00_2default_calculated.md b/tests/docs/examples/00_2default_calculated.md new file mode 100644 index 0000000..bca3616 --- /dev/null +++ b/tests/docs/examples/00_2default_calculated.md @@ -0,0 +1,27 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: 1.1 +var1: no # a first variable +var2: + description: a second variable + multi: true + default: + jinja: | + {{ _.var1 }} + description: the value of var1 +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var1: no + var2: + - no +``` diff --git a/tests/docs/examples/00_2default_calculated_multi.md b/tests/docs/examples/00_2default_calculated_multi.md new file mode 100644 index 0000000..9fc5240 --- /dev/null +++ b/tests/docs/examples/00_2default_calculated_multi.md @@ -0,0 +1,37 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: 1.1 +var1: # a first variable + - no + - yes + - maybe +var2: + description: a second variable + multi: true + default: + jinja: | + {% for val in _.var1 %} + {{ val }} + {% endfor %} + description: the value of _.var1 +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var1: + - no + - yes + - maybe + var2: + - no + - yes + - maybe +``` diff --git a/tests/docs/examples/00_2default_calculated_variable_transitive.md b/tests/docs/examples/00_2default_calculated_variable_transitive.md new file mode 100644 index 0000000..a23d591 --- /dev/null +++ b/tests/docs/examples/00_2default_calculated_variable_transitive.md @@ -0,0 +1,41 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: 1.1 + +var1: + description: a first variable + multi: true + type: domainname + params: + allow_ip: true + +var2: + description: a second variable + default: + type: variable + variable: _.var1 +``` +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + var1: + - example.net +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var1: + - example.net + var2: + - example.net +``` diff --git a/tests/docs/examples/00_4load_subfolder.md b/tests/docs/examples/00_4load_subfolder.md new file mode 100644 index 0000000..1457e00 --- /dev/null +++ b/tests/docs/examples/00_4load_subfolder.md @@ -0,0 +1,36 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/99-base.yml + +```yaml +--- +version: '1.0' +var1: + description: a variable +``` +# dictionaries/rougail2/00-base.yml + +```yaml +--- +version: '1.0' +var2: + description: a variable +``` +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + var1: example + var2: example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var1: example + var2: example +``` diff --git a/tests/docs/examples/00_5load_notype.md b/tests/docs/examples/00_5load_notype.md new file mode 100644 index 0000000..779026d --- /dev/null +++ b/tests/docs/examples/00_5load_notype.md @@ -0,0 +1,20 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.0' +without_type: + description: a variable + default: non +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + without_type: non +``` diff --git a/tests/docs/examples/00_6boolean.md b/tests/docs/examples/00_6boolean.md new file mode 100644 index 0000000..163dd34 --- /dev/null +++ b/tests/docs/examples/00_6boolean.md @@ -0,0 +1,38 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: true # the first variable +var2: + description: the second variable + default: true +var3: + description: the third variable + type: boolean + default: true +var4: false # the forth variable +var5: + description: the fifth variable + default: false +var6: + description: the sixth variable + type: boolean + default: false +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var1: true + var2: true + var3: true + var4: false + var5: false + var6: false +``` diff --git a/tests/docs/examples/00_6boolean_no_mandatory.md b/tests/docs/examples/00_6boolean_no_mandatory.md new file mode 100644 index 0000000..48a54d6 --- /dev/null +++ b/tests/docs/examples/00_6boolean_no_mandatory.md @@ -0,0 +1,21 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +variable: + description: a variable + type: boolean + mandatory: false +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + variable: true +``` diff --git a/tests/docs/examples/00_6choice.md b/tests/docs/examples/00_6choice.md new file mode 100644 index 0000000..0211298 --- /dev/null +++ b/tests/docs/examples/00_6choice.md @@ -0,0 +1,70 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: + description: the first variable + choices: + - a + - b + - c +var2: + description: the second variable + choices: + - a + - b + - c +var3: + description: the third variable + choices: + - a + - b + - c + mandatory: false +var4: + description: the forth variable + choices: + - + - b + - c + mandatory: false +var5: + description: the fifth variable + choices: + - a + - b + - c + default: a +var6: + description: the sixth variable + choices: + - 1 + - 2 + - 3 + default: 1 +``` +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + var1: a_choice + var2: a_choice +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var1: a_choice + var2: a_choice + var3: a_choice + var4: a_choice + var5: a + var6: 1 +``` diff --git a/tests/docs/examples/00_6choice_calculation.md b/tests/docs/examples/00_6choice_calculation.md new file mode 100644 index 0000000..eb3f613 --- /dev/null +++ b/tests/docs/examples/00_6choice_calculation.md @@ -0,0 +1,27 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: 1.1 +var: + description: a variable + default: 9 + choices: + jinja: | + {% for n in trange(0, 10) %} + {{ n }} + {% endfor %} + return_type: number + description: choices is 0 to 9 +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var: 9 +``` diff --git a/tests/docs/examples/00_6choice_variable.md b/tests/docs/examples/00_6choice_variable.md new file mode 100644 index 0000000..e995ab2 --- /dev/null +++ b/tests/docs/examples/00_6choice_variable.md @@ -0,0 +1,30 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: # a second variable + - a + - b + - c +var2: + description: a first variable + default: a + choices: + variable: _.var1 +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var1: + - a + - b + - c + var2: a +``` diff --git a/tests/docs/examples/00_6custom.md b/tests/docs/examples/00_6custom.md new file mode 100644 index 0000000..50980fa --- /dev/null +++ b/tests/docs/examples/00_6custom.md @@ -0,0 +1,32 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +custom1: + description: the first variable + type: custom +custom2: + description: the seconf variable + type: custom + default: value +``` +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + custom1: xxx +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + custom1: xxx + custom2: value +``` diff --git a/tests/docs/examples/00_6domainname.md b/tests/docs/examples/00_6domainname.md new file mode 100644 index 0000000..f56fd0e --- /dev/null +++ b/tests/docs/examples/00_6domainname.md @@ -0,0 +1,21 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +variable: + description: a domain name variable + type: domainname + default: my.domain.name +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + variable: my.domain.name +``` diff --git a/tests/docs/examples/00_6domainname_params.md b/tests/docs/examples/00_6domainname_params.md new file mode 100644 index 0000000..ff09fc8 --- /dev/null +++ b/tests/docs/examples/00_6domainname_params.md @@ -0,0 +1,23 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +variable: + description: a domain name variable + type: domainname + default: my.domain.name + params: + allow_ip: true +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + variable: my.domain.name +``` diff --git a/tests/docs/examples/00_6float.md b/tests/docs/examples/00_6float.md new file mode 100644 index 0000000..493ccd3 --- /dev/null +++ b/tests/docs/examples/00_6float.md @@ -0,0 +1,38 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: 0.0 # the first variable +var2: + description: the second variable + default: 0.0 +var3: + description: the third variable + type: float + default: 0.0 +var4: 10.1 # the forth variable +var5: + description: the fifth variable + default: 10.1 +var6: + description: the sixth variable + type: float + default: 10.1 +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var1: 0.0 + var2: 0.0 + var3: 0.0 + var4: 10.1 + var5: 10.1 + var6: 10.1 +``` diff --git a/tests/docs/examples/00_6number.md b/tests/docs/examples/00_6number.md new file mode 100644 index 0000000..beec238 --- /dev/null +++ b/tests/docs/examples/00_6number.md @@ -0,0 +1,38 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: 0 # the first variable +var2: + description: the second variable + default: 0 +var3: + description: the third variable + type: number + default: 0 +var4: 10 # this forth variable +var5: + description: the fifth variable + default: 10 +var6: + description: the sixth variable + type: number + default: 10 +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var1: 0 + var2: 0 + var3: 0 + var4: 10 + var5: 10 + var6: 10 +``` diff --git a/tests/docs/examples/00_6port.md b/tests/docs/examples/00_6port.md new file mode 100644 index 0000000..e074c18 --- /dev/null +++ b/tests/docs/examples/00_6port.md @@ -0,0 +1,37 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +variable1: + description: a port variable + type: port +variable2: + description: a port variable with default value + type: port + default: '8080' +variable3: + description: a port variable with integer default value + type: port + default: 8080 +``` +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + variable1: '111' +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + variable1: '111' + variable2: '8080' + variable3: '8080' +``` diff --git a/tests/docs/examples/00_6regexp.md b/tests/docs/examples/00_6regexp.md new file mode 100644 index 0000000..082ceb7 --- /dev/null +++ b/tests/docs/examples/00_6regexp.md @@ -0,0 +1,24 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: + description: a first variable + regexp: ^#(?:[0-9a-f]{3}){1,2}$ + default: '#a1a1a1' + test: + - '#b1b1b1' + - '#b2b2b2' +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var: '#b1b1b1' +``` diff --git a/tests/docs/examples/00_6string.md b/tests/docs/examples/00_6string.md new file mode 100644 index 0000000..a523d7a --- /dev/null +++ b/tests/docs/examples/00_6string.md @@ -0,0 +1,46 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: # the first variable +var2: + description: the second variable + default: +var3: + description: the third variable + type: string +var4: value # the forth variable +var5: + description: the fifth variable + default: value +var6: + description: the sixth variable + type: string + default: value +``` +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + var1: example + var2: example + var3: example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var1: example + var2: example + var3: example + var4: value + var5: value + var6: value +``` diff --git a/tests/docs/examples/00_7choice_quote.md b/tests/docs/examples/00_7choice_quote.md new file mode 100644 index 0000000..01f62dd --- /dev/null +++ b/tests/docs/examples/00_7choice_quote.md @@ -0,0 +1,25 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.0' +var: + type: choice + description: A choice + default: quote' + choices: + - quote' + - quote" + - quote"' +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var: quote' +``` diff --git a/tests/docs/examples/00_7help_quote.md b/tests/docs/examples/00_7help_quote.md new file mode 100644 index 0000000..d027c6c --- /dev/null +++ b/tests/docs/examples/00_7help_quote.md @@ -0,0 +1,32 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.0' +var1: + description: the first variable + help: message with ' +var2: + description: the second variable + help: message with " +``` +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + var1: example + var2: example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var1: example + var2: example +``` diff --git a/tests/docs/examples/00_7value_doublequote.md b/tests/docs/examples/00_7value_doublequote.md new file mode 100644 index 0000000..ab35271 --- /dev/null +++ b/tests/docs/examples/00_7value_doublequote.md @@ -0,0 +1,20 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +variable: + description: a variable + default: quote" +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + variable: quote" +``` diff --git a/tests/docs/examples/00_7value_doublequote2.md b/tests/docs/examples/00_7value_doublequote2.md new file mode 100644 index 0000000..1d6320a --- /dev/null +++ b/tests/docs/examples/00_7value_doublequote2.md @@ -0,0 +1,20 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +variable: + description: a variable + default: quote'" +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + variable: quote'" +``` diff --git a/tests/docs/examples/00_7value_doublequote3.md b/tests/docs/examples/00_7value_doublequote3.md new file mode 100644 index 0000000..3a5c7d5 --- /dev/null +++ b/tests/docs/examples/00_7value_doublequote3.md @@ -0,0 +1,21 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' + +variable: + description: a variable + default: quote\"\' +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + variable: quote\"\' +``` diff --git a/tests/docs/examples/00_7value_quote.md b/tests/docs/examples/00_7value_quote.md new file mode 100644 index 0000000..ac1a198 --- /dev/null +++ b/tests/docs/examples/00_7value_quote.md @@ -0,0 +1,20 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.0' +variable: + description: a variable + default: quote' +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + variable: quote' +``` diff --git a/tests/docs/examples/00_8calculation_information.md b/tests/docs/examples/00_8calculation_information.md new file mode 100644 index 0000000..aa6e1fc --- /dev/null +++ b/tests/docs/examples/00_8calculation_information.md @@ -0,0 +1,27 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +variable: + description: a variable + default: + jinja: | + {{test_information }} + params: + test_information: + type: information + information: test_information + description: get information test_information +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + variable: example +``` diff --git a/tests/docs/examples/00_8test.md b/tests/docs/examples/00_8test.md new file mode 100644 index 0000000..9fd111a --- /dev/null +++ b/tests/docs/examples/00_8test.md @@ -0,0 +1,73 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' + +var1: + description: the first variable + test: + - test + +var2: + description: the second variable + test: + - test + default: value + +var3: + description: the third variable + test: + - test1 + - test2 + +var4: + description: the forth variable + test: + - + - test1 + - test2 + mandatory: false + +var5: + description: the fifth variable + type: boolean + test: + - false + +var6: + description: the sixth variable + multi: true + test: + - test1 + - test2 +``` +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + var1: test + var3: test1 + var6: + - test1 + - test2 +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var1: test + var2: test + var3: test1 + var4: + var5: false + var6: + - test1 + - test2 +``` diff --git a/tests/docs/examples/00_9choice_variable_multi.md b/tests/docs/examples/00_9choice_variable_multi.md new file mode 100644 index 0000000..3ba39c1 --- /dev/null +++ b/tests/docs/examples/00_9choice_variable_multi.md @@ -0,0 +1,43 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +variable1: + description: a first variable + type: choice + multi: true + choices: + - val1 + - val2 +variable2: + description: a second variable + type: choice + multi: true + mandatory: false + choices: + - val1 + - val2 +``` +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + variable1: + - a_choice +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + variable1: + - a_choice + variable2: + - a_choice +``` diff --git a/tests/docs/examples/00_9choice_variables.md b/tests/docs/examples/00_9choice_variables.md new file mode 100644 index 0000000..8e1eb4a --- /dev/null +++ b/tests/docs/examples/00_9choice_variables.md @@ -0,0 +1,28 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +source_variable_1: val1 # the first source variable +source_variable_2: val2 # the second source variable +my_variable: + description: a variable + type: choice + choices: + - variable: _.source_variable_1 + - variable: _.source_variable_2 + default: val1 +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + source_variable_1: val1 + source_variable_2: val2 + my_variable: val1 +``` diff --git a/tests/docs/examples/00_9default_calculation.md b/tests/docs/examples/00_9default_calculation.md new file mode 100644 index 0000000..cac6e3b --- /dev/null +++ b/tests/docs/examples/00_9default_calculation.md @@ -0,0 +1,29 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' + +variable: + description: a variable + default: + jinja: | + {{ param1 }}_{{ param2 }}_{{ param3 }}_{{ param4 }} + params: + param1: string + param2: 1 + param3: true + param4: + description: concat all parameters +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + variable: string_1_True_None +``` diff --git a/tests/docs/examples/00_9default_calculation_information.md b/tests/docs/examples/00_9default_calculation_information.md new file mode 100644 index 0000000..b9189ab --- /dev/null +++ b/tests/docs/examples/00_9default_calculation_information.md @@ -0,0 +1,27 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: + description: a variable + default: + jinja: '{{ information }}' + params: + information: + type: information + information: test_information + variable: _.var + description: returns the information +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var: example +``` diff --git a/tests/docs/examples/00_9default_calculation_information_other_variable.md b/tests/docs/examples/00_9default_calculation_information_other_variable.md new file mode 100644 index 0000000..982b63a --- /dev/null +++ b/tests/docs/examples/00_9default_calculation_information_other_variable.md @@ -0,0 +1,36 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: # a first variable +var2: + description: a second variable + default: + jinja: | + {{ information }} + params: + information: + type: information + information: test_information + variable: _.var1 +``` +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + var1: example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var1: example + var2: example +``` diff --git a/tests/docs/examples/00_9default_calculation_multi_optional.md b/tests/docs/examples/00_9default_calculation_multi_optional.md new file mode 100644 index 0000000..8da2da3 --- /dev/null +++ b/tests/docs/examples/00_9default_calculation_multi_optional.md @@ -0,0 +1,28 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: 1.1 +my_variable: + default: val1 +my_calculated_variable: + multi: true + default: + - variable: _.my_variable + optional: true + - variable: _.my_variable_unexists + optional: true +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + my_variable: val1 + my_calculated_variable: + - val1 +``` diff --git a/tests/docs/examples/00_9default_calculation_multi_optional2.md b/tests/docs/examples/00_9default_calculation_multi_optional2.md new file mode 100644 index 0000000..429392f --- /dev/null +++ b/tests/docs/examples/00_9default_calculation_multi_optional2.md @@ -0,0 +1,28 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: 1.1 +my_variable: + default: val1 +my_calculated_variable: + multi: true + default: + - variable: _.my_variable_unexists + optional: true + - variable: _.my_variable + optional: true +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + my_variable: val1 + my_calculated_variable: + - val1 +``` diff --git a/tests/docs/examples/00_9default_calculation_optional.md b/tests/docs/examples/00_9default_calculation_optional.md new file mode 100644 index 0000000..21cc8a2 --- /dev/null +++ b/tests/docs/examples/00_9default_calculation_optional.md @@ -0,0 +1,31 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: 1.1 +my_calculated_variable: + multi: true + default: + variable: _.my_variable + optional: true +``` +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + my_calculated_variable: + - example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + my_calculated_variable: + - example +``` diff --git a/tests/docs/examples/00_9default_calculation_optional_exists.md b/tests/docs/examples/00_9default_calculation_optional_exists.md new file mode 100644 index 0000000..7148c21 --- /dev/null +++ b/tests/docs/examples/00_9default_calculation_optional_exists.md @@ -0,0 +1,32 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: 1.1 +my_variable: + multi: true + default: + - val1 + - val2 +my_calculated_variable: + multi: true + default: + variable: _.my_variable + optional: true +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + my_variable: + - val1 + - val2 + my_calculated_variable: + - val1 + - val2 +``` diff --git a/tests/docs/examples/00_9default_calculation_param_optional.md b/tests/docs/examples/00_9default_calculation_param_optional.md new file mode 100644 index 0000000..fcc5334 --- /dev/null +++ b/tests/docs/examples/00_9default_calculation_param_optional.md @@ -0,0 +1,36 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: + description: a first variable + default: + jinja: '{% if var2 is defined %} {{ var2 }} {% elif var3 is defined %} {{ var3 + }} {% elif var4 is defined %} {{ var4 }} {% else %} {{ _.var2 }} {% endif %} ' + params: + var2: + variable: _.var2 + optional: true + var3: + variable: _.var3 + optional: true + var4: + variable: _.unknown_family.var + optional: true + description: returns a value + mandatory: false +var2: no # a second variable +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var1: no + var2: no +``` diff --git a/tests/docs/examples/00_9default_information_other_variable.md b/tests/docs/examples/00_9default_information_other_variable.md new file mode 100644 index 0000000..a807670 --- /dev/null +++ b/tests/docs/examples/00_9default_information_other_variable.md @@ -0,0 +1,32 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: # a first variable +var2: + description: a second variable + default: + type: information + information: test_information + variable: _.var1 +``` +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + var1: example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var1: example + var2: example +``` diff --git a/tests/docs/examples/00_9default_integer.md b/tests/docs/examples/00_9default_integer.md new file mode 100644 index 0000000..c80cffb --- /dev/null +++ b/tests/docs/examples/00_9default_integer.md @@ -0,0 +1,27 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: + description: a variable + default: 9 + choices: + jinja: | + {% for item in trange(0, 10) %} + {{ item }} + {%- endfor %} + return_type: number + description: choice for 0 to 9 +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var: 9 +``` diff --git a/tests/docs/examples/00_9extra.md b/tests/docs/examples/00_9extra.md new file mode 100644 index 0000000..e9740d2 --- /dev/null +++ b/tests/docs/examples/00_9extra.md @@ -0,0 +1,31 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +variable: rougail # a variable +``` +# dictionaries/extra/00-base.yml + +```yaml +--- +version: '1.1' +variable: + description: a variable + default: + jinja: no + description: return no +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + variable: rougail +extra: + variable: no +``` diff --git a/tests/docs/examples/00_9extra_calculation.md b/tests/docs/examples/00_9extra_calculation.md new file mode 100644 index 0000000..7974470 --- /dev/null +++ b/tests/docs/examples/00_9extra_calculation.md @@ -0,0 +1,47 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +variable: value # a variable +``` +# dictionaries/extra/00-base.yml + +```yaml +--- +version: '1.1' +variable1: + description: a first variable + default: + variable: rougail.variable +variable2: + description: a second variable + default: + jinja: | + {{ rougail.variable }} + description: copy the value of rougail.variable +variable3: + description: a third variable + default: + jinja: | + {{ variable }} + params: + variable: + variable: rougail.variable + description: copy the value of rougail.variable +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + variable: value +extra: + variable1: value + variable2: value + variable3: value +``` diff --git a/tests/docs/examples/01_6boolean_multi.md b/tests/docs/examples/01_6boolean_multi.md new file mode 100644 index 0000000..b7c1ff7 --- /dev/null +++ b/tests/docs/examples/01_6boolean_multi.md @@ -0,0 +1,66 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: # the first variable + - true +var2: + description: the second variable + default: + - true +var3: + description: the third variable + type: boolean + default: + - true +var4: # the forth variable + - false +var5: + description: the fifth variable + default: + - false +var6: + description: the sixth variable + type: boolean + default: + - false + +var7: + description: the seventh variable + multi: true + default: + - true +var8: + description: the eighth variable + type: boolean + multi: true + default: + - true +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var1: + - true + var2: + - true + var3: + - true + var4: + - false + var5: + - false + var6: + - false + var7: + - true + var8: + - true +``` diff --git a/tests/docs/examples/01_6custom_multi.md b/tests/docs/examples/01_6custom_multi.md new file mode 100644 index 0000000..183828a --- /dev/null +++ b/tests/docs/examples/01_6custom_multi.md @@ -0,0 +1,37 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +custom1: + description: a first custom variable + type: custom + multi: true +custom2: + description: a second custom variable + type: custom + default: + - value +``` +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + custom1: + - xxx +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + custom1: + - xxx + custom2: + - value +``` diff --git a/tests/docs/examples/01_6float_multi.md b/tests/docs/examples/01_6float_multi.md new file mode 100644 index 0000000..2132d33 --- /dev/null +++ b/tests/docs/examples/01_6float_multi.md @@ -0,0 +1,66 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: # the first variable + - 0.0 +var2: + description: the second variable + default: + - 0.0 +var3: + description: the third variable + type: float + default: + - 0.0 +var4: # the forth variable + - 10.1 +var5: + description: the fifth variable + default: + - 10.1 +var6: + description: the sixth variable + type: float + default: + - 10.1 + +var7: + description: the seventh variable + multi: true + default: + - 0.0 +var8: + description: the eighth variable + type: float + multi: true + default: + - 0.0 +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var1: + - 0.0 + var2: + - 0.0 + var3: + - 0.0 + var4: + - 10.1 + var5: + - 10.1 + var6: + - 10.1 + var7: + - 0.0 + var8: + - 0.0 +``` diff --git a/tests/docs/examples/01_6number_multi.md b/tests/docs/examples/01_6number_multi.md new file mode 100644 index 0000000..a776a58 --- /dev/null +++ b/tests/docs/examples/01_6number_multi.md @@ -0,0 +1,66 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: # the first variable + - 0 +var2: + description: the second variable + default: + - 0 +var3: + description: the third variable + type: number + default: + - 0 +var4: # the forth variable + - 10 +var5: + description: the fifth variable + default: + - 10 +var6: + description: the sixth variable + type: number + default: + - 10 + +var7: + description: the seventh variable + multi: true + default: + - 0 +var8: + description: the eighth variable + type: number + multi: true + default: + - 0 +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var1: + - 0 + var2: + - 0 + var3: + - 0 + var4: + - 10 + var5: + - 10 + var6: + - 10 + var7: + - 0 + var8: + - 0 +``` diff --git a/tests/docs/examples/01_6string_empty.md b/tests/docs/examples/01_6string_empty.md new file mode 100644 index 0000000..380573e --- /dev/null +++ b/tests/docs/examples/01_6string_empty.md @@ -0,0 +1,25 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: + description: the second variable + empty: false + default: + - value + - +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var1: + - value + - +``` diff --git a/tests/docs/examples/01_6string_multi.md b/tests/docs/examples/01_6string_multi.md new file mode 100644 index 0000000..90ad674 --- /dev/null +++ b/tests/docs/examples/01_6string_multi.md @@ -0,0 +1,72 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: [] # the first variable +var2: + description: the second variable + default: [] +var3: + description: the third variable + type: string +var4: # the forth variable + - value +var5: + description: the fifth variable + default: + - value +var6: + description: the sixth variable + type: string + default: + - value + +var7: + description: the seventh variable + multi: true + default: + - value +var8: + description: the eighth variable + type: string + multi: true + default: + - value +``` +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + var1: + - example + var2: + - example + var3: example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var1: + - example + var2: + - example + var3: example + var4: + - value + var5: + - value + var6: + - value + var7: + - value + var8: + - value +``` diff --git a/tests/docs/examples/01_7value_multi_doublequote.md b/tests/docs/examples/01_7value_multi_doublequote.md new file mode 100644 index 0000000..d75972e --- /dev/null +++ b/tests/docs/examples/01_7value_multi_doublequote.md @@ -0,0 +1,22 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +variable: + description: a variable + default: + - quote" +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + variable: + - quote" +``` diff --git a/tests/docs/examples/01_7value_multi_doublequote2.md b/tests/docs/examples/01_7value_multi_doublequote2.md new file mode 100644 index 0000000..7eba741 --- /dev/null +++ b/tests/docs/examples/01_7value_multi_doublequote2.md @@ -0,0 +1,22 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +variable: + description: a variable + default: + - quote'" +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + variable: + - quote'" +``` diff --git a/tests/docs/examples/01_7value_multi_quote.md b/tests/docs/examples/01_7value_multi_quote.md new file mode 100644 index 0000000..5799129 --- /dev/null +++ b/tests/docs/examples/01_7value_multi_quote.md @@ -0,0 +1,22 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +variable: + description: a variable + default: + - quote' +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + variable: + - quote' +``` diff --git a/tests/docs/examples/01_8calculation_information_multi.md b/tests/docs/examples/01_8calculation_information_multi.md new file mode 100644 index 0000000..dd315e2 --- /dev/null +++ b/tests/docs/examples/01_8calculation_information_multi.md @@ -0,0 +1,29 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +variable: + description: a variable + multi: true + default: + jinja: | + {{test_information }} + params: + test_information: + type: information + information: test_information + description: get information test_information +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + variable: + - '[]' +``` diff --git a/tests/docs/examples/01_9choice_variable_multi.md b/tests/docs/examples/01_9choice_variable_multi.md new file mode 100644 index 0000000..b818e32 --- /dev/null +++ b/tests/docs/examples/01_9choice_variable_multi.md @@ -0,0 +1,36 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +variable1: # a first variable + - a + - b + - c +variable2: + description: a second variable + choices: + variable: _.variable1 +``` +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + variable2: a_choice +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + variable1: + - a + - b + - c + variable2: a_choice +``` diff --git a/tests/docs/examples/04_0type_param.md b/tests/docs/examples/04_0type_param.md new file mode 100644 index 0000000..59e2595 --- /dev/null +++ b/tests/docs/examples/04_0type_param.md @@ -0,0 +1,23 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +int: + description: A limited number + default: 10 + params: + min_number: 0 + max_number: 100 +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + int: 10 +``` diff --git a/tests/docs/examples/04_1auto_save.md b/tests/docs/examples/04_1auto_save.md new file mode 100644 index 0000000..5467a6c --- /dev/null +++ b/tests/docs/examples/04_1auto_save.md @@ -0,0 +1,21 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: 1.1 +variable: + description: an auto save variable + auto_save: true + default: no +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + variable: no +``` diff --git a/tests/docs/examples/04_1auto_save_and_calculated.md b/tests/docs/examples/04_1auto_save_and_calculated.md new file mode 100644 index 0000000..c882c74 --- /dev/null +++ b/tests/docs/examples/04_1auto_save_and_calculated.md @@ -0,0 +1,24 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: 1.1 +var1: no # a first variable +var2: + description: a second variable + auto_save: true + default: + variable: _.var1 +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var1: no + var2: no +``` diff --git a/tests/docs/examples/04_1auto_save_and_calculated_hidden.md b/tests/docs/examples/04_1auto_save_and_calculated_hidden.md new file mode 100644 index 0000000..bac8fb0 --- /dev/null +++ b/tests/docs/examples/04_1auto_save_and_calculated_hidden.md @@ -0,0 +1,31 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: no # a first variable +var2: + description: a second variable + auto_save: true + hidden: + jinja: | + {% if _.var1 == "yes" %} + _.var1 is yes + {% endif %} + description: only if the variable var1 has value "yes" + default: + jinja: yes + description: the value is always yes +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var1: no + var2: yes +``` diff --git a/tests/docs/examples/04_1auto_save_and_hidden.md b/tests/docs/examples/04_1auto_save_and_hidden.md new file mode 100644 index 0000000..eb23d55 --- /dev/null +++ b/tests/docs/examples/04_1auto_save_and_hidden.md @@ -0,0 +1,16 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: + description: autosave variable + auto_save: true + hidden: true + default: yes + mandatory: false +``` diff --git a/tests/docs/examples/04_1default_calculation_hidden.md b/tests/docs/examples/04_1default_calculation_hidden.md new file mode 100644 index 0000000..24cc767 --- /dev/null +++ b/tests/docs/examples/04_1default_calculation_hidden.md @@ -0,0 +1,44 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: 1.1 + +var1: + description: a first variable + default: value + +var2: + description: a second variable + disabled: + variable: _.var1 + when: value + +var3: + description: a third variable + default: + jinja: | + {% if _.var1 == 'value' or _.var2 == 'blah' %} + value + {% endif %} +``` +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + var2: example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var1: value + var2: example + var3: value +``` diff --git a/tests/docs/examples/04_1default_calculation_hidden_2.md b/tests/docs/examples/04_1default_calculation_hidden_2.md new file mode 100644 index 0000000..b758377 --- /dev/null +++ b/tests/docs/examples/04_1default_calculation_hidden_2.md @@ -0,0 +1,44 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: 1.1 + +var1: + description: a first variable + default: value + +var2: + description: a second variable + disabled: + variable: _.var1 + when: value + +var3: + description: a third variable + default: + jinja: | + {% if _.var2 is propertyerror %} + value + {% endif %} +``` +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + var2: example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var1: value + var2: example + var3: example +``` diff --git a/tests/docs/examples/04_5disabled_calculation.md b/tests/docs/examples/04_5disabled_calculation.md new file mode 100644 index 0000000..54e1ab1 --- /dev/null +++ b/tests/docs/examples/04_5disabled_calculation.md @@ -0,0 +1,44 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +condition: no # a conditional variable +variable1: + description: a first variable + disabled: + jinja: | + {% if _.condition == "yes" %} + condition is yes + {% endif %} + description: if condition is egal to "yes" +variable2: + description: a second variable + disabled: + jinja: | + {% if _.condition == "yes" %} + condition is yes + {% endif %} + description: if condition is egal to "yes" +``` +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + variable1: example + variable2: example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + condition: no + variable1: example + variable2: example +``` diff --git a/tests/docs/examples/04_5disabled_calculation_default.md b/tests/docs/examples/04_5disabled_calculation_default.md new file mode 100644 index 0000000..78f79e9 --- /dev/null +++ b/tests/docs/examples/04_5disabled_calculation_default.md @@ -0,0 +1,47 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' + +condition: no # a condition + +var1: + description: a first variable + disabled: + jinja: | + {% if _.condition == "yes" %} + condition is yes + {% endif %} + description: if condition is yes + default: + jinja: | + {{ _.condition }} + description: the value of condition + +var2: + description: a second variable + disabled: + jinja: | + {% if rougail.condition == "yes" %} + condition is yes + {% endif %} + description: if condition is yes + default: + jinja: | + {{ rougail.condition }} + description: the value of condition +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + condition: no + var1: no + var2: no +``` diff --git a/tests/docs/examples/04_5disabled_calculation_optional.md b/tests/docs/examples/04_5disabled_calculation_optional.md new file mode 100644 index 0000000..8fa1ac9 --- /dev/null +++ b/tests/docs/examples/04_5disabled_calculation_optional.md @@ -0,0 +1,50 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +condition: no # a condition +var1: + description: a first variable + hidden: + jinja: | + {% if unknown is not defined %} + unknown is undefined + {% elif unknown == "no" %} + unknown is no + {% endif %} + params: + unknown: + variable: _.unknown + optional: true + description: calculation from an unknown variable + mandatory: false +var2: + description: a second variable + hidden: + jinja: | + {% if condition is not defined %} + condition is undefined + {% elif condition == "no" %} + condition is no + {% endif %} + params: + condition: + variable: _.condition + optional: true + description: calculation from an condition variable + mandatory: false +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + condition: no + var1: example + var2: example +``` diff --git a/tests/docs/examples/04_5disabled_calculation_variable.md b/tests/docs/examples/04_5disabled_calculation_variable.md new file mode 100644 index 0000000..11d2578 --- /dev/null +++ b/tests/docs/examples/04_5disabled_calculation_variable.md @@ -0,0 +1,30 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +condition: false # a condition +variable: + description: a variable + disabled: + variable: _.condition +``` +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + variable: example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + condition: false + variable: example +``` diff --git a/tests/docs/examples/04_5disabled_calculation_variable2.md b/tests/docs/examples/04_5disabled_calculation_variable2.md new file mode 100644 index 0000000..0397596 --- /dev/null +++ b/tests/docs/examples/04_5disabled_calculation_variable2.md @@ -0,0 +1,30 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +condition: true # a condition +variable: + description: a variable + disabled: + variable: _.condition +``` +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + variable: example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + condition: true + variable: example +``` diff --git a/tests/docs/examples/04_5disabled_calculation_variable3.md b/tests/docs/examples/04_5disabled_calculation_variable3.md new file mode 100644 index 0000000..d3b0092 --- /dev/null +++ b/tests/docs/examples/04_5disabled_calculation_variable3.md @@ -0,0 +1,31 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +condition: yes # a condition +variable: + description: a variable + disabled: + variable: _.condition + when: yes +``` +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + variable: example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + condition: yes + variable: example +``` diff --git a/tests/docs/examples/04_5disabled_calculation_variable4.md b/tests/docs/examples/04_5disabled_calculation_variable4.md new file mode 100644 index 0000000..408c9c9 --- /dev/null +++ b/tests/docs/examples/04_5disabled_calculation_variable4.md @@ -0,0 +1,31 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +condition: yes # a condition +variable: + description: a variable + disabled: + variable: _.condition + when_not: yes +``` +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + variable: example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + condition: yes + variable: example +``` diff --git a/tests/docs/examples/04_5hidden_calculation.md b/tests/docs/examples/04_5hidden_calculation.md new file mode 100644 index 0000000..2b3369b --- /dev/null +++ b/tests/docs/examples/04_5hidden_calculation.md @@ -0,0 +1,38 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +condition: no # the condition +var1: + description: a first variable + default: no + hidden: + jinja: | + {% if _.condition == "yes" %} + condition is yes + {% endif %} + description: if condition is yes +var2: + description: a second variable + default: no + hidden: + jinja: | + {% if rougail.condition == "yes" %} + condition is yes + {% endif %} + description: if condition is yes +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + condition: no + var1: no + var2: no +``` diff --git a/tests/docs/examples/04_5hidden_calculation2.md b/tests/docs/examples/04_5hidden_calculation2.md new file mode 100644 index 0000000..6ff4a9d --- /dev/null +++ b/tests/docs/examples/04_5hidden_calculation2.md @@ -0,0 +1,44 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +condition: no # a condition +var1: + description: a first variable + hidden: + jinja: | + {% if _.condition != "yes" %} + condition is yes + {% endif %} + description: if condition is yes + default: + jinja: | + {{ _.condition }} + description: the value of condition +var2: + description: a second variable + hidden: + jinja: | + {% if rougail.condition != "yes" %} + condition is yes + {% endif %} + description: if condition is yes + default: + jinja: | + {{ rougail.condition }} + description: the value of condition +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + condition: no + var1: no + var2: no +``` diff --git a/tests/docs/examples/04_5hidden_calculation_default_calculation.md b/tests/docs/examples/04_5hidden_calculation_default_calculation.md new file mode 100644 index 0000000..904ae97 --- /dev/null +++ b/tests/docs/examples/04_5hidden_calculation_default_calculation.md @@ -0,0 +1,44 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +condition: no # a condition +var1: + description: a first variable + hidden: + jinja: | + {% if _.condition == "yes" %} + condition is yes + {% endif %} + description: if condition is yes + default: + jinja: | + {{ _.condition }} + description: returns the condition value +var2: + description: a second variable + hidden: + jinja: | + {% if rougail.condition == "yes" %} + condition is yes + {% endif %} + description: if condition is yes + default: + jinja: | + {{ rougail.condition }} + description: returns the condition value +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + condition: no + var1: no + var2: no +``` diff --git a/tests/docs/examples/04_5validators.md b/tests/docs/examples/04_5validators.md new file mode 100644 index 0000000..b054f5b --- /dev/null +++ b/tests/docs/examples/04_5validators.md @@ -0,0 +1,33 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +int: + description: A number + type: number + validators: + - jinja: | + {% if _.int > 100 %} + value is too high + {% endif %} + description: the max value is 100 +``` +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + int: 42 +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + int: 42 +``` diff --git a/tests/docs/examples/04_5validators_differ.md b/tests/docs/examples/04_5validators_differ.md new file mode 100644 index 0000000..c9330d1 --- /dev/null +++ b/tests/docs/examples/04_5validators_differ.md @@ -0,0 +1,31 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: + description: a first variable + test: + - another_value + type: string + default: oui + validators: + - jinja: | + {% if _.var1 == _.var2 %} + var1 must be different than var2 + {% endif %} + description: var1 must be different than var2 +var2: no # A second variable +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var1: another_value + var2: no +``` diff --git a/tests/docs/examples/04_5validators_multi.md b/tests/docs/examples/04_5validators_multi.md new file mode 100644 index 0000000..e44bd74 --- /dev/null +++ b/tests/docs/examples/04_5validators_multi.md @@ -0,0 +1,31 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: 1.1 +var1: + description: a second variable + multi: true + default: + - no + - yes + validators: + - jinja: | + {% if _.var1 | length > 9 %} + length must be less than 10 + {% endif %} + description: check length is less than 10 +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var1: + - no + - yes +``` diff --git a/tests/docs/examples/04_5validators_multi2.md b/tests/docs/examples/04_5validators_multi2.md new file mode 100644 index 0000000..5ded70e --- /dev/null +++ b/tests/docs/examples/04_5validators_multi2.md @@ -0,0 +1,38 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: 1.1 +var1: + description: a second variable + multi: true + default: + - no + - yes + test: + - val1 + - val2 + validators: + - params: + values: + variable: _.var1 + whole: true + jinja: | + {% if values | length > 2 %} + length must be less than 3 + {% endif %} + description: check length is less than 3 +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var1: + - val1 + - val2 +``` diff --git a/tests/docs/examples/05_0multi_not_uniq.md b/tests/docs/examples/05_0multi_not_uniq.md new file mode 100644 index 0000000..9453ec8 --- /dev/null +++ b/tests/docs/examples/05_0multi_not_uniq.md @@ -0,0 +1,23 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: + description: a variable + unique: false + default: + - non +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var1: + - non +``` diff --git a/tests/docs/examples/05_0multi_uniq.md b/tests/docs/examples/05_0multi_uniq.md new file mode 100644 index 0000000..1b00f8c --- /dev/null +++ b/tests/docs/examples/05_0multi_uniq.md @@ -0,0 +1,23 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +variable: + description: a variable + unique: true + default: + - non +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + variable: + - non +``` diff --git a/tests/docs/examples/12_1auto_save_expert.md b/tests/docs/examples/12_1auto_save_expert.md new file mode 100644 index 0000000..7ae5957 --- /dev/null +++ b/tests/docs/examples/12_1auto_save_expert.md @@ -0,0 +1,15 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: 1.1 +var: + description: a variable + auto_save: true + mode: advanced + default: no +``` diff --git a/tests/docs/examples/16_0redefine_description.md b/tests/docs/examples/16_0redefine_description.md new file mode 100644 index 0000000..d7bbe59 --- /dev/null +++ b/tests/docs/examples/16_0redefine_description.md @@ -0,0 +1,35 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: + description: Redefine description +``` +# dictionaries/rougail/01-redefine.yml + +```yaml +--- +version: '1.1' +var: + description: Redefined + redefine: true +``` +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + var: example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var: example +``` diff --git a/tests/docs/examples/16_2family_redefine_calculation.md b/tests/docs/examples/16_2family_redefine_calculation.md new file mode 100644 index 0000000..5c87570 --- /dev/null +++ b/tests/docs/examples/16_2family_redefine_calculation.md @@ -0,0 +1,39 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/01-base.yml + +```yaml +--- +version: '1.0' +family: + redefine: true + disabled: + jinja: | + true +``` +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.0' +family: + var1: +``` +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + family: + var1: example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + family: + var1: example +``` diff --git a/tests/docs/examples/16_2family_redefine_disabled.md b/tests/docs/examples/16_2family_redefine_disabled.md new file mode 100644 index 0000000..9ac5af4 --- /dev/null +++ b/tests/docs/examples/16_2family_redefine_disabled.md @@ -0,0 +1,21 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/01-base.yml + +```yaml +--- +version: '1.0' +family: + redefine: true + disabled: true +``` +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.0' +family: + var1: +``` diff --git a/tests/docs/examples/16_5exists_nonexists.md b/tests/docs/examples/16_5exists_nonexists.md new file mode 100644 index 0000000..46640a3 --- /dev/null +++ b/tests/docs/examples/16_5exists_nonexists.md @@ -0,0 +1,29 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/01-base.yml + +```yaml +--- +version: '1.1' +var2: + description: a new variable + exists: false + default: yes +``` +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: no # a variable +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var1: no + var2: yes +``` diff --git a/tests/docs/examples/16_5exists_redefine.md b/tests/docs/examples/16_5exists_redefine.md new file mode 100644 index 0000000..695da7d --- /dev/null +++ b/tests/docs/examples/16_5exists_redefine.md @@ -0,0 +1,30 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/01-base.yml + +```yaml +--- +version: '1.1' +var1: + redefine: true + exists: true + default: yes +var2: + description: a second variable + redefine: true + exists: true + default: yes +``` +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: + description: a first variable + hidden: true + default: no + mandatory: false +``` diff --git a/tests/docs/examples/16_5redefine_calculation.md b/tests/docs/examples/16_5redefine_calculation.md new file mode 100644 index 0000000..7390d28 --- /dev/null +++ b/tests/docs/examples/16_5redefine_calculation.md @@ -0,0 +1,33 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/01-base.yml + +```yaml +--- +version: '1.1' +variable: + redefine: true + default: + jinja: yes + description: returns yes +``` +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +variable: + description: a variable + default: + jinja: no + description: returns no +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + variable: yes +``` diff --git a/tests/docs/examples/16_5redefine_choice.md b/tests/docs/examples/16_5redefine_choice.md new file mode 100644 index 0000000..d4f4825 --- /dev/null +++ b/tests/docs/examples/16_5redefine_choice.md @@ -0,0 +1,41 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +variable: + description: a variable + choices: + - a + - b + - c +``` +# dictionaries/rougail/01-redefine.yml + +```yaml +--- +version: '1.0' +variable: + redefine: true + choices: + - a + - b +``` +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + variable: a_choice +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + variable: a_choice +``` diff --git a/tests/docs/examples/16_5redefine_default.md b/tests/docs/examples/16_5redefine_default.md new file mode 100644 index 0000000..78a6eed --- /dev/null +++ b/tests/docs/examples/16_5redefine_default.md @@ -0,0 +1,29 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +variable: + description: a variable + default: no +``` +# dictionaries/rougail/01-redefine.yml + +```yaml +--- +version: '1.1' +variable: + redefine: true + default: yes +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + variable: yes +``` diff --git a/tests/docs/examples/16_5redefine_default_calculation.md b/tests/docs/examples/16_5redefine_default_calculation.md new file mode 100644 index 0000000..bc23e7b --- /dev/null +++ b/tests/docs/examples/16_5redefine_default_calculation.md @@ -0,0 +1,37 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/01-base.yml + +```yaml +--- +version: '1.1' +variable: + redefine: true + default: +``` +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +variable: + description: a variable + default: + jinja: yes +``` +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + variable: example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + variable: example +``` diff --git a/tests/docs/examples/16_5redefine_family.md b/tests/docs/examples/16_5redefine_family.md new file mode 100644 index 0000000..7a9317f --- /dev/null +++ b/tests/docs/examples/16_5redefine_family.md @@ -0,0 +1,37 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/01-base.yml + +```yaml +--- +version: '1.1' +family: + redefine: true + description: new description +``` +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +family: # a family + variable: # a variable +``` +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + family: + variable: example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + family: + variable: example +``` diff --git a/tests/docs/examples/16_5redefine_help.md b/tests/docs/examples/16_5redefine_help.md new file mode 100644 index 0000000..a11c4c4 --- /dev/null +++ b/tests/docs/examples/16_5redefine_help.md @@ -0,0 +1,44 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/01-base.yml + +```yaml +--- +version: '1.1' +family: + redefine: true + help: redefine help family ok + variable: + redefine: true + help: redefine help ok +``` +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +family: + description: a family + help: redefine help family + variable: + description: redefine help + help: redefine help +``` +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + family: + variable: example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + family: + variable: example +``` diff --git a/tests/docs/examples/16_5redefine_hidden.md b/tests/docs/examples/16_5redefine_hidden.md new file mode 100644 index 0000000..6233386 --- /dev/null +++ b/tests/docs/examples/16_5redefine_hidden.md @@ -0,0 +1,21 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +variable: no # a variable +``` +# dictionaries/rougail/01-redefine.yml + +```yaml +--- +version: '1.1' +variable: + redefine: true + hidden: true + mandatory: false +``` diff --git a/tests/docs/examples/16_5redefine_multi.md b/tests/docs/examples/16_5redefine_multi.md new file mode 100644 index 0000000..b0b0836 --- /dev/null +++ b/tests/docs/examples/16_5redefine_multi.md @@ -0,0 +1,32 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +variable: + description: a variable + default: non +``` +# dictionaries/rougail/01-redefine.yml + +```yaml +--- +version: '1.1' +variable: + redefine: true + multi: true + default: + - non +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + variable: + - non +``` diff --git a/tests/docs/examples/16_5redefine_remove_disable_calculation.md b/tests/docs/examples/16_5redefine_remove_disable_calculation.md new file mode 100644 index 0000000..e01b37b --- /dev/null +++ b/tests/docs/examples/16_5redefine_remove_disable_calculation.md @@ -0,0 +1,44 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/01-base.yml + +```yaml +--- +version: '1.1' +variable: + redefine: true + disabled: false +``` +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +condition: no # a condition +variable: + description: a variable + disabled: + jinja: | + {% if _.condition == "yes" %} + true + {% else %} + false + {% endif %} +``` +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + variable: example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + condition: no + variable: example +``` diff --git a/tests/docs/examples/16_5test_redefine.md b/tests/docs/examples/16_5test_redefine.md new file mode 100644 index 0000000..dc1e751 --- /dev/null +++ b/tests/docs/examples/16_5test_redefine.md @@ -0,0 +1,53 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: no # a first variable +var2: + description: a second variable + test: + - test + default: non +var3: + description: a third variable + test: + - test +``` +# dictionaries/rougail/10-base.yml + +```yaml +--- +version: '1.1' +var1: + redefine: true + test: + - test1 +var2: + redefine: true + test: + - test1 +var3: + redefine: true + test: +``` +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + var3: example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var1: test1 + var2: test1 + var3: example +``` diff --git a/tests/docs/examples/16_6choice_redefine.md b/tests/docs/examples/16_6choice_redefine.md new file mode 100644 index 0000000..e02cca6 --- /dev/null +++ b/tests/docs/examples/16_6choice_redefine.md @@ -0,0 +1,36 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/01-base.yml + +```yaml +--- +version: '1.0' +var: + redefine: true + choices: + - a + - c +``` +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.0' +var: + type: choice + description: A choice + default: c + choices: + - a + - b + - c +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var: c +``` diff --git a/tests/docs/examples/16exists_exists.md b/tests/docs/examples/16exists_exists.md new file mode 100644 index 0000000..ad3bfea --- /dev/null +++ b/tests/docs/examples/16exists_exists.md @@ -0,0 +1,35 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/01-base.yml + +```yaml +--- +version: '1.1' +var: + description: New description + exists: false +``` +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: + description: Description +``` +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + var: example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var: example +``` diff --git a/tests/docs/examples/17_5redefine_leadership.md b/tests/docs/examples/17_5redefine_leadership.md new file mode 100644 index 0000000..58d32e4 --- /dev/null +++ b/tests/docs/examples/17_5redefine_leadership.md @@ -0,0 +1,28 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/01-base.yml + +```yaml +--- +version: '1.1' +leader: + redefine: true + hidden: true +``` +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +leader: # a leadership + type: leadership + leader: + description: a leader + multi: true + mandatory: false + follower: + description: a follower + mandatory: false +``` diff --git a/tests/docs/examples/20_0empty_family.md b/tests/docs/examples/20_0empty_family.md new file mode 100644 index 0000000..d61994c --- /dev/null +++ b/tests/docs/examples/20_0empty_family.md @@ -0,0 +1,12 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.0' +my_family: + type: family +``` diff --git a/tests/docs/examples/20_0family_append.md b/tests/docs/examples/20_0family_append.md new file mode 100644 index 0000000..a300a47 --- /dev/null +++ b/tests/docs/examples/20_0family_append.md @@ -0,0 +1,41 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/01-base.yml + +```yaml +--- +version: '1.1' +family: + var2: + description: The second variable +``` +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +family: + description: A family + var1: + description: The first variable +``` +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + family: + var1: example + var2: example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + family: + var1: example + var2: example +``` diff --git a/tests/docs/examples/20_0family_underscore.md b/tests/docs/examples/20_0family_underscore.md new file mode 100644 index 0000000..f75a46e --- /dev/null +++ b/tests/docs/examples/20_0family_underscore.md @@ -0,0 +1,46 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +my_family: + _type: family + _description: This is a great family + _help: This is a great family + _mode: standard + _hidden: true + _disabled: true + type: + description: a type family + type: family + my_variable: + mandatory: false + description: + description: This is a other great family + my_variable: + mandatory: false + help: + description: a help family + help: This is a other great family + my_variable: + mandatory: false + mode: + description: a mode family + mode: advanced + my_variable: + mandatory: false + hidden: + description: an hidden family + hidden: true + my_variable: + mandatory: false + disabled: + description: an disabled family + disabled: true + my_variable: + mandatory: false +``` diff --git a/tests/docs/examples/20_0multi_family.md b/tests/docs/examples/20_0multi_family.md new file mode 100644 index 0000000..4f0b7d9 --- /dev/null +++ b/tests/docs/examples/20_0multi_family.md @@ -0,0 +1,24 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +family: # a family + subfamily: # a sub family + variable: + description: a variable + mandatory: false +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + family: + subfamily: + variable: example +``` diff --git a/tests/docs/examples/20_0multi_family_basic.md b/tests/docs/examples/20_0multi_family_basic.md new file mode 100644 index 0000000..e853dd8 --- /dev/null +++ b/tests/docs/examples/20_0multi_family_basic.md @@ -0,0 +1,31 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +family: # a family + subfamily: # a sub family + variable: # a variable +``` +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + family: + subfamily: + variable: example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + family: + subfamily: + variable: example +``` diff --git a/tests/docs/examples/20_0multi_family_expert.md b/tests/docs/examples/20_0multi_family_expert.md new file mode 100644 index 0000000..1340984 --- /dev/null +++ b/tests/docs/examples/20_0multi_family_expert.md @@ -0,0 +1,17 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +family: + description: a family + mode: advanced + subfamily: # a sub family + variable: + description: a variable + mandatory: false +``` diff --git a/tests/docs/examples/20_0multi_family_order.md b/tests/docs/examples/20_0multi_family_order.md new file mode 100644 index 0000000..66ecad8 --- /dev/null +++ b/tests/docs/examples/20_0multi_family_order.md @@ -0,0 +1,40 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +variable: # a variable +family: # a family + variable1: # a first variable + subfamily: # a sub family + variable: # a variable + variable2: # a second variable +``` +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + variable: example + family: + variable1: example + subfamily: + variable: example + variable2: example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + variable: example + family: + variable1: example + subfamily: + variable: example + variable2: example +``` diff --git a/tests/docs/examples/20_0validators_differ_redefine.md b/tests/docs/examples/20_0validators_differ_redefine.md new file mode 100644 index 0000000..2c4d169 --- /dev/null +++ b/tests/docs/examples/20_0validators_differ_redefine.md @@ -0,0 +1,46 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/01-base.yml + +```yaml +--- +version: '1.1' +var3: + redefine: true + validators: + - jinja: | + {% if _.var3 == _.var2 %} + var3 must be different than var2 + {% endif %} + description: var3 must be different than var2 +``` +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: no # a first variable +var2: no # a second variable +var3: + description: a third variable + default: yes + test: + - yes + validators: + - jinja: | + {% if _.var3 == _.var1 %} + var3 must be different than var1 + {% endif %} + description: var3 must be different than var1 +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var1: no + var2: no + var3: yes +``` diff --git a/tests/docs/examples/20_1empty_subfamily.md b/tests/docs/examples/20_1empty_subfamily.md new file mode 100644 index 0000000..f876681 --- /dev/null +++ b/tests/docs/examples/20_1empty_subfamily.md @@ -0,0 +1,13 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.0' +my_family: + my_sub_family: + type: family +``` diff --git a/tests/docs/examples/20_9default_information_parent.md b/tests/docs/examples/20_9default_information_parent.md new file mode 100644 index 0000000..dcc6a32 --- /dev/null +++ b/tests/docs/examples/20_9default_information_parent.md @@ -0,0 +1,35 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: 1.1 +family: + var1: # a first variable + var2: + description: a second variable + default: + type: information + information: test_information + variable: __.family +``` +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + family: + var1: example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + family: + var1: example + var2: example +``` diff --git a/tests/docs/examples/24_0family_hidden_condition.md b/tests/docs/examples/24_0family_hidden_condition.md new file mode 100644 index 0000000..670bf5d --- /dev/null +++ b/tests/docs/examples/24_0family_hidden_condition.md @@ -0,0 +1,37 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +condition: no # the variable use has condition +family: + description: possibly hidden family + hidden: + jinja: | + {% if rougail.condition == "yes" %} + condition is yes + {% endif %} + description: if condition is yes + var1: # a variable +``` +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + family: + var1: example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + condition: no + family: + var1: example +``` diff --git a/tests/docs/examples/24_0family_hidden_condition_boolean.md b/tests/docs/examples/24_0family_hidden_condition_boolean.md new file mode 100644 index 0000000..b240697 --- /dev/null +++ b/tests/docs/examples/24_0family_hidden_condition_boolean.md @@ -0,0 +1,31 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +condition: false # a conditional variable +family: + description: a family + hidden: + jinja: | + {% if not rougail.condition %} + condition is false + {% endif %} + description: if not condition + variable: + description: a variable + mandatory: false +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + condition: false + family: + variable: example +``` diff --git a/tests/docs/examples/24_0family_hidden_condition_sub_family.md b/tests/docs/examples/24_0family_hidden_condition_sub_family.md new file mode 100644 index 0000000..893a32b --- /dev/null +++ b/tests/docs/examples/24_0family_hidden_condition_sub_family.md @@ -0,0 +1,40 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +condition: no # the variable use has condition +family: + description: possibly hidden family + hidden: + jinja: | + {% if _.condition == "yes" %} + condition is yes + {% endif %} + description: if condition is yes + subfamily: + var1: # a variable +``` +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + family: + subfamily: + var1: example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + condition: no + family: + subfamily: + var1: example +``` diff --git a/tests/docs/examples/24_0family_hidden_condition_variable_sub_family.md b/tests/docs/examples/24_0family_hidden_condition_variable_sub_family.md new file mode 100644 index 0000000..1f8f102 --- /dev/null +++ b/tests/docs/examples/24_0family_hidden_condition_variable_sub_family.md @@ -0,0 +1,29 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +condition: true # the variable use has condition +family: + description: possibly hidden family + hidden: + variable: _.condition + subfamily: # a subfamily + var1: + description: a variable + mandatory: false +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + condition: true + family: + subfamily: + var1: example +``` diff --git a/tests/docs/examples/24_0family_hidden_condition_with_variable.md b/tests/docs/examples/24_0family_hidden_condition_with_variable.md new file mode 100644 index 0000000..20fec3a --- /dev/null +++ b/tests/docs/examples/24_0family_hidden_condition_with_variable.md @@ -0,0 +1,39 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +condition1: false # a first conditional variable +condition2: false # a second conditional variable +family: + description: a family + hidden: + jinja: | + {% if not rougail.condition1 %} + condition1 is false + {% endif %} + description: if condition1 is false + variable: + description: a variable + hidden: + jinja: | + {% if rougail.condition2 %} + condition2 is true + {% endif %} + description: if condition2 is false + mandatory: false +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + condition1: false + condition2: false + family: + variable: example +``` diff --git a/tests/docs/examples/24_0family_hidden_param_condition_sub_family.md b/tests/docs/examples/24_0family_hidden_param_condition_sub_family.md new file mode 100644 index 0000000..535dcd7 --- /dev/null +++ b/tests/docs/examples/24_0family_hidden_param_condition_sub_family.md @@ -0,0 +1,43 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +condition: no # the variable use has condition +family: + description: possibly hidden family + hidden: + jinja: | + {% if condition == "yes" %} + condition is yes + {% endif %} + params: + condition: + variable: _.condition + description: if condition is yes + sub_family: # a subfamily + var1: # a variable +``` +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + family: + sub_family: + var1: example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + condition: no + family: + sub_family: + var1: example +``` diff --git a/tests/docs/examples/24_0family_mandatory_condition.md b/tests/docs/examples/24_0family_mandatory_condition.md new file mode 100644 index 0000000..93e98c6 --- /dev/null +++ b/tests/docs/examples/24_0family_mandatory_condition.md @@ -0,0 +1,27 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +condition: no # a condition +var: + description: a variable + mandatory: + jinja: | + {% if _.condition == "yes" %} + condition is yes + {% endif %} + description: only if rougail.condition has the value "yes" +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + condition: no + var: example +``` diff --git a/tests/docs/examples/24_0family_mandatory_condition_variable.md b/tests/docs/examples/24_0family_mandatory_condition_variable.md new file mode 100644 index 0000000..df7af53 --- /dev/null +++ b/tests/docs/examples/24_0family_mandatory_condition_variable.md @@ -0,0 +1,23 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +condition: true # a condition +var: + description: a variable + mandatory: + variable: _.condition +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + condition: true + var: example +``` diff --git a/tests/docs/examples/24_7validators_variable_optional.md b/tests/docs/examples/24_7validators_variable_optional.md new file mode 100644 index 0000000..ed7b040 --- /dev/null +++ b/tests/docs/examples/24_7validators_variable_optional.md @@ -0,0 +1,53 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +general: # a family + int: + description: a first number + type: number + test: + - 5 + validators: + - jinja: | + {% if _.int == int2 %} + int and int2 must be different + {% endif %} + params: + int2: + variable: _.int2 + optional: true + description: int and int2 must be different + - jinja: | + {% if int3 is defined and _.int == int3 %} + int and int3 must be different + {% endif %} + params: + int3: + variable: _.int3 + optional: true + description: int and int3 must be different + int2: 1 # a second number +``` +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + general: + int: 5 +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + general: + int: 5 + int2: 1 +``` diff --git a/tests/docs/examples/24_family_disabled_var_hidden.md b/tests/docs/examples/24_family_disabled_var_hidden.md new file mode 100644 index 0000000..05c7bbb --- /dev/null +++ b/tests/docs/examples/24_family_disabled_var_hidden.md @@ -0,0 +1,20 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: 1.1 + +family: + disabled: true + + var1: true # A description + + var2: + description: A description + hidden: + variable: _.var1 +``` diff --git a/tests/docs/examples/40_0leadership.md b/tests/docs/examples/40_0leadership.md new file mode 100644 index 0000000..ea45583 --- /dev/null +++ b/tests/docs/examples/40_0leadership.md @@ -0,0 +1,26 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +leader: + description: a leadership + type: leadership + leader: # a leader + follower1: # a follower + follower2: # an other follower +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + leader: + - leader: example + follower1: example + follower2: example +``` diff --git a/tests/docs/examples/40_0leadership_diff_name.md b/tests/docs/examples/40_0leadership_diff_name.md new file mode 100644 index 0000000..3d43447 --- /dev/null +++ b/tests/docs/examples/40_0leadership_diff_name.md @@ -0,0 +1,26 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +leadership: + description: a leadership + type: leadership + leader: [] # a leader + follower1: # a follower + follower2: # an other follower +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + leadership: + - leader: example + follower1: example + follower2: example +``` diff --git a/tests/docs/examples/40_0leadership_empty.md b/tests/docs/examples/40_0leadership_empty.md new file mode 100644 index 0000000..b7d0b8f --- /dev/null +++ b/tests/docs/examples/40_0leadership_empty.md @@ -0,0 +1,12 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +empty_leader: + type: leadership +``` diff --git a/tests/docs/examples/40_0leadership_follower_default_calculation.md b/tests/docs/examples/40_0leadership_follower_default_calculation.md new file mode 100644 index 0000000..a353904 --- /dev/null +++ b/tests/docs/examples/40_0leadership_follower_default_calculation.md @@ -0,0 +1,31 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +leader: + description: a leadership + type: leadership + leader: # a leader + follower1: value # a follower + follower2: + description: a second follower + default: + jinja: | + {{ _.follower1 }} + description: returns follower1 value +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + leader: + - leader: example + follower1: value + follower2: value +``` diff --git a/tests/docs/examples/40_0leadership_follower_default_submulti.md b/tests/docs/examples/40_0leadership_follower_default_submulti.md new file mode 100644 index 0000000..2f3643e --- /dev/null +++ b/tests/docs/examples/40_0leadership_follower_default_submulti.md @@ -0,0 +1,33 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +leader: + description: a leadership + type: leadership + leader: # a leader + - leader + follower1: # a follower1 + - value + follower2: # a follower2 + - value1 + - value2 +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + leader: + - leader: leader + follower1: + - value + follower2: + - value1 + - value2 +``` diff --git a/tests/docs/examples/40_0leadership_follower_default_submulti_calculation.md b/tests/docs/examples/40_0leadership_follower_default_submulti_calculation.md new file mode 100644 index 0000000..ec38cc7 --- /dev/null +++ b/tests/docs/examples/40_0leadership_follower_default_submulti_calculation.md @@ -0,0 +1,34 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +leader: + description: a leadership + type: leadership + leader: # the leader + - leader + follower1: # the follower1 + - value + follower2: + description: the follower2 + multi: true + default: + variable: _.follower1 +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + leader: + - leader: leader + follower1: + - value + follower2: + - value +``` diff --git a/tests/docs/examples/40_0leadership_follower_default_value.md b/tests/docs/examples/40_0leadership_follower_default_value.md new file mode 100644 index 0000000..439fa4d --- /dev/null +++ b/tests/docs/examples/40_0leadership_follower_default_value.md @@ -0,0 +1,27 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +leader: + description: a leadership + type: leadership + leader: + description: a leader + multi: true + mandatory: false + follower1: value # a follower with default value +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + leader: + - leader: example + follower1: value +``` diff --git a/tests/docs/examples/40_0leadership_leader_not_multi.md b/tests/docs/examples/40_0leadership_leader_not_multi.md new file mode 100644 index 0000000..39f7853 --- /dev/null +++ b/tests/docs/examples/40_0leadership_leader_not_multi.md @@ -0,0 +1,41 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +general: + mode_conteneur_actif: + type: string + description: No change + default: non +general1: + leader: + description: leader + type: leadership + leader: + type: string + description: leader + follower1: + type: string + description: follower1 + follower2: + type: string + description: follower2 +version: '1.0' +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + general: + mode_conteneur_actif: non + general1: + leader: + - leader: example + follower1: example + follower2: example +``` diff --git a/tests/docs/examples/40_1leadership_append_follower.md b/tests/docs/examples/40_1leadership_append_follower.md new file mode 100644 index 0000000..87c9707 --- /dev/null +++ b/tests/docs/examples/40_1leadership_append_follower.md @@ -0,0 +1,40 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/01-base.yml + +```yaml +--- +version: '1.1' +leader: + follower3: + description: the follower3 +``` +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +leader: + description: a leadership + type: leadership + leader: + description: the leader + multi: true + follower1: + description: the follower1 + follower2: + description: the follower2 +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + leader: + - leader: example + follower1: example + follower2: example + follower3: example +``` diff --git a/tests/docs/examples/40_2leadership_calculation_index.md b/tests/docs/examples/40_2leadership_calculation_index.md new file mode 100644 index 0000000..a704627 --- /dev/null +++ b/tests/docs/examples/40_2leadership_calculation_index.md @@ -0,0 +1,35 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +leader: + description: a leadership + type: leadership + leader: # a leader + - a + - b + - c + follower1: + description: a follower + type: number + default: + type: index +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + leader: + - leader: a + follower1: 0 + - leader: b + follower1: 1 + - leader: c + follower1: 2 +``` diff --git a/tests/docs/examples/40_2leadership_calculation_param_index.md b/tests/docs/examples/40_2leadership_calculation_param_index.md new file mode 100644 index 0000000..34e0876 --- /dev/null +++ b/tests/docs/examples/40_2leadership_calculation_param_index.md @@ -0,0 +1,39 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +leader: + description: leadership + type: leadership + leader: # a leader + - a + - b + - c + follower1: + description: a follower + type: number + default: + jinja: '{{ index }}' + params: + index: + type: index + description: returns index +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + leader: + - leader: a + follower1: 0 + - leader: b + follower1: 1 + - leader: c + follower1: 2 +``` diff --git a/tests/docs/examples/40_2leadership_leader_calculation.md b/tests/docs/examples/40_2leadership_leader_calculation.md new file mode 100644 index 0000000..55faf3b --- /dev/null +++ b/tests/docs/examples/40_2leadership_leader_calculation.md @@ -0,0 +1,40 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' + +leader: + description: a leadership + type: leadership + + leader: + description: a leader + multi: true + default: + jinja: | + val1 + val2 + description: returns val1 and val2 + + follower1: # a first follower + + follower2: # a second follower +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + leader: + - leader: val1 + follower1: example + follower2: example + - leader: val2 + follower1: example + follower2: example +``` diff --git a/tests/docs/examples/40_6leadership_follower_multi.md b/tests/docs/examples/40_6leadership_follower_multi.md new file mode 100644 index 0000000..897d3fc --- /dev/null +++ b/tests/docs/examples/40_6leadership_follower_multi.md @@ -0,0 +1,36 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.0' +leadership: + description: A leadership + type: leadership + leader: + description: The leader + multi: true + follower1: + description: The first follower + multi: true + follower2: + description: The second follower + multi: true + default: + - value +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + leadership: + - leader: example + follower1: + - example + follower2: + - value +``` diff --git a/tests/docs/examples/40_8calculation_boolean.md b/tests/docs/examples/40_8calculation_boolean.md new file mode 100644 index 0000000..7d4f392 --- /dev/null +++ b/tests/docs/examples/40_8calculation_boolean.md @@ -0,0 +1,49 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +bool: false # a boolean variable +multi1: + description: a first multi variable + type: boolean + multi: true + default: + jinja: | + {% if _.bool %} + True + False + {% else %} + False + {% endif %} + description: a calculation +multi2: + description: a second multi variable + type: boolean + multi: true + default: + jinja: | + {% if not _.bool %} + True + False + {% else %} + False + {% endif %} + description: a calculation +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + bool: false + multi1: + - false + multi2: + - true + - false +``` diff --git a/tests/docs/examples/40_8calculation_boolean_return_none.md b/tests/docs/examples/40_8calculation_boolean_return_none.md new file mode 100644 index 0000000..0212fb2 --- /dev/null +++ b/tests/docs/examples/40_8calculation_boolean_return_none.md @@ -0,0 +1,28 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: yes # a first variable +var2: + description: a second variable + type: boolean + default: + jinja: | + {% if rougail.var1 == 'no' %} + false + {% endif %} + description: return false if the value of var1 is "no" +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var1: yes + var2: xxx +``` diff --git a/tests/docs/examples/40_8calculation_integer.md b/tests/docs/examples/40_8calculation_integer.md new file mode 100644 index 0000000..910f1ac --- /dev/null +++ b/tests/docs/examples/40_8calculation_integer.md @@ -0,0 +1,34 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +bool: false # a boolean variable +int1: + description: first integer variable + type: number + default: + jinja: | + {% if rougail.bool %}1{% else %}2{% endif %} + description: if bool returns 1 otherwise return 2 +int2: + description: second integer variable + type: number + default: + jinja: | + {% if not rougail.bool %}3{% else %}4{% endif %} + description: if bool returns 3 otherwise return 4 +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + bool: false + int1: 2 + int2: 3 +``` diff --git a/tests/docs/examples/40_8calculation_multi_variable.md b/tests/docs/examples/40_8calculation_multi_variable.md new file mode 100644 index 0000000..f88c2ca --- /dev/null +++ b/tests/docs/examples/40_8calculation_multi_variable.md @@ -0,0 +1,28 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: + description: a first variable + default: + - variable: _.var2 + - variable: _.var3 +var2: no # a second variable +var3: yes # a third variable +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var: + - no + - yes + var2: no + var3: yes +``` diff --git a/tests/docs/examples/40_8calculation_multi_variable_parent.md b/tests/docs/examples/40_8calculation_multi_variable_parent.md new file mode 100644 index 0000000..aa73497 --- /dev/null +++ b/tests/docs/examples/40_8calculation_multi_variable_parent.md @@ -0,0 +1,25 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: no # a variable +fam1: # a family + var: + description: a calculated variable + default: + variable: __.var +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var: no + fam1: + var: no +``` diff --git a/tests/docs/examples/40_8calculation_multi_variable_parent2.md b/tests/docs/examples/40_8calculation_multi_variable_parent2.md new file mode 100644 index 0000000..771017b --- /dev/null +++ b/tests/docs/examples/40_8calculation_multi_variable_parent2.md @@ -0,0 +1,27 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +fam1: # first family + var: no # a variable +fam2: # second family + var: + description: a varaible + default: + variable: __.fam1.var +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + fam1: + var: no + fam2: + var: no +``` diff --git a/tests/docs/examples/41_0choice_leader.md b/tests/docs/examples/41_0choice_leader.md new file mode 100644 index 0000000..a3201d2 --- /dev/null +++ b/tests/docs/examples/41_0choice_leader.md @@ -0,0 +1,33 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.0' +leader: + description: The leadership + type: leadership + leader: + description: The leader + multi: true + mandatory: false + follower1: + type: choice + description: A follower + choices: + - a + - b + - c +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + leader: + - leader: example + follower1: a_choice +``` diff --git a/tests/docs/examples/44_0leadership_hidden.md b/tests/docs/examples/44_0leadership_hidden.md new file mode 100644 index 0000000..626b112 --- /dev/null +++ b/tests/docs/examples/44_0leadership_hidden.md @@ -0,0 +1,23 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' + +leader: + description: a leadership + hidden: true + type: leadership + + leader: + description: a leader + mandatory: false + + follower: + description: a follower + mandatory: false +``` diff --git a/tests/docs/examples/44_0leadership_leader_hidden.md b/tests/docs/examples/44_0leadership_leader_hidden.md new file mode 100644 index 0000000..a7690be --- /dev/null +++ b/tests/docs/examples/44_0leadership_leader_hidden.md @@ -0,0 +1,24 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' + +leader: + description: a leadership + type: leadership + + leader: + description: a leader + multi: true + hidden: true + mandatory: false + + follower: + description: a follower + mandatory: false +``` diff --git a/tests/docs/examples/44_1leadership_append_hidden_follower.md b/tests/docs/examples/44_1leadership_append_hidden_follower.md new file mode 100644 index 0000000..87edbdd --- /dev/null +++ b/tests/docs/examples/44_1leadership_append_hidden_follower.md @@ -0,0 +1,34 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/01-base.yml + +```yaml +--- +version: '1.1' +leader: + follower3: + description: follower3 + mandatory: false +``` +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +leader: + description: a leadership + type: leadership + leader: + description: a leader + multi: true + hidden: true + mandatory: false + follower1: + description: the follower1 + mandatory: false + follower2: + description: the follower2 + mandatory: false +``` diff --git a/tests/docs/examples/44_4disabled_calcultion_follower.md b/tests/docs/examples/44_4disabled_calcultion_follower.md new file mode 100644 index 0000000..7dff899 --- /dev/null +++ b/tests/docs/examples/44_4disabled_calcultion_follower.md @@ -0,0 +1,36 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +condition: true # a condition +leader: + description: a leadership + type: leadership + leader: + description: aleader + default: + - a + follower: + description: a follower + disabled: + jinja: | + {% if rougail.condition == "yes" %} + condition is yes + {% endif %} + description: if condition is yes +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + condition: true + leader: + - leader: a + follower: example +``` diff --git a/tests/docs/examples/44_4leadership_mandatory.md b/tests/docs/examples/44_4leadership_mandatory.md new file mode 100644 index 0000000..9c83d59 --- /dev/null +++ b/tests/docs/examples/44_4leadership_mandatory.md @@ -0,0 +1,29 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +leader: + description: a leadership + type: leadership + leader: + description: a leader + multi: true + mandatory: true + follower1: + description: a follower + mandatory: false +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + leader: + - leader: example + follower1: example +``` diff --git a/tests/docs/examples/44_4leadership_mandatory_follower.md b/tests/docs/examples/44_4leadership_mandatory_follower.md new file mode 100644 index 0000000..e938afa --- /dev/null +++ b/tests/docs/examples/44_4leadership_mandatory_follower.md @@ -0,0 +1,29 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.0' +leader: + description: a leadership + type: leadership + leader: + description: a leader + multi: true + mandatory: false + follower: + description: a follower + mandatory: true +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + leader: + - leader: example + follower: example +``` diff --git a/tests/docs/examples/44_5leadership_leader_hidden_calculation.md b/tests/docs/examples/44_5leadership_leader_hidden_calculation.md new file mode 100644 index 0000000..c08649f --- /dev/null +++ b/tests/docs/examples/44_5leadership_leader_hidden_calculation.md @@ -0,0 +1,35 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +condition: no # a condition +leader: + description: a leadership + type: leadership + leader: + description: a leader + multi: true + hidden: + jinja: | + {% if __.condition == "no" %} + condition is no + {% endif %} + description: if condition is no + mandatory: false + follower: # a follower +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + condition: no + leader: + - leader: example + follower: example +``` diff --git a/tests/docs/examples/44_6leadership_follower_disabled_calculation.md b/tests/docs/examples/44_6leadership_follower_disabled_calculation.md new file mode 100644 index 0000000..d6c255d --- /dev/null +++ b/tests/docs/examples/44_6leadership_follower_disabled_calculation.md @@ -0,0 +1,35 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +condition: yes # a condition +leader: + description: a leadership + type: leadership + leader: + description: a leader + multi: true + follower: + description: a follower + disabled: + jinja: | + {% if __.condition == "yes" %} + disabled + {% endif %} + description: if condition is yes +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + condition: yes + leader: + - leader: example + follower: example +``` diff --git a/tests/docs/examples/44_9calculated_default_leadership_leader.md b/tests/docs/examples/44_9calculated_default_leadership_leader.md new file mode 100644 index 0000000..0b4f1b5 --- /dev/null +++ b/tests/docs/examples/44_9calculated_default_leadership_leader.md @@ -0,0 +1,37 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: 1.1 +leader: + description: leader + type: leadership + leader: # a leader + - a + - b + follower: + description: a follower + disabled: + jinja: | + {% if _.leader == "a" %} + the value of "leader" is "a" + {% endif %} + description: if the value of "leader" is "a" + default: + variable: _.leader +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + leader: + - leader: a + follower: a + - leader: b + follower: b +``` diff --git a/tests/docs/examples/60_0family_dynamic.md b/tests/docs/examples/60_0family_dynamic.md new file mode 100644 index 0000000..126b9a5 --- /dev/null +++ b/tests/docs/examples/60_0family_dynamic.md @@ -0,0 +1,43 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' + +var: # A suffix variable + - val1 + - val2 + +dyn{{ identifier }}: + description: A dynamic family + dynamic: + variable: _.var + var: # A dynamic variable +``` +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + dynval1: + var: example + dynval2: + var: example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var: + - val1 + - val2 + dynval1: + var: example + dynval2: + var: example +``` diff --git a/tests/docs/examples/60_0family_dynamic_1_0.md b/tests/docs/examples/60_0family_dynamic_1_0.md new file mode 100644 index 0000000..873de62 --- /dev/null +++ b/tests/docs/examples/60_0family_dynamic_1_0.md @@ -0,0 +1,35 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.0' +var: + description: A suffix variable + multi: true + default: + - val1 + - val2 +dyn: + type: dynamic + variable: rougail.var + vardyn: + description: Dynamic variable + mandatory: false +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var: + - val1 + - val2 + dynval1: + vardyn: example + dynval2: + vardyn: example +``` diff --git a/tests/docs/examples/60_0family_dynamic_1_0_type.md b/tests/docs/examples/60_0family_dynamic_1_0_type.md new file mode 100644 index 0000000..2fa0e2e --- /dev/null +++ b/tests/docs/examples/60_0family_dynamic_1_0_type.md @@ -0,0 +1,44 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.0' +var: + description: A suffix variable + multi: true + default: + - val1 + - val2 +dyn: + _type: dynamic + variable: rougail.var + vardyn: + description: A dyn variable +``` +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + dynval1: + vardyn: example + dynval2: + vardyn: example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var: + - val1 + - val2 + dynval1: + vardyn: example + dynval2: + vardyn: example +``` diff --git a/tests/docs/examples/60_0family_dynamic_1_1.md b/tests/docs/examples/60_0family_dynamic_1_1.md new file mode 100644 index 0000000..1de0c2b --- /dev/null +++ b/tests/docs/examples/60_0family_dynamic_1_1.md @@ -0,0 +1,42 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: # A suffix variable + - val1 + - val2 +dyn: + type: dynamic + description: A dynamic family + variable: _.var + vardyn: + description: A dynamic variable +``` +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + dynval1: + vardyn: example + dynval2: + vardyn: example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var: + - val1 + - val2 + dynval1: + vardyn: example + dynval2: + vardyn: example +``` diff --git a/tests/docs/examples/60_0family_dynamic_jinja_number.md b/tests/docs/examples/60_0family_dynamic_jinja_number.md new file mode 100644 index 0000000..78cb8ec --- /dev/null +++ b/tests/docs/examples/60_0family_dynamic_jinja_number.md @@ -0,0 +1,38 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: # a suffix variable + - 1 + - 2 +dyn{{ identifier }}: + description: a dynamic family + dynamic: + variable: _.var + var: val # a variable inside dynamic family +var2: + description: a variable + default: + jinja: | + {{ rougail.dyn1.var }} + description: get the value of rougail.dyn1.var +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var: + - 1 + - 2 + dyn1: + var: val + dyn2: + var: val + var2: val +``` diff --git a/tests/docs/examples/60_0family_dynamic_no_description.md b/tests/docs/examples/60_0family_dynamic_no_description.md new file mode 100644 index 0000000..5119a90 --- /dev/null +++ b/tests/docs/examples/60_0family_dynamic_no_description.md @@ -0,0 +1,43 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' + +var: # A suffix variable + - val1 + - val2 + +dyn{{ identifier }}: + description: A dynamic family + dynamic: + variable: _.var + var: +``` +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + dynval1: + var: example + dynval2: + var: example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var: + - val1 + - val2 + dynval1: + var: example + dynval2: + var: example +``` diff --git a/tests/docs/examples/60_0family_dynamic_static.md b/tests/docs/examples/60_0family_dynamic_static.md new file mode 100644 index 0000000..5b1f1da --- /dev/null +++ b/tests/docs/examples/60_0family_dynamic_static.md @@ -0,0 +1,36 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +dyn{{ identifier }}: + description: a dynamic family + dynamic: + - val1 + - val2 + var: # a variable inside a dynamic family +``` +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + dynval1: + var: example + dynval2: + var: example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + dynval1: + var: example + dynval2: + var: example +``` diff --git a/tests/docs/examples/60_0family_dynamic_test.md b/tests/docs/examples/60_0family_dynamic_test.md new file mode 100644 index 0000000..aa016dc --- /dev/null +++ b/tests/docs/examples/60_0family_dynamic_test.md @@ -0,0 +1,50 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' + +var: + description: A suffix variable + multi: true + test: + - val1 + - val2 + +dyn{{ identifier }}: + description: A dynamic family + dynamic: + variable: _.var + + var: # A dynamic variable +``` +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + var: + - val1 + - val2 + dynval1: + var: example + dynval2: + var: example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var: + - val1 + - val2 + dynval1: + var: example + dynval2: + var: example +``` diff --git a/tests/docs/examples/60_0family_dynamic_variable_empty.md b/tests/docs/examples/60_0family_dynamic_variable_empty.md new file mode 100644 index 0000000..9972cd5 --- /dev/null +++ b/tests/docs/examples/60_0family_dynamic_variable_empty.md @@ -0,0 +1,34 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: [] # a suffix variable +dyn{{ identifier }}: + description: a dynamic family + dynamic: + variable: _.var + var: val # a variable inside dynamic family +``` +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + var: + - example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var: + - example + dynexample: + var: val +``` diff --git a/tests/docs/examples/60_0family_dynamic_variable_suffix.md b/tests/docs/examples/60_0family_dynamic_variable_suffix.md new file mode 100644 index 0000000..a80f345 --- /dev/null +++ b/tests/docs/examples/60_0family_dynamic_variable_suffix.md @@ -0,0 +1,31 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: # A suffix variable + - val1 + - val2 +dyn{{ identifier }}: + description: A dynamic family + dynamic: + variable: _.var + var: a value # A dynamic variable with suffix {{ identifier }} +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var: + - val1 + - val2 + dynval1: + var: a value + dynval2: + var: a value +``` diff --git a/tests/docs/examples/60_0family_empty.md b/tests/docs/examples/60_0family_empty.md new file mode 100644 index 0000000..252df76 --- /dev/null +++ b/tests/docs/examples/60_0family_empty.md @@ -0,0 +1,12 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.0' +general2: + type: family +``` diff --git a/tests/docs/examples/60_0family_hidden.md b/tests/docs/examples/60_0family_hidden.md new file mode 100644 index 0000000..ee44f10 --- /dev/null +++ b/tests/docs/examples/60_0family_hidden.md @@ -0,0 +1,23 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/01-base.yml + +```yaml +--- +version: '1.1' +family: + redefine: true + hidden: true +``` +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +family: # a family + var: + description: a variable + mandatory: false +``` diff --git a/tests/docs/examples/60_0family_mode.md b/tests/docs/examples/60_0family_mode.md new file mode 100644 index 0000000..192710c --- /dev/null +++ b/tests/docs/examples/60_0family_mode.md @@ -0,0 +1,23 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +family: # a family + var: + description: A variable + mode: basic + default: non +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + family: + var: non +``` diff --git a/tests/docs/examples/60_1family_dynamic_jinja.md b/tests/docs/examples/60_1family_dynamic_jinja.md new file mode 100644 index 0000000..6e6c325 --- /dev/null +++ b/tests/docs/examples/60_1family_dynamic_jinja.md @@ -0,0 +1,35 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: # a suffix variable + - val1 + - val2 +dyn{{ identifier }}: + description: A dynamic family + dynamic: + jinja: | + {% for val in _.var %} + {{ loop.index }} + {% endfor %} + description: index of suffix value + var: val # a dynamic variable +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var: + - val1 + - val2 + dyn1: + var: val + dyn2: + var: val +``` diff --git a/tests/docs/examples/60_2family_dynamic_jinja_fill_sub_group.md b/tests/docs/examples/60_2family_dynamic_jinja_fill_sub_group.md new file mode 100644 index 0000000..66744b1 --- /dev/null +++ b/tests/docs/examples/60_2family_dynamic_jinja_fill_sub_group.md @@ -0,0 +1,53 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: # a suffix variable + - val1 + - val2 +dyn{{ identifier }}: + description: a dynamic family + dynamic: + variable: _.var1 + family: # a family + var: # with a variable +var2: + description: a second variable + default: + jinja: | + {{ _.dynval1.family.var }} + description: the value of var +``` +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + dynval1: + family: + var: example + dynval2: + family: + var: example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var1: + - val1 + - val2 + dynval1: + family: + var: example + dynval2: + family: + var: example + var2: example +``` diff --git a/tests/docs/examples/60_2family_dynamic_jinja_fill_sub_group_2.md b/tests/docs/examples/60_2family_dynamic_jinja_fill_sub_group_2.md new file mode 100644 index 0000000..fbf87b9 --- /dev/null +++ b/tests/docs/examples/60_2family_dynamic_jinja_fill_sub_group_2.md @@ -0,0 +1,45 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: # a identifier variable + - val1 + - val2 +dyn{{ identifier }}: + description: a dynamic family + dynamic: + variable: _.var + family: + description: a family inside dynamic family + var: + description: a dynamic variable + default: + type: identifier +var2: + description: a varible outside dynamic family + default: + jinja: | + {{ _.dynval1.family.var }} + description: the value of var +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var: + - val1 + - val2 + dynval1: + family: + var: val1 + dynval2: + family: + var: val2 + var2: val1 +``` diff --git a/tests/docs/examples/60_2family_dynamic_outside_calc.md b/tests/docs/examples/60_2family_dynamic_outside_calc.md new file mode 100644 index 0000000..d750a3e --- /dev/null +++ b/tests/docs/examples/60_2family_dynamic_outside_calc.md @@ -0,0 +1,38 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: # a suffx variable + - val1 + - val2 +dyn{{ identifier }}: + description: a dynamic family + dynamic: + variable: _.var1 + var: val # a dynamic variable +newvar: + description: a second variable + default: + jinja: | + {{ _.dynval1.var }} + description: the value of var +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var1: + - val1 + - val2 + dynval1: + var: val + dynval2: + var: val + newvar: val +``` diff --git a/tests/docs/examples/60_5family_dynamic_calc2.md b/tests/docs/examples/60_5family_dynamic_calc2.md new file mode 100644 index 0000000..b4042e5 --- /dev/null +++ b/tests/docs/examples/60_5family_dynamic_calc2.md @@ -0,0 +1,50 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' + +var: # A suffix variable + - val1 + - val2 + +var2: # a second variable + +dyn{{ identifier }}: + description: A dynamic family + dynamic: + variable: _.var + hidden: + jinja: | + {% if _.var2 == "no" %} + var2 is no + {% endif %} + description: if var2 is no + + vardyn: val # a dynamic variable +``` +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + var2: example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var: + - val1 + - val2 + var2: example + dynval1: + vardyn: val + dynval2: + vardyn: val +``` diff --git a/tests/docs/examples/60_5family_dynamic_calc_suffix.md b/tests/docs/examples/60_5family_dynamic_calc_suffix.md new file mode 100644 index 0000000..dca8c83 --- /dev/null +++ b/tests/docs/examples/60_5family_dynamic_calc_suffix.md @@ -0,0 +1,52 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' + +var1: + description: A suffix variable + default: + - val1 + - val2 + +dyn{{ identifier }}: + dynamic: + variable: _.var1 + + var: + description: A dynamic variable + +var2: + description: A variable calculated + default: + variable: rougail.dynval1.var +``` +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + dynval1: + var: example + dynval2: + var: example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var1: + - val1 + - val2 + dynval1: + var: example + dynval2: + var: example + var2: example +``` diff --git a/tests/docs/examples/60_5family_dynamic_calc_suffix2.md b/tests/docs/examples/60_5family_dynamic_calc_suffix2.md new file mode 100644 index 0000000..50c4eea --- /dev/null +++ b/tests/docs/examples/60_5family_dynamic_calc_suffix2.md @@ -0,0 +1,34 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: # a suffix variable + - val1 + - val2 +dyn{{ identifier }}: + description: a dynamic family + dynamic: + variable: _.var + var: + description: Suffix has value + default: + type: identifier +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var: + - val1 + - val2 + dynval1: + var: val1 + dynval2: + var: val2 +``` diff --git a/tests/docs/examples/60_5family_dynamic_calc_suffix_disabled.md b/tests/docs/examples/60_5family_dynamic_calc_suffix_disabled.md new file mode 100644 index 0000000..5ff378c --- /dev/null +++ b/tests/docs/examples/60_5family_dynamic_calc_suffix_disabled.md @@ -0,0 +1,39 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +dyn{{ identifier }}: + dynamic: + - val1 + - val2 + var: + description: A dynamic variable + disabled: + type: identifier + when: val1 +``` +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + dynval1: + var: example + dynval2: + var: example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + dynval1: + var: example + dynval2: + var: example +``` diff --git a/tests/docs/examples/60_5family_dynamic_calc_suffix_param.md b/tests/docs/examples/60_5family_dynamic_calc_suffix_param.md new file mode 100644 index 0000000..e9dce5d --- /dev/null +++ b/tests/docs/examples/60_5family_dynamic_calc_suffix_param.md @@ -0,0 +1,39 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: # A identifier variable + - val1 + - val2 +dyn{{ identifier }}: + description: A dynamic family + dynamic: + variable: _.var + var: + description: A dynamic variable + default: + jinja: | + {{ identifier }} + params: + identifier: + type: identifier + description: from suffix +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var: + - val1 + - val2 + dynval1: + var: val1 + dynval2: + var: val2 +``` diff --git a/tests/docs/examples/60_5family_dynamic_calc_variable.md b/tests/docs/examples/60_5family_dynamic_calc_variable.md new file mode 100644 index 0000000..58a51d7 --- /dev/null +++ b/tests/docs/examples/60_5family_dynamic_calc_variable.md @@ -0,0 +1,49 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: + description: A suffix variable + default: + - val1 + - val2 +dyn{{ identifier }}: + dynamic: + variable: _.var1 + propertyerror: false + var: + description: A dynamic variable +var2: + description: A variable calculated + default: + variable: _.dynval1.var +``` +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + dynval1: + var: example + dynval2: + var: example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var1: + - val1 + - val2 + dynval1: + var: example + dynval2: + var: example + var2: example +``` diff --git a/tests/docs/examples/60_5family_dynamic_hidden_suffix.md b/tests/docs/examples/60_5family_dynamic_hidden_suffix.md new file mode 100644 index 0000000..009c050 --- /dev/null +++ b/tests/docs/examples/60_5family_dynamic_hidden_suffix.md @@ -0,0 +1,46 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +dyn{{ identifier }}: + description: a dynamic family + dynamic: + - val1 + - val2 + hidden: + jinja: | + {% if suffix == 'val2' %} + disabled + {% endif %} + params: + suffix: + type: identifier + description: if suffix == 'val2' + + var: + description: a variable + mandatory: false + family: # a family + var: + description: a new variable + mandatory: false +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + dynval1: + var: example + family: + var: example + dynval2: + var: example + family: + var: example +``` diff --git a/tests/docs/examples/60_5family_dynamic_variable_outside.md b/tests/docs/examples/60_5family_dynamic_variable_outside.md new file mode 100644 index 0000000..868a365 --- /dev/null +++ b/tests/docs/examples/60_5family_dynamic_variable_outside.md @@ -0,0 +1,43 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: # a suffix variable + - val1 + - val2 +my_dyn_family_{{ identifier }}: + description: a dynamic family + dynamic: + variable: _.var + var: + description: a variable inside a dynamic family + default: + type: identifier + mandatory: false +var2: + description: a variable + multi: true + default: + variable: rougail.my_dyn_family_{{ identifier }}.var +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var: + - val1 + - val2 + my_dyn_family_val1: + var: val1 + my_dyn_family_val2: + var: val2 + var2: + - val1 + - val2 +``` diff --git a/tests/docs/examples/60_5family_dynamic_variable_outside2.md b/tests/docs/examples/60_5family_dynamic_variable_outside2.md new file mode 100644 index 0000000..ada7968 --- /dev/null +++ b/tests/docs/examples/60_5family_dynamic_variable_outside2.md @@ -0,0 +1,47 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' + +var2: + description: a variable + multi: true + default: + variable: rougail.my_dyn_family_{{ identifier }}.var + +var: # a suffix variable + - val1 + - val2 + +my_dyn_family_{{ identifier }}: + description: a dynamic family + dynamic: + variable: _.var + + var: + description: a variable inside a dynamic family + default: + type: identifier + mandatory: false +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var2: + - val1 + - val2 + var: + - val1 + - val2 + my_dyn_family_val1: + var: val1 + my_dyn_family_val2: + var: val2 +``` diff --git a/tests/docs/examples/60_5family_dynamic_variable_outside_jinja.md b/tests/docs/examples/60_5family_dynamic_variable_outside_jinja.md new file mode 100644 index 0000000..5fa7385 --- /dev/null +++ b/tests/docs/examples/60_5family_dynamic_variable_outside_jinja.md @@ -0,0 +1,49 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: # a suffix variable + - val1 + - val2 +my_dyn_family_{{ identifier }}: + description: a dynamic family + dynamic: + variable: _.var + var: + description: a variable inside a dynamic family + default: + type: identifier + mandatory: false +var2: + description: a variable + multi: true + default: + jinja: |- + {%- for v in var %} + {{ v }} + {%- endfor -%} + params: + var: + variable: rougail.my_dyn_family_{{ identifier }}.var +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var: + - val1 + - val2 + my_dyn_family_val1: + var: val1 + my_dyn_family_val2: + var: val2 + var2: + - val1 + - val2 +``` diff --git a/tests/docs/examples/60_5family_dynamic_variable_outside_suffix.md b/tests/docs/examples/60_5family_dynamic_variable_outside_suffix.md new file mode 100644 index 0000000..8336db7 --- /dev/null +++ b/tests/docs/examples/60_5family_dynamic_variable_outside_suffix.md @@ -0,0 +1,39 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: # a suffix variable + - val1 + - val2 +dyn_{{ identifier }}: + description: a dynamic family + dynamic: + variable: _.var + var: + description: a variable inside dynamic family + default: + type: identifier +var2: + description: a variable + default: + variable: _.dyn_val1.var +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var: + - val1 + - val2 + dyn_val1: + var: val1 + dyn_val2: + var: val2 + var2: val1 +``` diff --git a/tests/docs/examples/60_6family_dynamic_inside.md b/tests/docs/examples/60_6family_dynamic_inside.md new file mode 100644 index 0000000..80aad8b --- /dev/null +++ b/tests/docs/examples/60_6family_dynamic_inside.md @@ -0,0 +1,53 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: # a suffix variable + - val1 + - val2 + +'{{ identifier }}_dyn': + description: a dynamic family + dynamic: + variable: _.var + var1: + description: value is suffix + default: + type: identifier + var2: + description: value is first variable + default: + variable: rougail.{{ identifier }}_dyn.var1 + var3: + description: value is relative first variable + default: + variable: _.var1 + var4: + description: value is first variable of val1 + default: + variable: rougail.val1_dyn.var1 +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var: + - val1 + - val2 + val1_dyn: + var1: val1 + var2: val1 + var3: val1 + var4: val1 + val2_dyn: + var1: val2 + var2: val2 + var3: val2 + var4: val1 +``` diff --git a/tests/docs/examples/60_6family_dynamic_leadership.md b/tests/docs/examples/60_6family_dynamic_leadership.md new file mode 100644 index 0000000..6b0107a --- /dev/null +++ b/tests/docs/examples/60_6family_dynamic_leadership.md @@ -0,0 +1,48 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: # a suffix variable + - val1 + - val2 +dyn{{ identifier }}: + description: a dynamic family + dynamic: + variable: _.var + leadership: + description: a leadership + type: leadership + leader: + description: a leader + multi: true + follower1: + description: a follower1 + mandatory: false + follower2: + description: a follower2 + mandatory: false +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var: + - val1 + - val2 + dynval1: + leadership: + - leader: example + follower1: example + follower2: example + dynval2: + leadership: + - leader: example + follower1: example + follower2: example +``` diff --git a/tests/docs/examples/60_6family_dynamic_sub_dynamic.md b/tests/docs/examples/60_6family_dynamic_sub_dynamic.md new file mode 100644 index 0000000..16908ef --- /dev/null +++ b/tests/docs/examples/60_6family_dynamic_sub_dynamic.md @@ -0,0 +1,85 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: # A identifier variable + - val1 + - val2 +dyn{{ identifier }}: + description: A dynamic family + dynamic: + variable: _.var + var: + description: A dynamic variable + multi: true + default: + jinja: | + {% for val in __.var %} + t{{ val }} + {% endfor %} + description: add 't' to each var value + dyn_{{ identifier }}: + description: a Second dynamic variable + dynamic: + variable: rougail.dyn{{ identifier }}.var + var: + description: A variable dynamic + default: + type: identifier + var_identifier: + description: identifier from first family + default: + type: identifier + identifier: 0 + var_identifiers: + description: merge identifiers + default: + jinja: | + {{ s1 }}-{{ s2 }} + params: + s1: + type: identifier + identifier: 0 + s2: + type: identifier + identifier: 1 + description: join identifier 1 et identifier 2 +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var: + - val1 + - val2 + dynval1: + var: + - tval1 + - tval2 + dyn_tval1: + var: tval1 + var_identifier: val1 + var_identifiers: val1-tval1 + dyn_tval2: + var: tval2 + var_identifier: val1 + var_identifiers: val1-tval2 + dynval2: + var: + - tval1 + - tval2 + dyn_tval1: + var: tval1 + var_identifier: val2 + var_identifiers: val2-tval1 + dyn_tval2: + var: tval2 + var_identifier: val2 + var_identifiers: val2-tval2 +``` diff --git a/tests/docs/examples/60_9extra_dynamic.md b/tests/docs/examples/60_9extra_dynamic.md new file mode 100644 index 0000000..089e3c9 --- /dev/null +++ b/tests/docs/examples/60_9extra_dynamic.md @@ -0,0 +1,41 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: 1.1 +var: # a variable + - a +``` +# dictionaries/extra/00-base.yml + +```yaml +--- +version: 1.1 +dyn_{{ identifier }}: + dynamic: + variable: rougail.var + var: +``` +# Example with mandatory variables not filled in + +```yaml +--- +extra: + dyn_a: + var: example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var: + - a +extra: + dyn_a: + var: example +``` diff --git a/tests/docs/examples/60_9extra_dynamic_extra.md b/tests/docs/examples/60_9extra_dynamic_extra.md new file mode 100644 index 0000000..8e22d24 --- /dev/null +++ b/tests/docs/examples/60_9extra_dynamic_extra.md @@ -0,0 +1,52 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +general: + description: général + varname: + type: string + description: No change + multi: true + default: + - a +version: '1.0' +``` +# dictionaries/extra/00-base.yml + +```yaml +--- +version: '1.1' +var: # a varaible + - a +dyn_{{ identifier }}: + dynamic: + variable: _.var + var: +``` +# Example with mandatory variables not filled in + +```yaml +--- +extra: + dyn_a: + var: example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + general: + varname: + - a +extra: + var: + - a + dyn_a: + var: example +``` diff --git a/tests/docs/examples/60_9family_dynamic_calc_both.md b/tests/docs/examples/60_9family_dynamic_calc_both.md new file mode 100644 index 0000000..ee34445 --- /dev/null +++ b/tests/docs/examples/60_9family_dynamic_calc_both.md @@ -0,0 +1,38 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: val2 # a suffix variable +dyn{{ identifier }}: + description: a dynamic family + dynamic: + - val1 + - variable: _.var + vardyn: # a dynamic variable +``` +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + dynval1: + vardyn: example + dynval2: + vardyn: example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var: val2 + dynval1: + vardyn: example + dynval2: + vardyn: example +``` diff --git a/tests/docs/examples/68_0family_leadership_mode.md b/tests/docs/examples/68_0family_leadership_mode.md new file mode 100644 index 0000000..1b975a3 --- /dev/null +++ b/tests/docs/examples/68_0family_leadership_mode.md @@ -0,0 +1,33 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.0' +leader: + description: A leadership + type: leadership + leader: + description: A leader + multi: true + mandatory: false + follower1: + description: a follower1 + mandatory: false + follower2: + description: a follower2 + mode: basic +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + leader: + - leader: example + follower1: example + follower2: example +``` diff --git a/tests/docs/no_namespace/00_0empty.json b/tests/docs/no_namespace/00_0empty.json new file mode 100644 index 0000000..9e26dfe --- /dev/null +++ b/tests/docs/no_namespace/00_0empty.json @@ -0,0 +1 @@ +{} \ No newline at end of file diff --git a/tests/docs/no_namespace/00_0version_underscore.adoc b/tests/docs/no_namespace/00_0version_underscore.adoc index d048ae9..627a0d3 100644 --- a/tests/docs/no_namespace/00_0version_underscore.adoc +++ b/tests/docs/no_namespace/00_0version_underscore.adoc @@ -10,11 +10,11 @@ version: # a variable [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **version** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A variable. |==== - diff --git a/tests/docs/no_namespace/00_0version_underscore.json b/tests/docs/no_namespace/00_0version_underscore.json new file mode 100644 index 0000000..3cba9c9 --- /dev/null +++ b/tests/docs/no_namespace/00_0version_underscore.json @@ -0,0 +1 @@ +{"version": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["version"], "names": ["version"], "descriptions": ["A variable."]}} \ No newline at end of file diff --git a/tests/docs/no_namespace/00_0version_underscore.md b/tests/docs/no_namespace/00_0version_underscore.md index b866ae7..71fe364 100644 --- a/tests/docs/no_namespace/00_0version_underscore.md +++ b/tests/docs/no_namespace/00_0version_underscore.md @@ -11,7 +11,7 @@ version: # a variable ``` # Variables -| Variable                                                                                                                | Description                                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **version**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **version**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | diff --git a/tests/docs/no_namespace/00_1empty_variable.adoc b/tests/docs/no_namespace/00_1empty_variable.adoc index 512602a..6b9de48 100644 --- a/tests/docs/no_namespace/00_1empty_variable.adoc +++ b/tests/docs/no_namespace/00_1empty_variable.adoc @@ -10,11 +10,11 @@ empty: [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **empty** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -Empty. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +Empty. |==== - diff --git a/tests/docs/no_namespace/00_1empty_variable.json b/tests/docs/no_namespace/00_1empty_variable.json new file mode 100644 index 0000000..4bb7826 --- /dev/null +++ b/tests/docs/no_namespace/00_1empty_variable.json @@ -0,0 +1 @@ +{"empty": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["empty"], "names": ["empty"]}} \ No newline at end of file diff --git a/tests/docs/no_namespace/00_1empty_variable.md b/tests/docs/no_namespace/00_1empty_variable.md index c866c20..7348469 100644 --- a/tests/docs/no_namespace/00_1empty_variable.md +++ b/tests/docs/no_namespace/00_1empty_variable.md @@ -15,4 +15,3 @@ empty: |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **empty**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | Empty. | - diff --git a/tests/docs/no_namespace/00_2default_calculated.adoc b/tests/docs/no_namespace/00_2default_calculated.adoc index 5f40f25..fce43ec 100644 --- a/tests/docs/no_namespace/00_2default_calculated.adoc +++ b/tests/docs/no_namespace/00_2default_calculated.adoc @@ -17,17 +17,18 @@ var2: [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A first variable. + -**Default**: no +**Default**: no | + **var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | A second variable. + -**Default**: the value of var1. +**Default**: the value of var1. |==== - diff --git a/tests/docs/no_namespace/00_2default_calculated.json b/tests/docs/no_namespace/00_2default_calculated.json new file mode 100644 index 0000000..2fb7ffd --- /dev/null +++ b/tests/docs/no_namespace/00_2default_calculated.json @@ -0,0 +1 @@ +{"var1": {"type": "variable", "default": "no", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["var1"], "names": ["var1"], "descriptions": ["A first variable."]}, "var2": {"type": "variable", "default": "the value of var1.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var2"], "names": ["var2"], "descriptions": ["A second variable."], "multiple": true}} \ No newline at end of file diff --git a/tests/docs/no_namespace/00_2default_calculated.md b/tests/docs/no_namespace/00_2default_calculated.md index 13d3f98..b3da829 100644 --- a/tests/docs/no_namespace/00_2default_calculated.md +++ b/tests/docs/no_namespace/00_2default_calculated.md @@ -23,4 +23,3 @@ var2: | **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A first variable.
**Default**: no | | **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A second variable.
**Default**: the value of var1. | - diff --git a/tests/docs/no_namespace/00_2default_calculated_multi.adoc b/tests/docs/no_namespace/00_2default_calculated_multi.adoc index 5613c97..d9823cd 100644 --- a/tests/docs/no_namespace/00_2default_calculated_multi.adoc +++ b/tests/docs/no_namespace/00_2default_calculated_multi.adoc @@ -22,21 +22,22 @@ var2: [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | A first variable. + **Default**: * no * yes -* maybe +* maybe | + **var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | A second variable. + -**Default**: the value of _.var1. +**Default**: the value of _.var1. |==== - diff --git a/tests/docs/no_namespace/00_2default_calculated_multi.json b/tests/docs/no_namespace/00_2default_calculated_multi.json new file mode 100644 index 0000000..5354ed1 --- /dev/null +++ b/tests/docs/no_namespace/00_2default_calculated_multi.json @@ -0,0 +1 @@ +{"var1": {"type": "variable", "default": ["no", "yes", "maybe"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var1"], "names": ["var1"], "descriptions": ["A first variable."], "multiple": true}, "var2": {"type": "variable", "default": "the value of _.var1.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var2"], "names": ["var2"], "descriptions": ["A second variable."], "multiple": true}} \ No newline at end of file diff --git a/tests/docs/no_namespace/00_2default_calculated_multi.md b/tests/docs/no_namespace/00_2default_calculated_multi.md index 3698376..e583110 100644 --- a/tests/docs/no_namespace/00_2default_calculated_multi.md +++ b/tests/docs/no_namespace/00_2default_calculated_multi.md @@ -28,4 +28,3 @@ var2: | **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A first variable.
**Default**:
- no
- yes
- maybe | | **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A second variable.
**Default**: the value of _.var1. | - diff --git a/tests/docs/no_namespace/00_2default_calculated_variable_transitive.adoc b/tests/docs/no_namespace/00_2default_calculated_variable_transitive.adoc index 9143058..0883eb3 100644 --- a/tests/docs/no_namespace/00_2default_calculated_variable_transitive.adoc +++ b/tests/docs/no_namespace/00_2default_calculated_variable_transitive.adoc @@ -22,18 +22,19 @@ var2: [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[domainname]` `basic` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[domainname]` `basic` `mandatory` `unique` `multiple` | A first variable. + -**Validator**: the domain name can be an IP +**Validator**: the domain name can be an IP | + **var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[domainname]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[domainname]` `standard` `mandatory` `unique` `multiple` | A second variable. + **Validator**: the domain name can be an IP + -**Default**: the value of the variable "var1". +**Default**: the value of the variable "var1". |==== - diff --git a/tests/docs/no_namespace/00_2default_calculated_variable_transitive.json b/tests/docs/no_namespace/00_2default_calculated_variable_transitive.json new file mode 100644 index 0000000..9f58863 --- /dev/null +++ b/tests/docs/no_namespace/00_2default_calculated_variable_transitive.json @@ -0,0 +1 @@ +{"var1": {"type": "variable", "properties": [{"type": "type", "name": "domainname"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "validators": ["the domain name can be an IP"], "paths": ["var1"], "names": ["var1"], "descriptions": ["A first variable."], "multiple": true}, "var2": {"type": "variable", "default": "the value of the variable \"var1\".", "properties": [{"type": "type", "name": "domainname"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "validators": ["the domain name can be an IP"], "paths": ["var2"], "names": ["var2"], "descriptions": ["A second variable."], "multiple": true}} \ No newline at end of file diff --git a/tests/docs/no_namespace/00_2default_calculated_variable_transitive.md b/tests/docs/no_namespace/00_2default_calculated_variable_transitive.md index f4e093f..40395e6 100644 --- a/tests/docs/no_namespace/00_2default_calculated_variable_transitive.md +++ b/tests/docs/no_namespace/00_2default_calculated_variable_transitive.md @@ -28,4 +28,3 @@ var2: | **var1**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | A first variable.
**Validator**: the domain name can be an IP | | **var2**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A second variable.
**Validator**: the domain name can be an IP
**Default**: the value of the variable "var1". | - diff --git a/tests/docs/no_namespace/00_4load_subfolder.adoc b/tests/docs/no_namespace/00_4load_subfolder.adoc index 5e9b1af..cf1962e 100644 --- a/tests/docs/no_namespace/00_4load_subfolder.adoc +++ b/tests/docs/no_namespace/00_4load_subfolder.adoc @@ -20,15 +20,16 @@ var2: [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A variable. | + **var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A variable. |==== - diff --git a/tests/docs/no_namespace/00_4load_subfolder.json b/tests/docs/no_namespace/00_4load_subfolder.json new file mode 100644 index 0000000..67020fa --- /dev/null +++ b/tests/docs/no_namespace/00_4load_subfolder.json @@ -0,0 +1 @@ +{"var1": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["var1"], "names": ["var1"], "descriptions": ["A variable."]}, "var2": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["var2"], "names": ["var2"], "descriptions": ["A variable."]}} \ No newline at end of file diff --git a/tests/docs/no_namespace/00_4load_subfolder.md b/tests/docs/no_namespace/00_4load_subfolder.md index 987ab72..f97d057 100644 --- a/tests/docs/no_namespace/00_4load_subfolder.md +++ b/tests/docs/no_namespace/00_4load_subfolder.md @@ -25,4 +25,3 @@ var2: | **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | | **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | - diff --git a/tests/docs/no_namespace/00_5load_notype.adoc b/tests/docs/no_namespace/00_5load_notype.adoc index 0b670ed..9ce309e 100644 --- a/tests/docs/no_namespace/00_5load_notype.adoc +++ b/tests/docs/no_namespace/00_5load_notype.adoc @@ -12,12 +12,12 @@ without_type: [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **without_type** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A variable. + -**Default**: non +**Default**: non |==== - diff --git a/tests/docs/no_namespace/00_5load_notype.json b/tests/docs/no_namespace/00_5load_notype.json new file mode 100644 index 0000000..57bf6a5 --- /dev/null +++ b/tests/docs/no_namespace/00_5load_notype.json @@ -0,0 +1 @@ +{"without_type": {"type": "variable", "default": "non", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["without_type"], "names": ["without_type"], "descriptions": ["A variable."]}} \ No newline at end of file diff --git a/tests/docs/no_namespace/00_5load_notype.md b/tests/docs/no_namespace/00_5load_notype.md index a65dac7..6437e94 100644 --- a/tests/docs/no_namespace/00_5load_notype.md +++ b/tests/docs/no_namespace/00_5load_notype.md @@ -17,4 +17,3 @@ without_type: |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **without_type**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: non | - diff --git a/tests/docs/no_namespace/00_6boolean.adoc b/tests/docs/no_namespace/00_6boolean.adoc index f42fd48..e743f56 100644 --- a/tests/docs/no_namespace/00_6boolean.adoc +++ b/tests/docs/no_namespace/00_6boolean.adoc @@ -25,37 +25,42 @@ var6: [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | The first variable. + -**Default**: True +**Default**: true | + **var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | The second variable. + -**Default**: True +**Default**: true | + **var3** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | The third variable. + -**Default**: True +**Default**: true | + **var4** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | The forth variable. + -**Default**: False +**Default**: false | + **var5** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | The fifth variable. + -**Default**: False +**Default**: false | + **var6** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | The sixth variable. + -**Default**: False +**Default**: false |==== - diff --git a/tests/docs/no_namespace/00_6boolean.json b/tests/docs/no_namespace/00_6boolean.json new file mode 100644 index 0000000..a0be1c6 --- /dev/null +++ b/tests/docs/no_namespace/00_6boolean.json @@ -0,0 +1 @@ +{"var1": {"type": "variable", "default": true, "properties": [{"type": "type", "name": "boolean"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["var1"], "names": ["var1"], "descriptions": ["The first variable."]}, "var2": {"type": "variable", "default": true, "properties": [{"type": "type", "name": "boolean"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["var2"], "names": ["var2"], "descriptions": ["The second variable."]}, "var3": {"type": "variable", "default": true, "properties": [{"type": "type", "name": "boolean"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["var3"], "names": ["var3"], "descriptions": ["The third variable."]}, "var4": {"type": "variable", "default": false, "properties": [{"type": "type", "name": "boolean"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["var4"], "names": ["var4"], "descriptions": ["The forth variable."]}, "var5": {"type": "variable", "default": false, "properties": [{"type": "type", "name": "boolean"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["var5"], "names": ["var5"], "descriptions": ["The fifth variable."]}, "var6": {"type": "variable", "default": false, "properties": [{"type": "type", "name": "boolean"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["var6"], "names": ["var6"], "descriptions": ["The sixth variable."]}} \ No newline at end of file diff --git a/tests/docs/no_namespace/00_6boolean.md b/tests/docs/no_namespace/00_6boolean.md index cc2ebad..d55652f 100644 --- a/tests/docs/no_namespace/00_6boolean.md +++ b/tests/docs/no_namespace/00_6boolean.md @@ -28,11 +28,10 @@ var6: | Variable                                                                                                    | Description                                                                                                 | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **var1**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The first variable.
**Default**: True | -| **var2**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The second variable.
**Default**: True | -| **var3**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The third variable.
**Default**: True | -| **var4**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The forth variable.
**Default**: False | -| **var5**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The fifth variable.
**Default**: False | -| **var6**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The sixth variable.
**Default**: False | - +| **var1**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The first variable.
**Default**: true | +| **var2**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The second variable.
**Default**: true | +| **var3**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The third variable.
**Default**: true | +| **var4**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The forth variable.
**Default**: false | +| **var5**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The fifth variable.
**Default**: false | +| **var6**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The sixth variable.
**Default**: false | diff --git a/tests/docs/no_namespace/00_6boolean_no_mandatory.adoc b/tests/docs/no_namespace/00_6boolean_no_mandatory.adoc index 07e68d4..e5c2685 100644 --- a/tests/docs/no_namespace/00_6boolean_no_mandatory.adoc +++ b/tests/docs/no_namespace/00_6boolean_no_mandatory.adoc @@ -13,12 +13,12 @@ variable: [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` | A variable. + -**Default**: True +**Default**: true |==== - diff --git a/tests/docs/no_namespace/00_6boolean_no_mandatory.json b/tests/docs/no_namespace/00_6boolean_no_mandatory.json new file mode 100644 index 0000000..40e4c7c --- /dev/null +++ b/tests/docs/no_namespace/00_6boolean_no_mandatory.json @@ -0,0 +1 @@ +{"variable": {"type": "variable", "default": true, "properties": [{"type": "type", "name": "boolean"}, {"type": "mode", "name": "standard"}], "paths": ["variable"], "names": ["variable"], "descriptions": ["A variable."]}} \ No newline at end of file diff --git a/tests/docs/no_namespace/00_6boolean_no_mandatory.md b/tests/docs/no_namespace/00_6boolean_no_mandatory.md index ef912fd..4de8684 100644 --- a/tests/docs/no_namespace/00_6boolean_no_mandatory.md +++ b/tests/docs/no_namespace/00_6boolean_no_mandatory.md @@ -16,6 +16,5 @@ variable: | Variable                                                                                        | Description                                                                                     | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **variable**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A variable.
**Default**: True | - +| **variable**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A variable.
**Default**: true | diff --git a/tests/docs/no_namespace/00_6choice.adoc b/tests/docs/no_namespace/00_6choice.adoc index 2f4df92..502dbbe 100644 --- a/tests/docs/no_namespace/00_6choice.adoc +++ b/tests/docs/no_namespace/00_6choice.adoc @@ -49,62 +49,67 @@ var6: [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `basic` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `basic` `mandatory` | The first variable. + **Choices**: * a * b -* c +* c | + **var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `basic` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `basic` `mandatory` | The second variable. + **Choices**: * a * b -* c +* c | + **var3** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` | The third variable. + **Choices**: * a * b * c -* null +* null | + **var4** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` | The forth variable. + **Choices**: * null * b -* c +* c | + **var5** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` `mandatory` | The fifth variable. + **Choices**: * a ← (default) * b -* c +* c | + **var6** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` `mandatory` | The sixth variable. + **Choices**: * 1 ← (default) * 2 -* 3 +* 3 |==== - diff --git a/tests/docs/no_namespace/00_6choice.json b/tests/docs/no_namespace/00_6choice.json new file mode 100644 index 0000000..d4f29d8 --- /dev/null +++ b/tests/docs/no_namespace/00_6choice.json @@ -0,0 +1 @@ +{"var1": {"type": "variable", "properties": [{"type": "type", "name": "choice"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "choices": ["a", "b", "c"], "paths": ["var1"], "names": ["var1"], "descriptions": ["The first variable."]}, "var2": {"type": "variable", "properties": [{"type": "type", "name": "choice"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "choices": ["a", "b", "c"], "paths": ["var2"], "names": ["var2"], "descriptions": ["The second variable."]}, "var3": {"type": "variable", "properties": [{"type": "type", "name": "choice"}, {"type": "mode", "name": "standard"}], "choices": ["a", "b", "c", null], "paths": ["var3"], "names": ["var3"], "descriptions": ["The third variable."]}, "var4": {"type": "variable", "properties": [{"type": "type", "name": "choice"}, {"type": "mode", "name": "standard"}], "choices": [null, "b", "c"], "paths": ["var4"], "names": ["var4"], "descriptions": ["The forth variable."]}, "var5": {"type": "variable", "default": "a", "properties": [{"type": "type", "name": "choice"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "display_default": false, "choices": ["a ← (default)", "b", "c"], "paths": ["var5"], "names": ["var5"], "descriptions": ["The fifth variable."]}, "var6": {"type": "variable", "default": 1, "properties": [{"type": "type", "name": "choice"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "display_default": false, "choices": ["1 ← (default)", 2, 3], "paths": ["var6"], "names": ["var6"], "descriptions": ["The sixth variable."]}} \ No newline at end of file diff --git a/tests/docs/no_namespace/00_6choice.md b/tests/docs/no_namespace/00_6choice.md index 1262d91..6f5bb37 100644 --- a/tests/docs/no_namespace/00_6choice.md +++ b/tests/docs/no_namespace/00_6choice.md @@ -59,4 +59,3 @@ var6: | **var5**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The fifth variable.
**Choices**:
- a ← (default)
- b
- c | | **var6**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The sixth variable.
**Choices**:
- 1 ← (default)
- 2
- 3 | - diff --git a/tests/docs/no_namespace/00_6choice_calculation.adoc b/tests/docs/no_namespace/00_6choice_calculation.adoc index c3dce9e..b929ce6 100644 --- a/tests/docs/no_namespace/00_6choice_calculation.adoc +++ b/tests/docs/no_namespace/00_6choice_calculation.adoc @@ -19,13 +19,13 @@ var: [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` `mandatory` | A variable. + **Choices**: choices is 0 to 9. + -**Default**: 9 +**Default**: 9 |==== - diff --git a/tests/docs/no_namespace/00_6choice_calculation.json b/tests/docs/no_namespace/00_6choice_calculation.json new file mode 100644 index 0000000..9ec1ae9 --- /dev/null +++ b/tests/docs/no_namespace/00_6choice_calculation.json @@ -0,0 +1 @@ +{"var": {"type": "variable", "default": 9, "properties": [{"type": "type", "name": "choice"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "choices": "choices is 0 to 9.", "paths": ["var"], "names": ["var"], "descriptions": ["A variable."]}} \ No newline at end of file diff --git a/tests/docs/no_namespace/00_6choice_calculation.md b/tests/docs/no_namespace/00_6choice_calculation.md index cc51415..6bc5d3f 100644 --- a/tests/docs/no_namespace/00_6choice_calculation.md +++ b/tests/docs/no_namespace/00_6choice_calculation.md @@ -24,4 +24,3 @@ var: |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **var**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Choices**: choices is 0 to 9.
**Default**: 9 | - diff --git a/tests/docs/no_namespace/00_6choice_variable.adoc b/tests/docs/no_namespace/00_6choice_variable.adoc index d9972b9..1d5b938 100644 --- a/tests/docs/no_namespace/00_6choice_variable.adoc +++ b/tests/docs/no_namespace/00_6choice_variable.adoc @@ -18,22 +18,23 @@ var2: [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | A second variable. + **Default**: * a * b -* c +* c | + **var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` `mandatory` | A first variable. + **Choices**: the value of the variable "var1". + -**Default**: a +**Default**: a |==== - diff --git a/tests/docs/no_namespace/00_6choice_variable.json b/tests/docs/no_namespace/00_6choice_variable.json new file mode 100644 index 0000000..92403d0 --- /dev/null +++ b/tests/docs/no_namespace/00_6choice_variable.json @@ -0,0 +1 @@ +{"var1": {"type": "variable", "default": ["a", "b", "c"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var1"], "names": ["var1"], "descriptions": ["A second variable."], "multiple": true}, "var2": {"type": "variable", "default": "a", "properties": [{"type": "type", "name": "choice"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "choices": "the value of the variable \"var1\".", "paths": ["var2"], "names": ["var2"], "descriptions": ["A first variable."]}} \ No newline at end of file diff --git a/tests/docs/no_namespace/00_6choice_variable.md b/tests/docs/no_namespace/00_6choice_variable.md index 3b648fa..0d9f009 100644 --- a/tests/docs/no_namespace/00_6choice_variable.md +++ b/tests/docs/no_namespace/00_6choice_variable.md @@ -19,9 +19,8 @@ var2: ``` # Variables -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A second variable.
**Default**:
- a
- b
- c | -| **var2**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A first variable.
**Choices**: the value of the variable "var1".
**Default**: a | - +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A second variable.
**Default**:
- a
- b
- c | +| **var2**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A first variable.
**Choices**: the value of the variable "var1".
**Default**: a | diff --git a/tests/docs/no_namespace/00_6custom.adoc b/tests/docs/no_namespace/00_6custom.adoc index 57069c8..75deac1 100644 --- a/tests/docs/no_namespace/00_6custom.adoc +++ b/tests/docs/no_namespace/00_6custom.adoc @@ -16,16 +16,17 @@ custom2: [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **custom1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[custom]` `basic` `mandatory` | -The first variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[custom]` `basic` `mandatory` | +The first variable. | + **custom2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[custom]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[custom]` `standard` `mandatory` | The seconf variable. + -**Default**: value +**Default**: value |==== - diff --git a/tests/docs/no_namespace/00_6custom.json b/tests/docs/no_namespace/00_6custom.json new file mode 100644 index 0000000..9e6de75 --- /dev/null +++ b/tests/docs/no_namespace/00_6custom.json @@ -0,0 +1 @@ +{"custom1": {"type": "variable", "properties": [{"type": "type", "name": "custom"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["custom1"], "names": ["custom1"], "descriptions": ["The first variable."]}, "custom2": {"type": "variable", "default": "value", "properties": [{"type": "type", "name": "custom"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["custom2"], "names": ["custom2"], "descriptions": ["The seconf variable."]}} \ No newline at end of file diff --git a/tests/docs/no_namespace/00_6custom.md b/tests/docs/no_namespace/00_6custom.md index 788cb1a..8e57b03 100644 --- a/tests/docs/no_namespace/00_6custom.md +++ b/tests/docs/no_namespace/00_6custom.md @@ -22,4 +22,3 @@ custom2: | **custom1**
[`custom`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The first variable. | | **custom2**
[`custom`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The seconf variable.
**Default**: value | - diff --git a/tests/docs/no_namespace/00_6domainname.adoc b/tests/docs/no_namespace/00_6domainname.adoc index bf6541f..bcfaee0 100644 --- a/tests/docs/no_namespace/00_6domainname.adoc +++ b/tests/docs/no_namespace/00_6domainname.adoc @@ -13,12 +13,12 @@ variable: [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[domainname]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[domainname]` `standard` `mandatory` | A domain name variable. + -**Default**: my.domain.name +**Default**: my.domain.name |==== - diff --git a/tests/docs/no_namespace/00_6domainname.json b/tests/docs/no_namespace/00_6domainname.json new file mode 100644 index 0000000..8063201 --- /dev/null +++ b/tests/docs/no_namespace/00_6domainname.json @@ -0,0 +1 @@ +{"variable": {"type": "variable", "default": "my.domain.name", "properties": [{"type": "type", "name": "domainname"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["variable"], "names": ["variable"], "descriptions": ["A domain name variable."]}} \ No newline at end of file diff --git a/tests/docs/no_namespace/00_6domainname.md b/tests/docs/no_namespace/00_6domainname.md index 2cfcc2e..4af5444 100644 --- a/tests/docs/no_namespace/00_6domainname.md +++ b/tests/docs/no_namespace/00_6domainname.md @@ -18,4 +18,3 @@ variable: |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **variable**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A domain name variable.
**Default**: my.domain.name | - diff --git a/tests/docs/no_namespace/00_6domainname_params.adoc b/tests/docs/no_namespace/00_6domainname_params.adoc index 148c3f3..e7d7c52 100644 --- a/tests/docs/no_namespace/00_6domainname_params.adoc +++ b/tests/docs/no_namespace/00_6domainname_params.adoc @@ -15,13 +15,13 @@ variable: [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[domainname]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[domainname]` `standard` `mandatory` | A domain name variable. + **Validator**: the domain name can be an IP + -**Default**: my.domain.name +**Default**: my.domain.name |==== - diff --git a/tests/docs/no_namespace/00_6domainname_params.json b/tests/docs/no_namespace/00_6domainname_params.json new file mode 100644 index 0000000..f378c6a --- /dev/null +++ b/tests/docs/no_namespace/00_6domainname_params.json @@ -0,0 +1 @@ +{"variable": {"type": "variable", "default": "my.domain.name", "properties": [{"type": "type", "name": "domainname"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "validators": ["the domain name can be an IP"], "paths": ["variable"], "names": ["variable"], "descriptions": ["A domain name variable."]}} \ No newline at end of file diff --git a/tests/docs/no_namespace/00_6domainname_params.md b/tests/docs/no_namespace/00_6domainname_params.md index 8df38b9..90c2755 100644 --- a/tests/docs/no_namespace/00_6domainname_params.md +++ b/tests/docs/no_namespace/00_6domainname_params.md @@ -20,4 +20,3 @@ variable: |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **variable**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A domain name variable.
**Validator**: the domain name can be an IP
**Default**: my.domain.name | - diff --git a/tests/docs/no_namespace/00_6float.adoc b/tests/docs/no_namespace/00_6float.adoc index 7037140..1fc1347 100644 --- a/tests/docs/no_namespace/00_6float.adoc +++ b/tests/docs/no_namespace/00_6float.adoc @@ -25,37 +25,42 @@ var6: [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` | The first variable. + -**Default**: 0.0 +**Default**: 0.0 | + **var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` | The second variable. + -**Default**: 0.0 +**Default**: 0.0 | + **var3** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` | The third variable. + -**Default**: 0.0 +**Default**: 0.0 | + **var4** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` | The forth variable. + -**Default**: 10.1 +**Default**: 10.1 | + **var5** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` | The fifth variable. + -**Default**: 10.1 +**Default**: 10.1 | + **var6** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` | The sixth variable. + -**Default**: 10.1 +**Default**: 10.1 |==== - diff --git a/tests/docs/no_namespace/00_6float.json b/tests/docs/no_namespace/00_6float.json new file mode 100644 index 0000000..c06ac77 --- /dev/null +++ b/tests/docs/no_namespace/00_6float.json @@ -0,0 +1 @@ +{"var1": {"type": "variable", "default": 0.0, "properties": [{"type": "type", "name": "float"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["var1"], "names": ["var1"], "descriptions": ["The first variable."]}, "var2": {"type": "variable", "default": 0.0, "properties": [{"type": "type", "name": "float"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["var2"], "names": ["var2"], "descriptions": ["The second variable."]}, "var3": {"type": "variable", "default": 0.0, "properties": [{"type": "type", "name": "float"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["var3"], "names": ["var3"], "descriptions": ["The third variable."]}, "var4": {"type": "variable", "default": 10.1, "properties": [{"type": "type", "name": "float"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["var4"], "names": ["var4"], "descriptions": ["The forth variable."]}, "var5": {"type": "variable", "default": 10.1, "properties": [{"type": "type", "name": "float"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["var5"], "names": ["var5"], "descriptions": ["The fifth variable."]}, "var6": {"type": "variable", "default": 10.1, "properties": [{"type": "type", "name": "float"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["var6"], "names": ["var6"], "descriptions": ["The sixth variable."]}} \ No newline at end of file diff --git a/tests/docs/no_namespace/00_6float.md b/tests/docs/no_namespace/00_6float.md index 007db53..7919a2c 100644 --- a/tests/docs/no_namespace/00_6float.md +++ b/tests/docs/no_namespace/00_6float.md @@ -35,4 +35,3 @@ var6: | **var5**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The fifth variable.
**Default**: 10.1 | | **var6**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The sixth variable.
**Default**: 10.1 | - diff --git a/tests/docs/no_namespace/00_6number.adoc b/tests/docs/no_namespace/00_6number.adoc index cd3f255..a69b6c3 100644 --- a/tests/docs/no_namespace/00_6number.adoc +++ b/tests/docs/no_namespace/00_6number.adoc @@ -25,37 +25,42 @@ var6: [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` | The first variable. + -**Default**: 0 +**Default**: 0 | + **var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` | The second variable. + -**Default**: 0 +**Default**: 0 | + **var3** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` | The third variable. + -**Default**: 0 +**Default**: 0 | + **var4** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` | This forth variable. + -**Default**: 10 +**Default**: 10 | + **var5** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` | The fifth variable. + -**Default**: 10 +**Default**: 10 | + **var6** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` | The sixth variable. + -**Default**: 10 +**Default**: 10 |==== - diff --git a/tests/docs/no_namespace/00_6number.json b/tests/docs/no_namespace/00_6number.json new file mode 100644 index 0000000..87df4c8 --- /dev/null +++ b/tests/docs/no_namespace/00_6number.json @@ -0,0 +1 @@ +{"var1": {"type": "variable", "default": 0, "properties": [{"type": "type", "name": "number"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["var1"], "names": ["var1"], "descriptions": ["The first variable."]}, "var2": {"type": "variable", "default": 0, "properties": [{"type": "type", "name": "number"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["var2"], "names": ["var2"], "descriptions": ["The second variable."]}, "var3": {"type": "variable", "default": 0, "properties": [{"type": "type", "name": "number"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["var3"], "names": ["var3"], "descriptions": ["The third variable."]}, "var4": {"type": "variable", "default": 10, "properties": [{"type": "type", "name": "number"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["var4"], "names": ["var4"], "descriptions": ["This forth variable."]}, "var5": {"type": "variable", "default": 10, "properties": [{"type": "type", "name": "number"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["var5"], "names": ["var5"], "descriptions": ["The fifth variable."]}, "var6": {"type": "variable", "default": 10, "properties": [{"type": "type", "name": "number"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["var6"], "names": ["var6"], "descriptions": ["The sixth variable."]}} \ No newline at end of file diff --git a/tests/docs/no_namespace/00_6number.md b/tests/docs/no_namespace/00_6number.md index b976533..7e5d3b2 100644 --- a/tests/docs/no_namespace/00_6number.md +++ b/tests/docs/no_namespace/00_6number.md @@ -35,4 +35,3 @@ var6: | **var5**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The fifth variable.
**Default**: 10 | | **var6**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The sixth variable.
**Default**: 10 | - diff --git a/tests/docs/no_namespace/00_6port.adoc b/tests/docs/no_namespace/00_6port.adoc index a7a23f9..9d00b7e 100644 --- a/tests/docs/no_namespace/00_6port.adoc +++ b/tests/docs/no_namespace/00_6port.adoc @@ -20,21 +20,23 @@ variable3: [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **variable1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[port]` `basic` `mandatory` | -A port variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[port]` `basic` `mandatory` | +A port variable. | + **variable2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[port]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[port]` `standard` `mandatory` | A port variable with default value. + -**Default**: 8080 +**Default**: 8080 | + **variable3** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[port]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[port]` `standard` `mandatory` | A port variable with integer default value. + -**Default**: 8080 +**Default**: 8080 |==== - diff --git a/tests/docs/no_namespace/00_6port.json b/tests/docs/no_namespace/00_6port.json new file mode 100644 index 0000000..99ef63a --- /dev/null +++ b/tests/docs/no_namespace/00_6port.json @@ -0,0 +1 @@ +{"variable1": {"type": "variable", "properties": [{"type": "type", "name": "port"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["variable1"], "names": ["variable1"], "descriptions": ["A port variable."]}, "variable2": {"type": "variable", "default": "8080", "properties": [{"type": "type", "name": "port"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["variable2"], "names": ["variable2"], "descriptions": ["A port variable with default value."]}, "variable3": {"type": "variable", "default": "8080", "properties": [{"type": "type", "name": "port"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["variable3"], "names": ["variable3"], "descriptions": ["A port variable with integer default value."]}} \ No newline at end of file diff --git a/tests/docs/no_namespace/00_6port.md b/tests/docs/no_namespace/00_6port.md index 3ca258b..7cf5568 100644 --- a/tests/docs/no_namespace/00_6port.md +++ b/tests/docs/no_namespace/00_6port.md @@ -27,4 +27,3 @@ variable3: | **variable2**
[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A port variable with default value.
**Default**: 8080 | | **variable3**
[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A port variable with integer default value.
**Default**: 8080 | - diff --git a/tests/docs/no_namespace/00_6regexp.adoc b/tests/docs/no_namespace/00_6regexp.adoc index 4f8b2cc..5a2babc 100644 --- a/tests/docs/no_namespace/00_6regexp.adoc +++ b/tests/docs/no_namespace/00_6regexp.adoc @@ -16,13 +16,17 @@ var: [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[regexp]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[regexp]` `standard` `mandatory` | A first variable. + +**Validator**: text based with regular expressions "^#(?:[0-9a-f]{3}){1,2}$" + **Default**: #a1a1a1 + -**Example**: #b1b1b1 +**Examples**: + +* '#b1b1b1' +* '#b2b2b2' |==== - diff --git a/tests/docs/no_namespace/00_6regexp.json b/tests/docs/no_namespace/00_6regexp.json new file mode 100644 index 0000000..4054d25 --- /dev/null +++ b/tests/docs/no_namespace/00_6regexp.json @@ -0,0 +1 @@ +{"var": {"type": "variable", "default": "#a1a1a1", "properties": [{"type": "type", "name": "regexp"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "validators": ["text based with regular expressions \"^#(?:[0-9a-f]{3}){1,2}$\""], "paths": ["var"], "names": ["var"], "descriptions": ["A first variable."], "examples": ["#b1b1b1", "#b2b2b2"]}} \ No newline at end of file diff --git a/tests/docs/no_namespace/00_6regexp.md b/tests/docs/no_namespace/00_6regexp.md index 7ed2aa6..12a6d85 100644 --- a/tests/docs/no_namespace/00_6regexp.md +++ b/tests/docs/no_namespace/00_6regexp.md @@ -19,6 +19,5 @@ var: | Variable                                                                                                   | Description                                                                                                | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **var**
[`regexp`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A first variable.
**Default**: #a1a1a1
**Example**: #b1b1b1 | - +| **var**
[`regexp`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A first variable.
**Validator**: text based with regular expressions "^#(?:[0-9a-f]{3}){1,2}$"
**Default**: #a1a1a1
**Examples**:
- #b1b1b1
- #b2b2b2 | diff --git a/tests/docs/no_namespace/00_6string.adoc b/tests/docs/no_namespace/00_6string.adoc index dbc3d57..6a42441 100644 --- a/tests/docs/no_namespace/00_6string.adoc +++ b/tests/docs/no_namespace/00_6string.adoc @@ -24,34 +24,39 @@ var6: [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -The first variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +The first variable. | + **var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -The second variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +The second variable. | + **var3** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -The third variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +The third variable. | + **var4** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | The forth variable. + -**Default**: value +**Default**: value | + **var5** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | The fifth variable. + -**Default**: value +**Default**: value | + **var6** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | The sixth variable. + -**Default**: value +**Default**: value |==== - diff --git a/tests/docs/no_namespace/00_6string.json b/tests/docs/no_namespace/00_6string.json new file mode 100644 index 0000000..c46728b --- /dev/null +++ b/tests/docs/no_namespace/00_6string.json @@ -0,0 +1 @@ +{"var1": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["var1"], "names": ["var1"], "descriptions": ["The first variable."]}, "var2": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["var2"], "names": ["var2"], "descriptions": ["The second variable."]}, "var3": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["var3"], "names": ["var3"], "descriptions": ["The third variable."]}, "var4": {"type": "variable", "default": "value", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["var4"], "names": ["var4"], "descriptions": ["The forth variable."]}, "var5": {"type": "variable", "default": "value", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["var5"], "names": ["var5"], "descriptions": ["The fifth variable."]}, "var6": {"type": "variable", "default": "value", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["var6"], "names": ["var6"], "descriptions": ["The sixth variable."]}} \ No newline at end of file diff --git a/tests/docs/no_namespace/00_6string.md b/tests/docs/no_namespace/00_6string.md index e9c4989..8d14de9 100644 --- a/tests/docs/no_namespace/00_6string.md +++ b/tests/docs/no_namespace/00_6string.md @@ -34,4 +34,3 @@ var6: | **var5**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The fifth variable.
**Default**: value | | **var6**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The sixth variable.
**Default**: value | - diff --git a/tests/docs/no_namespace/00_7choice_quote.adoc b/tests/docs/no_namespace/00_7choice_quote.adoc index 59f1ff8..42f94a1 100644 --- a/tests/docs/no_namespace/00_7choice_quote.adoc +++ b/tests/docs/no_namespace/00_7choice_quote.adoc @@ -17,16 +17,16 @@ var: [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` `mandatory` | A choice. + **Choices**: * quote' ← (default) * quote" -* quote"' +* quote"' |==== - diff --git a/tests/docs/no_namespace/00_7choice_quote.json b/tests/docs/no_namespace/00_7choice_quote.json new file mode 100644 index 0000000..00c21e8 --- /dev/null +++ b/tests/docs/no_namespace/00_7choice_quote.json @@ -0,0 +1 @@ +{"var": {"type": "variable", "default": "quote'", "properties": [{"type": "type", "name": "choice"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "display_default": false, "choices": ["quote' ← (default)", "quote\"", "quote\"'"], "paths": ["var"], "names": ["var"], "descriptions": ["A choice."]}} \ No newline at end of file diff --git a/tests/docs/no_namespace/00_7choice_quote.md b/tests/docs/no_namespace/00_7choice_quote.md index 6f8baa4..879e566 100644 --- a/tests/docs/no_namespace/00_7choice_quote.md +++ b/tests/docs/no_namespace/00_7choice_quote.md @@ -22,4 +22,3 @@ var: |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **var**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A choice.
**Choices**:
- quote' ← (default)
- quote"
- quote"' | - diff --git a/tests/docs/no_namespace/00_7help_quote.adoc b/tests/docs/no_namespace/00_7help_quote.adoc index 79e4f67..d9a15e9 100644 --- a/tests/docs/no_namespace/00_7help_quote.adoc +++ b/tests/docs/no_namespace/00_7help_quote.adoc @@ -15,17 +15,18 @@ var2: [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | The first variable. + -Message with '. +Message with '. | + **var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | The second variable. + -Message with ". +Message with ". |==== - diff --git a/tests/docs/no_namespace/00_7help_quote.json b/tests/docs/no_namespace/00_7help_quote.json new file mode 100644 index 0000000..81b0048 --- /dev/null +++ b/tests/docs/no_namespace/00_7help_quote.json @@ -0,0 +1 @@ +{"var1": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["var1"], "names": ["var1"], "help": ["Message with '."], "descriptions": ["The first variable."]}, "var2": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["var2"], "names": ["var2"], "help": ["Message with \"."], "descriptions": ["The second variable."]}} \ No newline at end of file diff --git a/tests/docs/no_namespace/00_7help_quote.md b/tests/docs/no_namespace/00_7help_quote.md index abfd855..6ced843 100644 --- a/tests/docs/no_namespace/00_7help_quote.md +++ b/tests/docs/no_namespace/00_7help_quote.md @@ -21,4 +21,3 @@ var2: | **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The first variable.
Message with '. | | **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The second variable.
Message with ". | - diff --git a/tests/docs/no_namespace/00_7value_doublequote.adoc b/tests/docs/no_namespace/00_7value_doublequote.adoc index 3139c7b..ec84dd5 100644 --- a/tests/docs/no_namespace/00_7value_doublequote.adoc +++ b/tests/docs/no_namespace/00_7value_doublequote.adoc @@ -12,12 +12,12 @@ variable: [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A variable. + -**Default**: quote" +**Default**: quote" |==== - diff --git a/tests/docs/no_namespace/00_7value_doublequote.json b/tests/docs/no_namespace/00_7value_doublequote.json new file mode 100644 index 0000000..0c66bd9 --- /dev/null +++ b/tests/docs/no_namespace/00_7value_doublequote.json @@ -0,0 +1 @@ +{"variable": {"type": "variable", "default": "quote\"", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["variable"], "names": ["variable"], "descriptions": ["A variable."]}} \ No newline at end of file diff --git a/tests/docs/no_namespace/00_7value_doublequote.md b/tests/docs/no_namespace/00_7value_doublequote.md index a6840f0..796caf0 100644 --- a/tests/docs/no_namespace/00_7value_doublequote.md +++ b/tests/docs/no_namespace/00_7value_doublequote.md @@ -17,4 +17,3 @@ variable: |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: quote" | - diff --git a/tests/docs/no_namespace/00_7value_doublequote2.adoc b/tests/docs/no_namespace/00_7value_doublequote2.adoc index 9a80a12..c78a516 100644 --- a/tests/docs/no_namespace/00_7value_doublequote2.adoc +++ b/tests/docs/no_namespace/00_7value_doublequote2.adoc @@ -12,12 +12,12 @@ variable: [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A variable. + -**Default**: quote'" +**Default**: quote'" |==== - diff --git a/tests/docs/no_namespace/00_7value_doublequote2.json b/tests/docs/no_namespace/00_7value_doublequote2.json new file mode 100644 index 0000000..bd82e61 --- /dev/null +++ b/tests/docs/no_namespace/00_7value_doublequote2.json @@ -0,0 +1 @@ +{"variable": {"type": "variable", "default": "quote'\"", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["variable"], "names": ["variable"], "descriptions": ["A variable."]}} \ No newline at end of file diff --git a/tests/docs/no_namespace/00_7value_doublequote2.md b/tests/docs/no_namespace/00_7value_doublequote2.md index 45df61c..a4cb332 100644 --- a/tests/docs/no_namespace/00_7value_doublequote2.md +++ b/tests/docs/no_namespace/00_7value_doublequote2.md @@ -17,4 +17,3 @@ variable: |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: quote'" | - diff --git a/tests/docs/no_namespace/00_7value_doublequote3.adoc b/tests/docs/no_namespace/00_7value_doublequote3.adoc index cd1ba85..7114f7d 100644 --- a/tests/docs/no_namespace/00_7value_doublequote3.adoc +++ b/tests/docs/no_namespace/00_7value_doublequote3.adoc @@ -13,12 +13,12 @@ variable: [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A variable. + -**Default**: quote\"\' +**Default**: quote\"\' |==== - diff --git a/tests/docs/no_namespace/00_7value_doublequote3.json b/tests/docs/no_namespace/00_7value_doublequote3.json new file mode 100644 index 0000000..a9bc9b6 --- /dev/null +++ b/tests/docs/no_namespace/00_7value_doublequote3.json @@ -0,0 +1 @@ +{"variable": {"type": "variable", "default": "quote\\\"\\'", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["variable"], "names": ["variable"], "descriptions": ["A variable."]}} \ No newline at end of file diff --git a/tests/docs/no_namespace/00_7value_doublequote3.md b/tests/docs/no_namespace/00_7value_doublequote3.md index b50b3e6..4aa28c3 100644 --- a/tests/docs/no_namespace/00_7value_doublequote3.md +++ b/tests/docs/no_namespace/00_7value_doublequote3.md @@ -18,4 +18,3 @@ variable: |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: quote\"\' | - diff --git a/tests/docs/no_namespace/00_7value_quote.adoc b/tests/docs/no_namespace/00_7value_quote.adoc index dd65ec1..519b00d 100644 --- a/tests/docs/no_namespace/00_7value_quote.adoc +++ b/tests/docs/no_namespace/00_7value_quote.adoc @@ -12,12 +12,12 @@ variable: [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A variable. + -**Default**: quote' +**Default**: quote' |==== - diff --git a/tests/docs/no_namespace/00_7value_quote.json b/tests/docs/no_namespace/00_7value_quote.json new file mode 100644 index 0000000..d498356 --- /dev/null +++ b/tests/docs/no_namespace/00_7value_quote.json @@ -0,0 +1 @@ +{"variable": {"type": "variable", "default": "quote'", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["variable"], "names": ["variable"], "descriptions": ["A variable."]}} \ No newline at end of file diff --git a/tests/docs/no_namespace/00_7value_quote.md b/tests/docs/no_namespace/00_7value_quote.md index 78f8910..c71d027 100644 --- a/tests/docs/no_namespace/00_7value_quote.md +++ b/tests/docs/no_namespace/00_7value_quote.md @@ -17,4 +17,3 @@ variable: |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: quote' | - diff --git a/tests/docs/no_namespace/00_8calculation_information.adoc b/tests/docs/no_namespace/00_8calculation_information.adoc index cf2eff2..6b3c39e 100644 --- a/tests/docs/no_namespace/00_8calculation_information.adoc +++ b/tests/docs/no_namespace/00_8calculation_information.adoc @@ -19,12 +19,12 @@ variable: [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A variable. + -**Default**: get information test_information. +**Default**: get information test_information. |==== - diff --git a/tests/docs/no_namespace/00_8calculation_information.json b/tests/docs/no_namespace/00_8calculation_information.json new file mode 100644 index 0000000..933f75c --- /dev/null +++ b/tests/docs/no_namespace/00_8calculation_information.json @@ -0,0 +1 @@ +{"variable": {"type": "variable", "default": "get information test_information.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["variable"], "names": ["variable"], "descriptions": ["A variable."]}} \ No newline at end of file diff --git a/tests/docs/no_namespace/00_8calculation_information.md b/tests/docs/no_namespace/00_8calculation_information.md index 2152c98..1300b5b 100644 --- a/tests/docs/no_namespace/00_8calculation_information.md +++ b/tests/docs/no_namespace/00_8calculation_information.md @@ -24,4 +24,3 @@ variable: |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: get information test_information. | - diff --git a/tests/docs/no_namespace/00_8test.adoc b/tests/docs/no_namespace/00_8test.adoc index 8df03ba..5d8e767 100644 --- a/tests/docs/no_namespace/00_8test.adoc +++ b/tests/docs/no_namespace/00_8test.adoc @@ -47,42 +47,54 @@ var6: [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | The first variable. + -**Example**: test +**Example**: test | + **var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | The second variable. + **Default**: value + -**Example**: test +**Example**: test | + **var3** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | The third variable. + -**Example**: test1 +**Examples**: + +* test1 +* test2 | + **var4** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | The forth variable. + -**Example**: None +**Examples**: + +* null +* test1 +* test2 | + **var5** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | The fifth variable. + -**Default**: True + -**Example**: False +**Default**: true + +**Example**: false | + **var6** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | The sixth variable. + **Examples**: * test1 -* test2 +* test2 |==== - diff --git a/tests/docs/no_namespace/00_8test.json b/tests/docs/no_namespace/00_8test.json new file mode 100644 index 0000000..471744e --- /dev/null +++ b/tests/docs/no_namespace/00_8test.json @@ -0,0 +1 @@ +{"var1": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["var1"], "names": ["var1"], "descriptions": ["The first variable."], "examples": ["test"]}, "var2": {"type": "variable", "default": "value", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["var2"], "names": ["var2"], "descriptions": ["The second variable."], "examples": ["test"]}, "var3": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["var3"], "names": ["var3"], "descriptions": ["The third variable."], "examples": ["test1", "test2"]}, "var4": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}], "paths": ["var4"], "names": ["var4"], "descriptions": ["The forth variable."], "examples": [null, "test1", "test2"]}, "var5": {"type": "variable", "default": true, "properties": [{"type": "type", "name": "boolean"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["var5"], "names": ["var5"], "descriptions": ["The fifth variable."], "examples": [false]}, "var6": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var6"], "names": ["var6"], "descriptions": ["The sixth variable."], "multiple": true, "examples": ["test1", "test2"]}} \ No newline at end of file diff --git a/tests/docs/no_namespace/00_8test.md b/tests/docs/no_namespace/00_8test.md index 91df1fd..f2ce136 100644 --- a/tests/docs/no_namespace/00_8test.md +++ b/tests/docs/no_namespace/00_8test.md @@ -52,9 +52,8 @@ var6: |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The first variable.
**Example**: test | | **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The second variable.
**Default**: value
**Example**: test | -| **var3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The third variable.
**Example**: test1 | -| **var4**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | The forth variable.
**Example**: None | -| **var5**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The fifth variable.
**Default**: True
**Example**: False | +| **var3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The third variable.
**Examples**:
- test1
- test2 | +| **var4**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | The forth variable.
**Examples**:
- null
- test1
- test2 | +| **var5**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The fifth variable.
**Default**: true
**Example**: false | | **var6**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | The sixth variable.
**Examples**:
- test1
- test2 | - diff --git a/tests/docs/no_namespace/00_9choice_variable_multi.adoc b/tests/docs/no_namespace/00_9choice_variable_multi.adoc index 21503dc..d465ab2 100644 --- a/tests/docs/no_namespace/00_9choice_variable_multi.adoc +++ b/tests/docs/no_namespace/00_9choice_variable_multi.adoc @@ -24,23 +24,24 @@ variable2: [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **variable1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `basic` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `basic` `mandatory` `unique` `multiple` | A first variable. + **Choices**: * val1 -* val2 +* val2 | + **variable2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` `unique` `multiple` | A second variable. + **Choices**: * val1 -* val2 +* val2 |==== - diff --git a/tests/docs/no_namespace/00_9choice_variable_multi.json b/tests/docs/no_namespace/00_9choice_variable_multi.json new file mode 100644 index 0000000..4b80b35 --- /dev/null +++ b/tests/docs/no_namespace/00_9choice_variable_multi.json @@ -0,0 +1 @@ +{"variable1": {"type": "variable", "properties": [{"type": "type", "name": "choice"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "choices": ["val1", "val2"], "paths": ["variable1"], "names": ["variable1"], "descriptions": ["A first variable."], "multiple": true}, "variable2": {"type": "variable", "properties": [{"type": "type", "name": "choice"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "choices": ["val1", "val2"], "paths": ["variable2"], "names": ["variable2"], "descriptions": ["A second variable."], "multiple": true}} \ No newline at end of file diff --git a/tests/docs/no_namespace/00_9choice_variable_multi.md b/tests/docs/no_namespace/00_9choice_variable_multi.md index c722be5..28b5153 100644 --- a/tests/docs/no_namespace/00_9choice_variable_multi.md +++ b/tests/docs/no_namespace/00_9choice_variable_multi.md @@ -25,9 +25,8 @@ variable2: ``` # Variables -| Variable                                                                                                           | Description                                                                                                        | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **variable1**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | A first variable.
**Choices**:
- val1
- val2 | -| **variable2**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A second variable.
**Choices**:
- val1
- val2 | - +| Variable                                                                                                                    | Description                                                                                                                 | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **variable1**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | A first variable.
**Choices**:
- val1
- val2 | +| **variable2**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A second variable.
**Choices**:
- val1
- val2 | diff --git a/tests/docs/no_namespace/00_9choice_variables.adoc b/tests/docs/no_namespace/00_9choice_variables.adoc index 1151e97..6c24576 100644 --- a/tests/docs/no_namespace/00_9choice_variables.adoc +++ b/tests/docs/no_namespace/00_9choice_variables.adoc @@ -18,27 +18,29 @@ my_variable: [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **source_variable_1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | The first source variable. + -**Default**: val1 +**Default**: val1 | + **source_variable_2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | The second source variable. + -**Default**: val2 +**Default**: val2 | + **my_variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` `mandatory` | A variable. + **Choices**: * the value of the variable "source_variable_1". * the value of the variable "source_variable_2". -**Default**: val1 +**Default**: val1 |==== - diff --git a/tests/docs/no_namespace/00_9choice_variables.json b/tests/docs/no_namespace/00_9choice_variables.json new file mode 100644 index 0000000..2678cbd --- /dev/null +++ b/tests/docs/no_namespace/00_9choice_variables.json @@ -0,0 +1 @@ +{"source_variable_1": {"type": "variable", "default": "val1", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["source_variable_1"], "names": ["source_variable_1"], "descriptions": ["The first source variable."]}, "source_variable_2": {"type": "variable", "default": "val2", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["source_variable_2"], "names": ["source_variable_2"], "descriptions": ["The second source variable."]}, "my_variable": {"type": "variable", "default": "val1", "properties": [{"type": "type", "name": "choice"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "choices": ["the value of the variable \"source_variable_1\".", "the value of the variable \"source_variable_2\"."], "paths": ["my_variable"], "names": ["my_variable"], "descriptions": ["A variable."]}} \ No newline at end of file diff --git a/tests/docs/no_namespace/00_9choice_variables.md b/tests/docs/no_namespace/00_9choice_variables.md index 9d948d5..a266e5b 100644 --- a/tests/docs/no_namespace/00_9choice_variables.md +++ b/tests/docs/no_namespace/00_9choice_variables.md @@ -19,10 +19,9 @@ my_variable: ``` # Variables -| Variable                                                                                                                 | Description                                                                                                              | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **source_variable_1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The first source variable.
**Default**: val1 | -| **source_variable_2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The second source variable.
**Default**: val2 | -| **my_variable**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Choices**:
- the value of the variable "source_variable_1".
- the value of the variable "source_variable_2".
**Default**: val1 | - +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **source_variable_1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The first source variable.
**Default**: val1 | +| **source_variable_2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The second source variable.
**Default**: val2 | +| **my_variable**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Choices**:
- the value of the variable "source_variable_1".
- the value of the variable "source_variable_2".
**Default**: val1 | diff --git a/tests/docs/no_namespace/00_9default_calculation.adoc b/tests/docs/no_namespace/00_9default_calculation.adoc index d257b01..20ad48c 100644 --- a/tests/docs/no_namespace/00_9default_calculation.adoc +++ b/tests/docs/no_namespace/00_9default_calculation.adoc @@ -21,12 +21,12 @@ variable: [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A variable. + -**Default**: concat all parameters. +**Default**: concat all parameters. |==== - diff --git a/tests/docs/no_namespace/00_9default_calculation.json b/tests/docs/no_namespace/00_9default_calculation.json new file mode 100644 index 0000000..4a2b14b --- /dev/null +++ b/tests/docs/no_namespace/00_9default_calculation.json @@ -0,0 +1 @@ +{"variable": {"type": "variable", "default": "concat all parameters.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["variable"], "names": ["variable"], "descriptions": ["A variable."]}} \ No newline at end of file diff --git a/tests/docs/no_namespace/00_9default_calculation.md b/tests/docs/no_namespace/00_9default_calculation.md index 6af9ff6..7d3f17a 100644 --- a/tests/docs/no_namespace/00_9default_calculation.md +++ b/tests/docs/no_namespace/00_9default_calculation.md @@ -26,4 +26,3 @@ variable: |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: concat all parameters. | - diff --git a/tests/docs/no_namespace/00_9default_calculation_information.adoc b/tests/docs/no_namespace/00_9default_calculation_information.adoc index d400f21..bec5bf0 100644 --- a/tests/docs/no_namespace/00_9default_calculation_information.adoc +++ b/tests/docs/no_namespace/00_9default_calculation_information.adoc @@ -19,12 +19,12 @@ var: [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A variable. + -**Default**: returns the information. +**Default**: returns the information. |==== - diff --git a/tests/docs/no_namespace/00_9default_calculation_information.json b/tests/docs/no_namespace/00_9default_calculation_information.json new file mode 100644 index 0000000..5f6df7b --- /dev/null +++ b/tests/docs/no_namespace/00_9default_calculation_information.json @@ -0,0 +1 @@ +{"var": {"type": "variable", "default": "returns the information.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["var"], "names": ["var"], "descriptions": ["A variable."]}} \ No newline at end of file diff --git a/tests/docs/no_namespace/00_9default_calculation_information.md b/tests/docs/no_namespace/00_9default_calculation_information.md index b4326da..e5467e8 100644 --- a/tests/docs/no_namespace/00_9default_calculation_information.md +++ b/tests/docs/no_namespace/00_9default_calculation_information.md @@ -24,4 +24,3 @@ var: |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: returns the information. | - 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 7bad338..ea8fcc7 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 @@ -20,16 +20,17 @@ var2: [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A first variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A first variable. | + **var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A second variable. + -**Default**: depends on a calculation. +**Default**: depends on a calculation. |==== - diff --git a/tests/docs/no_namespace/00_9default_calculation_information_other_variable.json b/tests/docs/no_namespace/00_9default_calculation_information_other_variable.json new file mode 100644 index 0000000..b302a5e --- /dev/null +++ b/tests/docs/no_namespace/00_9default_calculation_information_other_variable.json @@ -0,0 +1 @@ +{"var1": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["var1"], "names": ["var1"], "descriptions": ["A first variable."]}, "var2": {"type": "variable", "default": "depends on a calculation.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["var2"], "names": ["var2"], "descriptions": ["A second variable."]}} \ No newline at end of file diff --git a/tests/docs/no_namespace/00_9default_calculation_information_other_variable.md b/tests/docs/no_namespace/00_9default_calculation_information_other_variable.md index 3f8b3ea..4b9234d 100644 --- a/tests/docs/no_namespace/00_9default_calculation_information_other_variable.md +++ b/tests/docs/no_namespace/00_9default_calculation_information_other_variable.md @@ -26,4 +26,3 @@ var2: | **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A first variable. | | **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second variable.
**Default**: depends on a calculation. | - diff --git a/tests/docs/no_namespace/00_9default_calculation_multi_optional.adoc b/tests/docs/no_namespace/00_9default_calculation_multi_optional.adoc index ebd1051..9f0b73b 100644 --- a/tests/docs/no_namespace/00_9default_calculation_multi_optional.adoc +++ b/tests/docs/no_namespace/00_9default_calculation_multi_optional.adoc @@ -18,19 +18,18 @@ my_calculated_variable: [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | -**my_variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | -My_variable. + -**Default**: val1 -| -**my_calculated_variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | -My_calculated_variable. + -**Default**: -* the value of the variable "my_variable". +**my_variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +My_variable. + +**Default**: val1 +| + +**my_calculated_variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +My_calculated_variable. + +**Default**: the value of the variable "my_variable". |==== - diff --git a/tests/docs/no_namespace/00_9default_calculation_multi_optional.json b/tests/docs/no_namespace/00_9default_calculation_multi_optional.json new file mode 100644 index 0000000..4d54954 --- /dev/null +++ b/tests/docs/no_namespace/00_9default_calculation_multi_optional.json @@ -0,0 +1 @@ +{"my_variable": {"type": "variable", "default": "val1", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["my_variable"], "names": ["my_variable"]}, "my_calculated_variable": {"type": "variable", "default": ["the value of the variable \"my_variable\"."], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["my_calculated_variable"], "names": ["my_calculated_variable"], "multiple": true}} \ No newline at end of file diff --git a/tests/docs/no_namespace/00_9default_calculation_multi_optional.md b/tests/docs/no_namespace/00_9default_calculation_multi_optional.md index 07e2d87..20d7d45 100644 --- a/tests/docs/no_namespace/00_9default_calculation_multi_optional.md +++ b/tests/docs/no_namespace/00_9default_calculation_multi_optional.md @@ -22,6 +22,5 @@ my_calculated_variable: | Variable                                                                                                                       | Description                                                                                                                    | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **my_variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | My_variable.
**Default**: val1 | -| **my_calculated_variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | My_calculated_variable.
**Default**:
- the value of the variable "my_variable". | - +| **my_calculated_variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | My_calculated_variable.
**Default**: the value of the variable "my_variable". | diff --git a/tests/docs/no_namespace/00_9default_calculation_multi_optional2.adoc b/tests/docs/no_namespace/00_9default_calculation_multi_optional2.adoc index d054792..48f11de 100644 --- a/tests/docs/no_namespace/00_9default_calculation_multi_optional2.adoc +++ b/tests/docs/no_namespace/00_9default_calculation_multi_optional2.adoc @@ -18,19 +18,18 @@ my_calculated_variable: [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | -**my_variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | -My_variable. + -**Default**: val1 -| -**my_calculated_variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | -My_calculated_variable. + -**Default**: -* the value of the variable "my_variable_unexists". +**my_variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +My_variable. + +**Default**: val1 +| + +**my_calculated_variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +My_calculated_variable. + +**Default**: the value of the variable "my_variable". |==== - diff --git a/tests/docs/no_namespace/00_9default_calculation_multi_optional2.json b/tests/docs/no_namespace/00_9default_calculation_multi_optional2.json new file mode 100644 index 0000000..4d54954 --- /dev/null +++ b/tests/docs/no_namespace/00_9default_calculation_multi_optional2.json @@ -0,0 +1 @@ +{"my_variable": {"type": "variable", "default": "val1", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["my_variable"], "names": ["my_variable"]}, "my_calculated_variable": {"type": "variable", "default": ["the value of the variable \"my_variable\"."], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["my_calculated_variable"], "names": ["my_calculated_variable"], "multiple": true}} \ No newline at end of file diff --git a/tests/docs/no_namespace/00_9default_calculation_multi_optional2.md b/tests/docs/no_namespace/00_9default_calculation_multi_optional2.md index 79a6bbf..93d33e3 100644 --- a/tests/docs/no_namespace/00_9default_calculation_multi_optional2.md +++ b/tests/docs/no_namespace/00_9default_calculation_multi_optional2.md @@ -22,6 +22,5 @@ my_calculated_variable: | Variable                                                                                                                       | Description                                                                                                                    | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **my_variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | My_variable.
**Default**: val1 | -| **my_calculated_variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | My_calculated_variable.
**Default**:
- the value of the variable "my_variable_unexists". | - +| **my_calculated_variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | My_calculated_variable.
**Default**: the value of the variable "my_variable". | diff --git a/tests/docs/no_namespace/00_9default_calculation_optional.adoc b/tests/docs/no_namespace/00_9default_calculation_optional.adoc index ed1762e..57a1873 100644 --- a/tests/docs/no_namespace/00_9default_calculation_optional.adoc +++ b/tests/docs/no_namespace/00_9default_calculation_optional.adoc @@ -14,11 +14,11 @@ my_calculated_variable: [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **my_calculated_variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | -My_calculated_variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +My_calculated_variable. |==== - diff --git a/tests/docs/no_namespace/00_9default_calculation_optional.json b/tests/docs/no_namespace/00_9default_calculation_optional.json new file mode 100644 index 0000000..54d10bc --- /dev/null +++ b/tests/docs/no_namespace/00_9default_calculation_optional.json @@ -0,0 +1 @@ +{"my_calculated_variable": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["my_calculated_variable"], "names": ["my_calculated_variable"], "multiple": true}} \ No newline at end of file diff --git a/tests/docs/no_namespace/00_9default_calculation_optional.md b/tests/docs/no_namespace/00_9default_calculation_optional.md index 16ac5e0..f0976e0 100644 --- a/tests/docs/no_namespace/00_9default_calculation_optional.md +++ b/tests/docs/no_namespace/00_9default_calculation_optional.md @@ -19,4 +19,3 @@ my_calculated_variable: |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **my_calculated_variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | My_calculated_variable. | - diff --git a/tests/docs/no_namespace/00_9default_calculation_optional_exists.adoc b/tests/docs/no_namespace/00_9default_calculation_optional_exists.adoc index 7fd96e5..f205c20 100644 --- a/tests/docs/no_namespace/00_9default_calculation_optional_exists.adoc +++ b/tests/docs/no_namespace/00_9default_calculation_optional_exists.adoc @@ -19,20 +19,21 @@ my_calculated_variable: [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **my_variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | My_variable. + **Default**: * val1 -* val2 +* val2 | + **my_calculated_variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | My_calculated_variable. + -**Default**: the value of the variable "my_variable". +**Default**: the value of the variable "my_variable". |==== - diff --git a/tests/docs/no_namespace/00_9default_calculation_optional_exists.json b/tests/docs/no_namespace/00_9default_calculation_optional_exists.json new file mode 100644 index 0000000..a5c5ab7 --- /dev/null +++ b/tests/docs/no_namespace/00_9default_calculation_optional_exists.json @@ -0,0 +1 @@ +{"my_variable": {"type": "variable", "default": ["val1", "val2"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["my_variable"], "names": ["my_variable"], "multiple": true}, "my_calculated_variable": {"type": "variable", "default": "the value of the variable \"my_variable\".", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["my_calculated_variable"], "names": ["my_calculated_variable"], "multiple": true}} \ No newline at end of file diff --git a/tests/docs/no_namespace/00_9default_calculation_optional_exists.md b/tests/docs/no_namespace/00_9default_calculation_optional_exists.md index ea39e86..adba18e 100644 --- a/tests/docs/no_namespace/00_9default_calculation_optional_exists.md +++ b/tests/docs/no_namespace/00_9default_calculation_optional_exists.md @@ -25,4 +25,3 @@ my_calculated_variable: | **my_variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | My_variable.
**Default**:
- val1
- val2 | | **my_calculated_variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | My_calculated_variable.
**Default**: the value of the variable "my_variable". | - diff --git a/tests/docs/no_namespace/00_9default_calculation_param_optional.adoc b/tests/docs/no_namespace/00_9default_calculation_param_optional.adoc index 219c2e7..620b50c 100644 --- a/tests/docs/no_namespace/00_9default_calculation_param_optional.adoc +++ b/tests/docs/no_namespace/00_9default_calculation_param_optional.adoc @@ -27,17 +27,18 @@ var2: no # a second variable [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | A first variable. + -**Default**: returns a value. +**Default**: returns a value. | + **var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A second variable. + -**Default**: no +**Default**: no |==== - diff --git a/tests/docs/no_namespace/00_9default_calculation_param_optional.json b/tests/docs/no_namespace/00_9default_calculation_param_optional.json new file mode 100644 index 0000000..13b3321 --- /dev/null +++ b/tests/docs/no_namespace/00_9default_calculation_param_optional.json @@ -0,0 +1 @@ +{"var1": {"type": "variable", "default": "returns a value.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}], "paths": ["var1"], "names": ["var1"], "descriptions": ["A first variable."]}, "var2": {"type": "variable", "default": "no", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["var2"], "names": ["var2"], "descriptions": ["A second variable."]}} \ No newline at end of file diff --git a/tests/docs/no_namespace/00_9default_calculation_param_optional.md b/tests/docs/no_namespace/00_9default_calculation_param_optional.md index a850845..67e6efc 100644 --- a/tests/docs/no_namespace/00_9default_calculation_param_optional.md +++ b/tests/docs/no_namespace/00_9default_calculation_param_optional.md @@ -33,4 +33,3 @@ var2: no # a second variable | **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A first variable.
**Default**: returns a value. | | **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second variable.
**Default**: no | - diff --git a/tests/docs/no_namespace/00_9default_information_other_variable.adoc b/tests/docs/no_namespace/00_9default_information_other_variable.adoc index bf3995f..158c8fc 100644 --- a/tests/docs/no_namespace/00_9default_information_other_variable.adoc +++ b/tests/docs/no_namespace/00_9default_information_other_variable.adoc @@ -16,16 +16,17 @@ var2: [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A first variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A first variable. | + **var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A second variable. + -**Default**: the value of the information "test_information" of the variable "var1". +**Default**: the value of the information "test_information" of the variable "var1". |==== - diff --git a/tests/docs/no_namespace/00_9default_information_other_variable.json b/tests/docs/no_namespace/00_9default_information_other_variable.json new file mode 100644 index 0000000..1ccc1e3 --- /dev/null +++ b/tests/docs/no_namespace/00_9default_information_other_variable.json @@ -0,0 +1 @@ +{"var1": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["var1"], "names": ["var1"], "descriptions": ["A first variable."]}, "var2": {"type": "variable", "default": "the value of the information \"test_information\" of the variable \"var1\".", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["var2"], "names": ["var2"], "descriptions": ["A second variable."]}} \ No newline at end of file diff --git a/tests/docs/no_namespace/00_9default_information_other_variable.md b/tests/docs/no_namespace/00_9default_information_other_variable.md index 7e5ccc7..47d71c2 100644 --- a/tests/docs/no_namespace/00_9default_information_other_variable.md +++ b/tests/docs/no_namespace/00_9default_information_other_variable.md @@ -22,4 +22,3 @@ var2: | **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A first variable. | | **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second variable.
**Default**: the value of the information "test_information" of the variable "var1". | - diff --git a/tests/docs/no_namespace/00_9default_integer.adoc b/tests/docs/no_namespace/00_9default_integer.adoc index 7c94279..3be49e3 100644 --- a/tests/docs/no_namespace/00_9default_integer.adoc +++ b/tests/docs/no_namespace/00_9default_integer.adoc @@ -19,13 +19,13 @@ var: [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` `mandatory` | A variable. + **Choices**: choice for 0 to 9. + -**Default**: 9 +**Default**: 9 |==== - diff --git a/tests/docs/no_namespace/00_9default_integer.json b/tests/docs/no_namespace/00_9default_integer.json new file mode 100644 index 0000000..ec87948 --- /dev/null +++ b/tests/docs/no_namespace/00_9default_integer.json @@ -0,0 +1 @@ +{"var": {"type": "variable", "default": 9, "properties": [{"type": "type", "name": "choice"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "choices": "choice for 0 to 9.", "paths": ["var"], "names": ["var"], "descriptions": ["A variable."]}} \ No newline at end of file diff --git a/tests/docs/no_namespace/00_9default_integer.md b/tests/docs/no_namespace/00_9default_integer.md index 37c6f20..d8a970c 100644 --- a/tests/docs/no_namespace/00_9default_integer.md +++ b/tests/docs/no_namespace/00_9default_integer.md @@ -24,4 +24,3 @@ var: |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **var**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Choices**: choice for 0 to 9.
**Default**: 9 | - diff --git a/tests/docs/no_namespace/01_6boolean_multi.adoc b/tests/docs/no_namespace/01_6boolean_multi.adoc index 2e43bdb..c7f7d6b 100644 --- a/tests/docs/no_namespace/01_6boolean_multi.adoc +++ b/tests/docs/no_namespace/01_6boolean_multi.adoc @@ -43,63 +43,54 @@ var8: [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` `unique` `multiple` | The first variable. + -**Default**: - -* true +**Default**: true | + **var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` `unique` `multiple` | The second variable. + -**Default**: - -* true +**Default**: true | + **var3** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` `unique` `multiple` | The third variable. + -**Default**: - -* true +**Default**: true | + **var4** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` `unique` `multiple` | The forth variable. + -**Default**: - -* false +**Default**: false | + **var5** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` `unique` `multiple` | The fifth variable. + -**Default**: - -* false +**Default**: false | + **var6** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` `unique` `multiple` | The sixth variable. + -**Default**: - -* false +**Default**: false | + **var7** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` `unique` `multiple` | The seventh variable. + -**Default**: - -* true +**Default**: true | -**var8** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` `unique` `multiple` | -The eighth variable. + -**Default**: -* true +**var8** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` `unique` `multiple` | +The eighth variable. + +**Default**: true |==== - diff --git a/tests/docs/no_namespace/01_6boolean_multi.json b/tests/docs/no_namespace/01_6boolean_multi.json new file mode 100644 index 0000000..9ed12c7 --- /dev/null +++ b/tests/docs/no_namespace/01_6boolean_multi.json @@ -0,0 +1 @@ +{"var1": {"type": "variable", "default": [true], "properties": [{"type": "type", "name": "boolean"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var1"], "names": ["var1"], "descriptions": ["The first variable."], "multiple": true}, "var2": {"type": "variable", "default": [true], "properties": [{"type": "type", "name": "boolean"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var2"], "names": ["var2"], "descriptions": ["The second variable."], "multiple": true}, "var3": {"type": "variable", "default": [true], "properties": [{"type": "type", "name": "boolean"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var3"], "names": ["var3"], "descriptions": ["The third variable."], "multiple": true}, "var4": {"type": "variable", "default": [false], "properties": [{"type": "type", "name": "boolean"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var4"], "names": ["var4"], "descriptions": ["The forth variable."], "multiple": true}, "var5": {"type": "variable", "default": [false], "properties": [{"type": "type", "name": "boolean"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var5"], "names": ["var5"], "descriptions": ["The fifth variable."], "multiple": true}, "var6": {"type": "variable", "default": [false], "properties": [{"type": "type", "name": "boolean"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var6"], "names": ["var6"], "descriptions": ["The sixth variable."], "multiple": true}, "var7": {"type": "variable", "default": [true], "properties": [{"type": "type", "name": "boolean"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var7"], "names": ["var7"], "descriptions": ["The seventh variable."], "multiple": true}, "var8": {"type": "variable", "default": [true], "properties": [{"type": "type", "name": "boolean"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var8"], "names": ["var8"], "descriptions": ["The eighth variable."], "multiple": true}} \ No newline at end of file diff --git a/tests/docs/no_namespace/01_6boolean_multi.md b/tests/docs/no_namespace/01_6boolean_multi.md index 2c0d859..de20e2c 100644 --- a/tests/docs/no_namespace/01_6boolean_multi.md +++ b/tests/docs/no_namespace/01_6boolean_multi.md @@ -46,13 +46,12 @@ var8: | Variable                                                                                                                        | Description                                                                                                                     | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **var1**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The first variable.
**Default**:
- true | -| **var2**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The second variable.
**Default**:
- true | -| **var3**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The third variable.
**Default**:
- true | -| **var4**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The forth variable.
**Default**:
- false | -| **var5**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The fifth variable.
**Default**:
- false | -| **var6**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The sixth variable.
**Default**:
- false | -| **var7**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The seventh variable.
**Default**:
- true | -| **var8**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The eighth variable.
**Default**:
- true | - +| **var1**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The first variable.
**Default**: true | +| **var2**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The second variable.
**Default**: true | +| **var3**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The third variable.
**Default**: true | +| **var4**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The forth variable.
**Default**: false | +| **var5**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The fifth variable.
**Default**: false | +| **var6**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The sixth variable.
**Default**: false | +| **var7**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The seventh variable.
**Default**: true | +| **var8**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The eighth variable.
**Default**: true | diff --git a/tests/docs/no_namespace/01_6custom_multi.adoc b/tests/docs/no_namespace/01_6custom_multi.adoc index ff5d6e1..c2f0d4d 100644 --- a/tests/docs/no_namespace/01_6custom_multi.adoc +++ b/tests/docs/no_namespace/01_6custom_multi.adoc @@ -18,18 +18,17 @@ custom2: [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | -**custom1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[custom]` `basic` `mandatory` `unique` `multiple` | -A first custom variable. -| -**custom2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[custom]` `standard` `mandatory` `unique` `multiple` | -A second custom variable. + -**Default**: -* value +**custom1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[custom]` `basic` `mandatory` `unique` `multiple` | +A first custom variable. +| + +**custom2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[custom]` `standard` `mandatory` `unique` `multiple` | +A second custom variable. + +**Default**: value |==== - diff --git a/tests/docs/no_namespace/01_6custom_multi.json b/tests/docs/no_namespace/01_6custom_multi.json new file mode 100644 index 0000000..a197b5a --- /dev/null +++ b/tests/docs/no_namespace/01_6custom_multi.json @@ -0,0 +1 @@ +{"custom1": {"type": "variable", "properties": [{"type": "type", "name": "custom"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["custom1"], "names": ["custom1"], "descriptions": ["A first custom variable."], "multiple": true}, "custom2": {"type": "variable", "default": ["value"], "properties": [{"type": "type", "name": "custom"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["custom2"], "names": ["custom2"], "descriptions": ["A second custom variable."], "multiple": true}} \ No newline at end of file diff --git a/tests/docs/no_namespace/01_6custom_multi.md b/tests/docs/no_namespace/01_6custom_multi.md index 42a20c5..6dbc1fd 100644 --- a/tests/docs/no_namespace/01_6custom_multi.md +++ b/tests/docs/no_namespace/01_6custom_multi.md @@ -22,6 +22,5 @@ custom2: | Variable                                                                                                                       | Description                                                                                                                    | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **custom1**
[`custom`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | A first custom variable. | -| **custom2**
[`custom`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A second custom variable.
**Default**:
- value | - +| **custom2**
[`custom`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A second custom variable.
**Default**: value | diff --git a/tests/docs/no_namespace/01_6float_multi.adoc b/tests/docs/no_namespace/01_6float_multi.adoc index 14634e6..d801f7c 100644 --- a/tests/docs/no_namespace/01_6float_multi.adoc +++ b/tests/docs/no_namespace/01_6float_multi.adoc @@ -43,63 +43,54 @@ var8: [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` `unique` `multiple` | The first variable. + -**Default**: - -* 0.0 +**Default**: 0.0 | + **var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` `unique` `multiple` | The second variable. + -**Default**: - -* 0.0 +**Default**: 0.0 | + **var3** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` `unique` `multiple` | The third variable. + -**Default**: - -* 0.0 +**Default**: 0.0 | + **var4** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` `unique` `multiple` | The forth variable. + -**Default**: - -* 10.1 +**Default**: 10.1 | + **var5** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` `unique` `multiple` | The fifth variable. + -**Default**: - -* 10.1 +**Default**: 10.1 | + **var6** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` `unique` `multiple` | The sixth variable. + -**Default**: - -* 10.1 +**Default**: 10.1 | + **var7** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` `unique` `multiple` | The seventh variable. + -**Default**: - -* 0.0 +**Default**: 0.0 | -**var8** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` `unique` `multiple` | -The eighth variable. + -**Default**: -* 0.0 +**var8** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` `unique` `multiple` | +The eighth variable. + +**Default**: 0.0 |==== - diff --git a/tests/docs/no_namespace/01_6float_multi.json b/tests/docs/no_namespace/01_6float_multi.json new file mode 100644 index 0000000..2db8be4 --- /dev/null +++ b/tests/docs/no_namespace/01_6float_multi.json @@ -0,0 +1 @@ +{"var1": {"type": "variable", "default": [0.0], "properties": [{"type": "type", "name": "float"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var1"], "names": ["var1"], "descriptions": ["The first variable."], "multiple": true}, "var2": {"type": "variable", "default": [0.0], "properties": [{"type": "type", "name": "float"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var2"], "names": ["var2"], "descriptions": ["The second variable."], "multiple": true}, "var3": {"type": "variable", "default": [0.0], "properties": [{"type": "type", "name": "float"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var3"], "names": ["var3"], "descriptions": ["The third variable."], "multiple": true}, "var4": {"type": "variable", "default": [10.1], "properties": [{"type": "type", "name": "float"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var4"], "names": ["var4"], "descriptions": ["The forth variable."], "multiple": true}, "var5": {"type": "variable", "default": [10.1], "properties": [{"type": "type", "name": "float"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var5"], "names": ["var5"], "descriptions": ["The fifth variable."], "multiple": true}, "var6": {"type": "variable", "default": [10.1], "properties": [{"type": "type", "name": "float"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var6"], "names": ["var6"], "descriptions": ["The sixth variable."], "multiple": true}, "var7": {"type": "variable", "default": [0.0], "properties": [{"type": "type", "name": "float"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var7"], "names": ["var7"], "descriptions": ["The seventh variable."], "multiple": true}, "var8": {"type": "variable", "default": [0.0], "properties": [{"type": "type", "name": "float"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var8"], "names": ["var8"], "descriptions": ["The eighth variable."], "multiple": true}} \ No newline at end of file diff --git a/tests/docs/no_namespace/01_6float_multi.md b/tests/docs/no_namespace/01_6float_multi.md index 1ba3636..92c66e0 100644 --- a/tests/docs/no_namespace/01_6float_multi.md +++ b/tests/docs/no_namespace/01_6float_multi.md @@ -46,13 +46,12 @@ var8: | Variable                                                                                                                      | Description                                                                                                                   | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **var1**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The first variable.
**Default**:
- 0.0 | -| **var2**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The second variable.
**Default**:
- 0.0 | -| **var3**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The third variable.
**Default**:
- 0.0 | -| **var4**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The forth variable.
**Default**:
- 10.1 | -| **var5**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The fifth variable.
**Default**:
- 10.1 | -| **var6**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The sixth variable.
**Default**:
- 10.1 | -| **var7**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The seventh variable.
**Default**:
- 0.0 | -| **var8**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The eighth variable.
**Default**:
- 0.0 | - +| **var1**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The first variable.
**Default**: 0.0 | +| **var2**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The second variable.
**Default**: 0.0 | +| **var3**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The third variable.
**Default**: 0.0 | +| **var4**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The forth variable.
**Default**: 10.1 | +| **var5**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The fifth variable.
**Default**: 10.1 | +| **var6**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The sixth variable.
**Default**: 10.1 | +| **var7**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The seventh variable.
**Default**: 0.0 | +| **var8**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The eighth variable.
**Default**: 0.0 | diff --git a/tests/docs/no_namespace/01_6number_multi.adoc b/tests/docs/no_namespace/01_6number_multi.adoc index d4642ce..2881029 100644 --- a/tests/docs/no_namespace/01_6number_multi.adoc +++ b/tests/docs/no_namespace/01_6number_multi.adoc @@ -43,63 +43,54 @@ var8: [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` `unique` `multiple` | The first variable. + -**Default**: - -* 0 +**Default**: 0 | + **var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` `unique` `multiple` | The second variable. + -**Default**: - -* 0 +**Default**: 0 | + **var3** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` `unique` `multiple` | The third variable. + -**Default**: - -* 0 +**Default**: 0 | + **var4** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` `unique` `multiple` | The forth variable. + -**Default**: - -* 10 +**Default**: 10 | + **var5** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` `unique` `multiple` | The fifth variable. + -**Default**: - -* 10 +**Default**: 10 | + **var6** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` `unique` `multiple` | The sixth variable. + -**Default**: - -* 10 +**Default**: 10 | + **var7** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` `unique` `multiple` | The seventh variable. + -**Default**: - -* 0 +**Default**: 0 | -**var8** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` `unique` `multiple` | -The eighth variable. + -**Default**: -* 0 +**var8** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` `unique` `multiple` | +The eighth variable. + +**Default**: 0 |==== - diff --git a/tests/docs/no_namespace/01_6number_multi.json b/tests/docs/no_namespace/01_6number_multi.json new file mode 100644 index 0000000..ba9ad37 --- /dev/null +++ b/tests/docs/no_namespace/01_6number_multi.json @@ -0,0 +1 @@ +{"var1": {"type": "variable", "default": [0], "properties": [{"type": "type", "name": "number"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var1"], "names": ["var1"], "descriptions": ["The first variable."], "multiple": true}, "var2": {"type": "variable", "default": [0], "properties": [{"type": "type", "name": "number"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var2"], "names": ["var2"], "descriptions": ["The second variable."], "multiple": true}, "var3": {"type": "variable", "default": [0], "properties": [{"type": "type", "name": "number"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var3"], "names": ["var3"], "descriptions": ["The third variable."], "multiple": true}, "var4": {"type": "variable", "default": [10], "properties": [{"type": "type", "name": "number"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var4"], "names": ["var4"], "descriptions": ["The forth variable."], "multiple": true}, "var5": {"type": "variable", "default": [10], "properties": [{"type": "type", "name": "number"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var5"], "names": ["var5"], "descriptions": ["The fifth variable."], "multiple": true}, "var6": {"type": "variable", "default": [10], "properties": [{"type": "type", "name": "number"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var6"], "names": ["var6"], "descriptions": ["The sixth variable."], "multiple": true}, "var7": {"type": "variable", "default": [0], "properties": [{"type": "type", "name": "number"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var7"], "names": ["var7"], "descriptions": ["The seventh variable."], "multiple": true}, "var8": {"type": "variable", "default": [0], "properties": [{"type": "type", "name": "number"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var8"], "names": ["var8"], "descriptions": ["The eighth variable."], "multiple": true}} \ No newline at end of file diff --git a/tests/docs/no_namespace/01_6number_multi.md b/tests/docs/no_namespace/01_6number_multi.md index 62681f1..42da3ef 100644 --- a/tests/docs/no_namespace/01_6number_multi.md +++ b/tests/docs/no_namespace/01_6number_multi.md @@ -46,13 +46,12 @@ var8: | Variable                                                                                                                       | Description                                                                                                                    | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **var1**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The first variable.
**Default**:
- 0 | -| **var2**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The second variable.
**Default**:
- 0 | -| **var3**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The third variable.
**Default**:
- 0 | -| **var4**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The forth variable.
**Default**:
- 10 | -| **var5**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The fifth variable.
**Default**:
- 10 | -| **var6**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The sixth variable.
**Default**:
- 10 | -| **var7**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The seventh variable.
**Default**:
- 0 | -| **var8**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The eighth variable.
**Default**:
- 0 | - +| **var1**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The first variable.
**Default**: 0 | +| **var2**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The second variable.
**Default**: 0 | +| **var3**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The third variable.
**Default**: 0 | +| **var4**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The forth variable.
**Default**: 10 | +| **var5**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The fifth variable.
**Default**: 10 | +| **var6**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The sixth variable.
**Default**: 10 | +| **var7**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The seventh variable.
**Default**: 0 | +| **var8**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The eighth variable.
**Default**: 0 | diff --git a/tests/docs/no_namespace/01_6string_empty.adoc b/tests/docs/no_namespace/01_6string_empty.adoc index 1c7a4b3..ca84891 100644 --- a/tests/docs/no_namespace/01_6string_empty.adoc +++ b/tests/docs/no_namespace/01_6string_empty.adoc @@ -7,21 +7,23 @@ version: '1.1' var1: description: the second variable empty: false - default: [value, None] + default: + - value + - ---- == Variables [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | The second variable. + **Default**: * value -* None +* null |==== - diff --git a/tests/docs/no_namespace/01_6string_empty.json b/tests/docs/no_namespace/01_6string_empty.json new file mode 100644 index 0000000..423fb94 --- /dev/null +++ b/tests/docs/no_namespace/01_6string_empty.json @@ -0,0 +1 @@ +{"var1": {"type": "variable", "default": ["value", null], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var1"], "names": ["var1"], "descriptions": ["The second variable."], "multiple": true}} \ No newline at end of file diff --git a/tests/docs/no_namespace/01_6string_empty.md b/tests/docs/no_namespace/01_6string_empty.md index cedbf02..a5ab29a 100644 --- a/tests/docs/no_namespace/01_6string_empty.md +++ b/tests/docs/no_namespace/01_6string_empty.md @@ -10,12 +10,13 @@ version: '1.1' var1: description: the second variable empty: false - default: [value, None] + default: + - value + - ``` # Variables | Variable                                                                                                                       | Description                                                                                                                    | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The second variable.
**Default**:
- value
- None | - +| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The second variable.
**Default**:
- value
- null | diff --git a/tests/docs/no_namespace/01_6string_multi.adoc b/tests/docs/no_namespace/01_6string_multi.adoc index d05501f..57c58db 100644 --- a/tests/docs/no_namespace/01_6string_multi.adoc +++ b/tests/docs/no_namespace/01_6string_multi.adoc @@ -39,54 +39,51 @@ var8: [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | -The first variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | +The first variable. | + **var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | -The second variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | +The second variable. | + **var3** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -The third variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +The third variable. | + **var4** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | The forth variable. + -**Default**: - -* value +**Default**: value | + **var5** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | The fifth variable. + -**Default**: - -* value +**Default**: value | + **var6** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | The sixth variable. + -**Default**: - -* value +**Default**: value | + **var7** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | The seventh variable. + -**Default**: - -* value +**Default**: value | -**var8** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | -The eighth variable. + -**Default**: -* value +**var8** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +The eighth variable. + +**Default**: value |==== - diff --git a/tests/docs/no_namespace/01_6string_multi.json b/tests/docs/no_namespace/01_6string_multi.json new file mode 100644 index 0000000..135338c --- /dev/null +++ b/tests/docs/no_namespace/01_6string_multi.json @@ -0,0 +1 @@ +{"var1": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var1"], "names": ["var1"], "descriptions": ["The first variable."], "multiple": true}, "var2": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var2"], "names": ["var2"], "descriptions": ["The second variable."], "multiple": true}, "var3": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["var3"], "names": ["var3"], "descriptions": ["The third variable."]}, "var4": {"type": "variable", "default": ["value"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var4"], "names": ["var4"], "descriptions": ["The forth variable."], "multiple": true}, "var5": {"type": "variable", "default": ["value"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var5"], "names": ["var5"], "descriptions": ["The fifth variable."], "multiple": true}, "var6": {"type": "variable", "default": ["value"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var6"], "names": ["var6"], "descriptions": ["The sixth variable."], "multiple": true}, "var7": {"type": "variable", "default": ["value"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var7"], "names": ["var7"], "descriptions": ["The seventh variable."], "multiple": true}, "var8": {"type": "variable", "default": ["value"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var8"], "names": ["var8"], "descriptions": ["The eighth variable."], "multiple": true}} \ No newline at end of file diff --git a/tests/docs/no_namespace/01_6string_multi.md b/tests/docs/no_namespace/01_6string_multi.md index a38d09c..2f389b0 100644 --- a/tests/docs/no_namespace/01_6string_multi.md +++ b/tests/docs/no_namespace/01_6string_multi.md @@ -45,10 +45,9 @@ var8: | **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | The first variable. | | **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | The second variable. | | **var3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The third variable. | -| **var4**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The forth variable.
**Default**:
- value | -| **var5**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The fifth variable.
**Default**:
- value | -| **var6**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The sixth variable.
**Default**:
- value | -| **var7**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The seventh variable.
**Default**:
- value | -| **var8**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The eighth variable.
**Default**:
- value | - +| **var4**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The forth variable.
**Default**: value | +| **var5**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The fifth variable.
**Default**: value | +| **var6**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The sixth variable.
**Default**: value | +| **var7**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The seventh variable.
**Default**: value | +| **var8**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The eighth variable.
**Default**: value | diff --git a/tests/docs/no_namespace/01_7value_multi_doublequote.adoc b/tests/docs/no_namespace/01_7value_multi_doublequote.adoc index 32c1119..db98514 100644 --- a/tests/docs/no_namespace/01_7value_multi_doublequote.adoc +++ b/tests/docs/no_namespace/01_7value_multi_doublequote.adoc @@ -13,14 +13,12 @@ variable: [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | -**variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | -A variable. + -**Default**: -* quote" +**variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +A variable. + +**Default**: quote" |==== - diff --git a/tests/docs/no_namespace/01_7value_multi_doublequote.json b/tests/docs/no_namespace/01_7value_multi_doublequote.json new file mode 100644 index 0000000..fa18239 --- /dev/null +++ b/tests/docs/no_namespace/01_7value_multi_doublequote.json @@ -0,0 +1 @@ +{"variable": {"type": "variable", "default": ["quote\""], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["variable"], "names": ["variable"], "descriptions": ["A variable."], "multiple": true}} \ No newline at end of file diff --git a/tests/docs/no_namespace/01_7value_multi_doublequote.md b/tests/docs/no_namespace/01_7value_multi_doublequote.md index ee4189a..738979f 100644 --- a/tests/docs/no_namespace/01_7value_multi_doublequote.md +++ b/tests/docs/no_namespace/01_7value_multi_doublequote.md @@ -16,6 +16,5 @@ variable: | Variable                                                                                                                       | Description                                                                                                                    | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A variable.
**Default**:
- quote" | - +| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A variable.
**Default**: quote" | diff --git a/tests/docs/no_namespace/01_7value_multi_doublequote2.adoc b/tests/docs/no_namespace/01_7value_multi_doublequote2.adoc index ce7bd7c..79b5e45 100644 --- a/tests/docs/no_namespace/01_7value_multi_doublequote2.adoc +++ b/tests/docs/no_namespace/01_7value_multi_doublequote2.adoc @@ -13,14 +13,12 @@ variable: [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | -**variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | -A variable. + -**Default**: -* quote'" +**variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +A variable. + +**Default**: quote'" |==== - diff --git a/tests/docs/no_namespace/01_7value_multi_doublequote2.json b/tests/docs/no_namespace/01_7value_multi_doublequote2.json new file mode 100644 index 0000000..c067c5f --- /dev/null +++ b/tests/docs/no_namespace/01_7value_multi_doublequote2.json @@ -0,0 +1 @@ +{"variable": {"type": "variable", "default": ["quote'\""], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["variable"], "names": ["variable"], "descriptions": ["A variable."], "multiple": true}} \ No newline at end of file diff --git a/tests/docs/no_namespace/01_7value_multi_doublequote2.md b/tests/docs/no_namespace/01_7value_multi_doublequote2.md index 00ca396..87538ad 100644 --- a/tests/docs/no_namespace/01_7value_multi_doublequote2.md +++ b/tests/docs/no_namespace/01_7value_multi_doublequote2.md @@ -16,6 +16,5 @@ variable: | Variable                                                                                                                       | Description                                                                                                                    | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A variable.
**Default**:
- quote'" | - +| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A variable.
**Default**: quote'" | diff --git a/tests/docs/no_namespace/01_7value_multi_quote.adoc b/tests/docs/no_namespace/01_7value_multi_quote.adoc index 6da1d87..65d0126 100644 --- a/tests/docs/no_namespace/01_7value_multi_quote.adoc +++ b/tests/docs/no_namespace/01_7value_multi_quote.adoc @@ -13,14 +13,12 @@ variable: [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | -**variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | -A variable. + -**Default**: -* quote' +**variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +A variable. + +**Default**: quote' |==== - diff --git a/tests/docs/no_namespace/01_7value_multi_quote.json b/tests/docs/no_namespace/01_7value_multi_quote.json new file mode 100644 index 0000000..5193010 --- /dev/null +++ b/tests/docs/no_namespace/01_7value_multi_quote.json @@ -0,0 +1 @@ +{"variable": {"type": "variable", "default": ["quote'"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["variable"], "names": ["variable"], "descriptions": ["A variable."], "multiple": true}} \ No newline at end of file diff --git a/tests/docs/no_namespace/01_7value_multi_quote.md b/tests/docs/no_namespace/01_7value_multi_quote.md index e7f8631..f50a422 100644 --- a/tests/docs/no_namespace/01_7value_multi_quote.md +++ b/tests/docs/no_namespace/01_7value_multi_quote.md @@ -16,6 +16,5 @@ variable: | Variable                                                                                                                       | Description                                                                                                                    | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A variable.
**Default**:
- quote' | - +| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A variable.
**Default**: quote' | diff --git a/tests/docs/no_namespace/01_8calculation_information_multi.adoc b/tests/docs/no_namespace/01_8calculation_information_multi.adoc index 95d7535..b370f41 100644 --- a/tests/docs/no_namespace/01_8calculation_information_multi.adoc +++ b/tests/docs/no_namespace/01_8calculation_information_multi.adoc @@ -20,12 +20,12 @@ variable: [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | A variable. + -**Default**: get information test_information. +**Default**: get information test_information. |==== - diff --git a/tests/docs/no_namespace/01_8calculation_information_multi.json b/tests/docs/no_namespace/01_8calculation_information_multi.json new file mode 100644 index 0000000..fbbadb7 --- /dev/null +++ b/tests/docs/no_namespace/01_8calculation_information_multi.json @@ -0,0 +1 @@ +{"variable": {"type": "variable", "default": "get information test_information.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["variable"], "names": ["variable"], "descriptions": ["A variable."], "multiple": true}} \ No newline at end of file diff --git a/tests/docs/no_namespace/01_8calculation_information_multi.md b/tests/docs/no_namespace/01_8calculation_information_multi.md index dc5e955..50731c8 100644 --- a/tests/docs/no_namespace/01_8calculation_information_multi.md +++ b/tests/docs/no_namespace/01_8calculation_information_multi.md @@ -25,4 +25,3 @@ variable: |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A variable.
**Default**: get information test_information. | - diff --git a/tests/docs/no_namespace/01_9choice_variable_multi.adoc b/tests/docs/no_namespace/01_9choice_variable_multi.adoc index b37b147..3045ae1 100644 --- a/tests/docs/no_namespace/01_9choice_variable_multi.adoc +++ b/tests/docs/no_namespace/01_9choice_variable_multi.adoc @@ -17,21 +17,22 @@ variable2: [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **variable1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | A first variable. + **Default**: * a * b -* c +* c | + **variable2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `basic` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `basic` `mandatory` | A second variable. + -**Choices**: the value of the variable "variable1". +**Choices**: the value of the variable "variable1". |==== - diff --git a/tests/docs/no_namespace/01_9choice_variable_multi.json b/tests/docs/no_namespace/01_9choice_variable_multi.json new file mode 100644 index 0000000..aaa0991 --- /dev/null +++ b/tests/docs/no_namespace/01_9choice_variable_multi.json @@ -0,0 +1 @@ +{"variable1": {"type": "variable", "default": ["a", "b", "c"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["variable1"], "names": ["variable1"], "descriptions": ["A first variable."], "multiple": true}, "variable2": {"type": "variable", "properties": [{"type": "type", "name": "choice"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "choices": "the value of the variable \"variable1\".", "paths": ["variable2"], "names": ["variable2"], "descriptions": ["A second variable."]}} \ No newline at end of file diff --git a/tests/docs/no_namespace/01_9choice_variable_multi.md b/tests/docs/no_namespace/01_9choice_variable_multi.md index a4ace76..0982241 100644 --- a/tests/docs/no_namespace/01_9choice_variable_multi.md +++ b/tests/docs/no_namespace/01_9choice_variable_multi.md @@ -18,9 +18,8 @@ variable2: ``` # Variables -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **variable1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A first variable.
**Default**:
- a
- b
- c | -| **variable2**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A second variable.
**Choices**: the value of the variable "variable1". | - +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **variable1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A first variable.
**Default**:
- a
- b
- c | +| **variable2**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A second variable.
**Choices**: the value of the variable "variable1". | diff --git a/tests/docs/no_namespace/04_0type_param.adoc b/tests/docs/no_namespace/04_0type_param.adoc index 6e57a95..67061ab 100644 --- a/tests/docs/no_namespace/04_0type_param.adoc +++ b/tests/docs/no_namespace/04_0type_param.adoc @@ -15,17 +15,17 @@ int: [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **int** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` | A limited number. + **Validators**: * the minimum value is 0 * the maximum value is 100 -**Default**: 10 +**Default**: 10 |==== - diff --git a/tests/docs/no_namespace/04_0type_param.json b/tests/docs/no_namespace/04_0type_param.json new file mode 100644 index 0000000..d236ebc --- /dev/null +++ b/tests/docs/no_namespace/04_0type_param.json @@ -0,0 +1 @@ +{"int": {"type": "variable", "default": 10, "properties": [{"type": "type", "name": "number"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "validators": ["the minimum value is 0", "the maximum value is 100"], "paths": ["int"], "names": ["int"], "descriptions": ["A limited number."]}} \ No newline at end of file diff --git a/tests/docs/no_namespace/04_0type_param.md b/tests/docs/no_namespace/04_0type_param.md index 87954c1..eaac71e 100644 --- a/tests/docs/no_namespace/04_0type_param.md +++ b/tests/docs/no_namespace/04_0type_param.md @@ -20,4 +20,3 @@ int: |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **int**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A limited number.
**Validators**:
- the minimum value is 0
- the maximum value is 100
**Default**: 10 | - diff --git a/tests/docs/no_namespace/04_1auto_save.adoc b/tests/docs/no_namespace/04_1auto_save.adoc index 2919884..41e4839 100644 --- a/tests/docs/no_namespace/04_1auto_save.adoc +++ b/tests/docs/no_namespace/04_1auto_save.adoc @@ -13,12 +13,12 @@ variable: [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `auto modified` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `auto modified` | An auto save variable. + -**Default**: no +**Default**: no |==== - diff --git a/tests/docs/no_namespace/04_1auto_save.json b/tests/docs/no_namespace/04_1auto_save.json new file mode 100644 index 0000000..1b315d0 --- /dev/null +++ b/tests/docs/no_namespace/04_1auto_save.json @@ -0,0 +1 @@ +{"variable": {"type": "variable", "default": "no", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "auto modified"}], "paths": ["variable"], "names": ["variable"], "descriptions": ["An auto save variable."]}} \ No newline at end of file diff --git a/tests/docs/no_namespace/04_1auto_save.md b/tests/docs/no_namespace/04_1auto_save.md index f68a180..2657636 100644 --- a/tests/docs/no_namespace/04_1auto_save.md +++ b/tests/docs/no_namespace/04_1auto_save.md @@ -18,4 +18,3 @@ variable: |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `auto modified` | An auto save variable.
**Default**: no | - diff --git a/tests/docs/no_namespace/04_1auto_save_and_calculated.adoc b/tests/docs/no_namespace/04_1auto_save_and_calculated.adoc index 283c669..4a01a10 100644 --- a/tests/docs/no_namespace/04_1auto_save_and_calculated.adoc +++ b/tests/docs/no_namespace/04_1auto_save_and_calculated.adoc @@ -15,17 +15,18 @@ var2: [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A first variable. + -**Default**: no +**Default**: no | + **var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `auto modified` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `auto modified` | A second variable. + -**Default**: the value of the variable "var1". +**Default**: the value of the variable "var1". |==== - diff --git a/tests/docs/no_namespace/04_1auto_save_and_calculated.json b/tests/docs/no_namespace/04_1auto_save_and_calculated.json new file mode 100644 index 0000000..56d891b --- /dev/null +++ b/tests/docs/no_namespace/04_1auto_save_and_calculated.json @@ -0,0 +1 @@ +{"var1": {"type": "variable", "default": "no", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["var1"], "names": ["var1"], "descriptions": ["A first variable."]}, "var2": {"type": "variable", "default": "the value of the variable \"var1\".", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "auto modified"}], "paths": ["var2"], "names": ["var2"], "descriptions": ["A second variable."]}} \ No newline at end of file diff --git a/tests/docs/no_namespace/04_1auto_save_and_calculated.md b/tests/docs/no_namespace/04_1auto_save_and_calculated.md index 2a33dde..b8d1bfe 100644 --- a/tests/docs/no_namespace/04_1auto_save_and_calculated.md +++ b/tests/docs/no_namespace/04_1auto_save_and_calculated.md @@ -21,4 +21,3 @@ var2: | **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A first variable.
**Default**: no | | **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `auto modified` | A second variable.
**Default**: the value of the variable "var1". | - diff --git a/tests/docs/no_namespace/04_1auto_save_and_calculated_hidden.adoc b/tests/docs/no_namespace/04_1auto_save_and_calculated_hidden.adoc index 86cd46b..5ed4e3f 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 @@ -22,18 +22,19 @@ var2: [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A first variable. + -**Default**: no +**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". +**Hidden**: only if the variable var1 has value "yes". |==== - diff --git a/tests/docs/no_namespace/04_1auto_save_and_calculated_hidden.json b/tests/docs/no_namespace/04_1auto_save_and_calculated_hidden.json new file mode 100644 index 0000000..6768c6f --- /dev/null +++ b/tests/docs/no_namespace/04_1auto_save_and_calculated_hidden.json @@ -0,0 +1 @@ +{"var1": {"type": "variable", "default": "no", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["var1"], "names": ["var1"], "descriptions": ["A first variable."]}, "var2": {"type": "variable", "default": "the value is always yes.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "hidden", "annotation": "only if the variable var1 has value \"yes\"."}, {"type": "property", "name": "auto modified"}], "paths": ["var2"], "names": ["var2"], "descriptions": ["A second variable."]}} \ No newline at end of file diff --git a/tests/docs/no_namespace/04_1auto_save_and_calculated_hidden.md b/tests/docs/no_namespace/04_1auto_save_and_calculated_hidden.md index 5ecb4ca..a88232b 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 @@ -28,4 +28,3 @@ var2: | **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A first variable.
**Default**: no | | **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` *`hidden`* `auto modified` | A second variable.
**Default**: the value is always yes.
**Hidden**: only if the variable var1 has value "yes". | - diff --git a/tests/docs/no_namespace/04_1auto_save_and_hidden.json b/tests/docs/no_namespace/04_1auto_save_and_hidden.json new file mode 100644 index 0000000..9e26dfe --- /dev/null +++ b/tests/docs/no_namespace/04_1auto_save_and_hidden.json @@ -0,0 +1 @@ +{} \ No newline at end of file diff --git a/tests/docs/no_namespace/04_1default_calculation_hidden.adoc b/tests/docs/no_namespace/04_1default_calculation_hidden.adoc index 52ec7d9..41a3921 100644 --- a/tests/docs/no_namespace/04_1default_calculation_hidden.adoc +++ b/tests/docs/no_namespace/04_1default_calculation_hidden.adoc @@ -27,22 +27,24 @@ var3: [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A first variable. + -**Default**: value +**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". +**Disabled**: when the variable "var1" has the value "value". | + **var3** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A third variable. + -**Default**: depends on a calculation. +**Default**: depends on a calculation. |==== - diff --git a/tests/docs/no_namespace/04_1default_calculation_hidden.json b/tests/docs/no_namespace/04_1default_calculation_hidden.json new file mode 100644 index 0000000..5611a20 --- /dev/null +++ b/tests/docs/no_namespace/04_1default_calculation_hidden.json @@ -0,0 +1 @@ +{"var1": {"type": "variable", "default": "value", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["var1"], "names": ["var1"], "descriptions": ["A first variable."]}, "var2": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "disabled", "annotation": "when the variable \"var1\" has the value \"value\"."}], "paths": ["var2"], "names": ["var2"], "descriptions": ["A second variable."]}, "var3": {"type": "variable", "default": "depends on a calculation.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["var3"], "names": ["var3"], "descriptions": ["A third variable."]}} \ No newline at end of file diff --git a/tests/docs/no_namespace/04_1default_calculation_hidden.md b/tests/docs/no_namespace/04_1default_calculation_hidden.md index 8ed3742..fd680ae 100644 --- a/tests/docs/no_namespace/04_1default_calculation_hidden.md +++ b/tests/docs/no_namespace/04_1default_calculation_hidden.md @@ -28,10 +28,9 @@ var3: ``` # Variables -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A first variable.
**Default**: value | -| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` *`disabled`* | A second variable.
**Disabled**: when the variable "var1" has the value "value". | -| **var3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A third variable.
**Default**: depends on a calculation. | - +| Variable                                                                                                             | Description                                                                                                          | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A first variable.
**Default**: value | +| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` *`disabled`* | A second variable.
**Disabled**: when the variable "var1" has the value "value". | +| **var3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A third variable.
**Default**: depends on a calculation. | diff --git a/tests/docs/no_namespace/04_1default_calculation_hidden_2.adoc b/tests/docs/no_namespace/04_1default_calculation_hidden_2.adoc index a9db642..2bfef3a 100644 --- a/tests/docs/no_namespace/04_1default_calculation_hidden_2.adoc +++ b/tests/docs/no_namespace/04_1default_calculation_hidden_2.adoc @@ -27,22 +27,24 @@ var3: [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A first variable. + -**Default**: value +**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". +**Disabled**: when the variable "var1" has the value "value". | + **var3** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A third variable. + -**Default**: depends on a calculation. +**Default**: depends on a calculation. |==== - diff --git a/tests/docs/no_namespace/04_1default_calculation_hidden_2.json b/tests/docs/no_namespace/04_1default_calculation_hidden_2.json new file mode 100644 index 0000000..5611a20 --- /dev/null +++ b/tests/docs/no_namespace/04_1default_calculation_hidden_2.json @@ -0,0 +1 @@ +{"var1": {"type": "variable", "default": "value", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["var1"], "names": ["var1"], "descriptions": ["A first variable."]}, "var2": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "disabled", "annotation": "when the variable \"var1\" has the value \"value\"."}], "paths": ["var2"], "names": ["var2"], "descriptions": ["A second variable."]}, "var3": {"type": "variable", "default": "depends on a calculation.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["var3"], "names": ["var3"], "descriptions": ["A third variable."]}} \ No newline at end of file diff --git a/tests/docs/no_namespace/04_1default_calculation_hidden_2.md b/tests/docs/no_namespace/04_1default_calculation_hidden_2.md index 61429fb..32779f2 100644 --- a/tests/docs/no_namespace/04_1default_calculation_hidden_2.md +++ b/tests/docs/no_namespace/04_1default_calculation_hidden_2.md @@ -28,10 +28,9 @@ var3: ``` # Variables -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A first variable.
**Default**: value | -| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` *`disabled`* | A second variable.
**Disabled**: when the variable "var1" has the value "value". | -| **var3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A third variable.
**Default**: depends on a calculation. | - +| Variable                                                                                                             | Description                                                                                                          | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A first variable.
**Default**: value | +| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` *`disabled`* | A second variable.
**Disabled**: when the variable "var1" has the value "value". | +| **var3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A third variable.
**Default**: depends on a calculation. | diff --git a/tests/docs/no_namespace/04_5disabled_calculation_optional.adoc b/tests/docs/no_namespace/04_5disabled_calculation_optional.adoc index e607c90..b1ea4dd 100644 --- a/tests/docs/no_namespace/04_5disabled_calculation_optional.adoc +++ b/tests/docs/no_namespace/04_5disabled_calculation_optional.adoc @@ -40,22 +40,24 @@ var2: [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **condition** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A condition. + -**Default**: no +**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. +**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. +**Hidden**: calculation from an condition variable. |==== - diff --git a/tests/docs/no_namespace/04_5disabled_calculation_optional.json b/tests/docs/no_namespace/04_5disabled_calculation_optional.json new file mode 100644 index 0000000..fac97da --- /dev/null +++ b/tests/docs/no_namespace/04_5disabled_calculation_optional.json @@ -0,0 +1 @@ +{"condition": {"type": "variable", "default": "no", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["condition"], "names": ["condition"], "descriptions": ["A condition."]}, "var1": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "hidden", "annotation": "calculation from an unknown variable."}], "paths": ["var1"], "names": ["var1"], "descriptions": ["A first variable."]}, "var2": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "hidden", "annotation": "calculation from an condition variable."}], "paths": ["var2"], "names": ["var2"], "descriptions": ["A second variable."]}} \ No newline at end of file diff --git a/tests/docs/no_namespace/04_5disabled_calculation_optional.md b/tests/docs/no_namespace/04_5disabled_calculation_optional.md index 54880ce..208c711 100644 --- a/tests/docs/no_namespace/04_5disabled_calculation_optional.md +++ b/tests/docs/no_namespace/04_5disabled_calculation_optional.md @@ -41,10 +41,9 @@ var2: ``` # Variables -| Variable                                                                                                  | Description                                                                                               | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.
**Default**: no | -| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` *`hidden`* | A first variable.
**Hidden**: calculation from an unknown variable. | -| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` *`hidden`* | A second variable.
**Hidden**: calculation from an condition variable. | - +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.
**Default**: no | +| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` *`hidden`* | A first variable.
**Hidden**: calculation from an unknown variable. | +| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` *`hidden`* | A second variable.
**Hidden**: calculation from an condition variable. | diff --git a/tests/docs/no_namespace/04_5disabled_calculation_variable.adoc b/tests/docs/no_namespace/04_5disabled_calculation_variable.adoc index 00be5d2..1e37a39 100644 --- a/tests/docs/no_namespace/04_5disabled_calculation_variable.adoc +++ b/tests/docs/no_namespace/04_5disabled_calculation_variable.adoc @@ -14,17 +14,18 @@ variable: [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **condition** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | A condition. + -**Default**: False +**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". +**Disabled**: when the variable "condition" has the value "true". |==== - diff --git a/tests/docs/no_namespace/04_5disabled_calculation_variable.json b/tests/docs/no_namespace/04_5disabled_calculation_variable.json new file mode 100644 index 0000000..d714c16 --- /dev/null +++ b/tests/docs/no_namespace/04_5disabled_calculation_variable.json @@ -0,0 +1 @@ +{"condition": {"type": "variable", "default": false, "properties": [{"type": "type", "name": "boolean"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["condition"], "names": ["condition"], "descriptions": ["A condition."]}, "variable": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "disabled", "annotation": "when the variable \"condition\" has the value \"true\"."}], "paths": ["variable"], "names": ["variable"], "descriptions": ["A variable."]}} \ No newline at end of file diff --git a/tests/docs/no_namespace/04_5disabled_calculation_variable.md b/tests/docs/no_namespace/04_5disabled_calculation_variable.md index 07100ba..9630810 100644 --- a/tests/docs/no_namespace/04_5disabled_calculation_variable.md +++ b/tests/docs/no_namespace/04_5disabled_calculation_variable.md @@ -17,7 +17,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". | - +| **condition**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.
**Default**: false | +| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` *`disabled`* | A variable.
**Disabled**: when the variable "condition" has the value "true". | diff --git a/tests/docs/no_namespace/04_5disabled_calculation_variable2.adoc b/tests/docs/no_namespace/04_5disabled_calculation_variable2.adoc index 0b0bd16..ecb92ee 100644 --- a/tests/docs/no_namespace/04_5disabled_calculation_variable2.adoc +++ b/tests/docs/no_namespace/04_5disabled_calculation_variable2.adoc @@ -14,17 +14,18 @@ variable: [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **condition** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | A condition. + -**Default**: True +**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". +**Disabled**: when the variable "condition" has the value "true". |==== - diff --git a/tests/docs/no_namespace/04_5disabled_calculation_variable2.json b/tests/docs/no_namespace/04_5disabled_calculation_variable2.json new file mode 100644 index 0000000..a1e5851 --- /dev/null +++ b/tests/docs/no_namespace/04_5disabled_calculation_variable2.json @@ -0,0 +1 @@ +{"condition": {"type": "variable", "default": true, "properties": [{"type": "type", "name": "boolean"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["condition"], "names": ["condition"], "descriptions": ["A condition."]}, "variable": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "disabled", "annotation": "when the variable \"condition\" has the value \"true\"."}], "paths": ["variable"], "names": ["variable"], "descriptions": ["A variable."]}} \ No newline at end of file diff --git a/tests/docs/no_namespace/04_5disabled_calculation_variable2.md b/tests/docs/no_namespace/04_5disabled_calculation_variable2.md index 0f3a79c..e8a1817 100644 --- a/tests/docs/no_namespace/04_5disabled_calculation_variable2.md +++ b/tests/docs/no_namespace/04_5disabled_calculation_variable2.md @@ -17,7 +17,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". | - +| **condition**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.
**Default**: true | +| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` *`disabled`* | A variable.
**Disabled**: when the variable "condition" has the value "true". | diff --git a/tests/docs/no_namespace/04_5disabled_calculation_variable3.adoc b/tests/docs/no_namespace/04_5disabled_calculation_variable3.adoc index c30c125..f70cfe8 100644 --- a/tests/docs/no_namespace/04_5disabled_calculation_variable3.adoc +++ b/tests/docs/no_namespace/04_5disabled_calculation_variable3.adoc @@ -15,17 +15,18 @@ variable: [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **condition** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A condition. + -**Default**: yes +**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". +**Disabled**: when the variable "condition" has the value "yes". |==== - diff --git a/tests/docs/no_namespace/04_5disabled_calculation_variable3.json b/tests/docs/no_namespace/04_5disabled_calculation_variable3.json new file mode 100644 index 0000000..1e0ed0a --- /dev/null +++ b/tests/docs/no_namespace/04_5disabled_calculation_variable3.json @@ -0,0 +1 @@ +{"condition": {"type": "variable", "default": "yes", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["condition"], "names": ["condition"], "descriptions": ["A condition."]}, "variable": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "disabled", "annotation": "when the variable \"condition\" has the value \"yes\"."}], "paths": ["variable"], "names": ["variable"], "descriptions": ["A variable."]}} \ No newline at end of file diff --git a/tests/docs/no_namespace/04_5disabled_calculation_variable3.md b/tests/docs/no_namespace/04_5disabled_calculation_variable3.md index 9bbd2be..85935b5 100644 --- a/tests/docs/no_namespace/04_5disabled_calculation_variable3.md +++ b/tests/docs/no_namespace/04_5disabled_calculation_variable3.md @@ -21,4 +21,3 @@ variable: | **condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.
**Default**: yes | | **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` *`disabled`* | A variable.
**Disabled**: when the variable "condition" has the value "yes". | - diff --git a/tests/docs/no_namespace/04_5disabled_calculation_variable4.adoc b/tests/docs/no_namespace/04_5disabled_calculation_variable4.adoc index d267427..f62d672 100644 --- a/tests/docs/no_namespace/04_5disabled_calculation_variable4.adoc +++ b/tests/docs/no_namespace/04_5disabled_calculation_variable4.adoc @@ -15,17 +15,18 @@ variable: [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **condition** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A condition. + -**Default**: yes +**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". +**Disabled**: when the variable "condition" hasn't the value "yes". |==== - diff --git a/tests/docs/no_namespace/04_5disabled_calculation_variable4.json b/tests/docs/no_namespace/04_5disabled_calculation_variable4.json new file mode 100644 index 0000000..1b13ad3 --- /dev/null +++ b/tests/docs/no_namespace/04_5disabled_calculation_variable4.json @@ -0,0 +1 @@ +{"condition": {"type": "variable", "default": "yes", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["condition"], "names": ["condition"], "descriptions": ["A condition."]}, "variable": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "disabled", "annotation": "when the variable \"condition\" hasn't the value \"yes\"."}], "paths": ["variable"], "names": ["variable"], "descriptions": ["A variable."]}} \ No newline at end of file diff --git a/tests/docs/no_namespace/04_5disabled_calculation_variable4.md b/tests/docs/no_namespace/04_5disabled_calculation_variable4.md index d3fb05b..837ed13 100644 --- a/tests/docs/no_namespace/04_5disabled_calculation_variable4.md +++ b/tests/docs/no_namespace/04_5disabled_calculation_variable4.md @@ -21,4 +21,3 @@ variable: | **condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.
**Default**: yes | | **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` *`disabled`* | A variable.
**Disabled**: when the variable "condition" hasn't the value "yes". | - diff --git a/tests/docs/no_namespace/04_5validators.adoc b/tests/docs/no_namespace/04_5validators.adoc index f19d451..afa344f 100644 --- a/tests/docs/no_namespace/04_5validators.adoc +++ b/tests/docs/no_namespace/04_5validators.adoc @@ -18,12 +18,12 @@ int: [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **int** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `basic` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `basic` `mandatory` | A number. + -**Validator**: the max value is 100. +**Validator**: the max value is 100. |==== - diff --git a/tests/docs/no_namespace/04_5validators.json b/tests/docs/no_namespace/04_5validators.json new file mode 100644 index 0000000..d1fb25b --- /dev/null +++ b/tests/docs/no_namespace/04_5validators.json @@ -0,0 +1 @@ +{"int": {"type": "variable", "properties": [{"type": "type", "name": "number"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "validators": ["the max value is 100."], "paths": ["int"], "names": ["int"], "descriptions": ["A number."]}} \ No newline at end of file diff --git a/tests/docs/no_namespace/04_5validators.md b/tests/docs/no_namespace/04_5validators.md index 0a31112..aa76f64 100644 --- a/tests/docs/no_namespace/04_5validators.md +++ b/tests/docs/no_namespace/04_5validators.md @@ -23,4 +23,3 @@ int: |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **int**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A number.
**Validator**: the max value is 100. | - diff --git a/tests/docs/no_namespace/04_5validators_differ.adoc b/tests/docs/no_namespace/04_5validators_differ.adoc index 0a67035..4fd8f52 100644 --- a/tests/docs/no_namespace/04_5validators_differ.adoc +++ b/tests/docs/no_namespace/04_5validators_differ.adoc @@ -22,19 +22,20 @@ var2: no # A second variable [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A first variable. + **Validator**: var1 must be different than var2. + **Default**: oui + -**Example**: another_value +**Example**: another_value | + **var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A second variable. + -**Default**: no +**Default**: no |==== - diff --git a/tests/docs/no_namespace/04_5validators_differ.json b/tests/docs/no_namespace/04_5validators_differ.json new file mode 100644 index 0000000..0c7761e --- /dev/null +++ b/tests/docs/no_namespace/04_5validators_differ.json @@ -0,0 +1 @@ +{"var1": {"type": "variable", "default": "oui", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "validators": ["var1 must be different than var2."], "paths": ["var1"], "names": ["var1"], "descriptions": ["A first variable."], "examples": ["another_value"]}, "var2": {"type": "variable", "default": "no", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["var2"], "names": ["var2"], "descriptions": ["A second variable."]}} \ No newline at end of file diff --git a/tests/docs/no_namespace/04_5validators_differ.md b/tests/docs/no_namespace/04_5validators_differ.md index c7347a2..dbea3e1 100644 --- a/tests/docs/no_namespace/04_5validators_differ.md +++ b/tests/docs/no_namespace/04_5validators_differ.md @@ -28,4 +28,3 @@ var2: no # A second variable | **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A first variable.
**Validator**: var1 must be different than var2.
**Default**: oui
**Example**: another_value | | **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second variable.
**Default**: no | - diff --git a/tests/docs/no_namespace/04_5validators_multi.adoc b/tests/docs/no_namespace/04_5validators_multi.adoc index 68de870..c063d00 100644 --- a/tests/docs/no_namespace/04_5validators_multi.adoc +++ b/tests/docs/no_namespace/04_5validators_multi.adoc @@ -21,16 +21,16 @@ var1: [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | A second variable. + **Validator**: check length is less than 10. + **Default**: * no -* yes +* yes |==== - diff --git a/tests/docs/no_namespace/04_5validators_multi.json b/tests/docs/no_namespace/04_5validators_multi.json new file mode 100644 index 0000000..90b292d --- /dev/null +++ b/tests/docs/no_namespace/04_5validators_multi.json @@ -0,0 +1 @@ +{"var1": {"type": "variable", "default": ["no", "yes"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "validators": ["check length is less than 10."], "paths": ["var1"], "names": ["var1"], "descriptions": ["A second variable."], "multiple": true}} \ No newline at end of file diff --git a/tests/docs/no_namespace/04_5validators_multi.md b/tests/docs/no_namespace/04_5validators_multi.md index bc13ece..97e7010 100644 --- a/tests/docs/no_namespace/04_5validators_multi.md +++ b/tests/docs/no_namespace/04_5validators_multi.md @@ -26,4 +26,3 @@ var1: |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A second variable.
**Validator**: check length is less than 10.
**Default**:
- no
- yes | - diff --git a/tests/docs/no_namespace/04_5validators_multi2.adoc b/tests/docs/no_namespace/04_5validators_multi2.adoc index 27077e3..debc1c9 100644 --- a/tests/docs/no_namespace/04_5validators_multi2.adoc +++ b/tests/docs/no_namespace/04_5validators_multi2.adoc @@ -28,10 +28,11 @@ var1: [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | A second variable. + **Validator**: check length is less than 3. + **Default**: @@ -42,7 +43,6 @@ A second variable. + **Examples**: * val1 -* val2 +* val2 |==== - diff --git a/tests/docs/no_namespace/04_5validators_multi2.json b/tests/docs/no_namespace/04_5validators_multi2.json new file mode 100644 index 0000000..4f5f119 --- /dev/null +++ b/tests/docs/no_namespace/04_5validators_multi2.json @@ -0,0 +1 @@ +{"var1": {"type": "variable", "default": ["no", "yes"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "validators": ["check length is less than 3."], "paths": ["var1"], "names": ["var1"], "descriptions": ["A second variable."], "multiple": true, "examples": ["val1", "val2"]}} \ No newline at end of file diff --git a/tests/docs/no_namespace/04_5validators_multi2.md b/tests/docs/no_namespace/04_5validators_multi2.md index 7e82a97..a8e491d 100644 --- a/tests/docs/no_namespace/04_5validators_multi2.md +++ b/tests/docs/no_namespace/04_5validators_multi2.md @@ -33,4 +33,3 @@ var1: |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A second variable.
**Validator**: check length is less than 3.
**Default**:
- no
- yes
**Examples**:
- val1
- val2 | - diff --git a/tests/docs/no_namespace/05_0multi_not_uniq.adoc b/tests/docs/no_namespace/05_0multi_not_uniq.adoc index 47398ed..c1e0f2c 100644 --- a/tests/docs/no_namespace/05_0multi_not_uniq.adoc +++ b/tests/docs/no_namespace/05_0multi_not_uniq.adoc @@ -14,14 +14,12 @@ var1: [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | -**var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `multiple` | -A variable. + -**Default**: -* non +**var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `multiple` | +A variable. + +**Default**: non |==== - diff --git a/tests/docs/no_namespace/05_0multi_not_uniq.json b/tests/docs/no_namespace/05_0multi_not_uniq.json new file mode 100644 index 0000000..723c516 --- /dev/null +++ b/tests/docs/no_namespace/05_0multi_not_uniq.json @@ -0,0 +1 @@ +{"var1": {"type": "variable", "default": ["non"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "multiple", "name": "multiple"}], "paths": ["var1"], "names": ["var1"], "descriptions": ["A variable."], "multiple": true}} \ No newline at end of file diff --git a/tests/docs/no_namespace/05_0multi_not_uniq.md b/tests/docs/no_namespace/05_0multi_not_uniq.md index a126176..1897fec 100644 --- a/tests/docs/no_namespace/05_0multi_not_uniq.md +++ b/tests/docs/no_namespace/05_0multi_not_uniq.md @@ -17,6 +17,5 @@ var1: | Variable                                                                                                              | Description                                                                                                           | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `multiple` | A variable.
**Default**:
- non | - +| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `multiple` | A variable.
**Default**: non | diff --git a/tests/docs/no_namespace/05_0multi_uniq.adoc b/tests/docs/no_namespace/05_0multi_uniq.adoc index 287862b..c346e41 100644 --- a/tests/docs/no_namespace/05_0multi_uniq.adoc +++ b/tests/docs/no_namespace/05_0multi_uniq.adoc @@ -14,14 +14,12 @@ variable: [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | -**variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | -A variable. + -**Default**: -* non +**variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +A variable. + +**Default**: non |==== - diff --git a/tests/docs/no_namespace/05_0multi_uniq.json b/tests/docs/no_namespace/05_0multi_uniq.json new file mode 100644 index 0000000..e2af7df --- /dev/null +++ b/tests/docs/no_namespace/05_0multi_uniq.json @@ -0,0 +1 @@ +{"variable": {"type": "variable", "default": ["non"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["variable"], "names": ["variable"], "descriptions": ["A variable."], "multiple": true}} \ No newline at end of file diff --git a/tests/docs/no_namespace/05_0multi_uniq.md b/tests/docs/no_namespace/05_0multi_uniq.md index 7865619..7bfa1d6 100644 --- a/tests/docs/no_namespace/05_0multi_uniq.md +++ b/tests/docs/no_namespace/05_0multi_uniq.md @@ -17,6 +17,5 @@ variable: | Variable                                                                                                                       | Description                                                                                                                    | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A variable.
**Default**:
- non | - +| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A variable.
**Default**: non | diff --git a/tests/docs/no_namespace/12_1auto_save_expert.json b/tests/docs/no_namespace/12_1auto_save_expert.json new file mode 100644 index 0000000..9e26dfe --- /dev/null +++ b/tests/docs/no_namespace/12_1auto_save_expert.json @@ -0,0 +1 @@ +{} \ No newline at end of file diff --git a/tests/docs/no_namespace/16_0redefine_description.adoc b/tests/docs/no_namespace/16_0redefine_description.adoc index 7fce84e..208244f 100644 --- a/tests/docs/no_namespace/16_0redefine_description.adoc +++ b/tests/docs/no_namespace/16_0redefine_description.adoc @@ -21,11 +21,11 @@ var: [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -Redefined. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +Redefined. |==== - diff --git a/tests/docs/no_namespace/16_0redefine_description.json b/tests/docs/no_namespace/16_0redefine_description.json new file mode 100644 index 0000000..4eaffe7 --- /dev/null +++ b/tests/docs/no_namespace/16_0redefine_description.json @@ -0,0 +1 @@ +{"var": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["var"], "names": ["var"], "descriptions": ["Redefined."]}} \ No newline at end of file diff --git a/tests/docs/no_namespace/16_0redefine_description.md b/tests/docs/no_namespace/16_0redefine_description.md index 90d5816..acac09b 100644 --- a/tests/docs/no_namespace/16_0redefine_description.md +++ b/tests/docs/no_namespace/16_0redefine_description.md @@ -25,4 +25,3 @@ var: |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | Redefined. | - diff --git a/tests/docs/no_namespace/16_2family_redefine_calculation.adoc b/tests/docs/no_namespace/16_2family_redefine_calculation.adoc index c22cb36..de4d2d2 100644 --- a/tests/docs/no_namespace/16_2family_redefine_calculation.adoc +++ b/tests/docs/no_namespace/16_2family_redefine_calculation.adoc @@ -23,17 +23,18 @@ family: === family -`basic` `_disabled_` +`basic` `__disabled__` + **Disabled**: depends on a calculation. [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **family.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -Var1. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +Var1. |==== - diff --git a/tests/docs/no_namespace/16_2family_redefine_calculation.json b/tests/docs/no_namespace/16_2family_redefine_calculation.json new file mode 100644 index 0000000..81d3505 --- /dev/null +++ b/tests/docs/no_namespace/16_2family_redefine_calculation.json @@ -0,0 +1 @@ +{"family": {"type": "family", "informations": {"paths": ["family"], "names": ["family"], "properties": [{"type": "mode", "name": "basic"}, {"type": "property", "name": "disabled", "annotation": "depends on a calculation."}]}, "children": {"var1": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["family.var1"], "names": ["var1"]}}}} \ No newline at end of file diff --git a/tests/docs/no_namespace/16_2family_redefine_calculation.md b/tests/docs/no_namespace/16_2family_redefine_calculation.md index a9ecc96..ccf1f32 100644 --- a/tests/docs/no_namespace/16_2family_redefine_calculation.md +++ b/tests/docs/no_namespace/16_2family_redefine_calculation.md @@ -33,4 +33,3 @@ family: |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **family.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | Var1. | - diff --git a/tests/docs/no_namespace/16_2family_redefine_disabled.json b/tests/docs/no_namespace/16_2family_redefine_disabled.json new file mode 100644 index 0000000..9e26dfe --- /dev/null +++ b/tests/docs/no_namespace/16_2family_redefine_disabled.json @@ -0,0 +1 @@ +{} \ No newline at end of file diff --git a/tests/docs/no_namespace/16_5exists_nonexists.adoc b/tests/docs/no_namespace/16_5exists_nonexists.adoc index 5bf5be0..39bff53 100644 --- a/tests/docs/no_namespace/16_5exists_nonexists.adoc +++ b/tests/docs/no_namespace/16_5exists_nonexists.adoc @@ -21,17 +21,18 @@ var1: no # a variable [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A variable. + -**Default**: no +**Default**: no | + **var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A new variable. + -**Default**: yes +**Default**: yes |==== - diff --git a/tests/docs/no_namespace/16_5exists_nonexists.json b/tests/docs/no_namespace/16_5exists_nonexists.json new file mode 100644 index 0000000..0cfdfd1 --- /dev/null +++ b/tests/docs/no_namespace/16_5exists_nonexists.json @@ -0,0 +1 @@ +{"var1": {"type": "variable", "default": "no", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["var1"], "names": ["var1"], "descriptions": ["A variable."]}, "var2": {"type": "variable", "default": "yes", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["var2"], "names": ["var2"], "descriptions": ["A new variable."]}} \ No newline at end of file diff --git a/tests/docs/no_namespace/16_5exists_nonexists.md b/tests/docs/no_namespace/16_5exists_nonexists.md index 1e351d4..646abbf 100644 --- a/tests/docs/no_namespace/16_5exists_nonexists.md +++ b/tests/docs/no_namespace/16_5exists_nonexists.md @@ -26,4 +26,3 @@ var1: no # a variable | **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: no | | **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A new variable.
**Default**: yes | - diff --git a/tests/docs/no_namespace/16_5exists_redefine.json b/tests/docs/no_namespace/16_5exists_redefine.json new file mode 100644 index 0000000..9e26dfe --- /dev/null +++ b/tests/docs/no_namespace/16_5exists_redefine.json @@ -0,0 +1 @@ +{} \ No newline at end of file diff --git a/tests/docs/no_namespace/16_5redefine_calculation.adoc b/tests/docs/no_namespace/16_5redefine_calculation.adoc index c4fd03b..39fedbe 100644 --- a/tests/docs/no_namespace/16_5redefine_calculation.adoc +++ b/tests/docs/no_namespace/16_5redefine_calculation.adoc @@ -26,12 +26,12 @@ variable: [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A variable. + -**Default**: returns yes. +**Default**: returns yes. |==== - diff --git a/tests/docs/no_namespace/16_5redefine_calculation.json b/tests/docs/no_namespace/16_5redefine_calculation.json new file mode 100644 index 0000000..4852bcd --- /dev/null +++ b/tests/docs/no_namespace/16_5redefine_calculation.json @@ -0,0 +1 @@ +{"variable": {"type": "variable", "default": "returns yes.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["variable"], "names": ["variable"], "descriptions": ["A variable."]}} \ No newline at end of file diff --git a/tests/docs/no_namespace/16_5redefine_calculation.md b/tests/docs/no_namespace/16_5redefine_calculation.md index bba7df4..4d20b40 100644 --- a/tests/docs/no_namespace/16_5redefine_calculation.md +++ b/tests/docs/no_namespace/16_5redefine_calculation.md @@ -30,4 +30,3 @@ variable: |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: returns yes. | - diff --git a/tests/docs/no_namespace/16_5redefine_choice.adoc b/tests/docs/no_namespace/16_5redefine_choice.adoc index 2ad8898..989b815 100644 --- a/tests/docs/no_namespace/16_5redefine_choice.adoc +++ b/tests/docs/no_namespace/16_5redefine_choice.adoc @@ -27,15 +27,15 @@ variable: [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `basic` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `basic` `mandatory` | A variable. + **Choices**: * a -* b +* b |==== - diff --git a/tests/docs/no_namespace/16_5redefine_choice.json b/tests/docs/no_namespace/16_5redefine_choice.json new file mode 100644 index 0000000..3309f59 --- /dev/null +++ b/tests/docs/no_namespace/16_5redefine_choice.json @@ -0,0 +1 @@ +{"variable": {"type": "variable", "properties": [{"type": "type", "name": "choice"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "choices": ["a", "b"], "paths": ["variable"], "names": ["variable"], "descriptions": ["A variable."]}} \ No newline at end of file diff --git a/tests/docs/no_namespace/16_5redefine_choice.md b/tests/docs/no_namespace/16_5redefine_choice.md index adfd632..582e177 100644 --- a/tests/docs/no_namespace/16_5redefine_choice.md +++ b/tests/docs/no_namespace/16_5redefine_choice.md @@ -31,4 +31,3 @@ variable: |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **variable**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable.
**Choices**:
- a
- b | - diff --git a/tests/docs/no_namespace/16_5redefine_default.adoc b/tests/docs/no_namespace/16_5redefine_default.adoc index e1427de..53cbb26 100644 --- a/tests/docs/no_namespace/16_5redefine_default.adoc +++ b/tests/docs/no_namespace/16_5redefine_default.adoc @@ -22,12 +22,12 @@ variable: [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A variable. + -**Default**: yes +**Default**: yes |==== - diff --git a/tests/docs/no_namespace/16_5redefine_default.json b/tests/docs/no_namespace/16_5redefine_default.json new file mode 100644 index 0000000..4527689 --- /dev/null +++ b/tests/docs/no_namespace/16_5redefine_default.json @@ -0,0 +1 @@ +{"variable": {"type": "variable", "default": "yes", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["variable"], "names": ["variable"], "descriptions": ["A variable."]}} \ No newline at end of file diff --git a/tests/docs/no_namespace/16_5redefine_default.md b/tests/docs/no_namespace/16_5redefine_default.md index b78cd71..335d863 100644 --- a/tests/docs/no_namespace/16_5redefine_default.md +++ b/tests/docs/no_namespace/16_5redefine_default.md @@ -26,4 +26,3 @@ variable: |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: yes | - diff --git a/tests/docs/no_namespace/16_5redefine_default_calculation.adoc b/tests/docs/no_namespace/16_5redefine_default_calculation.adoc index bea1598..fd4853d 100644 --- a/tests/docs/no_namespace/16_5redefine_default_calculation.adoc +++ b/tests/docs/no_namespace/16_5redefine_default_calculation.adoc @@ -23,11 +23,11 @@ variable: [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A variable. |==== - diff --git a/tests/docs/no_namespace/16_5redefine_default_calculation.json b/tests/docs/no_namespace/16_5redefine_default_calculation.json new file mode 100644 index 0000000..85ca66e --- /dev/null +++ b/tests/docs/no_namespace/16_5redefine_default_calculation.json @@ -0,0 +1 @@ +{"variable": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["variable"], "names": ["variable"], "descriptions": ["A variable."]}} \ No newline at end of file diff --git a/tests/docs/no_namespace/16_5redefine_default_calculation.md b/tests/docs/no_namespace/16_5redefine_default_calculation.md index d4979de..c0514fb 100644 --- a/tests/docs/no_namespace/16_5redefine_default_calculation.md +++ b/tests/docs/no_namespace/16_5redefine_default_calculation.md @@ -27,4 +27,3 @@ variable: |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | - diff --git a/tests/docs/no_namespace/16_5redefine_family.adoc b/tests/docs/no_namespace/16_5redefine_family.adoc index d3b4168..dae614a 100644 --- a/tests/docs/no_namespace/16_5redefine_family.adoc +++ b/tests/docs/no_namespace/16_5redefine_family.adoc @@ -25,11 +25,11 @@ family: # a family [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **family.variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A variable. |==== - diff --git a/tests/docs/no_namespace/16_5redefine_family.json b/tests/docs/no_namespace/16_5redefine_family.json new file mode 100644 index 0000000..48f6cbf --- /dev/null +++ b/tests/docs/no_namespace/16_5redefine_family.json @@ -0,0 +1 @@ +{"family": {"type": "family", "informations": {"paths": ["family"], "names": ["family"], "description": "new description", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"variable": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["family.variable"], "names": ["variable"], "descriptions": ["A variable."]}}}} \ No newline at end of file diff --git a/tests/docs/no_namespace/16_5redefine_family.md b/tests/docs/no_namespace/16_5redefine_family.md index 60daab9..26182ef 100644 --- a/tests/docs/no_namespace/16_5redefine_family.md +++ b/tests/docs/no_namespace/16_5redefine_family.md @@ -29,4 +29,3 @@ family: # a family |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **family.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | - diff --git a/tests/docs/no_namespace/16_5redefine_help.adoc b/tests/docs/no_namespace/16_5redefine_help.adoc index d37e864..20375b8 100644 --- a/tests/docs/no_namespace/16_5redefine_help.adoc +++ b/tests/docs/no_namespace/16_5redefine_help.adoc @@ -30,17 +30,16 @@ family: `basic` - Redefine help family ok. [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **family.variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | Redefine help. + -Redefine help ok. +Redefine help ok. |==== - diff --git a/tests/docs/no_namespace/16_5redefine_help.json b/tests/docs/no_namespace/16_5redefine_help.json new file mode 100644 index 0000000..831ee7f --- /dev/null +++ b/tests/docs/no_namespace/16_5redefine_help.json @@ -0,0 +1 @@ +{"family": {"type": "family", "informations": {"paths": ["family"], "names": ["family"], "description": "a family", "help": ["Redefine help family ok."], "properties": [{"type": "mode", "name": "basic"}]}, "children": {"variable": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["family.variable"], "names": ["variable"], "help": ["Redefine help ok."], "descriptions": ["Redefine help."]}}}} \ No newline at end of file diff --git a/tests/docs/no_namespace/16_5redefine_help.md b/tests/docs/no_namespace/16_5redefine_help.md index e385a20..c06c83f 100644 --- a/tests/docs/no_namespace/16_5redefine_help.md +++ b/tests/docs/no_namespace/16_5redefine_help.md @@ -32,11 +32,9 @@ family: `basic` - Redefine help family ok. | Variable                                                                                                | Description                                                                                             | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **family.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | Redefine help.
Redefine help ok. | - diff --git a/tests/docs/no_namespace/16_5redefine_hidden.json b/tests/docs/no_namespace/16_5redefine_hidden.json new file mode 100644 index 0000000..9e26dfe --- /dev/null +++ b/tests/docs/no_namespace/16_5redefine_hidden.json @@ -0,0 +1 @@ +{} \ No newline at end of file diff --git a/tests/docs/no_namespace/16_5redefine_multi.adoc b/tests/docs/no_namespace/16_5redefine_multi.adoc index 00824e9..ae05e8c 100644 --- a/tests/docs/no_namespace/16_5redefine_multi.adoc +++ b/tests/docs/no_namespace/16_5redefine_multi.adoc @@ -24,14 +24,12 @@ variable: [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | -**variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | -A variable. + -**Default**: -* non +**variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +A variable. + +**Default**: non |==== - diff --git a/tests/docs/no_namespace/16_5redefine_multi.json b/tests/docs/no_namespace/16_5redefine_multi.json new file mode 100644 index 0000000..e2af7df --- /dev/null +++ b/tests/docs/no_namespace/16_5redefine_multi.json @@ -0,0 +1 @@ +{"variable": {"type": "variable", "default": ["non"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["variable"], "names": ["variable"], "descriptions": ["A variable."], "multiple": true}} \ No newline at end of file diff --git a/tests/docs/no_namespace/16_5redefine_multi.md b/tests/docs/no_namespace/16_5redefine_multi.md index bd6929d..b1cd453 100644 --- a/tests/docs/no_namespace/16_5redefine_multi.md +++ b/tests/docs/no_namespace/16_5redefine_multi.md @@ -26,6 +26,5 @@ variable: | Variable                                                                                                                       | Description                                                                                                                    | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A variable.
**Default**:
- non | - +| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A variable.
**Default**: non | diff --git a/tests/docs/no_namespace/16_5redefine_remove_disable_calculation.adoc b/tests/docs/no_namespace/16_5redefine_remove_disable_calculation.adoc index 2cd7c4e..3f759a5 100644 --- a/tests/docs/no_namespace/16_5redefine_remove_disable_calculation.adoc +++ b/tests/docs/no_namespace/16_5redefine_remove_disable_calculation.adoc @@ -29,16 +29,17 @@ variable: [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **condition** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A condition. + -**Default**: no +**Default**: no | + **variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A variable. |==== - diff --git a/tests/docs/no_namespace/16_5redefine_remove_disable_calculation.json b/tests/docs/no_namespace/16_5redefine_remove_disable_calculation.json new file mode 100644 index 0000000..fb65618 --- /dev/null +++ b/tests/docs/no_namespace/16_5redefine_remove_disable_calculation.json @@ -0,0 +1 @@ +{"condition": {"type": "variable", "default": "no", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["condition"], "names": ["condition"], "descriptions": ["A condition."]}, "variable": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["variable"], "names": ["variable"], "descriptions": ["A variable."]}} \ No newline at end of file diff --git a/tests/docs/no_namespace/16_5redefine_remove_disable_calculation.md b/tests/docs/no_namespace/16_5redefine_remove_disable_calculation.md index 048f904..890b661 100644 --- a/tests/docs/no_namespace/16_5redefine_remove_disable_calculation.md +++ b/tests/docs/no_namespace/16_5redefine_remove_disable_calculation.md @@ -29,9 +29,8 @@ variable: ``` # Variables -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.
**Default**: no | -| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | - +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.
**Default**: no | +| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | diff --git a/tests/docs/no_namespace/16_5test_redefine.adoc b/tests/docs/no_namespace/16_5test_redefine.adoc index 3ea98f6..0ca1ce1 100644 --- a/tests/docs/no_namespace/16_5test_redefine.adoc +++ b/tests/docs/no_namespace/16_5test_redefine.adoc @@ -37,23 +37,25 @@ var3: [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A first variable. + **Default**: no + -**Example**: test1 +**Example**: test1 | + **var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A second variable. + **Default**: non + -**Example**: test1 +**Example**: test1 | + **var3** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A third variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A third variable. |==== - diff --git a/tests/docs/no_namespace/16_5test_redefine.json b/tests/docs/no_namespace/16_5test_redefine.json new file mode 100644 index 0000000..c6596d1 --- /dev/null +++ b/tests/docs/no_namespace/16_5test_redefine.json @@ -0,0 +1 @@ +{"var1": {"type": "variable", "default": "no", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["var1"], "names": ["var1"], "descriptions": ["A first variable."], "examples": ["test1"]}, "var2": {"type": "variable", "default": "non", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["var2"], "names": ["var2"], "descriptions": ["A second variable."], "examples": ["test1"]}, "var3": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["var3"], "names": ["var3"], "descriptions": ["A third variable."]}} \ No newline at end of file diff --git a/tests/docs/no_namespace/16_5test_redefine.md b/tests/docs/no_namespace/16_5test_redefine.md index bdff84a..a4b73b0 100644 --- a/tests/docs/no_namespace/16_5test_redefine.md +++ b/tests/docs/no_namespace/16_5test_redefine.md @@ -37,10 +37,9 @@ var3: ``` # Variables -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A first variable.
**Default**: no
**Example**: test1 | -| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second variable.
**Default**: non
**Example**: test1 | -| **var3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A third variable. | - +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A first variable.
**Default**: no
**Example**: test1 | +| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second variable.
**Default**: non
**Example**: test1 | +| **var3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A third variable. | diff --git a/tests/docs/no_namespace/16_6choice_redefine.adoc b/tests/docs/no_namespace/16_6choice_redefine.adoc index a21703e..5a94bf1 100644 --- a/tests/docs/no_namespace/16_6choice_redefine.adoc +++ b/tests/docs/no_namespace/16_6choice_redefine.adoc @@ -29,15 +29,15 @@ var: [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` `mandatory` | A choice. + **Choices**: * a -* c ← (default) +* c ← (default) |==== - diff --git a/tests/docs/no_namespace/16_6choice_redefine.json b/tests/docs/no_namespace/16_6choice_redefine.json new file mode 100644 index 0000000..7329e05 --- /dev/null +++ b/tests/docs/no_namespace/16_6choice_redefine.json @@ -0,0 +1 @@ +{"var": {"type": "variable", "default": "c", "properties": [{"type": "type", "name": "choice"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "display_default": false, "choices": ["a", "c ← (default)"], "paths": ["var"], "names": ["var"], "descriptions": ["A choice."]}} \ No newline at end of file diff --git a/tests/docs/no_namespace/16_6choice_redefine.md b/tests/docs/no_namespace/16_6choice_redefine.md index c3497fd..8f6e20e 100644 --- a/tests/docs/no_namespace/16_6choice_redefine.md +++ b/tests/docs/no_namespace/16_6choice_redefine.md @@ -33,4 +33,3 @@ var: |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **var**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A choice.
**Choices**:
- a
- c ← (default) | - diff --git a/tests/docs/no_namespace/16exists_exists.adoc b/tests/docs/no_namespace/16exists_exists.adoc index 8c6ea5b..f28f085 100644 --- a/tests/docs/no_namespace/16exists_exists.adoc +++ b/tests/docs/no_namespace/16exists_exists.adoc @@ -21,11 +21,11 @@ var: [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -Description. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +Description. |==== - diff --git a/tests/docs/no_namespace/16exists_exists.json b/tests/docs/no_namespace/16exists_exists.json new file mode 100644 index 0000000..a0f7107 --- /dev/null +++ b/tests/docs/no_namespace/16exists_exists.json @@ -0,0 +1 @@ +{"var": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["var"], "names": ["var"], "descriptions": ["Description."]}} \ No newline at end of file diff --git a/tests/docs/no_namespace/16exists_exists.md b/tests/docs/no_namespace/16exists_exists.md index c428d7b..420f969 100644 --- a/tests/docs/no_namespace/16exists_exists.md +++ b/tests/docs/no_namespace/16exists_exists.md @@ -25,4 +25,3 @@ var: |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | Description. | - diff --git a/tests/docs/no_namespace/17_5redefine_leadership.json b/tests/docs/no_namespace/17_5redefine_leadership.json new file mode 100644 index 0000000..9e26dfe --- /dev/null +++ b/tests/docs/no_namespace/17_5redefine_leadership.json @@ -0,0 +1 @@ +{} \ No newline at end of file diff --git a/tests/docs/no_namespace/20_0empty_family.json b/tests/docs/no_namespace/20_0empty_family.json new file mode 100644 index 0000000..9e26dfe --- /dev/null +++ b/tests/docs/no_namespace/20_0empty_family.json @@ -0,0 +1 @@ +{} \ No newline at end of file diff --git a/tests/docs/no_namespace/20_0family_append.adoc b/tests/docs/no_namespace/20_0family_append.adoc index be12b50..0e173c9 100644 --- a/tests/docs/no_namespace/20_0family_append.adoc +++ b/tests/docs/no_namespace/20_0family_append.adoc @@ -27,15 +27,16 @@ family: [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **family.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -The first variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +The first variable. | + **family.var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -The second variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +The second variable. |==== - diff --git a/tests/docs/no_namespace/20_0family_append.json b/tests/docs/no_namespace/20_0family_append.json new file mode 100644 index 0000000..e44d20a --- /dev/null +++ b/tests/docs/no_namespace/20_0family_append.json @@ -0,0 +1 @@ +{"family": {"type": "family", "informations": {"paths": ["family"], "names": ["family"], "description": "A family", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"var1": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["family.var1"], "names": ["var1"], "descriptions": ["The first variable."]}, "var2": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["family.var2"], "names": ["var2"], "descriptions": ["The second variable."]}}}} \ No newline at end of file diff --git a/tests/docs/no_namespace/20_0family_append.md b/tests/docs/no_namespace/20_0family_append.md index d23f4da..f3ea38c 100644 --- a/tests/docs/no_namespace/20_0family_append.md +++ b/tests/docs/no_namespace/20_0family_append.md @@ -32,4 +32,3 @@ family: | **family.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The first variable. | | **family.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The second variable. | - diff --git a/tests/docs/no_namespace/20_0family_underscore.json b/tests/docs/no_namespace/20_0family_underscore.json new file mode 100644 index 0000000..9e26dfe --- /dev/null +++ b/tests/docs/no_namespace/20_0family_underscore.json @@ -0,0 +1 @@ +{} \ No newline at end of file diff --git a/tests/docs/no_namespace/20_0multi_family.adoc b/tests/docs/no_namespace/20_0multi_family.adoc index 20cc579..49c52aa 100644 --- a/tests/docs/no_namespace/20_0multi_family.adoc +++ b/tests/docs/no_namespace/20_0multi_family.adoc @@ -22,11 +22,11 @@ family: # a family [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **family.subfamily.variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | -A variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | +A variable. |==== - diff --git a/tests/docs/no_namespace/20_0multi_family.json b/tests/docs/no_namespace/20_0multi_family.json new file mode 100644 index 0000000..b7f50f5 --- /dev/null +++ b/tests/docs/no_namespace/20_0multi_family.json @@ -0,0 +1 @@ +{"family": {"type": "family", "informations": {"paths": ["family"], "names": ["family"], "description": "a family", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"subfamily": {"type": "family", "informations": {"paths": ["family.subfamily"], "names": ["subfamily"], "description": "a sub family", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"variable": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}], "paths": ["family.subfamily.variable"], "names": ["variable"], "descriptions": ["A variable."]}}}}}} \ No newline at end of file diff --git a/tests/docs/no_namespace/20_0multi_family.md b/tests/docs/no_namespace/20_0multi_family.md index d0f976b..e3e0be5 100644 --- a/tests/docs/no_namespace/20_0multi_family.md +++ b/tests/docs/no_namespace/20_0multi_family.md @@ -27,4 +27,3 @@ family: # a family |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **family.subfamily.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A variable. | - diff --git a/tests/docs/no_namespace/20_0multi_family_basic.adoc b/tests/docs/no_namespace/20_0multi_family_basic.adoc index 91b8ee2..9db8d45 100644 --- a/tests/docs/no_namespace/20_0multi_family_basic.adoc +++ b/tests/docs/no_namespace/20_0multi_family_basic.adoc @@ -20,11 +20,11 @@ family: # a family [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **family.subfamily.variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A variable. |==== - diff --git a/tests/docs/no_namespace/20_0multi_family_basic.json b/tests/docs/no_namespace/20_0multi_family_basic.json new file mode 100644 index 0000000..ee4ba89 --- /dev/null +++ b/tests/docs/no_namespace/20_0multi_family_basic.json @@ -0,0 +1 @@ +{"family": {"type": "family", "informations": {"paths": ["family"], "names": ["family"], "description": "a family", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"subfamily": {"type": "family", "informations": {"paths": ["family.subfamily"], "names": ["subfamily"], "description": "a sub family", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"variable": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["family.subfamily.variable"], "names": ["variable"], "descriptions": ["A variable."]}}}}}} \ No newline at end of file diff --git a/tests/docs/no_namespace/20_0multi_family_basic.md b/tests/docs/no_namespace/20_0multi_family_basic.md index 8a5d84d..b15533a 100644 --- a/tests/docs/no_namespace/20_0multi_family_basic.md +++ b/tests/docs/no_namespace/20_0multi_family_basic.md @@ -25,4 +25,3 @@ family: # a family |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **family.subfamily.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | - diff --git a/tests/docs/no_namespace/20_0multi_family_expert.json b/tests/docs/no_namespace/20_0multi_family_expert.json new file mode 100644 index 0000000..9e26dfe --- /dev/null +++ b/tests/docs/no_namespace/20_0multi_family_expert.json @@ -0,0 +1 @@ +{} \ No newline at end of file diff --git a/tests/docs/no_namespace/20_0multi_family_order.adoc b/tests/docs/no_namespace/20_0multi_family_order.adoc index 967f7ff..abb4d65 100644 --- a/tests/docs/no_namespace/20_0multi_family_order.adoc +++ b/tests/docs/no_namespace/20_0multi_family_order.adoc @@ -15,11 +15,12 @@ family: # a family [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A variable. |==== === a family @@ -28,11 +29,12 @@ A variable. [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **family.variable1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A first variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A first variable. |==== ==== a sub family @@ -41,20 +43,21 @@ A first variable. [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **family.subfamily.variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A variable. |==== [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **family.variable2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A second variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A second variable. |==== - diff --git a/tests/docs/no_namespace/20_0multi_family_order.json b/tests/docs/no_namespace/20_0multi_family_order.json new file mode 100644 index 0000000..4a6bfec --- /dev/null +++ b/tests/docs/no_namespace/20_0multi_family_order.json @@ -0,0 +1 @@ +{"variable": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["variable"], "names": ["variable"], "descriptions": ["A variable."]}, "family": {"type": "family", "informations": {"paths": ["family"], "names": ["family"], "description": "a family", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"variable1": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["family.variable1"], "names": ["variable1"], "descriptions": ["A first variable."]}, "subfamily": {"type": "family", "informations": {"paths": ["family.subfamily"], "names": ["subfamily"], "description": "a sub family", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"variable": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["family.subfamily.variable"], "names": ["variable"], "descriptions": ["A variable."]}}}, "variable2": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["family.variable2"], "names": ["variable2"], "descriptions": ["A second variable."]}}}} \ No newline at end of file diff --git a/tests/docs/no_namespace/20_0multi_family_order.md b/tests/docs/no_namespace/20_0multi_family_order.md index 2a7052f..887ba84 100644 --- a/tests/docs/no_namespace/20_0multi_family_order.md +++ b/tests/docs/no_namespace/20_0multi_family_order.md @@ -40,4 +40,3 @@ family: # a family |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **family.variable2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A second variable. | - diff --git a/tests/docs/no_namespace/20_0validators_differ_redefine.adoc b/tests/docs/no_namespace/20_0validators_differ_redefine.adoc index f63577c..dcdb1b1 100644 --- a/tests/docs/no_namespace/20_0validators_differ_redefine.adoc +++ b/tests/docs/no_namespace/20_0validators_differ_redefine.adoc @@ -37,24 +37,26 @@ var3: [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A first variable. + -**Default**: no +**Default**: no | + **var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A second variable. + -**Default**: no +**Default**: no | + **var3** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A third variable. + **Validator**: var3 must be different than var2. + **Default**: yes + -**Example**: yes +**Example**: yes |==== - diff --git a/tests/docs/no_namespace/20_0validators_differ_redefine.json b/tests/docs/no_namespace/20_0validators_differ_redefine.json new file mode 100644 index 0000000..565c32a --- /dev/null +++ b/tests/docs/no_namespace/20_0validators_differ_redefine.json @@ -0,0 +1 @@ +{"var1": {"type": "variable", "default": "no", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["var1"], "names": ["var1"], "descriptions": ["A first variable."]}, "var2": {"type": "variable", "default": "no", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["var2"], "names": ["var2"], "descriptions": ["A second variable."]}, "var3": {"type": "variable", "default": "yes", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "validators": ["var3 must be different than var2."], "paths": ["var3"], "names": ["var3"], "descriptions": ["A third variable."], "examples": ["yes"]}} \ No newline at end of file diff --git a/tests/docs/no_namespace/20_0validators_differ_redefine.md b/tests/docs/no_namespace/20_0validators_differ_redefine.md index a3f4ff2..de6f56b 100644 --- a/tests/docs/no_namespace/20_0validators_differ_redefine.md +++ b/tests/docs/no_namespace/20_0validators_differ_redefine.md @@ -43,4 +43,3 @@ var3: | **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second variable.
**Default**: no | | **var3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A third variable.
**Validator**: var3 must be different than var2.
**Default**: yes
**Example**: yes | - diff --git a/tests/docs/no_namespace/20_1empty_subfamily.json b/tests/docs/no_namespace/20_1empty_subfamily.json new file mode 100644 index 0000000..9e26dfe --- /dev/null +++ b/tests/docs/no_namespace/20_1empty_subfamily.json @@ -0,0 +1 @@ +{} \ No newline at end of file diff --git a/tests/docs/no_namespace/20_9default_information_parent.adoc b/tests/docs/no_namespace/20_9default_information_parent.adoc index 9c3d511..fd33985 100644 --- a/tests/docs/no_namespace/20_9default_information_parent.adoc +++ b/tests/docs/no_namespace/20_9default_information_parent.adoc @@ -21,16 +21,17 @@ family: [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **family.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A first variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A first variable. | + **family.var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A second variable. + -**Default**: the value of the information "test_information" of the variable "family". +**Default**: the value of the information "test_information" of the variable "family". |==== - diff --git a/tests/docs/no_namespace/20_9default_information_parent.json b/tests/docs/no_namespace/20_9default_information_parent.json new file mode 100644 index 0000000..1771134 --- /dev/null +++ b/tests/docs/no_namespace/20_9default_information_parent.json @@ -0,0 +1 @@ +{"family": {"type": "family", "informations": {"paths": ["family"], "names": ["family"], "properties": [{"type": "mode", "name": "basic"}]}, "children": {"var1": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["family.var1"], "names": ["var1"], "descriptions": ["A first variable."]}, "var2": {"type": "variable", "default": "the value of the information \"test_information\" of the variable \"family\".", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["family.var2"], "names": ["var2"], "descriptions": ["A second variable."]}}}} \ No newline at end of file diff --git a/tests/docs/no_namespace/20_9default_information_parent.md b/tests/docs/no_namespace/20_9default_information_parent.md index 3f00e0f..05aeb67 100644 --- a/tests/docs/no_namespace/20_9default_information_parent.md +++ b/tests/docs/no_namespace/20_9default_information_parent.md @@ -27,4 +27,3 @@ family: | **family.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A first variable. | | **family.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second variable.
**Default**: the value of the information "test_information" of the variable "family". | - diff --git a/tests/docs/no_namespace/24_0family_hidden_condition_sub_family.adoc b/tests/docs/no_namespace/24_0family_hidden_condition_sub_family.adoc index 9ed948e..463e440 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 @@ -20,17 +20,19 @@ family: [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **condition** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | The variable use has condition. + -**Default**: no +**Default**: no |==== === possibly hidden family -`basic` `_hidden_` +`basic` `__hidden__` + **Hidden**: if condition is yes. @@ -40,11 +42,11 @@ The variable use has condition. + [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **family.subfamily.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A variable. |==== - diff --git a/tests/docs/no_namespace/24_0family_hidden_condition_sub_family.json b/tests/docs/no_namespace/24_0family_hidden_condition_sub_family.json new file mode 100644 index 0000000..d0c9df8 --- /dev/null +++ b/tests/docs/no_namespace/24_0family_hidden_condition_sub_family.json @@ -0,0 +1 @@ +{"condition": {"type": "variable", "default": "no", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["condition"], "names": ["condition"], "descriptions": ["The variable use has condition."]}, "family": {"type": "family", "informations": {"paths": ["family"], "names": ["family"], "description": "possibly hidden family", "properties": [{"type": "mode", "name": "basic"}, {"type": "property", "name": "hidden", "annotation": "if condition is yes."}]}, "children": {"subfamily": {"type": "family", "informations": {"paths": ["family.subfamily"], "names": ["subfamily"], "properties": [{"type": "mode", "name": "basic"}]}, "children": {"var1": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["family.subfamily.var1"], "names": ["var1"], "descriptions": ["A variable."]}}}}}} \ No newline at end of file diff --git a/tests/docs/no_namespace/24_0family_hidden_condition_sub_family.md b/tests/docs/no_namespace/24_0family_hidden_condition_sub_family.md index dce3a30..50a5e7b 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 @@ -21,9 +21,9 @@ family: ``` # Variables -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The variable use has condition.
**Default**: no | +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The variable use has condition.
**Default**: no | ## possibly hidden family @@ -35,8 +35,7 @@ family: `basic` -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **family.subfamily.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | - +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **family.subfamily.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | 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 ab66c00..337c542 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 @@ -18,19 +18,21 @@ family: [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **condition** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | The variable use has condition. + -**Default**: True +**Default**: true |==== === possibly hidden family -`standard` `_hidden_` +`standard` `__hidden__` -**Hidden**: when the variable "condition" has the value "True". + +**Hidden**: when the variable "condition" has the value "true". ==== a subfamily @@ -38,11 +40,11 @@ The variable use has condition. + [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **family.subfamily.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | -A variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | +A variable. |==== - diff --git a/tests/docs/no_namespace/24_0family_hidden_condition_variable_sub_family.json b/tests/docs/no_namespace/24_0family_hidden_condition_variable_sub_family.json new file mode 100644 index 0000000..fb24ef8 --- /dev/null +++ b/tests/docs/no_namespace/24_0family_hidden_condition_variable_sub_family.json @@ -0,0 +1 @@ +{"condition": {"type": "variable", "default": true, "properties": [{"type": "type", "name": "boolean"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["condition"], "names": ["condition"], "descriptions": ["The variable use has condition."]}, "family": {"type": "family", "informations": {"paths": ["family"], "names": ["family"], "description": "possibly hidden family", "properties": [{"type": "mode", "name": "standard"}, {"type": "property", "name": "hidden", "annotation": "when the variable \"condition\" has the value \"true\"."}]}, "children": {"subfamily": {"type": "family", "informations": {"paths": ["family.subfamily"], "names": ["subfamily"], "description": "a subfamily", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"var1": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}], "paths": ["family.subfamily.var1"], "names": ["var1"], "descriptions": ["A variable."]}}}}}} \ No newline at end of file diff --git a/tests/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 8f3f15c..60dc73b 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 @@ -19,22 +19,21 @@ family: ``` # Variables -| Variable                                                                                       | Description                                                                                    | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **condition**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The variable use has condition.
**Default**: True | +| Variable                                                                                                    | Description                                                                                                 | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **condition**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The variable use has condition.
**Default**: true | ## possibly hidden family `standard` *`hidden`* -**Hidden**: when the variable "condition" has the value "True". +**Hidden**: when the variable "condition" has the value "true". ### a subfamily `standard` -| Variable                                                                                       | Description                                                                                    | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **family.subfamily.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A variable. | - +| Variable                                                                                                    | Description                                                                                                 | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **family.subfamily.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A variable. | 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 63874ac..fc8859e 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 @@ -23,17 +23,19 @@ family: [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **condition** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | The variable use has condition. + -**Default**: no +**Default**: no |==== === possibly hidden family -`basic` `_hidden_` +`basic` `__hidden__` + **Hidden**: if condition is yes. @@ -43,11 +45,11 @@ The variable use has condition. + [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **family.sub_family.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A variable. |==== - diff --git a/tests/docs/no_namespace/24_0family_hidden_param_condition_sub_family.json b/tests/docs/no_namespace/24_0family_hidden_param_condition_sub_family.json new file mode 100644 index 0000000..6045645 --- /dev/null +++ b/tests/docs/no_namespace/24_0family_hidden_param_condition_sub_family.json @@ -0,0 +1 @@ +{"condition": {"type": "variable", "default": "no", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["condition"], "names": ["condition"], "descriptions": ["The variable use has condition."]}, "family": {"type": "family", "informations": {"paths": ["family"], "names": ["family"], "description": "possibly hidden family", "properties": [{"type": "mode", "name": "basic"}, {"type": "property", "name": "hidden", "annotation": "if condition is yes."}]}, "children": {"sub_family": {"type": "family", "informations": {"paths": ["family.sub_family"], "names": ["sub_family"], "description": "a subfamily", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"var1": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["family.sub_family.var1"], "names": ["var1"], "descriptions": ["A variable."]}}}}}} \ No newline at end of file diff --git a/tests/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 56550e2..d3dfe34 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 @@ -24,9 +24,9 @@ family: ``` # Variables -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The variable use has condition.
**Default**: no | +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The variable use has condition.
**Default**: no | ## possibly hidden family @@ -38,8 +38,7 @@ family: `basic` -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **family.sub_family.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | - +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **family.sub_family.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | diff --git a/tests/docs/no_namespace/24_0family_mandatory_condition.adoc b/tests/docs/no_namespace/24_0family_mandatory_condition.adoc index d0607d1..23122b4 100644 --- a/tests/docs/no_namespace/24_0family_mandatory_condition.adoc +++ b/tests/docs/no_namespace/24_0family_mandatory_condition.adoc @@ -18,17 +18,18 @@ var: [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **condition** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A condition. + -**Default**: no +**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". +**Mandatory**: only if rougail.condition has the value "yes". |==== - diff --git a/tests/docs/no_namespace/24_0family_mandatory_condition.json b/tests/docs/no_namespace/24_0family_mandatory_condition.json new file mode 100644 index 0000000..8c8cf6e --- /dev/null +++ b/tests/docs/no_namespace/24_0family_mandatory_condition.json @@ -0,0 +1 @@ +{"condition": {"type": "variable", "default": "no", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["condition"], "names": ["condition"], "descriptions": ["A condition."]}, "var": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory", "annotation": "only if rougail.condition has the value \"yes\"."}], "paths": ["var"], "names": ["var"], "descriptions": ["A variable."]}} \ No newline at end of file diff --git a/tests/docs/no_namespace/24_0family_mandatory_condition.md b/tests/docs/no_namespace/24_0family_mandatory_condition.md index 424b868..274243a 100644 --- a/tests/docs/no_namespace/24_0family_mandatory_condition.md +++ b/tests/docs/no_namespace/24_0family_mandatory_condition.md @@ -24,4 +24,3 @@ var: | **condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.
**Default**: no | | **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` *`mandatory`* | A variable.
**Mandatory**: only if rougail.condition has the value "yes". | - diff --git a/tests/docs/no_namespace/24_0family_mandatory_condition_variable.adoc b/tests/docs/no_namespace/24_0family_mandatory_condition_variable.adoc index 8d35346..cbfb0b0 100644 --- a/tests/docs/no_namespace/24_0family_mandatory_condition_variable.adoc +++ b/tests/docs/no_namespace/24_0family_mandatory_condition_variable.adoc @@ -14,17 +14,18 @@ var: [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **condition** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | A condition. + -**Default**: True +**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". +**Mandatory**: when the variable "condition" has the value "true". |==== - diff --git a/tests/docs/no_namespace/24_0family_mandatory_condition_variable.json b/tests/docs/no_namespace/24_0family_mandatory_condition_variable.json new file mode 100644 index 0000000..2a3b763 --- /dev/null +++ b/tests/docs/no_namespace/24_0family_mandatory_condition_variable.json @@ -0,0 +1 @@ +{"condition": {"type": "variable", "default": true, "properties": [{"type": "type", "name": "boolean"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["condition"], "names": ["condition"], "descriptions": ["A condition."]}, "var": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory", "annotation": "when the variable \"condition\" has the value \"true\"."}], "paths": ["var"], "names": ["var"], "descriptions": ["A variable."]}} \ No newline at end of file diff --git a/tests/docs/no_namespace/24_0family_mandatory_condition_variable.md b/tests/docs/no_namespace/24_0family_mandatory_condition_variable.md index 568ed91..15cff7c 100644 --- a/tests/docs/no_namespace/24_0family_mandatory_condition_variable.md +++ b/tests/docs/no_namespace/24_0family_mandatory_condition_variable.md @@ -17,7 +17,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". | - +| **condition**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.
**Default**: true | +| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` *`mandatory`* | A variable.
**Mandatory**: when the variable "condition" has the value "true". | diff --git a/tests/docs/no_namespace/04_7validators_variable_optional.adoc b/tests/docs/no_namespace/24_7validators_variable_optional.adoc similarity index 59% rename from tests/docs/no_namespace/04_7validators_variable_optional.adoc rename to tests/docs/no_namespace/24_7validators_variable_optional.adoc index 7d51479..05840fd 100644 --- a/tests/docs/no_namespace/04_7validators_variable_optional.adoc +++ b/tests/docs/no_namespace/24_7validators_variable_optional.adoc @@ -39,22 +39,23 @@ general: # a family [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **general.int** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `basic` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `basic` `mandatory` | A first number. + **Validators**: * int and int2 must be different. * int and int3 must be different. -**Example**: 5 +**Example**: 5 | + **general.int2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` | A second number. + -**Default**: 1 +**Default**: 1 |==== - diff --git a/tests/docs/no_namespace/24_7validators_variable_optional.json b/tests/docs/no_namespace/24_7validators_variable_optional.json new file mode 100644 index 0000000..cb93400 --- /dev/null +++ b/tests/docs/no_namespace/24_7validators_variable_optional.json @@ -0,0 +1 @@ +{"general": {"type": "family", "informations": {"paths": ["general"], "names": ["general"], "description": "a family", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"int": {"type": "variable", "properties": [{"type": "type", "name": "number"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "validators": ["int and int2 must be different.", "int and int3 must be different."], "paths": ["general.int"], "names": ["int"], "descriptions": ["A first number."], "examples": [5]}, "int2": {"type": "variable", "default": 1, "properties": [{"type": "type", "name": "number"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["general.int2"], "names": ["int2"], "descriptions": ["A second number."]}}}} \ No newline at end of file diff --git a/tests/docs/no_namespace/04_7validators_variable_optional.md b/tests/docs/no_namespace/24_7validators_variable_optional.md similarity index 99% rename from tests/docs/no_namespace/04_7validators_variable_optional.md rename to tests/docs/no_namespace/24_7validators_variable_optional.md index 2828217..81a6314 100644 --- a/tests/docs/no_namespace/04_7validators_variable_optional.md +++ b/tests/docs/no_namespace/24_7validators_variable_optional.md @@ -45,4 +45,3 @@ general: # a family | **general.int**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A first number.
**Validators**:
- int and int2 must be different.
- int and int3 must be different.
**Example**: 5 | | **general.int2**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second number.
**Default**: 1 | - diff --git a/tests/docs/no_namespace/24_family_disabled_var_hidden.json b/tests/docs/no_namespace/24_family_disabled_var_hidden.json new file mode 100644 index 0000000..9e26dfe --- /dev/null +++ b/tests/docs/no_namespace/24_family_disabled_var_hidden.json @@ -0,0 +1 @@ +{} \ No newline at end of file diff --git a/tests/docs/no_namespace/40_0leadership.adoc b/tests/docs/no_namespace/40_0leadership.adoc index b7c8e1d..0788249 100644 --- a/tests/docs/no_namespace/40_0leadership.adoc +++ b/tests/docs/no_namespace/40_0leadership.adoc @@ -17,24 +17,25 @@ leader: `basic` - This family contains lists of variable blocks. [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **leader.leader** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | -A leader. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | +A leader. | + **leader.follower1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A follower. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A follower. | + **leader.follower2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -An other follower. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +An other follower. |==== - diff --git a/tests/docs/no_namespace/40_0leadership.json b/tests/docs/no_namespace/40_0leadership.json new file mode 100644 index 0000000..f2a8473 --- /dev/null +++ b/tests/docs/no_namespace/40_0leadership.json @@ -0,0 +1 @@ +{"leader": {"type": "leadership", "informations": {"paths": ["leader"], "names": ["leader"], "description": "a leadership", "properties": [{"type": "mode", "name": "basic"}], "help": ["This family contains lists of variable blocks."]}, "children": {"leader": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["leader.leader"], "names": ["leader"], "descriptions": ["A leader."], "multiple": true}, "follower1": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["leader.follower1"], "names": ["follower1"], "descriptions": ["A follower."]}, "follower2": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["leader.follower2"], "names": ["follower2"], "descriptions": ["An other follower."]}}}} \ No newline at end of file diff --git a/tests/docs/no_namespace/40_0leadership.md b/tests/docs/no_namespace/40_0leadership.md index 788029b..7b9db96 100644 --- a/tests/docs/no_namespace/40_0leadership.md +++ b/tests/docs/no_namespace/40_0leadership.md @@ -20,13 +20,11 @@ leader: `basic` - This family contains lists of variable blocks. -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | A leader. | -| **leader.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A follower. | -| **leader.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | An other follower. | - +| Variable                                                                                                                    | Description                                                                                                                 | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | A leader. | +| **leader.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A follower. | +| **leader.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | An other follower. | diff --git a/tests/docs/no_namespace/40_0leadership_diff_name.adoc b/tests/docs/no_namespace/40_0leadership_diff_name.adoc index fe53c6e..1042e18 100644 --- a/tests/docs/no_namespace/40_0leadership_diff_name.adoc +++ b/tests/docs/no_namespace/40_0leadership_diff_name.adoc @@ -17,24 +17,25 @@ leadership: `basic` - This family contains lists of variable blocks. [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **leadership.leader** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | -A leader. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | +A leader. | + **leadership.follower1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A follower. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A follower. | + **leadership.follower2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -An other follower. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +An other follower. |==== - diff --git a/tests/docs/no_namespace/40_0leadership_diff_name.json b/tests/docs/no_namespace/40_0leadership_diff_name.json new file mode 100644 index 0000000..0fee048 --- /dev/null +++ b/tests/docs/no_namespace/40_0leadership_diff_name.json @@ -0,0 +1 @@ +{"leadership": {"type": "leadership", "informations": {"paths": ["leadership"], "names": ["leadership"], "description": "a leadership", "properties": [{"type": "mode", "name": "basic"}], "help": ["This family contains lists of variable blocks."]}, "children": {"leader": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["leadership.leader"], "names": ["leader"], "descriptions": ["A leader."], "multiple": true}, "follower1": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["leadership.follower1"], "names": ["follower1"], "descriptions": ["A follower."]}, "follower2": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["leadership.follower2"], "names": ["follower2"], "descriptions": ["An other follower."]}}}} \ No newline at end of file diff --git a/tests/docs/no_namespace/40_0leadership_diff_name.md b/tests/docs/no_namespace/40_0leadership_diff_name.md index 1daa9af..992b6a6 100644 --- a/tests/docs/no_namespace/40_0leadership_diff_name.md +++ b/tests/docs/no_namespace/40_0leadership_diff_name.md @@ -20,13 +20,11 @@ leadership: `basic` - This family contains lists of variable blocks. -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **leadership.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | A leader. | -| **leadership.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A follower. | -| **leadership.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | An other follower. | - +| Variable                                                                                                                    | Description                                                                                                                 | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **leadership.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | A leader. | +| **leadership.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A follower. | +| **leadership.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | An other follower. | diff --git a/tests/docs/no_namespace/40_0leadership_empty.json b/tests/docs/no_namespace/40_0leadership_empty.json new file mode 100644 index 0000000..9e26dfe --- /dev/null +++ b/tests/docs/no_namespace/40_0leadership_empty.json @@ -0,0 +1 @@ +{} \ No newline at end of file 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 87dd825..05a314d 100644 --- a/tests/docs/no_namespace/40_0leadership_follower_default_calculation.adoc +++ b/tests/docs/no_namespace/40_0leadership_follower_default_calculation.adoc @@ -22,26 +22,27 @@ leader: `basic` - This family contains lists of variable blocks. [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **leader.leader** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | -A leader. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | +A leader. | + **leader.follower1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A follower. + -**Default**: value +**Default**: value | + **leader.follower2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A second follower. + -**Default**: returns follower1 value. +**Default**: returns follower1 value. |==== - diff --git a/tests/docs/no_namespace/40_0leadership_follower_default_calculation.json b/tests/docs/no_namespace/40_0leadership_follower_default_calculation.json new file mode 100644 index 0000000..c907577 --- /dev/null +++ b/tests/docs/no_namespace/40_0leadership_follower_default_calculation.json @@ -0,0 +1 @@ +{"leader": {"type": "leadership", "informations": {"paths": ["leader"], "names": ["leader"], "description": "a leadership", "properties": [{"type": "mode", "name": "basic"}], "help": ["This family contains lists of variable blocks."]}, "children": {"leader": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["leader.leader"], "names": ["leader"], "descriptions": ["A leader."], "multiple": true}, "follower1": {"type": "variable", "default": "value", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["leader.follower1"], "names": ["follower1"], "descriptions": ["A follower."]}, "follower2": {"type": "variable", "default": "returns follower1 value.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["leader.follower2"], "names": ["follower2"], "descriptions": ["A second follower."]}}}} \ No newline at end of file diff --git a/tests/docs/no_namespace/40_0leadership_follower_default_calculation.md b/tests/docs/no_namespace/40_0leadership_follower_default_calculation.md index ca115f1..f18bbe4 100644 --- a/tests/docs/no_namespace/40_0leadership_follower_default_calculation.md +++ b/tests/docs/no_namespace/40_0leadership_follower_default_calculation.md @@ -25,13 +25,11 @@ leader: `basic` - This family contains lists of variable blocks. -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | A leader. | -| **leader.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A follower.
**Default**: value | -| **leader.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second follower.
**Default**: returns follower1 value. | - +| Variable                                                                                                                    | Description                                                                                                                 | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | A leader. | +| **leader.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A follower.
**Default**: value | +| **leader.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second follower.
**Default**: returns follower1 value. | diff --git a/tests/docs/no_namespace/40_0leadership_follower_default_value.adoc b/tests/docs/no_namespace/40_0leadership_follower_default_value.adoc index edf006a..94dbd68 100644 --- a/tests/docs/no_namespace/40_0leadership_follower_default_value.adoc +++ b/tests/docs/no_namespace/40_0leadership_follower_default_value.adoc @@ -19,21 +19,21 @@ leader: `standard` - This family contains lists of variable blocks. [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **leader.leader** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `unique` `multiple` | -A leader. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `unique` `multiple` | +A leader. | + **leader.follower1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A follower with default value. + -**Default**: value +**Default**: value |==== - diff --git a/tests/docs/no_namespace/40_0leadership_follower_default_value.json b/tests/docs/no_namespace/40_0leadership_follower_default_value.json new file mode 100644 index 0000000..e0b3abe --- /dev/null +++ b/tests/docs/no_namespace/40_0leadership_follower_default_value.json @@ -0,0 +1 @@ +{"leader": {"type": "leadership", "informations": {"paths": ["leader"], "names": ["leader"], "description": "a leadership", "properties": [{"type": "mode", "name": "standard"}], "help": ["This family contains lists of variable blocks."]}, "children": {"leader": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["leader.leader"], "names": ["leader"], "descriptions": ["A leader."], "multiple": true}, "follower1": {"type": "variable", "default": "value", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["leader.follower1"], "names": ["follower1"], "descriptions": ["A follower with default value."]}}}} \ No newline at end of file diff --git a/tests/docs/no_namespace/40_0leadership_follower_default_value.md b/tests/docs/no_namespace/40_0leadership_follower_default_value.md index ba2fae9..eced466 100644 --- a/tests/docs/no_namespace/40_0leadership_follower_default_value.md +++ b/tests/docs/no_namespace/40_0leadership_follower_default_value.md @@ -22,12 +22,10 @@ leader: `standard` - This family contains lists of variable blocks. -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A leader. | -| **leader.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A follower with default value.
**Default**: value | - +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A leader. | +| **leader.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A follower with default value.
**Default**: value | diff --git a/tests/docs/no_namespace/40_0leadership_leader_not_multi.adoc b/tests/docs/no_namespace/40_0leadership_leader_not_multi.adoc index c36e6b9..c19ac23 100644 --- a/tests/docs/no_namespace/40_0leadership_leader_not_multi.adoc +++ b/tests/docs/no_namespace/40_0leadership_leader_not_multi.adoc @@ -31,12 +31,13 @@ version: '1.0' [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **general.mode_conteneur_actif** + -`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` | No change. + -**Default**: non +**Default**: non |==== === general1 @@ -47,24 +48,25 @@ No change. + `basic` - This family contains lists of variable blocks. [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **general1.leader.leader** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | -Leader. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | +Leader. | + **general1.leader.follower1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -Follower1. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +Follower1. | + **general1.leader.follower2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -Follower2. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +Follower2. |==== - diff --git a/tests/docs/no_namespace/40_0leadership_leader_not_multi.json b/tests/docs/no_namespace/40_0leadership_leader_not_multi.json new file mode 100644 index 0000000..9571ce4 --- /dev/null +++ b/tests/docs/no_namespace/40_0leadership_leader_not_multi.json @@ -0,0 +1 @@ +{"general": {"type": "family", "informations": {"paths": ["general"], "names": ["general"], "properties": [{"type": "mode", "name": "standard"}]}, "children": {"mode_conteneur_actif": {"type": "variable", "default": "non", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["general.mode_conteneur_actif"], "names": ["mode_conteneur_actif"], "descriptions": ["No change."]}}}, "general1": {"type": "family", "informations": {"paths": ["general1"], "names": ["general1"], "properties": [{"type": "mode", "name": "basic"}]}, "children": {"leader": {"type": "leadership", "informations": {"paths": ["general1.leader"], "names": ["leader"], "properties": [{"type": "mode", "name": "basic"}], "help": ["This family contains lists of variable blocks."]}, "children": {"leader": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["general1.leader.leader"], "names": ["leader"], "multiple": true}, "follower1": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["general1.leader.follower1"], "names": ["follower1"]}, "follower2": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["general1.leader.follower2"], "names": ["follower2"]}}}}}} \ No newline at end of file diff --git a/tests/docs/no_namespace/40_0leadership_leader_not_multi.md b/tests/docs/no_namespace/40_0leadership_leader_not_multi.md index 1052ad0..31184c0 100644 --- a/tests/docs/no_namespace/40_0leadership_leader_not_multi.md +++ b/tests/docs/no_namespace/40_0leadership_leader_not_multi.md @@ -32,9 +32,9 @@ version: '1.0' `standard` -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **general.mode_conteneur_actif**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | No change.
**Default**: non | +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **general.mode_conteneur_actif**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | No change.
**Default**: non | ## general1 @@ -44,13 +44,11 @@ version: '1.0' `basic` - This family contains lists of variable blocks. -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **general1.leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | Leader. | -| **general1.leader.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | Follower1. | -| **general1.leader.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | Follower2. | - +| Variable                                                                                                                    | Description                                                                                                                 | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **general1.leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | Leader. | +| **general1.leader.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | Follower1. | +| **general1.leader.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | Follower2. | diff --git a/tests/docs/no_namespace/40_1leadership_append_follower.adoc b/tests/docs/no_namespace/40_1leadership_append_follower.adoc index f8daa6d..4265300 100644 --- a/tests/docs/no_namespace/40_1leadership_append_follower.adoc +++ b/tests/docs/no_namespace/40_1leadership_append_follower.adoc @@ -31,28 +31,30 @@ leader: `basic` - This family contains lists of variable blocks. [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **leader.leader** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | -The leader. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | +The leader. | + **leader.follower1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -The follower1. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +The follower1. | + **leader.follower2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -The follower2. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +The follower2. | + **leader.follower3** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -The follower3. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +The follower3. |==== - diff --git a/tests/docs/no_namespace/40_1leadership_append_follower.json b/tests/docs/no_namespace/40_1leadership_append_follower.json new file mode 100644 index 0000000..352f24d --- /dev/null +++ b/tests/docs/no_namespace/40_1leadership_append_follower.json @@ -0,0 +1 @@ +{"leader": {"type": "leadership", "informations": {"paths": ["leader"], "names": ["leader"], "description": "a leadership", "properties": [{"type": "mode", "name": "basic"}], "help": ["This family contains lists of variable blocks."]}, "children": {"leader": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["leader.leader"], "names": ["leader"], "descriptions": ["The leader."], "multiple": true}, "follower1": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["leader.follower1"], "names": ["follower1"], "descriptions": ["The follower1."]}, "follower2": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["leader.follower2"], "names": ["follower2"], "descriptions": ["The follower2."]}, "follower3": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["leader.follower3"], "names": ["follower3"], "descriptions": ["The follower3."]}}}} \ No newline at end of file diff --git a/tests/docs/no_namespace/40_1leadership_append_follower.md b/tests/docs/no_namespace/40_1leadership_append_follower.md index 16656b8..d445eac 100644 --- a/tests/docs/no_namespace/40_1leadership_append_follower.md +++ b/tests/docs/no_namespace/40_1leadership_append_follower.md @@ -33,14 +33,12 @@ leader: `basic` - This family contains lists of variable blocks. -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | The leader. | -| **leader.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The follower1. | -| **leader.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The follower2. | -| **leader.follower3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The follower3. | - +| Variable                                                                                                                    | Description                                                                                                                 | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | The leader. | +| **leader.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The follower1. | +| **leader.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The follower2. | +| **leader.follower3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The follower3. | diff --git a/tests/docs/no_namespace/40_6leadership_follower_multi.adoc b/tests/docs/no_namespace/40_6leadership_follower_multi.adoc index 257b96c..a53cbfb 100644 --- a/tests/docs/no_namespace/40_6leadership_follower_multi.adoc +++ b/tests/docs/no_namespace/40_6leadership_follower_multi.adoc @@ -25,27 +25,26 @@ leadership: `basic` - This family contains lists of variable blocks. [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | -**leadership.leader** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | -The leader. -| -**leadership.follower1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `multiple` | -The first follower. -| -**leadership.follower2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `multiple` | -The second follower. + -**Default**: -* value +**leadership.leader** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | +The leader. +| + +**leadership.follower1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `multiple` | +The first follower. +| + +**leadership.follower2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `multiple` | +The second follower. + +**Default**: value |==== - diff --git a/tests/docs/no_namespace/40_6leadership_follower_multi.json b/tests/docs/no_namespace/40_6leadership_follower_multi.json new file mode 100644 index 0000000..0778bf6 --- /dev/null +++ b/tests/docs/no_namespace/40_6leadership_follower_multi.json @@ -0,0 +1 @@ +{"leadership": {"type": "leadership", "informations": {"paths": ["leadership"], "names": ["leadership"], "description": "A leadership", "properties": [{"type": "mode", "name": "basic"}], "help": ["This family contains lists of variable blocks."]}, "children": {"leader": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["leadership.leader"], "names": ["leader"], "descriptions": ["The leader."], "multiple": true}, "follower1": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}, {"type": "multiple", "name": "multiple"}], "paths": ["leadership.follower1"], "names": ["follower1"], "descriptions": ["The first follower."], "multiple": true}, "follower2": {"type": "variable", "default": ["value"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "multiple", "name": "multiple"}], "paths": ["leadership.follower2"], "names": ["follower2"], "descriptions": ["The second follower."], "multiple": true}}}} \ No newline at end of file diff --git a/tests/docs/no_namespace/40_6leadership_follower_multi.md b/tests/docs/no_namespace/40_6leadership_follower_multi.md index 4510c11..04aedf8 100644 --- a/tests/docs/no_namespace/40_6leadership_follower_multi.md +++ b/tests/docs/no_namespace/40_6leadership_follower_multi.md @@ -28,13 +28,11 @@ leadership: `basic` - This family contains lists of variable blocks. -| Variable                                                                                                              | Description                                                                                                           | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **leadership.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | The leader. | -| **leadership.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `multiple` | The first follower. | -| **leadership.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `multiple` | The second follower.
**Default**:
- value | - +| Variable                                                                                                                    | Description                                                                                                                 | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **leadership.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | The leader. | +| **leadership.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `multiple` | The first follower. | +| **leadership.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `multiple` | The second follower.
**Default**: value | diff --git a/tests/docs/no_namespace/40_8calculation_boolean.adoc b/tests/docs/no_namespace/40_8calculation_boolean.adoc index aa28e2a..589e745 100644 --- a/tests/docs/no_namespace/40_8calculation_boolean.adoc +++ b/tests/docs/no_namespace/40_8calculation_boolean.adoc @@ -36,22 +36,24 @@ multi2: [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **bool** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | A boolean variable. + -**Default**: False +**Default**: false | + **multi1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` `unique` `multiple` | A first multi variable. + -**Default**: a calculation. +**Default**: a calculation. | + **multi2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` `unique` `multiple` | A second multi variable. + -**Default**: a calculation. +**Default**: a calculation. |==== - diff --git a/tests/docs/no_namespace/40_8calculation_boolean.json b/tests/docs/no_namespace/40_8calculation_boolean.json new file mode 100644 index 0000000..6092c16 --- /dev/null +++ b/tests/docs/no_namespace/40_8calculation_boolean.json @@ -0,0 +1 @@ +{"bool": {"type": "variable", "default": false, "properties": [{"type": "type", "name": "boolean"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["bool"], "names": ["bool"], "descriptions": ["A boolean variable."]}, "multi1": {"type": "variable", "default": "a calculation.", "properties": [{"type": "type", "name": "boolean"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["multi1"], "names": ["multi1"], "descriptions": ["A first multi variable."], "multiple": true}, "multi2": {"type": "variable", "default": "a calculation.", "properties": [{"type": "type", "name": "boolean"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["multi2"], "names": ["multi2"], "descriptions": ["A second multi variable."], "multiple": true}} \ No newline at end of file diff --git a/tests/docs/no_namespace/40_8calculation_boolean.md b/tests/docs/no_namespace/40_8calculation_boolean.md index 9d369ba..dd20407 100644 --- a/tests/docs/no_namespace/40_8calculation_boolean.md +++ b/tests/docs/no_namespace/40_8calculation_boolean.md @@ -39,8 +39,7 @@ multi2: | Variable                                                                                                                        | Description                                                                                                                     | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **bool**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A boolean variable.
**Default**: False | +| **bool**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A boolean variable.
**Default**: false | | **multi1**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A first multi variable.
**Default**: a calculation. | | **multi2**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A second multi variable.
**Default**: a calculation. | - diff --git a/tests/docs/no_namespace/40_8calculation_multi_variable.adoc b/tests/docs/no_namespace/40_8calculation_multi_variable.adoc index 36b29ab..6d1ee4a 100644 --- a/tests/docs/no_namespace/40_8calculation_multi_variable.adoc +++ b/tests/docs/no_namespace/40_8calculation_multi_variable.adoc @@ -16,25 +16,27 @@ var3: yes # a third variable [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | A first variable. + **Default**: * the value of the variable "var2". -* the value of the variable "var3". +* the value of the variable "var3". | + **var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A second variable. + -**Default**: no +**Default**: no | + **var3** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A third variable. + -**Default**: yes +**Default**: yes |==== - diff --git a/tests/docs/no_namespace/40_8calculation_multi_variable.json b/tests/docs/no_namespace/40_8calculation_multi_variable.json new file mode 100644 index 0000000..3041336 --- /dev/null +++ b/tests/docs/no_namespace/40_8calculation_multi_variable.json @@ -0,0 +1 @@ +{"var": {"type": "variable", "default": ["the value of the variable \"var2\".", "the value of the variable \"var3\"."], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var"], "names": ["var"], "descriptions": ["A first variable."], "multiple": true}, "var2": {"type": "variable", "default": "no", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["var2"], "names": ["var2"], "descriptions": ["A second variable."]}, "var3": {"type": "variable", "default": "yes", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["var3"], "names": ["var3"], "descriptions": ["A third variable."]}} \ No newline at end of file diff --git a/tests/docs/no_namespace/40_8calculation_multi_variable.md b/tests/docs/no_namespace/40_8calculation_multi_variable.md index 22fa195..6bb4b39 100644 --- a/tests/docs/no_namespace/40_8calculation_multi_variable.md +++ b/tests/docs/no_namespace/40_8calculation_multi_variable.md @@ -17,10 +17,9 @@ var3: yes # a third variable ``` # Variables -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A first variable.
**Default**:
- the value of the variable "var2".
- the value of the variable "var3". | -| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second variable.
**Default**: no | -| **var3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A third variable.
**Default**: yes | - +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A first variable.
**Default**:
- the value of the variable "var2".
- the value of the variable "var3". | +| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second variable.
**Default**: no | +| **var3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A third variable.
**Default**: yes | diff --git a/tests/docs/no_namespace/40_8calculation_multi_variable_parent.adoc b/tests/docs/no_namespace/40_8calculation_multi_variable_parent.adoc index 4dbbccc..0bca83b 100644 --- a/tests/docs/no_namespace/40_8calculation_multi_variable_parent.adoc +++ b/tests/docs/no_namespace/40_8calculation_multi_variable_parent.adoc @@ -15,12 +15,13 @@ fam1: # a family [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A variable. + -**Default**: no +**Default**: no |==== === a family @@ -29,12 +30,12 @@ A variable. + [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **fam1.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A calculated variable. + -**Default**: the value of the variable "var". +**Default**: the value of the variable "var". |==== - diff --git a/tests/docs/no_namespace/40_8calculation_multi_variable_parent.json b/tests/docs/no_namespace/40_8calculation_multi_variable_parent.json new file mode 100644 index 0000000..0dd64f7 --- /dev/null +++ b/tests/docs/no_namespace/40_8calculation_multi_variable_parent.json @@ -0,0 +1 @@ +{"var": {"type": "variable", "default": "no", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["var"], "names": ["var"], "descriptions": ["A variable."]}, "fam1": {"type": "family", "informations": {"paths": ["fam1"], "names": ["fam1"], "description": "a family", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"var": {"type": "variable", "default": "the value of the variable \"var\".", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["fam1.var"], "names": ["var"], "descriptions": ["A calculated variable."]}}}} \ No newline at end of file diff --git a/tests/docs/no_namespace/40_8calculation_multi_variable_parent.md b/tests/docs/no_namespace/40_8calculation_multi_variable_parent.md index 03035c8..b681162 100644 --- a/tests/docs/no_namespace/40_8calculation_multi_variable_parent.md +++ b/tests/docs/no_namespace/40_8calculation_multi_variable_parent.md @@ -28,4 +28,3 @@ fam1: # a family |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **fam1.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A calculated variable.
**Default**: the value of the variable "var". | - diff --git a/tests/docs/no_namespace/40_8calculation_multi_variable_parent2.adoc b/tests/docs/no_namespace/40_8calculation_multi_variable_parent2.adoc index 362fc6d..12133a1 100644 --- a/tests/docs/no_namespace/40_8calculation_multi_variable_parent2.adoc +++ b/tests/docs/no_namespace/40_8calculation_multi_variable_parent2.adoc @@ -20,12 +20,13 @@ fam2: # second family [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **fam1.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A variable. + -**Default**: no +**Default**: no |==== === second family @@ -34,12 +35,12 @@ A variable. + [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **fam2.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A varaible. + -**Default**: the value of the variable "fam1.var". +**Default**: the value of the variable "fam1.var". |==== - diff --git a/tests/docs/no_namespace/40_8calculation_multi_variable_parent2.json b/tests/docs/no_namespace/40_8calculation_multi_variable_parent2.json new file mode 100644 index 0000000..3c1ba4f --- /dev/null +++ b/tests/docs/no_namespace/40_8calculation_multi_variable_parent2.json @@ -0,0 +1 @@ +{"fam1": {"type": "family", "informations": {"paths": ["fam1"], "names": ["fam1"], "description": "first family", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"var": {"type": "variable", "default": "no", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["fam1.var"], "names": ["var"], "descriptions": ["A variable."]}}}, "fam2": {"type": "family", "informations": {"paths": ["fam2"], "names": ["fam2"], "description": "second family", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"var": {"type": "variable", "default": "the value of the variable \"fam1.var\".", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["fam2.var"], "names": ["var"], "descriptions": ["A varaible."]}}}} \ No newline at end of file diff --git a/tests/docs/no_namespace/40_8calculation_multi_variable_parent2.md b/tests/docs/no_namespace/40_8calculation_multi_variable_parent2.md index 97362f3..e99f06f 100644 --- a/tests/docs/no_namespace/40_8calculation_multi_variable_parent2.md +++ b/tests/docs/no_namespace/40_8calculation_multi_variable_parent2.md @@ -33,4 +33,3 @@ fam2: # second family |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **fam2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A varaible.
**Default**: the value of the variable "fam1.var". | - diff --git a/tests/docs/no_namespace/41_0choice_leader.adoc b/tests/docs/no_namespace/41_0choice_leader.adoc index e1db091..8a8e737 100644 --- a/tests/docs/no_namespace/41_0choice_leader.adoc +++ b/tests/docs/no_namespace/41_0choice_leader.adoc @@ -25,25 +25,25 @@ leader: `basic` - This family contains lists of variable blocks. [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **leader.leader** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `unique` `multiple` | -The leader. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `unique` `multiple` | +The leader. | + **leader.follower1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `basic` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `basic` `mandatory` | A follower. + **Choices**: * a * b -* c +* c |==== - diff --git a/tests/docs/no_namespace/41_0choice_leader.json b/tests/docs/no_namespace/41_0choice_leader.json new file mode 100644 index 0000000..b899d1b --- /dev/null +++ b/tests/docs/no_namespace/41_0choice_leader.json @@ -0,0 +1 @@ +{"leader": {"type": "leadership", "informations": {"paths": ["leader"], "names": ["leader"], "description": "The leadership", "properties": [{"type": "mode", "name": "basic"}], "help": ["This family contains lists of variable blocks."]}, "children": {"leader": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["leader.leader"], "names": ["leader"], "descriptions": ["The leader."], "multiple": true}, "follower1": {"type": "variable", "properties": [{"type": "type", "name": "choice"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "choices": ["a", "b", "c"], "paths": ["leader.follower1"], "names": ["follower1"], "descriptions": ["A follower."]}}}} \ No newline at end of file diff --git a/tests/docs/no_namespace/41_0choice_leader.md b/tests/docs/no_namespace/41_0choice_leader.md index 7461be2..e907a39 100644 --- a/tests/docs/no_namespace/41_0choice_leader.md +++ b/tests/docs/no_namespace/41_0choice_leader.md @@ -28,12 +28,10 @@ leader: `basic` - This family contains lists of variable blocks. -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | The leader. | -| **leader.follower1**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A follower.
**Choices**:
- a
- b
- c | - +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | The leader. | +| **leader.follower1**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A follower.
**Choices**:
- a
- b
- c | diff --git a/tests/docs/no_namespace/44_0leadership_hidden.json b/tests/docs/no_namespace/44_0leadership_hidden.json new file mode 100644 index 0000000..9e26dfe --- /dev/null +++ b/tests/docs/no_namespace/44_0leadership_hidden.json @@ -0,0 +1 @@ +{} \ No newline at end of file diff --git a/tests/docs/no_namespace/44_0leadership_leader_hidden.json b/tests/docs/no_namespace/44_0leadership_leader_hidden.json new file mode 100644 index 0000000..9e26dfe --- /dev/null +++ b/tests/docs/no_namespace/44_0leadership_leader_hidden.json @@ -0,0 +1 @@ +{} \ No newline at end of file diff --git a/tests/docs/no_namespace/44_1leadership_append_hidden_follower.json b/tests/docs/no_namespace/44_1leadership_append_hidden_follower.json new file mode 100644 index 0000000..9e26dfe --- /dev/null +++ b/tests/docs/no_namespace/44_1leadership_append_hidden_follower.json @@ -0,0 +1 @@ +{} \ No newline at end of file diff --git a/tests/docs/no_namespace/44_4leadership_mandatory.adoc b/tests/docs/no_namespace/44_4leadership_mandatory.adoc index 9afe630..95ff212 100644 --- a/tests/docs/no_namespace/44_4leadership_mandatory.adoc +++ b/tests/docs/no_namespace/44_4leadership_mandatory.adoc @@ -21,20 +21,20 @@ leader: `basic` - This family contains lists of variable blocks. [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **leader.leader** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | -A leader. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | +A leader. | + **leader.follower1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | -A follower. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | +A follower. |==== - diff --git a/tests/docs/no_namespace/44_4leadership_mandatory.json b/tests/docs/no_namespace/44_4leadership_mandatory.json new file mode 100644 index 0000000..2024426 --- /dev/null +++ b/tests/docs/no_namespace/44_4leadership_mandatory.json @@ -0,0 +1 @@ +{"leader": {"type": "leadership", "informations": {"paths": ["leader"], "names": ["leader"], "description": "a leadership", "properties": [{"type": "mode", "name": "basic"}], "help": ["This family contains lists of variable blocks."]}, "children": {"leader": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["leader.leader"], "names": ["leader"], "descriptions": ["A leader."], "multiple": true}, "follower1": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}], "paths": ["leader.follower1"], "names": ["follower1"], "descriptions": ["A follower."]}}}} \ No newline at end of file diff --git a/tests/docs/no_namespace/44_4leadership_mandatory.md b/tests/docs/no_namespace/44_4leadership_mandatory.md index 1d31e62..d571bae 100644 --- a/tests/docs/no_namespace/44_4leadership_mandatory.md +++ b/tests/docs/no_namespace/44_4leadership_mandatory.md @@ -24,12 +24,10 @@ leader: `basic` - This family contains lists of variable blocks. -| Variable                                                                                       | Description                                                                                    | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | A leader. | -| **leader.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A follower. | - +| Variable                                                                                                                    | Description                                                                                                                 | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | A leader. | +| **leader.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A follower. | diff --git a/tests/docs/no_namespace/44_4leadership_mandatory_follower.adoc b/tests/docs/no_namespace/44_4leadership_mandatory_follower.adoc index c1714cd..770966a 100644 --- a/tests/docs/no_namespace/44_4leadership_mandatory_follower.adoc +++ b/tests/docs/no_namespace/44_4leadership_mandatory_follower.adoc @@ -21,20 +21,20 @@ leader: `basic` - This family contains lists of variable blocks. [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **leader.leader** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `unique` `multiple` | -A leader. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `unique` `multiple` | +A leader. | + **leader.follower** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A follower. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A follower. |==== - diff --git a/tests/docs/no_namespace/44_4leadership_mandatory_follower.json b/tests/docs/no_namespace/44_4leadership_mandatory_follower.json new file mode 100644 index 0000000..1cce06f --- /dev/null +++ b/tests/docs/no_namespace/44_4leadership_mandatory_follower.json @@ -0,0 +1 @@ +{"leader": {"type": "leadership", "informations": {"paths": ["leader"], "names": ["leader"], "description": "a leadership", "properties": [{"type": "mode", "name": "basic"}], "help": ["This family contains lists of variable blocks."]}, "children": {"leader": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["leader.leader"], "names": ["leader"], "descriptions": ["A leader."], "multiple": true}, "follower": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["leader.follower"], "names": ["follower"], "descriptions": ["A follower."]}}}} \ No newline at end of file diff --git a/tests/docs/no_namespace/44_4leadership_mandatory_follower.md b/tests/docs/no_namespace/44_4leadership_mandatory_follower.md index 5480656..5dcad26 100644 --- a/tests/docs/no_namespace/44_4leadership_mandatory_follower.md +++ b/tests/docs/no_namespace/44_4leadership_mandatory_follower.md @@ -24,12 +24,10 @@ leader: `basic` - This family contains lists of variable blocks. -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A leader. | -| **leader.follower**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A follower. | - +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A leader. | +| **leader.follower**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A follower. | diff --git a/tests/docs/no_namespace/44_5leadership_leader_hidden_calculation.adoc b/tests/docs/no_namespace/44_5leadership_leader_hidden_calculation.adoc index e6bba4c..34cfe1e 100644 --- a/tests/docs/no_namespace/44_5leadership_leader_hidden_calculation.adoc +++ b/tests/docs/no_namespace/44_5leadership_leader_hidden_calculation.adoc @@ -24,34 +24,36 @@ leader: [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **condition** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A condition. + -**Default**: no +**Default**: no |==== === a leadership -`basic` `_hidden_` +`basic` `__hidden__` + **Hidden**: if condition is no. - This family contains lists of variable blocks. [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **leader.leader** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `unique` `multiple` | -A leader. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `unique` `multiple` | +A leader. | + **leader.follower** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A follower. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A follower. |==== - diff --git a/tests/docs/no_namespace/44_5leadership_leader_hidden_calculation.json b/tests/docs/no_namespace/44_5leadership_leader_hidden_calculation.json new file mode 100644 index 0000000..3198b96 --- /dev/null +++ b/tests/docs/no_namespace/44_5leadership_leader_hidden_calculation.json @@ -0,0 +1 @@ +{"condition": {"type": "variable", "default": "no", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["condition"], "names": ["condition"], "descriptions": ["A condition."]}, "leader": {"type": "leadership", "informations": {"paths": ["leader"], "names": ["leader"], "description": "a leadership", "properties": [{"type": "mode", "name": "basic"}, {"type": "property", "name": "hidden", "annotation": "if condition is no."}], "help": ["This family contains lists of variable blocks."]}, "children": {"leader": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["leader.leader"], "names": ["leader"], "descriptions": ["A leader."], "multiple": true}, "follower": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["leader.follower"], "names": ["follower"], "descriptions": ["A follower."]}}}} \ No newline at end of file diff --git a/tests/docs/no_namespace/44_5leadership_leader_hidden_calculation.md b/tests/docs/no_namespace/44_5leadership_leader_hidden_calculation.md index ea94850..597d823 100644 --- a/tests/docs/no_namespace/44_5leadership_leader_hidden_calculation.md +++ b/tests/docs/no_namespace/44_5leadership_leader_hidden_calculation.md @@ -25,9 +25,9 @@ leader: ``` # Variables -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.
**Default**: no | +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.
**Default**: no | ## a leadership @@ -35,12 +35,10 @@ leader: **Hidden**: if condition is no. - This family contains lists of variable blocks. -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A leader. | -| **leader.follower**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A follower. | - +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A leader. | +| **leader.follower**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A follower. | diff --git a/tests/docs/no_namespace/44_6leadership_follower_disabled_calculation.adoc b/tests/docs/no_namespace/44_6leadership_follower_disabled_calculation.adoc index 56f0429..c1739f5 100644 --- a/tests/docs/no_namespace/44_6leadership_follower_disabled_calculation.adoc +++ b/tests/docs/no_namespace/44_6leadership_follower_disabled_calculation.adoc @@ -24,33 +24,34 @@ leader: [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **condition** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A condition. + -**Default**: yes +**Default**: yes |==== === a leadership `basic` - This family contains lists of variable blocks. [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **leader.leader** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | -A leader. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | +A leader. | + **leader.follower** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `_disabled_` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `__disabled__` | A follower. + -**Disabled**: if condition is yes. +**Disabled**: if condition is yes. |==== - diff --git a/tests/docs/no_namespace/44_6leadership_follower_disabled_calculation.json b/tests/docs/no_namespace/44_6leadership_follower_disabled_calculation.json new file mode 100644 index 0000000..7bc4562 --- /dev/null +++ b/tests/docs/no_namespace/44_6leadership_follower_disabled_calculation.json @@ -0,0 +1 @@ +{"condition": {"type": "variable", "default": "yes", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["condition"], "names": ["condition"], "descriptions": ["A condition."]}, "leader": {"type": "leadership", "informations": {"paths": ["leader"], "names": ["leader"], "description": "a leadership", "properties": [{"type": "mode", "name": "basic"}], "help": ["This family contains lists of variable blocks."]}, "children": {"leader": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["leader.leader"], "names": ["leader"], "descriptions": ["A leader."], "multiple": true}, "follower": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "disabled", "annotation": "if condition is yes."}], "paths": ["leader.follower"], "names": ["follower"], "descriptions": ["A follower."]}}}} \ No newline at end of file diff --git a/tests/docs/no_namespace/44_6leadership_follower_disabled_calculation.md b/tests/docs/no_namespace/44_6leadership_follower_disabled_calculation.md index e07551a..e0f1984 100644 --- a/tests/docs/no_namespace/44_6leadership_follower_disabled_calculation.md +++ b/tests/docs/no_namespace/44_6leadership_follower_disabled_calculation.md @@ -25,20 +25,18 @@ leader: ``` # Variables -| Variable                                                                                                             | Description                                                                                                          | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.
**Default**: yes | +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.
**Default**: yes | ## a leadership `basic` - This family contains lists of variable blocks. -| Variable                                                                                                             | Description                                                                                                          | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | A leader. | -| **leader.follower**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` *`disabled`* | A follower.
**Disabled**: if condition is yes. | - +| Variable                                                                                                                    | Description                                                                                                                 | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | A leader. | +| **leader.follower**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` *`disabled`* | A follower.
**Disabled**: if condition is yes. | diff --git a/tests/docs/no_namespace/60_0family_dynamic.adoc b/tests/docs/no_namespace/60_0family_dynamic.adoc index 4dfa689..2b37e3e 100644 --- a/tests/docs/no_namespace/60_0family_dynamic.adoc +++ b/tests/docs/no_namespace/60_0family_dynamic.adoc @@ -19,33 +19,34 @@ dyn{{ identifier }}: [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | A suffix variable. + **Default**: * val1 -* val2 +* val2 |==== === A dynamic family `basic` - This family builds families dynamically. **Identifiers**: the value of the variable "var". [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | -**dynval1.var** or **dynval2.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A dynamic variable. + +**dyn__val1__.var** + +**dyn__val2__.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A dynamic variable. |==== - diff --git a/tests/docs/no_namespace/60_0family_dynamic.json b/tests/docs/no_namespace/60_0family_dynamic.json new file mode 100644 index 0000000..3f7bf27 --- /dev/null +++ b/tests/docs/no_namespace/60_0family_dynamic.json @@ -0,0 +1 @@ +{"var": {"type": "variable", "default": ["val1", "val2"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var"], "names": ["var"], "descriptions": ["A suffix variable."], "multiple": true}, "dyn{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["dynval1", "dynval2"], "names": ["dynval1", "dynval2"], "description": "A dynamic family", "properties": [{"type": "mode", "name": "basic"}], "identifiers": "the value of the variable \"var\".", "help": ["This family builds families dynamically."]}, "children": {"var": {"paths": ["dynval1.var", "dynval2.var"], "names": ["var", "var"], "type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "descriptions": ["A dynamic variable."]}}}} \ No newline at end of file diff --git a/tests/docs/no_namespace/60_0family_dynamic.md b/tests/docs/no_namespace/60_0family_dynamic.md index e562f08..072407e 100644 --- a/tests/docs/no_namespace/60_0family_dynamic.md +++ b/tests/docs/no_namespace/60_0family_dynamic.md @@ -20,21 +20,19 @@ dyn{{ identifier }}: ``` # Variables -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A suffix variable.
**Default**:
- val1
- val2 | +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A suffix variable.
**Default**:
- val1
- val2 | ## A dynamic family `basic` - This family builds families dynamically. **Identifiers**: the value of the variable "var". -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **dynval1.var** or **dynval2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A dynamic variable. | - +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dyn*val1*.var**
**dyn*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A dynamic variable. | diff --git a/tests/docs/no_namespace/60_0family_dynamic_1_1.adoc b/tests/docs/no_namespace/60_0family_dynamic_1_1.adoc index 660b058..eeb9c7c 100644 --- a/tests/docs/no_namespace/60_0family_dynamic_1_1.adoc +++ b/tests/docs/no_namespace/60_0family_dynamic_1_1.adoc @@ -18,33 +18,34 @@ dyn: [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | A suffix variable. + **Default**: * val1 -* val2 +* val2 |==== === A dynamic family `basic` - This family builds families dynamically. **Identifiers**: the value of the variable "var". [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | -**dynval1.vardyn** or **dynval2.vardyn** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A dynamic variable. + +**dyn__val1__.vardyn** + +**dyn__val2__.vardyn** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A dynamic variable. |==== - diff --git a/tests/docs/no_namespace/60_0family_dynamic_1_1.json b/tests/docs/no_namespace/60_0family_dynamic_1_1.json new file mode 100644 index 0000000..498d281 --- /dev/null +++ b/tests/docs/no_namespace/60_0family_dynamic_1_1.json @@ -0,0 +1 @@ +{"var": {"type": "variable", "default": ["val1", "val2"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var"], "names": ["var"], "descriptions": ["A suffix variable."], "multiple": true}, "dyn{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["dynval1", "dynval2"], "names": ["dynval1", "dynval2"], "description": "A dynamic family", "properties": [{"type": "mode", "name": "basic"}], "identifiers": "the value of the variable \"var\".", "help": ["This family builds families dynamically."]}, "children": {"vardyn": {"paths": ["dynval1.vardyn", "dynval2.vardyn"], "names": ["vardyn", "vardyn"], "type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "descriptions": ["A dynamic variable."]}}}} \ No newline at end of file diff --git a/tests/docs/no_namespace/60_0family_dynamic_1_1.md b/tests/docs/no_namespace/60_0family_dynamic_1_1.md index cf54dba..ca8f73e 100644 --- a/tests/docs/no_namespace/60_0family_dynamic_1_1.md +++ b/tests/docs/no_namespace/60_0family_dynamic_1_1.md @@ -19,21 +19,19 @@ dyn: ``` # Variables -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A suffix variable.
**Default**:
- val1
- val2 | +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A suffix variable.
**Default**:
- val1
- val2 | ## A dynamic family `basic` - This family builds families dynamically. **Identifiers**: the value of the variable "var". -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **dynval1.vardyn** or **dynval2.vardyn**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A dynamic variable. | - +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dyn*val1*.vardyn**
**dyn*val2*.vardyn**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A dynamic variable. | diff --git a/tests/docs/no_namespace/60_0family_dynamic_no_description.adoc b/tests/docs/no_namespace/60_0family_dynamic_no_description.adoc new file mode 100644 index 0000000..82069af --- /dev/null +++ b/tests/docs/no_namespace/60_0family_dynamic_no_description.adoc @@ -0,0 +1,52 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +--- +version: '1.1' + +var: # A suffix variable + - val1 + - val2 + +dyn{{ identifier }}: + description: A dynamic family + dynamic: + variable: _.var + var: +---- +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +A suffix variable. + +**Default**: + +* val1 +* val2 +|==== + +=== A dynamic family + +`basic` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "var". + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**dyn__val1__.var** + +**dyn__val2__.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +Var. +|==== + diff --git a/tests/docs/no_namespace/60_0family_dynamic_no_description.json b/tests/docs/no_namespace/60_0family_dynamic_no_description.json new file mode 100644 index 0000000..7757108 --- /dev/null +++ b/tests/docs/no_namespace/60_0family_dynamic_no_description.json @@ -0,0 +1 @@ +{"var": {"type": "variable", "default": ["val1", "val2"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var"], "names": ["var"], "descriptions": ["A suffix variable."], "multiple": true}, "dyn{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["dynval1", "dynval2"], "names": ["dynval1", "dynval2"], "description": "A dynamic family", "properties": [{"type": "mode", "name": "basic"}], "identifiers": "the value of the variable \"var\".", "help": ["This family builds families dynamically."]}, "children": {"var": {"paths": ["dynval1.var", "dynval2.var"], "names": ["var", "var"], "type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}]}}}} \ No newline at end of file diff --git a/tests/docs/no_namespace/60_0family_dynamic_no_description.md b/tests/docs/no_namespace/60_0family_dynamic_no_description.md new file mode 100644 index 0000000..b5831a0 --- /dev/null +++ b/tests/docs/no_namespace/60_0family_dynamic_no_description.md @@ -0,0 +1,38 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' + +var: # A suffix variable + - val1 + - val2 + +dyn{{ identifier }}: + description: A dynamic family + dynamic: + variable: _.var + var: +``` +# Variables + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A suffix variable.
**Default**:
- val1
- val2 | + +## A dynamic family + +`basic` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "var". + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dyn*val1*.var**
**dyn*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | Var. | + diff --git a/tests/docs/no_namespace/60_0family_dynamic_static.adoc b/tests/docs/no_namespace/60_0family_dynamic_static.adoc index a0919d0..e8fd07f 100644 --- a/tests/docs/no_namespace/60_0family_dynamic_static.adoc +++ b/tests/docs/no_namespace/60_0family_dynamic_static.adoc @@ -17,7 +17,6 @@ dyn{{ identifier }}: `basic` - This family builds families dynamically. **Identifiers**: @@ -27,11 +26,12 @@ This family builds families dynamically. [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | -**dynval1.var** or **dynval2.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A variable inside a dynamic family. + +**dyn__val1__.var** + +**dyn__val2__.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A variable inside a dynamic family. |==== - diff --git a/tests/docs/no_namespace/60_0family_dynamic_static.json b/tests/docs/no_namespace/60_0family_dynamic_static.json new file mode 100644 index 0000000..62b3d7f --- /dev/null +++ b/tests/docs/no_namespace/60_0family_dynamic_static.json @@ -0,0 +1 @@ +{"dyn{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["dynval1", "dynval2"], "names": ["dynval1", "dynval2"], "description": "a dynamic family", "properties": [{"type": "mode", "name": "basic"}], "identifiers": ["val1", "val2"], "help": ["This family builds families dynamically."]}, "children": {"var": {"paths": ["dynval1.var", "dynval2.var"], "names": ["var", "var"], "type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "descriptions": ["A variable inside a dynamic family."]}}}} \ No newline at end of file diff --git a/tests/docs/no_namespace/60_0family_dynamic_static.md b/tests/docs/no_namespace/60_0family_dynamic_static.md index 32d86d9..254ae7a 100644 --- a/tests/docs/no_namespace/60_0family_dynamic_static.md +++ b/tests/docs/no_namespace/60_0family_dynamic_static.md @@ -20,13 +20,11 @@ dyn{{ identifier }}: `basic` - This family builds families dynamically. **Identifiers**:
- val1
- val2 | Variable                                                                                                | Description                                                                                             | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **dynval1.var** or **dynval2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable inside a dynamic family. | - +| **dyn*val1*.var**
**dyn*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable inside a dynamic family. | diff --git a/tests/docs/no_namespace/60_0family_dynamic_test.adoc b/tests/docs/no_namespace/60_0family_dynamic_test.adoc index e686967..990bdc3 100644 --- a/tests/docs/no_namespace/60_0family_dynamic_test.adoc +++ b/tests/docs/no_namespace/60_0family_dynamic_test.adoc @@ -23,33 +23,34 @@ dyn{{ identifier }}: [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | A suffix variable. + **Examples**: * val1 -* val2 +* val2 |==== === A dynamic family `basic` - This family builds families dynamically. **Identifiers**: the value of the variable "var". [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | -**dynval1.var** or **dynval2.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A dynamic variable. + +**dyn__val1__.var** + +**dyn__val2__.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A dynamic variable. |==== - diff --git a/tests/docs/no_namespace/60_0family_dynamic_test.json b/tests/docs/no_namespace/60_0family_dynamic_test.json new file mode 100644 index 0000000..d4bd2fa --- /dev/null +++ b/tests/docs/no_namespace/60_0family_dynamic_test.json @@ -0,0 +1 @@ +{"var": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var"], "names": ["var"], "descriptions": ["A suffix variable."], "multiple": true, "examples": ["val1", "val2"]}, "dyn{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["dynval1", "dynval2"], "names": ["dynval1", "dynval2"], "description": "A dynamic family", "properties": [{"type": "mode", "name": "basic"}], "identifiers": "the value of the variable \"var\".", "help": ["This family builds families dynamically."]}, "children": {"var": {"paths": ["dynval1.var", "dynval2.var"], "names": ["var", "var"], "type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "descriptions": ["A dynamic variable."]}}}} \ No newline at end of file diff --git a/tests/docs/no_namespace/60_0family_dynamic_test.md b/tests/docs/no_namespace/60_0family_dynamic_test.md index 5686696..43366e6 100644 --- a/tests/docs/no_namespace/60_0family_dynamic_test.md +++ b/tests/docs/no_namespace/60_0family_dynamic_test.md @@ -24,21 +24,19 @@ dyn{{ identifier }}: ``` # Variables -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | A suffix variable.
**Examples**:
- val1
- val2 | +| Variable                                                                                                                    | Description                                                                                                                 | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | A suffix variable.
**Examples**:
- val1
- val2 | ## A dynamic family `basic` - This family builds families dynamically. **Identifiers**: the value of the variable "var". -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **dynval1.var** or **dynval2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A dynamic variable. | - +| Variable                                                                                                                    | Description                                                                                                                 | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dyn*val1*.var**
**dyn*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A dynamic variable. | diff --git a/tests/docs/no_namespace/60_0family_dynamic_variable_empty.adoc b/tests/docs/no_namespace/60_0family_dynamic_variable_empty.adoc index 3865143..e5f3977 100644 --- a/tests/docs/no_namespace/60_0family_dynamic_variable_empty.adoc +++ b/tests/docs/no_namespace/60_0family_dynamic_variable_empty.adoc @@ -15,30 +15,30 @@ dyn{{ identifier }}: [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | -A suffix variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | +A suffix variable. |==== === a dynamic family `standard` - This family builds families dynamically. **Identifiers**: the value of the variable "var". [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | -**dynexample.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | + +**dyn__example__.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A variable inside dynamic family. + -**Default**: val +**Default**: val |==== - diff --git a/tests/docs/no_namespace/60_0family_dynamic_variable_empty.json b/tests/docs/no_namespace/60_0family_dynamic_variable_empty.json new file mode 100644 index 0000000..3cd5999 --- /dev/null +++ b/tests/docs/no_namespace/60_0family_dynamic_variable_empty.json @@ -0,0 +1 @@ +{"var": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var"], "names": ["var"], "descriptions": ["A suffix variable."], "multiple": true}, "dyn{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["dynexample"], "names": ["dynexample"], "description": "a dynamic family", "properties": [{"type": "mode", "name": "standard"}], "identifiers": "the value of the variable \"var\".", "help": ["This family builds families dynamically."]}, "children": {"var": {"paths": ["dynexample.var"], "names": ["var"], "type": "variable", "default": "val", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "descriptions": ["A variable inside dynamic family."]}}}} \ No newline at end of file diff --git a/tests/docs/no_namespace/60_0family_dynamic_variable_empty.md b/tests/docs/no_namespace/60_0family_dynamic_variable_empty.md index ad8d4ee..85df406 100644 --- a/tests/docs/no_namespace/60_0family_dynamic_variable_empty.md +++ b/tests/docs/no_namespace/60_0family_dynamic_variable_empty.md @@ -16,21 +16,19 @@ dyn{{ identifier }}: ``` # Variables -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | A suffix variable. | +| Variable                                                                                                                    | Description                                                                                                                 | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | A suffix variable. | ## a dynamic family `standard` - This family builds families dynamically. **Identifiers**: the value of the variable "var". -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **dynexample.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable inside dynamic family.
**Default**: val | - +| Variable                                                                                                                    | Description                                                                                                                 | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dyn*example*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable inside dynamic family.
**Default**: val | diff --git a/tests/docs/no_namespace/60_0family_dynamic_variable_suffix.adoc b/tests/docs/no_namespace/60_0family_dynamic_variable_suffix.adoc index e569ffe..8344a32 100644 --- a/tests/docs/no_namespace/60_0family_dynamic_variable_suffix.adoc +++ b/tests/docs/no_namespace/60_0family_dynamic_variable_suffix.adoc @@ -17,34 +17,36 @@ dyn{{ identifier }}: [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | A suffix variable. + **Default**: * val1 -* val2 +* val2 |==== === A dynamic family `standard` - This family builds families dynamically. **Identifiers**: the value of the variable "var". [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | -**dynval1.var** or **dynval2.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | -"A dynamic variable with suffix _val1_" or "A dynamic variable with suffix _val2_". + -**Default**: a value + +**dyn__val1__.var** + +**dyn__val2__.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A dynamic variable with suffix __val1__. + +A dynamic variable with suffix __val2__. + +**Default**: a value |==== - diff --git a/tests/docs/no_namespace/60_0family_dynamic_variable_suffix.json b/tests/docs/no_namespace/60_0family_dynamic_variable_suffix.json new file mode 100644 index 0000000..15cb1d8 --- /dev/null +++ b/tests/docs/no_namespace/60_0family_dynamic_variable_suffix.json @@ -0,0 +1 @@ +{"var": {"type": "variable", "default": ["val1", "val2"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var"], "names": ["var"], "descriptions": ["A suffix variable."], "multiple": true}, "dyn{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["dynval1", "dynval2"], "names": ["dynval1", "dynval2"], "description": "A dynamic family", "properties": [{"type": "mode", "name": "standard"}], "identifiers": "the value of the variable \"var\".", "help": ["This family builds families dynamically."]}, "children": {"var": {"paths": ["dynval1.var", "dynval2.var"], "names": ["var", "var"], "type": "variable", "default": "a value", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "descriptions": ["A dynamic variable with suffix val1.", "A dynamic variable with suffix val2."]}}}} \ No newline at end of file diff --git a/tests/docs/no_namespace/60_0family_dynamic_variable_suffix.md b/tests/docs/no_namespace/60_0family_dynamic_variable_suffix.md index 5620119..5fd80e9 100644 --- a/tests/docs/no_namespace/60_0family_dynamic_variable_suffix.md +++ b/tests/docs/no_namespace/60_0family_dynamic_variable_suffix.md @@ -18,21 +18,19 @@ dyn{{ identifier }}: ``` # Variables -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A suffix variable.
**Default**:
- val1
- val2 | +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A suffix variable.
**Default**:
- val1
- val2 | ## A dynamic family `standard` - This family builds families dynamically. **Identifiers**: the value of the variable "var". -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **dynval1.var** or **dynval2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | "A dynamic variable with suffix *val1*" or "A dynamic variable with suffix *val2*".
**Default**: a value | - +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dyn*val1*.var**
**dyn*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A dynamic variable with suffix *val1*.
A dynamic variable with suffix *val2*.
**Default**: a value | diff --git a/tests/docs/no_namespace/60_0family_empty.json b/tests/docs/no_namespace/60_0family_empty.json new file mode 100644 index 0000000..9e26dfe --- /dev/null +++ b/tests/docs/no_namespace/60_0family_empty.json @@ -0,0 +1 @@ +{} \ No newline at end of file diff --git a/tests/docs/no_namespace/60_0family_hidden.json b/tests/docs/no_namespace/60_0family_hidden.json new file mode 100644 index 0000000..9e26dfe --- /dev/null +++ b/tests/docs/no_namespace/60_0family_hidden.json @@ -0,0 +1 @@ +{} \ No newline at end of file diff --git a/tests/docs/no_namespace/60_0family_mode.adoc b/tests/docs/no_namespace/60_0family_mode.adoc index 0ca7f09..a0af59b 100644 --- a/tests/docs/no_namespace/60_0family_mode.adoc +++ b/tests/docs/no_namespace/60_0family_mode.adoc @@ -18,12 +18,12 @@ family: # a family [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **family.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | A variable. + -**Default**: non +**Default**: non |==== - diff --git a/tests/docs/no_namespace/60_0family_mode.json b/tests/docs/no_namespace/60_0family_mode.json new file mode 100644 index 0000000..3394837 --- /dev/null +++ b/tests/docs/no_namespace/60_0family_mode.json @@ -0,0 +1 @@ +{"family": {"type": "family", "informations": {"paths": ["family"], "names": ["family"], "description": "a family", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"var": {"type": "variable", "default": "non", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["family.var"], "names": ["var"], "descriptions": ["A variable."]}}}} \ No newline at end of file diff --git a/tests/docs/no_namespace/60_0family_mode.md b/tests/docs/no_namespace/60_0family_mode.md index 1344836..74aa2e3 100644 --- a/tests/docs/no_namespace/60_0family_mode.md +++ b/tests/docs/no_namespace/60_0family_mode.md @@ -23,4 +23,3 @@ family: # a family |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **family.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable.
**Default**: non | - diff --git a/tests/docs/no_namespace/60_1family_dynamic_jinja.adoc b/tests/docs/no_namespace/60_1family_dynamic_jinja.adoc index 4cb4f56..a938910 100644 --- a/tests/docs/no_namespace/60_1family_dynamic_jinja.adoc +++ b/tests/docs/no_namespace/60_1family_dynamic_jinja.adoc @@ -21,34 +21,35 @@ dyn{{ identifier }}: [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | A suffix variable. + **Default**: * val1 -* val2 +* val2 |==== === A dynamic family `standard` - This family builds families dynamically. **Identifiers**: index of suffix value. [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | -**dyn1.var** or **dyn2.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | + +**dyn__1__.var** + +**dyn__2__.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A dynamic variable. + -**Default**: val +**Default**: val |==== - diff --git a/tests/docs/no_namespace/60_1family_dynamic_jinja.json b/tests/docs/no_namespace/60_1family_dynamic_jinja.json new file mode 100644 index 0000000..a53308f --- /dev/null +++ b/tests/docs/no_namespace/60_1family_dynamic_jinja.json @@ -0,0 +1 @@ +{"var": {"type": "variable", "default": ["val1", "val2"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var"], "names": ["var"], "descriptions": ["A suffix variable."], "multiple": true}, "dyn{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["dyn1", "dyn2"], "names": ["dyn1", "dyn2"], "description": "A dynamic family", "properties": [{"type": "mode", "name": "standard"}], "identifiers": "index of suffix value.", "help": ["This family builds families dynamically."]}, "children": {"var": {"paths": ["dyn1.var", "dyn2.var"], "names": ["var", "var"], "type": "variable", "default": "val", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "descriptions": ["A dynamic variable."]}}}} \ No newline at end of file diff --git a/tests/docs/no_namespace/60_1family_dynamic_jinja.md b/tests/docs/no_namespace/60_1family_dynamic_jinja.md index a7cebd7..f05ca33 100644 --- a/tests/docs/no_namespace/60_1family_dynamic_jinja.md +++ b/tests/docs/no_namespace/60_1family_dynamic_jinja.md @@ -22,21 +22,19 @@ dyn{{ identifier }}: ``` # Variables -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A suffix variable.
**Default**:
- val1
- val2 | +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A suffix variable.
**Default**:
- val1
- val2 | ## A dynamic family `standard` - This family builds families dynamically. **Identifiers**: index of suffix value. -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **dyn1.var** or **dyn2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A dynamic variable.
**Default**: val | - +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dyn*1*.var**
**dyn*2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A dynamic variable.
**Default**: val | diff --git a/tests/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 fd0cfc0..ffdb182 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 @@ -24,22 +24,22 @@ var2: [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | A suffix variable. + **Default**: * val1 -* val2 +* val2 |==== === a dynamic family `basic` - This family builds families dynamically. **Identifiers**: the value of the variable "var1". @@ -50,21 +50,23 @@ This family builds families dynamically. [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | -**dynval1.family.var** or **dynval2.family.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -With a variable. + +**dyn__val1__.family.var** + +**dyn__val2__.family.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +With a variable. |==== [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A second variable. + -**Default**: the value of var. +**Default**: the value of var. |==== - diff --git a/tests/docs/no_namespace/60_2family_dynamic_jinja_fill_sub_group.json b/tests/docs/no_namespace/60_2family_dynamic_jinja_fill_sub_group.json new file mode 100644 index 0000000..380dd5b --- /dev/null +++ b/tests/docs/no_namespace/60_2family_dynamic_jinja_fill_sub_group.json @@ -0,0 +1 @@ +{"var1": {"type": "variable", "default": ["val1", "val2"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var1"], "names": ["var1"], "descriptions": ["A suffix variable."], "multiple": true}, "dyn{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["dynval1", "dynval2"], "names": ["dynval1", "dynval2"], "description": "a dynamic family", "properties": [{"type": "mode", "name": "basic"}], "identifiers": "the value of the variable \"var1\".", "help": ["This family builds families dynamically."]}, "children": {"family": {"type": "family", "informations": {"paths": ["dynval1.family", "dynval2.family"], "names": ["family", "family"], "description": "a family", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"var": {"paths": ["dynval1.family.var", "dynval2.family.var"], "names": ["var", "var"], "type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "descriptions": ["With a variable."]}}}}}, "var2": {"type": "variable", "default": "the value of var.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["var2"], "names": ["var2"], "descriptions": ["A second variable."]}} \ No newline at end of file diff --git a/tests/docs/no_namespace/60_2family_dynamic_jinja_fill_sub_group.md b/tests/docs/no_namespace/60_2family_dynamic_jinja_fill_sub_group.md index 5dabed6..504ac55 100644 --- a/tests/docs/no_namespace/60_2family_dynamic_jinja_fill_sub_group.md +++ b/tests/docs/no_namespace/60_2family_dynamic_jinja_fill_sub_group.md @@ -25,15 +25,14 @@ var2: ``` # Variables -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A suffix variable.
**Default**:
- val1
- val2 | +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A suffix variable.
**Default**:
- val1
- val2 | ## a dynamic family `basic` - This family builds families dynamically. **Identifiers**: the value of the variable "var1". @@ -42,12 +41,11 @@ This family builds families dynamically. `basic` -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **dynval1.family.var** or **dynval2.family.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | With a variable. | - -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second variable.
**Default**: the value of var. | +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dyn*val1*.family.var**
**dyn*val2*.family.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | With a variable. | +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second variable.
**Default**: the value of var. | diff --git a/tests/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 888b56f..2a841a5 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 @@ -28,22 +28,22 @@ var2: [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | A identifier variable. + **Default**: * val1 -* val2 +* val2 |==== === a dynamic family `standard` - This family builds families dynamically. **Identifiers**: the value of the variable "var". @@ -54,22 +54,24 @@ This family builds families dynamically. [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | -**dynval1.family.var** or **dynval2.family.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | + +**dyn__val1__.family.var** + +**dyn__val2__.family.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A dynamic variable. + -**Default**: the value of the identifier. +**Default**: the value of the identifier. |==== [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A varible outside dynamic family. + -**Default**: the value of var. +**Default**: the value of var. |==== - diff --git a/tests/docs/no_namespace/60_2family_dynamic_jinja_fill_sub_group_2.json b/tests/docs/no_namespace/60_2family_dynamic_jinja_fill_sub_group_2.json new file mode 100644 index 0000000..e8810c4 --- /dev/null +++ b/tests/docs/no_namespace/60_2family_dynamic_jinja_fill_sub_group_2.json @@ -0,0 +1 @@ +{"var": {"type": "variable", "default": ["val1", "val2"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var"], "names": ["var"], "descriptions": ["A identifier variable."], "multiple": true}, "dyn{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["dynval1", "dynval2"], "names": ["dynval1", "dynval2"], "description": "a dynamic family", "properties": [{"type": "mode", "name": "standard"}], "identifiers": "the value of the variable \"var\".", "help": ["This family builds families dynamically."]}, "children": {"family": {"type": "family", "informations": {"paths": ["dynval1.family", "dynval2.family"], "names": ["family", "family"], "description": "a family inside dynamic family", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"var": {"paths": ["dynval1.family.var", "dynval2.family.var"], "names": ["var", "var"], "type": "variable", "default": "the value of the identifier.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "descriptions": ["A dynamic variable."]}}}}}, "var2": {"type": "variable", "default": "the value of var.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["var2"], "names": ["var2"], "descriptions": ["A varible outside dynamic family."]}} \ No newline at end of file diff --git a/tests/docs/no_namespace/60_2family_dynamic_jinja_fill_sub_group_2.md b/tests/docs/no_namespace/60_2family_dynamic_jinja_fill_sub_group_2.md index 2bc75c9..5476971 100644 --- a/tests/docs/no_namespace/60_2family_dynamic_jinja_fill_sub_group_2.md +++ b/tests/docs/no_namespace/60_2family_dynamic_jinja_fill_sub_group_2.md @@ -29,15 +29,14 @@ var2: ``` # Variables -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A identifier variable.
**Default**:
- val1
- val2 | +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A identifier variable.
**Default**:
- val1
- val2 | ## a dynamic family `standard` - This family builds families dynamically. **Identifiers**: the value of the variable "var". @@ -46,12 +45,11 @@ This family builds families dynamically. `standard` -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **dynval1.family.var** or **dynval2.family.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A dynamic variable.
**Default**: the value of the identifier. | - -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A varible outside dynamic family.
**Default**: the value of var. | +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dyn*val1*.family.var**
**dyn*val2*.family.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A dynamic variable.
**Default**: the value of the identifier. | +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A varible outside dynamic family.
**Default**: the value of var. | diff --git a/tests/docs/no_namespace/60_2family_dynamic_outside_calc.adoc b/tests/docs/no_namespace/60_2family_dynamic_outside_calc.adoc index ccf0c8d..873d24e 100644 --- a/tests/docs/no_namespace/60_2family_dynamic_outside_calc.adoc +++ b/tests/docs/no_namespace/60_2family_dynamic_outside_calc.adoc @@ -23,44 +23,46 @@ newvar: [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | A suffx variable. + **Default**: * val1 -* val2 +* val2 |==== === a dynamic family `standard` - This family builds families dynamically. **Identifiers**: the value of the variable "var1". [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | -**dynval1.var** or **dynval2.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | + +**dyn__val1__.var** + +**dyn__val2__.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A dynamic variable. + -**Default**: val +**Default**: val |==== [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **newvar** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A second variable. + -**Default**: the value of var. +**Default**: the value of var. |==== - diff --git a/tests/docs/no_namespace/60_2family_dynamic_outside_calc.json b/tests/docs/no_namespace/60_2family_dynamic_outside_calc.json new file mode 100644 index 0000000..ee63090 --- /dev/null +++ b/tests/docs/no_namespace/60_2family_dynamic_outside_calc.json @@ -0,0 +1 @@ +{"var1": {"type": "variable", "default": ["val1", "val2"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var1"], "names": ["var1"], "descriptions": ["A suffx variable."], "multiple": true}, "dyn{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["dynval1", "dynval2"], "names": ["dynval1", "dynval2"], "description": "a dynamic family", "properties": [{"type": "mode", "name": "standard"}], "identifiers": "the value of the variable \"var1\".", "help": ["This family builds families dynamically."]}, "children": {"var": {"paths": ["dynval1.var", "dynval2.var"], "names": ["var", "var"], "type": "variable", "default": "val", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "descriptions": ["A dynamic variable."]}}}, "newvar": {"type": "variable", "default": "the value of var.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["newvar"], "names": ["newvar"], "descriptions": ["A second variable."]}} \ No newline at end of file diff --git a/tests/docs/no_namespace/60_2family_dynamic_outside_calc.md b/tests/docs/no_namespace/60_2family_dynamic_outside_calc.md index d39f0c8..f7650f5 100644 --- a/tests/docs/no_namespace/60_2family_dynamic_outside_calc.md +++ b/tests/docs/no_namespace/60_2family_dynamic_outside_calc.md @@ -24,25 +24,23 @@ newvar: ``` # Variables -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A suffx variable.
**Default**:
- val1
- val2 | +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A suffx variable.
**Default**:
- val1
- val2 | ## a dynamic family `standard` - This family builds families dynamically. **Identifiers**: the value of the variable "var1". -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **dynval1.var** or **dynval2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A dynamic variable.
**Default**: val | - -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **newvar**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second variable.
**Default**: the value of var. | +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dyn*val1*.var**
**dyn*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A dynamic variable.
**Default**: val | +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **newvar**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second variable.
**Default**: the value of var. | diff --git a/tests/docs/no_namespace/60_5family_dynamic_calc_suffix2.adoc b/tests/docs/no_namespace/60_5family_dynamic_calc_suffix2.adoc index 71d4899..1b9c8b7 100644 --- a/tests/docs/no_namespace/60_5family_dynamic_calc_suffix2.adoc +++ b/tests/docs/no_namespace/60_5family_dynamic_calc_suffix2.adoc @@ -20,34 +20,35 @@ dyn{{ identifier }}: [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | A suffix variable. + **Default**: * val1 -* val2 +* val2 |==== === a dynamic family `standard` - This family builds families dynamically. **Identifiers**: the value of the variable "var". [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | -**dynval1.var** or **dynval2.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | + +**dyn__val1__.var** + +**dyn__val2__.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | Suffix has value. + -**Default**: the value of the identifier. +**Default**: the value of the identifier. |==== - diff --git a/tests/docs/no_namespace/60_5family_dynamic_calc_suffix2.json b/tests/docs/no_namespace/60_5family_dynamic_calc_suffix2.json new file mode 100644 index 0000000..ab8947b --- /dev/null +++ b/tests/docs/no_namespace/60_5family_dynamic_calc_suffix2.json @@ -0,0 +1 @@ +{"var": {"type": "variable", "default": ["val1", "val2"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var"], "names": ["var"], "descriptions": ["A suffix variable."], "multiple": true}, "dyn{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["dynval1", "dynval2"], "names": ["dynval1", "dynval2"], "description": "a dynamic family", "properties": [{"type": "mode", "name": "standard"}], "identifiers": "the value of the variable \"var\".", "help": ["This family builds families dynamically."]}, "children": {"var": {"paths": ["dynval1.var", "dynval2.var"], "names": ["var", "var"], "type": "variable", "default": "the value of the identifier.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "descriptions": ["Suffix has value."]}}}} \ No newline at end of file diff --git a/tests/docs/no_namespace/60_5family_dynamic_calc_suffix2.md b/tests/docs/no_namespace/60_5family_dynamic_calc_suffix2.md index 8167e5f..1a9d718 100644 --- a/tests/docs/no_namespace/60_5family_dynamic_calc_suffix2.md +++ b/tests/docs/no_namespace/60_5family_dynamic_calc_suffix2.md @@ -21,21 +21,19 @@ dyn{{ identifier }}: ``` # Variables -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A suffix variable.
**Default**:
- val1
- val2 | +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A suffix variable.
**Default**:
- val1
- val2 | ## a dynamic family `standard` - This family builds families dynamically. **Identifiers**: the value of the variable "var". -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **dynval1.var** or **dynval2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Suffix has value.
**Default**: the value of the identifier. | - +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dyn*val1*.var**
**dyn*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Suffix has value.
**Default**: the value of the identifier. | diff --git a/tests/docs/no_namespace/60_5family_dynamic_calc_suffix_param.adoc b/tests/docs/no_namespace/60_5family_dynamic_calc_suffix_param.adoc index e3c9b3e..9c23369 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 @@ -25,34 +25,35 @@ dyn{{ identifier }}: [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | A identifier variable. + **Default**: * val1 -* val2 +* val2 |==== === A dynamic family `standard` - This family builds families dynamically. **Identifiers**: the value of the variable "var". [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | -**dynval1.var** or **dynval2.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | + +**dyn__val1__.var** + +**dyn__val2__.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A dynamic variable. + -**Default**: from suffix. +**Default**: from suffix. |==== - diff --git a/tests/docs/no_namespace/60_5family_dynamic_calc_suffix_param.json b/tests/docs/no_namespace/60_5family_dynamic_calc_suffix_param.json new file mode 100644 index 0000000..e505563 --- /dev/null +++ b/tests/docs/no_namespace/60_5family_dynamic_calc_suffix_param.json @@ -0,0 +1 @@ +{"var": {"type": "variable", "default": ["val1", "val2"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var"], "names": ["var"], "descriptions": ["A identifier variable."], "multiple": true}, "dyn{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["dynval1", "dynval2"], "names": ["dynval1", "dynval2"], "description": "A dynamic family", "properties": [{"type": "mode", "name": "standard"}], "identifiers": "the value of the variable \"var\".", "help": ["This family builds families dynamically."]}, "children": {"var": {"paths": ["dynval1.var", "dynval2.var"], "names": ["var", "var"], "type": "variable", "default": "from suffix.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "descriptions": ["A dynamic variable."]}}}} \ No newline at end of file diff --git a/tests/docs/no_namespace/60_5family_dynamic_calc_suffix_param.md b/tests/docs/no_namespace/60_5family_dynamic_calc_suffix_param.md index a93a688..27f4c1d 100644 --- a/tests/docs/no_namespace/60_5family_dynamic_calc_suffix_param.md +++ b/tests/docs/no_namespace/60_5family_dynamic_calc_suffix_param.md @@ -26,21 +26,19 @@ dyn{{ identifier }}: ``` # Variables -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A identifier variable.
**Default**:
- val1
- val2 | +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A identifier variable.
**Default**:
- val1
- val2 | ## A dynamic family `standard` - This family builds families dynamically. **Identifiers**: the value of the variable "var". -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **dynval1.var** or **dynval2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A dynamic variable.
**Default**: from suffix. | - +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dyn*val1*.var**
**dyn*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A dynamic variable.
**Default**: from suffix. | diff --git a/tests/docs/no_namespace/60_5family_dynamic_calc_variable.adoc b/tests/docs/no_namespace/60_5family_dynamic_calc_variable.adoc index 6d07e23..7cfa30f 100644 --- a/tests/docs/no_namespace/60_5family_dynamic_calc_variable.adoc +++ b/tests/docs/no_namespace/60_5family_dynamic_calc_variable.adoc @@ -24,43 +24,45 @@ var2: [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | A suffix variable. + **Default**: * val1 -* val2 +* val2 |==== -=== "dyn_val1_" or "dyn_val2_" +=== dyn__val1__ or dyn__val2__ `basic` - This family builds families dynamically. **Identifiers**: the value of the variable "var1". [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | -**dynval1.var** or **dynval2.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A dynamic variable. + +**dyn__val1__.var** + +**dyn__val2__.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A dynamic variable. |==== [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A variable calculated. + -**Default**: the value of the variable "dynval1.var". +**Default**: the value of the variable "dynval1.var". |==== - diff --git a/tests/docs/no_namespace/60_5family_dynamic_calc_variable.json b/tests/docs/no_namespace/60_5family_dynamic_calc_variable.json new file mode 100644 index 0000000..f45aa35 --- /dev/null +++ b/tests/docs/no_namespace/60_5family_dynamic_calc_variable.json @@ -0,0 +1 @@ +{"var1": {"type": "variable", "default": ["val1", "val2"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var1"], "names": ["var1"], "descriptions": ["A suffix variable."], "multiple": true}, "dyn{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["dynval1", "dynval2"], "names": ["dynval1", "dynval2"], "properties": [{"type": "mode", "name": "basic"}], "identifiers": "the value of the variable \"var1\".", "help": ["This family builds families dynamically."]}, "children": {"var": {"paths": ["dynval1.var", "dynval2.var"], "names": ["var", "var"], "type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "descriptions": ["A dynamic variable."]}}}, "var2": {"type": "variable", "default": "the value of the variable \"dynval1.var\".", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["var2"], "names": ["var2"], "descriptions": ["A variable calculated."]}} \ No newline at end of file diff --git a/tests/docs/no_namespace/60_5family_dynamic_calc_variable.md b/tests/docs/no_namespace/60_5family_dynamic_calc_variable.md index 057e140..ed53efd 100644 --- a/tests/docs/no_namespace/60_5family_dynamic_calc_variable.md +++ b/tests/docs/no_namespace/60_5family_dynamic_calc_variable.md @@ -25,25 +25,23 @@ var2: ``` # Variables -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A suffix variable.
**Default**:
- val1
- val2 | +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A suffix variable.
**Default**:
- val1
- val2 | -## "dyn*val1*" or "dyn*val2*" +## dyn*val1* or dyn*val2* `basic` - This family builds families dynamically. **Identifiers**: the value of the variable "var1". -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **dynval1.var** or **dynval2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A dynamic variable. | - -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable calculated.
**Default**: the value of the variable "dynval1.var". | +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dyn*val1*.var**
**dyn*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A dynamic variable. | +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable calculated.
**Default**: the value of the variable "dynval1.var". | diff --git a/tests/docs/no_namespace/60_5family_dynamic_hidden_suffix.adoc b/tests/docs/no_namespace/60_5family_dynamic_hidden_suffix.adoc index 899aaee..5f34f70 100644 --- a/tests/docs/no_namespace/60_5family_dynamic_hidden_suffix.adoc +++ b/tests/docs/no_namespace/60_5family_dynamic_hidden_suffix.adoc @@ -31,11 +31,11 @@ dyn{{ identifier }}: === a dynamic family -`standard` `_hidden_` +`standard` `__hidden__` + **Hidden**: if suffix == 'val2'. - This family builds families dynamically. **Identifiers**: @@ -45,11 +45,13 @@ This family builds families dynamically. [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | -**dynval1.var** or **dynval2.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | -A variable. + +**dyn__val1__.var** + +**dyn__val2__.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | +A variable. |==== ==== a family @@ -58,11 +60,12 @@ A variable. [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | -**dynval1.family.var** or **dynval2.family.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | -A new variable. + +**dyn__val1__.family.var** + +**dyn__val2__.family.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | +A new variable. |==== - diff --git a/tests/docs/no_namespace/60_5family_dynamic_hidden_suffix.json b/tests/docs/no_namespace/60_5family_dynamic_hidden_suffix.json new file mode 100644 index 0000000..3f4c0f1 --- /dev/null +++ b/tests/docs/no_namespace/60_5family_dynamic_hidden_suffix.json @@ -0,0 +1 @@ +{"dyn{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["dynval1", "dynval2"], "names": ["dynval1", "dynval2"], "description": "a dynamic family", "properties": [{"type": "mode", "name": "standard"}, {"type": "property", "name": "hidden", "annotation": "if suffix == 'val2'."}], "identifiers": ["val1", "val2"], "help": ["This family builds families dynamically."]}, "children": {"var": {"paths": ["dynval1.var", "dynval2.var"], "names": ["var", "var"], "type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}], "descriptions": ["A variable."]}, "family": {"type": "family", "informations": {"paths": ["dynval1.family", "dynval2.family"], "names": ["family", "family"], "description": "a family", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"var": {"paths": ["dynval1.family.var", "dynval2.family.var"], "names": ["var", "var"], "type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}], "descriptions": ["A new variable."]}}}}}} \ No newline at end of file diff --git a/tests/docs/no_namespace/60_5family_dynamic_hidden_suffix.md b/tests/docs/no_namespace/60_5family_dynamic_hidden_suffix.md index 033ed5f..0906034 100644 --- a/tests/docs/no_namespace/60_5family_dynamic_hidden_suffix.md +++ b/tests/docs/no_namespace/60_5family_dynamic_hidden_suffix.md @@ -38,14 +38,13 @@ dyn{{ identifier }}: **Hidden**: if suffix == 'val2'. - This family builds families dynamically. **Identifiers**:
- val1
- val2 | Variable                                                                                       | Description                                                                                    | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **dynval1.var** or **dynval2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A variable. | +| **dyn*val1*.var**
**dyn*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A variable. | ### a family @@ -53,6 +52,5 @@ This family builds families dynamically. | Variable                                                                                       | Description                                                                                    | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **dynval1.family.var** or **dynval2.family.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A new variable. | - +| **dyn*val1*.family.var**
**dyn*val2*.family.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A new variable. | diff --git a/tests/docs/no_namespace/60_5family_dynamic_variable_outside_suffix.adoc b/tests/docs/no_namespace/60_5family_dynamic_variable_outside_suffix.adoc index 4f80514..25d2599 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 @@ -24,44 +24,46 @@ var2: [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | A suffix variable. + **Default**: * val1 -* val2 +* val2 |==== === a dynamic family `standard` - This family builds families dynamically. **Identifiers**: the value of the variable "var". [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | -**dyn_val1.var** or **dyn_val2.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | + +**dyn___val1__.var** + +**dyn___val2__.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A variable inside dynamic family. + -**Default**: the value of the identifier. +**Default**: the value of the identifier. |==== [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A variable. + -**Default**: the value of the variable "dyn_val1.var". +**Default**: the value of the variable "dyn_val1.var". |==== - diff --git a/tests/docs/no_namespace/60_5family_dynamic_variable_outside_suffix.json b/tests/docs/no_namespace/60_5family_dynamic_variable_outside_suffix.json new file mode 100644 index 0000000..f9ca654 --- /dev/null +++ b/tests/docs/no_namespace/60_5family_dynamic_variable_outside_suffix.json @@ -0,0 +1 @@ +{"var": {"type": "variable", "default": ["val1", "val2"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var"], "names": ["var"], "descriptions": ["A suffix variable."], "multiple": true}, "dyn_{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["dyn_val1", "dyn_val2"], "names": ["dyn_val1", "dyn_val2"], "description": "a dynamic family", "properties": [{"type": "mode", "name": "standard"}], "identifiers": "the value of the variable \"var\".", "help": ["This family builds families dynamically."]}, "children": {"var": {"paths": ["dyn_val1.var", "dyn_val2.var"], "names": ["var", "var"], "type": "variable", "default": "the value of the identifier.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "descriptions": ["A variable inside dynamic family."]}}}, "var2": {"type": "variable", "default": "the value of the variable \"dyn_val1.var\".", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["var2"], "names": ["var2"], "descriptions": ["A variable."]}} \ No newline at end of file diff --git a/tests/docs/no_namespace/60_5family_dynamic_variable_outside_suffix.md b/tests/docs/no_namespace/60_5family_dynamic_variable_outside_suffix.md index 9ce5b96..33dd297 100644 --- a/tests/docs/no_namespace/60_5family_dynamic_variable_outside_suffix.md +++ b/tests/docs/no_namespace/60_5family_dynamic_variable_outside_suffix.md @@ -25,25 +25,23 @@ var2: ``` # Variables -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A suffix variable.
**Default**:
- val1
- val2 | +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A suffix variable.
**Default**:
- val1
- val2 | ## a dynamic family `standard` - This family builds families dynamically. **Identifiers**: the value of the variable "var". -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **dyn_val1.var** or **dyn_val2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable inside dynamic family.
**Default**: the value of the identifier. | - -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: the value of the variable "dyn_val1.var". | +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dyn_*val1*.var**
**dyn_*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable inside dynamic family.
**Default**: the value of the identifier. | +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: the value of the variable "dyn_val1.var". | diff --git a/tests/docs/no_namespace/60_6family_dynamic_leadership.adoc b/tests/docs/no_namespace/60_6family_dynamic_leadership.adoc index dae5f91..73a3557 100644 --- a/tests/docs/no_namespace/60_6family_dynamic_leadership.adoc +++ b/tests/docs/no_namespace/60_6family_dynamic_leadership.adoc @@ -28,22 +28,22 @@ dyn{{ identifier }}: [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | A suffix variable. + **Default**: * val1 -* val2 +* val2 |==== === a dynamic family `basic` - This family builds families dynamically. **Identifiers**: the value of the variable "var". @@ -52,24 +52,28 @@ This family builds families dynamically. `basic` - This family contains lists of variable blocks. [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | -**dynval1.leadership.leader** or **dynval2.leadership.leader** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | -A leader. + +**dyn__val1__.leadership.leader** + +**dyn__val2__.leadership.leader** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | +A leader. | -**dynval1.leadership.follower1** or **dynval2.leadership.follower1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | -A follower1. + +**dyn__val1__.leadership.follower1** + +**dyn__val2__.leadership.follower1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | +A follower1. | -**dynval1.leadership.follower2** or **dynval2.leadership.follower2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | -A follower2. + +**dyn__val1__.leadership.follower2** + +**dyn__val2__.leadership.follower2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | +A follower2. |==== - diff --git a/tests/docs/no_namespace/60_6family_dynamic_leadership.json b/tests/docs/no_namespace/60_6family_dynamic_leadership.json new file mode 100644 index 0000000..29b2687 --- /dev/null +++ b/tests/docs/no_namespace/60_6family_dynamic_leadership.json @@ -0,0 +1 @@ +{"var": {"type": "variable", "default": ["val1", "val2"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var"], "names": ["var"], "descriptions": ["A suffix variable."], "multiple": true}, "dyn{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["dynval1", "dynval2"], "names": ["dynval1", "dynval2"], "description": "a dynamic family", "properties": [{"type": "mode", "name": "basic"}], "identifiers": "the value of the variable \"var\".", "help": ["This family builds families dynamically."]}, "children": {"leadership": {"type": "leadership", "informations": {"paths": ["dynval1.leadership", "dynval2.leadership"], "names": ["leadership", "leadership"], "description": "a leadership", "properties": [{"type": "mode", "name": "basic"}], "help": ["This family contains lists of variable blocks."]}, "children": {"leader": {"paths": ["dynval1.leadership.leader", "dynval2.leadership.leader"], "names": ["leader", "leader"], "type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "descriptions": ["A leader."], "multiple": true}, "follower1": {"paths": ["dynval1.leadership.follower1", "dynval2.leadership.follower1"], "names": ["follower1", "follower1"], "type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}], "descriptions": ["A follower1."]}, "follower2": {"paths": ["dynval1.leadership.follower2", "dynval2.leadership.follower2"], "names": ["follower2", "follower2"], "type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}], "descriptions": ["A follower2."]}}}}}} \ No newline at end of file diff --git a/tests/docs/no_namespace/60_6family_dynamic_leadership.md b/tests/docs/no_namespace/60_6family_dynamic_leadership.md index 9a5cb3c..d0c5109 100644 --- a/tests/docs/no_namespace/60_6family_dynamic_leadership.md +++ b/tests/docs/no_namespace/60_6family_dynamic_leadership.md @@ -29,15 +29,14 @@ dyn{{ identifier }}: ``` # Variables -| Variable                                                                                       | Description                                                                                    | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A suffix variable.
**Default**:
- val1
- val2 | +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A suffix variable.
**Default**:
- val1
- val2 | ## a dynamic family `basic` - This family builds families dynamically. **Identifiers**: the value of the variable "var". @@ -46,13 +45,11 @@ This family builds families dynamically. `basic` - This family contains lists of variable blocks. -| Variable                                                                                       | Description                                                                                    | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **dynval1.leadership.leader** or **dynval2.leadership.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | A leader. | -| **dynval1.leadership.follower1** or **dynval2.leadership.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A follower1. | -| **dynval1.leadership.follower2** or **dynval2.leadership.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A follower2. | - +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dyn*val1*.leadership.leader**
**dyn*val2*.leadership.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | A leader. | +| **dyn*val1*.leadership.follower1**
**dyn*val2*.leadership.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A follower1. | +| **dyn*val1*.leadership.follower2**
**dyn*val2*.leadership.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A follower2. | diff --git a/tests/docs/no_namespace/60_9family_dynamic_calc_both.adoc b/tests/docs/no_namespace/60_9family_dynamic_calc_both.adoc index afb5c39..d1257d0 100644 --- a/tests/docs/no_namespace/60_9family_dynamic_calc_both.adoc +++ b/tests/docs/no_namespace/60_9family_dynamic_calc_both.adoc @@ -16,19 +16,19 @@ dyn{{ identifier }}: [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A suffix variable. + -**Default**: val2 +**Default**: val2 |==== === a dynamic family `basic` - This family builds families dynamically. **Identifiers**: @@ -38,11 +38,12 @@ This family builds families dynamically. [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | -**dynval1.vardyn** or **dynval2.vardyn** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A dynamic variable. + +**dyn__val1__.vardyn** + +**dyn__val2__.vardyn** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A dynamic variable. |==== - diff --git a/tests/docs/no_namespace/60_9family_dynamic_calc_both.json b/tests/docs/no_namespace/60_9family_dynamic_calc_both.json new file mode 100644 index 0000000..5d2d41f --- /dev/null +++ b/tests/docs/no_namespace/60_9family_dynamic_calc_both.json @@ -0,0 +1 @@ +{"var": {"type": "variable", "default": "val2", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["var"], "names": ["var"], "descriptions": ["A suffix variable."]}, "dyn{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["dynval1", "dynval2"], "names": ["dynval1", "dynval2"], "description": "a dynamic family", "properties": [{"type": "mode", "name": "basic"}], "identifiers": ["val1", "the value of the variable \"var\"."], "help": ["This family builds families dynamically."]}, "children": {"vardyn": {"paths": ["dynval1.vardyn", "dynval2.vardyn"], "names": ["vardyn", "vardyn"], "type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "descriptions": ["A dynamic variable."]}}}} \ No newline at end of file diff --git a/tests/docs/no_namespace/60_9family_dynamic_calc_both.md b/tests/docs/no_namespace/60_9family_dynamic_calc_both.md index dba7e7c..b81402b 100644 --- a/tests/docs/no_namespace/60_9family_dynamic_calc_both.md +++ b/tests/docs/no_namespace/60_9family_dynamic_calc_both.md @@ -17,21 +17,19 @@ dyn{{ identifier }}: ``` # Variables -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A suffix variable.
**Default**: val2 | +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A suffix variable.
**Default**: val2 | ## a dynamic family `basic` - This family builds families dynamically. **Identifiers**:
- val1
- the value of the variable "var". -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **dynval1.vardyn** or **dynval2.vardyn**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A dynamic variable. | - +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dyn*val1*.vardyn**
**dyn*val2*.vardyn**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A dynamic variable. | diff --git a/tests/docs/no_namespace/68_0family_leadership_mode.adoc b/tests/docs/no_namespace/68_0family_leadership_mode.adoc index e538299..7c30a74 100644 --- a/tests/docs/no_namespace/68_0family_leadership_mode.adoc +++ b/tests/docs/no_namespace/68_0family_leadership_mode.adoc @@ -24,24 +24,25 @@ leader: `basic` - This family contains lists of variable blocks. [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | + **leader.leader** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `unique` `multiple` | -A leader. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `unique` `multiple` | +A leader. | + **leader.follower1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | -A follower1. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | +A follower1. | + **leader.follower2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A follower2. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A follower2. |==== - diff --git a/tests/docs/no_namespace/68_0family_leadership_mode.json b/tests/docs/no_namespace/68_0family_leadership_mode.json new file mode 100644 index 0000000..8491c6f --- /dev/null +++ b/tests/docs/no_namespace/68_0family_leadership_mode.json @@ -0,0 +1 @@ +{"leader": {"type": "leadership", "informations": {"paths": ["leader"], "names": ["leader"], "description": "A leadership", "properties": [{"type": "mode", "name": "basic"}], "help": ["This family contains lists of variable blocks."]}, "children": {"leader": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["leader.leader"], "names": ["leader"], "descriptions": ["A leader."], "multiple": true}, "follower1": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}], "paths": ["leader.follower1"], "names": ["follower1"], "descriptions": ["A follower1."]}, "follower2": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["leader.follower2"], "names": ["follower2"], "descriptions": ["A follower2."]}}}} \ No newline at end of file diff --git a/tests/docs/no_namespace/68_0family_leadership_mode.md b/tests/docs/no_namespace/68_0family_leadership_mode.md index 9a736f9..1484528 100644 --- a/tests/docs/no_namespace/68_0family_leadership_mode.md +++ b/tests/docs/no_namespace/68_0family_leadership_mode.md @@ -27,13 +27,11 @@ leader: `basic` - This family contains lists of variable blocks. -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `unique` `multiple` | A leader. | -| **leader.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A follower1. | -| **leader.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A follower2. | - +| Variable                                                                                                        | Description                                                                                                     | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `unique` `multiple` | A leader. | +| **leader.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A follower1. | +| **leader.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A follower2. | diff --git a/tests/force_optional.adoc b/tests/force_optional.adoc index ebf978b..5404d4c 100644 --- a/tests/force_optional.adoc +++ b/tests/force_optional.adoc @@ -1,56 +1,63 @@ -== Variables for "rougail" +== Variables [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | -**rougail.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | + +**var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `mandatory` | My var1. + -**Default**: the value of the variable "a.unknown.variable". +**Default**: the value of the variable "a.unknown.variable". | -**rougail.var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | + +**var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `mandatory` | My var2. + -**Default**: var calculated. +**Default**: var calculated. | -**rougail.var3** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `_hidden_` | + +**var3** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `mandatory` `__hidden__` | My var3. + -**Hidden**: var could be hidden. +**Hidden**: var could be hidden. | -**rougail.var4** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `_hidden_` | + +**var4** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `mandatory` `__hidden__` | My var4. + -**Hidden**: when the variable "a.unknown.variable" has the value "value". +**Hidden**: when the variable "a.unknown.variable" has the value "value". | -**rougail.var5** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | + +**var5** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `mandatory` | My var5. + -**Default**: the value of the information "info" of the variable "a.unknown.variable". +**Default**: the value of the information "info" of the variable "a.unknown.variable". | -**rougail.var6** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `basic` `mandatory` | + +**var6** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `mandatory` | My var6. + -**Choices**: the value of the variable "a.unknown.variable". +**Choices**: the value of the variable "a.unknown.variable". | -**rougail.var7** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `basic` `mandatory` | + +**var7** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `mandatory` | My var7. + **Choices**: * the value of the variable "a.unknown.variable1". -* the value of the variable "a.unknown.variable2". +* the value of the variable "a.unknown.variable2". | -**rougail.var8** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `basic` `mandatory` | + +**var8** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `mandatory` | My var8. + -**Choices**: the a.unknown.variable values. +**Choices**: the a.unknown.variable values. |==== === my var6 -`basic` This family builds families dynamically. @@ -59,11 +66,11 @@ This family builds families dynamically. [cols="1a,1a"] |==== -| Variable | Description +| Variable | Description | -**rougail.varexample.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A variable. + +**var__example__.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `mandatory` | +A variable. |==== - diff --git a/tests/test_force_optional.py b/tests/test_force_optional.py index 7f17c7b..2d875b2 100644 --- a/tests/test_force_optional.py +++ b/tests/test_force_optional.py @@ -1,11 +1,11 @@ from pathlib import Path -from rougail import RougailConfig +from rougail.config import get_rougail_config from rougail.output_doc import RougailOutputDoc def test_dictionaries(): test_dir = Path(__file__).resolve().parent - rougailconfig = RougailConfig.copy() + rougailconfig = get_rougail_config(backward_compatibility=False) rougailconfig['step.output'] = 'doc' rougailconfig['force_optional'] = True #FIXME diff --git a/tests/test_load.py b/tests/test_load.py index 0d3420b..a2c6e92 100644 --- a/tests/test_load.py +++ b/tests/test_load.py @@ -17,12 +17,12 @@ excludes = set([ for test in dico_dirs.iterdir(): if (test / 'tiramisu').is_dir() and test.name not in excludes: - test_ok.add(test) + test_ok.add(test.name) test_ok = list(test_ok) test_ok.sort() -# test_ok = [dico_dirs / '60_0family_dynamic_variable_suffix'] +# test_ok = ['00_9default_calculation_multi_optional2'] @fixture(scope="module", params=test_ok) @@ -30,11 +30,16 @@ def test_dir(request): return request.param -def _test_dictionaries(test_dir, output, namespace): +def _test_dictionaries(test, output, namespace, examples=False): + test_dir = dico_dirs / test rougailconfig = RougailConfig.copy() rougailconfig['step.output'] = 'doc' rougailconfig['doc.output_format'] = output rougailconfig['functions_files'] = [str(dico_dirs.parent / 'eosfunc' / 'test.py')] + if examples: + rougailconfig['doc.with_example'] = True + else: + rougailconfig['doc.with_example'] = False # rougailconfig['tiramisu_cache'] = "cache.py" dirs = [str(test_dir / 'dictionaries' / 'rougail')] subfolder = test_dir / 'dictionaries' / 'rougail2' @@ -57,7 +62,10 @@ def _test_dictionaries(test_dir, output, namespace): rougailconfig['extra_dictionaries'] = extra_dictionaries rougailconfig['custom_types']['custom'] = CustomOption inventory = RougailOutputDoc(rougailconfig=rougailconfig) - doc = inventory.formater.header() + try: + doc = inventory.formater.header() + except: + doc = '' yaml = YAML() len_subdir = len(str(dico_dirs)) + 1 if extra_dictionaries: @@ -69,16 +77,26 @@ def _test_dictionaries(test_dir, output, namespace): for d in dirs: for f in Path(d).iterdir(): if f.name.endswith('.yml') or f.name.endswith('.yaml'): - doc += inventory.formater.title(str(f)[len_subdir:].split('/', 1)[-1], 1) + try: + doc += inventory.formater.title(str(f)[len_subdir:].split('/', 1)[-1], 1) + except: + pass with f.open(encoding="utf8") as file_fh: objects = yaml.load(file_fh) - doc += inventory.formater.yaml(objects) - doc += inventory.gen_doc() - if namespace: - name = 'base' + try: + doc += inventory.formater.yaml(objects) + except: + pass + if examples: + name = 'examples' + doc += inventory.gen_doc_examples() else: - name = 'no_namespace' - doc_file = Path('tests') / 'docs' / name / (test_dir.name + {'github': '.md', 'asciidoc': '.adoc'}.get(output)) + if namespace: + name = 'base' + else: + name = 'no_namespace' + doc += inventory.gen_doc() + doc_file = Path('tests') / 'docs' / name / (test_dir.name + {'github': '.md', 'asciidoc': '.adoc', 'json': '.json'}.get(output)) if not doc_file.is_file(): with doc_file.open('w') as docfh: docfh.write(doc) @@ -87,6 +105,10 @@ def _test_dictionaries(test_dir, output, namespace): assert doc == result +def test_dictionaries_json(test_dir): + _test_dictionaries(test_dir, 'json', True) + + def test_dictionaries_github(test_dir): _test_dictionaries(test_dir, 'github', True) @@ -95,13 +117,23 @@ def test_dictionaries_asciidoc(test_dir): _test_dictionaries(test_dir, 'asciidoc', True) +def test_dictionaries_examples(test_dir): + _test_dictionaries(test_dir, 'github', True, True) + + +def test_dictionaries_json_no_namespace(test_dir): + if (dico_dirs / test_dir / 'force_namespace').is_file(): + return + _test_dictionaries(test_dir, 'json', False) + + def test_dictionaries_github_no_namespace(test_dir): - if (test_dir / 'force_namespace').is_file(): + if (dico_dirs / test_dir / 'force_namespace').is_file(): return _test_dictionaries(test_dir, 'github', False) def test_dictionaries_asciidoc_no_namespace(test_dir): - if (test_dir / 'force_namespace').is_file(): + if (dico_dirs / test_dir / 'force_namespace').is_file(): return _test_dictionaries(test_dir, 'asciidoc', False)