diff --git a/src/rougail/output_doc/__init__.py b/src/rougail/output_doc/__init__.py new file mode 100644 index 0000000..38c352c --- /dev/null +++ b/src/rougail/output_doc/__init__.py @@ -0,0 +1,580 @@ +#!/usr/bin/env python3 +""" +Silique (https://www.silique.fr) +Copyright (C) 2022-2024 + +distribued with GPL-2 or later license + +This program is free software; you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation; either version 2 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 General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program; if not, write to the Free Software +Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA +""" +#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 +import tabulate as tabulate_module +from tabulate import tabulate +from warnings import warn +from typing import Optional + +from gettext import gettext as _ + +from rougail.error import display_xmlfiles +from rougail import RougailConfig, Rougail, CONVERT_OPTION +from rougail.object_model import PROPERTY_ATTRIBUTE + +from .config import OutPuts + +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 only 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 {value}'), + 'max_number': _('the maximum value is {value}'), + }, + }, + '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'), + }, + }, + +} + + +ROUGAIL_VARIABLE_TYPE = ( + "https://rougail.readthedocs.io/en/latest/variable.html#variables-types" +) + + +class RougailOutputDoc: + def __init__(self, + *, + config: 'Config'=None, + rougailconfig: RougailConfig=None, + ): + if rougailconfig is None: + rougailconfig = RougailConfig + 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.get_config() + 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 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(_(f'Variables for "{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(_(f'Variables'), self.level) + return_string += doc + if not examples_all: + return '' + if examples_mini: + #"Exemple avec les variables obligatoires non renseignées" + return_string += self.formater.title( + _("Example with mandatory variables not filled in"), self.level + ) + return_string += self.formater.yaml(examples_mini) + if examples_all: + #"Exemple avec tous les variables modifiables" + 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) + suffixes = self.dynamic_paths[path]['suffixes'] + description = variable["objects"][idx][1][0] + if "{{ suffix }}" in description: + if description.endswith('.'): + description = description[:-1] + comment_msg = self.to_phrase(display_list([description.replace('{{ suffix }}', self.formater.italic(suffix)) for suffix in suffixes], 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': [], 'suffixes': []})['paths'].append(child.path()) + self.dynamic_paths[path]['suffixes'].append(child.suffixes()[-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: + suffixes = family.suffixes(only_self=True) + if '{{ suffix }}' in title: + title = display_list([title.replace('{{ suffix }}', self.formater.italic(suffix)) for suffix in suffixes], 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 = "Cette famille contient des listes de bloc de variables." + help = "This family contains lists of variable blocks." + msg += "\n" + help + ENTER + if isdynamic: + suffixes = family.suffixes(only_self=True , uncalculated=True) + if isinstance(suffixes, Calculation): + suffixes = self.to_string(family, 'dynamic') + if isinstance(suffixes, list): + for idx, val in enumerate(suffixes): + if not isinstance(val, Calculation): + continue + suffixes[idx] = self.to_string(family, 'dynamic', f'_{idx}') + suffixes = self.formater.list(suffixes) + #help = f"Cette famille construit des familles dynamiquement.\n\n{self.formater.bold('Suffixes')}: {suffixes}" + help = f"This family builds families dynamically.\n\n{self.formater.bold('Suffixes')}: {suffixes}" + 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((self.formater.prop(mode), None, None)) + break + for prop, msg in self.property_to_string: + if prop in properties: + subparameter.append((self.formater.prop(msg), None, None)) + elif variable.information.get(f'{prop}_calculation', False): + subparameter.append((self.formater.prop(msg), msg, self.to_string(variable, prop))) + + def subparameter_to_string(self, + subparameter, + ): + subparameter_str = '' + for param in subparameter: + if param[1]: + subparameter_str += f"_{param[0]}_ " + else: + subparameter_str += f"{param[0]} " + 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 = [f"{self.formater.bold(variable.path())}"] + subparameter = [] + description = variable.description(uncalculated=True) + comment = [self.to_phrase(description)] + help_ = self.to_phrase(variable.information.get("help", '')) + if help_: + comment.append(help_) + 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((self.formater.prop("multiple"), None, None)) + if subparameter: + parameter.append(self.subparameter_to_string(subparameter)) + if variable.name() == description: + warning = f'No attribute "description" for variable "{variable.path()}" in {display_xmlfiles(variable.information.get("dictionaries"))}' + 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, []]: + return + 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, + suffix='', + ): + calculation_type = variable.information.get(f'{prop}_calculation_type{suffix}', None) + if not calculation_type: + raise Exception(f'cannot find {prop}_calculation_type{suffix} information, do you have declare doc has a plugins?') + calculation = variable.information.get(f'{prop}_calculation{suffix}') + if calculation_type == 'jinja': + if calculation is not True: + values = self.formater.to_string(calculation) + else: + values = "issu d'un calcul" + warning = f'"{prop}" is a calculation for {variable.path()} but has no description in {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 = _(f'the value of the variable "{calculation}"') + else: + values = _(f"value of the {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((self.formater.link(doc_type.get('msg', variable_type), ROUGAIL_VARIABLE_TYPE), None)) + 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=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(f'{self.formater.bold("Validator")}: ' + validators[0]) + else: + comment.append(f'{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("test", None) + default = variable.value.get() + if isinstance(example, tuple): + example = list(example) + mandatory = 'mandatory' in variable.property.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 = _("Exemple") + 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 diff --git a/src/rougail/output_doc/annotator.py b/src/rougail/output_doc/annotator.py new file mode 100644 index 0000000..c70468a --- /dev/null +++ b/src/rougail/output_doc/annotator.py @@ -0,0 +1,204 @@ +"""Annotate for documentation + +Silique (https://www.silique.fr) +Copyright (C) 2024 + +distribued with GPL-2 or later license + +This program is free software; you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation; either version 2 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 General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program; if not, write to the Free Software +Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA +""" +from tiramisu import undefined +from rougail.annotator.variable import Walk + +from rougail.i18n import _ +from rougail.error import DictConsistencyError +from rougail.object_model import Calculation, JinjaCalculation, VariableCalculation, \ + InformationCalculation, IndexCalculation, SuffixCalculation, CONVERT_OPTION, \ + PROPERTY_ATTRIBUTE + + +class Annotator(Walk): + """Annotate for documentation""" + + level = 95 + + def __init__( + self, + objectspace, + *args, + ) -> None: + if not objectspace.paths: + return + self.objectspace = objectspace + self.populate_family() + self.populate_variable() + + 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): + variable, suffix = self.objectspace.paths.get_with_dynamic( + value.variable, value.path_prefix, family.path, value.version, value.namespace, value.xmlfiles + ) + values = self.objectspace.informations.get(variable.path).get('test', 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(): + self.objectspace.informations.add( + family.path, "dictionaries", family.xmlfiles + ) + self.convert_variable_property(family) + if family.type != "dynamic": + continue + if not isinstance(family.dynamic, list): + self.add_default_value(family, family.dynamic) + else: + for value in family.dynamic: + self.add_default_value(family, value, inside_list=True) + self.calculation_to_information(family.path, + 'dynamic', + family.dynamic, + family.version, + ) + + def populate_variable(self) -> None: + """convert variables""" + for variable in self.get_variables(): + if variable.type == "symlink": + continue + if variable.type == "choice": + self.calculation_to_information(variable.path, + 'choice', + variable.choices, + variable.version, + ) + self.calculation_to_information(variable.path, + 'default', + variable.default, + variable.version, + ) + self.calculation_to_information(variable.path, + 'validators', + variable.validators, + variable.version, + ) + if variable.path in self.objectspace.leaders and \ + not variable.default: + values = self.objectspace.informations.get(variable.path).get('test', None) + if values: + variable.default = list(values) + else: + variable.default = [CONVERT_OPTION[variable.type]['example']] + self.objectspace.informations.add(variable.path, 'fake_default', True) + self.objectspace.informations.add( + variable.path, "dictionaries", variable.xmlfiles + ) + self.convert_variable_property(variable) + + def convert_variable_property( + self, + variable: dict, + ) -> None: + """convert properties""" + for prop in ['hidden', 'disabled', 'mandatory']: + prop_value = getattr(variable, prop, None) + if not prop_value: + continue + self.calculation_to_information(variable.path, + prop, + prop_value, + variable.version, + ) + + def calculation_to_information(self, + path: str, + prop: str, + values, + version: str, + ): + self._calculation_to_information(path, + prop, + values, + version, + ) + if isinstance(values, list): + for idx, val in enumerate(values): + self._calculation_to_information(path, + prop, + val, + version, + suffix=f'_{idx}', + ) + + def _calculation_to_information(self, + path: str, + prop: str, + values, + version: str, + *, + suffix: str='', + ): + if not isinstance(values, Calculation): + return + values_calculation = True + if isinstance(values, JinjaCalculation): + if values.description: + values_calculation = values.description + values_calculation_type = 'jinja' + elif isinstance(values, VariableCalculation): + values_calculation = values.variable + paths = self.objectspace.paths + if version != '1.0' and paths.regexp_relative.search(values_calculation): + calculation_path = paths.get_relative_path(values_calculation, + path, + ) + if prop in PROPERTY_ATTRIBUTE: + if values.when is not undefined: + values_calculation = f'when the variable "{calculation_path}" has the value "{values.when}"' + elif values.when_not is not undefined: + values_calculation = f'when the variable "{calculation_path}" hasn\'t the value "{values.when_not}"' + else: + values_calculation = f'when the variable "{calculation_path}" has the value "True"' + else: + values_calculation = calculation_path + values_calculation_type = 'variable' + elif isinstance(values, InformationCalculation): + values_calculation_type = 'information' + elif isinstance(values, SuffixCalculation): + values_calculation_type = 'suffix' + elif isinstance(values, IndexCalculation): + values_calculation_type = 'index' + self.objectspace.informations.add(path, + f'{prop}_calculation_type{suffix}', + values_calculation_type, + ) + self.objectspace.informations.add(path, + f'{prop}_calculation{suffix}', + values_calculation, + ) diff --git a/src/rougail/output_doc/cli.py b/src/rougail/output_doc/cli.py new file mode 100644 index 0000000..9a52072 --- /dev/null +++ b/src/rougail/output_doc/cli.py @@ -0,0 +1,36 @@ +""" +Cli code for Rougail-output-doc + +Silique (https://www.silique.fr) +Copyright (C) 2024 + +distribued with GPL-2 or later license + +This program is free software; you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation; either version 2 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 General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program; if not, write to the Free Software +Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA +""" +from . import RougailOutputDoc + + +def run(rougailconfig, + config, + user_data, + ): + inventory = RougailOutputDoc(config=config, + rougailconfig=rougailconfig, + ) + print(inventory.gen_doc()) + + +__all__ = ('run',) diff --git a/src/rougail/output_doc/config.py b/src/rougail/output_doc/config.py new file mode 100644 index 0000000..93d659c --- /dev/null +++ b/src/rougail/output_doc/config.py @@ -0,0 +1,96 @@ +""" +Config file for Rougail-doc + +Silique (https://www.silique.fr) +Copyright (C) 2024 + +distribued with GPL-2 or later license + +This program is free software; you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation; either version 2 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 General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program; if not, write to the Free Software +Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA +""" +from pathlib import Path +from rougail.utils import load_modules +# from .utils import _ + + +OUTPUTS = None + + +def get_outputs() -> None: + module_name = 'rougail.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)) + 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}') + outputs[module.Formater.level] = module.Formater + return {outputs[level].name: outputs[level] for level in sorted(outputs)} + + +class OutPuts: # pylint: disable=R0903 + """Transformations applied on a object instance""" + + def __init__( + self, + ) -> None: + global OUTPUTS + if OUTPUTS is None: + OUTPUTS = get_outputs() + + def get(self) -> dict: + return OUTPUTS + + +def get_rougail_config(*, + backward_compatibility=True, + ) -> dict: + outputs = list(OutPuts().get()) + output_format_default = outputs[0] + rougail_options = """ +doc: + description: Configuration rougail-doc + disabled: + type: jinja + jinja: | + {% if step.output != 'doc' %} + disabled + {% endif %} + title_level: + description: Start title level + alternative_name: dt + default: 1 + output_format: + description: Generate document in format + alternative_name: do + default: output_format_default + choices: +""".replace('output_format_default', output_format_default) + for output in outputs: + rougail_options += f" - {output}\n" + return {'name': 'doc', + 'process': 'output', + 'options': rougail_options, + 'allow_user_data': False, + 'level': 50, + } + + +__all__ = ("OutPuts", 'get_rougail_config') diff --git a/src/rougail/output_doc/output/__init__.py b/src/rougail/output_doc/output/__init__.py new file mode 100644 index 0000000..e4581b1 --- /dev/null +++ b/src/rougail/output_doc/output/__init__.py @@ -0,0 +1,25 @@ +"""Loads output +Silique (https://www.silique.fr) +Copyright (C) 2024 + +distribued with GPL-2 or later license + +This program is free software; you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation; either version 2 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 General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program; if not, write to the Free Software +Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA +""" + + +def echo(msg): + return msg +_ = echo diff --git a/src/rougail/output_doc/output/asciidoc.py b/src/rougail/output_doc/output/asciidoc.py new file mode 100644 index 0000000..0bdbbea --- /dev/null +++ b/src/rougail/output_doc/output/asciidoc.py @@ -0,0 +1,108 @@ +from io import BytesIO +from typing import List +from itertools import chain +from ruamel.yaml import YAML + + +class Formater: + name = 'asciidoc' + level = 40 + + def __init__(self): + self._yaml = YAML() + self._yaml.indent(mapping=2, sequence=4, offset=2) + + def header(self): + return '' + + def title(self, + title: str, + level: int, + ) -> str: + char = "=" + return f"{char * (level + 1)} {title}\n\n" + + def yaml(self, dump: dict) -> str: + return f"[,yaml]\n----\n{self.dump(dump)}\n----\n" + + def table(self, table: str) -> str: + # add 'a' option in cols to display list + stable = table.split("\n", 1) + return stable[0].replace("<", "a") + "\n" + stable[1] + + def link(self, + comment: str, + link: str, + ) -> str: + return f"`{link}[{comment}]`" + + def prop(self, + prop: str, + ) -> str: + 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: + string = "" + previous = '' + for line in lst: + if string: + if self.is_list(previous.split('\n')[-1]): + string += "\n\n" + else: + string += " +\n" + string += line + + 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: + return f"**{msg}**" + + def italic(self, + msg: str, + ) -> str: + 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 diff --git a/src/rougail/output_doc/output/github.py b/src/rougail/output_doc/output/github.py new file mode 100644 index 0000000..ef5ca0b --- /dev/null +++ b/src/rougail/output_doc/output/github.py @@ -0,0 +1,98 @@ +from io import BytesIO +from typing import List +from itertools import chain +from ruamel.yaml import YAML + + +class Formater: + name = 'github' + level = 50 + + def __init__(self): + self._yaml = YAML() + self._yaml.indent(mapping=2, sequence=4, offset=2) + self.header_setted = False + + def header(self): + if self.header_setted: + return '' + self.header_setted = True + return "---\ngitea: none\ninclude_toc: true\n---\n" + + def title(self, + title: str, + level: int, + ) -> str: + 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, + ) -> str: + return f'`{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])) + + def bold(self, + msg: str, + ) -> str: + return f"**{msg}**" + + def italic(self, + msg: str, + ) -> str: + 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 diff --git a/tests/__init__.py b/tests/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/tests/custom.py b/tests/custom.py new file mode 100644 index 0000000..eb0e07f --- /dev/null +++ b/tests/custom.py @@ -0,0 +1,7 @@ +from os import environ +environ['TIRAMISU_LOCALE'] = 'en' +from tiramisu import StrOption + + +class CustomOption(StrOption): + pass diff --git a/tests/docs/base/00_0empty.adoc b/tests/docs/base/00_0empty.adoc new file mode 100644 index 0000000..e69de29 diff --git a/tests/docs/base/00_0empty.md b/tests/docs/base/00_0empty.md new file mode 100644 index 0000000..3fc684d --- /dev/null +++ b/tests/docs/base/00_0empty.md @@ -0,0 +1,4 @@ +--- +gitea: none +include_toc: true +--- diff --git a/tests/docs/base/00_0version_underscore.adoc b/tests/docs/base/00_0version_underscore.adoc new file mode 100644 index 0000000..b04ef5c --- /dev/null +++ b/tests/docs/base/00_0version_underscore.adoc @@ -0,0 +1,33 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +_version: '1.1' +version: # a variable +---- +== Variables for "rougail" + +[cols="105a,105a",options="header"] +|==== +| Variable | Description +| +**rougail.version** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A variable. +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +rougail: + version: example +---- +== Example with all variables modifiable + +[,yaml] +---- +rougail: + version: example +---- diff --git a/tests/docs/base/00_0version_underscore.md b/tests/docs/base/00_0version_underscore.md new file mode 100644 index 0000000..0477bbd --- /dev/null +++ b/tests/docs/base/00_0version_underscore.md @@ -0,0 +1,32 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +_version: '1.1' +version: # a variable +``` +# Variables for "rougail" + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.version**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | + + +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + version: example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + version: example +``` diff --git a/tests/docs/base/00_1empty_variable.adoc b/tests/docs/base/00_1empty_variable.adoc new file mode 100644 index 0000000..f2eb080 --- /dev/null +++ b/tests/docs/base/00_1empty_variable.adoc @@ -0,0 +1,33 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.0' +empty: +---- +== Variables for "rougail" + +[cols="105a,105a",options="header"] +|==== +| Variable | Description +| +**rougail.empty** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +Empty. +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +rougail: + empty: example +---- +== Example with all variables modifiable + +[,yaml] +---- +rougail: + empty: example +---- diff --git a/tests/docs/base/00_1empty_variable.md b/tests/docs/base/00_1empty_variable.md new file mode 100644 index 0000000..697252d --- /dev/null +++ b/tests/docs/base/00_1empty_variable.md @@ -0,0 +1,32 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.0' +empty: +``` +# Variables for "rougail" + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.empty**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | Empty. | + + +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + empty: example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + empty: example +``` diff --git a/tests/docs/base/00_2default_calculated.adoc b/tests/docs/base/00_2default_calculated.adoc new file mode 100644 index 0000000..0146aa8 --- /dev/null +++ b/tests/docs/base/00_2default_calculated.adoc @@ -0,0 +1,42 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: 1.1 +var1: no # a first variable +var2: + description: a second variable + multi: true + default: + type: jinja + jinja: | + {{ _.var1 }} + description: the value of var1 +---- +== Variables for "rougail" + +[cols="128a,128a",options="header"] +|==== +| Variable | Description +| +**rougail.var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A first variable. + +**Default**: no +| +**rougail.var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +A second variable. + +**Default**: the value of var1. +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +rougail: + var1: no + var2: + - no +---- diff --git a/tests/docs/base/00_2default_calculated.md b/tests/docs/base/00_2default_calculated.md new file mode 100644 index 0000000..ac86727 --- /dev/null +++ b/tests/docs/base/00_2default_calculated.md @@ -0,0 +1,36 @@ +--- +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: + type: jinja + jinja: | + {{ _.var1 }} + description: the value of var1 +``` +# 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. | + + +# Example with all variables modifiable + +```yaml +--- +rougail: + var1: no + var2: + - no +``` diff --git a/tests/docs/base/00_2default_calculated_multi.adoc b/tests/docs/base/00_2default_calculated_multi.adoc new file mode 100644 index 0000000..7541750 --- /dev/null +++ b/tests/docs/base/00_2default_calculated_multi.adoc @@ -0,0 +1,56 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: 1.1 +var1: # a first variable + - no + - yes + - maybe +var2: + description: a second variable + multi: true + default: + type: jinja + jinja: | + {% for val in _.var1 %} + {{ val }} + {% endfor %} + description: the value of _.var1 +---- +== Variables for "rougail" + +[cols="128a,128a",options="header"] +|==== +| Variable | Description +| +**rougail.var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +A first variable. + +**Default**: + +* no +* yes +* maybe +| +**rougail.var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +A second variable. + +**Default**: the value of _.var1. +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +rougail: + var1: + - no + - yes + - maybe + var2: + - no + - yes + - maybe +---- diff --git a/tests/docs/base/00_2default_calculated_multi.md b/tests/docs/base/00_2default_calculated_multi.md new file mode 100644 index 0000000..d398031 --- /dev/null +++ b/tests/docs/base/00_2default_calculated_multi.md @@ -0,0 +1,46 @@ +--- +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: + type: jinja + jinja: | + {% for val in _.var1 %} + {{ val }} + {% endfor %} + description: the value of _.var1 +``` +# 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. | + + +# Example with all variables modifiable + +```yaml +--- +rougail: + var1: + - no + - yes + - maybe + var2: + - no + - yes + - maybe +``` diff --git a/tests/docs/base/00_4load_subfolder.adoc b/tests/docs/base/00_4load_subfolder.adoc new file mode 100644 index 0000000..9359433 --- /dev/null +++ b/tests/docs/base/00_4load_subfolder.adoc @@ -0,0 +1,48 @@ +== dictionaries/rougail/99-base.yml + +[,yaml] +---- +version: '1.0' +var1: + description: a variable +---- +== dictionaries/rougail2/00-base.yml + +[,yaml] +---- +version: '1.0' +var2: + description: a variable +---- +== Variables for "rougail" + +[cols="105a,105a",options="header"] +|==== +| Variable | Description +| +**rougail.var1** + +`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. +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +rougail: + var1: example + var2: example +---- +== Example with all variables modifiable + +[,yaml] +---- +rougail: + var1: example + var2: example +---- diff --git a/tests/docs/base/00_4load_subfolder.md b/tests/docs/base/00_4load_subfolder.md new file mode 100644 index 0000000..4160388 --- /dev/null +++ b/tests/docs/base/00_4load_subfolder.md @@ -0,0 +1,44 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/99-base.yml + +```yaml +--- +version: '1.0' +var1: + description: a variable +``` +# dictionaries/rougail2/00-base.yml + +```yaml +--- +version: '1.0' +var2: + description: a variable +``` +# Variables for "rougail" + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | +| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | + + +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + var1: example + var2: example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var1: example + var2: example +``` diff --git a/tests/docs/base/00_5load_notype.adoc b/tests/docs/base/00_5load_notype.adoc new file mode 100644 index 0000000..ee553f0 --- /dev/null +++ b/tests/docs/base/00_5load_notype.adoc @@ -0,0 +1,29 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.0' +without_type: + description: a variable + default: non +---- +== Variables for "rougail" + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**rougail.without_type** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A variable. + +**Default**: non +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +rougail: + without_type: non +---- diff --git a/tests/docs/base/00_5load_notype.md b/tests/docs/base/00_5load_notype.md new file mode 100644 index 0000000..af49633 --- /dev/null +++ b/tests/docs/base/00_5load_notype.md @@ -0,0 +1,27 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.0' +without_type: + description: a variable + default: non +``` +# Variables for "rougail" + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.without_type**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: non | + + +# Example with all variables modifiable + +```yaml +--- +rougail: + without_type: non +``` diff --git a/tests/docs/base/00_6boolean.adoc b/tests/docs/base/00_6boolean.adoc new file mode 100644 index 0000000..38edf1b --- /dev/null +++ b/tests/docs/base/00_6boolean.adoc @@ -0,0 +1,72 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +var1: true # the first variable +var2: + description: the second variable + default: true +var3: + description: the third variable + type: boolean + default: true +var4: false # the forth variable +var5: + description: the fifth variable + default: false +var6: + description: the sixth variable + type: boolean + default: false +---- +== Variables for "rougail" + +[cols="109a,109a",options="header"] +|==== +| Variable | Description +| +**rougail.var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | +The first variable. + +**Default**: True +| +**rougail.var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | +The second variable. + +**Default**: True +| +**rougail.var3** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | +The third variable. + +**Default**: True +| +**rougail.var4** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | +The forth variable. + +**Default**: False +| +**rougail.var5** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | +The fifth variable. + +**Default**: False +| +**rougail.var6** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | +The sixth variable. + +**Default**: False +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +rougail: + var1: true + var2: true + var3: true + var4: false + var5: false + var6: false +---- diff --git a/tests/docs/base/00_6boolean.md b/tests/docs/base/00_6boolean.md new file mode 100644 index 0000000..7d448ff --- /dev/null +++ b/tests/docs/base/00_6boolean.md @@ -0,0 +1,50 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: true # the first variable +var2: + description: the second variable + default: true +var3: + description: the third variable + type: boolean + default: true +var4: false # the forth variable +var5: + description: the fifth variable + default: false +var6: + description: the sixth variable + type: boolean + default: false +``` +# Variables for "rougail" + +| Variable                                                                                                    | Description                                                                                                 | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **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 | + + +# Example with all variables modifiable + +```yaml +--- +rougail: + var1: true + var2: true + var3: true + var4: false + var5: false + var6: false +``` diff --git a/tests/docs/base/00_6boolean_no_mandatory.adoc b/tests/docs/base/00_6boolean_no_mandatory.adoc new file mode 100644 index 0000000..15bbf20 --- /dev/null +++ b/tests/docs/base/00_6boolean_no_mandatory.adoc @@ -0,0 +1,30 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +variable: + description: a variable + type: boolean + mandatory: false +---- +== Variables for "rougail" + +[cols="97a,97a",options="header"] +|==== +| Variable | Description +| +**rougail.variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` | +A variable. + +**Default**: True +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +rougail: + variable: true +---- diff --git a/tests/docs/base/00_6boolean_no_mandatory.md b/tests/docs/base/00_6boolean_no_mandatory.md new file mode 100644 index 0000000..8f058a4 --- /dev/null +++ b/tests/docs/base/00_6boolean_no_mandatory.md @@ -0,0 +1,28 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +variable: + description: a variable + type: boolean + mandatory: false +``` +# Variables for "rougail" + +| Variable                                                                                        | Description                                                                                     | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.variable**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A variable.
**Default**: True | + + +# Example with all variables modifiable + +```yaml +--- +rougail: + variable: true +``` diff --git a/tests/docs/base/00_6choice.adoc b/tests/docs/base/00_6choice.adoc new file mode 100644 index 0000000..b66be75 --- /dev/null +++ b/tests/docs/base/00_6choice.adoc @@ -0,0 +1,129 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +var1: + description: the first variable + choices: + - a + - b + - c +var2: + description: the second variable + choices: + - a + - b + - c +var3: + description: the third variable + choices: + - a + - b + - c + mandatory: false +var4: + description: the forth variable + choices: + - + - b + - c + mandatory: false +var5: + description: the fifth variable + choices: + - a + - b + - c + default: a +var6: + description: the sixth variable + choices: + - 1 + - 2 + - 3 + default: 1 +---- +== Variables for "rougail" + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**rougail.var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `basic` `mandatory` | +The first variable. + +**Choices**: + +* a +* b +* c +| +**rougail.var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `basic` `mandatory` | +The second variable. + +**Choices**: + +* a +* b +* c +| +**rougail.var3** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` | +The third variable. + +**Choices**: + +* a +* b +* c +* null +| +**rougail.var4** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` | +The forth variable. + +**Choices**: + +* null +* b +* c +| +**rougail.var5** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` `mandatory` | +The fifth variable. + +**Choices**: + +* a ← (default) +* b +* c +| +**rougail.var6** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` `mandatory` | +The sixth variable. + +**Choices**: + +* 1 ← (default) +* 2 +* 3 +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +rougail: + var1: a_choice + var2: a_choice +---- +== Example with all variables modifiable + +[,yaml] +---- +rougail: + var1: a_choice + var2: a_choice + var3: a_choice + var4: a_choice + var5: a + var6: 1 +---- diff --git a/tests/docs/base/00_6choice.md b/tests/docs/base/00_6choice.md new file mode 100644 index 0000000..8ec6f13 --- /dev/null +++ b/tests/docs/base/00_6choice.md @@ -0,0 +1,82 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: + description: the first variable + choices: + - a + - b + - c +var2: + description: the second variable + choices: + - a + - b + - c +var3: + description: the third variable + choices: + - a + - b + - c + mandatory: false +var4: + description: the forth variable + choices: + - + - b + - c + mandatory: false +var5: + description: the fifth variable + choices: + - a + - b + - c + default: a +var6: + description: the sixth variable + choices: + - 1 + - 2 + - 3 + default: 1 +``` +# Variables for "rougail" + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var1**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The first variable.
**Choices**:
- a
- b
- c | +| **rougail.var2**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The second variable.
**Choices**:
- a
- b
- c | +| **rougail.var3**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | The third variable.
**Choices**:
- a
- b
- c
- null | +| **rougail.var4**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | The forth variable.
**Choices**:
- null
- b
- c | +| **rougail.var5**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The fifth variable.
**Choices**:
- a ← (default)
- b
- c | +| **rougail.var6**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The sixth variable.
**Choices**:
- 1 ← (default)
- 2
- 3 | + + +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + var1: a_choice + var2: a_choice +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var1: a_choice + var2: a_choice + var3: a_choice + var4: a_choice + var5: a + var6: 1 +``` diff --git a/tests/docs/base/00_6choice_calculation.adoc b/tests/docs/base/00_6choice_calculation.adoc new file mode 100644 index 0000000..b493224 --- /dev/null +++ b/tests/docs/base/00_6choice_calculation.adoc @@ -0,0 +1,38 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: 1.1 +var: + description: a variable + default: 9 + choices: + type: jinja + jinja: | + {% for n in trange(0, 10) %} + {{ n }} + {% endfor %} + return_type: number + description: choices is 0 to 9 +---- +== Variables for "rougail" + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**rougail.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` `mandatory` | +A variable. + +**Choices**: choices is 0 to 9. + +**Default**: 9 +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +rougail: + var: 9 +---- diff --git a/tests/docs/base/00_6choice_calculation.md b/tests/docs/base/00_6choice_calculation.md new file mode 100644 index 0000000..e6d6bb6 --- /dev/null +++ b/tests/docs/base/00_6choice_calculation.md @@ -0,0 +1,35 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: 1.1 +var: + description: a variable + default: 9 + choices: + type: jinja + jinja: | + {% for n in trange(0, 10) %} + {{ n }} + {% endfor %} + return_type: number + description: choices is 0 to 9 +``` +# Variables for "rougail" + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Choices**: choices is 0 to 9.
**Default**: 9 | + + +# Example with all variables modifiable + +```yaml +--- +rougail: + var: 9 +``` diff --git a/tests/docs/base/00_6choice_variable.adoc b/tests/docs/base/00_6choice_variable.adoc new file mode 100644 index 0000000..821b124 --- /dev/null +++ b/tests/docs/base/00_6choice_variable.adoc @@ -0,0 +1,50 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +var1: # a second variable + - a + - b + - c +var2: + description: a first variable + default: a + choices: + type: variable + variable: _.var1 +---- +== Variables for "rougail" + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**rougail.var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +A second variable. + +**Default**: + +* a +* b +* c +| +**rougail.var2** + +`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 +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +rougail: + var1: + - a + - b + - c + var2: a +---- diff --git a/tests/docs/base/00_6choice_variable.md b/tests/docs/base/00_6choice_variable.md new file mode 100644 index 0000000..cab611e --- /dev/null +++ b/tests/docs/base/00_6choice_variable.md @@ -0,0 +1,39 @@ +--- +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: + type: variable + 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 | + + +# Example with all variables modifiable + +```yaml +--- +rougail: + var1: + - a + - b + - c + var2: a +``` diff --git a/tests/docs/base/00_6custom.adoc b/tests/docs/base/00_6custom.adoc new file mode 100644 index 0000000..f1ea71d --- /dev/null +++ b/tests/docs/base/00_6custom.adoc @@ -0,0 +1,45 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +custom1: + description: the first variable + type: custom +custom2: + description: the seconf variable + type: custom + default: value +---- +== Variables for "rougail" + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**rougail.custom1** + +`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` | +The seconf variable. + +**Default**: value +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +rougail: + custom1: xxx +---- +== Example with all variables modifiable + +[,yaml] +---- +rougail: + custom1: xxx + custom2: value +---- diff --git a/tests/docs/base/00_6custom.md b/tests/docs/base/00_6custom.md new file mode 100644 index 0000000..01155b9 --- /dev/null +++ b/tests/docs/base/00_6custom.md @@ -0,0 +1,40 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +custom1: + description: the first variable + type: custom +custom2: + description: the seconf variable + type: custom + default: value +``` +# Variables for "rougail" + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.custom1**
[`custom`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The first variable. | +| **rougail.custom2**
[`custom`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The seconf variable.
**Default**: value | + + +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + custom1: xxx +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + custom1: xxx + custom2: value +``` diff --git a/tests/docs/base/00_6domainname.adoc b/tests/docs/base/00_6domainname.adoc new file mode 100644 index 0000000..898c179 --- /dev/null +++ b/tests/docs/base/00_6domainname.adoc @@ -0,0 +1,30 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +variable: + description: a domain name variable + type: domainname + default: my.domain.name +---- +== Variables for "rougail" + +[cols="112a,112a",options="header"] +|==== +| Variable | Description +| +**rougail.variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[domainname]` `standard` `mandatory` | +A domain name variable. + +**Default**: my.domain.name +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +rougail: + variable: my.domain.name +---- diff --git a/tests/docs/base/00_6domainname.md b/tests/docs/base/00_6domainname.md new file mode 100644 index 0000000..677658f --- /dev/null +++ b/tests/docs/base/00_6domainname.md @@ -0,0 +1,28 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +variable: + description: a domain name variable + type: domainname + default: my.domain.name +``` +# Variables for "rougail" + +| Variable                                                                                                       | Description                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.variable**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A domain name variable.
**Default**: my.domain.name | + + +# Example with all variables modifiable + +```yaml +--- +rougail: + variable: my.domain.name +``` diff --git a/tests/docs/base/00_6domainname_params.adoc b/tests/docs/base/00_6domainname_params.adoc new file mode 100644 index 0000000..6c273f7 --- /dev/null +++ b/tests/docs/base/00_6domainname_params.adoc @@ -0,0 +1,33 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +variable: + description: a domain name variable + type: domainname + default: my.domain.name + params: + allow_ip: true +---- +== Variables for "rougail" + +[cols="112a,112a",options="header"] +|==== +| Variable | Description +| +**rougail.variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[domainname]` `standard` `mandatory` | +A domain name variable. + +**Validator**: the domain name can be an IP + +**Default**: my.domain.name +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +rougail: + variable: my.domain.name +---- diff --git a/tests/docs/base/00_6domainname_params.md b/tests/docs/base/00_6domainname_params.md new file mode 100644 index 0000000..4237c2c --- /dev/null +++ b/tests/docs/base/00_6domainname_params.md @@ -0,0 +1,30 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +variable: + description: a domain name variable + type: domainname + default: my.domain.name + params: + allow_ip: true +``` +# Variables for "rougail" + +| Variable                                                                                                       | Description                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.variable**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A domain name variable.
**Validator**: the domain name can be an IP
**Default**: my.domain.name | + + +# Example with all variables modifiable + +```yaml +--- +rougail: + variable: my.domain.name +``` diff --git a/tests/docs/base/00_6float.adoc b/tests/docs/base/00_6float.adoc new file mode 100644 index 0000000..27447ba --- /dev/null +++ b/tests/docs/base/00_6float.adoc @@ -0,0 +1,72 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +var1: 0.0 # the first variable +var2: + description: the second variable + default: 0.0 +var3: + description: the third variable + type: float + default: 0.0 +var4: 10.1 # the forth variable +var5: + description: the fifth variable + default: 10.1 +var6: + description: the sixth variable + type: float + default: 10.1 +---- +== Variables for "rougail" + +[cols="107a,107a",options="header"] +|==== +| Variable | Description +| +**rougail.var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` | +The first variable. + +**Default**: 0.0 +| +**rougail.var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` | +The second variable. + +**Default**: 0.0 +| +**rougail.var3** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` | +The third variable. + +**Default**: 0.0 +| +**rougail.var4** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` | +The forth variable. + +**Default**: 10.1 +| +**rougail.var5** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` | +The fifth variable. + +**Default**: 10.1 +| +**rougail.var6** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` | +The sixth variable. + +**Default**: 10.1 +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +rougail: + var1: 0.0 + var2: 0.0 + var3: 0.0 + var4: 10.1 + var5: 10.1 + var6: 10.1 +---- diff --git a/tests/docs/base/00_6float.md b/tests/docs/base/00_6float.md new file mode 100644 index 0000000..1873adb --- /dev/null +++ b/tests/docs/base/00_6float.md @@ -0,0 +1,50 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: 0.0 # the first variable +var2: + description: the second variable + default: 0.0 +var3: + description: the third variable + type: float + default: 0.0 +var4: 10.1 # the forth variable +var5: + description: the fifth variable + default: 10.1 +var6: + description: the sixth variable + type: float + default: 10.1 +``` +# Variables for "rougail" + +| Variable                                                                                                  | Description                                                                                               | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var1**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The first variable.
**Default**: 0.0 | +| **rougail.var2**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The second variable.
**Default**: 0.0 | +| **rougail.var3**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The third variable.
**Default**: 0.0 | +| **rougail.var4**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The forth variable.
**Default**: 10.1 | +| **rougail.var5**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The fifth variable.
**Default**: 10.1 | +| **rougail.var6**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The sixth variable.
**Default**: 10.1 | + + +# Example with all variables modifiable + +```yaml +--- +rougail: + var1: 0.0 + var2: 0.0 + var3: 0.0 + var4: 10.1 + var5: 10.1 + var6: 10.1 +``` diff --git a/tests/docs/base/00_6number.adoc b/tests/docs/base/00_6number.adoc new file mode 100644 index 0000000..a13ed3e --- /dev/null +++ b/tests/docs/base/00_6number.adoc @@ -0,0 +1,72 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +var1: 0 # the first variable +var2: + description: the second variable + default: 0 +var3: + description: the third variable + type: number + default: 0 +var4: 10 # this forth variable +var5: + description: the fifth variable + default: 10 +var6: + description: the sixth variable + type: number + default: 10 +---- +== Variables for "rougail" + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**rougail.var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` | +The first variable. + +**Default**: 0 +| +**rougail.var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` | +The second variable. + +**Default**: 0 +| +**rougail.var3** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` | +The third variable. + +**Default**: 0 +| +**rougail.var4** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` | +This forth variable. + +**Default**: 10 +| +**rougail.var5** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` | +The fifth variable. + +**Default**: 10 +| +**rougail.var6** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` | +The sixth variable. + +**Default**: 10 +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +rougail: + var1: 0 + var2: 0 + var3: 0 + var4: 10 + var5: 10 + var6: 10 +---- diff --git a/tests/docs/base/00_6number.md b/tests/docs/base/00_6number.md new file mode 100644 index 0000000..46ba71d --- /dev/null +++ b/tests/docs/base/00_6number.md @@ -0,0 +1,50 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: 0 # the first variable +var2: + description: the second variable + default: 0 +var3: + description: the third variable + type: number + default: 0 +var4: 10 # this forth variable +var5: + description: the fifth variable + default: 10 +var6: + description: the sixth variable + type: number + default: 10 +``` +# Variables for "rougail" + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var1**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The first variable.
**Default**: 0 | +| **rougail.var2**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The second variable.
**Default**: 0 | +| **rougail.var3**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The third variable.
**Default**: 0 | +| **rougail.var4**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | This forth variable.
**Default**: 10 | +| **rougail.var5**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The fifth variable.
**Default**: 10 | +| **rougail.var6**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The sixth variable.
**Default**: 10 | + + +# Example with all variables modifiable + +```yaml +--- +rougail: + var1: 0 + var2: 0 + var3: 0 + var4: 10 + var5: 10 + var6: 10 +``` diff --git a/tests/docs/base/00_6string.adoc b/tests/docs/base/00_6string.adoc new file mode 100644 index 0000000..fe4b52e --- /dev/null +++ b/tests/docs/base/00_6string.adoc @@ -0,0 +1,77 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +var1: # the first variable +var2: + description: the second variable + default: +var3: + description: the third variable + type: string +var4: value # the forth variable +var5: + description: the fifth variable + default: value +var6: + description: the sixth variable + type: string + default: value +---- +== Variables for "rougail" + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**rougail.var1** + +`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. +| +**rougail.var3** + +`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` | +The forth variable. + +**Default**: value +| +**rougail.var5** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +The fifth variable. + +**Default**: value +| +**rougail.var6** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +The sixth variable. + +**Default**: value +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +rougail: + var1: example + var2: example + var3: example +---- +== Example with all variables modifiable + +[,yaml] +---- +rougail: + var1: example + var2: example + var3: example + var4: value + var5: value + var6: value +---- diff --git a/tests/docs/base/00_6string.md b/tests/docs/base/00_6string.md new file mode 100644 index 0000000..1b5e4fc --- /dev/null +++ b/tests/docs/base/00_6string.md @@ -0,0 +1,58 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: # the first variable +var2: + description: the second variable + default: +var3: + description: the third variable + type: string +var4: value # the forth variable +var5: + description: the fifth variable + default: value +var6: + description: the sixth variable + type: string + default: value +``` +# Variables for "rougail" + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The first variable. | +| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The second variable. | +| **rougail.var3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The third variable. | +| **rougail.var4**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The forth variable.
**Default**: value | +| **rougail.var5**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The fifth variable.
**Default**: value | +| **rougail.var6**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The sixth variable.
**Default**: value | + + +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + var1: example + var2: example + var3: example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var1: example + var2: example + var3: example + var4: value + var5: value + var6: value +``` diff --git a/tests/docs/base/00_7choice_quote.adoc b/tests/docs/base/00_7choice_quote.adoc new file mode 100644 index 0000000..f007ffe --- /dev/null +++ b/tests/docs/base/00_7choice_quote.adoc @@ -0,0 +1,38 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.0' +var: + type: choice + description: A choice + default: quote' + choices: + - quote' + - quote" + - quote"' +---- +== Variables for "rougail" + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**rougail.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` `mandatory` | +A choice. + +**Choices**: + +* quote' ← (default) +* quote" +* quote"' +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +rougail: + var: quote' +---- diff --git a/tests/docs/base/00_7choice_quote.md b/tests/docs/base/00_7choice_quote.md new file mode 100644 index 0000000..7e4f5b0 --- /dev/null +++ b/tests/docs/base/00_7choice_quote.md @@ -0,0 +1,32 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.0' +var: + type: choice + description: A choice + default: quote' + choices: + - quote' + - quote" + - quote"' +``` +# Variables for "rougail" + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A choice.
**Choices**:
- quote' ← (default)
- quote"
- quote"' | + + +# Example with all variables modifiable + +```yaml +--- +rougail: + var: quote' +``` diff --git a/tests/docs/base/00_7help_quote.adoc b/tests/docs/base/00_7help_quote.adoc new file mode 100644 index 0000000..0f0f189 --- /dev/null +++ b/tests/docs/base/00_7help_quote.adoc @@ -0,0 +1,46 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.0' +var1: + description: the first variable + help: message with ' +var2: + description: the second variable + help: message with " +---- +== Variables for "rougail" + +[cols="105a,105a",options="header"] +|==== +| Variable | Description +| +**rougail.var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +The first variable. + +Message with '. +| +**rougail.var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +The second variable. + +Message with ". +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +rougail: + var1: example + var2: example +---- +== Example with all variables modifiable + +[,yaml] +---- +rougail: + var1: example + var2: example +---- diff --git a/tests/docs/base/00_7help_quote.md b/tests/docs/base/00_7help_quote.md new file mode 100644 index 0000000..2c8a93f --- /dev/null +++ b/tests/docs/base/00_7help_quote.md @@ -0,0 +1,40 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.0' +var1: + description: the first variable + help: message with ' +var2: + description: the second variable + help: message with " +``` +# Variables for "rougail" + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The first variable.
Message with '. | +| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The second variable.
Message with ". | + + +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + var1: example + var2: example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var1: example + var2: example +``` diff --git a/tests/docs/base/00_7value_doublequote.adoc b/tests/docs/base/00_7value_doublequote.adoc new file mode 100644 index 0000000..ac709d0 --- /dev/null +++ b/tests/docs/base/00_7value_doublequote.adoc @@ -0,0 +1,29 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +variable: + description: a variable + default: quote" +---- +== Variables for "rougail" + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**rougail.variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A variable. + +**Default**: quote" +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +rougail: + variable: quote" +---- diff --git a/tests/docs/base/00_7value_doublequote.md b/tests/docs/base/00_7value_doublequote.md new file mode 100644 index 0000000..ea20845 --- /dev/null +++ b/tests/docs/base/00_7value_doublequote.md @@ -0,0 +1,27 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +variable: + description: a variable + default: quote" +``` +# Variables for "rougail" + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: quote" | + + +# Example with all variables modifiable + +```yaml +--- +rougail: + variable: quote" +``` diff --git a/tests/docs/base/00_7value_doublequote2.adoc b/tests/docs/base/00_7value_doublequote2.adoc new file mode 100644 index 0000000..3962c76 --- /dev/null +++ b/tests/docs/base/00_7value_doublequote2.adoc @@ -0,0 +1,29 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +variable: + description: a variable + default: quote'" +---- +== Variables for "rougail" + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**rougail.variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A variable. + +**Default**: quote'" +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +rougail: + variable: quote'" +---- diff --git a/tests/docs/base/00_7value_doublequote2.md b/tests/docs/base/00_7value_doublequote2.md new file mode 100644 index 0000000..cb2650c --- /dev/null +++ b/tests/docs/base/00_7value_doublequote2.md @@ -0,0 +1,27 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +variable: + description: a variable + default: quote'" +``` +# Variables for "rougail" + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: quote'" | + + +# Example with all variables modifiable + +```yaml +--- +rougail: + variable: quote'" +``` diff --git a/tests/docs/base/00_7value_doublequote3.adoc b/tests/docs/base/00_7value_doublequote3.adoc new file mode 100644 index 0000000..dcee9ff --- /dev/null +++ b/tests/docs/base/00_7value_doublequote3.adoc @@ -0,0 +1,10 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.0' +variable: + description: a variable + hidden: true + default: quote\"\' +---- diff --git a/tests/docs/base/00_7value_doublequote3.md b/tests/docs/base/00_7value_doublequote3.md new file mode 100644 index 0000000..391ed13 --- /dev/null +++ b/tests/docs/base/00_7value_doublequote3.md @@ -0,0 +1,14 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.0' +variable: + description: a variable + hidden: true + default: quote\"\' +``` diff --git a/tests/docs/base/00_7value_quote.adoc b/tests/docs/base/00_7value_quote.adoc new file mode 100644 index 0000000..772f4f6 --- /dev/null +++ b/tests/docs/base/00_7value_quote.adoc @@ -0,0 +1,29 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.0' +variable: + description: a variable + default: quote' +---- +== Variables for "rougail" + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**rougail.variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A variable. + +**Default**: quote' +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +rougail: + variable: quote' +---- diff --git a/tests/docs/base/00_7value_quote.md b/tests/docs/base/00_7value_quote.md new file mode 100644 index 0000000..9113259 --- /dev/null +++ b/tests/docs/base/00_7value_quote.md @@ -0,0 +1,27 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.0' +variable: + description: a variable + default: quote' +``` +# Variables for "rougail" + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: quote' | + + +# Example with all variables modifiable + +```yaml +--- +rougail: + variable: quote' +``` diff --git a/tests/docs/base/00_8calculation_information.adoc b/tests/docs/base/00_8calculation_information.adoc new file mode 100644 index 0000000..5794bcf --- /dev/null +++ b/tests/docs/base/00_8calculation_information.adoc @@ -0,0 +1,44 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +variable: + description: a variable + default: + type: jinja + jinja: | + {{test_information }} + params: + test_information: + type: information + information: test_information + description: get information test_information +---- +== Variables for "rougail" + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**rougail.variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A variable. + +**Default**: get information test_information. +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +rougail: + variable: example +---- +== Example with all variables modifiable + +[,yaml] +---- +rougail: + variable: example +---- diff --git a/tests/docs/base/00_8calculation_information.md b/tests/docs/base/00_8calculation_information.md new file mode 100644 index 0000000..a7d8623 --- /dev/null +++ b/tests/docs/base/00_8calculation_information.md @@ -0,0 +1,42 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +variable: + description: a variable + default: + type: jinja + jinja: | + {{test_information }} + params: + test_information: + type: information + information: test_information + description: get information test_information +``` +# Variables for "rougail" + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: get information test_information. | + + +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + variable: example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + variable: example +``` diff --git a/tests/docs/base/00_8test.adoc b/tests/docs/base/00_8test.adoc new file mode 100644 index 0000000..1c8a433 --- /dev/null +++ b/tests/docs/base/00_8test.adoc @@ -0,0 +1,85 @@ +== 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 +var5: + description: the fifth variable + test: + - false +---- +== Variables for "rougail" + +[cols="105a,105a",options="header"] +|==== +| Variable | Description +| +**rougail.var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +The first variable. + +**Example**: test +| +**rougail.var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +The second variable. + +**Default**: value + +**Example**: test +| +**rougail.var3** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +The third variable. + +**Example**: test1 +| +**rougail.var4** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +The forth variable. + +**Example**: None +| +**rougail.var5** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +The fifth variable. + +**Example**: False +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +rougail: + var1: test + var2: test + var3: test1 + var5: false +---- +== Example with all variables modifiable + +[,yaml] +---- +rougail: + var1: test + var2: test + var3: test1 + var4: + var5: false +---- diff --git a/tests/docs/base/00_8test.md b/tests/docs/base/00_8test.md new file mode 100644 index 0000000..7782e75 --- /dev/null +++ b/tests/docs/base/00_8test.md @@ -0,0 +1,66 @@ +--- +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 +var5: + description: the fifth variable + test: + - false +``` +# 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) `basic` `mandatory` | The forth variable.
**Example**: None | +| **rougail.var5**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The fifth variable.
**Example**: False | + + +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + var1: test + var2: test + var3: test1 + var5: false +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var1: test + var2: test + var3: test1 + var4: + var5: false +``` diff --git a/tests/docs/base/00_9choice_variable_multi.adoc b/tests/docs/base/00_9choice_variable_multi.adoc new file mode 100644 index 0000000..cc27fc1 --- /dev/null +++ b/tests/docs/base/00_9choice_variable_multi.adoc @@ -0,0 +1,63 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +variable1: + description: a first variable + type: choice + multi: true + choices: + - val1 + - val2 +variable2: + description: a second variable + type: choice + multi: true + mandatory: false + choices: + - val1 + - val2 +---- +== Variables for "rougail" + +[cols="116a,116a",options="header"] +|==== +| Variable | Description +| +**rougail.variable1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `basic` `mandatory` `unique` `multiple` | +A first variable. + +**Choices**: + +* val1 +* val2 +| +**rougail.variable2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` `unique` `multiple` | +A second variable. + +**Choices**: + +* val1 +* val2 +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +rougail: + variable1: + - a_choice +---- +== Example with all variables modifiable + +[,yaml] +---- +rougail: + variable1: + - a_choice + variable2: + - a_choice +---- diff --git a/tests/docs/base/00_9choice_variable_multi.md b/tests/docs/base/00_9choice_variable_multi.md new file mode 100644 index 0000000..8a049fb --- /dev/null +++ b/tests/docs/base/00_9choice_variable_multi.md @@ -0,0 +1,51 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +variable1: + description: a first variable + type: choice + multi: true + choices: + - val1 + - val2 +variable2: + description: a second variable + type: choice + multi: true + mandatory: false + choices: + - val1 + - val2 +``` +# Variables for "rougail" + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.variable1**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | A first variable.
**Choices**:
- val1
- val2 | +| **rougail.variable2**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A second variable.
**Choices**:
- val1
- val2 | + + +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + variable1: + - a_choice +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + variable1: + - a_choice + variable2: + - a_choice +``` diff --git a/tests/docs/base/00_9choice_variables.adoc b/tests/docs/base/00_9choice_variables.adoc new file mode 100644 index 0000000..a37a3ba --- /dev/null +++ b/tests/docs/base/00_9choice_variables.adoc @@ -0,0 +1,54 @@ +== 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: + - type: variable + variable: rougail.source_variable_1 + - type: variable + variable: rougail.source_variable_2 + default: val1 +---- +== Variables for "rougail" + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**rougail.source_variable_1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +The first source variable. + +**Default**: val1 +| +**rougail.source_variable_2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +The second source variable. + +**Default**: val2 +| +**rougail.my_variable** + +`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 +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +rougail: + source_variable_1: val1 + source_variable_2: val2 + my_variable: val1 +---- diff --git a/tests/docs/base/00_9choice_variables.md b/tests/docs/base/00_9choice_variables.md new file mode 100644 index 0000000..7880074 --- /dev/null +++ b/tests/docs/base/00_9choice_variables.md @@ -0,0 +1,39 @@ +--- +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: + - type: variable + variable: rougail.source_variable_1 + - type: variable + 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 | + + +# Example with all variables modifiable + +```yaml +--- +rougail: + source_variable_1: val1 + source_variable_2: val2 + my_variable: val1 +``` diff --git a/tests/docs/base/00_9default_calculation.adoc b/tests/docs/base/00_9default_calculation.adoc new file mode 100644 index 0000000..141e89e --- /dev/null +++ b/tests/docs/base/00_9default_calculation.adoc @@ -0,0 +1,38 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +variable: + description: a variable + default: + type: jinja + jinja: | + {{ param1 }}_{{ param2 }}_{{ param3 }}_{{ param4 }} + params: + param1: string + param2: 1 + param3: true + param4: + description: concat all parameters +---- +== Variables for "rougail" + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**rougail.variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A variable. + +**Default**: concat all parameters. +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +rougail: + variable: string_1_True_None +---- diff --git a/tests/docs/base/00_9default_calculation.md b/tests/docs/base/00_9default_calculation.md new file mode 100644 index 0000000..db63626 --- /dev/null +++ b/tests/docs/base/00_9default_calculation.md @@ -0,0 +1,36 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +variable: + description: a variable + default: + type: jinja + jinja: | + {{ param1 }}_{{ param2 }}_{{ param3 }}_{{ param4 }} + params: + param1: string + param2: 1 + param3: true + param4: + description: concat all parameters +``` +# Variables for "rougail" + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: concat all parameters. | + + +# Example with all variables modifiable + +```yaml +--- +rougail: + variable: string_1_True_None +``` diff --git a/tests/docs/base/00_9default_calculation_information.adoc b/tests/docs/base/00_9default_calculation_information.adoc new file mode 100644 index 0000000..3a58670 --- /dev/null +++ b/tests/docs/base/00_9default_calculation_information.adoc @@ -0,0 +1,44 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +var: + description: a variable + default: + type: jinja + jinja: '{{ information }}' + params: + information: + type: information + information: test_information + variable: _.var + description: returns the information +---- +== Variables for "rougail" + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**rougail.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A variable. + +**Default**: returns the information. +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +rougail: + var: example +---- +== Example with all variables modifiable + +[,yaml] +---- +rougail: + var: example +---- diff --git a/tests/docs/base/00_9default_calculation_information.md b/tests/docs/base/00_9default_calculation_information.md new file mode 100644 index 0000000..275342f --- /dev/null +++ b/tests/docs/base/00_9default_calculation_information.md @@ -0,0 +1,42 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: + description: a variable + default: + type: jinja + jinja: '{{ information }}' + params: + information: + type: information + information: test_information + variable: _.var + description: returns the information +``` +# Variables for "rougail" + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: returns the information. | + + +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + var: example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var: example +``` diff --git a/tests/docs/base/00_9default_calculation_information_other_variable.adoc b/tests/docs/base/00_9default_calculation_information_other_variable.adoc new file mode 100644 index 0000000..82be87a --- /dev/null +++ b/tests/docs/base/00_9default_calculation_information_other_variable.adoc @@ -0,0 +1,51 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +var1: # a first variable +var2: + description: a second variable + default: + type: jinja + jinja: | + {{ information }} + params: + information: + type: information + information: test_information + variable: _.var1 +---- +== Variables for "rougail" + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**rougail.var1** + +`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` | +A second variable. + +**Default**: issu d'un calcul. +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +rougail: + var1: example + var2: example +---- +== Example with all variables modifiable + +[,yaml] +---- +rougail: + var1: example + var2: example +---- diff --git a/tests/docs/base/00_9default_calculation_information_other_variable.md b/tests/docs/base/00_9default_calculation_information_other_variable.md new file mode 100644 index 0000000..9667d51 --- /dev/null +++ b/tests/docs/base/00_9default_calculation_information_other_variable.md @@ -0,0 +1,46 @@ +--- +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: jinja + jinja: | + {{ information }} + params: + information: + type: information + information: test_information + variable: _.var1 +``` +# 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**: issu d'un calcul. | + + +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + var1: example + var2: example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var1: example + var2: example +``` diff --git a/tests/docs/base/00_9default_calculation_param_optional.adoc b/tests/docs/base/00_9default_calculation_param_optional.adoc new file mode 100644 index 0000000..5169601 --- /dev/null +++ b/tests/docs/base/00_9default_calculation_param_optional.adoc @@ -0,0 +1,54 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +var1: + description: a first variable + default: + type: jinja + jinja: '{% if var2 is defined %} {{ var2 }} {% elif var3 is defined %} {{ var3 + }} {% elif var4 is defined %} {{ var4 }} {% else %} {{ _.var2 }} {% endif %} ' + params: + var2: + type: variable + variable: _.var2 + optional: true + var3: + type: variable + variable: _.var3 + optional: true + var4: + type: variable + variable: _.unknown_family.var + optional: true + description: returns a value + mandatory: false +var2: no # a second variable +---- +== Variables for "rougail" + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**rougail.var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | +A first variable. + +**Default**: returns a value. +| +**rougail.var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A second variable. + +**Default**: no +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +rougail: + var1: no + var2: no +---- diff --git a/tests/docs/base/00_9default_calculation_param_optional.md b/tests/docs/base/00_9default_calculation_param_optional.md new file mode 100644 index 0000000..9dc2c6e --- /dev/null +++ b/tests/docs/base/00_9default_calculation_param_optional.md @@ -0,0 +1,48 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: + description: a first variable + default: + type: jinja + jinja: '{% if var2 is defined %} {{ var2 }} {% elif var3 is defined %} {{ var3 + }} {% elif var4 is defined %} {{ var4 }} {% else %} {{ _.var2 }} {% endif %} ' + params: + var2: + type: variable + variable: _.var2 + optional: true + var3: + type: variable + variable: _.var3 + optional: true + var4: + type: variable + variable: _.unknown_family.var + optional: true + description: returns a value + mandatory: false +var2: no # a second variable +``` +# Variables for "rougail" + +| 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 | + + +# Example with all variables modifiable + +```yaml +--- +rougail: + var1: no + var2: no +``` diff --git a/tests/docs/base/00_9default_information_other_variable.adoc b/tests/docs/base/00_9default_information_other_variable.adoc new file mode 100644 index 0000000..7608b55 --- /dev/null +++ b/tests/docs/base/00_9default_information_other_variable.adoc @@ -0,0 +1,46 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +var1: # a first variable +var2: + description: a second variable + default: + type: information + information: test_information + variable: _.var1 +---- +== Variables for "rougail" + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**rougail.var1** + +`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` | +A second variable. + +**Default**: value of the information. +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +rougail: + var1: example + var2: example +---- +== Example with all variables modifiable + +[,yaml] +---- +rougail: + var1: example + var2: example +---- diff --git a/tests/docs/base/00_9default_information_other_variable.md b/tests/docs/base/00_9default_information_other_variable.md new file mode 100644 index 0000000..8e98b02 --- /dev/null +++ b/tests/docs/base/00_9default_information_other_variable.md @@ -0,0 +1,41 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: # a first variable +var2: + description: a second variable + default: + type: information + information: test_information + variable: _.var1 +``` +# Variables for "rougail" + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A first variable. | +| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second variable.
**Default**: value of the information. | + + +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + var1: example + var2: example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var1: example + var2: example +``` diff --git a/tests/docs/base/00_9default_integer.adoc b/tests/docs/base/00_9default_integer.adoc new file mode 100644 index 0000000..5f47ba0 --- /dev/null +++ b/tests/docs/base/00_9default_integer.adoc @@ -0,0 +1,39 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +var: + description: a variable + type: choice + default: 9 + choices: + type: jinja + jinja: | + {% for item in trange(0, 10) %} + {{ item }} + {%- endfor %} + return_type: number + description: choice for 0 to 9 +---- +== Variables for "rougail" + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**rougail.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` `mandatory` | +A variable. + +**Choices**: choice for 0 to 9. + +**Default**: 9 +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +rougail: + var: 9 +---- diff --git a/tests/docs/base/00_9default_integer.md b/tests/docs/base/00_9default_integer.md new file mode 100644 index 0000000..d432416 --- /dev/null +++ b/tests/docs/base/00_9default_integer.md @@ -0,0 +1,36 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: + description: a variable + type: choice + default: 9 + choices: + type: jinja + jinja: | + {% for item in trange(0, 10) %} + {{ item }} + {%- endfor %} + return_type: number + description: choice for 0 to 9 +``` +# Variables for "rougail" + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Choices**: choice for 0 to 9.
**Default**: 9 | + + +# Example with all variables modifiable + +```yaml +--- +rougail: + var: 9 +``` diff --git a/tests/docs/base/00_9extra.adoc b/tests/docs/base/00_9extra.adoc new file mode 100644 index 0000000..e9d78a4 --- /dev/null +++ b/tests/docs/base/00_9extra.adoc @@ -0,0 +1,54 @@ +== 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: + type: jinja + jinja: no + description: return no +---- +== Variables for "rougail" + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**rougail.variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A variable. + +**Default**: rougail +|==== + + +== Variables for "extra" + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**extra.variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A variable. + +**Default**: return no. +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +rougail: + variable: rougail +extra: + variable: no +---- diff --git a/tests/docs/base/00_9extra.md b/tests/docs/base/00_9extra.md new file mode 100644 index 0000000..6e95961 --- /dev/null +++ b/tests/docs/base/00_9extra.md @@ -0,0 +1,46 @@ +--- +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: + type: jinja + jinja: no + description: return no +``` +# 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. | + + +# Example with all variables modifiable + +```yaml +--- +rougail: + variable: rougail +extra: + variable: no +``` diff --git a/tests/docs/base/00_9extra_calculation.adoc b/tests/docs/base/00_9extra_calculation.adoc new file mode 100644 index 0000000..ba1a965 --- /dev/null +++ b/tests/docs/base/00_9extra_calculation.adoc @@ -0,0 +1,83 @@ +== 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: + type: variable + variable: rougail.variable +variable2: + description: a second variable + default: + type: jinja + jinja: | + {{ rougail.variable }} + description: copy the value of rougail.variable +variable3: + description: a third variable + default: + type: jinja + jinja: | + {{ variable }} + params: + variable: + type: variable + variable: rougail.variable + description: copy the value of rougail.variable +---- +== Variables for "rougail" + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**rougail.variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A variable. + +**Default**: value +|==== + + +== Variables for "extra" + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**extra.variable1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A first variable. + +**Default**: the value of the variable "rougail.variable". +| +**extra.variable2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A second variable. + +**Default**: copy the value of rougail.variable. +| +**extra.variable3** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A third variable. + +**Default**: copy the value of rougail.variable. +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +rougail: + variable: value +extra: + variable1: value + variable2: value + variable3: value +---- diff --git a/tests/docs/base/00_9extra_calculation.md b/tests/docs/base/00_9extra_calculation.md new file mode 100644 index 0000000..6b70529 --- /dev/null +++ b/tests/docs/base/00_9extra_calculation.md @@ -0,0 +1,67 @@ +--- +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: + type: variable + variable: rougail.variable +variable2: + description: a second variable + default: + type: jinja + jinja: | + {{ rougail.variable }} + description: copy the value of rougail.variable +variable3: + description: a third variable + default: + type: jinja + jinja: | + {{ variable }} + params: + variable: + type: variable + variable: rougail.variable + description: copy the value of rougail.variable +``` +# Variables for "rougail" + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: value | + + +# Variables for "extra" + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **extra.variable1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A first variable.
**Default**: the value of the variable "rougail.variable". | +| **extra.variable2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second variable.
**Default**: copy the value of rougail.variable. | +| **extra.variable3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A third variable.
**Default**: copy the value of rougail.variable. | + + +# Example with all variables modifiable + +```yaml +--- +rougail: + variable: value +extra: + variable1: value + variable2: value + variable3: value +``` diff --git a/tests/docs/base/01_6boolean_multi.adoc b/tests/docs/base/01_6boolean_multi.adoc new file mode 100644 index 0000000..7e5b04a --- /dev/null +++ b/tests/docs/base/01_6boolean_multi.adoc @@ -0,0 +1,126 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +var1: # the first variable + - true +var2: + description: the second variable + default: + - true +var3: + description: the third variable + type: boolean + default: + - true +var4: # the forth variable + - false +var5: + description: the fifth variable + default: + - false +var6: + description: the sixth variable + type: boolean + default: + - false + +var7: + description: the seventh variable + multi: true + default: + - true +var8: + description: the eighth variable + type: boolean + multi: true + default: + - true +---- +== Variables for "rougail" + +[cols="129a,129a",options="header"] +|==== +| Variable | Description +| +**rougail.var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` `unique` `multiple` | +The first variable. + +**Default**: + +* true +| +**rougail.var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` `unique` `multiple` | +The second variable. + +**Default**: + +* true +| +**rougail.var3** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` `unique` `multiple` | +The third variable. + +**Default**: + +* true +| +**rougail.var4** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` `unique` `multiple` | +The forth variable. + +**Default**: + +* false +| +**rougail.var5** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` `unique` `multiple` | +The fifth variable. + +**Default**: + +* false +| +**rougail.var6** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` `unique` `multiple` | +The sixth variable. + +**Default**: + +* false +| +**rougail.var7** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` `unique` `multiple` | +The seventh 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 +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +rougail: + var1: + - true + var2: + - true + var3: + - true + var4: + - false + var5: + - false + var6: + - false + var7: + - true + var8: + - true +---- diff --git a/tests/docs/base/01_6boolean_multi.md b/tests/docs/base/01_6boolean_multi.md new file mode 100644 index 0000000..d0e3ed6 --- /dev/null +++ b/tests/docs/base/01_6boolean_multi.md @@ -0,0 +1,80 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: # the first variable + - true +var2: + description: the second variable + default: + - true +var3: + description: the third variable + type: boolean + default: + - true +var4: # the forth variable + - false +var5: + description: the fifth variable + default: + - false +var6: + description: the sixth variable + type: boolean + default: + - false + +var7: + description: the seventh variable + multi: true + default: + - true +var8: + description: the eighth variable + type: boolean + multi: true + default: + - true +``` +# Variables for "rougail" + +| Variable                                                                                                                        | Description                                                                                                                     | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **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 | + + +# Example with all variables modifiable + +```yaml +--- +rougail: + var1: + - true + var2: + - true + var3: + - true + var4: + - false + var5: + - false + var6: + - false + var7: + - true + var8: + - true +``` diff --git a/tests/docs/base/01_6custom_multi.adoc b/tests/docs/base/01_6custom_multi.adoc new file mode 100644 index 0000000..f51cc8d --- /dev/null +++ b/tests/docs/base/01_6custom_multi.adoc @@ -0,0 +1,52 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +custom1: + description: a first custom variable + type: custom + multi: true +custom2: + description: a second custom variable + type: custom + default: + - value +---- +== Variables for "rougail" + +[cols="128a,128a",options="header"] +|==== +| 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 +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +rougail: + custom1: + - xxx +---- +== Example with all variables modifiable + +[,yaml] +---- +rougail: + custom1: + - xxx + custom2: + - value +---- diff --git a/tests/docs/base/01_6custom_multi.md b/tests/docs/base/01_6custom_multi.md new file mode 100644 index 0000000..be4fdef --- /dev/null +++ b/tests/docs/base/01_6custom_multi.md @@ -0,0 +1,45 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +custom1: + description: a first custom variable + type: custom + multi: true +custom2: + description: a second custom variable + type: custom + default: + - value +``` +# Variables for "rougail" + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.custom1**
[`custom`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | A first custom variable. | +| **rougail.custom2**
[`custom`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A second custom variable.
**Default**:
- value | + + +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + custom1: + - xxx +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + custom1: + - xxx + custom2: + - value +``` diff --git a/tests/docs/base/01_6float_multi.adoc b/tests/docs/base/01_6float_multi.adoc new file mode 100644 index 0000000..063a825 --- /dev/null +++ b/tests/docs/base/01_6float_multi.adoc @@ -0,0 +1,126 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +var1: # the first variable + - 0.0 +var2: + description: the second variable + default: + - 0.0 +var3: + description: the third variable + type: float + default: + - 0.0 +var4: # the forth variable + - 10.1 +var5: + description: the fifth variable + default: + - 10.1 +var6: + description: the sixth variable + type: float + default: + - 10.1 + +var7: + description: the seventh variable + multi: true + default: + - 0.0 +var8: + description: the eighth variable + type: float + multi: true + default: + - 0.0 +---- +== Variables for "rougail" + +[cols="127a,127a",options="header"] +|==== +| Variable | Description +| +**rougail.var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` `unique` `multiple` | +The first variable. + +**Default**: + +* 0.0 +| +**rougail.var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` `unique` `multiple` | +The second variable. + +**Default**: + +* 0.0 +| +**rougail.var3** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` `unique` `multiple` | +The third variable. + +**Default**: + +* 0.0 +| +**rougail.var4** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` `unique` `multiple` | +The forth variable. + +**Default**: + +* 10.1 +| +**rougail.var5** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` `unique` `multiple` | +The fifth variable. + +**Default**: + +* 10.1 +| +**rougail.var6** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` `unique` `multiple` | +The sixth variable. + +**Default**: + +* 10.1 +| +**rougail.var7** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` `unique` `multiple` | +The seventh 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 +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +rougail: + var1: + - 0.0 + var2: + - 0.0 + var3: + - 0.0 + var4: + - 10.1 + var5: + - 10.1 + var6: + - 10.1 + var7: + - 0.0 + var8: + - 0.0 +---- diff --git a/tests/docs/base/01_6float_multi.md b/tests/docs/base/01_6float_multi.md new file mode 100644 index 0000000..ab1d99b --- /dev/null +++ b/tests/docs/base/01_6float_multi.md @@ -0,0 +1,80 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: # the first variable + - 0.0 +var2: + description: the second variable + default: + - 0.0 +var3: + description: the third variable + type: float + default: + - 0.0 +var4: # the forth variable + - 10.1 +var5: + description: the fifth variable + default: + - 10.1 +var6: + description: the sixth variable + type: float + default: + - 10.1 + +var7: + description: the seventh variable + multi: true + default: + - 0.0 +var8: + description: the eighth variable + type: float + multi: true + default: + - 0.0 +``` +# Variables for "rougail" + +| Variable                                                                                                                      | Description                                                                                                                   | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **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 | + + +# Example with all variables modifiable + +```yaml +--- +rougail: + var1: + - 0.0 + var2: + - 0.0 + var3: + - 0.0 + var4: + - 10.1 + var5: + - 10.1 + var6: + - 10.1 + var7: + - 0.0 + var8: + - 0.0 +``` diff --git a/tests/docs/base/01_6number_multi.adoc b/tests/docs/base/01_6number_multi.adoc new file mode 100644 index 0000000..f67c5e2 --- /dev/null +++ b/tests/docs/base/01_6number_multi.adoc @@ -0,0 +1,126 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +var1: # the first variable + - 0 +var2: + description: the second variable + default: + - 0 +var3: + description: the third variable + type: number + default: + - 0 +var4: # the forth variable + - 10 +var5: + description: the fifth variable + default: + - 10 +var6: + description: the sixth variable + type: number + default: + - 10 + +var7: + description: the seventh variable + multi: true + default: + - 0 +var8: + description: the eighth variable + type: number + multi: true + default: + - 0 +---- +== Variables for "rougail" + +[cols="128a,128a",options="header"] +|==== +| Variable | Description +| +**rougail.var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` `unique` `multiple` | +The first variable. + +**Default**: + +* 0 +| +**rougail.var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` `unique` `multiple` | +The second variable. + +**Default**: + +* 0 +| +**rougail.var3** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` `unique` `multiple` | +The third variable. + +**Default**: + +* 0 +| +**rougail.var4** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` `unique` `multiple` | +The forth variable. + +**Default**: + +* 10 +| +**rougail.var5** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` `unique` `multiple` | +The fifth variable. + +**Default**: + +* 10 +| +**rougail.var6** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` `unique` `multiple` | +The sixth variable. + +**Default**: + +* 10 +| +**rougail.var7** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` `unique` `multiple` | +The seventh 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 +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +rougail: + var1: + - 0 + var2: + - 0 + var3: + - 0 + var4: + - 10 + var5: + - 10 + var6: + - 10 + var7: + - 0 + var8: + - 0 +---- diff --git a/tests/docs/base/01_6number_multi.md b/tests/docs/base/01_6number_multi.md new file mode 100644 index 0000000..2038dce --- /dev/null +++ b/tests/docs/base/01_6number_multi.md @@ -0,0 +1,80 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: # the first variable + - 0 +var2: + description: the second variable + default: + - 0 +var3: + description: the third variable + type: number + default: + - 0 +var4: # the forth variable + - 10 +var5: + description: the fifth variable + default: + - 10 +var6: + description: the sixth variable + type: number + default: + - 10 + +var7: + description: the seventh variable + multi: true + default: + - 0 +var8: + description: the eighth variable + type: number + multi: true + default: + - 0 +``` +# Variables for "rougail" + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **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 | + + +# Example with all variables modifiable + +```yaml +--- +rougail: + var1: + - 0 + var2: + - 0 + var3: + - 0 + var4: + - 10 + var5: + - 10 + var6: + - 10 + var7: + - 0 + var8: + - 0 +``` diff --git a/tests/docs/base/01_6string_multi.adoc b/tests/docs/base/01_6string_multi.adoc new file mode 100644 index 0000000..dbd0a5d --- /dev/null +++ b/tests/docs/base/01_6string_multi.adoc @@ -0,0 +1,123 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +var1: [] # the first variable +var2: + description: the second variable + default: [] +var3: + description: the third variable + type: string +var4: # the forth variable + - value +var5: + description: the fifth variable + default: + - value +var6: + description: the sixth variable + type: string + default: + - value + +var7: + description: the seventh variable + multi: true + default: + - value +var8: + description: the eighth variable + type: string + multi: true + default: + - value +---- +== Variables for "rougail" + +[cols="128a,128a",options="header"] +|==== +| Variable | Description +| +**rougail.var1** + +`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. +| +**rougail.var3** + +`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` | +The forth variable. + +**Default**: + +* value +| +**rougail.var5** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +The fifth variable. + +**Default**: + +* value +| +**rougail.var6** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +The sixth variable. + +**Default**: + +* value +| +**rougail.var7** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +The seventh 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 +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +rougail: + var1: + - example + var2: + - example + var3: example +---- +== Example with all variables modifiable + +[,yaml] +---- +rougail: + var1: + - example + var2: + - example + var3: example + var4: + - value + var5: + - value + var6: + - value + var7: + - value + var8: + - value +---- diff --git a/tests/docs/base/01_6string_multi.md b/tests/docs/base/01_6string_multi.md new file mode 100644 index 0000000..955c9f3 --- /dev/null +++ b/tests/docs/base/01_6string_multi.md @@ -0,0 +1,86 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: [] # the first variable +var2: + description: the second variable + default: [] +var3: + description: the third variable + type: string +var4: # the forth variable + - value +var5: + description: the fifth variable + default: + - value +var6: + description: the sixth variable + type: string + default: + - value + +var7: + description: the seventh variable + multi: true + default: + - value +var8: + description: the eighth variable + type: string + multi: true + default: + - value +``` +# Variables for "rougail" + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **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 | + + +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + var1: + - example + var2: + - example + var3: example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var1: + - example + var2: + - example + var3: example + var4: + - value + var5: + - value + var6: + - value + var7: + - value + var8: + - value +``` diff --git a/tests/docs/base/01_7value_multi_doublequote.adoc b/tests/docs/base/01_7value_multi_doublequote.adoc new file mode 100644 index 0000000..c62da50 --- /dev/null +++ b/tests/docs/base/01_7value_multi_doublequote.adoc @@ -0,0 +1,33 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +variable: + description: a variable + default: + - quote" +---- +== Variables for "rougail" + +[cols="128a,128a",options="header"] +|==== +| Variable | Description +| +**rougail.variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +A variable. + +**Default**: + +* quote" +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +rougail: + variable: + - quote" +---- diff --git a/tests/docs/base/01_7value_multi_doublequote.md b/tests/docs/base/01_7value_multi_doublequote.md new file mode 100644 index 0000000..258c1d1 --- /dev/null +++ b/tests/docs/base/01_7value_multi_doublequote.md @@ -0,0 +1,29 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +variable: + description: a variable + default: + - quote" +``` +# Variables for "rougail" + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A variable.
**Default**:
- quote" | + + +# Example with all variables modifiable + +```yaml +--- +rougail: + variable: + - quote" +``` diff --git a/tests/docs/base/01_7value_multi_doublequote2.adoc b/tests/docs/base/01_7value_multi_doublequote2.adoc new file mode 100644 index 0000000..3f66202 --- /dev/null +++ b/tests/docs/base/01_7value_multi_doublequote2.adoc @@ -0,0 +1,33 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +variable: + description: a variable + default: + - quote'" +---- +== Variables for "rougail" + +[cols="128a,128a",options="header"] +|==== +| Variable | Description +| +**rougail.variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +A variable. + +**Default**: + +* quote'" +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +rougail: + variable: + - quote'" +---- diff --git a/tests/docs/base/01_7value_multi_doublequote2.md b/tests/docs/base/01_7value_multi_doublequote2.md new file mode 100644 index 0000000..7e5a49d --- /dev/null +++ b/tests/docs/base/01_7value_multi_doublequote2.md @@ -0,0 +1,29 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +variable: + description: a variable + default: + - quote'" +``` +# Variables for "rougail" + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A variable.
**Default**:
- quote'" | + + +# Example with all variables modifiable + +```yaml +--- +rougail: + variable: + - quote'" +``` diff --git a/tests/docs/base/01_7value_multi_quote.adoc b/tests/docs/base/01_7value_multi_quote.adoc new file mode 100644 index 0000000..fa84adb --- /dev/null +++ b/tests/docs/base/01_7value_multi_quote.adoc @@ -0,0 +1,33 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +variable: + description: a variable + default: + - quote' +---- +== Variables for "rougail" + +[cols="128a,128a",options="header"] +|==== +| Variable | Description +| +**rougail.variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +A variable. + +**Default**: + +* quote' +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +rougail: + variable: + - quote' +---- diff --git a/tests/docs/base/01_7value_multi_quote.md b/tests/docs/base/01_7value_multi_quote.md new file mode 100644 index 0000000..48bf417 --- /dev/null +++ b/tests/docs/base/01_7value_multi_quote.md @@ -0,0 +1,29 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +variable: + description: a variable + default: + - quote' +``` +# Variables for "rougail" + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A variable.
**Default**:
- quote' | + + +# Example with all variables modifiable + +```yaml +--- +rougail: + variable: + - quote' +``` diff --git a/tests/docs/base/01_8calculation_information_multi.adoc b/tests/docs/base/01_8calculation_information_multi.adoc new file mode 100644 index 0000000..0965b20 --- /dev/null +++ b/tests/docs/base/01_8calculation_information_multi.adoc @@ -0,0 +1,39 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +variable: + description: a variable + multi: true + default: + type: jinja + jinja: | + {{test_information }} + params: + test_information: + type: information + information: test_information + description: get information test_information +---- +== Variables for "rougail" + +[cols="128a,128a",options="header"] +|==== +| Variable | Description +| +**rougail.variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +A variable. + +**Default**: get information test_information. +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +rougail: + variable: + - '[]' +---- diff --git a/tests/docs/base/01_8calculation_information_multi.md b/tests/docs/base/01_8calculation_information_multi.md new file mode 100644 index 0000000..6126d63 --- /dev/null +++ b/tests/docs/base/01_8calculation_information_multi.md @@ -0,0 +1,37 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +variable: + description: a variable + multi: true + default: + type: jinja + jinja: | + {{test_information }} + params: + test_information: + type: information + information: test_information + description: get information test_information +``` +# Variables for "rougail" + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A variable.
**Default**: get information test_information. | + + +# Example with all variables modifiable + +```yaml +--- +rougail: + variable: + - '[]' +``` diff --git a/tests/docs/base/01_9choice_variable_multi.adoc b/tests/docs/base/01_9choice_variable_multi.adoc new file mode 100644 index 0000000..ff21ebe --- /dev/null +++ b/tests/docs/base/01_9choice_variable_multi.adoc @@ -0,0 +1,55 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +variable1: # a first variable + - a + - b + - c +variable2: + description: a second variable + choices: + type: variable + variable: _.variable1 +---- +== Variables for "rougail" + +[cols="105a,105a",options="header"] +|==== +| Variable | Description +| +**rougail.variable1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +A first variable. + +**Default**: + +* a +* b +* c +| +**rougail.variable2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `basic` `mandatory` | +A second variable. + +**Choices**: the value of the variable "rougail.variable1". +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +rougail: + variable2: a_choice +---- +== Example with all variables modifiable + +[,yaml] +---- +rougail: + variable1: + - a + - b + - c + variable2: a_choice +---- diff --git a/tests/docs/base/01_9choice_variable_multi.md b/tests/docs/base/01_9choice_variable_multi.md new file mode 100644 index 0000000..cc74f51 --- /dev/null +++ b/tests/docs/base/01_9choice_variable_multi.md @@ -0,0 +1,45 @@ +--- +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: + type: variable + 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". | + + +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + variable2: a_choice +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + variable1: + - a + - b + - c + variable2: a_choice +``` diff --git a/tests/docs/base/04_0type_param.adoc b/tests/docs/base/04_0type_param.adoc new file mode 100644 index 0000000..ceeb8a9 --- /dev/null +++ b/tests/docs/base/04_0type_param.adoc @@ -0,0 +1,42 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +int: + description: A limited number + type: number + params: + min_number: 0 + max_number: 100 +---- +== Variables for "rougail" + +[cols="105a,105a",options="header"] +|==== +| Variable | Description +| +**rougail.int** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `basic` `mandatory` | +A limited number. + +**Validators**: + +* the minimum value is 0 +* the maximum value is 100 +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +rougail: + int: 42 +---- +== Example with all variables modifiable + +[,yaml] +---- +rougail: + int: 42 +---- diff --git a/tests/docs/base/04_0type_param.md b/tests/docs/base/04_0type_param.md new file mode 100644 index 0000000..9385a1d --- /dev/null +++ b/tests/docs/base/04_0type_param.md @@ -0,0 +1,37 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +int: + description: A limited number + type: number + params: + min_number: 0 + max_number: 100 +``` +# Variables for "rougail" + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.int**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A limited number.
**Validators**:
- the minimum value is 0
- the maximum value is 100 | + + +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + int: 42 +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + int: 42 +``` diff --git a/tests/docs/base/04_1auto_save.adoc b/tests/docs/base/04_1auto_save.adoc new file mode 100644 index 0000000..f58aacb --- /dev/null +++ b/tests/docs/base/04_1auto_save.adoc @@ -0,0 +1,30 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: 1.1 +variable: + description: an auto save variable + auto_save: true + default: no +---- +== Variables for "rougail" + +[cols="121a,121a",options="header"] +|==== +| Variable | Description +| +**rougail.variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `auto modified` | +An auto save variable. + +**Default**: no +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +rougail: + variable: no +---- diff --git a/tests/docs/base/04_1auto_save.md b/tests/docs/base/04_1auto_save.md new file mode 100644 index 0000000..95705a4 --- /dev/null +++ b/tests/docs/base/04_1auto_save.md @@ -0,0 +1,28 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: 1.1 +variable: + description: an auto save variable + auto_save: true + default: no +``` +# Variables for "rougail" + +| Variable                                                                                                                | Description                                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `auto modified` | An auto save variable.
**Default**: no | + + +# Example with all variables modifiable + +```yaml +--- +rougail: + variable: no +``` diff --git a/tests/docs/base/04_1auto_save_and_calculated.adoc b/tests/docs/base/04_1auto_save_and_calculated.adoc new file mode 100644 index 0000000..daf067b --- /dev/null +++ b/tests/docs/base/04_1auto_save_and_calculated.adoc @@ -0,0 +1,39 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: 1.1 +var1: no # a first variable +var2: + description: a second variable + auto_save: true + default: + type: variable + variable: _.var1 +---- +== Variables for "rougail" + +[cols="121a,121a",options="header"] +|==== +| Variable | Description +| +**rougail.var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A first variable. + +**Default**: no +| +**rougail.var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `auto modified` | +A second variable. + +**Default**: the value of the variable "rougail.var1". +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +rougail: + var1: no + var2: no +---- diff --git a/tests/docs/base/04_1auto_save_and_calculated.md b/tests/docs/base/04_1auto_save_and_calculated.md new file mode 100644 index 0000000..b3200d9 --- /dev/null +++ b/tests/docs/base/04_1auto_save_and_calculated.md @@ -0,0 +1,33 @@ +--- +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: + type: variable + variable: _.var1 +``` +# 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". | + + +# Example with all variables modifiable + +```yaml +--- +rougail: + var1: no + var2: no +``` diff --git a/tests/docs/base/04_1auto_save_and_calculated_hidden.adoc b/tests/docs/base/04_1auto_save_and_calculated_hidden.adoc new file mode 100644 index 0000000..eff9434 --- /dev/null +++ b/tests/docs/base/04_1auto_save_and_calculated_hidden.adoc @@ -0,0 +1,48 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +var1: no # a first variable +var2: + description: a second variable + auto_save: true + hidden: + type: jinja + jinja: | + {% if _.var1 == "yes" %} + _.var1 is yes + {% endif %} + description: only if the variable var1 has value "yes" + default: + type: jinja + jinja: yes + description: the value is always yes +---- +== Variables for "rougail" + +[cols="132a,132a",options="header"] +|==== +| Variable | Description +| +**rougail.var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A first variable. + +**Default**: no +| +**rougail.var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` _`hidden`_ `auto modified` | +A second variable. + +**Default**: the value is always yes. + +**Hidden**: only if the variable var1 has value "yes". +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +rougail: + var1: no + var2: yes +---- diff --git a/tests/docs/base/04_1auto_save_and_calculated_hidden.md b/tests/docs/base/04_1auto_save_and_calculated_hidden.md new file mode 100644 index 0000000..b2c38a9 --- /dev/null +++ b/tests/docs/base/04_1auto_save_and_calculated_hidden.md @@ -0,0 +1,41 @@ +--- +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: + type: jinja + jinja: | + {% if _.var1 == "yes" %} + _.var1 is yes + {% endif %} + description: only if the variable var1 has value "yes" + default: + type: jinja + jinja: yes + description: the value is always yes +``` +# Variables for "rougail" + +| 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". | + + +# Example with all variables modifiable + +```yaml +--- +rougail: + var1: no + var2: yes +``` diff --git a/tests/docs/base/04_1auto_save_and_hidden.adoc b/tests/docs/base/04_1auto_save_and_hidden.adoc new file mode 100644 index 0000000..e8bea5c --- /dev/null +++ b/tests/docs/base/04_1auto_save_and_hidden.adoc @@ -0,0 +1,11 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +var: + description: autosave variable + auto_save: true + hidden: true + default: yes +---- diff --git a/tests/docs/base/04_1auto_save_and_hidden.md b/tests/docs/base/04_1auto_save_and_hidden.md new file mode 100644 index 0000000..7bbe9eb --- /dev/null +++ b/tests/docs/base/04_1auto_save_and_hidden.md @@ -0,0 +1,15 @@ +--- +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 +``` diff --git a/tests/docs/base/04_5disabled_calculation.adoc b/tests/docs/base/04_5disabled_calculation.adoc new file mode 100644 index 0000000..5e749e7 --- /dev/null +++ b/tests/docs/base/04_5disabled_calculation.adoc @@ -0,0 +1,65 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +condition: no # a conditional variable +variable1: + description: a first variable + disabled: + type: jinja + jinja: | + {% if _.condition == "yes" %} + condition is yes + {% endif %} + description: if condition is egal to "yes" +variable2: + description: a second variable + disabled: + type: jinja + jinja: | + {% if _.condition == "yes" %} + condition is yes + {% endif %} + description: if condition is egal to "yes" +---- +== Variables for "rougail" + +[cols="118a,118a",options="header"] +|==== +| Variable | Description +| +**rougail.condition** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A conditional variable. + +**Default**: no +| +**rougail.variable1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` _`disabled`_ | +A first variable. + +**Disabled**: if condition is egal to "yes". +| +**rougail.variable2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` _`disabled`_ | +A second variable. + +**Disabled**: if condition is egal to "yes". +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +rougail: + variable1: example + variable2: example +---- +== Example with all variables modifiable + +[,yaml] +---- +rougail: + condition: no + variable1: example + variable2: example +---- diff --git a/tests/docs/base/04_5disabled_calculation.md b/tests/docs/base/04_5disabled_calculation.md new file mode 100644 index 0000000..c298bc3 --- /dev/null +++ b/tests/docs/base/04_5disabled_calculation.md @@ -0,0 +1,55 @@ +--- +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: + type: jinja + jinja: | + {% if _.condition == "yes" %} + condition is yes + {% endif %} + description: if condition is egal to "yes" +variable2: + description: a second variable + disabled: + type: jinja + jinja: | + {% if _.condition == "yes" %} + condition is yes + {% endif %} + description: if condition is egal to "yes" +``` +# Variables for "rougail" + +| Variable                                                                                                             | Description                                                                                                          | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A conditional variable.
**Default**: no | +| **rougail.variable1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` _`disabled`_ | A first variable.
**Disabled**: if condition is egal to "yes". | +| **rougail.variable2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` _`disabled`_ | A second variable.
**Disabled**: if condition is egal to "yes". | + + +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + variable1: example + variable2: example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + condition: no + variable1: example + variable2: example +``` diff --git a/tests/docs/base/04_5disabled_calculation_default.adoc b/tests/docs/base/04_5disabled_calculation_default.adoc new file mode 100644 index 0000000..4ae0cef --- /dev/null +++ b/tests/docs/base/04_5disabled_calculation_default.adoc @@ -0,0 +1,69 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +condition: no # a condition +var1: + description: a first variable + disabled: + type: jinja + jinja: | + {% if _.condition == "yes" %} + condition is yes + {% endif %} + description: if condition is yes + default: + type: jinja + jinja: | + {{ _.condition }} + description: the value of condition +var2: + description: a second variable + disabled: + type: jinja + jinja: | + {% if rougail.condition == "yes" %} + condition is yes + {% endif %} + description: if condition is yes + default: + type: jinja + jinja: | + {{ rougail.condition }} + description: the value of condition +---- +== Variables for "rougail" + +[cols="121a,121a",options="header"] +|==== +| Variable | Description +| +**rougail.condition** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A condition. + +**Default**: no +| +**rougail.var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` _`disabled`_ | +A first variable. + +**Default**: the value of condition. + +**Disabled**: if condition is yes. +| +**rougail.var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` _`disabled`_ | +A second variable. + +**Default**: the value of condition. + +**Disabled**: if condition is yes. +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +rougail: + condition: no + var1: no + var2: no +---- diff --git a/tests/docs/base/04_5disabled_calculation_default.md b/tests/docs/base/04_5disabled_calculation_default.md new file mode 100644 index 0000000..d81a726 --- /dev/null +++ b/tests/docs/base/04_5disabled_calculation_default.md @@ -0,0 +1,57 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +condition: no # a condition +var1: + description: a first variable + disabled: + type: jinja + jinja: | + {% if _.condition == "yes" %} + condition is yes + {% endif %} + description: if condition is yes + default: + type: jinja + jinja: | + {{ _.condition }} + description: the value of condition +var2: + description: a second variable + disabled: + type: jinja + jinja: | + {% if rougail.condition == "yes" %} + condition is yes + {% endif %} + description: if condition is yes + default: + type: jinja + jinja: | + {{ rougail.condition }} + description: the value of condition +``` +# Variables for "rougail" + +| Variable                                                                                                                | Description                                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.
**Default**: no | +| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` _`disabled`_ | A first variable.
**Default**: the value of condition.
**Disabled**: if condition is yes. | +| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` _`disabled`_ | A second variable.
**Default**: the value of condition.
**Disabled**: if condition is yes. | + + +# Example with all variables modifiable + +```yaml +--- +rougail: + condition: no + var1: no + var2: no +``` diff --git a/tests/docs/base/04_5disabled_calculation_optional.adoc b/tests/docs/base/04_5disabled_calculation_optional.adoc new file mode 100644 index 0000000..a4bf515 --- /dev/null +++ b/tests/docs/base/04_5disabled_calculation_optional.adoc @@ -0,0 +1,79 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +condition: no # a condition +var1: + description: a first variable + hidden: + type: jinja + jinja: | + {% if unknown is not defined %} + unknown is undefined + {% elif unknown == "no" %} + unknown is no + {% endif %} + params: + unknown: + type: variable + variable: _.unknown + optional: true + description: calculation from an unknown variable +var2: + description: a second variable + hidden: + type: jinja + jinja: | + {% if condition is not defined %} + condition is undefined + {% elif condition == "no" %} + condition is no + {% endif %} + params: + condition: + type: variable + variable: _.condition + optional: true + description: calculation from an condition variable +---- +== Variables for "rougail" + +[cols="116a,116a",options="header"] +|==== +| Variable | Description +| +**rougail.condition** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A condition. + +**Default**: no +| +**rougail.var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` _`hidden`_ | +A first variable. + +**Hidden**: calculation from an unknown variable. +| +**rougail.var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` _`hidden`_ | +A second variable. + +**Hidden**: calculation from an condition variable. +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +rougail: + var1: example + var2: example +---- +== Example with all variables modifiable + +[,yaml] +---- +rougail: + condition: no + var1: example + var2: example +---- diff --git a/tests/docs/base/04_5disabled_calculation_optional.md b/tests/docs/base/04_5disabled_calculation_optional.md new file mode 100644 index 0000000..0acc71f --- /dev/null +++ b/tests/docs/base/04_5disabled_calculation_optional.md @@ -0,0 +1,69 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +condition: no # a condition +var1: + description: a first variable + hidden: + type: jinja + jinja: | + {% if unknown is not defined %} + unknown is undefined + {% elif unknown == "no" %} + unknown is no + {% endif %} + params: + unknown: + type: variable + variable: _.unknown + optional: true + description: calculation from an unknown variable +var2: + description: a second variable + hidden: + type: jinja + jinja: | + {% if condition is not defined %} + condition is undefined + {% elif condition == "no" %} + condition is no + {% endif %} + params: + condition: + type: variable + variable: _.condition + optional: true + description: 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) `basic` `mandatory` _`hidden`_ | A first variable.
**Hidden**: calculation from an unknown variable. | +| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` _`hidden`_ | A second variable.
**Hidden**: calculation from an condition variable. | + + +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + var1: example + var2: example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + condition: no + var1: example + var2: example +``` diff --git a/tests/docs/base/04_5disabled_calculation_variable.adoc b/tests/docs/base/04_5disabled_calculation_variable.adoc new file mode 100644 index 0000000..adeaf56 --- /dev/null +++ b/tests/docs/base/04_5disabled_calculation_variable.adoc @@ -0,0 +1,45 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +condition: false # a condition +variable: + description: a variable + disabled: + type: variable + variable: _.condition +---- +== Variables for "rougail" + +[cols="118a,118a",options="header"] +|==== +| Variable | Description +| +**rougail.condition** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | +A condition. + +**Default**: False +| +**rougail.variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` _`disabled`_ | +A variable. + +**Disabled**: when the variable "rougail.condition" has the value "True". +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +rougail: + variable: example +---- +== Example with all variables modifiable + +[,yaml] +---- +rougail: + condition: false + variable: example +---- diff --git a/tests/docs/base/04_5disabled_calculation_variable.md b/tests/docs/base/04_5disabled_calculation_variable.md new file mode 100644 index 0000000..c33b25a --- /dev/null +++ b/tests/docs/base/04_5disabled_calculation_variable.md @@ -0,0 +1,39 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +condition: false # a condition +variable: + description: a variable + disabled: + type: variable + variable: _.condition +``` +# Variables for "rougail" + +| Variable                                                                                                             | Description                                                                                                          | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.condition**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.
**Default**: False | +| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` _`disabled`_ | A variable.
**Disabled**: when the variable "rougail.condition" has the value "True". | + + +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + variable: example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + condition: false + variable: example +``` diff --git a/tests/docs/base/04_5disabled_calculation_variable2.adoc b/tests/docs/base/04_5disabled_calculation_variable2.adoc new file mode 100644 index 0000000..362a75d --- /dev/null +++ b/tests/docs/base/04_5disabled_calculation_variable2.adoc @@ -0,0 +1,45 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +condition: true # a condition +variable: + description: a variable + disabled: + type: variable + variable: _.condition +---- +== Variables for "rougail" + +[cols="118a,118a",options="header"] +|==== +| Variable | Description +| +**rougail.condition** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | +A condition. + +**Default**: True +| +**rougail.variable** + +`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". +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +rougail: + variable: example +---- +== Example with all variables modifiable + +[,yaml] +---- +rougail: + condition: true + variable: example +---- diff --git a/tests/docs/base/04_5disabled_calculation_variable2.md b/tests/docs/base/04_5disabled_calculation_variable2.md new file mode 100644 index 0000000..6cdefa1 --- /dev/null +++ b/tests/docs/base/04_5disabled_calculation_variable2.md @@ -0,0 +1,39 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +condition: true # a condition +variable: + description: a variable + disabled: + type: variable + variable: _.condition +``` +# Variables for "rougail" + +| Variable                                                                                                             | Description                                                                                                          | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.condition**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.
**Default**: True | +| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` _`disabled`_ | A variable.
**Disabled**: when the variable "rougail.condition" has the value "True". | + + +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + variable: example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + condition: true + variable: example +``` diff --git a/tests/docs/base/04_5disabled_calculation_variable3.adoc b/tests/docs/base/04_5disabled_calculation_variable3.adoc new file mode 100644 index 0000000..2febb3e --- /dev/null +++ b/tests/docs/base/04_5disabled_calculation_variable3.adoc @@ -0,0 +1,46 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +condition: yes # a condition +variable: + description: a variable + disabled: + type: variable + variable: _.condition + when: yes +---- +== Variables for "rougail" + +[cols="118a,118a",options="header"] +|==== +| Variable | Description +| +**rougail.condition** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A condition. + +**Default**: yes +| +**rougail.variable** + +`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". +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +rougail: + variable: example +---- +== Example with all variables modifiable + +[,yaml] +---- +rougail: + condition: yes + variable: example +---- diff --git a/tests/docs/base/04_5disabled_calculation_variable3.md b/tests/docs/base/04_5disabled_calculation_variable3.md new file mode 100644 index 0000000..ac79463 --- /dev/null +++ b/tests/docs/base/04_5disabled_calculation_variable3.md @@ -0,0 +1,40 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +condition: yes # a condition +variable: + description: a variable + disabled: + type: variable + variable: _.condition + when: yes +``` +# 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". | + + +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + variable: example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + condition: yes + variable: example +``` diff --git a/tests/docs/base/04_5disabled_calculation_variable4.adoc b/tests/docs/base/04_5disabled_calculation_variable4.adoc new file mode 100644 index 0000000..f170e05 --- /dev/null +++ b/tests/docs/base/04_5disabled_calculation_variable4.adoc @@ -0,0 +1,46 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +condition: yes # a condition +variable: + description: a variable + disabled: + type: variable + variable: _.condition + when_not: yes +---- +== Variables for "rougail" + +[cols="118a,118a",options="header"] +|==== +| Variable | Description +| +**rougail.condition** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A condition. + +**Default**: yes +| +**rougail.variable** + +`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". +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +rougail: + variable: example +---- +== Example with all variables modifiable + +[,yaml] +---- +rougail: + condition: yes + variable: example +---- diff --git a/tests/docs/base/04_5disabled_calculation_variable4.md b/tests/docs/base/04_5disabled_calculation_variable4.md new file mode 100644 index 0000000..ef271d1 --- /dev/null +++ b/tests/docs/base/04_5disabled_calculation_variable4.md @@ -0,0 +1,40 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +condition: yes # a condition +variable: + description: a variable + disabled: + type: variable + variable: _.condition + when_not: yes +``` +# 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". | + + +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + variable: example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + condition: yes + variable: example +``` diff --git a/tests/docs/base/04_5hidden_calculation.adoc b/tests/docs/base/04_5hidden_calculation.adoc new file mode 100644 index 0000000..e96db03 --- /dev/null +++ b/tests/docs/base/04_5hidden_calculation.adoc @@ -0,0 +1,61 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +condition: no # the condition +var1: + description: a first variable + default: no + hidden: + type: jinja + jinja: | + {% if _.condition == "yes" %} + condition is yes + {% endif %} + description: if condition is yes +var2: + description: a second variable + default: no + hidden: + type: jinja + jinja: | + {% if rougail.condition == "yes" %} + condition is yes + {% endif %} + description: if condition is yes +---- +== Variables for "rougail" + +[cols="119a,119a",options="header"] +|==== +| Variable | Description +| +**rougail.condition** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +The condition. + +**Default**: no +| +**rougail.var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` _`hidden`_ | +A first variable. + +**Default**: no + +**Hidden**: if condition is yes. +| +**rougail.var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` _`hidden`_ | +A second variable. + +**Default**: no + +**Hidden**: if condition is yes. +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +rougail: + condition: no + var1: no + var2: no +---- diff --git a/tests/docs/base/04_5hidden_calculation.md b/tests/docs/base/04_5hidden_calculation.md new file mode 100644 index 0000000..b42fb10 --- /dev/null +++ b/tests/docs/base/04_5hidden_calculation.md @@ -0,0 +1,49 @@ +--- +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: + type: jinja + jinja: | + {% if _.condition == "yes" %} + condition is yes + {% endif %} + description: if condition is yes +var2: + description: a second variable + default: no + hidden: + type: jinja + jinja: | + {% if rougail.condition == "yes" %} + condition is yes + {% endif %} + description: if condition is yes +``` +# Variables for "rougail" + +| Variable                                                                                                              | Description                                                                                                           | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The condition.
**Default**: no | +| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` _`hidden`_ | A first variable.
**Default**: no
**Hidden**: if condition is yes. | +| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` _`hidden`_ | A second variable.
**Default**: no
**Hidden**: if condition is yes. | + + +# Example with all variables modifiable + +```yaml +--- +rougail: + condition: no + var1: no + var2: no +``` diff --git a/tests/docs/base/04_5hidden_calculation2.adoc b/tests/docs/base/04_5hidden_calculation2.adoc new file mode 100644 index 0000000..382b1b3 --- /dev/null +++ b/tests/docs/base/04_5hidden_calculation2.adoc @@ -0,0 +1,69 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +condition: no # a condition +var1: + description: a first variable + hidden: + type: jinja + jinja: | + {% if _.condition != "yes" %} + condition is yes + {% endif %} + description: if condition is yes + default: + type: jinja + jinja: | + {{ _.condition }} + description: the value of condition +var2: + description: a second variable + hidden: + type: jinja + jinja: | + {% if rougail.condition != "yes" %} + condition is yes + {% endif %} + description: if condition is yes + default: + type: jinja + jinja: | + {{ rougail.condition }} + description: the value of condition +---- +== Variables for "rougail" + +[cols="119a,119a",options="header"] +|==== +| Variable | Description +| +**rougail.condition** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A condition. + +**Default**: no +| +**rougail.var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` _`hidden`_ | +A first variable. + +**Default**: the value of condition. + +**Hidden**: if condition is yes. +| +**rougail.var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` _`hidden`_ | +A second variable. + +**Default**: the value of condition. + +**Hidden**: if condition is yes. +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +rougail: + condition: no + var1: no + var2: no +---- diff --git a/tests/docs/base/04_5hidden_calculation2.md b/tests/docs/base/04_5hidden_calculation2.md new file mode 100644 index 0000000..cfdf3eb --- /dev/null +++ b/tests/docs/base/04_5hidden_calculation2.md @@ -0,0 +1,57 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +condition: no # a condition +var1: + description: a first variable + hidden: + type: jinja + jinja: | + {% if _.condition != "yes" %} + condition is yes + {% endif %} + description: if condition is yes + default: + type: jinja + jinja: | + {{ _.condition }} + description: the value of condition +var2: + description: a second variable + hidden: + type: jinja + jinja: | + {% if rougail.condition != "yes" %} + condition is yes + {% endif %} + description: if condition is yes + default: + type: jinja + jinja: | + {{ rougail.condition }} + description: the value of condition +``` +# Variables for "rougail" + +| Variable                                                                                                              | Description                                                                                                           | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.
**Default**: no | +| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` _`hidden`_ | A first variable.
**Default**: the value of condition.
**Hidden**: if condition is yes. | +| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` _`hidden`_ | A second variable.
**Default**: the value of condition.
**Hidden**: if condition is yes. | + + +# Example with all variables modifiable + +```yaml +--- +rougail: + condition: no + var1: no + var2: no +``` diff --git a/tests/docs/base/04_5hidden_calculation_default_calculation.adoc b/tests/docs/base/04_5hidden_calculation_default_calculation.adoc new file mode 100644 index 0000000..9718eba --- /dev/null +++ b/tests/docs/base/04_5hidden_calculation_default_calculation.adoc @@ -0,0 +1,69 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +condition: no # a condition +var1: + description: a first variable + hidden: + type: jinja + jinja: | + {% if _.condition == "yes" %} + condition is yes + {% endif %} + description: if condition is yes + default: + type: jinja + jinja: | + {{ _.condition }} + description: returns the condition value +var2: + description: a second variable + hidden: + type: jinja + jinja: | + {% if rougail.condition == "yes" %} + condition is yes + {% endif %} + description: if condition is yes + default: + type: jinja + jinja: | + {{ rougail.condition }} + description: returns the condition value +---- +== Variables for "rougail" + +[cols="119a,119a",options="header"] +|==== +| Variable | Description +| +**rougail.condition** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A condition. + +**Default**: no +| +**rougail.var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` _`hidden`_ | +A first variable. + +**Default**: returns the condition value. + +**Hidden**: if condition is yes. +| +**rougail.var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` _`hidden`_ | +A second variable. + +**Default**: returns the condition value. + +**Hidden**: if condition is yes. +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +rougail: + condition: no + var1: no + var2: no +---- diff --git a/tests/docs/base/04_5hidden_calculation_default_calculation.md b/tests/docs/base/04_5hidden_calculation_default_calculation.md new file mode 100644 index 0000000..6f0f4ca --- /dev/null +++ b/tests/docs/base/04_5hidden_calculation_default_calculation.md @@ -0,0 +1,57 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +condition: no # a condition +var1: + description: a first variable + hidden: + type: jinja + jinja: | + {% if _.condition == "yes" %} + condition is yes + {% endif %} + description: if condition is yes + default: + type: jinja + jinja: | + {{ _.condition }} + description: returns the condition value +var2: + description: a second variable + hidden: + type: jinja + jinja: | + {% if rougail.condition == "yes" %} + condition is yes + {% endif %} + description: if condition is yes + default: + type: jinja + jinja: | + {{ rougail.condition }} + description: returns the condition value +``` +# Variables for "rougail" + +| Variable                                                                                                              | Description                                                                                                           | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.
**Default**: no | +| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` _`hidden`_ | A first variable.
**Default**: returns the condition value.
**Hidden**: if condition is yes. | +| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` _`hidden`_ | A second variable.
**Default**: returns the condition value.
**Hidden**: if condition is yes. | + + +# Example with all variables modifiable + +```yaml +--- +rougail: + condition: no + var1: no + var2: no +``` diff --git a/tests/docs/base/04_5validators.adoc b/tests/docs/base/04_5validators.adoc new file mode 100644 index 0000000..0a7ea78 --- /dev/null +++ b/tests/docs/base/04_5validators.adoc @@ -0,0 +1,43 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +int: + description: A number + type: number + validators: + - type: jinja + jinja: | + {% if _.int > 100 %} + value is too high + {% endif %} + description: the max value is 100 +---- +== Variables for "rougail" + +[cols="105a,105a",options="header"] +|==== +| Variable | Description +| +**rougail.int** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `basic` `mandatory` | +A number. + +**Validator**: the max value is 100. +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +rougail: + int: 42 +---- +== Example with all variables modifiable + +[,yaml] +---- +rougail: + int: 42 +---- diff --git a/tests/docs/base/04_5validators.md b/tests/docs/base/04_5validators.md new file mode 100644 index 0000000..035ebf7 --- /dev/null +++ b/tests/docs/base/04_5validators.md @@ -0,0 +1,41 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +int: + description: A number + type: number + validators: + - type: jinja + jinja: | + {% if _.int > 100 %} + value is too high + {% endif %} + description: the max value is 100 +``` +# Variables for "rougail" + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.int**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A number.
**Validator**: the max value is 100. | + + +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + int: 42 +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + int: 42 +``` diff --git a/tests/docs/base/04_5validators_differ.adoc b/tests/docs/base/04_5validators_differ.adoc new file mode 100644 index 0000000..0e10524 --- /dev/null +++ b/tests/docs/base/04_5validators_differ.adoc @@ -0,0 +1,45 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +var1: + description: a first variable + type: string + default: oui + validators: + - type: jinja + jinja: | + {% if _.var1 == _.var2 %} + var1 must be different than var2 + {% endif %} + description: var1 must be different than var2 +var2: no # A second variable +---- +== Variables for "rougail" + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**rougail.var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A first variable. + +**Validator**: var1 must be different than var2. + +**Default**: oui +| +**rougail.var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A second variable. + +**Default**: no +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +rougail: + var1: oui + var2: no +---- diff --git a/tests/docs/base/04_5validators_differ.md b/tests/docs/base/04_5validators_differ.md new file mode 100644 index 0000000..8f4d30e --- /dev/null +++ b/tests/docs/base/04_5validators_differ.md @@ -0,0 +1,38 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: + description: a first variable + type: string + default: oui + validators: + - type: jinja + jinja: | + {% if _.var1 == _.var2 %} + var1 must be different than var2 + {% endif %} + description: var1 must be different than var2 +var2: no # A second variable +``` +# Variables for "rougail" + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A first variable.
**Validator**: var1 must be different than var2.
**Default**: oui | +| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second variable.
**Default**: no | + + +# Example with all variables modifiable + +```yaml +--- +rougail: + var1: oui + var2: no +``` diff --git a/tests/docs/base/04_5validators_in_network.adoc b/tests/docs/base/04_5validators_in_network.adoc new file mode 100644 index 0000000..0f1428e --- /dev/null +++ b/tests/docs/base/04_5validators_in_network.adoc @@ -0,0 +1,64 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +network_address_eth0: + description: Network address + type: network +netmask_address_eth0: + description: Network address + type: netmask +ip_address: + description: an IP + type: ip + validators: + - type: jinja + jinja: | + {% if not _.ip_address | valid_in_network(_.network_address_eth0, _.netmask_address_eth0) %} + {{ _.ip_address }} is not in network {{ _.network_address_eth0 }}/{{ _.netmask_address_eth0 }} + {% endif %} + description: check if IP in the previous network +---- +== Variables for "rougail" + +[cols="101a,101a",options="header"] +|==== +| Variable | Description +| +**rougail.network_address_eth0** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[network]` `basic` `mandatory` | +Network address. +| +**rougail.netmask_address_eth0** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[netmask]` `basic` `mandatory` | +Network address. +| +**rougail.ip_address** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[IP]` `basic` `mandatory` | +An IP. + +**Validators**: + +* reserved IP are allowed +* check if IP in the previous network. +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +rougail: + network_address_eth0: 1.1.1.0 + netmask_address_eth0: 255.255.255.0 + ip_address: 1.1.1.1 +---- +== Example with all variables modifiable + +[,yaml] +---- +rougail: + network_address_eth0: 1.1.1.0 + netmask_address_eth0: 255.255.255.0 + ip_address: 1.1.1.1 +---- diff --git a/tests/docs/base/04_5validators_in_network.md b/tests/docs/base/04_5validators_in_network.md new file mode 100644 index 0000000..8851b62 --- /dev/null +++ b/tests/docs/base/04_5validators_in_network.md @@ -0,0 +1,53 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +network_address_eth0: + description: Network address + type: network +netmask_address_eth0: + description: Network address + type: netmask +ip_address: + description: an IP + type: ip + validators: + - type: jinja + jinja: | + {% if not _.ip_address | valid_in_network(_.network_address_eth0, _.netmask_address_eth0) %} + {{ _.ip_address }} is not in network {{ _.network_address_eth0 }}/{{ _.netmask_address_eth0 }} + {% endif %} + description: check if IP in the previous network +``` +# Variables for "rougail" + +| Variable                                                                                            | Description                                                                                         | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.network_address_eth0**
[`network`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | Network address. | +| **rougail.netmask_address_eth0**
[`netmask`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | Network address. | +| **rougail.ip_address**
[`IP`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | An IP.
**Validators**:
- reserved IP are allowed
- check if IP in the previous network. | + + +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + network_address_eth0: 1.1.1.0 + netmask_address_eth0: 255.255.255.0 + ip_address: 1.1.1.1 +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + network_address_eth0: 1.1.1.0 + netmask_address_eth0: 255.255.255.0 + ip_address: 1.1.1.1 +``` diff --git a/tests/docs/base/04_5validators_in_network_cidr.adoc b/tests/docs/base/04_5validators_in_network_cidr.adoc new file mode 100644 index 0000000..613b470 --- /dev/null +++ b/tests/docs/base/04_5validators_in_network_cidr.adoc @@ -0,0 +1,55 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +network_address_eth0: + description: Network address + type: cidr +ip_address: + description: an IP + type: ip + validators: + - type: jinja + jinja: | + {% if not _.ip_address | valid_in_network(_.network_address_eth0) %} + {{ _.ip_address }} is not in network {{ _.network_address_eth0 }} + {% endif %} + description: this IP must be in network +---- +== Variables for "rougail" + +[cols="101a,101a",options="header"] +|==== +| Variable | Description +| +**rougail.network_address_eth0** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[cidr]` `basic` `mandatory` | +Network address. +| +**rougail.ip_address** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[IP]` `basic` `mandatory` | +An IP. + +**Validators**: + +* reserved IP are allowed +* this IP must be in network. +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +rougail: + network_address_eth0: 1.1.1.0/24 + ip_address: 1.1.1.1 +---- +== Example with all variables modifiable + +[,yaml] +---- +rougail: + network_address_eth0: 1.1.1.0/24 + ip_address: 1.1.1.1 +---- diff --git a/tests/docs/base/04_5validators_in_network_cidr.md b/tests/docs/base/04_5validators_in_network_cidr.md new file mode 100644 index 0000000..66b0859 --- /dev/null +++ b/tests/docs/base/04_5validators_in_network_cidr.md @@ -0,0 +1,47 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +network_address_eth0: + description: Network address + type: cidr +ip_address: + description: an IP + type: ip + validators: + - type: jinja + jinja: | + {% if not _.ip_address | valid_in_network(_.network_address_eth0) %} + {{ _.ip_address }} is not in network {{ _.network_address_eth0 }} + {% endif %} + description: this IP must be in network +``` +# Variables for "rougail" + +| Variable                                                                                            | Description                                                                                         | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.network_address_eth0**
[`cidr`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | Network address. | +| **rougail.ip_address**
[`IP`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | An IP.
**Validators**:
- reserved IP are allowed
- this IP must be in network. | + + +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + network_address_eth0: 1.1.1.0/24 + ip_address: 1.1.1.1 +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + network_address_eth0: 1.1.1.0/24 + ip_address: 1.1.1.1 +``` diff --git a/tests/docs/base/04_5validators_ipnetmask.adoc b/tests/docs/base/04_5validators_ipnetmask.adoc new file mode 100644 index 0000000..fd3b10e --- /dev/null +++ b/tests/docs/base/04_5validators_ipnetmask.adoc @@ -0,0 +1,52 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +network_address_eth0: + description: Network address + type: network +netmask_address_eth0: + description: Netmask address + type: netmask + validators: + - type: jinja + jinja: | + {% if not _.netmask_address_eth0 | valid_in_network(_.network_address_eth0) %} + {{ _.netmask_address_eth0 }} is not a netmask for network {{ _.network_address_eth0 }} + {% endif %} + description: this mask is possible for the network +---- +== Variables for "rougail" + +[cols="106a,106a",options="header"] +|==== +| Variable | Description +| +**rougail.network_address_eth0** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[network]` `basic` `mandatory` | +Network address. +| +**rougail.netmask_address_eth0** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[netmask]` `basic` `mandatory` | +Netmask address. + +**Validator**: this mask is possible for the network. +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +rougail: + network_address_eth0: 1.1.1.0 + netmask_address_eth0: 255.255.255.0 +---- +== Example with all variables modifiable + +[,yaml] +---- +rougail: + network_address_eth0: 1.1.1.0 + netmask_address_eth0: 255.255.255.0 +---- diff --git a/tests/docs/base/04_5validators_ipnetmask.md b/tests/docs/base/04_5validators_ipnetmask.md new file mode 100644 index 0000000..65384f2 --- /dev/null +++ b/tests/docs/base/04_5validators_ipnetmask.md @@ -0,0 +1,47 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +network_address_eth0: + description: Network address + type: network +netmask_address_eth0: + description: Netmask address + type: netmask + validators: + - type: jinja + jinja: | + {% if not _.netmask_address_eth0 | valid_in_network(_.network_address_eth0) %} + {{ _.netmask_address_eth0 }} is not a netmask for network {{ _.network_address_eth0 }} + {% endif %} + description: this mask is possible for the network +``` +# Variables for "rougail" + +| Variable                                                                                                 | Description                                                                                              | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.network_address_eth0**
[`network`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | Network address. | +| **rougail.netmask_address_eth0**
[`netmask`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | Netmask address.
**Validator**: this mask is possible for the network. | + + +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + network_address_eth0: 1.1.1.0 + netmask_address_eth0: 255.255.255.0 +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + network_address_eth0: 1.1.1.0 + netmask_address_eth0: 255.255.255.0 +``` diff --git a/tests/docs/base/04_7validators_variable_optional.adoc b/tests/docs/base/04_7validators_variable_optional.adoc new file mode 100644 index 0000000..27d7177 --- /dev/null +++ b/tests/docs/base/04_7validators_variable_optional.adoc @@ -0,0 +1,76 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +general: # a family + int: + description: a first number + type: number + validators: + - type: jinja + jinja: | + {% if _.int == int2 %} + int and int2 must be different + {% endif %} + params: + int2: + type: variable + variable: _.int2 + optional: true + description: int and int2 must be different + - type: jinja + jinja: | + {% if _.int == int3 %} + int and int3 must be different + {% endif %} + params: + int3: + type: variable + variable: _.int3 + optional: true + description: int and int3 must be different + int2: 1 # a second number +---- +== Variables for "rougail" + +=== a family + +`basic` + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**rougail.general.int** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `basic` `mandatory` | +A first number. + +**Validators**: + +* int and int2 must be different. +* int and int3 must be different. +| +**rougail.general.int2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` | +A second number. + +**Default**: 1 +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +rougail: + general: + int: 42 +---- +== Example with all variables modifiable + +[,yaml] +---- +rougail: + general: + int: 42 + int2: 1 +---- diff --git a/tests/docs/base/04_7validators_variable_optional.md b/tests/docs/base/04_7validators_variable_optional.md new file mode 100644 index 0000000..a89e2ab --- /dev/null +++ b/tests/docs/base/04_7validators_variable_optional.md @@ -0,0 +1,67 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +general: # a family + int: + description: a first number + type: number + validators: + - type: jinja + jinja: | + {% if _.int == int2 %} + int and int2 must be different + {% endif %} + params: + int2: + type: variable + variable: _.int2 + optional: true + description: int and int2 must be different + - type: jinja + jinja: | + {% if _.int == int3 %} + int and int3 must be different + {% endif %} + params: + int3: + type: variable + variable: _.int3 + optional: true + description: int and int3 must be different + int2: 1 # a second number +``` +# Variables for "rougail" + +## a family + +`basic` + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.general.int**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A first number.
**Validators**:
- int and int2 must be different.
- int and int3 must be different. | +| **rougail.general.int2**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second number.
**Default**: 1 | + + +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + general: + int: 42 +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + general: + int: 42 + int2: 1 +``` diff --git a/tests/docs/base/05_0multi_not_uniq.adoc b/tests/docs/base/05_0multi_not_uniq.adoc new file mode 100644 index 0000000..9626f7a --- /dev/null +++ b/tests/docs/base/05_0multi_not_uniq.adoc @@ -0,0 +1,34 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +var1: + description: a variable + unique: false + default: + - non +---- +== Variables for "rougail" + +[cols="119a,119a",options="header"] +|==== +| Variable | Description +| +**rougail.var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `multiple` | +A variable. + +**Default**: + +* non +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +rougail: + var1: + - non +---- diff --git a/tests/docs/base/05_0multi_not_uniq.md b/tests/docs/base/05_0multi_not_uniq.md new file mode 100644 index 0000000..508f268 --- /dev/null +++ b/tests/docs/base/05_0multi_not_uniq.md @@ -0,0 +1,30 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: + description: a variable + unique: false + default: + - non +``` +# Variables for "rougail" + +| Variable                                                                                                              | Description                                                                                                           | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `multiple` | A variable.
**Default**:
- non | + + +# Example with all variables modifiable + +```yaml +--- +rougail: + var1: + - non +``` diff --git a/tests/docs/base/05_0multi_uniq.adoc b/tests/docs/base/05_0multi_uniq.adoc new file mode 100644 index 0000000..0d0a378 --- /dev/null +++ b/tests/docs/base/05_0multi_uniq.adoc @@ -0,0 +1,34 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +variable: + description: a variable + unique: true + default: + - non +---- +== Variables for "rougail" + +[cols="128a,128a",options="header"] +|==== +| Variable | Description +| +**rougail.variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +A variable. + +**Default**: + +* non +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +rougail: + variable: + - non +---- diff --git a/tests/docs/base/05_0multi_uniq.md b/tests/docs/base/05_0multi_uniq.md new file mode 100644 index 0000000..621d288 --- /dev/null +++ b/tests/docs/base/05_0multi_uniq.md @@ -0,0 +1,30 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +variable: + description: a variable + unique: true + default: + - non +``` +# Variables for "rougail" + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A variable.
**Default**:
- non | + + +# Example with all variables modifiable + +```yaml +--- +rougail: + variable: + - non +``` diff --git a/tests/docs/base/12_1auto_save_expert.adoc b/tests/docs/base/12_1auto_save_expert.adoc new file mode 100644 index 0000000..b2fa8f9 --- /dev/null +++ b/tests/docs/base/12_1auto_save_expert.adoc @@ -0,0 +1,11 @@ +== 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/base/12_1auto_save_expert.md b/tests/docs/base/12_1auto_save_expert.md new file mode 100644 index 0000000..7ae5957 --- /dev/null +++ b/tests/docs/base/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/base/16_0redefine_description.adoc b/tests/docs/base/16_0redefine_description.adoc new file mode 100644 index 0000000..1fca07d --- /dev/null +++ b/tests/docs/base/16_0redefine_description.adoc @@ -0,0 +1,43 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +var: + description: Redefine description +---- +== dictionaries/rougail/01-redefine.yml + +[,yaml] +---- +version: '1.1' +var: + description: Redefined + redefine: true +---- +== Variables for "rougail" + +[cols="105a,105a",options="header"] +|==== +| Variable | Description +| +**rougail.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +Redefined. +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +rougail: + var: example +---- +== Example with all variables modifiable + +[,yaml] +---- +rougail: + var: example +---- diff --git a/tests/docs/base/16_0redefine_description.md b/tests/docs/base/16_0redefine_description.md new file mode 100644 index 0000000..3be0f1d --- /dev/null +++ b/tests/docs/base/16_0redefine_description.md @@ -0,0 +1,42 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: + description: Redefine description +``` +# dictionaries/rougail/01-redefine.yml + +```yaml +--- +version: '1.1' +var: + description: Redefined + redefine: true +``` +# Variables for "rougail" + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | Redefined. | + + +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + var: example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var: example +``` diff --git a/tests/docs/base/16_2family_redefine_calculation.adoc b/tests/docs/base/16_2family_redefine_calculation.adoc new file mode 100644 index 0000000..a8ff75f --- /dev/null +++ b/tests/docs/base/16_2family_redefine_calculation.adoc @@ -0,0 +1,54 @@ +== dictionaries/rougail/01-base.yml + +[,yaml] +---- +version: '1.0' +family: + redefine: true + disabled: + type: jinja + jinja: | + true +---- +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.0' +family: + var1: +---- +== Variables for "rougail" + +=== rougail.family + +`basic` _`disabled`_ + +**Disabled**: issu d'un calcul. + +[cols="105a,105a",options="header"] +|==== +| Variable | Description +| +**rougail.family.var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +Var1. +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +rougail: + family: + var1: example +---- +== Example with all variables modifiable + +[,yaml] +---- +rougail: + family: + var1: example +---- diff --git a/tests/docs/base/16_2family_redefine_calculation.md b/tests/docs/base/16_2family_redefine_calculation.md new file mode 100644 index 0000000..466e787 --- /dev/null +++ b/tests/docs/base/16_2family_redefine_calculation.md @@ -0,0 +1,53 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/01-base.yml + +```yaml +--- +version: '1.0' +family: + redefine: true + disabled: + type: jinja + jinja: | + true +``` +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.0' +family: + var1: +``` +# Variables for "rougail" + +## rougail.family + +`basic` _`disabled`_ + +**Disabled**: issu d'un calcul. + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.family.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | Var1. | + + +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + family: + var1: example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + family: + var1: example +``` diff --git a/tests/docs/base/16_2family_redefine_disabled.adoc b/tests/docs/base/16_2family_redefine_disabled.adoc new file mode 100644 index 0000000..14f798a --- /dev/null +++ b/tests/docs/base/16_2family_redefine_disabled.adoc @@ -0,0 +1,17 @@ +== dictionaries/rougail/01-base.yml + +[,yaml] +---- +version: '1.0' +family: + redefine: true + disabled: true +---- +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.0' +family: + var1: +---- diff --git a/tests/docs/base/16_2family_redefine_disabled.md b/tests/docs/base/16_2family_redefine_disabled.md new file mode 100644 index 0000000..9ac5af4 --- /dev/null +++ b/tests/docs/base/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/base/16_5exists_nonexists.adoc b/tests/docs/base/16_5exists_nonexists.adoc new file mode 100644 index 0000000..fc080ab --- /dev/null +++ b/tests/docs/base/16_5exists_nonexists.adoc @@ -0,0 +1,43 @@ +== dictionaries/rougail/01-base.yml + +[,yaml] +---- +version: '1.1' +var2: + description: a new variable + exists: false + default: yes +---- +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +var1: no # a variable +---- +== Variables for "rougail" + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**rougail.var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A variable. + +**Default**: no +| +**rougail.var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A new variable. + +**Default**: yes +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +rougail: + var1: no + var2: yes +---- diff --git a/tests/docs/base/16_5exists_nonexists.md b/tests/docs/base/16_5exists_nonexists.md new file mode 100644 index 0000000..c556883 --- /dev/null +++ b/tests/docs/base/16_5exists_nonexists.md @@ -0,0 +1,37 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/01-base.yml + +```yaml +--- +version: '1.1' +var2: + description: a new variable + exists: false + default: yes +``` +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: no # a variable +``` +# Variables for "rougail" + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: no | +| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A new variable.
**Default**: yes | + + +# Example with all variables modifiable + +```yaml +--- +rougail: + var1: no + var2: yes +``` diff --git a/tests/docs/base/16_5exists_redefine.adoc b/tests/docs/base/16_5exists_redefine.adoc new file mode 100644 index 0000000..04d36a1 --- /dev/null +++ b/tests/docs/base/16_5exists_redefine.adoc @@ -0,0 +1,25 @@ +== 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 +---- diff --git a/tests/docs/base/16_5exists_redefine.md b/tests/docs/base/16_5exists_redefine.md new file mode 100644 index 0000000..40f84ee --- /dev/null +++ b/tests/docs/base/16_5exists_redefine.md @@ -0,0 +1,29 @@ +--- +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 +``` diff --git a/tests/docs/base/16_5redefine_calculation.adoc b/tests/docs/base/16_5redefine_calculation.adoc new file mode 100644 index 0000000..214230c --- /dev/null +++ b/tests/docs/base/16_5redefine_calculation.adoc @@ -0,0 +1,44 @@ +== dictionaries/rougail/01-base.yml + +[,yaml] +---- +version: '1.1' +variable: + redefine: true + default: + type: jinja + jinja: yes + description: returns yes +---- +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +variable: + description: a variable + default: + type: jinja + jinja: no + description: returns no +---- +== Variables for "rougail" + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**rougail.variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A variable. + +**Default**: returns yes. +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +rougail: + variable: yes +---- diff --git a/tests/docs/base/16_5redefine_calculation.md b/tests/docs/base/16_5redefine_calculation.md new file mode 100644 index 0000000..4c6f78a --- /dev/null +++ b/tests/docs/base/16_5redefine_calculation.md @@ -0,0 +1,42 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/01-base.yml + +```yaml +--- +version: '1.1' +variable: + redefine: true + default: + type: jinja + jinja: yes + description: returns yes +``` +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +variable: + description: a variable + default: + type: jinja + jinja: no + description: returns no +``` +# Variables for "rougail" + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: returns yes. | + + +# Example with all variables modifiable + +```yaml +--- +rougail: + variable: yes +``` diff --git a/tests/docs/base/16_5redefine_choice.adoc b/tests/docs/base/16_5redefine_choice.adoc new file mode 100644 index 0000000..4f80ab8 --- /dev/null +++ b/tests/docs/base/16_5redefine_choice.adoc @@ -0,0 +1,53 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +variable: + description: a variable + choices: + - a + - b + - c +---- +== dictionaries/rougail/01-redefine.yml + +[,yaml] +---- +version: '1.0' +variable: + redefine: true + choices: + - a + - b +---- +== Variables for "rougail" + +[cols="105a,105a",options="header"] +|==== +| Variable | Description +| +**rougail.variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `basic` `mandatory` | +A variable. + +**Choices**: + +* a +* b +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +rougail: + variable: a_choice +---- +== Example with all variables modifiable + +[,yaml] +---- +rougail: + variable: a_choice +---- diff --git a/tests/docs/base/16_5redefine_choice.md b/tests/docs/base/16_5redefine_choice.md new file mode 100644 index 0000000..7a03911 --- /dev/null +++ b/tests/docs/base/16_5redefine_choice.md @@ -0,0 +1,48 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +variable: + description: a variable + choices: + - a + - b + - c +``` +# dictionaries/rougail/01-redefine.yml + +```yaml +--- +version: '1.0' +variable: + redefine: true + choices: + - a + - b +``` +# Variables for "rougail" + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.variable**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable.
**Choices**:
- a
- b | + + +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + variable: a_choice +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + variable: a_choice +``` diff --git a/tests/docs/base/16_5redefine_default.adoc b/tests/docs/base/16_5redefine_default.adoc new file mode 100644 index 0000000..eda78fc --- /dev/null +++ b/tests/docs/base/16_5redefine_default.adoc @@ -0,0 +1,38 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +variable: + description: a variable + default: no +---- +== dictionaries/rougail/01-redefine.yml + +[,yaml] +---- +version: '1.1' +variable: + redefine: true + default: yes +---- +== Variables for "rougail" + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**rougail.variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A variable. + +**Default**: yes +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +rougail: + variable: yes +---- diff --git a/tests/docs/base/16_5redefine_default.md b/tests/docs/base/16_5redefine_default.md new file mode 100644 index 0000000..8b51d53 --- /dev/null +++ b/tests/docs/base/16_5redefine_default.md @@ -0,0 +1,36 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +variable: + description: a variable + default: no +``` +# dictionaries/rougail/01-redefine.yml + +```yaml +--- +version: '1.1' +variable: + redefine: true + default: yes +``` +# Variables for "rougail" + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: yes | + + +# Example with all variables modifiable + +```yaml +--- +rougail: + variable: yes +``` diff --git a/tests/docs/base/16_5redefine_default_calculation.adoc b/tests/docs/base/16_5redefine_default_calculation.adoc new file mode 100644 index 0000000..7a5439f --- /dev/null +++ b/tests/docs/base/16_5redefine_default_calculation.adoc @@ -0,0 +1,46 @@ +== 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: + type: jinja + jinja: yes +---- +== Variables for "rougail" + +[cols="105a,105a",options="header"] +|==== +| Variable | Description +| +**rougail.variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A variable. +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +rougail: + variable: example +---- +== Example with all variables modifiable + +[,yaml] +---- +rougail: + variable: example +---- diff --git a/tests/docs/base/16_5redefine_default_calculation.md b/tests/docs/base/16_5redefine_default_calculation.md new file mode 100644 index 0000000..cc541e3 --- /dev/null +++ b/tests/docs/base/16_5redefine_default_calculation.md @@ -0,0 +1,45 @@ +--- +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: + type: jinja + jinja: yes +``` +# Variables for "rougail" + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | + + +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + variable: example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + variable: example +``` diff --git a/tests/docs/base/16_5redefine_family.adoc b/tests/docs/base/16_5redefine_family.adoc new file mode 100644 index 0000000..46dc599 --- /dev/null +++ b/tests/docs/base/16_5redefine_family.adoc @@ -0,0 +1,49 @@ +== dictionaries/rougail/01-base.yml + +[,yaml] +---- +version: '1.1' +family: + redefine: true + description: new description +---- +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +family: # a family + variable: # a variable +---- +== Variables for "rougail" + +=== new description + +`basic` + +[cols="105a,105a",options="header"] +|==== +| Variable | Description +| +**rougail.family.variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A variable. +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +rougail: + family: + variable: example +---- +== Example with all variables modifiable + +[,yaml] +---- +rougail: + family: + variable: example +---- diff --git a/tests/docs/base/16_5redefine_family.md b/tests/docs/base/16_5redefine_family.md new file mode 100644 index 0000000..f15399b --- /dev/null +++ b/tests/docs/base/16_5redefine_family.md @@ -0,0 +1,48 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/01-base.yml + +```yaml +--- +version: '1.1' +family: + redefine: true + description: new description +``` +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +family: # a family + variable: # a variable +``` +# Variables for "rougail" + +## new description + +`basic` + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.family.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | + + +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + family: + variable: example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + family: + variable: example +``` diff --git a/tests/docs/base/16_5redefine_help.adoc b/tests/docs/base/16_5redefine_help.adoc new file mode 100644 index 0000000..a6f1800 --- /dev/null +++ b/tests/docs/base/16_5redefine_help.adoc @@ -0,0 +1,60 @@ +== dictionaries/rougail/01-base.yml + +[,yaml] +---- +version: '1.1' +family: + redefine: true + help: redefine help family ok + variable: + redefine: true + help: redefine help ok +---- +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +family: + description: a family + help: redefine help family + variable: + description: redefine help + help: redefine help +---- +== Variables for "rougail" + +=== a family + +`basic` + + +Redefine help family ok. + +[cols="105a,105a",options="header"] +|==== +| Variable | Description +| +**rougail.family.variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +Redefine help. + +Redefine help ok. +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +rougail: + family: + variable: example +---- +== Example with all variables modifiable + +[,yaml] +---- +rougail: + family: + variable: example +---- diff --git a/tests/docs/base/16_5redefine_help.md b/tests/docs/base/16_5redefine_help.md new file mode 100644 index 0000000..c5b2ea1 --- /dev/null +++ b/tests/docs/base/16_5redefine_help.md @@ -0,0 +1,58 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/01-base.yml + +```yaml +--- +version: '1.1' +family: + redefine: true + help: redefine help family ok + variable: + redefine: true + help: redefine help ok +``` +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +family: + description: a family + help: redefine help family + variable: + description: redefine help + help: redefine help +``` +# Variables for "rougail" + +## a family + +`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. | + + +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + family: + variable: example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + family: + variable: example +``` diff --git a/tests/docs/base/16_5redefine_hidden.adoc b/tests/docs/base/16_5redefine_hidden.adoc new file mode 100644 index 0000000..e484541 --- /dev/null +++ b/tests/docs/base/16_5redefine_hidden.adoc @@ -0,0 +1,16 @@ +== 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 +---- diff --git a/tests/docs/base/16_5redefine_hidden.md b/tests/docs/base/16_5redefine_hidden.md new file mode 100644 index 0000000..d0b8ac8 --- /dev/null +++ b/tests/docs/base/16_5redefine_hidden.md @@ -0,0 +1,20 @@ +--- +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 +``` diff --git a/tests/docs/base/16_5redefine_multi.adoc b/tests/docs/base/16_5redefine_multi.adoc new file mode 100644 index 0000000..3fd8033 --- /dev/null +++ b/tests/docs/base/16_5redefine_multi.adoc @@ -0,0 +1,43 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +variable: + description: a variable + default: non +---- +== dictionaries/rougail/01-redefine.yml + +[,yaml] +---- +version: '1.1' +variable: + redefine: true + multi: true + default: + - non +---- +== Variables for "rougail" + +[cols="128a,128a",options="header"] +|==== +| Variable | Description +| +**rougail.variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +A variable. + +**Default**: + +* non +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +rougail: + variable: + - non +---- diff --git a/tests/docs/base/16_5redefine_multi.md b/tests/docs/base/16_5redefine_multi.md new file mode 100644 index 0000000..9f0c9c6 --- /dev/null +++ b/tests/docs/base/16_5redefine_multi.md @@ -0,0 +1,39 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +variable: + description: a variable + default: non +``` +# dictionaries/rougail/01-redefine.yml + +```yaml +--- +version: '1.1' +variable: + redefine: true + multi: true + default: + - non +``` +# Variables for "rougail" + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A variable.
**Default**:
- non | + + +# Example with all variables modifiable + +```yaml +--- +rougail: + variable: + - non +``` diff --git a/tests/docs/base/16_5redefine_remove_disable_calculation.adoc b/tests/docs/base/16_5redefine_remove_disable_calculation.adoc new file mode 100644 index 0000000..9bafb69 --- /dev/null +++ b/tests/docs/base/16_5redefine_remove_disable_calculation.adoc @@ -0,0 +1,58 @@ +== 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: + type: jinja + jinja: | + {% if _.condition == "yes" %} + true + {% else %} + false + {% endif %} +---- +== Variables for "rougail" + +[cols="105a,105a",options="header"] +|==== +| Variable | Description +| +**rougail.condition** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A condition. + +**Default**: no +| +**rougail.variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A variable. +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +rougail: + variable: example +---- +== Example with all variables modifiable + +[,yaml] +---- +rougail: + condition: no + variable: example +---- diff --git a/tests/docs/base/16_5redefine_remove_disable_calculation.md b/tests/docs/base/16_5redefine_remove_disable_calculation.md new file mode 100644 index 0000000..b3a83ad --- /dev/null +++ b/tests/docs/base/16_5redefine_remove_disable_calculation.md @@ -0,0 +1,53 @@ +--- +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: + type: jinja + jinja: | + {% if _.condition == "yes" %} + true + {% else %} + 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. | + + +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + variable: example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + condition: no + variable: example +``` diff --git a/tests/docs/base/16_5test_redefine.adoc b/tests/docs/base/16_5test_redefine.adoc new file mode 100644 index 0000000..af9e5f6 --- /dev/null +++ b/tests/docs/base/16_5test_redefine.adoc @@ -0,0 +1,75 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +var1: no # a first variable +var2: + description: a second variable + test: + - test + default: non +var3: + description: a third variable + test: + - test +---- +== dictionaries/rougail/10-base.yml + +[,yaml] +---- +version: '1.1' +var1: + redefine: true + test: + - test1 +var2: + redefine: true + test: + - test1 +var3: + redefine: true + test: +---- +== Variables for "rougail" + +[cols="105a,105a",options="header"] +|==== +| Variable | Description +| +**rougail.var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A first variable. + +**Default**: no + +**Example**: test1 +| +**rougail.var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A second variable. + +**Default**: non + +**Example**: test1 +| +**rougail.var3** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A third variable. +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +rougail: + var1: test1 + var2: test1 + var3: example +---- +== Example with all variables modifiable + +[,yaml] +---- +rougail: + var1: test1 + var2: test1 + var3: example +---- diff --git a/tests/docs/base/16_5test_redefine.md b/tests/docs/base/16_5test_redefine.md new file mode 100644 index 0000000..81a171d --- /dev/null +++ b/tests/docs/base/16_5test_redefine.md @@ -0,0 +1,64 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: no # a first variable +var2: + description: a second variable + test: + - test + default: non +var3: + description: a third variable + test: + - test +``` +# dictionaries/rougail/10-base.yml + +```yaml +--- +version: '1.1' +var1: + redefine: true + test: + - test1 +var2: + redefine: true + test: + - test1 +var3: + redefine: true + test: +``` +# Variables for "rougail" + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **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. | + + +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + var1: test1 + var2: test1 + var3: example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var1: test1 + var2: test1 + var3: example +``` diff --git a/tests/docs/base/16_6choice_redefine.adoc b/tests/docs/base/16_6choice_redefine.adoc new file mode 100644 index 0000000..d7d24ce --- /dev/null +++ b/tests/docs/base/16_6choice_redefine.adoc @@ -0,0 +1,48 @@ +== dictionaries/rougail/01-base.yml + +[,yaml] +---- +version: '1.0' +var: + redefine: true + choices: + - a + - c +---- +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.0' +var: + type: choice + description: A choice + default: c + choices: + - a + - b + - c +---- +== Variables for "rougail" + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**rougail.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` `mandatory` | +A choice. + +**Choices**: + +* a +* c ← (default) +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +rougail: + var: c +---- diff --git a/tests/docs/base/16_6choice_redefine.md b/tests/docs/base/16_6choice_redefine.md new file mode 100644 index 0000000..5c154f7 --- /dev/null +++ b/tests/docs/base/16_6choice_redefine.md @@ -0,0 +1,43 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/01-base.yml + +```yaml +--- +version: '1.0' +var: + redefine: true + choices: + - a + - c +``` +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.0' +var: + type: choice + description: A choice + default: c + choices: + - a + - b + - c +``` +# Variables for "rougail" + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A choice.
**Choices**:
- a
- c ← (default) | + + +# Example with all variables modifiable + +```yaml +--- +rougail: + var: c +``` diff --git a/tests/docs/base/16exists_exists.adoc b/tests/docs/base/16exists_exists.adoc new file mode 100644 index 0000000..e11c21f --- /dev/null +++ b/tests/docs/base/16exists_exists.adoc @@ -0,0 +1,43 @@ +== dictionaries/rougail/01-base.yml + +[,yaml] +---- +version: '1.1' +var: + description: New description + exists: false +---- +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +var: + description: Description +---- +== Variables for "rougail" + +[cols="105a,105a",options="header"] +|==== +| Variable | Description +| +**rougail.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +Description. +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +rougail: + var: example +---- +== Example with all variables modifiable + +[,yaml] +---- +rougail: + var: example +---- diff --git a/tests/docs/base/16exists_exists.md b/tests/docs/base/16exists_exists.md new file mode 100644 index 0000000..419b752 --- /dev/null +++ b/tests/docs/base/16exists_exists.md @@ -0,0 +1,42 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/01-base.yml + +```yaml +--- +version: '1.1' +var: + description: New description + exists: false +``` +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: + description: Description +``` +# Variables for "rougail" + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | Description. | + + +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + var: example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var: example +``` diff --git a/tests/docs/base/17_5redefine_leadership.adoc b/tests/docs/base/17_5redefine_leadership.adoc new file mode 100644 index 0000000..3e7fb3c --- /dev/null +++ b/tests/docs/base/17_5redefine_leadership.adoc @@ -0,0 +1,19 @@ +== 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: [] # a leader + follower: # a follower +---- diff --git a/tests/docs/base/17_5redefine_leadership.md b/tests/docs/base/17_5redefine_leadership.md new file mode 100644 index 0000000..6890c87 --- /dev/null +++ b/tests/docs/base/17_5redefine_leadership.md @@ -0,0 +1,23 @@ +--- +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: [] # a leader + follower: # a follower +``` diff --git a/tests/docs/base/20_0empty_family.adoc b/tests/docs/base/20_0empty_family.adoc new file mode 100644 index 0000000..2bf432c --- /dev/null +++ b/tests/docs/base/20_0empty_family.adoc @@ -0,0 +1,8 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.0' +my_family: + type: family +---- diff --git a/tests/docs/base/20_0empty_family.md b/tests/docs/base/20_0empty_family.md new file mode 100644 index 0000000..d61994c --- /dev/null +++ b/tests/docs/base/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/base/20_0family_append.adoc b/tests/docs/base/20_0family_append.adoc new file mode 100644 index 0000000..5a5ece4 --- /dev/null +++ b/tests/docs/base/20_0family_append.adoc @@ -0,0 +1,57 @@ +== dictionaries/rougail/01-base.yml + +[,yaml] +---- +version: '1.1' +family: + var2: + description: The second variable +---- +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +family: + description: A family + var1: + description: The first variable +---- +== Variables for "rougail" + +=== A family + +`basic` + +[cols="105a,105a",options="header"] +|==== +| Variable | Description +| +**rougail.family.var1** + +`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. +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +rougail: + family: + var1: example + var2: example +---- +== Example with all variables modifiable + +[,yaml] +---- +rougail: + family: + var1: example + var2: example +---- diff --git a/tests/docs/base/20_0family_append.md b/tests/docs/base/20_0family_append.md new file mode 100644 index 0000000..f926f23 --- /dev/null +++ b/tests/docs/base/20_0family_append.md @@ -0,0 +1,53 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/01-base.yml + +```yaml +--- +version: '1.1' +family: + var2: + description: The second variable +``` +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +family: + description: A family + var1: + description: The first variable +``` +# Variables for "rougail" + +## A family + +`basic` + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.family.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The first variable. | +| **rougail.family.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The second variable. | + + +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + family: + var1: example + var2: example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + family: + var1: example + var2: example +``` diff --git a/tests/docs/base/20_0family_underscore.adoc b/tests/docs/base/20_0family_underscore.adoc new file mode 100644 index 0000000..d7798d8 --- /dev/null +++ b/tests/docs/base/20_0family_underscore.adoc @@ -0,0 +1,37 @@ +== 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: basic + _hidden: true + _disabled: true + type: + description: a type family + type: family + my_variable: + description: + description: This is a other great family + my_variable: + help: + description: a help family + help: This is a other great family + my_variable: + mode: + description: a mode family + mode: advanced + my_variable: + mandatory: false + hidden: + description: an hidden family + hidden: true + my_variable: + disabled: + description: an disabled family + disabled: true + my_variable: +---- diff --git a/tests/docs/base/20_0family_underscore.md b/tests/docs/base/20_0family_underscore.md new file mode 100644 index 0000000..c580bd7 --- /dev/null +++ b/tests/docs/base/20_0family_underscore.md @@ -0,0 +1,41 @@ +--- +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: basic + _hidden: true + _disabled: true + type: + description: a type family + type: family + my_variable: + description: + description: This is a other great family + my_variable: + help: + description: a help family + help: This is a other great family + my_variable: + mode: + description: a mode family + mode: advanced + my_variable: + mandatory: false + hidden: + description: an hidden family + hidden: true + my_variable: + disabled: + description: an disabled family + disabled: true + my_variable: +``` diff --git a/tests/docs/base/20_0multi_family.adoc b/tests/docs/base/20_0multi_family.adoc new file mode 100644 index 0000000..6b271e2 --- /dev/null +++ b/tests/docs/base/20_0multi_family.adoc @@ -0,0 +1,40 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +family: # a family + subfamily: # a sub family + variable: + description: a variable + mandatory: false +---- +== Variables for "rougail" + +=== a family + +`standard` + +==== a sub family + +`standard` + +[cols="96a,96a",options="header"] +|==== +| Variable | Description +| +**rougail.family.subfamily.variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | +A variable. +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +rougail: + family: + subfamily: + variable: example +---- diff --git a/tests/docs/base/20_0multi_family.md b/tests/docs/base/20_0multi_family.md new file mode 100644 index 0000000..00b1e5d --- /dev/null +++ b/tests/docs/base/20_0multi_family.md @@ -0,0 +1,39 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +family: # a family + subfamily: # a sub family + variable: + description: a variable + mandatory: false +``` +# Variables for "rougail" + +## a family + +`standard` + +### a sub family + +`standard` + +| Variable                                                                                       | Description                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.family.subfamily.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A variable. | + + +# Example with all variables modifiable + +```yaml +--- +rougail: + family: + subfamily: + variable: example +``` diff --git a/tests/docs/base/20_0multi_family_basic.adoc b/tests/docs/base/20_0multi_family_basic.adoc new file mode 100644 index 0000000..d3facb0 --- /dev/null +++ b/tests/docs/base/20_0multi_family_basic.adoc @@ -0,0 +1,47 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +family: # a family + subfamily: # a sub family + variable: # a variable +---- +== Variables for "rougail" + +=== a family + +`basic` + +==== a sub family + +`basic` + +[cols="105a,105a",options="header"] +|==== +| Variable | Description +| +**rougail.family.subfamily.variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A variable. +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +rougail: + family: + subfamily: + variable: example +---- +== Example with all variables modifiable + +[,yaml] +---- +rougail: + family: + subfamily: + variable: example +---- diff --git a/tests/docs/base/20_0multi_family_basic.md b/tests/docs/base/20_0multi_family_basic.md new file mode 100644 index 0000000..0f96847 --- /dev/null +++ b/tests/docs/base/20_0multi_family_basic.md @@ -0,0 +1,46 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +family: # a family + subfamily: # a sub family + variable: # a variable +``` +# Variables for "rougail" + +## a family + +`basic` + +### a sub family + +`basic` + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.family.subfamily.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | + + +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + family: + subfamily: + variable: example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + family: + subfamily: + variable: example +``` diff --git a/tests/docs/base/20_0multi_family_expert.adoc b/tests/docs/base/20_0multi_family_expert.adoc new file mode 100644 index 0000000..b5495aa --- /dev/null +++ b/tests/docs/base/20_0multi_family_expert.adoc @@ -0,0 +1,13 @@ +== 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/base/20_0multi_family_expert.md b/tests/docs/base/20_0multi_family_expert.md new file mode 100644 index 0000000..1340984 --- /dev/null +++ b/tests/docs/base/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/base/20_0multi_family_order.adoc b/tests/docs/base/20_0multi_family_order.adoc new file mode 100644 index 0000000..407aa71 --- /dev/null +++ b/tests/docs/base/20_0multi_family_order.adoc @@ -0,0 +1,83 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +variable: # a variable +family: # a family + variable1: # a first variable + subfamily: # a sub family + variable: # a variable + variable2: # a second variable +---- +== Variables for "rougail" + +[cols="105a,105a",options="header"] +|==== +| Variable | Description +| +**rougail.variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A variable. +|==== + +=== a family + +`basic` + +[cols="105a,105a",options="header"] +|==== +| Variable | Description +| +**rougail.family.variable1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A first variable. +|==== + +==== a sub family + +`basic` + +[cols="105a,105a",options="header"] +|==== +| Variable | Description +| +**rougail.family.subfamily.variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A variable. +|==== + +[cols="105a,105a",options="header"] +|==== +| Variable | Description +| +**rougail.family.variable2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A second variable. +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +rougail: + variable: example + family: + variable1: example + subfamily: + variable: example + variable2: example +---- +== Example with all variables modifiable + +[,yaml] +---- +rougail: + variable: example + family: + variable1: example + subfamily: + variable: example + variable2: example +---- diff --git a/tests/docs/base/20_0multi_family_order.md b/tests/docs/base/20_0multi_family_order.md new file mode 100644 index 0000000..834d2f5 --- /dev/null +++ b/tests/docs/base/20_0multi_family_order.md @@ -0,0 +1,67 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +variable: # a variable +family: # a family + variable1: # a first variable + subfamily: # a sub family + variable: # a variable + variable2: # a second variable +``` +# Variables for "rougail" + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | + +## a family + +`basic` + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.family.variable1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A first variable. | + +### a sub family + +`basic` + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.family.subfamily.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.family.variable2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A second variable. | + + +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + variable: example + family: + variable1: example + subfamily: + variable: example + variable2: example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + variable: example + family: + variable1: example + subfamily: + variable: example + variable2: example +``` diff --git a/tests/docs/base/20_0validators_differ_redefine.adoc b/tests/docs/base/20_0validators_differ_redefine.adoc new file mode 100644 index 0000000..f93c0e8 --- /dev/null +++ b/tests/docs/base/20_0validators_differ_redefine.adoc @@ -0,0 +1,66 @@ +== dictionaries/rougail/01-base.yml + +[,yaml] +---- +version: '1.1' +var3: + redefine: true + validators: + - type: jinja + 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 + validators: + - type: jinja + jinja: | + {% if _.var3 == _.var1 %} + var3 must be different than var1 + {% endif %} + description: var3 must be different than var1 +---- +== Variables for "rougail" + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**rougail.var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A first variable. + +**Default**: no +| +**rougail.var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A second variable. + +**Default**: no +| +**rougail.var3** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A third variable. + +**Validator**: var3 must be different than var2. + +**Default**: yes +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +rougail: + var1: no + var2: no + var3: yes +---- diff --git a/tests/docs/base/20_0validators_differ_redefine.md b/tests/docs/base/20_0validators_differ_redefine.md new file mode 100644 index 0000000..613f860 --- /dev/null +++ b/tests/docs/base/20_0validators_differ_redefine.md @@ -0,0 +1,55 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/01-base.yml + +```yaml +--- +version: '1.1' +var3: + redefine: true + validators: + - type: jinja + 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 + validators: + - type: jinja + jinja: | + {% if _.var3 == _.var1 %} + var3 must be different than var1 + {% endif %} + description: var3 must be different than var1 +``` +# Variables for "rougail" + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A first variable.
**Default**: no | +| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second variable.
**Default**: no | +| **rougail.var3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A third variable.
**Validator**: var3 must be different than var2.
**Default**: yes | + + +# Example with all variables modifiable + +```yaml +--- +rougail: + var1: no + var2: no + var3: yes +``` diff --git a/tests/docs/base/20_1empty_subfamily.adoc b/tests/docs/base/20_1empty_subfamily.adoc new file mode 100644 index 0000000..a830ac2 --- /dev/null +++ b/tests/docs/base/20_1empty_subfamily.adoc @@ -0,0 +1,9 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.0' +my_family: + my_sub_family: + type: family +---- diff --git a/tests/docs/base/20_1empty_subfamily.md b/tests/docs/base/20_1empty_subfamily.md new file mode 100644 index 0000000..f876681 --- /dev/null +++ b/tests/docs/base/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/base/20_9default_information_parent.adoc b/tests/docs/base/20_9default_information_parent.adoc new file mode 100644 index 0000000..b828150 --- /dev/null +++ b/tests/docs/base/20_9default_information_parent.adoc @@ -0,0 +1,53 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: 1.1 +family: + var1: # a first variable + var2: + description: a second variable + default: + type: information + information: test_information + variable: __.family +---- +== Variables for "rougail" + +=== rougail.family + +`basic` + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**rougail.family.var1** + +`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` | +A second variable. + +**Default**: value of the information. +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +rougail: + family: + var1: example + var2: example +---- +== Example with all variables modifiable + +[,yaml] +---- +rougail: + family: + var1: example + var2: example +---- diff --git a/tests/docs/base/20_9default_information_parent.md b/tests/docs/base/20_9default_information_parent.md new file mode 100644 index 0000000..c78d58a --- /dev/null +++ b/tests/docs/base/20_9default_information_parent.md @@ -0,0 +1,48 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: 1.1 +family: + var1: # a first variable + var2: + description: a second variable + default: + type: information + information: test_information + variable: __.family +``` +# Variables for "rougail" + +## rougail.family + +`basic` + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.family.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A first variable. | +| **rougail.family.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second variable.
**Default**: value of the information. | + + +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + family: + var1: example + var2: example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + family: + var1: example + var2: example +``` diff --git a/tests/docs/base/24_0family_hidden_condition.adoc b/tests/docs/base/24_0family_hidden_condition.adoc new file mode 100644 index 0000000..159e2aa --- /dev/null +++ b/tests/docs/base/24_0family_hidden_condition.adoc @@ -0,0 +1,62 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +condition: no # the variable use has condition +family: + description: possibly hidden family + hidden: + type: jinja + jinja: | + {% if rougail.condition == "yes" %} + condition is yes + {% endif %} + description: if condition is yes + var1: # a variable +---- +== Variables for "rougail" + +[cols="105a,105a",options="header"] +|==== +| Variable | Description +| +**rougail.condition** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +The variable use has condition. + +**Default**: no +|==== + +=== possibly hidden family + +`basic` _`hidden`_ + +**Hidden**: if condition is yes. + +[cols="105a,105a",options="header"] +|==== +| Variable | Description +| +**rougail.family.var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A variable. +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +rougail: + family: + var1: example +---- +== Example with all variables modifiable + +[,yaml] +---- +rougail: + condition: no + family: + var1: example +---- diff --git a/tests/docs/base/24_0family_hidden_condition.md b/tests/docs/base/24_0family_hidden_condition.md new file mode 100644 index 0000000..6768768 --- /dev/null +++ b/tests/docs/base/24_0family_hidden_condition.md @@ -0,0 +1,55 @@ +--- +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: + type: jinja + jinja: | + {% if rougail.condition == "yes" %} + condition is yes + {% endif %} + description: if condition is yes + var1: # a variable +``` +# Variables for "rougail" + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The variable use has condition.
**Default**: no | + +## possibly hidden family + +`basic` _`hidden`_ + +**Hidden**: if condition is yes. + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.family.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | + + +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + family: + var1: example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + condition: no + family: + var1: example +``` diff --git a/tests/docs/base/24_0family_hidden_condition_boolean.adoc b/tests/docs/base/24_0family_hidden_condition_boolean.adoc new file mode 100644 index 0000000..74a8aeb --- /dev/null +++ b/tests/docs/base/24_0family_hidden_condition_boolean.adoc @@ -0,0 +1,62 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +condition: false # a conditional variable +family: + description: a family + hidden: + type: jinja + jinja: | + {% if not rougail.condition %} + condition is false + {% endif %} + description: if not condition + variable: # a variable +---- +== Variables for "rougail" + +[cols="105a,105a",options="header"] +|==== +| Variable | Description +| +**rougail.condition** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | +A conditional variable. + +**Default**: False +|==== + +=== a family + +`basic` _`hidden`_ + +**Hidden**: if not condition. + +[cols="105a,105a",options="header"] +|==== +| Variable | Description +| +**rougail.family.variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A variable. +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +rougail: + family: + variable: example +---- +== Example with all variables modifiable + +[,yaml] +---- +rougail: + condition: false + family: + variable: example +---- diff --git a/tests/docs/base/24_0family_hidden_condition_boolean.md b/tests/docs/base/24_0family_hidden_condition_boolean.md new file mode 100644 index 0000000..72dc7e1 --- /dev/null +++ b/tests/docs/base/24_0family_hidden_condition_boolean.md @@ -0,0 +1,55 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +condition: false # a conditional variable +family: + description: a family + hidden: + type: jinja + jinja: | + {% if not rougail.condition %} + condition is false + {% endif %} + description: if not condition + variable: # a variable +``` +# Variables for "rougail" + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.condition**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A conditional variable.
**Default**: False | + +## a family + +`basic` _`hidden`_ + +**Hidden**: if not condition. + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.family.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | + + +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + family: + variable: example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + condition: false + family: + variable: example +``` diff --git a/tests/docs/base/24_0family_hidden_condition_sub_family.adoc b/tests/docs/base/24_0family_hidden_condition_sub_family.adoc new file mode 100644 index 0000000..039375d --- /dev/null +++ b/tests/docs/base/24_0family_hidden_condition_sub_family.adoc @@ -0,0 +1,69 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +condition: no # the variable use has condition +family: + description: possibly hidden family + hidden: + type: jinja + jinja: | + {% if _.condition == "yes" %} + condition is yes + {% endif %} + description: if condition is yes + subfamily: + var1: # a variable +---- +== Variables for "rougail" + +[cols="105a,105a",options="header"] +|==== +| Variable | Description +| +**rougail.condition** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +The variable use has condition. + +**Default**: no +|==== + +=== possibly hidden family + +`basic` _`hidden`_ + +**Hidden**: if condition is yes. + +==== rougail.family.subfamily + +`basic` + +[cols="105a,105a",options="header"] +|==== +| Variable | Description +| +**rougail.family.subfamily.var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A variable. +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +rougail: + family: + subfamily: + var1: example +---- +== Example with all variables modifiable + +[,yaml] +---- +rougail: + condition: no + family: + subfamily: + var1: example +---- diff --git a/tests/docs/base/24_0family_hidden_condition_sub_family.md b/tests/docs/base/24_0family_hidden_condition_sub_family.md new file mode 100644 index 0000000..091de6e --- /dev/null +++ b/tests/docs/base/24_0family_hidden_condition_sub_family.md @@ -0,0 +1,62 @@ +--- +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: + type: jinja + jinja: | + {% if _.condition == "yes" %} + condition is yes + {% endif %} + description: if condition is yes + subfamily: + var1: # a variable +``` +# Variables for "rougail" + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The variable use has condition.
**Default**: no | + +## possibly hidden family + +`basic` _`hidden`_ + +**Hidden**: if condition is yes. + +### rougail.family.subfamily + +`basic` + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.family.subfamily.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | + + +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + family: + subfamily: + var1: example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + condition: no + family: + subfamily: + var1: example +``` diff --git a/tests/docs/base/24_0family_hidden_condition_variable_sub_family.adoc b/tests/docs/base/24_0family_hidden_condition_variable_sub_family.adoc new file mode 100644 index 0000000..e309f7f --- /dev/null +++ b/tests/docs/base/24_0family_hidden_condition_variable_sub_family.adoc @@ -0,0 +1,65 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +condition: true # the variable use has condition +family: + description: possibly hidden family + hidden: + type: variable + variable: _.condition + subfamily: # a subfamily + var1: # a variable +---- +== Variables for "rougail" + +[cols="105a,105a",options="header"] +|==== +| Variable | Description +| +**rougail.condition** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | +The variable use has condition. + +**Default**: True +|==== + +=== possibly hidden family + +`basic` _`hidden`_ + +**Hidden**: when the variable "rougail.condition" has the value "True". + +==== a subfamily + +`basic` + +[cols="105a,105a",options="header"] +|==== +| Variable | Description +| +**rougail.family.subfamily.var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A variable. +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +rougail: + family: + subfamily: + var1: example +---- +== Example with all variables modifiable + +[,yaml] +---- +rougail: + condition: true + family: + subfamily: + var1: example +---- diff --git a/tests/docs/base/24_0family_hidden_condition_variable_sub_family.md b/tests/docs/base/24_0family_hidden_condition_variable_sub_family.md new file mode 100644 index 0000000..6ec1c23 --- /dev/null +++ b/tests/docs/base/24_0family_hidden_condition_variable_sub_family.md @@ -0,0 +1,58 @@ +--- +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: + type: variable + variable: _.condition + subfamily: # a subfamily + var1: # a variable +``` +# Variables for "rougail" + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.condition**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The variable use has condition.
**Default**: True | + +## possibly hidden family + +`basic` _`hidden`_ + +**Hidden**: when the variable "rougail.condition" has the value "True". + +### a subfamily + +`basic` + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.family.subfamily.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | + + +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + family: + subfamily: + var1: example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + condition: true + family: + subfamily: + var1: example +``` diff --git a/tests/docs/base/24_0family_hidden_condition_with_variable.adoc b/tests/docs/base/24_0family_hidden_condition_with_variable.adoc new file mode 100644 index 0000000..f4301fa --- /dev/null +++ b/tests/docs/base/24_0family_hidden_condition_with_variable.adoc @@ -0,0 +1,78 @@ +== 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: + type: jinja + jinja: | + {% if not rougail.condition1 %} + condition1 is false + {% endif %} + description: if condition1 is false + variable: + description: a variable + hidden: + type: jinja + jinja: | + {% if rougail.condition2 %} + condition2 is true + {% endif %} + description: if condition2 is false +---- +== Variables for "rougail" + +[cols="116a,116a",options="header"] +|==== +| Variable | Description +| +**rougail.condition1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | +A first conditional variable. + +**Default**: False +| +**rougail.condition2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | +A second conditional variable. + +**Default**: False +|==== + +=== a family + +`basic` _`hidden`_ + +**Hidden**: if condition1 is false. + +[cols="116a,116a",options="header"] +|==== +| Variable | Description +| +**rougail.family.variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` _`hidden`_ | +A variable. + +**Hidden**: if condition2 is false. +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +rougail: + family: + variable: example +---- +== Example with all variables modifiable + +[,yaml] +---- +rougail: + condition1: false + condition2: false + family: + variable: example +---- diff --git a/tests/docs/base/24_0family_hidden_condition_with_variable.md b/tests/docs/base/24_0family_hidden_condition_with_variable.md new file mode 100644 index 0000000..cafc4b4 --- /dev/null +++ b/tests/docs/base/24_0family_hidden_condition_with_variable.md @@ -0,0 +1,66 @@ +--- +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: + type: jinja + jinja: | + {% if not rougail.condition1 %} + condition1 is false + {% endif %} + description: if condition1 is false + variable: + description: a variable + hidden: + type: jinja + jinja: | + {% if rougail.condition2 %} + condition2 is true + {% endif %} + description: if condition2 is false +``` +# Variables for "rougail" + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.condition1**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A first conditional variable.
**Default**: False | +| **rougail.condition2**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second conditional variable.
**Default**: False | + +## a family + +`basic` _`hidden`_ + +**Hidden**: if condition1 is false. + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.family.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` _`hidden`_ | A variable.
**Hidden**: if condition2 is false. | + + +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + family: + variable: example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + condition1: false + condition2: false + family: + variable: example +``` diff --git a/tests/docs/base/24_0family_hidden_param_condition_sub_family.adoc b/tests/docs/base/24_0family_hidden_param_condition_sub_family.adoc new file mode 100644 index 0000000..ab22264 --- /dev/null +++ b/tests/docs/base/24_0family_hidden_param_condition_sub_family.adoc @@ -0,0 +1,73 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +condition: no # the variable use has condition +family: + description: possibly hidden family + hidden: + type: jinja + jinja: | + {% if condition == "yes" %} + condition is yes + {% endif %} + params: + condition: + type: variable + variable: _.condition + description: if condition is yes + sub_family: # a subfamily + var1: # a variable +---- +== Variables for "rougail" + +[cols="105a,105a",options="header"] +|==== +| Variable | Description +| +**rougail.condition** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +The variable use has condition. + +**Default**: no +|==== + +=== possibly hidden family + +`basic` _`hidden`_ + +**Hidden**: if condition is yes. + +==== a subfamily + +`basic` + +[cols="105a,105a",options="header"] +|==== +| Variable | Description +| +**rougail.family.sub_family.var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A variable. +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +rougail: + family: + sub_family: + var1: example +---- +== Example with all variables modifiable + +[,yaml] +---- +rougail: + condition: no + family: + sub_family: + var1: example +---- diff --git a/tests/docs/base/24_0family_hidden_param_condition_sub_family.md b/tests/docs/base/24_0family_hidden_param_condition_sub_family.md new file mode 100644 index 0000000..11a235b --- /dev/null +++ b/tests/docs/base/24_0family_hidden_param_condition_sub_family.md @@ -0,0 +1,66 @@ +--- +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: + type: jinja + jinja: | + {% if condition == "yes" %} + condition is yes + {% endif %} + params: + condition: + type: variable + variable: _.condition + description: if condition is yes + sub_family: # a subfamily + var1: # a variable +``` +# Variables for "rougail" + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The variable use has condition.
**Default**: no | + +## possibly hidden family + +`basic` _`hidden`_ + +**Hidden**: if condition is yes. + +### a subfamily + +`basic` + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.family.sub_family.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | + + +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + family: + sub_family: + var1: example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + condition: no + family: + sub_family: + var1: example +``` diff --git a/tests/docs/base/24_0family_mandatory_condition.adoc b/tests/docs/base/24_0family_mandatory_condition.adoc new file mode 100644 index 0000000..3e9e632 --- /dev/null +++ b/tests/docs/base/24_0family_mandatory_condition.adoc @@ -0,0 +1,42 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +condition: no # a condition +var: + description: a variable + mandatory: + type: jinja + jinja: | + {% if _.condition == "yes" %} + condition is yes + {% endif %} + description: only if rougail.condition has the value "yes" +---- +== Variables for "rougail" + +[cols="110a,110a",options="header"] +|==== +| Variable | Description +| +**rougail.condition** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A condition. + +**Default**: no +| +**rougail.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` _`mandatory`_ | +A variable. + +**Mandatory**: only if rougail.condition has the value "yes". +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +rougail: + condition: no + var: example +---- diff --git a/tests/docs/base/24_0family_mandatory_condition.md b/tests/docs/base/24_0family_mandatory_condition.md new file mode 100644 index 0000000..d0aa5af --- /dev/null +++ b/tests/docs/base/24_0family_mandatory_condition.md @@ -0,0 +1,36 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +condition: no # a condition +var: + description: a variable + mandatory: + type: jinja + jinja: | + {% if _.condition == "yes" %} + condition is yes + {% endif %} + description: only if rougail.condition has the value "yes" +``` +# Variables for "rougail" + +| 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". | + + +# Example with all variables modifiable + +```yaml +--- +rougail: + condition: no + var: example +``` diff --git a/tests/docs/base/24_0family_mandatory_condition_variable.adoc b/tests/docs/base/24_0family_mandatory_condition_variable.adoc new file mode 100644 index 0000000..d345263 --- /dev/null +++ b/tests/docs/base/24_0family_mandatory_condition_variable.adoc @@ -0,0 +1,38 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +condition: true # a condition +var: + description: a variable + mandatory: + type: variable + variable: _.condition +---- +== Variables for "rougail" + +[cols="110a,110a",options="header"] +|==== +| Variable | Description +| +**rougail.condition** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | +A condition. + +**Default**: True +| +**rougail.var** + +`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". +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +rougail: + condition: true + var: example +---- diff --git a/tests/docs/base/24_0family_mandatory_condition_variable.md b/tests/docs/base/24_0family_mandatory_condition_variable.md new file mode 100644 index 0000000..abc5030 --- /dev/null +++ b/tests/docs/base/24_0family_mandatory_condition_variable.md @@ -0,0 +1,32 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +condition: true # a condition +var: + description: a variable + mandatory: + type: variable + variable: _.condition +``` +# 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". | + + +# Example with all variables modifiable + +```yaml +--- +rougail: + condition: true + var: example +``` diff --git a/tests/docs/base/40_0leadership.adoc b/tests/docs/base/40_0leadership.adoc new file mode 100644 index 0000000..be69ee7 --- /dev/null +++ b/tests/docs/base/40_0leadership.adoc @@ -0,0 +1,51 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +leader: + description: a leadership + type: leadership + leader: + description: a leader + multi: true + follower1: # a follower + follower2: # an other follower +---- +== Variables for "rougail" + +=== a leadership + +`basic` + + +This family contains lists of variable blocks. + +[cols="105a,105a",options="header"] +|==== +| Variable | Description +| +**rougail.leader.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. +| +**rougail.leader.follower2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +An other follower. +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +rougail: + leader: + - leader: example + follower1: example + follower2: example +---- diff --git a/tests/docs/base/40_0leadership.md b/tests/docs/base/40_0leadership.md new file mode 100644 index 0000000..94e71d6 --- /dev/null +++ b/tests/docs/base/40_0leadership.md @@ -0,0 +1,44 @@ +--- +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 + follower1: # a follower + follower2: # an other follower +``` +# Variables for "rougail" + +## a leadership + +`basic` + + +This family contains lists of variable blocks. + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.leader.leader**
[`string`](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. | + + +# Example with all variables modifiable + +```yaml +--- +rougail: + leader: + - leader: example + follower1: example + follower2: example +``` diff --git a/tests/docs/base/40_0leadership_diff_name.adoc b/tests/docs/base/40_0leadership_diff_name.adoc new file mode 100644 index 0000000..f4987c0 --- /dev/null +++ b/tests/docs/base/40_0leadership_diff_name.adoc @@ -0,0 +1,49 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +leadership: + description: a leadership + type: leadership + leader: [] # a leader + follower1: # a follower + follower2: # an other follower +---- +== Variables for "rougail" + +=== a leadership + +`basic` + + +This family contains lists of variable blocks. + +[cols="105a,105a",options="header"] +|==== +| Variable | Description +| +**rougail.leadership.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. +| +**rougail.leadership.follower2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +An other follower. +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +rougail: + leadership: + - leader: example + follower1: example + follower2: example +---- diff --git a/tests/docs/base/40_0leadership_diff_name.md b/tests/docs/base/40_0leadership_diff_name.md new file mode 100644 index 0000000..f0e2d2c --- /dev/null +++ b/tests/docs/base/40_0leadership_diff_name.md @@ -0,0 +1,42 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +leadership: + description: a leadership + type: leadership + leader: [] # a leader + follower1: # a follower + follower2: # an other follower +``` +# Variables for "rougail" + +## a leadership + +`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. | + + +# Example with all variables modifiable + +```yaml +--- +rougail: + leadership: + - leader: example + follower1: example + follower2: example +``` diff --git a/tests/docs/base/40_0leadership_empty.adoc b/tests/docs/base/40_0leadership_empty.adoc new file mode 100644 index 0000000..eadc65f --- /dev/null +++ b/tests/docs/base/40_0leadership_empty.adoc @@ -0,0 +1,8 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +empty_leader: + type: leadership +---- diff --git a/tests/docs/base/40_0leadership_empty.md b/tests/docs/base/40_0leadership_empty.md new file mode 100644 index 0000000..b7d0b8f --- /dev/null +++ b/tests/docs/base/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/base/40_0leadership_follower_default_calculation.adoc b/tests/docs/base/40_0leadership_follower_default_calculation.adoc new file mode 100644 index 0000000..eb5a8c8 --- /dev/null +++ b/tests/docs/base/40_0leadership_follower_default_calculation.adoc @@ -0,0 +1,57 @@ +== 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: + type: jinja + jinja: | + {{ _.follower1 }} + description: returns follower1 value +---- +== Variables for "rougail" + +=== a leadership + +`basic` + + +This family contains lists of variable blocks. + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**rougail.leader.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` | +A follower. + +**Default**: value +| +**rougail.leader.follower2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A second follower. + +**Default**: returns follower1 value. +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +rougail: + leader: + - leader: example + follower1: value + follower2: value +---- diff --git a/tests/docs/base/40_0leadership_follower_default_calculation.md b/tests/docs/base/40_0leadership_follower_default_calculation.md new file mode 100644 index 0000000..159a117 --- /dev/null +++ b/tests/docs/base/40_0leadership_follower_default_calculation.md @@ -0,0 +1,48 @@ +--- +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: + type: jinja + jinja: | + {{ _.follower1 }} + description: returns follower1 value +``` +# Variables for "rougail" + +## a leadership + +`basic` + + +This family contains lists of variable blocks. + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.leader.leader**
[`string`](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. | + + +# Example with all variables modifiable + +```yaml +--- +rougail: + leader: + - leader: example + follower1: value + follower2: value +``` diff --git a/tests/docs/base/40_0leadership_follower_default_submulti.adoc b/tests/docs/base/40_0leadership_follower_default_submulti.adoc new file mode 100644 index 0000000..248d31f --- /dev/null +++ b/tests/docs/base/40_0leadership_follower_default_submulti.adoc @@ -0,0 +1,66 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +leader: + description: a leadership + type: leadership + leader: # a leader + - leader + follower1: # a follower1 + - value + follower2: # a follower2 + - value1 + - value2 +---- +== Variables for "rougail" + +=== a leadership + +`standard` + + +This family contains lists of variable blocks. + +[cols="119a,119a",options="header"] +|==== +| Variable | Description +| +**rougail.leader.leader** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +A leader. + +**Default**: + +* leader +| +**rougail.leader.follower1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `multiple` | +A follower1. + +**Default**: + +* value +| +**rougail.leader.follower2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `multiple` | +A follower2. + +**Default**: + +* value1 +* value2 +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +rougail: + leader: + - leader: leader + follower1: + - value + follower2: + - value1 + - value2 +---- diff --git a/tests/docs/base/40_0leadership_follower_default_submulti.md b/tests/docs/base/40_0leadership_follower_default_submulti.md new file mode 100644 index 0000000..01b7b44 --- /dev/null +++ b/tests/docs/base/40_0leadership_follower_default_submulti.md @@ -0,0 +1,49 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +leader: + description: a leadership + type: leadership + leader: # a leader + - leader + follower1: # a follower1 + - value + follower2: # a follower2 + - value1 + - value2 +``` +# Variables for "rougail" + +## a leadership + +`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 | + + +# Example with all variables modifiable + +```yaml +--- +rougail: + leader: + - leader: leader + follower1: + - value + follower2: + - value1 + - value2 +``` diff --git a/tests/docs/base/40_0leadership_follower_default_submulti_calculation.adoc b/tests/docs/base/40_0leadership_follower_default_submulti_calculation.adoc new file mode 100644 index 0000000..35a0d33 --- /dev/null +++ b/tests/docs/base/40_0leadership_follower_default_submulti_calculation.adoc @@ -0,0 +1,65 @@ +== 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: + type: variable + variable: _.follower1 +---- +== Variables for "rougail" + +=== a leadership + +`standard` + + +This family contains lists of variable blocks. + +[cols="119a,119a",options="header"] +|==== +| Variable | Description +| +**rougail.leader.leader** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +The leader. + +**Default**: + +* leader +| +**rougail.leader.follower1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `multiple` | +The follower1. + +**Default**: + +* value +| +**rougail.leader.follower2** + +`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". +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +rougail: + leader: + - leader: leader + follower1: + - value + follower2: + - value +---- diff --git a/tests/docs/base/40_0leadership_follower_default_submulti_calculation.md b/tests/docs/base/40_0leadership_follower_default_submulti_calculation.md new file mode 100644 index 0000000..30ff924 --- /dev/null +++ b/tests/docs/base/40_0leadership_follower_default_submulti_calculation.md @@ -0,0 +1,51 @@ +--- +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: + type: variable + variable: _.follower1 +``` +# 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". | + + +# Example with all variables modifiable + +```yaml +--- +rougail: + leader: + - leader: leader + follower1: + - value + follower2: + - value +``` diff --git a/tests/docs/base/40_0leadership_follower_default_value.adoc b/tests/docs/base/40_0leadership_follower_default_value.adoc new file mode 100644 index 0000000..fd72282 --- /dev/null +++ b/tests/docs/base/40_0leadership_follower_default_value.adoc @@ -0,0 +1,47 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +leader: + description: a leadership + type: leadership + leader: + description: a leader + multi: true + mandatory: false + follower1: value # a follower with default value +---- +== Variables for "rougail" + +=== a leadership + +`standard` + + +This family contains lists of variable blocks. + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**rougail.leader.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` | +A follower with default value. + +**Default**: value +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +rougail: + leader: + - leader: example + follower1: value +---- diff --git a/tests/docs/base/40_0leadership_follower_default_value.md b/tests/docs/base/40_0leadership_follower_default_value.md new file mode 100644 index 0000000..08228ee --- /dev/null +++ b/tests/docs/base/40_0leadership_follower_default_value.md @@ -0,0 +1,42 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +leader: + description: a leadership + type: leadership + leader: + description: a leader + multi: true + mandatory: false + follower1: value # a follower with default value +``` +# Variables for "rougail" + +## a leadership + +`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 | + + +# Example with all variables modifiable + +```yaml +--- +rougail: + leader: + - leader: example + follower1: value +``` diff --git a/tests/docs/base/40_1leadership_append_follower.adoc b/tests/docs/base/40_1leadership_append_follower.adoc new file mode 100644 index 0000000..a4edb3f --- /dev/null +++ b/tests/docs/base/40_1leadership_append_follower.adoc @@ -0,0 +1,67 @@ +== dictionaries/rougail/01-base.yml + +[,yaml] +---- +version: '1.1' +leader: + follower3: + description: the follower3 +---- +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +leader: + description: a leadership + type: leadership + leader: + description: the leader + multi: true + follower1: + description: the follower1 + follower2: + description: the follower2 +---- +== Variables for "rougail" + +=== a leadership + +`basic` + + +This family contains lists of variable blocks. + +[cols="105a,105a",options="header"] +|==== +| Variable | Description +| +**rougail.leader.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. +| +**rougail.leader.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. +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +rougail: + leader: + - leader: example + follower1: example + follower2: example + follower3: example +---- diff --git a/tests/docs/base/40_1leadership_append_follower.md b/tests/docs/base/40_1leadership_append_follower.md new file mode 100644 index 0000000..b0f427d --- /dev/null +++ b/tests/docs/base/40_1leadership_append_follower.md @@ -0,0 +1,57 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/01-base.yml + +```yaml +--- +version: '1.1' +leader: + follower3: + description: the follower3 +``` +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +leader: + description: a leadership + type: leadership + leader: + description: the leader + multi: true + follower1: + description: the follower1 + follower2: + description: the follower2 +``` +# Variables for "rougail" + +## a leadership + +`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. | + + +# Example with all variables modifiable + +```yaml +--- +rougail: + leader: + - leader: example + follower1: example + follower2: example + follower3: example +``` diff --git a/tests/docs/base/40_2leadership_calculation_index.adoc b/tests/docs/base/40_2leadership_calculation_index.adoc new file mode 100644 index 0000000..18bdbaf --- /dev/null +++ b/tests/docs/base/40_2leadership_calculation_index.adoc @@ -0,0 +1,60 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +leader: + description: a leadership + type: leadership + leader: # a leader + - a + - b + - c + follower1: + description: a follower + type: number + default: + type: index +---- +== Variables for "rougail" + +=== a leadership + +`standard` + + +This family contains lists of variable blocks. + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**rougail.leader.leader** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +A leader. + +**Default**: + +* a +* b +* c +| +**rougail.leader.follower1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` | +A follower. + +**Default**: value of the index. +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +rougail: + leader: + - leader: a + follower1: 2 + - leader: b + follower1: 2 + - leader: c + follower1: 2 +---- diff --git a/tests/docs/base/40_2leadership_calculation_index.md b/tests/docs/base/40_2leadership_calculation_index.md new file mode 100644 index 0000000..ea29ff8 --- /dev/null +++ b/tests/docs/base/40_2leadership_calculation_index.md @@ -0,0 +1,50 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +leader: + description: a leadership + type: leadership + leader: # a leader + - a + - b + - c + follower1: + description: a follower + type: number + default: + type: index +``` +# Variables for "rougail" + +## a leadership + +`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**: value of the index. | + + +# Example with all variables modifiable + +```yaml +--- +rougail: + leader: + - leader: a + follower1: 2 + - leader: b + follower1: 2 + - leader: c + follower1: 2 +``` diff --git a/tests/docs/base/40_2leadership_calculation_param_index.adoc b/tests/docs/base/40_2leadership_calculation_param_index.adoc new file mode 100644 index 0000000..ba3b817 --- /dev/null +++ b/tests/docs/base/40_2leadership_calculation_param_index.adoc @@ -0,0 +1,65 @@ +== 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: + type: jinja + jinja: '{{ index }}' + params: + index: + type: index + description: returns index +---- +== Variables for "rougail" + +=== leadership + +`standard` + + +This family contains lists of variable blocks. + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**rougail.leader.leader** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +A leader. + +**Default**: + +* a +* b +* c +| +**rougail.leader.follower1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` | +A follower. + +**Default**: returns index. +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +rougail: + leader: + - leader: a + follower1: 2 + - leader: b + follower1: 2 + - leader: c + follower1: 2 +---- diff --git a/tests/docs/base/40_2leadership_calculation_param_index.md b/tests/docs/base/40_2leadership_calculation_param_index.md new file mode 100644 index 0000000..38a542b --- /dev/null +++ b/tests/docs/base/40_2leadership_calculation_param_index.md @@ -0,0 +1,55 @@ +--- +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: + type: jinja + jinja: '{{ index }}' + params: + index: + type: index + description: returns index +``` +# Variables for "rougail" + +## leadership + +`standard` + + +This family contains lists of variable blocks. + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A leader.
**Default**:
- a
- b
- c | +| **rougail.leader.follower1**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A follower.
**Default**: returns index. | + + +# Example with all variables modifiable + +```yaml +--- +rougail: + leader: + - leader: a + follower1: 2 + - leader: b + follower1: 2 + - leader: c + follower1: 2 +``` diff --git a/tests/docs/base/40_2leadership_leader_calculation.adoc b/tests/docs/base/40_2leadership_leader_calculation.adoc new file mode 100644 index 0000000..13f6b10 --- /dev/null +++ b/tests/docs/base/40_2leadership_leader_calculation.adoc @@ -0,0 +1,61 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +leader: + description: a leadership + type: leadership + leader: + description: a leader + multi: true + default: + type: jinja + jinja: | + val1 + val2 + description: returns val1 and val2 + follower1: # a first follower + follower2: # a second follower +---- +== Variables for "rougail" + +=== a leadership + +`basic` + + +This family contains lists of variable blocks. + +[cols="105a,105a",options="header"] +|==== +| Variable | Description +| +**rougail.leader.leader** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +A leader. + +**Default**: returns val1 and val2. +| +**rougail.leader.follower1** + +`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. +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +rougail: + leader: + - leader: val1 + follower1: example + follower2: example + - leader: val2 + follower1: example + follower2: example +---- diff --git a/tests/docs/base/40_2leadership_leader_calculation.md b/tests/docs/base/40_2leadership_leader_calculation.md new file mode 100644 index 0000000..10b3580 --- /dev/null +++ b/tests/docs/base/40_2leadership_leader_calculation.md @@ -0,0 +1,53 @@ +--- +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: + type: jinja + jinja: | + val1 + val2 + description: returns val1 and val2 + follower1: # a first follower + follower2: # a second follower +``` +# Variables for "rougail" + +## a leadership + +`basic` + + +This family contains lists of variable blocks. + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.leader.leader**
[`string`](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. | + + +# Example with all variables modifiable + +```yaml +--- +rougail: + leader: + - leader: val1 + follower1: example + follower2: example + - leader: val2 + follower1: example + follower2: example +``` diff --git a/tests/docs/base/40_6leadership_follower_multi.adoc b/tests/docs/base/40_6leadership_follower_multi.adoc new file mode 100644 index 0000000..d02c6c8 --- /dev/null +++ b/tests/docs/base/40_6leadership_follower_multi.adoc @@ -0,0 +1,62 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.0' +leadership: + description: A leadership + type: leadership + leader: + description: The leader + multi: true + follower1: + description: The first follower + multi: true + follower2: + description: The second follower + multi: true + default: + - value +---- +== Variables for "rougail" + +=== A leadership + +`basic` + + +This family contains lists of variable blocks. + +[cols="119a,119a",options="header"] +|==== +| 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 +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +rougail: + leadership: + - leader: example + follower1: + - example + follower2: + - value +---- diff --git a/tests/docs/base/40_6leadership_follower_multi.md b/tests/docs/base/40_6leadership_follower_multi.md new file mode 100644 index 0000000..01c7ecc --- /dev/null +++ b/tests/docs/base/40_6leadership_follower_multi.md @@ -0,0 +1,52 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.0' +leadership: + description: A leadership + type: leadership + leader: + description: The leader + multi: true + follower1: + description: The first follower + multi: true + follower2: + description: The second follower + multi: true + default: + - value +``` +# Variables for "rougail" + +## A leadership + +`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 | + + +# Example with all variables modifiable + +```yaml +--- +rougail: + leadership: + - leader: example + follower1: + - example + follower2: + - value +``` diff --git a/tests/docs/base/40_8calculation_boolean.adoc b/tests/docs/base/40_8calculation_boolean.adoc new file mode 100644 index 0000000..8cfed9c --- /dev/null +++ b/tests/docs/base/40_8calculation_boolean.adoc @@ -0,0 +1,70 @@ +== 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: + type: jinja + jinja: | + {% if _.bool %} + True + False + {% else %} + False + {% endif %} + description: a calculation +multi2: + description: a second multi variable + type: boolean + multi: true + default: + type: jinja + jinja: | + {% if not _.bool %} + True + False + {% else %} + False + {% endif %} + description: a calculation +---- +== Variables for "rougail" + +[cols="129a,129a",options="header"] +|==== +| Variable | Description +| +**rougail.bool** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | +A boolean variable. + +**Default**: False +| +**rougail.multi1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` `unique` `multiple` | +A first multi variable. + +**Default**: a calculation. +| +**rougail.multi2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` `unique` `multiple` | +A second multi variable. + +**Default**: a calculation. +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +rougail: + bool: false + multi1: + - false + multi2: + - true + - false +---- diff --git a/tests/docs/base/40_8calculation_boolean.md b/tests/docs/base/40_8calculation_boolean.md new file mode 100644 index 0000000..46f570c --- /dev/null +++ b/tests/docs/base/40_8calculation_boolean.md @@ -0,0 +1,60 @@ +--- +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: + type: jinja + jinja: | + {% if _.bool %} + True + False + {% else %} + False + {% endif %} + description: a calculation +multi2: + description: a second multi variable + type: boolean + multi: true + default: + type: jinja + jinja: | + {% if not _.bool %} + True + False + {% else %} + False + {% endif %} + description: a calculation +``` +# Variables for "rougail" + +| Variable                                                                                                                        | Description                                                                                                                     | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.bool**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A boolean variable.
**Default**: False | +| **rougail.multi1**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A first multi variable.
**Default**: a calculation. | +| **rougail.multi2**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A second multi variable.
**Default**: a calculation. | + + +# Example with all variables modifiable + +```yaml +--- +rougail: + bool: false + multi1: + - false + multi2: + - true + - false +``` diff --git a/tests/docs/base/40_8calculation_boolean_return_none.adoc b/tests/docs/base/40_8calculation_boolean_return_none.adoc new file mode 100644 index 0000000..6679d73 --- /dev/null +++ b/tests/docs/base/40_8calculation_boolean_return_none.adoc @@ -0,0 +1,50 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +var1: yes # a first variable +var2: + description: a second variable + type: boolean + default: + type: jinja + jinja: | + {% if rougail.var1 == 'no' %} + false + {% endif %} + description: return false if the value of var1 is "no" +---- +== Variables for "rougail" + +[cols="109a,109a",options="header"] +|==== +| Variable | Description +| +**rougail.var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A first variable. + +**Default**: yes +| +**rougail.var2** + +`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". +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +rougail: + var2: xxx +---- +== Example with all variables modifiable + +[,yaml] +---- +rougail: + var1: yes + var2: xxx +---- diff --git a/tests/docs/base/40_8calculation_boolean_return_none.md b/tests/docs/base/40_8calculation_boolean_return_none.md new file mode 100644 index 0000000..8487837 --- /dev/null +++ b/tests/docs/base/40_8calculation_boolean_return_none.md @@ -0,0 +1,44 @@ +--- +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: + type: jinja + jinja: | + {% if rougail.var1 == 'no' %} + false + {% endif %} + description: return false if the value of var1 is "no" +``` +# Variables for "rougail" + +| Variable                                                                                                    | Description                                                                                                 | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A first variable.
**Default**: yes | +| **rougail.var2**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second variable.
**Default**: return false if the value of var1 is "no". | + + +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + var2: xxx +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var1: yes + var2: xxx +``` diff --git a/tests/docs/base/40_8calculation_integer.adoc b/tests/docs/base/40_8calculation_integer.adoc new file mode 100644 index 0000000..1e2d84a --- /dev/null +++ b/tests/docs/base/40_8calculation_integer.adoc @@ -0,0 +1,55 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +bool: false # a boolean variable +int1: + description: first integer variable + type: number + default: + type: jinja + jinja: | + {% if rougail.bool %}1{% else %}2{% endif %} + description: if bool returns 1 otherwise return 2 +int2: + description: second integer variable + type: number + default: + type: jinja + jinja: | + {% if not rougail.bool %}3{% else %}4{% endif %} + description: if bool returns 3 otherwise return 4 +---- +== Variables for "rougail" + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**rougail.bool** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | +A boolean variable. + +**Default**: False +| +**rougail.int1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` | +First integer variable. + +**Default**: if bool returns 1 otherwise return 2. +| +**rougail.int2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` | +Second integer variable. + +**Default**: if bool returns 3 otherwise return 4. +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +rougail: + bool: false + int1: 2 + int2: 3 +---- diff --git a/tests/docs/base/40_8calculation_integer.md b/tests/docs/base/40_8calculation_integer.md new file mode 100644 index 0000000..ba102b4 --- /dev/null +++ b/tests/docs/base/40_8calculation_integer.md @@ -0,0 +1,45 @@ +--- +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: + type: jinja + jinja: | + {% if rougail.bool %}1{% else %}2{% endif %} + description: if bool returns 1 otherwise return 2 +int2: + description: second integer variable + type: number + default: + type: jinja + jinja: | + {% if not rougail.bool %}3{% else %}4{% endif %} + description: if bool returns 3 otherwise return 4 +``` +# Variables for "rougail" + +| 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. | + + +# Example with all variables modifiable + +```yaml +--- +rougail: + bool: false + int1: 2 + int2: 3 +``` diff --git a/tests/docs/base/40_8calculation_multi_variable.adoc b/tests/docs/base/40_8calculation_multi_variable.adoc new file mode 100644 index 0000000..eb2c83c --- /dev/null +++ b/tests/docs/base/40_8calculation_multi_variable.adoc @@ -0,0 +1,52 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +var: + description: a first variable + default: + - type: variable + variable: _.var2 + - type: variable + variable: _.var3 +var2: no # a second variable +var3: yes # a third variable +---- +== Variables for "rougail" + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**rougail.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +A first variable. + +**Default**: + +* the value of the variable "rougail.var2". +* the value of the variable "rougail.var3". +| +**rougail.var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A second variable. + +**Default**: no +| +**rougail.var3** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A third variable. + +**Default**: yes +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +rougail: + var: + - no + - yes + var2: no + var3: yes +---- diff --git a/tests/docs/base/40_8calculation_multi_variable.md b/tests/docs/base/40_8calculation_multi_variable.md new file mode 100644 index 0000000..62fbbe7 --- /dev/null +++ b/tests/docs/base/40_8calculation_multi_variable.md @@ -0,0 +1,39 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: + description: a first variable + default: + - type: variable + variable: _.var2 + - type: variable + variable: _.var3 +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 | + + +# Example with all variables modifiable + +```yaml +--- +rougail: + var: + - no + - yes + var2: no + var3: yes +``` diff --git a/tests/docs/base/40_8calculation_multi_variable_parent.adoc b/tests/docs/base/40_8calculation_multi_variable_parent.adoc new file mode 100644 index 0000000..a084c16 --- /dev/null +++ b/tests/docs/base/40_8calculation_multi_variable_parent.adoc @@ -0,0 +1,49 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +var: no # a variable +fam1: # a family + var: + description: a calculated variable + default: + type: variable + variable: __.var +---- +== Variables for "rougail" + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**rougail.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A variable. + +**Default**: no +|==== + +=== a family + +`standard` + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**rougail.fam1.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A calculated variable. + +**Default**: the value of the variable "rougail.var". +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +rougail: + var: no + fam1: + var: no +---- diff --git a/tests/docs/base/40_8calculation_multi_variable_parent.md b/tests/docs/base/40_8calculation_multi_variable_parent.md new file mode 100644 index 0000000..960cedd --- /dev/null +++ b/tests/docs/base/40_8calculation_multi_variable_parent.md @@ -0,0 +1,41 @@ +--- +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: + type: variable + variable: __.var +``` +# Variables for "rougail" + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: no | + +## a family + +`standard` + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.fam1.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A calculated variable.
**Default**: the value of the variable "rougail.var". | + + +# Example with all variables modifiable + +```yaml +--- +rougail: + var: no + fam1: + var: no +``` diff --git a/tests/docs/base/40_8calculation_multi_variable_parent2.adoc b/tests/docs/base/40_8calculation_multi_variable_parent2.adoc new file mode 100644 index 0000000..34d6639 --- /dev/null +++ b/tests/docs/base/40_8calculation_multi_variable_parent2.adoc @@ -0,0 +1,55 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +fam1: # first family + var: no # a variable +fam2: # second family + var: + description: a varaible + default: + type: variable + variable: __.fam1.var +---- +== Variables for "rougail" + +=== first family + +`standard` + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**rougail.fam1.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A variable. + +**Default**: no +|==== + +=== second family + +`standard` + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**rougail.fam2.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A varaible. + +**Default**: the value of the variable "rougail.fam1.var". +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +rougail: + fam1: + var: no + fam2: + var: no +---- diff --git a/tests/docs/base/40_8calculation_multi_variable_parent2.md b/tests/docs/base/40_8calculation_multi_variable_parent2.md new file mode 100644 index 0000000..e1f9bcb --- /dev/null +++ b/tests/docs/base/40_8calculation_multi_variable_parent2.md @@ -0,0 +1,47 @@ +--- +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: + type: variable + variable: __.fam1.var +``` +# Variables for "rougail" + +## first family + +`standard` + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.fam1.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: no | + +## second family + +`standard` + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.fam2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A varaible.
**Default**: the value of the variable "rougail.fam1.var". | + + +# Example with all variables modifiable + +```yaml +--- +rougail: + fam1: + var: no + fam2: + var: no +``` diff --git a/tests/docs/base/41_0choice_leader.adoc b/tests/docs/base/41_0choice_leader.adoc new file mode 100644 index 0000000..22e691d --- /dev/null +++ b/tests/docs/base/41_0choice_leader.adoc @@ -0,0 +1,57 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.0' +leader: + description: The leadership + type: leadership + leader: + description: The leader + multi: true + mandatory: false + follower1: + type: choice + description: A follower + choices: + - a + - b + - c +---- +== Variables for "rougail" + +=== The leadership + +`basic` + + +This family contains lists of variable blocks. + +[cols="105a,105a",options="header"] +|==== +| Variable | Description +| +**rougail.leader.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` | +A follower. + +**Choices**: + +* a +* b +* c +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +rougail: + leader: + - leader: example + follower1: a_choice +---- diff --git a/tests/docs/base/41_0choice_leader.md b/tests/docs/base/41_0choice_leader.md new file mode 100644 index 0000000..12b543f --- /dev/null +++ b/tests/docs/base/41_0choice_leader.md @@ -0,0 +1,48 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.0' +leader: + description: The leadership + type: leadership + leader: + description: The leader + multi: true + mandatory: false + follower1: + type: choice + description: A follower + choices: + - a + - b + - c +``` +# Variables for "rougail" + +## The leadership + +`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 | + + +# Example with all variables modifiable + +```yaml +--- +rougail: + leader: + - leader: example + follower1: a_choice +``` diff --git a/tests/docs/base/44_0leadership_hidden.adoc b/tests/docs/base/44_0leadership_hidden.adoc new file mode 100644 index 0000000..0045864 --- /dev/null +++ b/tests/docs/base/44_0leadership_hidden.adoc @@ -0,0 +1,12 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +leader: + description: a leadership + hidden: true + type: leadership + leader: [] # a leader + follower: # a follower +---- diff --git a/tests/docs/base/44_0leadership_hidden.md b/tests/docs/base/44_0leadership_hidden.md new file mode 100644 index 0000000..32576ab --- /dev/null +++ b/tests/docs/base/44_0leadership_hidden.md @@ -0,0 +1,16 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +leader: + description: a leadership + hidden: true + type: leadership + leader: [] # a leader + follower: # a follower +``` diff --git a/tests/docs/base/44_0leadership_leader_hidden.adoc b/tests/docs/base/44_0leadership_leader_hidden.adoc new file mode 100644 index 0000000..ab771fc --- /dev/null +++ b/tests/docs/base/44_0leadership_leader_hidden.adoc @@ -0,0 +1,14 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +leader: + description: a leadership + type: leadership + leader: + description: a leader + multi: true + hidden: true + follower: # a follower +---- diff --git a/tests/docs/base/44_0leadership_leader_hidden.md b/tests/docs/base/44_0leadership_leader_hidden.md new file mode 100644 index 0000000..252e154 --- /dev/null +++ b/tests/docs/base/44_0leadership_leader_hidden.md @@ -0,0 +1,18 @@ +--- +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 + follower: # a follower +``` diff --git a/tests/docs/base/44_1leadership_append_hidden_follower.adoc b/tests/docs/base/44_1leadership_append_hidden_follower.adoc new file mode 100644 index 0000000..d7d8d3d --- /dev/null +++ b/tests/docs/base/44_1leadership_append_hidden_follower.adoc @@ -0,0 +1,23 @@ +== dictionaries/rougail/01-base.yml + +[,yaml] +---- +version: '1.1' +leader: + follower3: # follower3 +---- +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +leader: + description: a leadership + type: leadership + leader: + description: a leader + multi: true + hidden: true + follower1: # the follower1 + follower2: # the follower2 +---- diff --git a/tests/docs/base/44_1leadership_append_hidden_follower.md b/tests/docs/base/44_1leadership_append_hidden_follower.md new file mode 100644 index 0000000..673d765 --- /dev/null +++ b/tests/docs/base/44_1leadership_append_hidden_follower.md @@ -0,0 +1,27 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/01-base.yml + +```yaml +--- +version: '1.1' +leader: + follower3: # follower3 +``` +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +leader: + description: a leadership + type: leadership + leader: + description: a leader + multi: true + hidden: true + follower1: # the follower1 + follower2: # the follower2 +``` diff --git a/tests/docs/base/44_4disabled_calcultion_follower.adoc b/tests/docs/base/44_4disabled_calcultion_follower.adoc new file mode 100644 index 0000000..7ffc47a --- /dev/null +++ b/tests/docs/base/44_4disabled_calcultion_follower.adoc @@ -0,0 +1,70 @@ +== 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: + type: jinja + jinja: | + {% if rougail.condition == "yes" %} + condition is yes + {% endif %} + description: if condition is yes +---- +== Variables for "rougail" + +[cols="118a,118a",options="header"] +|==== +| Variable | Description +| +**rougail.condition** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | +A condition. + +**Default**: True +|==== + +=== a leadership + +`basic` + + +This family contains lists of variable blocks. + +[cols="118a,118a",options="header"] +|==== +| 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.follower** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` _`disabled`_ | +A follower. + +**Disabled**: if condition is yes. +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +rougail: + condition: true + leader: + - leader: a + follower: example +---- diff --git a/tests/docs/base/44_4disabled_calcultion_follower.md b/tests/docs/base/44_4disabled_calcultion_follower.md new file mode 100644 index 0000000..62924ee --- /dev/null +++ b/tests/docs/base/44_4disabled_calcultion_follower.md @@ -0,0 +1,56 @@ +--- +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: + type: jinja + jinja: | + {% if rougail.condition == "yes" %} + condition is yes + {% endif %} + description: if condition is yes +``` +# Variables for "rougail" + +| Variable                                                                                                             | Description                                                                                                          | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.condition**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.
**Default**: True | + +## a leadership + +`basic` + + +This family contains lists of variable blocks. + +| Variable                                                                                                             | Description                                                                                                          | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | Aleader.
**Default**:
- a | +| **rougail.leader.follower**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` _`disabled`_ | A follower.
**Disabled**: if condition is yes. | + + +# Example with all variables modifiable + +```yaml +--- +rougail: + condition: true + leader: + - leader: a + follower: example +``` diff --git a/tests/docs/base/44_4leadership_mandatory.adoc b/tests/docs/base/44_4leadership_mandatory.adoc new file mode 100644 index 0000000..e5abcb5 --- /dev/null +++ b/tests/docs/base/44_4leadership_mandatory.adoc @@ -0,0 +1,48 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +leader: + description: a leadership + type: leadership + leader: + description: a leader + multi: true + mandatory: true + follower1: + description: a follower + mandatory: false +---- +== Variables for "rougail" + +=== a leadership + +`basic` + + +This family contains lists of variable blocks. + +[cols="96a,96a",options="header"] +|==== +| Variable | Description +| +**rougail.leader.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. +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +rougail: + leader: + - leader: example + follower1: example +---- diff --git a/tests/docs/base/44_4leadership_mandatory.md b/tests/docs/base/44_4leadership_mandatory.md new file mode 100644 index 0000000..0557d29 --- /dev/null +++ b/tests/docs/base/44_4leadership_mandatory.md @@ -0,0 +1,44 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +leader: + description: a leadership + type: leadership + leader: + description: a leader + multi: true + mandatory: true + follower1: + description: a follower + mandatory: false +``` +# Variables for "rougail" + +## a leadership + +`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. | + + +# Example with all variables modifiable + +```yaml +--- +rougail: + leader: + - leader: example + follower1: example +``` diff --git a/tests/docs/base/44_4leadership_mandatory_follower.adoc b/tests/docs/base/44_4leadership_mandatory_follower.adoc new file mode 100644 index 0000000..303146e --- /dev/null +++ b/tests/docs/base/44_4leadership_mandatory_follower.adoc @@ -0,0 +1,48 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.0' +leader: + description: a leadership + type: leadership + leader: + description: a leader + multi: true + mandatory: false + follower: + description: a follower + mandatory: true +---- +== Variables for "rougail" + +=== a leadership + +`basic` + + +This family contains lists of variable blocks. + +[cols="105a,105a",options="header"] +|==== +| Variable | Description +| +**rougail.leader.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. +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +rougail: + leader: + - leader: example + follower: example +---- diff --git a/tests/docs/base/44_4leadership_mandatory_follower.md b/tests/docs/base/44_4leadership_mandatory_follower.md new file mode 100644 index 0000000..ab92f26 --- /dev/null +++ b/tests/docs/base/44_4leadership_mandatory_follower.md @@ -0,0 +1,44 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.0' +leader: + description: a leadership + type: leadership + leader: + description: a leader + multi: true + mandatory: false + follower: + description: a follower + mandatory: true +``` +# Variables for "rougail" + +## a leadership + +`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. | + + +# Example with all variables modifiable + +```yaml +--- +rougail: + leader: + - leader: example + follower: example +``` diff --git a/tests/docs/base/44_5leadership_leader_hidden_calculation.adoc b/tests/docs/base/44_5leadership_leader_hidden_calculation.adoc new file mode 100644 index 0000000..a91a9e2 --- /dev/null +++ b/tests/docs/base/44_5leadership_leader_hidden_calculation.adoc @@ -0,0 +1,66 @@ +== 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: + type: jinja + jinja: | + {% if __.condition == "no" %} + condition is no + {% endif %} + description: if condition is no + follower: # a follower +---- +== Variables for "rougail" + +[cols="105a,105a",options="header"] +|==== +| Variable | Description +| +**rougail.condition** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A condition. + +**Default**: no +|==== + +=== a leadership + +`basic` _`hidden`_ + +**Hidden**: if condition is no. + + +This family contains lists of variable blocks. + +[cols="105a,105a",options="header"] +|==== +| Variable | Description +| +**rougail.leader.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` | +A follower. +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +rougail: + condition: no + leader: + - leader: example + follower: example +---- diff --git a/tests/docs/base/44_5leadership_leader_hidden_calculation.md b/tests/docs/base/44_5leadership_leader_hidden_calculation.md new file mode 100644 index 0000000..b67ad17 --- /dev/null +++ b/tests/docs/base/44_5leadership_leader_hidden_calculation.md @@ -0,0 +1,56 @@ +--- +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: + type: jinja + jinja: | + {% if __.condition == "no" %} + condition is no + {% endif %} + description: if condition is no + follower: # a follower +``` +# Variables for "rougail" + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.
**Default**: no | + +## a leadership + +`basic` _`hidden`_ + +**Hidden**: if condition is no. + + +This family contains lists of variable blocks. + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | A leader. | +| **rougail.leader.follower**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A follower. | + + +# Example with all variables modifiable + +```yaml +--- +rougail: + condition: no + leader: + - leader: example + follower: example +``` diff --git a/tests/docs/base/44_6leadership_follower_disabled_calculation.adoc b/tests/docs/base/44_6leadership_follower_disabled_calculation.adoc new file mode 100644 index 0000000..dcb824a --- /dev/null +++ b/tests/docs/base/44_6leadership_follower_disabled_calculation.adoc @@ -0,0 +1,64 @@ +== 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: + type: jinja + jinja: | + {% if __.condition == "yes" %}true{% else %}false{% endif %} + description: if condition is yes +---- +== Variables for "rougail" + +[cols="118a,118a",options="header"] +|==== +| Variable | Description +| +**rougail.condition** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A condition. + +**Default**: yes +|==== + +=== a leadership + +`basic` + + +This family contains lists of variable blocks. + +[cols="118a,118a",options="header"] +|==== +| Variable | Description +| +**rougail.leader.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`_ | +A follower. + +**Disabled**: if condition is yes. +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +rougail: + condition: yes + leader: + - leader: example + follower: example +---- diff --git a/tests/docs/base/44_6leadership_follower_disabled_calculation.md b/tests/docs/base/44_6leadership_follower_disabled_calculation.md new file mode 100644 index 0000000..bb0c8bb --- /dev/null +++ b/tests/docs/base/44_6leadership_follower_disabled_calculation.md @@ -0,0 +1,53 @@ +--- +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: + type: jinja + jinja: | + {% if __.condition == "yes" %}true{% else %}false{% endif %} + description: if condition is yes +``` +# Variables for "rougail" + +| Variable                                                                                                             | Description                                                                                                          | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.
**Default**: yes | + +## a leadership + +`basic` + + +This family contains lists of variable blocks. + +| Variable                                                                                                             | Description                                                                                                          | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | A leader. | +| **rougail.leader.follower**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` _`disabled`_ | A follower.
**Disabled**: if condition is yes. | + + +# Example with all variables modifiable + +```yaml +--- +rougail: + condition: yes + leader: + - leader: example + follower: example +``` diff --git a/tests/docs/base/44_9calculated_default_leadership_leader.adoc b/tests/docs/base/44_9calculated_default_leadership_leader.adoc new file mode 100644 index 0000000..ed8e633 --- /dev/null +++ b/tests/docs/base/44_9calculated_default_leadership_leader.adoc @@ -0,0 +1,64 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: 1.1 +leader: + description: leader + type: leadership + leader: # a leader + - a + - b + follower: + description: a follower + disabled: + type: jinja + jinja: | + {% if _.leader == "a" %} + the value of "leader" is "a" + {% endif %} + description: if the value of "leader" is "a" + default: + type: variable + variable: _.leader +---- +== Variables for "rougail" + +=== rougail.leader + +`standard` + + +This family contains lists of variable blocks. + +[cols="121a,121a",options="header"] +|==== +| Variable | Description +| +**rougail.leader.leader** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +A leader. + +**Default**: + +* a +* b +| +**rougail.leader.follower** + +`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". +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +rougail: + leader: + - leader: a + follower: b + - leader: b + follower: b +---- diff --git a/tests/docs/base/44_9calculated_default_leadership_leader.md b/tests/docs/base/44_9calculated_default_leadership_leader.md new file mode 100644 index 0000000..56ba732 --- /dev/null +++ b/tests/docs/base/44_9calculated_default_leadership_leader.md @@ -0,0 +1,54 @@ +--- +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: + type: jinja + jinja: | + {% if _.leader == "a" %} + the value of "leader" is "a" + {% endif %} + description: if the value of "leader" is "a" + default: + type: variable + variable: _.leader +``` +# Variables for "rougail" + +## 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". | + + +# Example with all variables modifiable + +```yaml +--- +rougail: + leader: + - leader: a + follower: b + - leader: b + follower: b +``` diff --git a/tests/docs/base/60_0family_dynamic.adoc b/tests/docs/base/60_0family_dynamic.adoc new file mode 100644 index 0000000..11abda8 --- /dev/null +++ b/tests/docs/base/60_0family_dynamic.adoc @@ -0,0 +1,73 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +var: # A suffix variable + - val1 + - val2 +dyn{{ suffix }}: + description: A dynamic family + type: dynamic + dynamic: + type: variable + variable: _.var + var: # A dynamic variable +---- +== Variables for "rougail" + +[cols="105a,105a",options="header"] +|==== +| 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. + +**Suffixes**: the value of the variable "rougail.var". + +[cols="105a,105a",options="header"] +|==== +| Variable | Description +| +**rougail.dynval1.var** ou **rougail.dynval2.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A dynamic variable. +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +rougail: + dynval1: + var: example + dynval2: + var: example +---- +== Example with all variables modifiable + +[,yaml] +---- +rougail: + var: + - val1 + - val2 + dynval1: + var: example + dynval2: + var: example +---- diff --git a/tests/docs/base/60_0family_dynamic.md b/tests/docs/base/60_0family_dynamic.md new file mode 100644 index 0000000..fb83089 --- /dev/null +++ b/tests/docs/base/60_0family_dynamic.md @@ -0,0 +1,63 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: # A suffix variable + - val1 + - val2 +dyn{{ suffix }}: + description: A dynamic family + type: dynamic + dynamic: + type: variable + variable: _.var + var: # A dynamic variable +``` +# 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. + +**Suffixes**: the value of the variable "rougail.var". + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dynval1.var** ou **rougail.dynval2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A dynamic variable. | + + +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + dynval1: + var: example + dynval2: + var: example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var: + - val1 + - val2 + dynval1: + var: example + dynval2: + var: example +``` diff --git a/tests/docs/base/60_0family_dynamic_1_0.adoc b/tests/docs/base/60_0family_dynamic_1_0.adoc new file mode 100644 index 0000000..56f8138 --- /dev/null +++ b/tests/docs/base/60_0family_dynamic_1_0.adoc @@ -0,0 +1,65 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.0' +var: + description: A suffix variable + multi: true + default: + - val1 + - val2 +dyn: + type: dynamic + variable: rougail.var + vardyn: + description: Dynamic variable + mandatory: false +---- +== Variables for "rougail" + +[cols="96a,96a",options="header"] +|==== +| 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 +|==== + +=== "dyn_val1_" ou "dyn_val2_" + +`standard` + + +This family builds families dynamically. + +**Suffixes**: the value of the variable "rougail.var". + +[cols="96a,96a",options="header"] +|==== +| Variable | Description +| +**rougail.dynval1.vardyn** ou **rougail.dynval2.vardyn** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | +Dynamic variable. +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +rougail: + var: + - val1 + - val2 + dynval1: + vardyn: example + dynval2: + vardyn: example +---- diff --git a/tests/docs/base/60_0family_dynamic_1_0.md b/tests/docs/base/60_0family_dynamic_1_0.md new file mode 100644 index 0000000..6e09dc5 --- /dev/null +++ b/tests/docs/base/60_0family_dynamic_1_0.md @@ -0,0 +1,55 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.0' +var: + description: A suffix variable + multi: true + default: + - val1 + - val2 +dyn: + type: dynamic + variable: rougail.var + vardyn: + description: Dynamic variable + mandatory: false +``` +# Variables for "rougail" + +| Variable                                                                                       | Description                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **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*" ou "dyn*val2*" + +`standard` + + +This family builds families dynamically. + +**Suffixes**: the value of the variable "rougail.var". + +| Variable                                                                                       | Description                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dynval1.vardyn** ou **rougail.dynval2.vardyn**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | Dynamic variable. | + + +# Example with all variables modifiable + +```yaml +--- +rougail: + var: + - val1 + - val2 + dynval1: + vardyn: example + dynval2: + vardyn: example +``` diff --git a/tests/docs/base/60_0family_dynamic_1_0_type.adoc b/tests/docs/base/60_0family_dynamic_1_0_type.adoc new file mode 100644 index 0000000..3c05289 --- /dev/null +++ b/tests/docs/base/60_0family_dynamic_1_0_type.adoc @@ -0,0 +1,74 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.0' +var: + description: A suffix variable + multi: true + default: + - val1 + - val2 +dyn: + _type: dynamic + variable: rougail.var + vardyn: + description: A dyn variable +---- +== Variables for "rougail" + +[cols="105a,105a",options="header"] +|==== +| 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 +|==== + +=== "dyn_val1_" ou "dyn_val2_" + +`basic` + + +This family builds families dynamically. + +**Suffixes**: the value of the variable "rougail.var". + +[cols="105a,105a",options="header"] +|==== +| Variable | Description +| +**rougail.dynval1.vardyn** ou **rougail.dynval2.vardyn** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A dyn variable. +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +rougail: + dynval1: + vardyn: example + dynval2: + vardyn: example +---- +== Example with all variables modifiable + +[,yaml] +---- +rougail: + var: + - val1 + - val2 + dynval1: + vardyn: example + dynval2: + vardyn: example +---- diff --git a/tests/docs/base/60_0family_dynamic_1_0_type.md b/tests/docs/base/60_0family_dynamic_1_0_type.md new file mode 100644 index 0000000..fe2dabc --- /dev/null +++ b/tests/docs/base/60_0family_dynamic_1_0_type.md @@ -0,0 +1,64 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.0' +var: + description: A suffix variable + multi: true + default: + - val1 + - val2 +dyn: + _type: dynamic + variable: rougail.var + vardyn: + description: A dyn variable +``` +# Variables for "rougail" + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **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*" ou "dyn*val2*" + +`basic` + + +This family builds families dynamically. + +**Suffixes**: the value of the variable "rougail.var". + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dynval1.vardyn** ou **rougail.dynval2.vardyn**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A dyn variable. | + + +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + dynval1: + vardyn: example + dynval2: + vardyn: example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var: + - val1 + - val2 + dynval1: + vardyn: example + dynval2: + vardyn: example +``` diff --git a/tests/docs/base/60_0family_dynamic_1_1.adoc b/tests/docs/base/60_0family_dynamic_1_1.adoc new file mode 100644 index 0000000..f523b21 --- /dev/null +++ b/tests/docs/base/60_0family_dynamic_1_1.adoc @@ -0,0 +1,72 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +var: # A suffix variable + - val1 + - val2 +dyn: + type: dynamic + description: A dynamic family + variable: _.var + vardyn: + description: A dynamic variable +---- +== Variables for "rougail" + +[cols="105a,105a",options="header"] +|==== +| 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. + +**Suffixes**: the value of the variable "rougail.var". + +[cols="105a,105a",options="header"] +|==== +| Variable | Description +| +**rougail.dynval1.vardyn** ou **rougail.dynval2.vardyn** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A dynamic variable. +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +rougail: + dynval1: + vardyn: example + dynval2: + vardyn: example +---- +== Example with all variables modifiable + +[,yaml] +---- +rougail: + var: + - val1 + - val2 + dynval1: + vardyn: example + dynval2: + vardyn: example +---- diff --git a/tests/docs/base/60_0family_dynamic_1_1.md b/tests/docs/base/60_0family_dynamic_1_1.md new file mode 100644 index 0000000..b56acdb --- /dev/null +++ b/tests/docs/base/60_0family_dynamic_1_1.md @@ -0,0 +1,62 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: # A suffix variable + - val1 + - val2 +dyn: + type: dynamic + description: A dynamic family + variable: _.var + vardyn: + description: A dynamic variable +``` +# Variables for "rougail" + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **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. + +**Suffixes**: the value of the variable "rougail.var". + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dynval1.vardyn** ou **rougail.dynval2.vardyn**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A dynamic variable. | + + +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + dynval1: + vardyn: example + dynval2: + vardyn: example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var: + - val1 + - val2 + dynval1: + vardyn: example + dynval2: + vardyn: example +``` diff --git a/tests/docs/base/60_0family_dynamic_jinja_number.adoc b/tests/docs/base/60_0family_dynamic_jinja_number.adoc new file mode 100644 index 0000000..97ad40f --- /dev/null +++ b/tests/docs/base/60_0family_dynamic_jinja_number.adoc @@ -0,0 +1,82 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +var: # a suffix variable + - 1 + - 2 +dyn{{ suffix }}: + description: a dynamic family + type: dynamic + dynamic: + type: variable + variable: _.var + var: val # a variable inside dynamic family +var2: + description: a variable + default: + type: jinja + jinja: | + {{ rougail.dyn1.var }} + description: get the value of rougail.dyn1.var +---- +== Variables for "rougail" + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**rougail.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` `unique` `multiple` | +A suffix variable. + +**Default**: + +* 1 +* 2 +|==== + +=== a dynamic family + +`standard` + + +This family builds families dynamically. + +**Suffixes**: the value of the variable "rougail.var". + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**rougail.dyn1.var** ou **rougail.dyn2.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A variable inside dynamic family. + +**Default**: val +|==== + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**rougail.var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A variable. + +**Default**: get the value of rougail.dyn1.var. +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +rougail: + var: + - 1 + - 2 + dyn1: + var: val + dyn2: + var: val + var2: val +---- diff --git a/tests/docs/base/60_0family_dynamic_jinja_number.md b/tests/docs/base/60_0family_dynamic_jinja_number.md new file mode 100644 index 0000000..69e72d8 --- /dev/null +++ b/tests/docs/base/60_0family_dynamic_jinja_number.md @@ -0,0 +1,65 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: # a suffix variable + - 1 + - 2 +dyn{{ suffix }}: + description: a dynamic family + type: dynamic + dynamic: + type: variable + variable: _.var + var: val # a variable inside dynamic family +var2: + description: a variable + default: + type: jinja + jinja: | + {{ rougail.dyn1.var }} + description: get the value of rougail.dyn1.var +``` +# Variables for "rougail" + +| 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. + +**Suffixes**: the value of the variable "rougail.var". + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dyn1.var** ou **rougail.dyn2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable inside dynamic family.
**Default**: val | + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: get the value of rougail.dyn1.var. | + + +# Example with all variables modifiable + +```yaml +--- +rougail: + var: + - 1 + - 2 + dyn1: + var: val + dyn2: + var: val + var2: val +``` diff --git a/tests/docs/base/60_0family_dynamic_static.adoc b/tests/docs/base/60_0family_dynamic_static.adoc new file mode 100644 index 0000000..0003bad --- /dev/null +++ b/tests/docs/base/60_0family_dynamic_static.adoc @@ -0,0 +1,57 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +dyn{{ suffix }}: + description: a dynamic family + type: dynamic + dynamic: + - val1 + - val2 + var: # a variable inside a dynamic family +---- +== Variables for "rougail" + +=== a dynamic family + +`basic` + + +This family builds families dynamically. + +**Suffixes**: + +* val1 +* val2 + +[cols="105a,105a",options="header"] +|==== +| Variable | Description +| +**rougail.dynval1.var** ou **rougail.dynval2.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A variable inside a dynamic family. +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +rougail: + dynval1: + var: example + dynval2: + var: example +---- +== Example with all variables modifiable + +[,yaml] +---- +rougail: + dynval1: + var: example + dynval2: + var: example +---- diff --git a/tests/docs/base/60_0family_dynamic_static.md b/tests/docs/base/60_0family_dynamic_static.md new file mode 100644 index 0000000..ab3165c --- /dev/null +++ b/tests/docs/base/60_0family_dynamic_static.md @@ -0,0 +1,53 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +dyn{{ suffix }}: + description: a dynamic family + type: dynamic + dynamic: + - val1 + - val2 + var: # a variable inside a dynamic family +``` +# Variables for "rougail" + +## a dynamic family + +`basic` + + +This family builds families dynamically. + +**Suffixes**:
- val1
- val2 + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dynval1.var** ou **rougail.dynval2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable inside a dynamic family. | + + +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + dynval1: + var: example + dynval2: + var: example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + dynval1: + var: example + dynval2: + var: example +``` diff --git a/tests/docs/base/60_0family_dynamic_variable_empty.adoc b/tests/docs/base/60_0family_dynamic_variable_empty.adoc new file mode 100644 index 0000000..96cab47 --- /dev/null +++ b/tests/docs/base/60_0family_dynamic_variable_empty.adoc @@ -0,0 +1,63 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +var: [] # a suffix variable +dyn{{ suffix }}: + description: a dynamic family + type: dynamic + dynamic: + type: variable + variable: _.var + var: val # a variable inside dynamic family +---- +== Variables for "rougail" + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**rougail.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | +A suffix variable. +|==== + +=== a dynamic family + +`standard` + + +This family builds families dynamically. + +**Suffixes**: the value of the variable "rougail.var". + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**rougail.dynexample.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A variable inside dynamic family. + +**Default**: val +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +rougail: + var: + - example +---- +== Example with all variables modifiable + +[,yaml] +---- +rougail: + var: + - example + dynexample: + var: val +---- diff --git a/tests/docs/base/60_0family_dynamic_variable_empty.md b/tests/docs/base/60_0family_dynamic_variable_empty.md new file mode 100644 index 0000000..6857e87 --- /dev/null +++ b/tests/docs/base/60_0family_dynamic_variable_empty.md @@ -0,0 +1,56 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: [] # a suffix variable +dyn{{ suffix }}: + description: a dynamic family + type: dynamic + dynamic: + type: variable + variable: _.var + var: val # a variable inside dynamic family +``` +# Variables for "rougail" + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | A suffix variable. | + +## a dynamic family + +`standard` + + +This family builds families dynamically. + +**Suffixes**: 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 | + + +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + var: + - example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var: + - example + dynexample: + var: val +``` diff --git a/tests/docs/base/60_0family_dynamic_variable_suffix.adoc b/tests/docs/base/60_0family_dynamic_variable_suffix.adoc new file mode 100644 index 0000000..6117ab1 --- /dev/null +++ b/tests/docs/base/60_0family_dynamic_variable_suffix.adoc @@ -0,0 +1,64 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +var: # A suffix variable + - val1 + - val2 +dyn{{ suffix }}: + description: A dynamic family + type: dynamic + dynamic: + type: variable + variable: _.var + var: a value # A dynamic variable with suffix {{ suffix }} +---- +== Variables for "rougail" + +[cols="108a,108a",options="header"] +|==== +| 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 + +`standard` + + +This family builds families dynamically. + +**Suffixes**: the value of the variable "rougail.var". + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**rougail.dynval1.var** ou **rougail.dynval2.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +"A dynamic variable with suffix _val1_" ou "A dynamic variable with suffix _val2_". + +**Default**: a value +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +rougail: + var: + - val1 + - val2 + dynval1: + var: a value + dynval2: + var: a value +---- diff --git a/tests/docs/base/60_0family_dynamic_variable_suffix.md b/tests/docs/base/60_0family_dynamic_variable_suffix.md new file mode 100644 index 0000000..4a3e4a9 --- /dev/null +++ b/tests/docs/base/60_0family_dynamic_variable_suffix.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 +dyn{{ suffix }}: + description: A dynamic family + type: dynamic + dynamic: + type: variable + variable: _.var + var: a value # A dynamic variable with suffix {{ suffix }} +``` +# Variables for "rougail" + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A suffix variable.
**Default**:
- val1
- val2 | + +## A dynamic family + +`standard` + + +This family builds families dynamically. + +**Suffixes**: the value of the variable "rougail.var". + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dynval1.var** ou **rougail.dynval2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | "A dynamic variable with suffix *val1*" ou "A dynamic variable with suffix *val2*".
**Default**: a value | + + +# Example with all variables modifiable + +```yaml +--- +rougail: + var: + - val1 + - val2 + dynval1: + var: a value + dynval2: + var: a value +``` diff --git a/tests/docs/base/60_0family_empty.adoc b/tests/docs/base/60_0family_empty.adoc new file mode 100644 index 0000000..895216f --- /dev/null +++ b/tests/docs/base/60_0family_empty.adoc @@ -0,0 +1,8 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.0' +general2: + type: family +---- diff --git a/tests/docs/base/60_0family_empty.md b/tests/docs/base/60_0family_empty.md new file mode 100644 index 0000000..252df76 --- /dev/null +++ b/tests/docs/base/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/base/60_0family_hidden.adoc b/tests/docs/base/60_0family_hidden.adoc new file mode 100644 index 0000000..95608e1 --- /dev/null +++ b/tests/docs/base/60_0family_hidden.adoc @@ -0,0 +1,17 @@ +== 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: # a variable +---- diff --git a/tests/docs/base/60_0family_hidden.md b/tests/docs/base/60_0family_hidden.md new file mode 100644 index 0000000..92e412b --- /dev/null +++ b/tests/docs/base/60_0family_hidden.md @@ -0,0 +1,21 @@ +--- +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: # a variable +``` diff --git a/tests/docs/base/60_0family_mode.adoc b/tests/docs/base/60_0family_mode.adoc new file mode 100644 index 0000000..01ea2f8 --- /dev/null +++ b/tests/docs/base/60_0family_mode.adoc @@ -0,0 +1,36 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +family: # a family + var: + description: A variable + mode: basic + default: non +---- +== Variables for "rougail" + +=== a family + +`basic` + +[cols="105a,105a",options="header"] +|==== +| Variable | Description +| +**rougail.family.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A variable. + +**Default**: non +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +rougail: + family: + var: non +---- diff --git a/tests/docs/base/60_0family_mode.md b/tests/docs/base/60_0family_mode.md new file mode 100644 index 0000000..d79a412 --- /dev/null +++ b/tests/docs/base/60_0family_mode.md @@ -0,0 +1,34 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +family: # a family + var: + description: A variable + mode: basic + default: non +``` +# Variables for "rougail" + +## a family + +`basic` + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.family.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable.
**Default**: non | + + +# Example with all variables modifiable + +```yaml +--- +rougail: + family: + var: non +``` diff --git a/tests/docs/base/60_1family_dynamic_jinja.adoc b/tests/docs/base/60_1family_dynamic_jinja.adoc new file mode 100644 index 0000000..0f8c6a5 --- /dev/null +++ b/tests/docs/base/60_1family_dynamic_jinja.adoc @@ -0,0 +1,68 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +var: # a suffix variable + - val1 + - val2 +dyn{{ suffix }}: + description: A dynamic family + type: dynamic + dynamic: + type: jinja + jinja: | + {% for val in _.var %} + {{ loop.index }} + {% endfor %} + description: index of suffix value + var: val # a dynamic variable +---- +== Variables for "rougail" + +[cols="108a,108a",options="header"] +|==== +| 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 + +`standard` + + +This family builds families dynamically. + +**Suffixes**: index of suffix value. + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**rougail.dyn1.var** ou **rougail.dyn2.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A dynamic variable. + +**Default**: val +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +rougail: + var: + - val1 + - val2 + dyn1: + var: val + dyn2: + var: val +---- diff --git a/tests/docs/base/60_1family_dynamic_jinja.md b/tests/docs/base/60_1family_dynamic_jinja.md new file mode 100644 index 0000000..e16426f --- /dev/null +++ b/tests/docs/base/60_1family_dynamic_jinja.md @@ -0,0 +1,57 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: # a suffix variable + - val1 + - val2 +dyn{{ suffix }}: + description: A dynamic family + type: dynamic + dynamic: + type: jinja + jinja: | + {% for val in _.var %} + {{ loop.index }} + {% endfor %} + description: index of suffix value + var: val # a dynamic variable +``` +# Variables for "rougail" + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`string`](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. + +**Suffixes**: index of suffix value. + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dyn1.var** ou **rougail.dyn2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A dynamic variable.
**Default**: val | + + +# Example with all variables modifiable + +```yaml +--- +rougail: + var: + - val1 + - val2 + dyn1: + var: val + dyn2: + var: val +``` diff --git a/tests/docs/base/60_2family_dynamic_jinja_fill_sub_group.adoc b/tests/docs/base/60_2family_dynamic_jinja_fill_sub_group.adoc new file mode 100644 index 0000000..c295149 --- /dev/null +++ b/tests/docs/base/60_2family_dynamic_jinja_fill_sub_group.adoc @@ -0,0 +1,101 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +var1: # a suffix variable + - val1 + - val2 +dyn{{ suffix }}: + description: a dynamic family + type: dynamic + dynamic: + type: variable + variable: _.var1 + family: # a family + var: # with a variable +var2: + description: a second variable + default: + type: jinja + jinja: | + {{ _.dynval1.family.var }} + description: the value of var +---- +== Variables for "rougail" + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**rougail.var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +A suffix variable. + +**Default**: + +* val1 +* val2 +|==== + +=== a dynamic family + +`basic` + + +This family builds families dynamically. + +**Suffixes**: the value of the variable "rougail.var1". + +==== a family + +`basic` + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**rougail.dynval1.family.var** ou **rougail.dynval2.family.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +With a variable. +|==== + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**rougail.var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A second variable. + +**Default**: the value of var. +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +rougail: + dynval1: + family: + var: example + dynval2: + family: + var: example + var2: example +---- +== Example with all variables modifiable + +[,yaml] +---- +rougail: + var1: + - val1 + - val2 + dynval1: + family: + var: example + dynval2: + family: + var: example + var2: example +---- diff --git a/tests/docs/base/60_2family_dynamic_jinja_fill_sub_group.md b/tests/docs/base/60_2family_dynamic_jinja_fill_sub_group.md new file mode 100644 index 0000000..f1e7fc1 --- /dev/null +++ b/tests/docs/base/60_2family_dynamic_jinja_fill_sub_group.md @@ -0,0 +1,85 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: # a suffix variable + - val1 + - val2 +dyn{{ suffix }}: + description: a dynamic family + type: dynamic + dynamic: + type: variable + variable: _.var1 + family: # a family + var: # with a variable +var2: + description: a second variable + default: + type: jinja + jinja: | + {{ _.dynval1.family.var }} + description: the value of var +``` +# Variables for "rougail" + +| 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. + +**Suffixes**: the value of the variable "rougail.var1". + +### a family + +`basic` + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dynval1.family.var** ou **rougail.dynval2.family.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | With a variable. | + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second variable.
**Default**: the value of var. | + + +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + dynval1: + family: + var: example + dynval2: + family: + var: example + var2: example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var1: + - val1 + - val2 + dynval1: + family: + var: example + dynval2: + family: + var: example + var2: example +``` diff --git a/tests/docs/base/60_2family_dynamic_jinja_fill_sub_group_2.adoc b/tests/docs/base/60_2family_dynamic_jinja_fill_sub_group_2.adoc new file mode 100644 index 0000000..1a4560d --- /dev/null +++ b/tests/docs/base/60_2family_dynamic_jinja_fill_sub_group_2.adoc @@ -0,0 +1,93 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +var: # a suffix variable + - val1 + - val2 +dyn{{ suffix }}: + description: a dynamic family + type: dynamic + dynamic: + type: variable + variable: _.var + family: + description: a family inside dynamic family + var: + description: a dynamic variable + default: + type: suffix +var2: + description: a varible outside dynamic family + default: + type: jinja + jinja: | + {{ _.dynval1.family.var }} + description: the value of var +---- +== Variables for "rougail" + +[cols="108a,108a",options="header"] +|==== +| 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 + +`standard` + + +This family builds families dynamically. + +**Suffixes**: the value of the variable "rougail.var". + +==== a family inside dynamic family + +`standard` + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**rougail.dynval1.family.var** ou **rougail.dynval2.family.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A dynamic variable. + +**Default**: value of the suffix. +|==== + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**rougail.var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A varible outside dynamic family. + +**Default**: the value of var. +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +rougail: + var: + - val1 + - val2 + dynval1: + family: + var: val1 + dynval2: + family: + var: val2 + var2: val1 +---- diff --git a/tests/docs/base/60_2family_dynamic_jinja_fill_sub_group_2.md b/tests/docs/base/60_2family_dynamic_jinja_fill_sub_group_2.md new file mode 100644 index 0000000..b10e63a --- /dev/null +++ b/tests/docs/base/60_2family_dynamic_jinja_fill_sub_group_2.md @@ -0,0 +1,76 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: # a suffix variable + - val1 + - val2 +dyn{{ suffix }}: + description: a dynamic family + type: dynamic + dynamic: + type: variable + variable: _.var + family: + description: a family inside dynamic family + var: + description: a dynamic variable + default: + type: suffix +var2: + description: a varible outside dynamic family + default: + type: jinja + jinja: | + {{ _.dynval1.family.var }} + description: the value of 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 + +`standard` + + +This family builds families dynamically. + +**Suffixes**: the value of the variable "rougail.var". + +### a family inside dynamic family + +`standard` + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dynval1.family.var** ou **rougail.dynval2.family.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A dynamic variable.
**Default**: value of the suffix. | + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A varible outside dynamic family.
**Default**: the value of var. | + + +# Example with all variables modifiable + +```yaml +--- +rougail: + var: + - val1 + - val2 + dynval1: + family: + var: val1 + dynval2: + family: + var: val2 + var2: val1 +``` diff --git a/tests/docs/base/60_2family_dynamic_outside_calc.adoc b/tests/docs/base/60_2family_dynamic_outside_calc.adoc new file mode 100644 index 0000000..76655c7 --- /dev/null +++ b/tests/docs/base/60_2family_dynamic_outside_calc.adoc @@ -0,0 +1,82 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +var1: # a suffx variable + - val1 + - val2 +dyn{{ suffix }}: + description: a dynamic family + type: dynamic + dynamic: + type: variable + variable: _.var1 + var: val # a dynamic variable +newvar: + description: a second variable + default: + type: jinja + jinja: | + {{ _.dynval1.var }} + description: the value of var +---- +== Variables for "rougail" + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**rougail.var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +A suffx variable. + +**Default**: + +* val1 +* val2 +|==== + +=== a dynamic family + +`standard` + + +This family builds families dynamically. + +**Suffixes**: the value of the variable "rougail.var1". + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**rougail.dynval1.var** ou **rougail.dynval2.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A dynamic variable. + +**Default**: val +|==== + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**rougail.newvar** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A second variable. + +**Default**: the value of var. +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +rougail: + var1: + - val1 + - val2 + dynval1: + var: val + dynval2: + var: val + newvar: val +---- diff --git a/tests/docs/base/60_2family_dynamic_outside_calc.md b/tests/docs/base/60_2family_dynamic_outside_calc.md new file mode 100644 index 0000000..47a485d --- /dev/null +++ b/tests/docs/base/60_2family_dynamic_outside_calc.md @@ -0,0 +1,65 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: # a suffx variable + - val1 + - val2 +dyn{{ suffix }}: + description: a dynamic family + type: dynamic + dynamic: + type: variable + variable: _.var1 + var: val # a dynamic variable +newvar: + description: a second variable + default: + type: jinja + jinja: | + {{ _.dynval1.var }} + description: the value of var +``` +# Variables for "rougail" + +| 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. + +**Suffixes**: the value of the variable "rougail.var1". + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dynval1.var** ou **rougail.dynval2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A dynamic variable.
**Default**: val | + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.newvar**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second variable.
**Default**: the value of var. | + + +# Example with all variables modifiable + +```yaml +--- +rougail: + var1: + - val1 + - val2 + dynval1: + var: val + dynval2: + var: val + newvar: val +``` diff --git a/tests/docs/base/60_5family_dynamic_calc2.adoc b/tests/docs/base/60_5family_dynamic_calc2.adoc new file mode 100644 index 0000000..7ab3b18 --- /dev/null +++ b/tests/docs/base/60_5family_dynamic_calc2.adoc @@ -0,0 +1,88 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +var: # A suffix variable + - val1 + - val2 +var2: # a second variable +dyn{{ suffix }}: + description: A dynamic family + type: dynamic + dynamic: + type: variable + variable: _.var + propertyerror: false + hidden: + type: jinja +#FIXME RELATIVE __.var2 + jinja: | + {% if rougail.var2 == "no" %} + var2 is no + {% endif %} + description: if var2 is no + vardyn: val # a dynamic variable +---- +== Variables for "rougail" + +[cols="108a,108a",options="header"] +|==== +| 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 +| +**rougail.var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A second variable. +|==== + +=== A dynamic family + +`standard` _`hidden`_ + +**Hidden**: if var2 is no. + + +This family builds families dynamically. + +**Suffixes**: the value of the variable "rougail.var". + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**rougail.dynval1.vardyn** ou **rougail.dynval2.vardyn** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A dynamic variable. + +**Default**: val +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +rougail: + var2: example +---- +== Example with all variables modifiable + +[,yaml] +---- +rougail: + var: + - val1 + - val2 + var2: example + dynval1: + vardyn: val + dynval2: + vardyn: val +---- diff --git a/tests/docs/base/60_5family_dynamic_calc2.md b/tests/docs/base/60_5family_dynamic_calc2.md new file mode 100644 index 0000000..e7cca06 --- /dev/null +++ b/tests/docs/base/60_5family_dynamic_calc2.md @@ -0,0 +1,74 @@ +--- +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{{ suffix }}: + description: A dynamic family + type: dynamic + dynamic: + type: variable + variable: _.var + propertyerror: false + hidden: + type: jinja +#FIXME RELATIVE __.var2 + jinja: | + {% if rougail.var2 == "no" %} + var2 is no + {% endif %} + description: if var2 is no + vardyn: val # a dynamic variable +``` +# Variables for "rougail" + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A suffix variable.
**Default**:
- val1
- val2 | +| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A second variable. | + +## A dynamic family + +`standard` _`hidden`_ + +**Hidden**: if var2 is no. + + +This family builds families dynamically. + +**Suffixes**: the value of the variable "rougail.var". + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dynval1.vardyn** ou **rougail.dynval2.vardyn**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A dynamic variable.
**Default**: val | + + +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + var2: example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var: + - val1 + - val2 + var2: example + dynval1: + vardyn: val + dynval2: + vardyn: val +``` diff --git a/tests/docs/base/60_5family_dynamic_calc_suffix.adoc b/tests/docs/base/60_5family_dynamic_calc_suffix.adoc new file mode 100644 index 0000000..16cae1e --- /dev/null +++ b/tests/docs/base/60_5family_dynamic_calc_suffix.adoc @@ -0,0 +1,99 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +var1: + description: A suffix variable + default: + - val1 + - val2 +dyn{{ suffix }}: + type: dynamic + dynamic: + type: variable + variable: _.var1 + propertyerror: false + var: + description: A dynamic variable +var2: + description: A variable calculated + default: + type: jinja + jinja: | + {{ vardyn }} + params: + vardyn: + type: variable + variable: rougail.dynval1.var + description: from rougail.dynval1.var +---- +== Variables for "rougail" + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**rougail.var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +A suffix variable. + +**Default**: + +* val1 +* val2 +|==== + +=== "dyn_val1_" ou "dyn_val2_" + +`basic` + + +This family builds families dynamically. + +**Suffixes**: the value of the variable "rougail.var1". + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**rougail.dynval1.var** ou **rougail.dynval2.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A dynamic variable. +|==== + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**rougail.var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A variable calculated. + +**Default**: from rougail.dynval1.var. +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +rougail: + dynval1: + var: example + dynval2: + var: example + var2: example +---- +== Example with all variables modifiable + +[,yaml] +---- +rougail: + var1: + - val1 + - val2 + dynval1: + var: example + dynval2: + var: example + var2: example +---- diff --git a/tests/docs/base/60_5family_dynamic_calc_suffix.md b/tests/docs/base/60_5family_dynamic_calc_suffix.md new file mode 100644 index 0000000..c10a408 --- /dev/null +++ b/tests/docs/base/60_5family_dynamic_calc_suffix.md @@ -0,0 +1,83 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: + description: A suffix variable + default: + - val1 + - val2 +dyn{{ suffix }}: + type: dynamic + dynamic: + type: variable + variable: _.var1 + propertyerror: false + var: + description: A dynamic variable +var2: + description: A variable calculated + default: + type: jinja + jinja: | + {{ vardyn }} + params: + vardyn: + type: variable + variable: rougail.dynval1.var + description: from rougail.dynval1.var +``` +# 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 | + +## "dyn*val1*" ou "dyn*val2*" + +`basic` + + +This family builds families dynamically. + +**Suffixes**: the value of the variable "rougail.var1". + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dynval1.var** ou **rougail.dynval2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A dynamic variable. | + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable calculated.
**Default**: from rougail.dynval1.var. | + + +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + dynval1: + var: example + dynval2: + var: example + var2: example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var1: + - val1 + - val2 + dynval1: + var: example + dynval2: + var: example + var2: example +``` diff --git a/tests/docs/base/60_5family_dynamic_calc_suffix2.adoc b/tests/docs/base/60_5family_dynamic_calc_suffix2.adoc new file mode 100644 index 0000000..cf7ff07 --- /dev/null +++ b/tests/docs/base/60_5family_dynamic_calc_suffix2.adoc @@ -0,0 +1,67 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +var: # a suffix variable + - val1 + - val2 +dyn{{ suffix }}: + description: a dynamic family + type: dynamic + dynamic: + type: variable + variable: _.var + var: + description: Suffix has value + default: + type: suffix +---- +== Variables for "rougail" + +[cols="108a,108a",options="header"] +|==== +| 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 + +`standard` + + +This family builds families dynamically. + +**Suffixes**: the value of the variable "rougail.var". + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**rougail.dynval1.var** ou **rougail.dynval2.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +Suffix has value. + +**Default**: value of the suffix. +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +rougail: + var: + - val1 + - val2 + dynval1: + var: val1 + dynval2: + var: val2 +---- diff --git a/tests/docs/base/60_5family_dynamic_calc_suffix2.md b/tests/docs/base/60_5family_dynamic_calc_suffix2.md new file mode 100644 index 0000000..f4580f6 --- /dev/null +++ b/tests/docs/base/60_5family_dynamic_calc_suffix2.md @@ -0,0 +1,56 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: # a suffix variable + - val1 + - val2 +dyn{{ suffix }}: + description: a dynamic family + type: dynamic + dynamic: + type: variable + variable: _.var + var: + description: Suffix has value + default: + type: suffix +``` +# Variables for "rougail" + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A suffix variable.
**Default**:
- val1
- val2 | + +## a dynamic family + +`standard` + + +This family builds families dynamically. + +**Suffixes**: the value of the variable "rougail.var". + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dynval1.var** ou **rougail.dynval2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Suffix has value.
**Default**: value of the suffix. | + + +# Example with all variables modifiable + +```yaml +--- +rougail: + var: + - val1 + - val2 + dynval1: + var: val1 + dynval2: + var: val2 +``` diff --git a/tests/docs/base/60_5family_dynamic_calc_suffix_param.adoc b/tests/docs/base/60_5family_dynamic_calc_suffix_param.adoc new file mode 100644 index 0000000..2ed4414 --- /dev/null +++ b/tests/docs/base/60_5family_dynamic_calc_suffix_param.adoc @@ -0,0 +1,73 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +var: # A suffix variable + - val1 + - val2 +dyn{{ suffix }}: + description: A dynamic family + type: dynamic + dynamic: + type: variable + variable: _.var + var: + description: A dynamic variable + default: + type: jinja + jinja: | + {{ suffix }} + params: + suffix: + type: suffix + description: from suffix +---- +== Variables for "rougail" + +[cols="108a,108a",options="header"] +|==== +| 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 + +`standard` + + +This family builds families dynamically. + +**Suffixes**: the value of the variable "rougail.var". + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**rougail.dynval1.var** ou **rougail.dynval2.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A dynamic variable. + +**Default**: from suffix. +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +rougail: + var: + - val1 + - val2 + dynval1: + var: val1 + dynval2: + var: val2 +---- diff --git a/tests/docs/base/60_5family_dynamic_calc_suffix_param.md b/tests/docs/base/60_5family_dynamic_calc_suffix_param.md new file mode 100644 index 0000000..12f063e --- /dev/null +++ b/tests/docs/base/60_5family_dynamic_calc_suffix_param.md @@ -0,0 +1,62 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: # A suffix variable + - val1 + - val2 +dyn{{ suffix }}: + description: A dynamic family + type: dynamic + dynamic: + type: variable + variable: _.var + var: + description: A dynamic variable + default: + type: jinja + jinja: | + {{ suffix }} + params: + suffix: + type: suffix + description: from suffix +``` +# Variables for "rougail" + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A suffix variable.
**Default**:
- val1
- val2 | + +## A dynamic family + +`standard` + + +This family builds families dynamically. + +**Suffixes**: the value of the variable "rougail.var". + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dynval1.var** ou **rougail.dynval2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A dynamic variable.
**Default**: from suffix. | + + +# Example with all variables modifiable + +```yaml +--- +rougail: + var: + - val1 + - val2 + dynval1: + var: val1 + dynval2: + var: val2 +``` diff --git a/tests/docs/base/60_5family_dynamic_calc_variable.adoc b/tests/docs/base/60_5family_dynamic_calc_variable.adoc new file mode 100644 index 0000000..b6a56d9 --- /dev/null +++ b/tests/docs/base/60_5family_dynamic_calc_variable.adoc @@ -0,0 +1,93 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +var1: + description: A suffix variable + default: + - val1 + - val2 +dyn{{ suffix }}: + type: dynamic + dynamic: + type: variable + variable: _.var1 + propertyerror: false + var: + description: A dynamic variable +var2: + description: A variable calculated + default: + type: variable + variable: _.dynval1.var +---- +== Variables for "rougail" + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**rougail.var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +A suffix variable. + +**Default**: + +* val1 +* val2 +|==== + +=== "dyn_val1_" ou "dyn_val2_" + +`basic` + + +This family builds families dynamically. + +**Suffixes**: the value of the variable "rougail.var1". + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**rougail.dynval1.var** ou **rougail.dynval2.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A dynamic variable. +|==== + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**rougail.var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A variable calculated. + +**Default**: the value of the variable "rougail.dynval1.var". +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +rougail: + dynval1: + var: example + dynval2: + var: example + var2: example +---- +== Example with all variables modifiable + +[,yaml] +---- +rougail: + var1: + - val1 + - val2 + dynval1: + var: example + dynval2: + var: example + var2: example +---- diff --git a/tests/docs/base/60_5family_dynamic_calc_variable.md b/tests/docs/base/60_5family_dynamic_calc_variable.md new file mode 100644 index 0000000..b9f270a --- /dev/null +++ b/tests/docs/base/60_5family_dynamic_calc_variable.md @@ -0,0 +1,77 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: + description: A suffix variable + default: + - val1 + - val2 +dyn{{ suffix }}: + type: dynamic + dynamic: + type: variable + variable: _.var1 + propertyerror: false + var: + description: A dynamic variable +var2: + description: A variable calculated + default: + type: variable + variable: _.dynval1.var +``` +# 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 | + +## "dyn*val1*" ou "dyn*val2*" + +`basic` + + +This family builds families dynamically. + +**Suffixes**: the value of the variable "rougail.var1". + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dynval1.var** ou **rougail.dynval2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A dynamic variable. | + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable calculated.
**Default**: the value of the variable "rougail.dynval1.var". | + + +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + dynval1: + var: example + dynval2: + var: example + var2: example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var1: + - val1 + - val2 + dynval1: + var: example + dynval2: + var: example + var2: example +``` diff --git a/tests/docs/base/60_5family_dynamic_hidden_suffix.adoc b/tests/docs/base/60_5family_dynamic_hidden_suffix.adoc new file mode 100644 index 0000000..0b33d3e --- /dev/null +++ b/tests/docs/base/60_5family_dynamic_hidden_suffix.adoc @@ -0,0 +1,93 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +dyn{{ suffix }}: + description: a dynamic family + type: dynamic + dynamic: + - val1 + - val2 + hidden: + type: jinja + jinja: | + {% if suffix == 'val2' %} + disabled + {% endif %} + params: + suffix: + type: suffix + description: if suffix == 'val2' + + var: # a variable + family: # a family + var: # a new variable +---- +== Variables for "rougail" + +=== a dynamic family + +`basic` _`hidden`_ + +**Hidden**: if suffix == 'val2'. + + +This family builds families dynamically. + +**Suffixes**: + +* val1 +* val2 + +[cols="105a,105a",options="header"] +|==== +| Variable | Description +| +**rougail.dynval1.var** ou **rougail.dynval2.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A variable. +|==== + +==== a family + +`basic` + +[cols="105a,105a",options="header"] +|==== +| Variable | Description +| +**rougail.dynval1.family.var** ou **rougail.dynval2.family.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A new variable. +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +rougail: + dynval1: + var: example + family: + var: example + dynval2: + var: example + family: + var: example +---- +== Example with all variables modifiable + +[,yaml] +---- +rougail: + dynval1: + var: example + family: + var: example + dynval2: + var: example + family: + var: example +---- diff --git a/tests/docs/base/60_5family_dynamic_hidden_suffix.md b/tests/docs/base/60_5family_dynamic_hidden_suffix.md new file mode 100644 index 0000000..b40ef1e --- /dev/null +++ b/tests/docs/base/60_5family_dynamic_hidden_suffix.md @@ -0,0 +1,84 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +dyn{{ suffix }}: + description: a dynamic family + type: dynamic + dynamic: + - val1 + - val2 + hidden: + type: jinja + jinja: | + {% if suffix == 'val2' %} + disabled + {% endif %} + params: + suffix: + type: suffix + description: if suffix == 'val2' + + var: # a variable + family: # a family + var: # a new variable +``` +# Variables for "rougail" + +## a dynamic family + +`basic` _`hidden`_ + +**Hidden**: if suffix == 'val2'. + + +This family builds families dynamically. + +**Suffixes**:
- val1
- val2 + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dynval1.var** ou **rougail.dynval2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | + +### a family + +`basic` + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dynval1.family.var** ou **rougail.dynval2.family.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A new variable. | + + +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + dynval1: + var: example + family: + var: example + dynval2: + var: example + family: + var: example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + dynval1: + var: example + family: + var: example + dynval2: + var: example + family: + var: example +``` diff --git a/tests/docs/base/60_5family_dynamic_variable_outside.adoc b/tests/docs/base/60_5family_dynamic_variable_outside.adoc new file mode 100644 index 0000000..b86403f --- /dev/null +++ b/tests/docs/base/60_5family_dynamic_variable_outside.adoc @@ -0,0 +1,87 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +var: # a suffix variable + - val1 + - val2 +my_dyn_family_{{ suffix }}: + description: a dynamic family + type: dynamic + dynamic: + type: variable + variable: _.var + var: + description: a variable inside a dynamic family + default: + type: suffix + mandatory: false +var2: + description: a variable + multi: true + default: + type: variable + variable: rougail.my_dyn_family_{{ suffix }}.var +---- +== Variables for "rougail" + +[cols="128a,128a",options="header"] +|==== +| 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 + +`standard` + + +This family builds families dynamically. + +**Suffixes**: the value of the variable "rougail.var". + +[cols="128a,128a",options="header"] +|==== +| Variable | Description +| +**rougail.my_dyn_family_val1.var** ou **rougail.my_dyn_family_val2.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | +A variable inside a dynamic family. + +**Default**: value of the suffix. +|==== + +[cols="128a,128a",options="header"] +|==== +| 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_{{ suffix }}.var". +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +rougail: + var: + - val1 + - val2 + my_dyn_family_val1: + var: val1 + my_dyn_family_val2: + var: val2 + var2: + - val1 + - val2 +---- diff --git a/tests/docs/base/60_5family_dynamic_variable_outside.md b/tests/docs/base/60_5family_dynamic_variable_outside.md new file mode 100644 index 0000000..aa91b0a --- /dev/null +++ b/tests/docs/base/60_5family_dynamic_variable_outside.md @@ -0,0 +1,70 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: # a suffix variable + - val1 + - val2 +my_dyn_family_{{ suffix }}: + description: a dynamic family + type: dynamic + dynamic: + type: variable + variable: _.var + var: + description: a variable inside a dynamic family + default: + type: suffix + mandatory: false +var2: + description: a variable + multi: true + default: + type: variable + variable: rougail.my_dyn_family_{{ suffix }}.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 + +`standard` + + +This family builds families dynamically. + +**Suffixes**: the value of the variable "rougail.var". + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.my_dyn_family_val1.var** ou **rougail.my_dyn_family_val2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A variable inside a dynamic family.
**Default**: value of the suffix. | + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A variable.
**Default**: the value of the variable "rougail.my_dyn_family_{{ suffix }}.var". | + + +# Example with all variables modifiable + +```yaml +--- +rougail: + var: + - val1 + - val2 + my_dyn_family_val1: + var: val1 + my_dyn_family_val2: + var: val2 + var2: + - val1 + - val2 +``` diff --git a/tests/docs/base/60_5family_dynamic_variable_outside_suffix.adoc b/tests/docs/base/60_5family_dynamic_variable_outside_suffix.adoc new file mode 100644 index 0000000..cd42f9a --- /dev/null +++ b/tests/docs/base/60_5family_dynamic_variable_outside_suffix.adoc @@ -0,0 +1,83 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +var: # a suffix variable + - val1 + - val2 +dyn_{{ suffix }}: + description: a dynamic family + type: dynamic + dynamic: + type: variable + variable: _.var + var: + description: a variable inside dynamic family + default: + type: suffix +var2: + description: a variable + default: + type: variable + variable: _.dyn_val1.var +---- +== Variables for "rougail" + +[cols="108a,108a",options="header"] +|==== +| 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 + +`standard` + + +This family builds families dynamically. + +**Suffixes**: the value of the variable "rougail.var". + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**rougail.dyn_val1.var** ou **rougail.dyn_val2.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A variable inside dynamic family. + +**Default**: value of the suffix. +|==== + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**rougail.var2** + +`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". +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +rougail: + var: + - val1 + - val2 + dyn_val1: + var: val1 + dyn_val2: + var: val2 + var2: val1 +---- diff --git a/tests/docs/base/60_5family_dynamic_variable_outside_suffix.md b/tests/docs/base/60_5family_dynamic_variable_outside_suffix.md new file mode 100644 index 0000000..b9232af --- /dev/null +++ b/tests/docs/base/60_5family_dynamic_variable_outside_suffix.md @@ -0,0 +1,66 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: # a suffix variable + - val1 + - val2 +dyn_{{ suffix }}: + description: a dynamic family + type: dynamic + dynamic: + type: variable + variable: _.var + var: + description: a variable inside dynamic family + default: + type: suffix +var2: + description: a variable + default: + type: variable + variable: _.dyn_val1.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 + +`standard` + + +This family builds families dynamically. + +**Suffixes**: the value of the variable "rougail.var". + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dyn_val1.var** ou **rougail.dyn_val2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable inside dynamic family.
**Default**: value of the suffix. | + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: the value of the variable "rougail.dyn_val1.var". | + + +# Example with all variables modifiable + +```yaml +--- +rougail: + var: + - val1 + - val2 + dyn_val1: + var: val1 + dyn_val2: + var: val2 + var2: val1 +``` diff --git a/tests/docs/base/60_6family_dynamic_inside.adoc b/tests/docs/base/60_6family_dynamic_inside.adoc new file mode 100644 index 0000000..dad17fc --- /dev/null +++ b/tests/docs/base/60_6family_dynamic_inside.adoc @@ -0,0 +1,104 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +var: # a suffix variable + - val1 + - val2 + +'{{ suffix }}_dyn': + description: a dynamic family + type: dynamic + dynamic: + type: variable + variable: _.var + var1: + description: value is suffix + default: + type: suffix + var2: + description: value is first variable + default: + type: variable + variable: rougail.{{ suffix }}_dyn.var1 + var3: + description: value is relative first variable + default: + type: variable + variable: _.var1 + var4: + description: value is first variable of val1 + default: + type: variable + variable: rougail.val1_dyn.var1 +---- +== Variables for "rougail" + +[cols="108a,108a",options="header"] +|==== +| 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 + +`standard` + + +This family builds families dynamically. + +**Suffixes**: the value of the variable "rougail.var". + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**rougail.val1_dyn.var1** ou **rougail.val2_dyn.var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +Value is suffix. + +**Default**: value of the suffix. +| +**rougail.val1_dyn.var2** ou **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.{{ suffix }}_dyn.var1". +| +**rougail.val1_dyn.var3** ou **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.{{ suffix }}_dyn.var1". +| +**rougail.val1_dyn.var4** ou **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". +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +rougail: + var: + - val1 + - val2 + val1_dyn: + var1: val1 + var2: val1 + var3: val1 + var4: val1 + val2_dyn: + var1: val2 + var2: val2 + var3: val2 + var4: val1 +---- diff --git a/tests/docs/base/60_6family_dynamic_inside.md b/tests/docs/base/60_6family_dynamic_inside.md new file mode 100644 index 0000000..18bb195 --- /dev/null +++ b/tests/docs/base/60_6family_dynamic_inside.md @@ -0,0 +1,81 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: # a suffix variable + - val1 + - val2 + +'{{ suffix }}_dyn': + description: a dynamic family + type: dynamic + dynamic: + type: variable + variable: _.var + var1: + description: value is suffix + default: + type: suffix + var2: + description: value is first variable + default: + type: variable + variable: rougail.{{ suffix }}_dyn.var1 + var3: + description: value is relative first variable + default: + type: variable + variable: _.var1 + var4: + description: value is first variable of val1 + default: + type: variable + variable: rougail.val1_dyn.var1 +``` +# Variables for "rougail" + +| 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. + +**Suffixes**: the value of the variable "rougail.var". + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.val1_dyn.var1** ou **rougail.val2_dyn.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Value is suffix.
**Default**: value of the suffix. | +| **rougail.val1_dyn.var2** ou **rougail.val2_dyn.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Value is first variable.
**Default**: the value of the variable "rougail.{{ suffix }}_dyn.var1". | +| **rougail.val1_dyn.var3** ou **rougail.val2_dyn.var3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Value is relative first variable.
**Default**: the value of the variable "rougail.{{ suffix }}_dyn.var1". | +| **rougail.val1_dyn.var4** ou **rougail.val2_dyn.var4**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Value is first variable of val1.
**Default**: the value of the variable "rougail.val1_dyn.var1". | + + +# Example with all variables modifiable + +```yaml +--- +rougail: + var: + - val1 + - val2 + val1_dyn: + var1: val1 + var2: val1 + var3: val1 + var4: val1 + val2_dyn: + var1: val2 + var2: val2 + var3: val2 + var4: val1 +``` diff --git a/tests/docs/base/60_6family_dynamic_leadership.adoc b/tests/docs/base/60_6family_dynamic_leadership.adoc new file mode 100644 index 0000000..2d5afad --- /dev/null +++ b/tests/docs/base/60_6family_dynamic_leadership.adoc @@ -0,0 +1,95 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +var: # a suffix variable + - val1 + - val2 +dyn{{ suffix }}: + description: a dynamic family + type: dynamic + dynamic: + type: variable + variable: _.var + leadership: + description: a leadership + type: leadership + leader: + description: a leader + multi: true + follower1: + description: a follower1 + mandatory: false + follower2: + description: a follower2 + mandatory: false +---- +== Variables for "rougail" + +[cols="96a,96a",options="header"] +|==== +| 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. + +**Suffixes**: the value of the variable "rougail.var". + +==== a leadership + +`basic` + + +This family contains lists of variable blocks. + +[cols="96a,96a",options="header"] +|==== +| Variable | Description +| +**rougail.dynval1.leadership.leader** ou **rougail.dynval2.leadership.leader** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | +A leader. +| +**rougail.dynval1.leadership.follower1** ou **rougail.dynval2.leadership.follower1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | +A follower1. +| +**rougail.dynval1.leadership.follower2** ou **rougail.dynval2.leadership.follower2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | +A follower2. +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +rougail: + var: + - val1 + - val2 + dynval1: + leadership: + - leader: example + follower1: example + follower2: example + dynval2: + leadership: + - leader: example + follower1: example + follower2: example +---- diff --git a/tests/docs/base/60_6family_dynamic_leadership.md b/tests/docs/base/60_6family_dynamic_leadership.md new file mode 100644 index 0000000..a3b3029 --- /dev/null +++ b/tests/docs/base/60_6family_dynamic_leadership.md @@ -0,0 +1,79 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: # a suffix variable + - val1 + - val2 +dyn{{ suffix }}: + description: a dynamic family + type: dynamic + dynamic: + type: variable + variable: _.var + leadership: + description: a leadership + type: leadership + leader: + description: a leader + multi: true + follower1: + description: a follower1 + mandatory: false + follower2: + description: a follower2 + mandatory: false +``` +# Variables for "rougail" + +| Variable                                                                                       | Description                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`string`](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. + +**Suffixes**: the value of the variable "rougail.var". + +### a leadership + +`basic` + + +This family contains lists of variable blocks. + +| Variable                                                                                       | Description                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dynval1.leadership.leader** ou **rougail.dynval2.leadership.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | A leader. | +| **rougail.dynval1.leadership.follower1** ou **rougail.dynval2.leadership.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A follower1. | +| **rougail.dynval1.leadership.follower2** ou **rougail.dynval2.leadership.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A follower2. | + + +# Example with all variables modifiable + +```yaml +--- +rougail: + var: + - val1 + - val2 + dynval1: + leadership: + - leader: example + follower1: example + follower2: example + dynval2: + leadership: + - leader: example + follower1: example + follower2: example +``` diff --git a/tests/docs/base/60_6family_dynamic_sub_dynamic.adoc b/tests/docs/base/60_6family_dynamic_sub_dynamic.adoc new file mode 100644 index 0000000..fe861f8 --- /dev/null +++ b/tests/docs/base/60_6family_dynamic_sub_dynamic.adoc @@ -0,0 +1,151 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +var: # A suffix variable + - val1 + - val2 +dyn{{ suffix }}: + description: A dynamic family + type: dynamic + dynamic: + type: variable + variable: _.var + var: + description: A dynamic variable + multi: true + default: + type: jinja + jinja: | + {% for val in __.var %} + t{{ val }} + {% endfor %} + description: add 't' to each var value + dyn_{{ suffix }}: + description: a Second dynamic variable + type: dynamic + dynamic: + type: variable + variable: rougail.dyn{{ suffix }}.var + var: + description: A variable dynamic + default: + type: suffix + var_suffix: + description: suffix from first family + default: + type: suffix + suffix: 0 + var_suffixes: + description: merge suffixes + default: + type: jinja + jinja: | + {{ s1 }}-{{ s2 }} + params: + s1: + type: suffix + suffix: 0 + s2: + type: suffix + suffix: 1 + description: join suffix 1 et suffix 2 +---- +== Variables for "rougail" + +[cols="108a,108a",options="header"] +|==== +| 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 + +`standard` + + +This family builds families dynamically. + +**Suffixes**: the value of the variable "rougail.var". + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**rougail.dynval1.var** ou **rougail.dynval2.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +A dynamic variable. + +**Default**: add 't' to each var value. +|==== + +==== a Second dynamic variable + +`standard` + + +This family builds families dynamically. + +**Suffixes**: the value of the variable "rougail.dyn{{ suffix }}.var". + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**rougail.dynval1.dyn_tval1.var**, **rougail.dynval1.dyn_tval2.var**, **rougail.dynval2.dyn_tval1.var** ou **rougail.dynval2.dyn_tval2.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A variable dynamic. + +**Default**: value of the suffix. +| +**rougail.dynval1.dyn_tval1.var_suffix**, **rougail.dynval1.dyn_tval2.var_suffix**, **rougail.dynval2.dyn_tval1.var_suffix** ou **rougail.dynval2.dyn_tval2.var_suffix** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +Suffix from first family. + +**Default**: value of the suffix. +| +**rougail.dynval1.dyn_tval1.var_suffixes**, **rougail.dynval1.dyn_tval2.var_suffixes**, **rougail.dynval2.dyn_tval1.var_suffixes** ou **rougail.dynval2.dyn_tval2.var_suffixes** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +Merge suffixes. + +**Default**: join suffix 1 et suffix 2. +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +rougail: + var: + - val1 + - val2 + dynval1: + var: + - tval1 + - tval2 + dyn_tval1: + var: tval1 + var_suffix: val1 + var_suffixes: val1-tval1 + dyn_tval2: + var: tval2 + var_suffix: val1 + var_suffixes: val1-tval2 + dynval2: + var: + - tval1 + - tval2 + dyn_tval1: + var: tval1 + var_suffix: val2 + var_suffixes: val2-tval1 + dyn_tval2: + var: tval2 + var_suffix: val2 + var_suffixes: val2-tval2 +---- diff --git a/tests/docs/base/60_6family_dynamic_sub_dynamic.md b/tests/docs/base/60_6family_dynamic_sub_dynamic.md new file mode 100644 index 0000000..719bc4f --- /dev/null +++ b/tests/docs/base/60_6family_dynamic_sub_dynamic.md @@ -0,0 +1,126 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: # A suffix variable + - val1 + - val2 +dyn{{ suffix }}: + description: A dynamic family + type: dynamic + dynamic: + type: variable + variable: _.var + var: + description: A dynamic variable + multi: true + default: + type: jinja + jinja: | + {% for val in __.var %} + t{{ val }} + {% endfor %} + description: add 't' to each var value + dyn_{{ suffix }}: + description: a Second dynamic variable + type: dynamic + dynamic: + type: variable + variable: rougail.dyn{{ suffix }}.var + var: + description: A variable dynamic + default: + type: suffix + var_suffix: + description: suffix from first family + default: + type: suffix + suffix: 0 + var_suffixes: + description: merge suffixes + default: + type: jinja + jinja: | + {{ s1 }}-{{ s2 }} + params: + s1: + type: suffix + suffix: 0 + s2: + type: suffix + suffix: 1 + description: join suffix 1 et suffix 2 +``` +# Variables for "rougail" + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A suffix variable.
**Default**:
- val1
- val2 | + +## A dynamic family + +`standard` + + +This family builds families dynamically. + +**Suffixes**: the value of the variable "rougail.var". + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dynval1.var** ou **rougail.dynval2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A dynamic variable.
**Default**: add 't' to each var value. | + +### a Second dynamic variable + +`standard` + + +This family builds families dynamically. + +**Suffixes**: the value of the variable "rougail.dyn{{ suffix }}.var". + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dynval1.dyn_tval1.var**, **rougail.dynval1.dyn_tval2.var**, **rougail.dynval2.dyn_tval1.var** ou **rougail.dynval2.dyn_tval2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable dynamic.
**Default**: value of the suffix. | +| **rougail.dynval1.dyn_tval1.var_suffix**, **rougail.dynval1.dyn_tval2.var_suffix**, **rougail.dynval2.dyn_tval1.var_suffix** ou **rougail.dynval2.dyn_tval2.var_suffix**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Suffix from first family.
**Default**: value of the suffix. | +| **rougail.dynval1.dyn_tval1.var_suffixes**, **rougail.dynval1.dyn_tval2.var_suffixes**, **rougail.dynval2.dyn_tval1.var_suffixes** ou **rougail.dynval2.dyn_tval2.var_suffixes**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Merge suffixes.
**Default**: join suffix 1 et suffix 2. | + + +# Example with all variables modifiable + +```yaml +--- +rougail: + var: + - val1 + - val2 + dynval1: + var: + - tval1 + - tval2 + dyn_tval1: + var: tval1 + var_suffix: val1 + var_suffixes: val1-tval1 + dyn_tval2: + var: tval2 + var_suffix: val1 + var_suffixes: val1-tval2 + dynval2: + var: + - tval1 + - tval2 + dyn_tval1: + var: tval1 + var_suffix: val2 + var_suffixes: val2-tval1 + dyn_tval2: + var: tval2 + var_suffix: val2 + var_suffixes: val2-tval2 +``` diff --git a/tests/docs/base/60_9extra_dynamic.adoc b/tests/docs/base/60_9extra_dynamic.adoc new file mode 100644 index 0000000..cbd47f1 --- /dev/null +++ b/tests/docs/base/60_9extra_dynamic.adoc @@ -0,0 +1,75 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: 1.1 +var: # a variable + - a +---- +== dictionaries/extra/00-base.yml + +[,yaml] +---- +version: 1.1 +dyn_{{ suffix }}: + type: dynamic + dynamic: + type: variable + variable: rougail.var + var: +---- +== Variables for "rougail" + +[cols="128a,128a",options="header"] +|==== +| Variable | Description +| +**rougail.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +A variable. + +**Default**: + +* a +|==== + + +== Variables for "extra" + +=== "dyn__a_" + +`basic` + + +This family builds families dynamically. + +**Suffixes**: the value of the variable "rougail.var". + +[cols="105a,105a",options="header"] +|==== +| Variable | Description +| +**extra.dyn_a.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +Var. +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +extra: + dyn_a: + var: example +---- +== Example with all variables modifiable + +[,yaml] +---- +rougail: + var: + - a +extra: + dyn_a: + var: example +---- diff --git a/tests/docs/base/60_9extra_dynamic.md b/tests/docs/base/60_9extra_dynamic.md new file mode 100644 index 0000000..45f9b35 --- /dev/null +++ b/tests/docs/base/60_9extra_dynamic.md @@ -0,0 +1,66 @@ +--- +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_{{ suffix }}: + type: dynamic + dynamic: + type: variable + variable: rougail.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 variable.
**Default**:
- a | + + +# Variables for "extra" + +## "dyn_*a*" + +`basic` + + +This family builds families dynamically. + +**Suffixes**: 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. | + + +# Example with mandatory variables not filled in + +```yaml +--- +extra: + dyn_a: + var: example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var: + - a +extra: + dyn_a: + var: example +``` diff --git a/tests/docs/base/60_9extra_dynamic_extra.adoc b/tests/docs/base/60_9extra_dynamic_extra.adoc new file mode 100644 index 0000000..e4be9b3 --- /dev/null +++ b/tests/docs/base/60_9extra_dynamic_extra.adoc @@ -0,0 +1,102 @@ +== 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_{{ suffix }}: + type: dynamic + dynamic: + type: variable + variable: _.var + var: +---- +== Variables for "rougail" + +=== général + +`standard` + +[cols="128a,128a",options="header"] +|==== +| Variable | Description +| +**rougail.general.varname** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +No change. + +**Default**: + +* a +|==== + + +== Variables for "extra" + +[cols="105a,105a",options="header"] +|==== +| Variable | Description +| +**extra.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +A varaible. + +**Default**: + +* a +|==== + +=== "dyn__a_" + +`basic` + + +This family builds families dynamically. + +**Suffixes**: the value of the variable "extra.var". + +[cols="105a,105a",options="header"] +|==== +| Variable | Description +| +**extra.dyn_a.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +Var. +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +extra: + dyn_a: + var: example +---- +== Example with all variables modifiable + +[,yaml] +---- +rougail: + general: + varname: + - a +extra: + var: + - a + dyn_a: + var: example +---- diff --git a/tests/docs/base/60_9extra_dynamic_extra.md b/tests/docs/base/60_9extra_dynamic_extra.md new file mode 100644 index 0000000..51db57b --- /dev/null +++ b/tests/docs/base/60_9extra_dynamic_extra.md @@ -0,0 +1,85 @@ +--- +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_{{ suffix }}: + type: dynamic + dynamic: + type: variable + variable: _.var + var: +``` +# Variables for "rougail" + +## général + +`standard` + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.general.varname**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | No change.
**Default**:
- a | + + +# Variables for "extra" + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **extra.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A varaible.
**Default**:
- a | + +## "dyn_*a*" + +`basic` + + +This family builds families dynamically. + +**Suffixes**: 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. | + + +# Example with mandatory variables not filled in + +```yaml +--- +extra: + dyn_a: + var: example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + general: + varname: + - a +extra: + var: + - a + dyn_a: + var: example +``` diff --git a/tests/docs/base/60_9family_dynamic_calc_both.adoc b/tests/docs/base/60_9family_dynamic_calc_both.adoc new file mode 100644 index 0000000..eaab794 --- /dev/null +++ b/tests/docs/base/60_9family_dynamic_calc_both.adoc @@ -0,0 +1,70 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +var: val2 # a suffix variable +dyn{{ suffix }}: + type: dynamic + description: a dynamic family + dynamic: + - val1 + - type: variable + variable: _.var + vardyn: # a dynamic variable +---- +== Variables for "rougail" + +[cols="105a,105a",options="header"] +|==== +| Variable | Description +| +**rougail.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A suffix variable. + +**Default**: val2 +|==== + +=== a dynamic family + +`basic` + + +This family builds families dynamically. + +**Suffixes**: + +* val1 +* the value of the variable "rougail.var". + +[cols="105a,105a",options="header"] +|==== +| Variable | Description +| +**rougail.dynval1.vardyn** ou **rougail.dynval2.vardyn** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A dynamic variable. +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +rougail: + dynval1: + vardyn: example + dynval2: + vardyn: example +---- +== Example with all variables modifiable + +[,yaml] +---- +rougail: + var: val2 + dynval1: + vardyn: example + dynval2: + vardyn: example +---- diff --git a/tests/docs/base/60_9family_dynamic_calc_both.md b/tests/docs/base/60_9family_dynamic_calc_both.md new file mode 100644 index 0000000..d072aa1 --- /dev/null +++ b/tests/docs/base/60_9family_dynamic_calc_both.md @@ -0,0 +1,60 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: val2 # a suffix variable +dyn{{ suffix }}: + type: dynamic + description: a dynamic family + dynamic: + - val1 + - type: variable + variable: _.var + vardyn: # a dynamic variable +``` +# Variables for "rougail" + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A suffix variable.
**Default**: val2 | + +## a dynamic family + +`basic` + + +This family builds families dynamically. + +**Suffixes**:
- val1
- the value of the variable "rougail.var". + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dynval1.vardyn** ou **rougail.dynval2.vardyn**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A dynamic variable. | + + +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + dynval1: + vardyn: example + dynval2: + vardyn: example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var: val2 + dynval1: + vardyn: example + dynval2: + vardyn: example +``` diff --git a/tests/docs/base/68_0family_leadership_mode.adoc b/tests/docs/base/68_0family_leadership_mode.adoc new file mode 100644 index 0000000..f266948 --- /dev/null +++ b/tests/docs/base/68_0family_leadership_mode.adoc @@ -0,0 +1,56 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.0' +leader: + description: A leadership + type: leadership + leader: + description: A leader + multi: true + mandatory: false + follower1: + description: a follower1 + mandatory: false + follower2: + description: a follower2 + mode: basic +---- +== Variables for "rougail" + +=== A leadership + +`basic` + + +This family contains lists of variable blocks. + +[cols="105a,105a",options="header"] +|==== +| Variable | Description +| +**rougail.leader.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. +| +**rougail.leader.follower2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A follower2. +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +rougail: + leader: + - leader: example + follower1: example + follower2: example +---- diff --git a/tests/docs/base/68_0family_leadership_mode.md b/tests/docs/base/68_0family_leadership_mode.md new file mode 100644 index 0000000..8f21d1e --- /dev/null +++ b/tests/docs/base/68_0family_leadership_mode.md @@ -0,0 +1,49 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.0' +leader: + description: A leadership + type: leadership + leader: + description: A leader + multi: true + mandatory: false + follower1: + description: a follower1 + mandatory: false + follower2: + description: a follower2 + mode: basic +``` +# Variables for "rougail" + +## A leadership + +`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. | + + +# Example with all variables modifiable + +```yaml +--- +rougail: + leader: + - leader: example + follower1: example + follower2: example +``` diff --git a/tests/docs/no_namespace/00_0empty.adoc b/tests/docs/no_namespace/00_0empty.adoc new file mode 100644 index 0000000..e69de29 diff --git a/tests/docs/no_namespace/00_0empty.md b/tests/docs/no_namespace/00_0empty.md new file mode 100644 index 0000000..3fc684d --- /dev/null +++ b/tests/docs/no_namespace/00_0empty.md @@ -0,0 +1,4 @@ +--- +gitea: none +include_toc: true +--- diff --git a/tests/docs/no_namespace/00_0version_underscore.adoc b/tests/docs/no_namespace/00_0version_underscore.adoc new file mode 100644 index 0000000..09e6aab --- /dev/null +++ b/tests/docs/no_namespace/00_0version_underscore.adoc @@ -0,0 +1,31 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +_version: '1.1' +version: # a variable +---- +== Variables + +[cols="105a,105a",options="header"] +|==== +| Variable | Description +| +**version** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A variable. +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +version: example +---- +== Example with all variables modifiable + +[,yaml] +---- +version: example +---- diff --git a/tests/docs/no_namespace/00_0version_underscore.md b/tests/docs/no_namespace/00_0version_underscore.md new file mode 100644 index 0000000..2709ed2 --- /dev/null +++ b/tests/docs/no_namespace/00_0version_underscore.md @@ -0,0 +1,30 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +_version: '1.1' +version: # a variable +``` +# Variables + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **version**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | + + +# Example with mandatory variables not filled in + +```yaml +--- +version: example +``` +# Example with all variables modifiable + +```yaml +--- +version: example +``` diff --git a/tests/docs/no_namespace/00_1empty_variable.adoc b/tests/docs/no_namespace/00_1empty_variable.adoc new file mode 100644 index 0000000..7dd7fda --- /dev/null +++ b/tests/docs/no_namespace/00_1empty_variable.adoc @@ -0,0 +1,31 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.0' +empty: +---- +== Variables + +[cols="105a,105a",options="header"] +|==== +| Variable | Description +| +**empty** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +Empty. +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +empty: example +---- +== Example with all variables modifiable + +[,yaml] +---- +empty: example +---- diff --git a/tests/docs/no_namespace/00_1empty_variable.md b/tests/docs/no_namespace/00_1empty_variable.md new file mode 100644 index 0000000..10e4000 --- /dev/null +++ b/tests/docs/no_namespace/00_1empty_variable.md @@ -0,0 +1,30 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.0' +empty: +``` +# Variables + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **empty**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | Empty. | + + +# Example with mandatory variables not filled in + +```yaml +--- +empty: example +``` +# Example with all variables modifiable + +```yaml +--- +empty: example +``` diff --git a/tests/docs/no_namespace/00_2default_calculated.adoc b/tests/docs/no_namespace/00_2default_calculated.adoc new file mode 100644 index 0000000..959e5fc --- /dev/null +++ b/tests/docs/no_namespace/00_2default_calculated.adoc @@ -0,0 +1,41 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: 1.1 +var1: no # a first variable +var2: + description: a second variable + multi: true + default: + type: jinja + jinja: | + {{ _.var1 }} + description: the value of var1 +---- +== Variables + +[cols="128a,128a",options="header"] +|==== +| Variable | Description +| +**var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A first variable. + +**Default**: no +| +**var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +A second variable. + +**Default**: the value of var1. +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +var1: no +var2: + - no +---- diff --git a/tests/docs/no_namespace/00_2default_calculated.md b/tests/docs/no_namespace/00_2default_calculated.md new file mode 100644 index 0000000..4b64b24 --- /dev/null +++ b/tests/docs/no_namespace/00_2default_calculated.md @@ -0,0 +1,35 @@ +--- +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: + type: jinja + jinja: | + {{ _.var1 }} + description: the value of var1 +``` +# Variables + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A first variable.
**Default**: no | +| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A second variable.
**Default**: the value of var1. | + + +# Example with all variables modifiable + +```yaml +--- +var1: no +var2: + - no +``` diff --git a/tests/docs/no_namespace/00_2default_calculated_multi.adoc b/tests/docs/no_namespace/00_2default_calculated_multi.adoc new file mode 100644 index 0000000..dff3ac3 --- /dev/null +++ b/tests/docs/no_namespace/00_2default_calculated_multi.adoc @@ -0,0 +1,55 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: 1.1 +var1: # a first variable + - no + - yes + - maybe +var2: + description: a second variable + multi: true + default: + type: jinja + jinja: | + {% for val in _.var1 %} + {{ val }} + {% endfor %} + description: the value of _.var1 +---- +== Variables + +[cols="128a,128a",options="header"] +|==== +| Variable | Description +| +**var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +A first variable. + +**Default**: + +* no +* yes +* maybe +| +**var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +A second variable. + +**Default**: the value of _.var1. +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +var1: + - no + - yes + - maybe +var2: + - no + - yes + - maybe +---- diff --git a/tests/docs/no_namespace/00_2default_calculated_multi.md b/tests/docs/no_namespace/00_2default_calculated_multi.md new file mode 100644 index 0000000..4330622 --- /dev/null +++ b/tests/docs/no_namespace/00_2default_calculated_multi.md @@ -0,0 +1,45 @@ +--- +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: + type: jinja + jinja: | + {% for val in _.var1 %} + {{ val }} + {% endfor %} + description: the value of _.var1 +``` +# Variables + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A first variable.
**Default**:
- no
- yes
- maybe | +| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A second variable.
**Default**: the value of _.var1. | + + +# Example with all variables modifiable + +```yaml +--- +var1: + - no + - yes + - maybe +var2: + - no + - yes + - maybe +``` diff --git a/tests/docs/no_namespace/00_4load_subfolder.adoc b/tests/docs/no_namespace/00_4load_subfolder.adoc new file mode 100644 index 0000000..8020d91 --- /dev/null +++ b/tests/docs/no_namespace/00_4load_subfolder.adoc @@ -0,0 +1,46 @@ +== dictionaries/rougail/99-base.yml + +[,yaml] +---- +version: '1.0' +var1: + description: a variable +---- +== dictionaries/rougail2/00-base.yml + +[,yaml] +---- +version: '1.0' +var2: + description: a variable +---- +== Variables + +[cols="105a,105a",options="header"] +|==== +| Variable | Description +| +**var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A variable. +| +**var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A variable. +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +var1: example +var2: example +---- +== Example with all variables modifiable + +[,yaml] +---- +var1: example +var2: example +---- diff --git a/tests/docs/no_namespace/00_4load_subfolder.md b/tests/docs/no_namespace/00_4load_subfolder.md new file mode 100644 index 0000000..82f8b19 --- /dev/null +++ b/tests/docs/no_namespace/00_4load_subfolder.md @@ -0,0 +1,42 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/99-base.yml + +```yaml +--- +version: '1.0' +var1: + description: a variable +``` +# dictionaries/rougail2/00-base.yml + +```yaml +--- +version: '1.0' +var2: + description: a variable +``` +# Variables + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | +| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | + + +# Example with mandatory variables not filled in + +```yaml +--- +var1: example +var2: example +``` +# Example with all variables modifiable + +```yaml +--- +var1: example +var2: example +``` diff --git a/tests/docs/no_namespace/00_5load_notype.adoc b/tests/docs/no_namespace/00_5load_notype.adoc new file mode 100644 index 0000000..8cec498 --- /dev/null +++ b/tests/docs/no_namespace/00_5load_notype.adoc @@ -0,0 +1,28 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.0' +without_type: + description: a variable + default: non +---- +== Variables + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**without_type** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A variable. + +**Default**: non +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +without_type: non +---- diff --git a/tests/docs/no_namespace/00_5load_notype.md b/tests/docs/no_namespace/00_5load_notype.md new file mode 100644 index 0000000..a199070 --- /dev/null +++ b/tests/docs/no_namespace/00_5load_notype.md @@ -0,0 +1,26 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.0' +without_type: + description: a variable + default: non +``` +# Variables + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **without_type**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: non | + + +# Example with all variables modifiable + +```yaml +--- +without_type: non +``` diff --git a/tests/docs/no_namespace/00_6boolean.adoc b/tests/docs/no_namespace/00_6boolean.adoc new file mode 100644 index 0000000..5291154 --- /dev/null +++ b/tests/docs/no_namespace/00_6boolean.adoc @@ -0,0 +1,71 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +var1: true # the first variable +var2: + description: the second variable + default: true +var3: + description: the third variable + type: boolean + default: true +var4: false # the forth variable +var5: + description: the fifth variable + default: false +var6: + description: the sixth variable + type: boolean + default: false +---- +== Variables + +[cols="109a,109a",options="header"] +|==== +| Variable | Description +| +**var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | +The first variable. + +**Default**: True +| +**var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | +The second variable. + +**Default**: True +| +**var3** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | +The third variable. + +**Default**: True +| +**var4** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | +The forth variable. + +**Default**: False +| +**var5** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | +The fifth variable. + +**Default**: False +| +**var6** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | +The sixth variable. + +**Default**: False +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +var1: true +var2: true +var3: true +var4: false +var5: false +var6: false +---- diff --git a/tests/docs/no_namespace/00_6boolean.md b/tests/docs/no_namespace/00_6boolean.md new file mode 100644 index 0000000..efabf1a --- /dev/null +++ b/tests/docs/no_namespace/00_6boolean.md @@ -0,0 +1,49 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: true # the first variable +var2: + description: the second variable + default: true +var3: + description: the third variable + type: boolean + default: true +var4: false # the forth variable +var5: + description: the fifth variable + default: false +var6: + description: the sixth variable + type: boolean + default: false +``` +# Variables + +| Variable                                                                                                    | Description                                                                                                 | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var1**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The first variable.
**Default**: True | +| **var2**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The second variable.
**Default**: True | +| **var3**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The third variable.
**Default**: True | +| **var4**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The forth variable.
**Default**: False | +| **var5**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The fifth variable.
**Default**: False | +| **var6**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The sixth variable.
**Default**: False | + + +# Example with all variables modifiable + +```yaml +--- +var1: true +var2: true +var3: true +var4: false +var5: false +var6: false +``` diff --git a/tests/docs/no_namespace/00_6boolean_no_mandatory.adoc b/tests/docs/no_namespace/00_6boolean_no_mandatory.adoc new file mode 100644 index 0000000..640da04 --- /dev/null +++ b/tests/docs/no_namespace/00_6boolean_no_mandatory.adoc @@ -0,0 +1,29 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +variable: + description: a variable + type: boolean + mandatory: false +---- +== Variables + +[cols="97a,97a",options="header"] +|==== +| Variable | Description +| +**variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` | +A variable. + +**Default**: True +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +variable: true +---- diff --git a/tests/docs/no_namespace/00_6boolean_no_mandatory.md b/tests/docs/no_namespace/00_6boolean_no_mandatory.md new file mode 100644 index 0000000..39398f6 --- /dev/null +++ b/tests/docs/no_namespace/00_6boolean_no_mandatory.md @@ -0,0 +1,27 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +variable: + description: a variable + type: boolean + mandatory: false +``` +# Variables + +| Variable                                                                                        | Description                                                                                     | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **variable**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A variable.
**Default**: True | + + +# Example with all variables modifiable + +```yaml +--- +variable: true +``` diff --git a/tests/docs/no_namespace/00_6choice.adoc b/tests/docs/no_namespace/00_6choice.adoc new file mode 100644 index 0000000..c2870c8 --- /dev/null +++ b/tests/docs/no_namespace/00_6choice.adoc @@ -0,0 +1,127 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +var1: + description: the first variable + choices: + - a + - b + - c +var2: + description: the second variable + choices: + - a + - b + - c +var3: + description: the third variable + choices: + - a + - b + - c + mandatory: false +var4: + description: the forth variable + choices: + - + - b + - c + mandatory: false +var5: + description: the fifth variable + choices: + - a + - b + - c + default: a +var6: + description: the sixth variable + choices: + - 1 + - 2 + - 3 + default: 1 +---- +== Variables + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `basic` `mandatory` | +The first variable. + +**Choices**: + +* a +* b +* c +| +**var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `basic` `mandatory` | +The second variable. + +**Choices**: + +* a +* b +* c +| +**var3** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` | +The third variable. + +**Choices**: + +* a +* b +* c +* null +| +**var4** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` | +The forth variable. + +**Choices**: + +* null +* b +* c +| +**var5** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` `mandatory` | +The fifth variable. + +**Choices**: + +* a ← (default) +* b +* c +| +**var6** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` `mandatory` | +The sixth variable. + +**Choices**: + +* 1 ← (default) +* 2 +* 3 +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +var1: a_choice +var2: a_choice +---- +== Example with all variables modifiable + +[,yaml] +---- +var1: a_choice +var2: a_choice +var3: a_choice +var4: a_choice +var5: a +var6: 1 +---- diff --git a/tests/docs/no_namespace/00_6choice.md b/tests/docs/no_namespace/00_6choice.md new file mode 100644 index 0000000..ce34e3a --- /dev/null +++ b/tests/docs/no_namespace/00_6choice.md @@ -0,0 +1,80 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: + description: the first variable + choices: + - a + - b + - c +var2: + description: the second variable + choices: + - a + - b + - c +var3: + description: the third variable + choices: + - a + - b + - c + mandatory: false +var4: + description: the forth variable + choices: + - + - b + - c + mandatory: false +var5: + description: the fifth variable + choices: + - a + - b + - c + default: a +var6: + description: the sixth variable + choices: + - 1 + - 2 + - 3 + default: 1 +``` +# Variables + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var1**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The first variable.
**Choices**:
- a
- b
- c | +| **var2**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The second variable.
**Choices**:
- a
- b
- c | +| **var3**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | The third variable.
**Choices**:
- a
- b
- c
- null | +| **var4**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | The forth variable.
**Choices**:
- null
- b
- c | +| **var5**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The fifth variable.
**Choices**:
- a ← (default)
- b
- c | +| **var6**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The sixth variable.
**Choices**:
- 1 ← (default)
- 2
- 3 | + + +# Example with mandatory variables not filled in + +```yaml +--- +var1: a_choice +var2: a_choice +``` +# Example with all variables modifiable + +```yaml +--- +var1: a_choice +var2: a_choice +var3: a_choice +var4: a_choice +var5: a +var6: 1 +``` diff --git a/tests/docs/no_namespace/00_6choice_calculation.adoc b/tests/docs/no_namespace/00_6choice_calculation.adoc new file mode 100644 index 0000000..8b21d80 --- /dev/null +++ b/tests/docs/no_namespace/00_6choice_calculation.adoc @@ -0,0 +1,37 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: 1.1 +var: + description: a variable + default: 9 + choices: + type: jinja + jinja: | + {% for n in trange(0, 10) %} + {{ n }} + {% endfor %} + return_type: number + description: choices is 0 to 9 +---- +== Variables + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` `mandatory` | +A variable. + +**Choices**: choices is 0 to 9. + +**Default**: 9 +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +var: 9 +---- diff --git a/tests/docs/no_namespace/00_6choice_calculation.md b/tests/docs/no_namespace/00_6choice_calculation.md new file mode 100644 index 0000000..57b49ca --- /dev/null +++ b/tests/docs/no_namespace/00_6choice_calculation.md @@ -0,0 +1,34 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: 1.1 +var: + description: a variable + default: 9 + choices: + type: jinja + jinja: | + {% for n in trange(0, 10) %} + {{ n }} + {% endfor %} + return_type: number + description: choices is 0 to 9 +``` +# Variables + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Choices**: choices is 0 to 9.
**Default**: 9 | + + +# Example with all variables modifiable + +```yaml +--- +var: 9 +``` diff --git a/tests/docs/no_namespace/00_6choice_variable.adoc b/tests/docs/no_namespace/00_6choice_variable.adoc new file mode 100644 index 0000000..3cab334 --- /dev/null +++ b/tests/docs/no_namespace/00_6choice_variable.adoc @@ -0,0 +1,49 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +var1: # a second variable + - a + - b + - c +var2: + description: a first variable + default: a + choices: + type: variable + variable: _.var1 +---- +== Variables + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +A second variable. + +**Default**: + +* a +* b +* c +| +**var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` `mandatory` | +A first variable. + +**Choices**: the value of the variable "var1". + +**Default**: a +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +var1: + - a + - b + - c +var2: a +---- diff --git a/tests/docs/no_namespace/00_6choice_variable.md b/tests/docs/no_namespace/00_6choice_variable.md new file mode 100644 index 0000000..42a0ced --- /dev/null +++ b/tests/docs/no_namespace/00_6choice_variable.md @@ -0,0 +1,38 @@ +--- +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: + type: variable + variable: _.var1 +``` +# Variables + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A second variable.
**Default**:
- a
- b
- c | +| **var2**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A first variable.
**Choices**: the value of the variable "var1".
**Default**: a | + + +# Example with all variables modifiable + +```yaml +--- +var1: + - a + - b + - c +var2: a +``` diff --git a/tests/docs/no_namespace/00_6custom.adoc b/tests/docs/no_namespace/00_6custom.adoc new file mode 100644 index 0000000..729718a --- /dev/null +++ b/tests/docs/no_namespace/00_6custom.adoc @@ -0,0 +1,43 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +custom1: + description: the first variable + type: custom +custom2: + description: the seconf variable + type: custom + default: value +---- +== Variables + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**custom1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[custom]` `basic` `mandatory` | +The first variable. +| +**custom2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[custom]` `standard` `mandatory` | +The seconf variable. + +**Default**: value +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +custom1: xxx +---- +== Example with all variables modifiable + +[,yaml] +---- +custom1: xxx +custom2: value +---- diff --git a/tests/docs/no_namespace/00_6custom.md b/tests/docs/no_namespace/00_6custom.md new file mode 100644 index 0000000..28456f3 --- /dev/null +++ b/tests/docs/no_namespace/00_6custom.md @@ -0,0 +1,38 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +custom1: + description: the first variable + type: custom +custom2: + description: the seconf variable + type: custom + default: value +``` +# Variables + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **custom1**
[`custom`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The first variable. | +| **custom2**
[`custom`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The seconf variable.
**Default**: value | + + +# Example with mandatory variables not filled in + +```yaml +--- +custom1: xxx +``` +# Example with all variables modifiable + +```yaml +--- +custom1: xxx +custom2: value +``` diff --git a/tests/docs/no_namespace/00_6domainname.adoc b/tests/docs/no_namespace/00_6domainname.adoc new file mode 100644 index 0000000..2c49acd --- /dev/null +++ b/tests/docs/no_namespace/00_6domainname.adoc @@ -0,0 +1,29 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +variable: + description: a domain name variable + type: domainname + default: my.domain.name +---- +== Variables + +[cols="112a,112a",options="header"] +|==== +| Variable | Description +| +**variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[domainname]` `standard` `mandatory` | +A domain name variable. + +**Default**: my.domain.name +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +variable: my.domain.name +---- diff --git a/tests/docs/no_namespace/00_6domainname.md b/tests/docs/no_namespace/00_6domainname.md new file mode 100644 index 0000000..3b6ce01 --- /dev/null +++ b/tests/docs/no_namespace/00_6domainname.md @@ -0,0 +1,27 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +variable: + description: a domain name variable + type: domainname + default: my.domain.name +``` +# Variables + +| Variable                                                                                                       | Description                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **variable**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A domain name variable.
**Default**: my.domain.name | + + +# Example with all variables modifiable + +```yaml +--- +variable: my.domain.name +``` diff --git a/tests/docs/no_namespace/00_6domainname_params.adoc b/tests/docs/no_namespace/00_6domainname_params.adoc new file mode 100644 index 0000000..e8df208 --- /dev/null +++ b/tests/docs/no_namespace/00_6domainname_params.adoc @@ -0,0 +1,32 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +variable: + description: a domain name variable + type: domainname + default: my.domain.name + params: + allow_ip: true +---- +== Variables + +[cols="112a,112a",options="header"] +|==== +| Variable | Description +| +**variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[domainname]` `standard` `mandatory` | +A domain name variable. + +**Validator**: the domain name can be an IP + +**Default**: my.domain.name +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +variable: my.domain.name +---- diff --git a/tests/docs/no_namespace/00_6domainname_params.md b/tests/docs/no_namespace/00_6domainname_params.md new file mode 100644 index 0000000..3d7d094 --- /dev/null +++ b/tests/docs/no_namespace/00_6domainname_params.md @@ -0,0 +1,29 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +variable: + description: a domain name variable + type: domainname + default: my.domain.name + params: + allow_ip: true +``` +# Variables + +| Variable                                                                                                       | Description                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **variable**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A domain name variable.
**Validator**: the domain name can be an IP
**Default**: my.domain.name | + + +# Example with all variables modifiable + +```yaml +--- +variable: my.domain.name +``` diff --git a/tests/docs/no_namespace/00_6float.adoc b/tests/docs/no_namespace/00_6float.adoc new file mode 100644 index 0000000..b388eca --- /dev/null +++ b/tests/docs/no_namespace/00_6float.adoc @@ -0,0 +1,71 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +var1: 0.0 # the first variable +var2: + description: the second variable + default: 0.0 +var3: + description: the third variable + type: float + default: 0.0 +var4: 10.1 # the forth variable +var5: + description: the fifth variable + default: 10.1 +var6: + description: the sixth variable + type: float + default: 10.1 +---- +== Variables + +[cols="107a,107a",options="header"] +|==== +| Variable | Description +| +**var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` | +The first variable. + +**Default**: 0.0 +| +**var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` | +The second variable. + +**Default**: 0.0 +| +**var3** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` | +The third variable. + +**Default**: 0.0 +| +**var4** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` | +The forth variable. + +**Default**: 10.1 +| +**var5** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` | +The fifth variable. + +**Default**: 10.1 +| +**var6** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` | +The sixth variable. + +**Default**: 10.1 +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +var1: 0.0 +var2: 0.0 +var3: 0.0 +var4: 10.1 +var5: 10.1 +var6: 10.1 +---- diff --git a/tests/docs/no_namespace/00_6float.md b/tests/docs/no_namespace/00_6float.md new file mode 100644 index 0000000..4db028e --- /dev/null +++ b/tests/docs/no_namespace/00_6float.md @@ -0,0 +1,49 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: 0.0 # the first variable +var2: + description: the second variable + default: 0.0 +var3: + description: the third variable + type: float + default: 0.0 +var4: 10.1 # the forth variable +var5: + description: the fifth variable + default: 10.1 +var6: + description: the sixth variable + type: float + default: 10.1 +``` +# Variables + +| Variable                                                                                                  | Description                                                                                               | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var1**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The first variable.
**Default**: 0.0 | +| **var2**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The second variable.
**Default**: 0.0 | +| **var3**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The third variable.
**Default**: 0.0 | +| **var4**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The forth variable.
**Default**: 10.1 | +| **var5**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The fifth variable.
**Default**: 10.1 | +| **var6**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The sixth variable.
**Default**: 10.1 | + + +# Example with all variables modifiable + +```yaml +--- +var1: 0.0 +var2: 0.0 +var3: 0.0 +var4: 10.1 +var5: 10.1 +var6: 10.1 +``` diff --git a/tests/docs/no_namespace/00_6number.adoc b/tests/docs/no_namespace/00_6number.adoc new file mode 100644 index 0000000..54b0fd5 --- /dev/null +++ b/tests/docs/no_namespace/00_6number.adoc @@ -0,0 +1,71 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +var1: 0 # the first variable +var2: + description: the second variable + default: 0 +var3: + description: the third variable + type: number + default: 0 +var4: 10 # this forth variable +var5: + description: the fifth variable + default: 10 +var6: + description: the sixth variable + type: number + default: 10 +---- +== Variables + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` | +The first variable. + +**Default**: 0 +| +**var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` | +The second variable. + +**Default**: 0 +| +**var3** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` | +The third variable. + +**Default**: 0 +| +**var4** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` | +This forth variable. + +**Default**: 10 +| +**var5** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` | +The fifth variable. + +**Default**: 10 +| +**var6** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` | +The sixth variable. + +**Default**: 10 +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +var1: 0 +var2: 0 +var3: 0 +var4: 10 +var5: 10 +var6: 10 +---- diff --git a/tests/docs/no_namespace/00_6number.md b/tests/docs/no_namespace/00_6number.md new file mode 100644 index 0000000..c218d39 --- /dev/null +++ b/tests/docs/no_namespace/00_6number.md @@ -0,0 +1,49 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: 0 # the first variable +var2: + description: the second variable + default: 0 +var3: + description: the third variable + type: number + default: 0 +var4: 10 # this forth variable +var5: + description: the fifth variable + default: 10 +var6: + description: the sixth variable + type: number + default: 10 +``` +# Variables + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var1**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The first variable.
**Default**: 0 | +| **var2**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The second variable.
**Default**: 0 | +| **var3**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The third variable.
**Default**: 0 | +| **var4**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | This forth variable.
**Default**: 10 | +| **var5**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The fifth variable.
**Default**: 10 | +| **var6**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The sixth variable.
**Default**: 10 | + + +# Example with all variables modifiable + +```yaml +--- +var1: 0 +var2: 0 +var3: 0 +var4: 10 +var5: 10 +var6: 10 +``` diff --git a/tests/docs/no_namespace/00_6string.adoc b/tests/docs/no_namespace/00_6string.adoc new file mode 100644 index 0000000..9e57039 --- /dev/null +++ b/tests/docs/no_namespace/00_6string.adoc @@ -0,0 +1,75 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +var1: # the first variable +var2: + description: the second variable + default: +var3: + description: the third variable + type: string +var4: value # the forth variable +var5: + description: the fifth variable + default: value +var6: + description: the sixth variable + type: string + default: value +---- +== Variables + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +The first variable. +| +**var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +The second variable. +| +**var3** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +The third variable. +| +**var4** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +The forth variable. + +**Default**: value +| +**var5** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +The fifth variable. + +**Default**: value +| +**var6** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +The sixth variable. + +**Default**: value +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +var1: example +var2: example +var3: example +---- +== Example with all variables modifiable + +[,yaml] +---- +var1: example +var2: example +var3: example +var4: value +var5: value +var6: value +---- diff --git a/tests/docs/no_namespace/00_6string.md b/tests/docs/no_namespace/00_6string.md new file mode 100644 index 0000000..6bcf0ac --- /dev/null +++ b/tests/docs/no_namespace/00_6string.md @@ -0,0 +1,56 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: # the first variable +var2: + description: the second variable + default: +var3: + description: the third variable + type: string +var4: value # the forth variable +var5: + description: the fifth variable + default: value +var6: + description: the sixth variable + type: string + default: value +``` +# Variables + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The first variable. | +| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The second variable. | +| **var3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The third variable. | +| **var4**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The forth variable.
**Default**: value | +| **var5**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The fifth variable.
**Default**: value | +| **var6**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The sixth variable.
**Default**: value | + + +# Example with mandatory variables not filled in + +```yaml +--- +var1: example +var2: example +var3: example +``` +# Example with all variables modifiable + +```yaml +--- +var1: example +var2: example +var3: example +var4: value +var5: value +var6: value +``` diff --git a/tests/docs/no_namespace/00_7choice_quote.adoc b/tests/docs/no_namespace/00_7choice_quote.adoc new file mode 100644 index 0000000..fe03b97 --- /dev/null +++ b/tests/docs/no_namespace/00_7choice_quote.adoc @@ -0,0 +1,37 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.0' +var: + type: choice + description: A choice + default: quote' + choices: + - quote' + - quote" + - quote"' +---- +== Variables + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` `mandatory` | +A choice. + +**Choices**: + +* quote' ← (default) +* quote" +* quote"' +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +var: quote' +---- diff --git a/tests/docs/no_namespace/00_7choice_quote.md b/tests/docs/no_namespace/00_7choice_quote.md new file mode 100644 index 0000000..aadd30c --- /dev/null +++ b/tests/docs/no_namespace/00_7choice_quote.md @@ -0,0 +1,31 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.0' +var: + type: choice + description: A choice + default: quote' + choices: + - quote' + - quote" + - quote"' +``` +# Variables + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A choice.
**Choices**:
- quote' ← (default)
- quote"
- quote"' | + + +# Example with all variables modifiable + +```yaml +--- +var: quote' +``` diff --git a/tests/docs/no_namespace/00_7help_quote.adoc b/tests/docs/no_namespace/00_7help_quote.adoc new file mode 100644 index 0000000..f6498da --- /dev/null +++ b/tests/docs/no_namespace/00_7help_quote.adoc @@ -0,0 +1,44 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.0' +var1: + description: the first variable + help: message with ' +var2: + description: the second variable + help: message with " +---- +== Variables + +[cols="105a,105a",options="header"] +|==== +| Variable | Description +| +**var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +The first variable. + +Message with '. +| +**var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +The second variable. + +Message with ". +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +var1: example +var2: example +---- +== Example with all variables modifiable + +[,yaml] +---- +var1: example +var2: example +---- diff --git a/tests/docs/no_namespace/00_7help_quote.md b/tests/docs/no_namespace/00_7help_quote.md new file mode 100644 index 0000000..c0b3cd8 --- /dev/null +++ b/tests/docs/no_namespace/00_7help_quote.md @@ -0,0 +1,38 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.0' +var1: + description: the first variable + help: message with ' +var2: + description: the second variable + help: message with " +``` +# Variables + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The first variable.
Message with '. | +| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The second variable.
Message with ". | + + +# Example with mandatory variables not filled in + +```yaml +--- +var1: example +var2: example +``` +# Example with all variables modifiable + +```yaml +--- +var1: example +var2: example +``` diff --git a/tests/docs/no_namespace/00_7value_doublequote.adoc b/tests/docs/no_namespace/00_7value_doublequote.adoc new file mode 100644 index 0000000..887e513 --- /dev/null +++ b/tests/docs/no_namespace/00_7value_doublequote.adoc @@ -0,0 +1,28 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +variable: + description: a variable + default: quote" +---- +== Variables + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A variable. + +**Default**: quote" +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +variable: quote" +---- diff --git a/tests/docs/no_namespace/00_7value_doublequote.md b/tests/docs/no_namespace/00_7value_doublequote.md new file mode 100644 index 0000000..c946bdd --- /dev/null +++ b/tests/docs/no_namespace/00_7value_doublequote.md @@ -0,0 +1,26 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +variable: + description: a variable + default: quote" +``` +# Variables + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: quote" | + + +# Example with all variables modifiable + +```yaml +--- +variable: quote" +``` diff --git a/tests/docs/no_namespace/00_7value_doublequote2.adoc b/tests/docs/no_namespace/00_7value_doublequote2.adoc new file mode 100644 index 0000000..86dfaf8 --- /dev/null +++ b/tests/docs/no_namespace/00_7value_doublequote2.adoc @@ -0,0 +1,28 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +variable: + description: a variable + default: quote'" +---- +== Variables + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A variable. + +**Default**: quote'" +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +variable: quote'" +---- diff --git a/tests/docs/no_namespace/00_7value_doublequote2.md b/tests/docs/no_namespace/00_7value_doublequote2.md new file mode 100644 index 0000000..c89bb92 --- /dev/null +++ b/tests/docs/no_namespace/00_7value_doublequote2.md @@ -0,0 +1,26 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +variable: + description: a variable + default: quote'" +``` +# Variables + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: quote'" | + + +# Example with all variables modifiable + +```yaml +--- +variable: quote'" +``` diff --git a/tests/docs/no_namespace/00_7value_doublequote3.adoc b/tests/docs/no_namespace/00_7value_doublequote3.adoc new file mode 100644 index 0000000..dcee9ff --- /dev/null +++ b/tests/docs/no_namespace/00_7value_doublequote3.adoc @@ -0,0 +1,10 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.0' +variable: + description: a variable + hidden: true + default: quote\"\' +---- diff --git a/tests/docs/no_namespace/00_7value_doublequote3.md b/tests/docs/no_namespace/00_7value_doublequote3.md new file mode 100644 index 0000000..391ed13 --- /dev/null +++ b/tests/docs/no_namespace/00_7value_doublequote3.md @@ -0,0 +1,14 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.0' +variable: + description: a variable + hidden: true + default: quote\"\' +``` diff --git a/tests/docs/no_namespace/00_7value_quote.adoc b/tests/docs/no_namespace/00_7value_quote.adoc new file mode 100644 index 0000000..f3848ec --- /dev/null +++ b/tests/docs/no_namespace/00_7value_quote.adoc @@ -0,0 +1,28 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.0' +variable: + description: a variable + default: quote' +---- +== Variables + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A variable. + +**Default**: quote' +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +variable: quote' +---- diff --git a/tests/docs/no_namespace/00_7value_quote.md b/tests/docs/no_namespace/00_7value_quote.md new file mode 100644 index 0000000..bbcba9b --- /dev/null +++ b/tests/docs/no_namespace/00_7value_quote.md @@ -0,0 +1,26 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.0' +variable: + description: a variable + default: quote' +``` +# Variables + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: quote' | + + +# Example with all variables modifiable + +```yaml +--- +variable: quote' +``` diff --git a/tests/docs/no_namespace/00_8calculation_information.adoc b/tests/docs/no_namespace/00_8calculation_information.adoc new file mode 100644 index 0000000..8fa01d9 --- /dev/null +++ b/tests/docs/no_namespace/00_8calculation_information.adoc @@ -0,0 +1,42 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +variable: + description: a variable + default: + type: jinja + jinja: | + {{test_information }} + params: + test_information: + type: information + information: test_information + description: get information test_information +---- +== Variables + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A variable. + +**Default**: get information test_information. +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +variable: example +---- +== Example with all variables modifiable + +[,yaml] +---- +variable: example +---- diff --git a/tests/docs/no_namespace/00_8calculation_information.md b/tests/docs/no_namespace/00_8calculation_information.md new file mode 100644 index 0000000..391214e --- /dev/null +++ b/tests/docs/no_namespace/00_8calculation_information.md @@ -0,0 +1,40 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +variable: + description: a variable + default: + type: jinja + jinja: | + {{test_information }} + params: + test_information: + type: information + information: test_information + description: get information test_information +``` +# Variables + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: get information test_information. | + + +# Example with mandatory variables not filled in + +```yaml +--- +variable: example +``` +# Example with all variables modifiable + +```yaml +--- +variable: example +``` diff --git a/tests/docs/no_namespace/00_8test.adoc b/tests/docs/no_namespace/00_8test.adoc new file mode 100644 index 0000000..94437eb --- /dev/null +++ b/tests/docs/no_namespace/00_8test.adoc @@ -0,0 +1,83 @@ +== 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 +var5: + description: the fifth variable + test: + - false +---- +== Variables + +[cols="105a,105a",options="header"] +|==== +| Variable | Description +| +**var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +The first variable. + +**Example**: test +| +**var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +The second variable. + +**Default**: value + +**Example**: test +| +**var3** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +The third variable. + +**Example**: test1 +| +**var4** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +The forth variable. + +**Example**: None +| +**var5** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +The fifth variable. + +**Example**: False +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +var1: test +var2: test +var3: test1 +var5: false +---- +== Example with all variables modifiable + +[,yaml] +---- +var1: test +var2: test +var3: test1 +var4: +var5: false +---- diff --git a/tests/docs/no_namespace/00_8test.md b/tests/docs/no_namespace/00_8test.md new file mode 100644 index 0000000..9f9c1ea --- /dev/null +++ b/tests/docs/no_namespace/00_8test.md @@ -0,0 +1,64 @@ +--- +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 +var5: + description: the fifth variable + test: + - false +``` +# Variables + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The first variable.
**Example**: test | +| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The second variable.
**Default**: value
**Example**: test | +| **var3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The third variable.
**Example**: test1 | +| **var4**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The forth variable.
**Example**: None | +| **var5**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The fifth variable.
**Example**: False | + + +# Example with mandatory variables not filled in + +```yaml +--- +var1: test +var2: test +var3: test1 +var5: false +``` +# Example with all variables modifiable + +```yaml +--- +var1: test +var2: test +var3: test1 +var4: +var5: false +``` diff --git a/tests/docs/no_namespace/00_9choice_variable_multi.adoc b/tests/docs/no_namespace/00_9choice_variable_multi.adoc new file mode 100644 index 0000000..4944b56 --- /dev/null +++ b/tests/docs/no_namespace/00_9choice_variable_multi.adoc @@ -0,0 +1,61 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +variable1: + description: a first variable + type: choice + multi: true + choices: + - val1 + - val2 +variable2: + description: a second variable + type: choice + multi: true + mandatory: false + choices: + - val1 + - val2 +---- +== Variables + +[cols="116a,116a",options="header"] +|==== +| Variable | Description +| +**variable1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `basic` `mandatory` `unique` `multiple` | +A first variable. + +**Choices**: + +* val1 +* val2 +| +**variable2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` `unique` `multiple` | +A second variable. + +**Choices**: + +* val1 +* val2 +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +variable1: + - a_choice +---- +== Example with all variables modifiable + +[,yaml] +---- +variable1: + - a_choice +variable2: + - a_choice +---- diff --git a/tests/docs/no_namespace/00_9choice_variable_multi.md b/tests/docs/no_namespace/00_9choice_variable_multi.md new file mode 100644 index 0000000..ab99f21 --- /dev/null +++ b/tests/docs/no_namespace/00_9choice_variable_multi.md @@ -0,0 +1,49 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +variable1: + description: a first variable + type: choice + multi: true + choices: + - val1 + - val2 +variable2: + description: a second variable + type: choice + multi: true + mandatory: false + choices: + - val1 + - val2 +``` +# Variables + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **variable1**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | A first variable.
**Choices**:
- val1
- val2 | +| **variable2**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A second variable.
**Choices**:
- val1
- val2 | + + +# Example with mandatory variables not filled in + +```yaml +--- +variable1: + - a_choice +``` +# Example with all variables modifiable + +```yaml +--- +variable1: + - a_choice +variable2: + - a_choice +``` diff --git a/tests/docs/no_namespace/00_9default_calculation.adoc b/tests/docs/no_namespace/00_9default_calculation.adoc new file mode 100644 index 0000000..82aab71 --- /dev/null +++ b/tests/docs/no_namespace/00_9default_calculation.adoc @@ -0,0 +1,37 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +variable: + description: a variable + default: + type: jinja + jinja: | + {{ param1 }}_{{ param2 }}_{{ param3 }}_{{ param4 }} + params: + param1: string + param2: 1 + param3: true + param4: + description: concat all parameters +---- +== Variables + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A variable. + +**Default**: concat all parameters. +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +variable: string_1_True_None +---- diff --git a/tests/docs/no_namespace/00_9default_calculation.md b/tests/docs/no_namespace/00_9default_calculation.md new file mode 100644 index 0000000..c25991b --- /dev/null +++ b/tests/docs/no_namespace/00_9default_calculation.md @@ -0,0 +1,35 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +variable: + description: a variable + default: + type: jinja + jinja: | + {{ param1 }}_{{ param2 }}_{{ param3 }}_{{ param4 }} + params: + param1: string + param2: 1 + param3: true + param4: + description: concat all parameters +``` +# Variables + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: concat all parameters. | + + +# Example with all variables modifiable + +```yaml +--- +variable: string_1_True_None +``` diff --git a/tests/docs/no_namespace/00_9default_calculation_information.adoc b/tests/docs/no_namespace/00_9default_calculation_information.adoc new file mode 100644 index 0000000..1874e35 --- /dev/null +++ b/tests/docs/no_namespace/00_9default_calculation_information.adoc @@ -0,0 +1,42 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +var: + description: a variable + default: + type: jinja + jinja: '{{ information }}' + params: + information: + type: information + information: test_information + variable: _.var + description: returns the information +---- +== Variables + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A variable. + +**Default**: returns the information. +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +var: example +---- +== Example with all variables modifiable + +[,yaml] +---- +var: example +---- diff --git a/tests/docs/no_namespace/00_9default_calculation_information.md b/tests/docs/no_namespace/00_9default_calculation_information.md new file mode 100644 index 0000000..a53f1a3 --- /dev/null +++ b/tests/docs/no_namespace/00_9default_calculation_information.md @@ -0,0 +1,40 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: + description: a variable + default: + type: jinja + jinja: '{{ information }}' + params: + information: + type: information + information: test_information + variable: _.var + description: returns the information +``` +# Variables + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: returns the information. | + + +# Example with mandatory variables not filled in + +```yaml +--- +var: example +``` +# Example with all variables modifiable + +```yaml +--- +var: example +``` diff --git a/tests/docs/no_namespace/00_9default_calculation_information_other_variable.adoc b/tests/docs/no_namespace/00_9default_calculation_information_other_variable.adoc new file mode 100644 index 0000000..d6811d8 --- /dev/null +++ b/tests/docs/no_namespace/00_9default_calculation_information_other_variable.adoc @@ -0,0 +1,49 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +var1: # a first variable +var2: + description: a second variable + default: + type: jinja + jinja: | + {{ information }} + params: + information: + type: information + information: test_information + variable: _.var1 +---- +== Variables + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A first variable. +| +**var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A second variable. + +**Default**: issu d'un calcul. +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +var1: example +var2: example +---- +== Example with all variables modifiable + +[,yaml] +---- +var1: example +var2: example +---- diff --git a/tests/docs/no_namespace/00_9default_calculation_information_other_variable.md b/tests/docs/no_namespace/00_9default_calculation_information_other_variable.md new file mode 100644 index 0000000..7cc598a --- /dev/null +++ b/tests/docs/no_namespace/00_9default_calculation_information_other_variable.md @@ -0,0 +1,44 @@ +--- +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: jinja + jinja: | + {{ information }} + params: + information: + type: information + information: test_information + variable: _.var1 +``` +# Variables + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A first variable. | +| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second variable.
**Default**: issu d'un calcul. | + + +# Example with mandatory variables not filled in + +```yaml +--- +var1: example +var2: example +``` +# Example with all variables modifiable + +```yaml +--- +var1: example +var2: example +``` diff --git a/tests/docs/no_namespace/00_9default_calculation_param_optional.adoc b/tests/docs/no_namespace/00_9default_calculation_param_optional.adoc new file mode 100644 index 0000000..08987da --- /dev/null +++ b/tests/docs/no_namespace/00_9default_calculation_param_optional.adoc @@ -0,0 +1,53 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +var1: + description: a first variable + default: + type: jinja + jinja: '{% if var2 is defined %} {{ var2 }} {% elif var3 is defined %} {{ var3 + }} {% elif var4 is defined %} {{ var4 }} {% else %} {{ _.var2 }} {% endif %} ' + params: + var2: + type: variable + variable: _.var2 + optional: true + var3: + type: variable + variable: _.var3 + optional: true + var4: + type: variable + variable: _.unknown_family.var + optional: true + description: returns a value + mandatory: false +var2: no # a second variable +---- +== Variables + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | +A first variable. + +**Default**: returns a value. +| +**var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A second variable. + +**Default**: no +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +var1: no +var2: no +---- diff --git a/tests/docs/no_namespace/00_9default_calculation_param_optional.md b/tests/docs/no_namespace/00_9default_calculation_param_optional.md new file mode 100644 index 0000000..b6ee040 --- /dev/null +++ b/tests/docs/no_namespace/00_9default_calculation_param_optional.md @@ -0,0 +1,47 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: + description: a first variable + default: + type: jinja + jinja: '{% if var2 is defined %} {{ var2 }} {% elif var3 is defined %} {{ var3 + }} {% elif var4 is defined %} {{ var4 }} {% else %} {{ _.var2 }} {% endif %} ' + params: + var2: + type: variable + variable: _.var2 + optional: true + var3: + type: variable + variable: _.var3 + optional: true + var4: + type: variable + variable: _.unknown_family.var + optional: true + description: returns a value + mandatory: false +var2: no # a second variable +``` +# Variables + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A first variable.
**Default**: returns a value. | +| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second variable.
**Default**: no | + + +# Example with all variables modifiable + +```yaml +--- +var1: no +var2: no +``` diff --git a/tests/docs/no_namespace/00_9default_information_other_variable.adoc b/tests/docs/no_namespace/00_9default_information_other_variable.adoc new file mode 100644 index 0000000..7913c73 --- /dev/null +++ b/tests/docs/no_namespace/00_9default_information_other_variable.adoc @@ -0,0 +1,44 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +var1: # a first variable +var2: + description: a second variable + default: + type: information + information: test_information + variable: _.var1 +---- +== Variables + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A first variable. +| +**var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A second variable. + +**Default**: value of the information. +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +var1: example +var2: example +---- +== Example with all variables modifiable + +[,yaml] +---- +var1: example +var2: example +---- diff --git a/tests/docs/no_namespace/00_9default_information_other_variable.md b/tests/docs/no_namespace/00_9default_information_other_variable.md new file mode 100644 index 0000000..8883491 --- /dev/null +++ b/tests/docs/no_namespace/00_9default_information_other_variable.md @@ -0,0 +1,39 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: # a first variable +var2: + description: a second variable + default: + type: information + information: test_information + variable: _.var1 +``` +# Variables + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A first variable. | +| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second variable.
**Default**: value of the information. | + + +# Example with mandatory variables not filled in + +```yaml +--- +var1: example +var2: example +``` +# Example with all variables modifiable + +```yaml +--- +var1: example +var2: example +``` diff --git a/tests/docs/no_namespace/00_9default_integer.adoc b/tests/docs/no_namespace/00_9default_integer.adoc new file mode 100644 index 0000000..463bee8 --- /dev/null +++ b/tests/docs/no_namespace/00_9default_integer.adoc @@ -0,0 +1,38 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +var: + description: a variable + type: choice + default: 9 + choices: + type: jinja + jinja: | + {% for item in trange(0, 10) %} + {{ item }} + {%- endfor %} + return_type: number + description: choice for 0 to 9 +---- +== Variables + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` `mandatory` | +A variable. + +**Choices**: choice for 0 to 9. + +**Default**: 9 +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +var: 9 +---- diff --git a/tests/docs/no_namespace/00_9default_integer.md b/tests/docs/no_namespace/00_9default_integer.md new file mode 100644 index 0000000..b1dcf66 --- /dev/null +++ b/tests/docs/no_namespace/00_9default_integer.md @@ -0,0 +1,35 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: + description: a variable + type: choice + default: 9 + choices: + type: jinja + jinja: | + {% for item in trange(0, 10) %} + {{ item }} + {%- endfor %} + return_type: number + description: choice for 0 to 9 +``` +# Variables + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Choices**: choice for 0 to 9.
**Default**: 9 | + + +# Example with all variables modifiable + +```yaml +--- +var: 9 +``` diff --git a/tests/docs/no_namespace/01_6boolean_multi.adoc b/tests/docs/no_namespace/01_6boolean_multi.adoc new file mode 100644 index 0000000..33b026e --- /dev/null +++ b/tests/docs/no_namespace/01_6boolean_multi.adoc @@ -0,0 +1,125 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +var1: # the first variable + - true +var2: + description: the second variable + default: + - true +var3: + description: the third variable + type: boolean + default: + - true +var4: # the forth variable + - false +var5: + description: the fifth variable + default: + - false +var6: + description: the sixth variable + type: boolean + default: + - false + +var7: + description: the seventh variable + multi: true + default: + - true +var8: + description: the eighth variable + type: boolean + multi: true + default: + - true +---- +== Variables + +[cols="129a,129a",options="header"] +|==== +| Variable | Description +| +**var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` `unique` `multiple` | +The first variable. + +**Default**: + +* true +| +**var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` `unique` `multiple` | +The second variable. + +**Default**: + +* true +| +**var3** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` `unique` `multiple` | +The third variable. + +**Default**: + +* true +| +**var4** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` `unique` `multiple` | +The forth variable. + +**Default**: + +* false +| +**var5** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` `unique` `multiple` | +The fifth variable. + +**Default**: + +* false +| +**var6** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` `unique` `multiple` | +The sixth variable. + +**Default**: + +* false +| +**var7** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` `unique` `multiple` | +The seventh variable. + +**Default**: + +* true +| +**var8** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` `unique` `multiple` | +The eighth variable. + +**Default**: + +* true +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +var1: + - true +var2: + - true +var3: + - true +var4: + - false +var5: + - false +var6: + - false +var7: + - true +var8: + - true +---- diff --git a/tests/docs/no_namespace/01_6boolean_multi.md b/tests/docs/no_namespace/01_6boolean_multi.md new file mode 100644 index 0000000..e159f72 --- /dev/null +++ b/tests/docs/no_namespace/01_6boolean_multi.md @@ -0,0 +1,79 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: # the first variable + - true +var2: + description: the second variable + default: + - true +var3: + description: the third variable + type: boolean + default: + - true +var4: # the forth variable + - false +var5: + description: the fifth variable + default: + - false +var6: + description: the sixth variable + type: boolean + default: + - false + +var7: + description: the seventh variable + multi: true + default: + - true +var8: + description: the eighth variable + type: boolean + multi: true + default: + - true +``` +# Variables + +| Variable                                                                                                                        | Description                                                                                                                     | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var1**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The first variable.
**Default**:
- true | +| **var2**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The second variable.
**Default**:
- true | +| **var3**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The third variable.
**Default**:
- true | +| **var4**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The forth variable.
**Default**:
- false | +| **var5**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The fifth variable.
**Default**:
- false | +| **var6**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The sixth variable.
**Default**:
- false | +| **var7**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The seventh variable.
**Default**:
- true | +| **var8**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The eighth variable.
**Default**:
- true | + + +# Example with all variables modifiable + +```yaml +--- +var1: + - true +var2: + - true +var3: + - true +var4: + - false +var5: + - false +var6: + - false +var7: + - true +var8: + - true +``` diff --git a/tests/docs/no_namespace/01_6custom_multi.adoc b/tests/docs/no_namespace/01_6custom_multi.adoc new file mode 100644 index 0000000..f8c7af3 --- /dev/null +++ b/tests/docs/no_namespace/01_6custom_multi.adoc @@ -0,0 +1,50 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +custom1: + description: a first custom variable + type: custom + multi: true +custom2: + description: a second custom variable + type: custom + default: + - value +---- +== Variables + +[cols="128a,128a",options="header"] +|==== +| 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 +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +custom1: + - xxx +---- +== Example with all variables modifiable + +[,yaml] +---- +custom1: + - xxx +custom2: + - value +---- diff --git a/tests/docs/no_namespace/01_6custom_multi.md b/tests/docs/no_namespace/01_6custom_multi.md new file mode 100644 index 0000000..e4c7909 --- /dev/null +++ b/tests/docs/no_namespace/01_6custom_multi.md @@ -0,0 +1,43 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +custom1: + description: a first custom variable + type: custom + multi: true +custom2: + description: a second custom variable + type: custom + default: + - value +``` +# Variables + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **custom1**
[`custom`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | A first custom variable. | +| **custom2**
[`custom`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A second custom variable.
**Default**:
- value | + + +# Example with mandatory variables not filled in + +```yaml +--- +custom1: + - xxx +``` +# Example with all variables modifiable + +```yaml +--- +custom1: + - xxx +custom2: + - value +``` diff --git a/tests/docs/no_namespace/01_6float_multi.adoc b/tests/docs/no_namespace/01_6float_multi.adoc new file mode 100644 index 0000000..77dfb93 --- /dev/null +++ b/tests/docs/no_namespace/01_6float_multi.adoc @@ -0,0 +1,125 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +var1: # the first variable + - 0.0 +var2: + description: the second variable + default: + - 0.0 +var3: + description: the third variable + type: float + default: + - 0.0 +var4: # the forth variable + - 10.1 +var5: + description: the fifth variable + default: + - 10.1 +var6: + description: the sixth variable + type: float + default: + - 10.1 + +var7: + description: the seventh variable + multi: true + default: + - 0.0 +var8: + description: the eighth variable + type: float + multi: true + default: + - 0.0 +---- +== Variables + +[cols="127a,127a",options="header"] +|==== +| Variable | Description +| +**var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` `unique` `multiple` | +The first variable. + +**Default**: + +* 0.0 +| +**var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` `unique` `multiple` | +The second variable. + +**Default**: + +* 0.0 +| +**var3** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` `unique` `multiple` | +The third variable. + +**Default**: + +* 0.0 +| +**var4** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` `unique` `multiple` | +The forth variable. + +**Default**: + +* 10.1 +| +**var5** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` `unique` `multiple` | +The fifth variable. + +**Default**: + +* 10.1 +| +**var6** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` `unique` `multiple` | +The sixth variable. + +**Default**: + +* 10.1 +| +**var7** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` `unique` `multiple` | +The seventh variable. + +**Default**: + +* 0.0 +| +**var8** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` `unique` `multiple` | +The eighth variable. + +**Default**: + +* 0.0 +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +var1: + - 0.0 +var2: + - 0.0 +var3: + - 0.0 +var4: + - 10.1 +var5: + - 10.1 +var6: + - 10.1 +var7: + - 0.0 +var8: + - 0.0 +---- diff --git a/tests/docs/no_namespace/01_6float_multi.md b/tests/docs/no_namespace/01_6float_multi.md new file mode 100644 index 0000000..250b24a --- /dev/null +++ b/tests/docs/no_namespace/01_6float_multi.md @@ -0,0 +1,79 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: # the first variable + - 0.0 +var2: + description: the second variable + default: + - 0.0 +var3: + description: the third variable + type: float + default: + - 0.0 +var4: # the forth variable + - 10.1 +var5: + description: the fifth variable + default: + - 10.1 +var6: + description: the sixth variable + type: float + default: + - 10.1 + +var7: + description: the seventh variable + multi: true + default: + - 0.0 +var8: + description: the eighth variable + type: float + multi: true + default: + - 0.0 +``` +# Variables + +| Variable                                                                                                                      | Description                                                                                                                   | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var1**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The first variable.
**Default**:
- 0.0 | +| **var2**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The second variable.
**Default**:
- 0.0 | +| **var3**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The third variable.
**Default**:
- 0.0 | +| **var4**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The forth variable.
**Default**:
- 10.1 | +| **var5**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The fifth variable.
**Default**:
- 10.1 | +| **var6**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The sixth variable.
**Default**:
- 10.1 | +| **var7**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The seventh variable.
**Default**:
- 0.0 | +| **var8**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The eighth variable.
**Default**:
- 0.0 | + + +# Example with all variables modifiable + +```yaml +--- +var1: + - 0.0 +var2: + - 0.0 +var3: + - 0.0 +var4: + - 10.1 +var5: + - 10.1 +var6: + - 10.1 +var7: + - 0.0 +var8: + - 0.0 +``` diff --git a/tests/docs/no_namespace/01_6number_multi.adoc b/tests/docs/no_namespace/01_6number_multi.adoc new file mode 100644 index 0000000..5c8bdb3 --- /dev/null +++ b/tests/docs/no_namespace/01_6number_multi.adoc @@ -0,0 +1,125 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +var1: # the first variable + - 0 +var2: + description: the second variable + default: + - 0 +var3: + description: the third variable + type: number + default: + - 0 +var4: # the forth variable + - 10 +var5: + description: the fifth variable + default: + - 10 +var6: + description: the sixth variable + type: number + default: + - 10 + +var7: + description: the seventh variable + multi: true + default: + - 0 +var8: + description: the eighth variable + type: number + multi: true + default: + - 0 +---- +== Variables + +[cols="128a,128a",options="header"] +|==== +| Variable | Description +| +**var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` `unique` `multiple` | +The first variable. + +**Default**: + +* 0 +| +**var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` `unique` `multiple` | +The second variable. + +**Default**: + +* 0 +| +**var3** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` `unique` `multiple` | +The third variable. + +**Default**: + +* 0 +| +**var4** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` `unique` `multiple` | +The forth variable. + +**Default**: + +* 10 +| +**var5** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` `unique` `multiple` | +The fifth variable. + +**Default**: + +* 10 +| +**var6** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` `unique` `multiple` | +The sixth variable. + +**Default**: + +* 10 +| +**var7** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` `unique` `multiple` | +The seventh variable. + +**Default**: + +* 0 +| +**var8** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` `unique` `multiple` | +The eighth variable. + +**Default**: + +* 0 +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +var1: + - 0 +var2: + - 0 +var3: + - 0 +var4: + - 10 +var5: + - 10 +var6: + - 10 +var7: + - 0 +var8: + - 0 +---- diff --git a/tests/docs/no_namespace/01_6number_multi.md b/tests/docs/no_namespace/01_6number_multi.md new file mode 100644 index 0000000..d2507a2 --- /dev/null +++ b/tests/docs/no_namespace/01_6number_multi.md @@ -0,0 +1,79 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: # the first variable + - 0 +var2: + description: the second variable + default: + - 0 +var3: + description: the third variable + type: number + default: + - 0 +var4: # the forth variable + - 10 +var5: + description: the fifth variable + default: + - 10 +var6: + description: the sixth variable + type: number + default: + - 10 + +var7: + description: the seventh variable + multi: true + default: + - 0 +var8: + description: the eighth variable + type: number + multi: true + default: + - 0 +``` +# Variables + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var1**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The first variable.
**Default**:
- 0 | +| **var2**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The second variable.
**Default**:
- 0 | +| **var3**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The third variable.
**Default**:
- 0 | +| **var4**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The forth variable.
**Default**:
- 10 | +| **var5**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The fifth variable.
**Default**:
- 10 | +| **var6**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The sixth variable.
**Default**:
- 10 | +| **var7**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The seventh variable.
**Default**:
- 0 | +| **var8**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The eighth variable.
**Default**:
- 0 | + + +# Example with all variables modifiable + +```yaml +--- +var1: + - 0 +var2: + - 0 +var3: + - 0 +var4: + - 10 +var5: + - 10 +var6: + - 10 +var7: + - 0 +var8: + - 0 +``` diff --git a/tests/docs/no_namespace/01_6string_multi.adoc b/tests/docs/no_namespace/01_6string_multi.adoc new file mode 100644 index 0000000..7e493a3 --- /dev/null +++ b/tests/docs/no_namespace/01_6string_multi.adoc @@ -0,0 +1,121 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +var1: [] # the first variable +var2: + description: the second variable + default: [] +var3: + description: the third variable + type: string +var4: # the forth variable + - value +var5: + description: the fifth variable + default: + - value +var6: + description: the sixth variable + type: string + default: + - value + +var7: + description: the seventh variable + multi: true + default: + - value +var8: + description: the eighth variable + type: string + multi: true + default: + - value +---- +== Variables + +[cols="128a,128a",options="header"] +|==== +| Variable | Description +| +**var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | +The first variable. +| +**var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | +The second variable. +| +**var3** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +The third variable. +| +**var4** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +The forth variable. + +**Default**: + +* value +| +**var5** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +The fifth variable. + +**Default**: + +* value +| +**var6** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +The sixth variable. + +**Default**: + +* value +| +**var7** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +The seventh variable. + +**Default**: + +* value +| +**var8** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +The eighth variable. + +**Default**: + +* value +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +var1: + - example +var2: + - example +var3: example +---- +== Example with all variables modifiable + +[,yaml] +---- +var1: + - example +var2: + - example +var3: example +var4: + - value +var5: + - value +var6: + - value +var7: + - value +var8: + - value +---- diff --git a/tests/docs/no_namespace/01_6string_multi.md b/tests/docs/no_namespace/01_6string_multi.md new file mode 100644 index 0000000..72b0c5b --- /dev/null +++ b/tests/docs/no_namespace/01_6string_multi.md @@ -0,0 +1,84 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: [] # the first variable +var2: + description: the second variable + default: [] +var3: + description: the third variable + type: string +var4: # the forth variable + - value +var5: + description: the fifth variable + default: + - value +var6: + description: the sixth variable + type: string + default: + - value + +var7: + description: the seventh variable + multi: true + default: + - value +var8: + description: the eighth variable + type: string + multi: true + default: + - value +``` +# Variables + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | The first variable. | +| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | The second variable. | +| **var3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The third variable. | +| **var4**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The forth variable.
**Default**:
- value | +| **var5**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The fifth variable.
**Default**:
- value | +| **var6**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The sixth variable.
**Default**:
- value | +| **var7**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The seventh variable.
**Default**:
- value | +| **var8**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The eighth variable.
**Default**:
- value | + + +# Example with mandatory variables not filled in + +```yaml +--- +var1: + - example +var2: + - example +var3: example +``` +# Example with all variables modifiable + +```yaml +--- +var1: + - example +var2: + - example +var3: example +var4: + - value +var5: + - value +var6: + - value +var7: + - value +var8: + - value +``` diff --git a/tests/docs/no_namespace/01_7value_multi_doublequote.adoc b/tests/docs/no_namespace/01_7value_multi_doublequote.adoc new file mode 100644 index 0000000..c1adb64 --- /dev/null +++ b/tests/docs/no_namespace/01_7value_multi_doublequote.adoc @@ -0,0 +1,32 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +variable: + description: a variable + default: + - quote" +---- +== Variables + +[cols="128a,128a",options="header"] +|==== +| Variable | Description +| +**variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +A variable. + +**Default**: + +* quote" +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +variable: + - quote" +---- diff --git a/tests/docs/no_namespace/01_7value_multi_doublequote.md b/tests/docs/no_namespace/01_7value_multi_doublequote.md new file mode 100644 index 0000000..c9c8533 --- /dev/null +++ b/tests/docs/no_namespace/01_7value_multi_doublequote.md @@ -0,0 +1,28 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +variable: + description: a variable + default: + - quote" +``` +# Variables + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A variable.
**Default**:
- quote" | + + +# Example with all variables modifiable + +```yaml +--- +variable: + - quote" +``` diff --git a/tests/docs/no_namespace/01_7value_multi_doublequote2.adoc b/tests/docs/no_namespace/01_7value_multi_doublequote2.adoc new file mode 100644 index 0000000..20fa4b3 --- /dev/null +++ b/tests/docs/no_namespace/01_7value_multi_doublequote2.adoc @@ -0,0 +1,32 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +variable: + description: a variable + default: + - quote'" +---- +== Variables + +[cols="128a,128a",options="header"] +|==== +| Variable | Description +| +**variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +A variable. + +**Default**: + +* quote'" +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +variable: + - quote'" +---- diff --git a/tests/docs/no_namespace/01_7value_multi_doublequote2.md b/tests/docs/no_namespace/01_7value_multi_doublequote2.md new file mode 100644 index 0000000..c98f7dd --- /dev/null +++ b/tests/docs/no_namespace/01_7value_multi_doublequote2.md @@ -0,0 +1,28 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +variable: + description: a variable + default: + - quote'" +``` +# Variables + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A variable.
**Default**:
- quote'" | + + +# Example with all variables modifiable + +```yaml +--- +variable: + - quote'" +``` diff --git a/tests/docs/no_namespace/01_7value_multi_quote.adoc b/tests/docs/no_namespace/01_7value_multi_quote.adoc new file mode 100644 index 0000000..bc6e1af --- /dev/null +++ b/tests/docs/no_namespace/01_7value_multi_quote.adoc @@ -0,0 +1,32 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +variable: + description: a variable + default: + - quote' +---- +== Variables + +[cols="128a,128a",options="header"] +|==== +| Variable | Description +| +**variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +A variable. + +**Default**: + +* quote' +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +variable: + - quote' +---- diff --git a/tests/docs/no_namespace/01_7value_multi_quote.md b/tests/docs/no_namespace/01_7value_multi_quote.md new file mode 100644 index 0000000..3a79dd8 --- /dev/null +++ b/tests/docs/no_namespace/01_7value_multi_quote.md @@ -0,0 +1,28 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +variable: + description: a variable + default: + - quote' +``` +# Variables + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A variable.
**Default**:
- quote' | + + +# Example with all variables modifiable + +```yaml +--- +variable: + - quote' +``` diff --git a/tests/docs/no_namespace/01_8calculation_information_multi.adoc b/tests/docs/no_namespace/01_8calculation_information_multi.adoc new file mode 100644 index 0000000..95cd54a --- /dev/null +++ b/tests/docs/no_namespace/01_8calculation_information_multi.adoc @@ -0,0 +1,38 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +variable: + description: a variable + multi: true + default: + type: jinja + jinja: | + {{test_information }} + params: + test_information: + type: information + information: test_information + description: get information test_information +---- +== Variables + +[cols="128a,128a",options="header"] +|==== +| Variable | Description +| +**variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +A variable. + +**Default**: get information test_information. +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +variable: + - '[]' +---- diff --git a/tests/docs/no_namespace/01_8calculation_information_multi.md b/tests/docs/no_namespace/01_8calculation_information_multi.md new file mode 100644 index 0000000..544f436 --- /dev/null +++ b/tests/docs/no_namespace/01_8calculation_information_multi.md @@ -0,0 +1,36 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +variable: + description: a variable + multi: true + default: + type: jinja + jinja: | + {{test_information }} + params: + test_information: + type: information + information: test_information + description: get information test_information +``` +# Variables + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A variable.
**Default**: get information test_information. | + + +# Example with all variables modifiable + +```yaml +--- +variable: + - '[]' +``` diff --git a/tests/docs/no_namespace/01_9choice_variable_multi.adoc b/tests/docs/no_namespace/01_9choice_variable_multi.adoc new file mode 100644 index 0000000..54d6542 --- /dev/null +++ b/tests/docs/no_namespace/01_9choice_variable_multi.adoc @@ -0,0 +1,53 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +variable1: # a first variable + - a + - b + - c +variable2: + description: a second variable + choices: + type: variable + variable: _.variable1 +---- +== Variables + +[cols="105a,105a",options="header"] +|==== +| Variable | Description +| +**variable1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +A first variable. + +**Default**: + +* a +* b +* c +| +**variable2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `basic` `mandatory` | +A second variable. + +**Choices**: the value of the variable "variable1". +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +variable2: a_choice +---- +== Example with all variables modifiable + +[,yaml] +---- +variable1: + - a + - b + - c +variable2: a_choice +---- diff --git a/tests/docs/no_namespace/01_9choice_variable_multi.md b/tests/docs/no_namespace/01_9choice_variable_multi.md new file mode 100644 index 0000000..b9c7374 --- /dev/null +++ b/tests/docs/no_namespace/01_9choice_variable_multi.md @@ -0,0 +1,43 @@ +--- +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: + type: variable + variable: _.variable1 +``` +# Variables + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **variable1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A first variable.
**Default**:
- a
- b
- c | +| **variable2**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A second variable.
**Choices**: the value of the variable "variable1". | + + +# Example with mandatory variables not filled in + +```yaml +--- +variable2: a_choice +``` +# Example with all variables modifiable + +```yaml +--- +variable1: + - a + - b + - c +variable2: a_choice +``` diff --git a/tests/docs/no_namespace/04_0type_param.adoc b/tests/docs/no_namespace/04_0type_param.adoc new file mode 100644 index 0000000..c5157bd --- /dev/null +++ b/tests/docs/no_namespace/04_0type_param.adoc @@ -0,0 +1,40 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +int: + description: A limited number + type: number + params: + min_number: 0 + max_number: 100 +---- +== Variables + +[cols="105a,105a",options="header"] +|==== +| Variable | Description +| +**int** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `basic` `mandatory` | +A limited number. + +**Validators**: + +* the minimum value is 0 +* the maximum value is 100 +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +int: 42 +---- +== Example with all variables modifiable + +[,yaml] +---- +int: 42 +---- diff --git a/tests/docs/no_namespace/04_0type_param.md b/tests/docs/no_namespace/04_0type_param.md new file mode 100644 index 0000000..0260585 --- /dev/null +++ b/tests/docs/no_namespace/04_0type_param.md @@ -0,0 +1,35 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +int: + description: A limited number + type: number + params: + min_number: 0 + max_number: 100 +``` +# Variables + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **int**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A limited number.
**Validators**:
- the minimum value is 0
- the maximum value is 100 | + + +# Example with mandatory variables not filled in + +```yaml +--- +int: 42 +``` +# Example with all variables modifiable + +```yaml +--- +int: 42 +``` diff --git a/tests/docs/no_namespace/04_1auto_save.adoc b/tests/docs/no_namespace/04_1auto_save.adoc new file mode 100644 index 0000000..f2d6aa0 --- /dev/null +++ b/tests/docs/no_namespace/04_1auto_save.adoc @@ -0,0 +1,29 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: 1.1 +variable: + description: an auto save variable + auto_save: true + default: no +---- +== Variables + +[cols="121a,121a",options="header"] +|==== +| Variable | Description +| +**variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `auto modified` | +An auto save variable. + +**Default**: no +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +variable: no +---- diff --git a/tests/docs/no_namespace/04_1auto_save.md b/tests/docs/no_namespace/04_1auto_save.md new file mode 100644 index 0000000..70ca72b --- /dev/null +++ b/tests/docs/no_namespace/04_1auto_save.md @@ -0,0 +1,27 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: 1.1 +variable: + description: an auto save variable + auto_save: true + default: no +``` +# Variables + +| Variable                                                                                                                | Description                                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `auto modified` | An auto save variable.
**Default**: no | + + +# Example with all variables modifiable + +```yaml +--- +variable: no +``` diff --git a/tests/docs/no_namespace/04_1auto_save_and_calculated.adoc b/tests/docs/no_namespace/04_1auto_save_and_calculated.adoc new file mode 100644 index 0000000..9bc2820 --- /dev/null +++ b/tests/docs/no_namespace/04_1auto_save_and_calculated.adoc @@ -0,0 +1,38 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: 1.1 +var1: no # a first variable +var2: + description: a second variable + auto_save: true + default: + type: variable + variable: _.var1 +---- +== Variables + +[cols="121a,121a",options="header"] +|==== +| Variable | Description +| +**var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A first variable. + +**Default**: no +| +**var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `auto modified` | +A second variable. + +**Default**: the value of the variable "var1". +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +var1: no +var2: no +---- diff --git a/tests/docs/no_namespace/04_1auto_save_and_calculated.md b/tests/docs/no_namespace/04_1auto_save_and_calculated.md new file mode 100644 index 0000000..788b29f --- /dev/null +++ b/tests/docs/no_namespace/04_1auto_save_and_calculated.md @@ -0,0 +1,32 @@ +--- +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: + type: variable + variable: _.var1 +``` +# Variables + +| Variable                                                                                                                | Description                                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A first variable.
**Default**: no | +| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `auto modified` | A second variable.
**Default**: the value of the variable "var1". | + + +# Example with all variables modifiable + +```yaml +--- +var1: no +var2: no +``` diff --git a/tests/docs/no_namespace/04_1auto_save_and_calculated_hidden.adoc b/tests/docs/no_namespace/04_1auto_save_and_calculated_hidden.adoc new file mode 100644 index 0000000..b35d393 --- /dev/null +++ b/tests/docs/no_namespace/04_1auto_save_and_calculated_hidden.adoc @@ -0,0 +1,47 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +var1: no # a first variable +var2: + description: a second variable + auto_save: true + hidden: + type: jinja + jinja: | + {% if _.var1 == "yes" %} + _.var1 is yes + {% endif %} + description: only if the variable var1 has value "yes" + default: + type: jinja + jinja: yes + description: the value is always yes +---- +== Variables + +[cols="132a,132a",options="header"] +|==== +| Variable | Description +| +**var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A first variable. + +**Default**: no +| +**var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` _`hidden`_ `auto modified` | +A second variable. + +**Default**: the value is always yes. + +**Hidden**: only if the variable var1 has value "yes". +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +var1: no +var2: yes +---- diff --git a/tests/docs/no_namespace/04_1auto_save_and_calculated_hidden.md b/tests/docs/no_namespace/04_1auto_save_and_calculated_hidden.md new file mode 100644 index 0000000..cc2dee5 --- /dev/null +++ b/tests/docs/no_namespace/04_1auto_save_and_calculated_hidden.md @@ -0,0 +1,40 @@ +--- +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: + type: jinja + jinja: | + {% if _.var1 == "yes" %} + _.var1 is yes + {% endif %} + description: only if the variable var1 has value "yes" + default: + type: jinja + jinja: yes + description: the value is always yes +``` +# Variables + +| Variable                                                                                                                           | Description                                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A first variable.
**Default**: no | +| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` _`hidden`_ `auto modified` | A second variable.
**Default**: the value is always yes.
**Hidden**: only if the variable var1 has value "yes". | + + +# Example with all variables modifiable + +```yaml +--- +var1: no +var2: yes +``` diff --git a/tests/docs/no_namespace/04_1auto_save_and_hidden.adoc b/tests/docs/no_namespace/04_1auto_save_and_hidden.adoc new file mode 100644 index 0000000..e8bea5c --- /dev/null +++ b/tests/docs/no_namespace/04_1auto_save_and_hidden.adoc @@ -0,0 +1,11 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +var: + description: autosave variable + auto_save: true + hidden: true + default: yes +---- diff --git a/tests/docs/no_namespace/04_1auto_save_and_hidden.md b/tests/docs/no_namespace/04_1auto_save_and_hidden.md new file mode 100644 index 0000000..7bbe9eb --- /dev/null +++ b/tests/docs/no_namespace/04_1auto_save_and_hidden.md @@ -0,0 +1,15 @@ +--- +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 +``` diff --git a/tests/docs/no_namespace/04_5disabled_calculation_optional.adoc b/tests/docs/no_namespace/04_5disabled_calculation_optional.adoc new file mode 100644 index 0000000..d5b8c3d --- /dev/null +++ b/tests/docs/no_namespace/04_5disabled_calculation_optional.adoc @@ -0,0 +1,77 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +condition: no # a condition +var1: + description: a first variable + hidden: + type: jinja + jinja: | + {% if unknown is not defined %} + unknown is undefined + {% elif unknown == "no" %} + unknown is no + {% endif %} + params: + unknown: + type: variable + variable: _.unknown + optional: true + description: calculation from an unknown variable +var2: + description: a second variable + hidden: + type: jinja + jinja: | + {% if condition is not defined %} + condition is undefined + {% elif condition == "no" %} + condition is no + {% endif %} + params: + condition: + type: variable + variable: _.condition + optional: true + description: calculation from an condition variable +---- +== Variables + +[cols="116a,116a",options="header"] +|==== +| Variable | Description +| +**condition** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A condition. + +**Default**: no +| +**var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` _`hidden`_ | +A first variable. + +**Hidden**: calculation from an unknown variable. +| +**var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` _`hidden`_ | +A second variable. + +**Hidden**: calculation from an condition variable. +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +var1: example +var2: example +---- +== Example with all variables modifiable + +[,yaml] +---- +condition: no +var1: example +var2: example +---- diff --git a/tests/docs/no_namespace/04_5disabled_calculation_optional.md b/tests/docs/no_namespace/04_5disabled_calculation_optional.md new file mode 100644 index 0000000..6431a5f --- /dev/null +++ b/tests/docs/no_namespace/04_5disabled_calculation_optional.md @@ -0,0 +1,67 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +condition: no # a condition +var1: + description: a first variable + hidden: + type: jinja + jinja: | + {% if unknown is not defined %} + unknown is undefined + {% elif unknown == "no" %} + unknown is no + {% endif %} + params: + unknown: + type: variable + variable: _.unknown + optional: true + description: calculation from an unknown variable +var2: + description: a second variable + hidden: + type: jinja + jinja: | + {% if condition is not defined %} + condition is undefined + {% elif condition == "no" %} + condition is no + {% endif %} + params: + condition: + type: variable + variable: _.condition + optional: true + description: calculation from an condition variable +``` +# Variables + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.
**Default**: no | +| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` _`hidden`_ | A first variable.
**Hidden**: calculation from an unknown variable. | +| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` _`hidden`_ | A second variable.
**Hidden**: calculation from an condition variable. | + + +# Example with mandatory variables not filled in + +```yaml +--- +var1: example +var2: example +``` +# Example with all variables modifiable + +```yaml +--- +condition: no +var1: example +var2: example +``` diff --git a/tests/docs/no_namespace/04_5disabled_calculation_variable.adoc b/tests/docs/no_namespace/04_5disabled_calculation_variable.adoc new file mode 100644 index 0000000..1c06d39 --- /dev/null +++ b/tests/docs/no_namespace/04_5disabled_calculation_variable.adoc @@ -0,0 +1,43 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +condition: false # a condition +variable: + description: a variable + disabled: + type: variable + variable: _.condition +---- +== Variables + +[cols="118a,118a",options="header"] +|==== +| Variable | Description +| +**condition** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | +A condition. + +**Default**: False +| +**variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` _`disabled`_ | +A variable. + +**Disabled**: when the variable "condition" has the value "True". +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +variable: example +---- +== Example with all variables modifiable + +[,yaml] +---- +condition: false +variable: example +---- diff --git a/tests/docs/no_namespace/04_5disabled_calculation_variable.md b/tests/docs/no_namespace/04_5disabled_calculation_variable.md new file mode 100644 index 0000000..f051333 --- /dev/null +++ b/tests/docs/no_namespace/04_5disabled_calculation_variable.md @@ -0,0 +1,37 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +condition: false # a condition +variable: + description: a variable + disabled: + type: variable + variable: _.condition +``` +# Variables + +| Variable                                                                                                             | Description                                                                                                          | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **condition**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.
**Default**: False | +| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` _`disabled`_ | A variable.
**Disabled**: when the variable "condition" has the value "True". | + + +# Example with mandatory variables not filled in + +```yaml +--- +variable: example +``` +# Example with all variables modifiable + +```yaml +--- +condition: false +variable: example +``` diff --git a/tests/docs/no_namespace/04_5disabled_calculation_variable2.adoc b/tests/docs/no_namespace/04_5disabled_calculation_variable2.adoc new file mode 100644 index 0000000..199a789 --- /dev/null +++ b/tests/docs/no_namespace/04_5disabled_calculation_variable2.adoc @@ -0,0 +1,43 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +condition: true # a condition +variable: + description: a variable + disabled: + type: variable + variable: _.condition +---- +== Variables + +[cols="118a,118a",options="header"] +|==== +| Variable | Description +| +**condition** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | +A condition. + +**Default**: True +| +**variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` _`disabled`_ | +A variable. + +**Disabled**: when the variable "condition" has the value "True". +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +variable: example +---- +== Example with all variables modifiable + +[,yaml] +---- +condition: true +variable: example +---- diff --git a/tests/docs/no_namespace/04_5disabled_calculation_variable2.md b/tests/docs/no_namespace/04_5disabled_calculation_variable2.md new file mode 100644 index 0000000..ded660c --- /dev/null +++ b/tests/docs/no_namespace/04_5disabled_calculation_variable2.md @@ -0,0 +1,37 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +condition: true # a condition +variable: + description: a variable + disabled: + type: variable + variable: _.condition +``` +# Variables + +| Variable                                                                                                             | Description                                                                                                          | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **condition**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.
**Default**: True | +| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` _`disabled`_ | A variable.
**Disabled**: when the variable "condition" has the value "True". | + + +# Example with mandatory variables not filled in + +```yaml +--- +variable: example +``` +# Example with all variables modifiable + +```yaml +--- +condition: true +variable: example +``` diff --git a/tests/docs/no_namespace/04_5disabled_calculation_variable3.adoc b/tests/docs/no_namespace/04_5disabled_calculation_variable3.adoc new file mode 100644 index 0000000..20c319d --- /dev/null +++ b/tests/docs/no_namespace/04_5disabled_calculation_variable3.adoc @@ -0,0 +1,44 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +condition: yes # a condition +variable: + description: a variable + disabled: + type: variable + variable: _.condition + when: yes +---- +== Variables + +[cols="118a,118a",options="header"] +|==== +| Variable | Description +| +**condition** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A condition. + +**Default**: yes +| +**variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` _`disabled`_ | +A variable. + +**Disabled**: when the variable "condition" has the value "yes". +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +variable: example +---- +== Example with all variables modifiable + +[,yaml] +---- +condition: yes +variable: example +---- diff --git a/tests/docs/no_namespace/04_5disabled_calculation_variable3.md b/tests/docs/no_namespace/04_5disabled_calculation_variable3.md new file mode 100644 index 0000000..25d7dc5 --- /dev/null +++ b/tests/docs/no_namespace/04_5disabled_calculation_variable3.md @@ -0,0 +1,38 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +condition: yes # a condition +variable: + description: a variable + disabled: + type: variable + variable: _.condition + when: yes +``` +# Variables + +| Variable                                                                                                             | Description                                                                                                          | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.
**Default**: yes | +| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` _`disabled`_ | A variable.
**Disabled**: when the variable "condition" has the value "yes". | + + +# Example with mandatory variables not filled in + +```yaml +--- +variable: example +``` +# Example with all variables modifiable + +```yaml +--- +condition: yes +variable: example +``` diff --git a/tests/docs/no_namespace/04_5disabled_calculation_variable4.adoc b/tests/docs/no_namespace/04_5disabled_calculation_variable4.adoc new file mode 100644 index 0000000..f611be7 --- /dev/null +++ b/tests/docs/no_namespace/04_5disabled_calculation_variable4.adoc @@ -0,0 +1,44 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +condition: yes # a condition +variable: + description: a variable + disabled: + type: variable + variable: _.condition + when_not: yes +---- +== Variables + +[cols="118a,118a",options="header"] +|==== +| Variable | Description +| +**condition** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A condition. + +**Default**: yes +| +**variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` _`disabled`_ | +A variable. + +**Disabled**: when the variable "condition" hasn't the value "yes". +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +variable: example +---- +== Example with all variables modifiable + +[,yaml] +---- +condition: yes +variable: example +---- diff --git a/tests/docs/no_namespace/04_5disabled_calculation_variable4.md b/tests/docs/no_namespace/04_5disabled_calculation_variable4.md new file mode 100644 index 0000000..32ea32a --- /dev/null +++ b/tests/docs/no_namespace/04_5disabled_calculation_variable4.md @@ -0,0 +1,38 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +condition: yes # a condition +variable: + description: a variable + disabled: + type: variable + variable: _.condition + when_not: yes +``` +# Variables + +| Variable                                                                                                             | Description                                                                                                          | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.
**Default**: yes | +| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` _`disabled`_ | A variable.
**Disabled**: when the variable "condition" hasn't the value "yes". | + + +# Example with mandatory variables not filled in + +```yaml +--- +variable: example +``` +# Example with all variables modifiable + +```yaml +--- +condition: yes +variable: example +``` diff --git a/tests/docs/no_namespace/04_5validators.adoc b/tests/docs/no_namespace/04_5validators.adoc new file mode 100644 index 0000000..ea38555 --- /dev/null +++ b/tests/docs/no_namespace/04_5validators.adoc @@ -0,0 +1,41 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +int: + description: A number + type: number + validators: + - type: jinja + jinja: | + {% if _.int > 100 %} + value is too high + {% endif %} + description: the max value is 100 +---- +== Variables + +[cols="105a,105a",options="header"] +|==== +| Variable | Description +| +**int** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `basic` `mandatory` | +A number. + +**Validator**: the max value is 100. +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +int: 42 +---- +== Example with all variables modifiable + +[,yaml] +---- +int: 42 +---- diff --git a/tests/docs/no_namespace/04_5validators.md b/tests/docs/no_namespace/04_5validators.md new file mode 100644 index 0000000..deb5ce9 --- /dev/null +++ b/tests/docs/no_namespace/04_5validators.md @@ -0,0 +1,39 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +int: + description: A number + type: number + validators: + - type: jinja + jinja: | + {% if _.int > 100 %} + value is too high + {% endif %} + description: the max value is 100 +``` +# Variables + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **int**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A number.
**Validator**: the max value is 100. | + + +# Example with mandatory variables not filled in + +```yaml +--- +int: 42 +``` +# Example with all variables modifiable + +```yaml +--- +int: 42 +``` diff --git a/tests/docs/no_namespace/04_5validators_differ.adoc b/tests/docs/no_namespace/04_5validators_differ.adoc new file mode 100644 index 0000000..3ea2154 --- /dev/null +++ b/tests/docs/no_namespace/04_5validators_differ.adoc @@ -0,0 +1,44 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +var1: + description: a first variable + type: string + default: oui + validators: + - type: jinja + jinja: | + {% if _.var1 == _.var2 %} + var1 must be different than var2 + {% endif %} + description: var1 must be different than var2 +var2: no # A second variable +---- +== Variables + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A first variable. + +**Validator**: var1 must be different than var2. + +**Default**: oui +| +**var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A second variable. + +**Default**: no +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +var1: oui +var2: no +---- diff --git a/tests/docs/no_namespace/04_5validators_differ.md b/tests/docs/no_namespace/04_5validators_differ.md new file mode 100644 index 0000000..c79ad6b --- /dev/null +++ b/tests/docs/no_namespace/04_5validators_differ.md @@ -0,0 +1,37 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: + description: a first variable + type: string + default: oui + validators: + - type: jinja + jinja: | + {% if _.var1 == _.var2 %} + var1 must be different than var2 + {% endif %} + description: var1 must be different than var2 +var2: no # A second variable +``` +# Variables + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A first variable.
**Validator**: var1 must be different than var2.
**Default**: oui | +| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second variable.
**Default**: no | + + +# Example with all variables modifiable + +```yaml +--- +var1: oui +var2: no +``` diff --git a/tests/docs/no_namespace/04_5validators_in_network.adoc b/tests/docs/no_namespace/04_5validators_in_network.adoc new file mode 100644 index 0000000..54b19e8 --- /dev/null +++ b/tests/docs/no_namespace/04_5validators_in_network.adoc @@ -0,0 +1,62 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +network_address_eth0: + description: Network address + type: network +netmask_address_eth0: + description: Network address + type: netmask +ip_address: + description: an IP + type: ip + validators: + - type: jinja + jinja: | + {% if not _.ip_address | valid_in_network(_.network_address_eth0, _.netmask_address_eth0) %} + {{ _.ip_address }} is not in network {{ _.network_address_eth0 }}/{{ _.netmask_address_eth0 }} + {% endif %} + description: check if IP in the previous network +---- +== Variables + +[cols="101a,101a",options="header"] +|==== +| Variable | Description +| +**network_address_eth0** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[network]` `basic` `mandatory` | +Network address. +| +**netmask_address_eth0** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[netmask]` `basic` `mandatory` | +Network address. +| +**ip_address** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[IP]` `basic` `mandatory` | +An IP. + +**Validators**: + +* reserved IP are allowed +* check if IP in the previous network. +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +network_address_eth0: 1.1.1.0 +netmask_address_eth0: 255.255.255.0 +ip_address: 1.1.1.1 +---- +== Example with all variables modifiable + +[,yaml] +---- +network_address_eth0: 1.1.1.0 +netmask_address_eth0: 255.255.255.0 +ip_address: 1.1.1.1 +---- diff --git a/tests/docs/no_namespace/04_5validators_in_network.md b/tests/docs/no_namespace/04_5validators_in_network.md new file mode 100644 index 0000000..58317ea --- /dev/null +++ b/tests/docs/no_namespace/04_5validators_in_network.md @@ -0,0 +1,51 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +network_address_eth0: + description: Network address + type: network +netmask_address_eth0: + description: Network address + type: netmask +ip_address: + description: an IP + type: ip + validators: + - type: jinja + jinja: | + {% if not _.ip_address | valid_in_network(_.network_address_eth0, _.netmask_address_eth0) %} + {{ _.ip_address }} is not in network {{ _.network_address_eth0 }}/{{ _.netmask_address_eth0 }} + {% endif %} + description: check if IP in the previous network +``` +# Variables + +| Variable                                                                                            | Description                                                                                         | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **network_address_eth0**
[`network`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | Network address. | +| **netmask_address_eth0**
[`netmask`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | Network address. | +| **ip_address**
[`IP`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | An IP.
**Validators**:
- reserved IP are allowed
- check if IP in the previous network. | + + +# Example with mandatory variables not filled in + +```yaml +--- +network_address_eth0: 1.1.1.0 +netmask_address_eth0: 255.255.255.0 +ip_address: 1.1.1.1 +``` +# Example with all variables modifiable + +```yaml +--- +network_address_eth0: 1.1.1.0 +netmask_address_eth0: 255.255.255.0 +ip_address: 1.1.1.1 +``` diff --git a/tests/docs/no_namespace/04_5validators_in_network_cidr.adoc b/tests/docs/no_namespace/04_5validators_in_network_cidr.adoc new file mode 100644 index 0000000..80dc9a0 --- /dev/null +++ b/tests/docs/no_namespace/04_5validators_in_network_cidr.adoc @@ -0,0 +1,53 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +network_address_eth0: + description: Network address + type: cidr +ip_address: + description: an IP + type: ip + validators: + - type: jinja + jinja: | + {% if not _.ip_address | valid_in_network(_.network_address_eth0) %} + {{ _.ip_address }} is not in network {{ _.network_address_eth0 }} + {% endif %} + description: this IP must be in network +---- +== Variables + +[cols="101a,101a",options="header"] +|==== +| Variable | Description +| +**network_address_eth0** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[cidr]` `basic` `mandatory` | +Network address. +| +**ip_address** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[IP]` `basic` `mandatory` | +An IP. + +**Validators**: + +* reserved IP are allowed +* this IP must be in network. +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +network_address_eth0: 1.1.1.0/24 +ip_address: 1.1.1.1 +---- +== Example with all variables modifiable + +[,yaml] +---- +network_address_eth0: 1.1.1.0/24 +ip_address: 1.1.1.1 +---- diff --git a/tests/docs/no_namespace/04_5validators_in_network_cidr.md b/tests/docs/no_namespace/04_5validators_in_network_cidr.md new file mode 100644 index 0000000..9a85ab7 --- /dev/null +++ b/tests/docs/no_namespace/04_5validators_in_network_cidr.md @@ -0,0 +1,45 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +network_address_eth0: + description: Network address + type: cidr +ip_address: + description: an IP + type: ip + validators: + - type: jinja + jinja: | + {% if not _.ip_address | valid_in_network(_.network_address_eth0) %} + {{ _.ip_address }} is not in network {{ _.network_address_eth0 }} + {% endif %} + description: this IP must be in network +``` +# Variables + +| Variable                                                                                            | Description                                                                                         | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **network_address_eth0**
[`cidr`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | Network address. | +| **ip_address**
[`IP`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | An IP.
**Validators**:
- reserved IP are allowed
- this IP must be in network. | + + +# Example with mandatory variables not filled in + +```yaml +--- +network_address_eth0: 1.1.1.0/24 +ip_address: 1.1.1.1 +``` +# Example with all variables modifiable + +```yaml +--- +network_address_eth0: 1.1.1.0/24 +ip_address: 1.1.1.1 +``` diff --git a/tests/docs/no_namespace/04_5validators_ipnetmask.adoc b/tests/docs/no_namespace/04_5validators_ipnetmask.adoc new file mode 100644 index 0000000..ceb1ea6 --- /dev/null +++ b/tests/docs/no_namespace/04_5validators_ipnetmask.adoc @@ -0,0 +1,50 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +network_address_eth0: + description: Network address + type: network +netmask_address_eth0: + description: Netmask address + type: netmask + validators: + - type: jinja + jinja: | + {% if not _.netmask_address_eth0 | valid_in_network(_.network_address_eth0) %} + {{ _.netmask_address_eth0 }} is not a netmask for network {{ _.network_address_eth0 }} + {% endif %} + description: this mask is possible for the network +---- +== Variables + +[cols="106a,106a",options="header"] +|==== +| Variable | Description +| +**network_address_eth0** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[network]` `basic` `mandatory` | +Network address. +| +**netmask_address_eth0** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[netmask]` `basic` `mandatory` | +Netmask address. + +**Validator**: this mask is possible for the network. +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +network_address_eth0: 1.1.1.0 +netmask_address_eth0: 255.255.255.0 +---- +== Example with all variables modifiable + +[,yaml] +---- +network_address_eth0: 1.1.1.0 +netmask_address_eth0: 255.255.255.0 +---- diff --git a/tests/docs/no_namespace/04_5validators_ipnetmask.md b/tests/docs/no_namespace/04_5validators_ipnetmask.md new file mode 100644 index 0000000..eaf18ba --- /dev/null +++ b/tests/docs/no_namespace/04_5validators_ipnetmask.md @@ -0,0 +1,45 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +network_address_eth0: + description: Network address + type: network +netmask_address_eth0: + description: Netmask address + type: netmask + validators: + - type: jinja + jinja: | + {% if not _.netmask_address_eth0 | valid_in_network(_.network_address_eth0) %} + {{ _.netmask_address_eth0 }} is not a netmask for network {{ _.network_address_eth0 }} + {% endif %} + description: this mask is possible for the network +``` +# Variables + +| Variable                                                                                                 | Description                                                                                              | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **network_address_eth0**
[`network`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | Network address. | +| **netmask_address_eth0**
[`netmask`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | Netmask address.
**Validator**: this mask is possible for the network. | + + +# Example with mandatory variables not filled in + +```yaml +--- +network_address_eth0: 1.1.1.0 +netmask_address_eth0: 255.255.255.0 +``` +# Example with all variables modifiable + +```yaml +--- +network_address_eth0: 1.1.1.0 +netmask_address_eth0: 255.255.255.0 +``` diff --git a/tests/docs/no_namespace/04_7validators_variable_optional.adoc b/tests/docs/no_namespace/04_7validators_variable_optional.adoc new file mode 100644 index 0000000..1a15e7d --- /dev/null +++ b/tests/docs/no_namespace/04_7validators_variable_optional.adoc @@ -0,0 +1,74 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +general: # a family + int: + description: a first number + type: number + validators: + - type: jinja + jinja: | + {% if _.int == int2 %} + int and int2 must be different + {% endif %} + params: + int2: + type: variable + variable: _.int2 + optional: true + description: int and int2 must be different + - type: jinja + jinja: | + {% if _.int == int3 %} + int and int3 must be different + {% endif %} + params: + int3: + type: variable + variable: _.int3 + optional: true + description: int and int3 must be different + int2: 1 # a second number +---- +== Variables + +=== a family + +`basic` + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**general.int** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `basic` `mandatory` | +A first number. + +**Validators**: + +* int and int2 must be different. +* int and int3 must be different. +| +**general.int2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` | +A second number. + +**Default**: 1 +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +general: + int: 42 +---- +== Example with all variables modifiable + +[,yaml] +---- +general: + int: 42 + int2: 1 +---- diff --git a/tests/docs/no_namespace/04_7validators_variable_optional.md b/tests/docs/no_namespace/04_7validators_variable_optional.md new file mode 100644 index 0000000..13b0d1d --- /dev/null +++ b/tests/docs/no_namespace/04_7validators_variable_optional.md @@ -0,0 +1,65 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +general: # a family + int: + description: a first number + type: number + validators: + - type: jinja + jinja: | + {% if _.int == int2 %} + int and int2 must be different + {% endif %} + params: + int2: + type: variable + variable: _.int2 + optional: true + description: int and int2 must be different + - type: jinja + jinja: | + {% if _.int == int3 %} + int and int3 must be different + {% endif %} + params: + int3: + type: variable + variable: _.int3 + optional: true + description: int and int3 must be different + int2: 1 # a second number +``` +# Variables + +## a family + +`basic` + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **general.int**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A first number.
**Validators**:
- int and int2 must be different.
- int and int3 must be different. | +| **general.int2**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second number.
**Default**: 1 | + + +# Example with mandatory variables not filled in + +```yaml +--- +general: + int: 42 +``` +# Example with all variables modifiable + +```yaml +--- +general: + int: 42 + int2: 1 +``` diff --git a/tests/docs/no_namespace/05_0multi_not_uniq.adoc b/tests/docs/no_namespace/05_0multi_not_uniq.adoc new file mode 100644 index 0000000..b65e635 --- /dev/null +++ b/tests/docs/no_namespace/05_0multi_not_uniq.adoc @@ -0,0 +1,33 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +var1: + description: a variable + unique: false + default: + - non +---- +== Variables + +[cols="119a,119a",options="header"] +|==== +| Variable | Description +| +**var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `multiple` | +A variable. + +**Default**: + +* non +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +var1: + - non +---- diff --git a/tests/docs/no_namespace/05_0multi_not_uniq.md b/tests/docs/no_namespace/05_0multi_not_uniq.md new file mode 100644 index 0000000..95b27cd --- /dev/null +++ b/tests/docs/no_namespace/05_0multi_not_uniq.md @@ -0,0 +1,29 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: + description: a variable + unique: false + default: + - non +``` +# Variables + +| Variable                                                                                                              | Description                                                                                                           | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `multiple` | A variable.
**Default**:
- non | + + +# Example with all variables modifiable + +```yaml +--- +var1: + - non +``` diff --git a/tests/docs/no_namespace/05_0multi_uniq.adoc b/tests/docs/no_namespace/05_0multi_uniq.adoc new file mode 100644 index 0000000..7748dc9 --- /dev/null +++ b/tests/docs/no_namespace/05_0multi_uniq.adoc @@ -0,0 +1,33 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +variable: + description: a variable + unique: true + default: + - non +---- +== Variables + +[cols="128a,128a",options="header"] +|==== +| Variable | Description +| +**variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +A variable. + +**Default**: + +* non +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +variable: + - non +---- diff --git a/tests/docs/no_namespace/05_0multi_uniq.md b/tests/docs/no_namespace/05_0multi_uniq.md new file mode 100644 index 0000000..1b3ec1a --- /dev/null +++ b/tests/docs/no_namespace/05_0multi_uniq.md @@ -0,0 +1,29 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +variable: + description: a variable + unique: true + default: + - non +``` +# Variables + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A variable.
**Default**:
- non | + + +# Example with all variables modifiable + +```yaml +--- +variable: + - non +``` diff --git a/tests/docs/no_namespace/12_1auto_save_expert.adoc b/tests/docs/no_namespace/12_1auto_save_expert.adoc new file mode 100644 index 0000000..b2fa8f9 --- /dev/null +++ b/tests/docs/no_namespace/12_1auto_save_expert.adoc @@ -0,0 +1,11 @@ +== 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/no_namespace/12_1auto_save_expert.md b/tests/docs/no_namespace/12_1auto_save_expert.md new file mode 100644 index 0000000..7ae5957 --- /dev/null +++ b/tests/docs/no_namespace/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/no_namespace/16_0redefine_description.adoc b/tests/docs/no_namespace/16_0redefine_description.adoc new file mode 100644 index 0000000..f4080fb --- /dev/null +++ b/tests/docs/no_namespace/16_0redefine_description.adoc @@ -0,0 +1,41 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +var: + description: Redefine description +---- +== dictionaries/rougail/01-redefine.yml + +[,yaml] +---- +version: '1.1' +var: + description: Redefined + redefine: true +---- +== Variables + +[cols="105a,105a",options="header"] +|==== +| Variable | Description +| +**var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +Redefined. +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +var: example +---- +== Example with all variables modifiable + +[,yaml] +---- +var: example +---- diff --git a/tests/docs/no_namespace/16_0redefine_description.md b/tests/docs/no_namespace/16_0redefine_description.md new file mode 100644 index 0000000..11098a3 --- /dev/null +++ b/tests/docs/no_namespace/16_0redefine_description.md @@ -0,0 +1,40 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: + description: Redefine description +``` +# dictionaries/rougail/01-redefine.yml + +```yaml +--- +version: '1.1' +var: + description: Redefined + redefine: true +``` +# Variables + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | Redefined. | + + +# Example with mandatory variables not filled in + +```yaml +--- +var: example +``` +# Example with all variables modifiable + +```yaml +--- +var: example +``` diff --git a/tests/docs/no_namespace/16_2family_redefine_calculation.adoc b/tests/docs/no_namespace/16_2family_redefine_calculation.adoc new file mode 100644 index 0000000..7474dc0 --- /dev/null +++ b/tests/docs/no_namespace/16_2family_redefine_calculation.adoc @@ -0,0 +1,52 @@ +== dictionaries/rougail/01-base.yml + +[,yaml] +---- +version: '1.0' +family: + redefine: true + disabled: + type: jinja + jinja: | + true +---- +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.0' +family: + var1: +---- +== Variables + +=== family + +`basic` _`disabled`_ + +**Disabled**: issu d'un calcul. + +[cols="105a,105a",options="header"] +|==== +| Variable | Description +| +**family.var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +Var1. +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +family: + var1: example +---- +== Example with all variables modifiable + +[,yaml] +---- +family: + var1: example +---- diff --git a/tests/docs/no_namespace/16_2family_redefine_calculation.md b/tests/docs/no_namespace/16_2family_redefine_calculation.md new file mode 100644 index 0000000..e24540c --- /dev/null +++ b/tests/docs/no_namespace/16_2family_redefine_calculation.md @@ -0,0 +1,51 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/01-base.yml + +```yaml +--- +version: '1.0' +family: + redefine: true + disabled: + type: jinja + jinja: | + true +``` +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.0' +family: + var1: +``` +# Variables + +## family + +`basic` _`disabled`_ + +**Disabled**: issu d'un calcul. + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **family.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | Var1. | + + +# Example with mandatory variables not filled in + +```yaml +--- +family: + var1: example +``` +# Example with all variables modifiable + +```yaml +--- +family: + var1: example +``` diff --git a/tests/docs/no_namespace/16_2family_redefine_disabled.adoc b/tests/docs/no_namespace/16_2family_redefine_disabled.adoc new file mode 100644 index 0000000..14f798a --- /dev/null +++ b/tests/docs/no_namespace/16_2family_redefine_disabled.adoc @@ -0,0 +1,17 @@ +== 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/no_namespace/16_2family_redefine_disabled.md b/tests/docs/no_namespace/16_2family_redefine_disabled.md new file mode 100644 index 0000000..9ac5af4 --- /dev/null +++ b/tests/docs/no_namespace/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/no_namespace/16_5exists_nonexists.adoc b/tests/docs/no_namespace/16_5exists_nonexists.adoc new file mode 100644 index 0000000..5cfd257 --- /dev/null +++ b/tests/docs/no_namespace/16_5exists_nonexists.adoc @@ -0,0 +1,42 @@ +== dictionaries/rougail/01-base.yml + +[,yaml] +---- +version: '1.1' +var2: + description: a new variable + exists: false + default: yes +---- +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +var1: no # a variable +---- +== Variables + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A variable. + +**Default**: no +| +**var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A new variable. + +**Default**: yes +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +var1: no +var2: yes +---- diff --git a/tests/docs/no_namespace/16_5exists_nonexists.md b/tests/docs/no_namespace/16_5exists_nonexists.md new file mode 100644 index 0000000..4564532 --- /dev/null +++ b/tests/docs/no_namespace/16_5exists_nonexists.md @@ -0,0 +1,36 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/01-base.yml + +```yaml +--- +version: '1.1' +var2: + description: a new variable + exists: false + default: yes +``` +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: no # a variable +``` +# Variables + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: no | +| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A new variable.
**Default**: yes | + + +# Example with all variables modifiable + +```yaml +--- +var1: no +var2: yes +``` diff --git a/tests/docs/no_namespace/16_5exists_redefine.adoc b/tests/docs/no_namespace/16_5exists_redefine.adoc new file mode 100644 index 0000000..04d36a1 --- /dev/null +++ b/tests/docs/no_namespace/16_5exists_redefine.adoc @@ -0,0 +1,25 @@ +== 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 +---- diff --git a/tests/docs/no_namespace/16_5exists_redefine.md b/tests/docs/no_namespace/16_5exists_redefine.md new file mode 100644 index 0000000..40f84ee --- /dev/null +++ b/tests/docs/no_namespace/16_5exists_redefine.md @@ -0,0 +1,29 @@ +--- +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 +``` diff --git a/tests/docs/no_namespace/16_5redefine_calculation.adoc b/tests/docs/no_namespace/16_5redefine_calculation.adoc new file mode 100644 index 0000000..a7e615f --- /dev/null +++ b/tests/docs/no_namespace/16_5redefine_calculation.adoc @@ -0,0 +1,43 @@ +== dictionaries/rougail/01-base.yml + +[,yaml] +---- +version: '1.1' +variable: + redefine: true + default: + type: jinja + jinja: yes + description: returns yes +---- +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +variable: + description: a variable + default: + type: jinja + jinja: no + description: returns no +---- +== Variables + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A variable. + +**Default**: returns yes. +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +variable: yes +---- diff --git a/tests/docs/no_namespace/16_5redefine_calculation.md b/tests/docs/no_namespace/16_5redefine_calculation.md new file mode 100644 index 0000000..72bc16a --- /dev/null +++ b/tests/docs/no_namespace/16_5redefine_calculation.md @@ -0,0 +1,41 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/01-base.yml + +```yaml +--- +version: '1.1' +variable: + redefine: true + default: + type: jinja + jinja: yes + description: returns yes +``` +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +variable: + description: a variable + default: + type: jinja + jinja: no + description: returns no +``` +# Variables + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: returns yes. | + + +# Example with all variables modifiable + +```yaml +--- +variable: yes +``` diff --git a/tests/docs/no_namespace/16_5redefine_choice.adoc b/tests/docs/no_namespace/16_5redefine_choice.adoc new file mode 100644 index 0000000..6aa909f --- /dev/null +++ b/tests/docs/no_namespace/16_5redefine_choice.adoc @@ -0,0 +1,51 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +variable: + description: a variable + choices: + - a + - b + - c +---- +== dictionaries/rougail/01-redefine.yml + +[,yaml] +---- +version: '1.0' +variable: + redefine: true + choices: + - a + - b +---- +== Variables + +[cols="105a,105a",options="header"] +|==== +| Variable | Description +| +**variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `basic` `mandatory` | +A variable. + +**Choices**: + +* a +* b +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +variable: a_choice +---- +== Example with all variables modifiable + +[,yaml] +---- +variable: a_choice +---- diff --git a/tests/docs/no_namespace/16_5redefine_choice.md b/tests/docs/no_namespace/16_5redefine_choice.md new file mode 100644 index 0000000..d9cd950 --- /dev/null +++ b/tests/docs/no_namespace/16_5redefine_choice.md @@ -0,0 +1,46 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +variable: + description: a variable + choices: + - a + - b + - c +``` +# dictionaries/rougail/01-redefine.yml + +```yaml +--- +version: '1.0' +variable: + redefine: true + choices: + - a + - b +``` +# Variables + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **variable**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable.
**Choices**:
- a
- b | + + +# Example with mandatory variables not filled in + +```yaml +--- +variable: a_choice +``` +# Example with all variables modifiable + +```yaml +--- +variable: a_choice +``` diff --git a/tests/docs/no_namespace/16_5redefine_default.adoc b/tests/docs/no_namespace/16_5redefine_default.adoc new file mode 100644 index 0000000..24086f6 --- /dev/null +++ b/tests/docs/no_namespace/16_5redefine_default.adoc @@ -0,0 +1,37 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +variable: + description: a variable + default: no +---- +== dictionaries/rougail/01-redefine.yml + +[,yaml] +---- +version: '1.1' +variable: + redefine: true + default: yes +---- +== Variables + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A variable. + +**Default**: yes +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +variable: yes +---- diff --git a/tests/docs/no_namespace/16_5redefine_default.md b/tests/docs/no_namespace/16_5redefine_default.md new file mode 100644 index 0000000..30f4687 --- /dev/null +++ b/tests/docs/no_namespace/16_5redefine_default.md @@ -0,0 +1,35 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +variable: + description: a variable + default: no +``` +# dictionaries/rougail/01-redefine.yml + +```yaml +--- +version: '1.1' +variable: + redefine: true + default: yes +``` +# Variables + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: yes | + + +# Example with all variables modifiable + +```yaml +--- +variable: yes +``` diff --git a/tests/docs/no_namespace/16_5redefine_default_calculation.adoc b/tests/docs/no_namespace/16_5redefine_default_calculation.adoc new file mode 100644 index 0000000..29d3b64 --- /dev/null +++ b/tests/docs/no_namespace/16_5redefine_default_calculation.adoc @@ -0,0 +1,44 @@ +== 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: + type: jinja + jinja: yes +---- +== Variables + +[cols="105a,105a",options="header"] +|==== +| Variable | Description +| +**variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A variable. +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +variable: example +---- +== Example with all variables modifiable + +[,yaml] +---- +variable: example +---- diff --git a/tests/docs/no_namespace/16_5redefine_default_calculation.md b/tests/docs/no_namespace/16_5redefine_default_calculation.md new file mode 100644 index 0000000..a16e7c8 --- /dev/null +++ b/tests/docs/no_namespace/16_5redefine_default_calculation.md @@ -0,0 +1,43 @@ +--- +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: + type: jinja + jinja: yes +``` +# Variables + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | + + +# Example with mandatory variables not filled in + +```yaml +--- +variable: example +``` +# Example with all variables modifiable + +```yaml +--- +variable: example +``` diff --git a/tests/docs/no_namespace/16_5redefine_family.adoc b/tests/docs/no_namespace/16_5redefine_family.adoc new file mode 100644 index 0000000..0cdca34 --- /dev/null +++ b/tests/docs/no_namespace/16_5redefine_family.adoc @@ -0,0 +1,47 @@ +== dictionaries/rougail/01-base.yml + +[,yaml] +---- +version: '1.1' +family: + redefine: true + description: new description +---- +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +family: # a family + variable: # a variable +---- +== Variables + +=== new description + +`basic` + +[cols="105a,105a",options="header"] +|==== +| Variable | Description +| +**family.variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A variable. +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +family: + variable: example +---- +== Example with all variables modifiable + +[,yaml] +---- +family: + variable: example +---- diff --git a/tests/docs/no_namespace/16_5redefine_family.md b/tests/docs/no_namespace/16_5redefine_family.md new file mode 100644 index 0000000..bc60018 --- /dev/null +++ b/tests/docs/no_namespace/16_5redefine_family.md @@ -0,0 +1,46 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/01-base.yml + +```yaml +--- +version: '1.1' +family: + redefine: true + description: new description +``` +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +family: # a family + variable: # a variable +``` +# Variables + +## new description + +`basic` + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **family.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | + + +# Example with mandatory variables not filled in + +```yaml +--- +family: + variable: example +``` +# Example with all variables modifiable + +```yaml +--- +family: + variable: example +``` diff --git a/tests/docs/no_namespace/16_5redefine_help.adoc b/tests/docs/no_namespace/16_5redefine_help.adoc new file mode 100644 index 0000000..4641242 --- /dev/null +++ b/tests/docs/no_namespace/16_5redefine_help.adoc @@ -0,0 +1,58 @@ +== dictionaries/rougail/01-base.yml + +[,yaml] +---- +version: '1.1' +family: + redefine: true + help: redefine help family ok + variable: + redefine: true + help: redefine help ok +---- +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +family: + description: a family + help: redefine help family + variable: + description: redefine help + help: redefine help +---- +== Variables + +=== a family + +`basic` + + +Redefine help family ok. + +[cols="105a,105a",options="header"] +|==== +| Variable | Description +| +**family.variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +Redefine help. + +Redefine help ok. +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +family: + variable: example +---- +== Example with all variables modifiable + +[,yaml] +---- +family: + variable: example +---- diff --git a/tests/docs/no_namespace/16_5redefine_help.md b/tests/docs/no_namespace/16_5redefine_help.md new file mode 100644 index 0000000..fa5ab77 --- /dev/null +++ b/tests/docs/no_namespace/16_5redefine_help.md @@ -0,0 +1,56 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/01-base.yml + +```yaml +--- +version: '1.1' +family: + redefine: true + help: redefine help family ok + variable: + redefine: true + help: redefine help ok +``` +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +family: + description: a family + help: redefine help family + variable: + description: redefine help + help: redefine help +``` +# Variables + +## a family + +`basic` + + +Redefine help family ok. + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **family.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | Redefine help.
Redefine help ok. | + + +# Example with mandatory variables not filled in + +```yaml +--- +family: + variable: example +``` +# Example with all variables modifiable + +```yaml +--- +family: + variable: example +``` diff --git a/tests/docs/no_namespace/16_5redefine_hidden.adoc b/tests/docs/no_namespace/16_5redefine_hidden.adoc new file mode 100644 index 0000000..e484541 --- /dev/null +++ b/tests/docs/no_namespace/16_5redefine_hidden.adoc @@ -0,0 +1,16 @@ +== 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 +---- diff --git a/tests/docs/no_namespace/16_5redefine_hidden.md b/tests/docs/no_namespace/16_5redefine_hidden.md new file mode 100644 index 0000000..d0b8ac8 --- /dev/null +++ b/tests/docs/no_namespace/16_5redefine_hidden.md @@ -0,0 +1,20 @@ +--- +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 +``` diff --git a/tests/docs/no_namespace/16_5redefine_multi.adoc b/tests/docs/no_namespace/16_5redefine_multi.adoc new file mode 100644 index 0000000..ad2e1d9 --- /dev/null +++ b/tests/docs/no_namespace/16_5redefine_multi.adoc @@ -0,0 +1,42 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +variable: + description: a variable + default: non +---- +== dictionaries/rougail/01-redefine.yml + +[,yaml] +---- +version: '1.1' +variable: + redefine: true + multi: true + default: + - non +---- +== Variables + +[cols="128a,128a",options="header"] +|==== +| Variable | Description +| +**variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +A variable. + +**Default**: + +* non +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +variable: + - non +---- diff --git a/tests/docs/no_namespace/16_5redefine_multi.md b/tests/docs/no_namespace/16_5redefine_multi.md new file mode 100644 index 0000000..82dd331 --- /dev/null +++ b/tests/docs/no_namespace/16_5redefine_multi.md @@ -0,0 +1,38 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +variable: + description: a variable + default: non +``` +# dictionaries/rougail/01-redefine.yml + +```yaml +--- +version: '1.1' +variable: + redefine: true + multi: true + default: + - non +``` +# Variables + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A variable.
**Default**:
- non | + + +# Example with all variables modifiable + +```yaml +--- +variable: + - non +``` diff --git a/tests/docs/no_namespace/16_5redefine_remove_disable_calculation.adoc b/tests/docs/no_namespace/16_5redefine_remove_disable_calculation.adoc new file mode 100644 index 0000000..b5058de --- /dev/null +++ b/tests/docs/no_namespace/16_5redefine_remove_disable_calculation.adoc @@ -0,0 +1,56 @@ +== 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: + type: jinja + jinja: | + {% if _.condition == "yes" %} + true + {% else %} + false + {% endif %} +---- +== Variables + +[cols="105a,105a",options="header"] +|==== +| Variable | Description +| +**condition** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A condition. + +**Default**: no +| +**variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A variable. +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +variable: example +---- +== Example with all variables modifiable + +[,yaml] +---- +condition: no +variable: example +---- diff --git a/tests/docs/no_namespace/16_5redefine_remove_disable_calculation.md b/tests/docs/no_namespace/16_5redefine_remove_disable_calculation.md new file mode 100644 index 0000000..88dcc60 --- /dev/null +++ b/tests/docs/no_namespace/16_5redefine_remove_disable_calculation.md @@ -0,0 +1,51 @@ +--- +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: + type: jinja + jinja: | + {% if _.condition == "yes" %} + true + {% else %} + false + {% endif %} +``` +# Variables + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.
**Default**: no | +| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | + + +# Example with mandatory variables not filled in + +```yaml +--- +variable: example +``` +# Example with all variables modifiable + +```yaml +--- +condition: no +variable: example +``` diff --git a/tests/docs/no_namespace/16_5test_redefine.adoc b/tests/docs/no_namespace/16_5test_redefine.adoc new file mode 100644 index 0000000..8976aeb --- /dev/null +++ b/tests/docs/no_namespace/16_5test_redefine.adoc @@ -0,0 +1,73 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +var1: no # a first variable +var2: + description: a second variable + test: + - test + default: non +var3: + description: a third variable + test: + - test +---- +== dictionaries/rougail/10-base.yml + +[,yaml] +---- +version: '1.1' +var1: + redefine: true + test: + - test1 +var2: + redefine: true + test: + - test1 +var3: + redefine: true + test: +---- +== Variables + +[cols="105a,105a",options="header"] +|==== +| Variable | Description +| +**var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A first variable. + +**Default**: no + +**Example**: test1 +| +**var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A second variable. + +**Default**: non + +**Example**: test1 +| +**var3** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A third variable. +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +var1: test1 +var2: test1 +var3: example +---- +== Example with all variables modifiable + +[,yaml] +---- +var1: test1 +var2: test1 +var3: example +---- diff --git a/tests/docs/no_namespace/16_5test_redefine.md b/tests/docs/no_namespace/16_5test_redefine.md new file mode 100644 index 0000000..fcf35ab --- /dev/null +++ b/tests/docs/no_namespace/16_5test_redefine.md @@ -0,0 +1,62 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: no # a first variable +var2: + description: a second variable + test: + - test + default: non +var3: + description: a third variable + test: + - test +``` +# dictionaries/rougail/10-base.yml + +```yaml +--- +version: '1.1' +var1: + redefine: true + test: + - test1 +var2: + redefine: true + test: + - test1 +var3: + redefine: true + test: +``` +# Variables + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A first variable.
**Default**: no
**Example**: test1 | +| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second variable.
**Default**: non
**Example**: test1 | +| **var3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A third variable. | + + +# Example with mandatory variables not filled in + +```yaml +--- +var1: test1 +var2: test1 +var3: example +``` +# Example with all variables modifiable + +```yaml +--- +var1: test1 +var2: test1 +var3: example +``` diff --git a/tests/docs/no_namespace/16_6choice_redefine.adoc b/tests/docs/no_namespace/16_6choice_redefine.adoc new file mode 100644 index 0000000..0a0aec1 --- /dev/null +++ b/tests/docs/no_namespace/16_6choice_redefine.adoc @@ -0,0 +1,47 @@ +== dictionaries/rougail/01-base.yml + +[,yaml] +---- +version: '1.0' +var: + redefine: true + choices: + - a + - c +---- +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.0' +var: + type: choice + description: A choice + default: c + choices: + - a + - b + - c +---- +== Variables + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` `mandatory` | +A choice. + +**Choices**: + +* a +* c ← (default) +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +var: c +---- diff --git a/tests/docs/no_namespace/16_6choice_redefine.md b/tests/docs/no_namespace/16_6choice_redefine.md new file mode 100644 index 0000000..725e191 --- /dev/null +++ b/tests/docs/no_namespace/16_6choice_redefine.md @@ -0,0 +1,42 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/01-base.yml + +```yaml +--- +version: '1.0' +var: + redefine: true + choices: + - a + - c +``` +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.0' +var: + type: choice + description: A choice + default: c + choices: + - a + - b + - c +``` +# Variables + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A choice.
**Choices**:
- a
- c ← (default) | + + +# Example with all variables modifiable + +```yaml +--- +var: c +``` diff --git a/tests/docs/no_namespace/16exists_exists.adoc b/tests/docs/no_namespace/16exists_exists.adoc new file mode 100644 index 0000000..17f3980 --- /dev/null +++ b/tests/docs/no_namespace/16exists_exists.adoc @@ -0,0 +1,41 @@ +== dictionaries/rougail/01-base.yml + +[,yaml] +---- +version: '1.1' +var: + description: New description + exists: false +---- +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +var: + description: Description +---- +== Variables + +[cols="105a,105a",options="header"] +|==== +| Variable | Description +| +**var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +Description. +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +var: example +---- +== Example with all variables modifiable + +[,yaml] +---- +var: example +---- diff --git a/tests/docs/no_namespace/16exists_exists.md b/tests/docs/no_namespace/16exists_exists.md new file mode 100644 index 0000000..fc8dadb --- /dev/null +++ b/tests/docs/no_namespace/16exists_exists.md @@ -0,0 +1,40 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/01-base.yml + +```yaml +--- +version: '1.1' +var: + description: New description + exists: false +``` +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: + description: Description +``` +# Variables + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | Description. | + + +# Example with mandatory variables not filled in + +```yaml +--- +var: example +``` +# Example with all variables modifiable + +```yaml +--- +var: example +``` diff --git a/tests/docs/no_namespace/17_5redefine_leadership.adoc b/tests/docs/no_namespace/17_5redefine_leadership.adoc new file mode 100644 index 0000000..3e7fb3c --- /dev/null +++ b/tests/docs/no_namespace/17_5redefine_leadership.adoc @@ -0,0 +1,19 @@ +== 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: [] # a leader + follower: # a follower +---- diff --git a/tests/docs/no_namespace/17_5redefine_leadership.md b/tests/docs/no_namespace/17_5redefine_leadership.md new file mode 100644 index 0000000..6890c87 --- /dev/null +++ b/tests/docs/no_namespace/17_5redefine_leadership.md @@ -0,0 +1,23 @@ +--- +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: [] # a leader + follower: # a follower +``` diff --git a/tests/docs/no_namespace/20_0empty_family.adoc b/tests/docs/no_namespace/20_0empty_family.adoc new file mode 100644 index 0000000..2bf432c --- /dev/null +++ b/tests/docs/no_namespace/20_0empty_family.adoc @@ -0,0 +1,8 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.0' +my_family: + type: family +---- diff --git a/tests/docs/no_namespace/20_0empty_family.md b/tests/docs/no_namespace/20_0empty_family.md new file mode 100644 index 0000000..d61994c --- /dev/null +++ b/tests/docs/no_namespace/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/no_namespace/20_0family_append.adoc b/tests/docs/no_namespace/20_0family_append.adoc new file mode 100644 index 0000000..3c6ff44 --- /dev/null +++ b/tests/docs/no_namespace/20_0family_append.adoc @@ -0,0 +1,55 @@ +== dictionaries/rougail/01-base.yml + +[,yaml] +---- +version: '1.1' +family: + var2: + description: The second variable +---- +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +family: + description: A family + var1: + description: The first variable +---- +== Variables + +=== A family + +`basic` + +[cols="105a,105a",options="header"] +|==== +| Variable | Description +| +**family.var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +The first variable. +| +**family.var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +The second variable. +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +family: + var1: example + var2: example +---- +== Example with all variables modifiable + +[,yaml] +---- +family: + var1: example + var2: example +---- diff --git a/tests/docs/no_namespace/20_0family_append.md b/tests/docs/no_namespace/20_0family_append.md new file mode 100644 index 0000000..d42dd82 --- /dev/null +++ b/tests/docs/no_namespace/20_0family_append.md @@ -0,0 +1,51 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/01-base.yml + +```yaml +--- +version: '1.1' +family: + var2: + description: The second variable +``` +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +family: + description: A family + var1: + description: The first variable +``` +# Variables + +## A family + +`basic` + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **family.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The first variable. | +| **family.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The second variable. | + + +# Example with mandatory variables not filled in + +```yaml +--- +family: + var1: example + var2: example +``` +# Example with all variables modifiable + +```yaml +--- +family: + var1: example + var2: example +``` diff --git a/tests/docs/no_namespace/20_0family_underscore.adoc b/tests/docs/no_namespace/20_0family_underscore.adoc new file mode 100644 index 0000000..d7798d8 --- /dev/null +++ b/tests/docs/no_namespace/20_0family_underscore.adoc @@ -0,0 +1,37 @@ +== 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: basic + _hidden: true + _disabled: true + type: + description: a type family + type: family + my_variable: + description: + description: This is a other great family + my_variable: + help: + description: a help family + help: This is a other great family + my_variable: + mode: + description: a mode family + mode: advanced + my_variable: + mandatory: false + hidden: + description: an hidden family + hidden: true + my_variable: + disabled: + description: an disabled family + disabled: true + my_variable: +---- diff --git a/tests/docs/no_namespace/20_0family_underscore.md b/tests/docs/no_namespace/20_0family_underscore.md new file mode 100644 index 0000000..c580bd7 --- /dev/null +++ b/tests/docs/no_namespace/20_0family_underscore.md @@ -0,0 +1,41 @@ +--- +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: basic + _hidden: true + _disabled: true + type: + description: a type family + type: family + my_variable: + description: + description: This is a other great family + my_variable: + help: + description: a help family + help: This is a other great family + my_variable: + mode: + description: a mode family + mode: advanced + my_variable: + mandatory: false + hidden: + description: an hidden family + hidden: true + my_variable: + disabled: + description: an disabled family + disabled: true + my_variable: +``` diff --git a/tests/docs/no_namespace/20_0multi_family.adoc b/tests/docs/no_namespace/20_0multi_family.adoc new file mode 100644 index 0000000..9018569 --- /dev/null +++ b/tests/docs/no_namespace/20_0multi_family.adoc @@ -0,0 +1,39 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +family: # a family + subfamily: # a sub family + variable: + description: a variable + mandatory: false +---- +== Variables + +=== a family + +`standard` + +==== a sub family + +`standard` + +[cols="96a,96a",options="header"] +|==== +| Variable | Description +| +**family.subfamily.variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | +A variable. +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +family: + subfamily: + variable: example +---- diff --git a/tests/docs/no_namespace/20_0multi_family.md b/tests/docs/no_namespace/20_0multi_family.md new file mode 100644 index 0000000..d1a0489 --- /dev/null +++ b/tests/docs/no_namespace/20_0multi_family.md @@ -0,0 +1,38 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +family: # a family + subfamily: # a sub family + variable: + description: a variable + mandatory: false +``` +# Variables + +## a family + +`standard` + +### a sub family + +`standard` + +| Variable                                                                                       | Description                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **family.subfamily.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A variable. | + + +# Example with all variables modifiable + +```yaml +--- +family: + subfamily: + variable: example +``` diff --git a/tests/docs/no_namespace/20_0multi_family_basic.adoc b/tests/docs/no_namespace/20_0multi_family_basic.adoc new file mode 100644 index 0000000..094c6f1 --- /dev/null +++ b/tests/docs/no_namespace/20_0multi_family_basic.adoc @@ -0,0 +1,45 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +family: # a family + subfamily: # a sub family + variable: # a variable +---- +== Variables + +=== a family + +`basic` + +==== a sub family + +`basic` + +[cols="105a,105a",options="header"] +|==== +| Variable | Description +| +**family.subfamily.variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A variable. +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +family: + subfamily: + variable: example +---- +== Example with all variables modifiable + +[,yaml] +---- +family: + subfamily: + variable: example +---- diff --git a/tests/docs/no_namespace/20_0multi_family_basic.md b/tests/docs/no_namespace/20_0multi_family_basic.md new file mode 100644 index 0000000..c9221c3 --- /dev/null +++ b/tests/docs/no_namespace/20_0multi_family_basic.md @@ -0,0 +1,44 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +family: # a family + subfamily: # a sub family + variable: # a variable +``` +# Variables + +## a family + +`basic` + +### a sub family + +`basic` + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **family.subfamily.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | + + +# Example with mandatory variables not filled in + +```yaml +--- +family: + subfamily: + variable: example +``` +# Example with all variables modifiable + +```yaml +--- +family: + subfamily: + variable: example +``` diff --git a/tests/docs/no_namespace/20_0multi_family_expert.adoc b/tests/docs/no_namespace/20_0multi_family_expert.adoc new file mode 100644 index 0000000..b5495aa --- /dev/null +++ b/tests/docs/no_namespace/20_0multi_family_expert.adoc @@ -0,0 +1,13 @@ +== 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/no_namespace/20_0multi_family_expert.md b/tests/docs/no_namespace/20_0multi_family_expert.md new file mode 100644 index 0000000..1340984 --- /dev/null +++ b/tests/docs/no_namespace/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/no_namespace/20_0multi_family_order.adoc b/tests/docs/no_namespace/20_0multi_family_order.adoc new file mode 100644 index 0000000..34273bd --- /dev/null +++ b/tests/docs/no_namespace/20_0multi_family_order.adoc @@ -0,0 +1,81 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +variable: # a variable +family: # a family + variable1: # a first variable + subfamily: # a sub family + variable: # a variable + variable2: # a second variable +---- +== Variables + +[cols="105a,105a",options="header"] +|==== +| Variable | Description +| +**variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A variable. +|==== + +=== a family + +`basic` + +[cols="105a,105a",options="header"] +|==== +| Variable | Description +| +**family.variable1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A first variable. +|==== + +==== a sub family + +`basic` + +[cols="105a,105a",options="header"] +|==== +| Variable | Description +| +**family.subfamily.variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A variable. +|==== + +[cols="105a,105a",options="header"] +|==== +| Variable | Description +| +**family.variable2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A second variable. +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +variable: example +family: + variable1: example + subfamily: + variable: example + variable2: example +---- +== Example with all variables modifiable + +[,yaml] +---- +variable: example +family: + variable1: example + subfamily: + variable: example + variable2: example +---- diff --git a/tests/docs/no_namespace/20_0multi_family_order.md b/tests/docs/no_namespace/20_0multi_family_order.md new file mode 100644 index 0000000..bbe7ae7 --- /dev/null +++ b/tests/docs/no_namespace/20_0multi_family_order.md @@ -0,0 +1,65 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +variable: # a variable +family: # a family + variable1: # a first variable + subfamily: # a sub family + variable: # a variable + variable2: # a second variable +``` +# Variables + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | + +## a family + +`basic` + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **family.variable1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A first variable. | + +### a sub family + +`basic` + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **family.subfamily.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **family.variable2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A second variable. | + + +# Example with mandatory variables not filled in + +```yaml +--- +variable: example +family: + variable1: example + subfamily: + variable: example + variable2: example +``` +# Example with all variables modifiable + +```yaml +--- +variable: example +family: + variable1: example + subfamily: + variable: example + variable2: example +``` diff --git a/tests/docs/no_namespace/20_0validators_differ_redefine.adoc b/tests/docs/no_namespace/20_0validators_differ_redefine.adoc new file mode 100644 index 0000000..a40633a --- /dev/null +++ b/tests/docs/no_namespace/20_0validators_differ_redefine.adoc @@ -0,0 +1,65 @@ +== dictionaries/rougail/01-base.yml + +[,yaml] +---- +version: '1.1' +var3: + redefine: true + validators: + - type: jinja + 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 + validators: + - type: jinja + jinja: | + {% if _.var3 == _.var1 %} + var3 must be different than var1 + {% endif %} + description: var3 must be different than var1 +---- +== Variables + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A first variable. + +**Default**: no +| +**var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A second variable. + +**Default**: no +| +**var3** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A third variable. + +**Validator**: var3 must be different than var2. + +**Default**: yes +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +var1: no +var2: no +var3: yes +---- diff --git a/tests/docs/no_namespace/20_0validators_differ_redefine.md b/tests/docs/no_namespace/20_0validators_differ_redefine.md new file mode 100644 index 0000000..1850700 --- /dev/null +++ b/tests/docs/no_namespace/20_0validators_differ_redefine.md @@ -0,0 +1,54 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/01-base.yml + +```yaml +--- +version: '1.1' +var3: + redefine: true + validators: + - type: jinja + 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 + validators: + - type: jinja + jinja: | + {% if _.var3 == _.var1 %} + var3 must be different than var1 + {% endif %} + description: var3 must be different than var1 +``` +# Variables + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A first variable.
**Default**: no | +| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | 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 with all variables modifiable + +```yaml +--- +var1: no +var2: no +var3: yes +``` diff --git a/tests/docs/no_namespace/20_1empty_subfamily.adoc b/tests/docs/no_namespace/20_1empty_subfamily.adoc new file mode 100644 index 0000000..a830ac2 --- /dev/null +++ b/tests/docs/no_namespace/20_1empty_subfamily.adoc @@ -0,0 +1,9 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.0' +my_family: + my_sub_family: + type: family +---- diff --git a/tests/docs/no_namespace/20_1empty_subfamily.md b/tests/docs/no_namespace/20_1empty_subfamily.md new file mode 100644 index 0000000..f876681 --- /dev/null +++ b/tests/docs/no_namespace/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/no_namespace/20_9default_information_parent.adoc b/tests/docs/no_namespace/20_9default_information_parent.adoc new file mode 100644 index 0000000..50ef944 --- /dev/null +++ b/tests/docs/no_namespace/20_9default_information_parent.adoc @@ -0,0 +1,51 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: 1.1 +family: + var1: # a first variable + var2: + description: a second variable + default: + type: information + information: test_information + variable: __.family +---- +== Variables + +=== family + +`basic` + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**family.var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A first variable. +| +**family.var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A second variable. + +**Default**: value of the information. +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +family: + var1: example + var2: example +---- +== Example with all variables modifiable + +[,yaml] +---- +family: + var1: example + var2: example +---- diff --git a/tests/docs/no_namespace/20_9default_information_parent.md b/tests/docs/no_namespace/20_9default_information_parent.md new file mode 100644 index 0000000..4ec941c --- /dev/null +++ b/tests/docs/no_namespace/20_9default_information_parent.md @@ -0,0 +1,46 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: 1.1 +family: + var1: # a first variable + var2: + description: a second variable + default: + type: information + information: test_information + variable: __.family +``` +# Variables + +## family + +`basic` + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **family.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A first variable. | +| **family.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second variable.
**Default**: value of the information. | + + +# Example with mandatory variables not filled in + +```yaml +--- +family: + var1: example + var2: example +``` +# Example with all variables modifiable + +```yaml +--- +family: + var1: example + var2: example +``` diff --git a/tests/docs/no_namespace/24_0family_hidden_condition_sub_family.adoc b/tests/docs/no_namespace/24_0family_hidden_condition_sub_family.adoc new file mode 100644 index 0000000..b981128 --- /dev/null +++ b/tests/docs/no_namespace/24_0family_hidden_condition_sub_family.adoc @@ -0,0 +1,67 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +condition: no # the variable use has condition +family: + description: possibly hidden family + hidden: + type: jinja + jinja: | + {% if _.condition == "yes" %} + condition is yes + {% endif %} + description: if condition is yes + subfamily: + var1: # a variable +---- +== Variables + +[cols="105a,105a",options="header"] +|==== +| Variable | Description +| +**condition** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +The variable use has condition. + +**Default**: no +|==== + +=== possibly hidden family + +`basic` _`hidden`_ + +**Hidden**: if condition is yes. + +==== family.subfamily + +`basic` + +[cols="105a,105a",options="header"] +|==== +| Variable | Description +| +**family.subfamily.var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A variable. +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +family: + subfamily: + var1: example +---- +== Example with all variables modifiable + +[,yaml] +---- +condition: no +family: + subfamily: + var1: example +---- diff --git a/tests/docs/no_namespace/24_0family_hidden_condition_sub_family.md b/tests/docs/no_namespace/24_0family_hidden_condition_sub_family.md new file mode 100644 index 0000000..8f33b85 --- /dev/null +++ b/tests/docs/no_namespace/24_0family_hidden_condition_sub_family.md @@ -0,0 +1,60 @@ +--- +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: + type: jinja + jinja: | + {% if _.condition == "yes" %} + condition is yes + {% endif %} + description: if condition is yes + subfamily: + var1: # a variable +``` +# Variables + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The variable use has condition.
**Default**: no | + +## possibly hidden family + +`basic` _`hidden`_ + +**Hidden**: if condition is yes. + +### family.subfamily + +`basic` + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **family.subfamily.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | + + +# Example with mandatory variables not filled in + +```yaml +--- +family: + subfamily: + var1: example +``` +# Example with all variables modifiable + +```yaml +--- +condition: no +family: + subfamily: + var1: example +``` diff --git a/tests/docs/no_namespace/24_0family_hidden_condition_variable_sub_family.adoc b/tests/docs/no_namespace/24_0family_hidden_condition_variable_sub_family.adoc new file mode 100644 index 0000000..2f8ef18 --- /dev/null +++ b/tests/docs/no_namespace/24_0family_hidden_condition_variable_sub_family.adoc @@ -0,0 +1,63 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +condition: true # the variable use has condition +family: + description: possibly hidden family + hidden: + type: variable + variable: _.condition + subfamily: # a subfamily + var1: # a variable +---- +== Variables + +[cols="105a,105a",options="header"] +|==== +| Variable | Description +| +**condition** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | +The variable use has condition. + +**Default**: True +|==== + +=== possibly hidden family + +`basic` _`hidden`_ + +**Hidden**: when the variable "condition" has the value "True". + +==== a subfamily + +`basic` + +[cols="105a,105a",options="header"] +|==== +| Variable | Description +| +**family.subfamily.var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A variable. +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +family: + subfamily: + var1: example +---- +== Example with all variables modifiable + +[,yaml] +---- +condition: true +family: + subfamily: + var1: example +---- diff --git a/tests/docs/no_namespace/24_0family_hidden_condition_variable_sub_family.md b/tests/docs/no_namespace/24_0family_hidden_condition_variable_sub_family.md new file mode 100644 index 0000000..378ea08 --- /dev/null +++ b/tests/docs/no_namespace/24_0family_hidden_condition_variable_sub_family.md @@ -0,0 +1,56 @@ +--- +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: + type: variable + variable: _.condition + subfamily: # a subfamily + var1: # a variable +``` +# Variables + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **condition**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The variable use has condition.
**Default**: True | + +## possibly hidden family + +`basic` _`hidden`_ + +**Hidden**: when the variable "condition" has the value "True". + +### a subfamily + +`basic` + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **family.subfamily.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | + + +# Example with mandatory variables not filled in + +```yaml +--- +family: + subfamily: + var1: example +``` +# Example with all variables modifiable + +```yaml +--- +condition: true +family: + subfamily: + var1: example +``` diff --git a/tests/docs/no_namespace/24_0family_hidden_param_condition_sub_family.adoc b/tests/docs/no_namespace/24_0family_hidden_param_condition_sub_family.adoc new file mode 100644 index 0000000..660b9bf --- /dev/null +++ b/tests/docs/no_namespace/24_0family_hidden_param_condition_sub_family.adoc @@ -0,0 +1,71 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +condition: no # the variable use has condition +family: + description: possibly hidden family + hidden: + type: jinja + jinja: | + {% if condition == "yes" %} + condition is yes + {% endif %} + params: + condition: + type: variable + variable: _.condition + description: if condition is yes + sub_family: # a subfamily + var1: # a variable +---- +== Variables + +[cols="105a,105a",options="header"] +|==== +| Variable | Description +| +**condition** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +The variable use has condition. + +**Default**: no +|==== + +=== possibly hidden family + +`basic` _`hidden`_ + +**Hidden**: if condition is yes. + +==== a subfamily + +`basic` + +[cols="105a,105a",options="header"] +|==== +| Variable | Description +| +**family.sub_family.var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A variable. +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +family: + sub_family: + var1: example +---- +== Example with all variables modifiable + +[,yaml] +---- +condition: no +family: + sub_family: + var1: example +---- diff --git a/tests/docs/no_namespace/24_0family_hidden_param_condition_sub_family.md b/tests/docs/no_namespace/24_0family_hidden_param_condition_sub_family.md new file mode 100644 index 0000000..f44239c --- /dev/null +++ b/tests/docs/no_namespace/24_0family_hidden_param_condition_sub_family.md @@ -0,0 +1,64 @@ +--- +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: + type: jinja + jinja: | + {% if condition == "yes" %} + condition is yes + {% endif %} + params: + condition: + type: variable + variable: _.condition + description: if condition is yes + sub_family: # a subfamily + var1: # a variable +``` +# Variables + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The variable use has condition.
**Default**: no | + +## possibly hidden family + +`basic` _`hidden`_ + +**Hidden**: if condition is yes. + +### a subfamily + +`basic` + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **family.sub_family.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | + + +# Example with mandatory variables not filled in + +```yaml +--- +family: + sub_family: + var1: example +``` +# Example with all variables modifiable + +```yaml +--- +condition: no +family: + sub_family: + var1: example +``` diff --git a/tests/docs/no_namespace/24_0family_mandatory_condition.adoc b/tests/docs/no_namespace/24_0family_mandatory_condition.adoc new file mode 100644 index 0000000..d138eb9 --- /dev/null +++ b/tests/docs/no_namespace/24_0family_mandatory_condition.adoc @@ -0,0 +1,41 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +condition: no # a condition +var: + description: a variable + mandatory: + type: jinja + jinja: | + {% if _.condition == "yes" %} + condition is yes + {% endif %} + description: only if rougail.condition has the value "yes" +---- +== Variables + +[cols="110a,110a",options="header"] +|==== +| Variable | Description +| +**condition** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A condition. + +**Default**: no +| +**var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` _`mandatory`_ | +A variable. + +**Mandatory**: only if rougail.condition has the value "yes". +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +condition: no +var: example +---- diff --git a/tests/docs/no_namespace/24_0family_mandatory_condition.md b/tests/docs/no_namespace/24_0family_mandatory_condition.md new file mode 100644 index 0000000..27137f1 --- /dev/null +++ b/tests/docs/no_namespace/24_0family_mandatory_condition.md @@ -0,0 +1,35 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +condition: no # a condition +var: + description: a variable + mandatory: + type: jinja + jinja: | + {% if _.condition == "yes" %} + condition is yes + {% endif %} + description: only if rougail.condition has the value "yes" +``` +# Variables + +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.
**Default**: no | +| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` _`mandatory`_ | A variable.
**Mandatory**: only if rougail.condition has the value "yes". | + + +# Example with all variables modifiable + +```yaml +--- +condition: no +var: example +``` diff --git a/tests/docs/no_namespace/24_0family_mandatory_condition_variable.adoc b/tests/docs/no_namespace/24_0family_mandatory_condition_variable.adoc new file mode 100644 index 0000000..fd529c5 --- /dev/null +++ b/tests/docs/no_namespace/24_0family_mandatory_condition_variable.adoc @@ -0,0 +1,37 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +condition: true # a condition +var: + description: a variable + mandatory: + type: variable + variable: _.condition +---- +== Variables + +[cols="110a,110a",options="header"] +|==== +| Variable | Description +| +**condition** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | +A condition. + +**Default**: True +| +**var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` _`mandatory`_ | +A variable. + +**Mandatory**: when the variable "condition" has the value "True". +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +condition: true +var: example +---- diff --git a/tests/docs/no_namespace/24_0family_mandatory_condition_variable.md b/tests/docs/no_namespace/24_0family_mandatory_condition_variable.md new file mode 100644 index 0000000..f096394 --- /dev/null +++ b/tests/docs/no_namespace/24_0family_mandatory_condition_variable.md @@ -0,0 +1,31 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +condition: true # a condition +var: + description: a variable + mandatory: + type: variable + variable: _.condition +``` +# Variables + +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **condition**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.
**Default**: True | +| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` _`mandatory`_ | A variable.
**Mandatory**: when the variable "condition" has the value "True". | + + +# Example with all variables modifiable + +```yaml +--- +condition: true +var: example +``` diff --git a/tests/docs/no_namespace/40_0leadership.adoc b/tests/docs/no_namespace/40_0leadership.adoc new file mode 100644 index 0000000..490737f --- /dev/null +++ b/tests/docs/no_namespace/40_0leadership.adoc @@ -0,0 +1,50 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +leader: + description: a leadership + type: leadership + leader: + description: a leader + multi: true + follower1: # a follower + follower2: # an other follower +---- +== Variables + +=== a leadership + +`basic` + + +This family contains lists of variable blocks. + +[cols="105a,105a",options="header"] +|==== +| Variable | Description +| +**leader.leader** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | +A leader. +| +**leader.follower1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A follower. +| +**leader.follower2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +An other follower. +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +leader: + - leader: example + follower1: example + follower2: example +---- diff --git a/tests/docs/no_namespace/40_0leadership.md b/tests/docs/no_namespace/40_0leadership.md new file mode 100644 index 0000000..455d63f --- /dev/null +++ b/tests/docs/no_namespace/40_0leadership.md @@ -0,0 +1,43 @@ +--- +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 + follower1: # a follower + follower2: # an other follower +``` +# Variables + +## a leadership + +`basic` + + +This family contains lists of variable blocks. + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | A leader. | +| **leader.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A follower. | +| **leader.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | An other follower. | + + +# Example with all variables modifiable + +```yaml +--- +leader: + - leader: example + follower1: example + follower2: example +``` diff --git a/tests/docs/no_namespace/40_0leadership_diff_name.adoc b/tests/docs/no_namespace/40_0leadership_diff_name.adoc new file mode 100644 index 0000000..cc45b83 --- /dev/null +++ b/tests/docs/no_namespace/40_0leadership_diff_name.adoc @@ -0,0 +1,48 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +leadership: + description: a leadership + type: leadership + leader: [] # a leader + follower1: # a follower + follower2: # an other follower +---- +== Variables + +=== a leadership + +`basic` + + +This family contains lists of variable blocks. + +[cols="105a,105a",options="header"] +|==== +| Variable | Description +| +**leadership.leader** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | +A leader. +| +**leadership.follower1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A follower. +| +**leadership.follower2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +An other follower. +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +leadership: + - leader: example + follower1: example + follower2: example +---- diff --git a/tests/docs/no_namespace/40_0leadership_diff_name.md b/tests/docs/no_namespace/40_0leadership_diff_name.md new file mode 100644 index 0000000..3512e7a --- /dev/null +++ b/tests/docs/no_namespace/40_0leadership_diff_name.md @@ -0,0 +1,41 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +leadership: + description: a leadership + type: leadership + leader: [] # a leader + follower1: # a follower + follower2: # an other follower +``` +# Variables + +## a leadership + +`basic` + + +This family contains lists of variable blocks. + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **leadership.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | A leader. | +| **leadership.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A follower. | +| **leadership.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | An other follower. | + + +# Example with all variables modifiable + +```yaml +--- +leadership: + - leader: example + follower1: example + follower2: example +``` diff --git a/tests/docs/no_namespace/40_0leadership_empty.adoc b/tests/docs/no_namespace/40_0leadership_empty.adoc new file mode 100644 index 0000000..eadc65f --- /dev/null +++ b/tests/docs/no_namespace/40_0leadership_empty.adoc @@ -0,0 +1,8 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +empty_leader: + type: leadership +---- diff --git a/tests/docs/no_namespace/40_0leadership_empty.md b/tests/docs/no_namespace/40_0leadership_empty.md new file mode 100644 index 0000000..b7d0b8f --- /dev/null +++ b/tests/docs/no_namespace/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/no_namespace/40_0leadership_follower_default_calculation.adoc b/tests/docs/no_namespace/40_0leadership_follower_default_calculation.adoc new file mode 100644 index 0000000..50c21a2 --- /dev/null +++ b/tests/docs/no_namespace/40_0leadership_follower_default_calculation.adoc @@ -0,0 +1,56 @@ +== 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: + type: jinja + jinja: | + {{ _.follower1 }} + description: returns follower1 value +---- +== Variables + +=== a leadership + +`basic` + + +This family contains lists of variable blocks. + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**leader.leader** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | +A leader. +| +**leader.follower1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A follower. + +**Default**: value +| +**leader.follower2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A second follower. + +**Default**: returns follower1 value. +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +leader: + - leader: example + follower1: value + follower2: value +---- diff --git a/tests/docs/no_namespace/40_0leadership_follower_default_calculation.md b/tests/docs/no_namespace/40_0leadership_follower_default_calculation.md new file mode 100644 index 0000000..31b1a23 --- /dev/null +++ b/tests/docs/no_namespace/40_0leadership_follower_default_calculation.md @@ -0,0 +1,47 @@ +--- +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: + type: jinja + jinja: | + {{ _.follower1 }} + description: returns follower1 value +``` +# Variables + +## a leadership + +`basic` + + +This family contains lists of variable blocks. + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | A leader. | +| **leader.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A follower.
**Default**: value | +| **leader.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second follower.
**Default**: returns follower1 value. | + + +# Example with all variables modifiable + +```yaml +--- +leader: + - leader: example + follower1: value + follower2: value +``` diff --git a/tests/docs/no_namespace/40_0leadership_follower_default_value.adoc b/tests/docs/no_namespace/40_0leadership_follower_default_value.adoc new file mode 100644 index 0000000..7504dba --- /dev/null +++ b/tests/docs/no_namespace/40_0leadership_follower_default_value.adoc @@ -0,0 +1,46 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +leader: + description: a leadership + type: leadership + leader: + description: a leader + multi: true + mandatory: false + follower1: value # a follower with default value +---- +== Variables + +=== a leadership + +`standard` + + +This family contains lists of variable blocks. + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**leader.leader** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `unique` `multiple` | +A leader. +| +**leader.follower1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A follower with default value. + +**Default**: value +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +leader: + - leader: example + follower1: value +---- diff --git a/tests/docs/no_namespace/40_0leadership_follower_default_value.md b/tests/docs/no_namespace/40_0leadership_follower_default_value.md new file mode 100644 index 0000000..90f5810 --- /dev/null +++ b/tests/docs/no_namespace/40_0leadership_follower_default_value.md @@ -0,0 +1,41 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +leader: + description: a leadership + type: leadership + leader: + description: a leader + multi: true + mandatory: false + follower1: value # a follower with default value +``` +# Variables + +## a leadership + +`standard` + + +This family contains lists of variable blocks. + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A leader. | +| **leader.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A follower with default value.
**Default**: value | + + +# Example with all variables modifiable + +```yaml +--- +leader: + - leader: example + follower1: value +``` diff --git a/tests/docs/no_namespace/40_1leadership_append_follower.adoc b/tests/docs/no_namespace/40_1leadership_append_follower.adoc new file mode 100644 index 0000000..f7f81a1 --- /dev/null +++ b/tests/docs/no_namespace/40_1leadership_append_follower.adoc @@ -0,0 +1,66 @@ +== dictionaries/rougail/01-base.yml + +[,yaml] +---- +version: '1.1' +leader: + follower3: + description: the follower3 +---- +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +leader: + description: a leadership + type: leadership + leader: + description: the leader + multi: true + follower1: + description: the follower1 + follower2: + description: the follower2 +---- +== Variables + +=== a leadership + +`basic` + + +This family contains lists of variable blocks. + +[cols="105a,105a",options="header"] +|==== +| Variable | Description +| +**leader.leader** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | +The leader. +| +**leader.follower1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +The follower1. +| +**leader.follower2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +The follower2. +| +**leader.follower3** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +The follower3. +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +leader: + - leader: example + follower1: example + follower2: example + follower3: example +---- diff --git a/tests/docs/no_namespace/40_1leadership_append_follower.md b/tests/docs/no_namespace/40_1leadership_append_follower.md new file mode 100644 index 0000000..26e9c97 --- /dev/null +++ b/tests/docs/no_namespace/40_1leadership_append_follower.md @@ -0,0 +1,56 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/01-base.yml + +```yaml +--- +version: '1.1' +leader: + follower3: + description: the follower3 +``` +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +leader: + description: a leadership + type: leadership + leader: + description: the leader + multi: true + follower1: + description: the follower1 + follower2: + description: the follower2 +``` +# Variables + +## a leadership + +`basic` + + +This family contains lists of variable blocks. + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | The leader. | +| **leader.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The follower1. | +| **leader.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The follower2. | +| **leader.follower3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The follower3. | + + +# Example with all variables modifiable + +```yaml +--- +leader: + - leader: example + follower1: example + follower2: example + follower3: example +``` diff --git a/tests/docs/no_namespace/40_6leadership_follower_multi.adoc b/tests/docs/no_namespace/40_6leadership_follower_multi.adoc new file mode 100644 index 0000000..0b6f19e --- /dev/null +++ b/tests/docs/no_namespace/40_6leadership_follower_multi.adoc @@ -0,0 +1,61 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.0' +leadership: + description: A leadership + type: leadership + leader: + description: The leader + multi: true + follower1: + description: The first follower + multi: true + follower2: + description: The second follower + multi: true + default: + - value +---- +== Variables + +=== A leadership + +`basic` + + +This family contains lists of variable blocks. + +[cols="119a,119a",options="header"] +|==== +| 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 +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +leadership: + - leader: example + follower1: + - example + follower2: + - value +---- diff --git a/tests/docs/no_namespace/40_6leadership_follower_multi.md b/tests/docs/no_namespace/40_6leadership_follower_multi.md new file mode 100644 index 0000000..55b3433 --- /dev/null +++ b/tests/docs/no_namespace/40_6leadership_follower_multi.md @@ -0,0 +1,51 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.0' +leadership: + description: A leadership + type: leadership + leader: + description: The leader + multi: true + follower1: + description: The first follower + multi: true + follower2: + description: The second follower + multi: true + default: + - value +``` +# Variables + +## A leadership + +`basic` + + +This family contains lists of variable blocks. + +| Variable                                                                                                              | Description                                                                                                           | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **leadership.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | The leader. | +| **leadership.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `multiple` | The first follower. | +| **leadership.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `multiple` | The second follower.
**Default**:
- value | + + +# Example with all variables modifiable + +```yaml +--- +leadership: + - leader: example + follower1: + - example + follower2: + - value +``` diff --git a/tests/docs/no_namespace/40_8calculation_boolean.adoc b/tests/docs/no_namespace/40_8calculation_boolean.adoc new file mode 100644 index 0000000..7dff654 --- /dev/null +++ b/tests/docs/no_namespace/40_8calculation_boolean.adoc @@ -0,0 +1,69 @@ +== 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: + type: jinja + jinja: | + {% if _.bool %} + True + False + {% else %} + False + {% endif %} + description: a calculation +multi2: + description: a second multi variable + type: boolean + multi: true + default: + type: jinja + jinja: | + {% if not _.bool %} + True + False + {% else %} + False + {% endif %} + description: a calculation +---- +== Variables + +[cols="129a,129a",options="header"] +|==== +| Variable | Description +| +**bool** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | +A boolean variable. + +**Default**: False +| +**multi1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` `unique` `multiple` | +A first multi variable. + +**Default**: a calculation. +| +**multi2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` `unique` `multiple` | +A second multi variable. + +**Default**: a calculation. +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +bool: false +multi1: + - false +multi2: + - true + - false +---- diff --git a/tests/docs/no_namespace/40_8calculation_boolean.md b/tests/docs/no_namespace/40_8calculation_boolean.md new file mode 100644 index 0000000..d4ce4ae --- /dev/null +++ b/tests/docs/no_namespace/40_8calculation_boolean.md @@ -0,0 +1,59 @@ +--- +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: + type: jinja + jinja: | + {% if _.bool %} + True + False + {% else %} + False + {% endif %} + description: a calculation +multi2: + description: a second multi variable + type: boolean + multi: true + default: + type: jinja + jinja: | + {% if not _.bool %} + True + False + {% else %} + False + {% endif %} + description: a calculation +``` +# Variables + +| Variable                                                                                                                        | Description                                                                                                                     | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **bool**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A boolean variable.
**Default**: False | +| **multi1**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A first multi variable.
**Default**: a calculation. | +| **multi2**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A second multi variable.
**Default**: a calculation. | + + +# Example with all variables modifiable + +```yaml +--- +bool: false +multi1: + - false +multi2: + - true + - false +``` diff --git a/tests/docs/no_namespace/40_8calculation_multi_variable.adoc b/tests/docs/no_namespace/40_8calculation_multi_variable.adoc new file mode 100644 index 0000000..6255773 --- /dev/null +++ b/tests/docs/no_namespace/40_8calculation_multi_variable.adoc @@ -0,0 +1,51 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +var: + description: a first variable + default: + - type: variable + variable: _.var2 + - type: variable + variable: _.var3 +var2: no # a second variable +var3: yes # a third variable +---- +== Variables + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +A first variable. + +**Default**: + +* the value of the variable "var2". +* the value of the variable "var3". +| +**var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A second variable. + +**Default**: no +| +**var3** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A third variable. + +**Default**: yes +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +var: + - no + - yes +var2: no +var3: yes +---- diff --git a/tests/docs/no_namespace/40_8calculation_multi_variable.md b/tests/docs/no_namespace/40_8calculation_multi_variable.md new file mode 100644 index 0000000..66f4fc8 --- /dev/null +++ b/tests/docs/no_namespace/40_8calculation_multi_variable.md @@ -0,0 +1,38 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: + description: a first variable + default: + - type: variable + variable: _.var2 + - type: variable + variable: _.var3 +var2: no # a second variable +var3: yes # a third variable +``` +# Variables + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A first variable.
**Default**:
- the value of the variable "var2".
- the value of the variable "var3". | +| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second variable.
**Default**: no | +| **var3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A third variable.
**Default**: yes | + + +# Example with all variables modifiable + +```yaml +--- +var: + - no + - yes +var2: no +var3: yes +``` diff --git a/tests/docs/no_namespace/40_8calculation_multi_variable_parent.adoc b/tests/docs/no_namespace/40_8calculation_multi_variable_parent.adoc new file mode 100644 index 0000000..1332d37 --- /dev/null +++ b/tests/docs/no_namespace/40_8calculation_multi_variable_parent.adoc @@ -0,0 +1,48 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +var: no # a variable +fam1: # a family + var: + description: a calculated variable + default: + type: variable + variable: __.var +---- +== Variables + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A variable. + +**Default**: no +|==== + +=== a family + +`standard` + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**fam1.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A calculated variable. + +**Default**: the value of the variable "var". +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +var: no +fam1: + var: no +---- diff --git a/tests/docs/no_namespace/40_8calculation_multi_variable_parent.md b/tests/docs/no_namespace/40_8calculation_multi_variable_parent.md new file mode 100644 index 0000000..4899bfd --- /dev/null +++ b/tests/docs/no_namespace/40_8calculation_multi_variable_parent.md @@ -0,0 +1,40 @@ +--- +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: + type: variable + variable: __.var +``` +# Variables + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: no | + +## a family + +`standard` + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **fam1.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A calculated variable.
**Default**: the value of the variable "var". | + + +# Example with all variables modifiable + +```yaml +--- +var: no +fam1: + var: no +``` diff --git a/tests/docs/no_namespace/40_8calculation_multi_variable_parent2.adoc b/tests/docs/no_namespace/40_8calculation_multi_variable_parent2.adoc new file mode 100644 index 0000000..64f54ae --- /dev/null +++ b/tests/docs/no_namespace/40_8calculation_multi_variable_parent2.adoc @@ -0,0 +1,54 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +fam1: # first family + var: no # a variable +fam2: # second family + var: + description: a varaible + default: + type: variable + variable: __.fam1.var +---- +== Variables + +=== first family + +`standard` + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**fam1.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A variable. + +**Default**: no +|==== + +=== second family + +`standard` + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**fam2.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A varaible. + +**Default**: the value of the variable "fam1.var". +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +fam1: + var: no +fam2: + var: no +---- diff --git a/tests/docs/no_namespace/40_8calculation_multi_variable_parent2.md b/tests/docs/no_namespace/40_8calculation_multi_variable_parent2.md new file mode 100644 index 0000000..3b72c52 --- /dev/null +++ b/tests/docs/no_namespace/40_8calculation_multi_variable_parent2.md @@ -0,0 +1,46 @@ +--- +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: + type: variable + variable: __.fam1.var +``` +# Variables + +## first family + +`standard` + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **fam1.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: no | + +## second family + +`standard` + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **fam2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A varaible.
**Default**: the value of the variable "fam1.var". | + + +# Example with all variables modifiable + +```yaml +--- +fam1: + var: no +fam2: + var: no +``` diff --git a/tests/docs/no_namespace/41_0choice_leader.adoc b/tests/docs/no_namespace/41_0choice_leader.adoc new file mode 100644 index 0000000..da5f0af --- /dev/null +++ b/tests/docs/no_namespace/41_0choice_leader.adoc @@ -0,0 +1,56 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.0' +leader: + description: The leadership + type: leadership + leader: + description: The leader + multi: true + mandatory: false + follower1: + type: choice + description: A follower + choices: + - a + - b + - c +---- +== Variables + +=== The leadership + +`basic` + + +This family contains lists of variable blocks. + +[cols="105a,105a",options="header"] +|==== +| Variable | Description +| +**leader.leader** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `unique` `multiple` | +The leader. +| +**leader.follower1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `basic` `mandatory` | +A follower. + +**Choices**: + +* a +* b +* c +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +leader: + - leader: example + follower1: a_choice +---- diff --git a/tests/docs/no_namespace/41_0choice_leader.md b/tests/docs/no_namespace/41_0choice_leader.md new file mode 100644 index 0000000..ef05258 --- /dev/null +++ b/tests/docs/no_namespace/41_0choice_leader.md @@ -0,0 +1,47 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.0' +leader: + description: The leadership + type: leadership + leader: + description: The leader + multi: true + mandatory: false + follower1: + type: choice + description: A follower + choices: + - a + - b + - c +``` +# Variables + +## The leadership + +`basic` + + +This family contains lists of variable blocks. + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | The leader. | +| **leader.follower1**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A follower.
**Choices**:
- a
- b
- c | + + +# Example with all variables modifiable + +```yaml +--- +leader: + - leader: example + follower1: a_choice +``` diff --git a/tests/docs/no_namespace/44_0leadership_hidden.adoc b/tests/docs/no_namespace/44_0leadership_hidden.adoc new file mode 100644 index 0000000..0045864 --- /dev/null +++ b/tests/docs/no_namespace/44_0leadership_hidden.adoc @@ -0,0 +1,12 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +leader: + description: a leadership + hidden: true + type: leadership + leader: [] # a leader + follower: # a follower +---- diff --git a/tests/docs/no_namespace/44_0leadership_hidden.md b/tests/docs/no_namespace/44_0leadership_hidden.md new file mode 100644 index 0000000..32576ab --- /dev/null +++ b/tests/docs/no_namespace/44_0leadership_hidden.md @@ -0,0 +1,16 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +leader: + description: a leadership + hidden: true + type: leadership + leader: [] # a leader + follower: # a follower +``` diff --git a/tests/docs/no_namespace/44_0leadership_leader_hidden.adoc b/tests/docs/no_namespace/44_0leadership_leader_hidden.adoc new file mode 100644 index 0000000..ab771fc --- /dev/null +++ b/tests/docs/no_namespace/44_0leadership_leader_hidden.adoc @@ -0,0 +1,14 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +leader: + description: a leadership + type: leadership + leader: + description: a leader + multi: true + hidden: true + follower: # a follower +---- diff --git a/tests/docs/no_namespace/44_0leadership_leader_hidden.md b/tests/docs/no_namespace/44_0leadership_leader_hidden.md new file mode 100644 index 0000000..252e154 --- /dev/null +++ b/tests/docs/no_namespace/44_0leadership_leader_hidden.md @@ -0,0 +1,18 @@ +--- +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 + follower: # a follower +``` diff --git a/tests/docs/no_namespace/44_1leadership_append_hidden_follower.adoc b/tests/docs/no_namespace/44_1leadership_append_hidden_follower.adoc new file mode 100644 index 0000000..d7d8d3d --- /dev/null +++ b/tests/docs/no_namespace/44_1leadership_append_hidden_follower.adoc @@ -0,0 +1,23 @@ +== dictionaries/rougail/01-base.yml + +[,yaml] +---- +version: '1.1' +leader: + follower3: # follower3 +---- +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +leader: + description: a leadership + type: leadership + leader: + description: a leader + multi: true + hidden: true + follower1: # the follower1 + follower2: # the follower2 +---- diff --git a/tests/docs/no_namespace/44_1leadership_append_hidden_follower.md b/tests/docs/no_namespace/44_1leadership_append_hidden_follower.md new file mode 100644 index 0000000..673d765 --- /dev/null +++ b/tests/docs/no_namespace/44_1leadership_append_hidden_follower.md @@ -0,0 +1,27 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/01-base.yml + +```yaml +--- +version: '1.1' +leader: + follower3: # follower3 +``` +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +leader: + description: a leadership + type: leadership + leader: + description: a leader + multi: true + hidden: true + follower1: # the follower1 + follower2: # the follower2 +``` diff --git a/tests/docs/no_namespace/44_4leadership_mandatory.adoc b/tests/docs/no_namespace/44_4leadership_mandatory.adoc new file mode 100644 index 0000000..3dacc1b --- /dev/null +++ b/tests/docs/no_namespace/44_4leadership_mandatory.adoc @@ -0,0 +1,47 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +leader: + description: a leadership + type: leadership + leader: + description: a leader + multi: true + mandatory: true + follower1: + description: a follower + mandatory: false +---- +== Variables + +=== a leadership + +`basic` + + +This family contains lists of variable blocks. + +[cols="96a,96a",options="header"] +|==== +| Variable | Description +| +**leader.leader** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | +A leader. +| +**leader.follower1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | +A follower. +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +leader: + - leader: example + follower1: example +---- diff --git a/tests/docs/no_namespace/44_4leadership_mandatory.md b/tests/docs/no_namespace/44_4leadership_mandatory.md new file mode 100644 index 0000000..615f398 --- /dev/null +++ b/tests/docs/no_namespace/44_4leadership_mandatory.md @@ -0,0 +1,43 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +leader: + description: a leadership + type: leadership + leader: + description: a leader + multi: true + mandatory: true + follower1: + description: a follower + mandatory: false +``` +# Variables + +## a leadership + +`basic` + + +This family contains lists of variable blocks. + +| Variable                                                                                       | Description                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | A leader. | +| **leader.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A follower. | + + +# Example with all variables modifiable + +```yaml +--- +leader: + - leader: example + follower1: example +``` diff --git a/tests/docs/no_namespace/44_4leadership_mandatory_follower.adoc b/tests/docs/no_namespace/44_4leadership_mandatory_follower.adoc new file mode 100644 index 0000000..5bf124a --- /dev/null +++ b/tests/docs/no_namespace/44_4leadership_mandatory_follower.adoc @@ -0,0 +1,47 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.0' +leader: + description: a leadership + type: leadership + leader: + description: a leader + multi: true + mandatory: false + follower: + description: a follower + mandatory: true +---- +== Variables + +=== a leadership + +`basic` + + +This family contains lists of variable blocks. + +[cols="105a,105a",options="header"] +|==== +| Variable | Description +| +**leader.leader** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `unique` `multiple` | +A leader. +| +**leader.follower** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A follower. +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +leader: + - leader: example + follower: example +---- diff --git a/tests/docs/no_namespace/44_4leadership_mandatory_follower.md b/tests/docs/no_namespace/44_4leadership_mandatory_follower.md new file mode 100644 index 0000000..7963eaa --- /dev/null +++ b/tests/docs/no_namespace/44_4leadership_mandatory_follower.md @@ -0,0 +1,43 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.0' +leader: + description: a leadership + type: leadership + leader: + description: a leader + multi: true + mandatory: false + follower: + description: a follower + mandatory: true +``` +# Variables + +## a leadership + +`basic` + + +This family contains lists of variable blocks. + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A leader. | +| **leader.follower**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A follower. | + + +# Example with all variables modifiable + +```yaml +--- +leader: + - leader: example + follower: example +``` diff --git a/tests/docs/no_namespace/44_5leadership_leader_hidden_calculation.adoc b/tests/docs/no_namespace/44_5leadership_leader_hidden_calculation.adoc new file mode 100644 index 0000000..ec857fb --- /dev/null +++ b/tests/docs/no_namespace/44_5leadership_leader_hidden_calculation.adoc @@ -0,0 +1,65 @@ +== 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: + type: jinja + jinja: | + {% if __.condition == "no" %} + condition is no + {% endif %} + description: if condition is no + follower: # a follower +---- +== Variables + +[cols="105a,105a",options="header"] +|==== +| Variable | Description +| +**condition** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A condition. + +**Default**: no +|==== + +=== a leadership + +`basic` _`hidden`_ + +**Hidden**: if condition is no. + + +This family contains lists of variable blocks. + +[cols="105a,105a",options="header"] +|==== +| Variable | Description +| +**leader.leader** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | +A leader. +| +**leader.follower** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A follower. +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +condition: no +leader: + - leader: example + follower: example +---- diff --git a/tests/docs/no_namespace/44_5leadership_leader_hidden_calculation.md b/tests/docs/no_namespace/44_5leadership_leader_hidden_calculation.md new file mode 100644 index 0000000..90a342c --- /dev/null +++ b/tests/docs/no_namespace/44_5leadership_leader_hidden_calculation.md @@ -0,0 +1,55 @@ +--- +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: + type: jinja + jinja: | + {% if __.condition == "no" %} + condition is no + {% endif %} + description: if condition is no + follower: # a follower +``` +# Variables + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.
**Default**: no | + +## a leadership + +`basic` _`hidden`_ + +**Hidden**: if condition is no. + + +This family contains lists of variable blocks. + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | A leader. | +| **leader.follower**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A follower. | + + +# Example with all variables modifiable + +```yaml +--- +condition: no +leader: + - leader: example + follower: example +``` diff --git a/tests/docs/no_namespace/44_6leadership_follower_disabled_calculation.adoc b/tests/docs/no_namespace/44_6leadership_follower_disabled_calculation.adoc new file mode 100644 index 0000000..b2f0827 --- /dev/null +++ b/tests/docs/no_namespace/44_6leadership_follower_disabled_calculation.adoc @@ -0,0 +1,63 @@ +== 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: + type: jinja + jinja: | + {% if __.condition == "yes" %}true{% else %}false{% endif %} + description: if condition is yes +---- +== Variables + +[cols="118a,118a",options="header"] +|==== +| Variable | Description +| +**condition** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A condition. + +**Default**: yes +|==== + +=== a leadership + +`basic` + + +This family contains lists of variable blocks. + +[cols="118a,118a",options="header"] +|==== +| Variable | Description +| +**leader.leader** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | +A leader. +| +**leader.follower** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` _`disabled`_ | +A follower. + +**Disabled**: if condition is yes. +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +condition: yes +leader: + - leader: example + follower: example +---- diff --git a/tests/docs/no_namespace/44_6leadership_follower_disabled_calculation.md b/tests/docs/no_namespace/44_6leadership_follower_disabled_calculation.md new file mode 100644 index 0000000..48fa046 --- /dev/null +++ b/tests/docs/no_namespace/44_6leadership_follower_disabled_calculation.md @@ -0,0 +1,52 @@ +--- +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: + type: jinja + jinja: | + {% if __.condition == "yes" %}true{% else %}false{% endif %} + description: if condition is yes +``` +# Variables + +| Variable                                                                                                             | Description                                                                                                          | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.
**Default**: yes | + +## a leadership + +`basic` + + +This family contains lists of variable blocks. + +| Variable                                                                                                             | Description                                                                                                          | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | A leader. | +| **leader.follower**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` _`disabled`_ | A follower.
**Disabled**: if condition is yes. | + + +# Example with all variables modifiable + +```yaml +--- +condition: yes +leader: + - leader: example + follower: example +``` diff --git a/tests/docs/no_namespace/60_0family_dynamic.adoc b/tests/docs/no_namespace/60_0family_dynamic.adoc new file mode 100644 index 0000000..281623a --- /dev/null +++ b/tests/docs/no_namespace/60_0family_dynamic.adoc @@ -0,0 +1,71 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +var: # A suffix variable + - val1 + - val2 +dyn{{ suffix }}: + description: A dynamic family + type: dynamic + dynamic: + type: variable + variable: _.var + var: # A dynamic variable +---- +== Variables + +[cols="105a,105a",options="header"] +|==== +| 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. + +**Suffixes**: the value of the variable "var". + +[cols="105a,105a",options="header"] +|==== +| Variable | Description +| +**dynval1.var** ou **dynval2.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A dynamic variable. +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +dynval1: + var: example +dynval2: + var: example +---- +== Example with all variables modifiable + +[,yaml] +---- +var: + - val1 + - val2 +dynval1: + var: example +dynval2: + var: example +---- diff --git a/tests/docs/no_namespace/60_0family_dynamic.md b/tests/docs/no_namespace/60_0family_dynamic.md new file mode 100644 index 0000000..d78a0b0 --- /dev/null +++ b/tests/docs/no_namespace/60_0family_dynamic.md @@ -0,0 +1,61 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: # A suffix variable + - val1 + - val2 +dyn{{ suffix }}: + description: A dynamic family + type: dynamic + dynamic: + type: variable + variable: _.var + var: # A dynamic variable +``` +# Variables + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A suffix variable.
**Default**:
- val1
- val2 | + +## A dynamic family + +`basic` + + +This family builds families dynamically. + +**Suffixes**: the value of the variable "var". + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dynval1.var** ou **dynval2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A dynamic variable. | + + +# Example with mandatory variables not filled in + +```yaml +--- +dynval1: + var: example +dynval2: + var: example +``` +# Example with all variables modifiable + +```yaml +--- +var: + - val1 + - val2 +dynval1: + var: example +dynval2: + var: example +``` diff --git a/tests/docs/no_namespace/60_0family_dynamic_1_1.adoc b/tests/docs/no_namespace/60_0family_dynamic_1_1.adoc new file mode 100644 index 0000000..516a32a --- /dev/null +++ b/tests/docs/no_namespace/60_0family_dynamic_1_1.adoc @@ -0,0 +1,70 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +var: # A suffix variable + - val1 + - val2 +dyn: + type: dynamic + description: A dynamic family + variable: _.var + vardyn: + description: A dynamic variable +---- +== Variables + +[cols="105a,105a",options="header"] +|==== +| 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. + +**Suffixes**: the value of the variable "var". + +[cols="105a,105a",options="header"] +|==== +| Variable | Description +| +**dynval1.vardyn** ou **dynval2.vardyn** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A dynamic variable. +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +dynval1: + vardyn: example +dynval2: + vardyn: example +---- +== Example with all variables modifiable + +[,yaml] +---- +var: + - val1 + - val2 +dynval1: + vardyn: example +dynval2: + vardyn: example +---- diff --git a/tests/docs/no_namespace/60_0family_dynamic_1_1.md b/tests/docs/no_namespace/60_0family_dynamic_1_1.md new file mode 100644 index 0000000..5f42bec --- /dev/null +++ b/tests/docs/no_namespace/60_0family_dynamic_1_1.md @@ -0,0 +1,60 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: # A suffix variable + - val1 + - val2 +dyn: + type: dynamic + description: A dynamic family + variable: _.var + vardyn: + description: A dynamic variable +``` +# Variables + +| 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. + +**Suffixes**: the value of the variable "var". + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dynval1.vardyn** ou **dynval2.vardyn**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A dynamic variable. | + + +# Example with mandatory variables not filled in + +```yaml +--- +dynval1: + vardyn: example +dynval2: + vardyn: example +``` +# Example with all variables modifiable + +```yaml +--- +var: + - val1 + - val2 +dynval1: + vardyn: example +dynval2: + vardyn: example +``` diff --git a/tests/docs/no_namespace/60_0family_dynamic_static.adoc b/tests/docs/no_namespace/60_0family_dynamic_static.adoc new file mode 100644 index 0000000..d2ac21a --- /dev/null +++ b/tests/docs/no_namespace/60_0family_dynamic_static.adoc @@ -0,0 +1,55 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +dyn{{ suffix }}: + description: a dynamic family + type: dynamic + dynamic: + - val1 + - val2 + var: # a variable inside a dynamic family +---- +== Variables + +=== a dynamic family + +`basic` + + +This family builds families dynamically. + +**Suffixes**: + +* val1 +* val2 + +[cols="105a,105a",options="header"] +|==== +| Variable | Description +| +**dynval1.var** ou **dynval2.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A variable inside a dynamic family. +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +dynval1: + var: example +dynval2: + var: example +---- +== Example with all variables modifiable + +[,yaml] +---- +dynval1: + var: example +dynval2: + var: example +---- diff --git a/tests/docs/no_namespace/60_0family_dynamic_static.md b/tests/docs/no_namespace/60_0family_dynamic_static.md new file mode 100644 index 0000000..b5c7f01 --- /dev/null +++ b/tests/docs/no_namespace/60_0family_dynamic_static.md @@ -0,0 +1,51 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +dyn{{ suffix }}: + description: a dynamic family + type: dynamic + dynamic: + - val1 + - val2 + var: # a variable inside a dynamic family +``` +# Variables + +## a dynamic family + +`basic` + + +This family builds families dynamically. + +**Suffixes**:
- val1
- val2 + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dynval1.var** ou **dynval2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable inside a dynamic family. | + + +# Example with mandatory variables not filled in + +```yaml +--- +dynval1: + var: example +dynval2: + var: example +``` +# Example with all variables modifiable + +```yaml +--- +dynval1: + var: example +dynval2: + var: example +``` diff --git a/tests/docs/no_namespace/60_0family_dynamic_variable_empty.adoc b/tests/docs/no_namespace/60_0family_dynamic_variable_empty.adoc new file mode 100644 index 0000000..fcf74cc --- /dev/null +++ b/tests/docs/no_namespace/60_0family_dynamic_variable_empty.adoc @@ -0,0 +1,61 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +var: [] # a suffix variable +dyn{{ suffix }}: + description: a dynamic family + type: dynamic + dynamic: + type: variable + variable: _.var + var: val # a variable inside dynamic family +---- +== Variables + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | +A suffix variable. +|==== + +=== a dynamic family + +`standard` + + +This family builds families dynamically. + +**Suffixes**: the value of the variable "var". + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**dynexample.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A variable inside dynamic family. + +**Default**: val +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +var: + - example +---- +== Example with all variables modifiable + +[,yaml] +---- +var: + - example +dynexample: + var: val +---- diff --git a/tests/docs/no_namespace/60_0family_dynamic_variable_empty.md b/tests/docs/no_namespace/60_0family_dynamic_variable_empty.md new file mode 100644 index 0000000..cb89f7e --- /dev/null +++ b/tests/docs/no_namespace/60_0family_dynamic_variable_empty.md @@ -0,0 +1,54 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: [] # a suffix variable +dyn{{ suffix }}: + description: a dynamic family + type: dynamic + dynamic: + type: variable + variable: _.var + var: val # a variable inside dynamic family +``` +# Variables + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | A suffix variable. | + +## a dynamic family + +`standard` + + +This family builds families dynamically. + +**Suffixes**: 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 | + + +# Example with mandatory variables not filled in + +```yaml +--- +var: + - example +``` +# Example with all variables modifiable + +```yaml +--- +var: + - example +dynexample: + var: val +``` diff --git a/tests/docs/no_namespace/60_0family_dynamic_variable_suffix.adoc b/tests/docs/no_namespace/60_0family_dynamic_variable_suffix.adoc new file mode 100644 index 0000000..7d206e1 --- /dev/null +++ b/tests/docs/no_namespace/60_0family_dynamic_variable_suffix.adoc @@ -0,0 +1,63 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +var: # A suffix variable + - val1 + - val2 +dyn{{ suffix }}: + description: A dynamic family + type: dynamic + dynamic: + type: variable + variable: _.var + var: a value # A dynamic variable with suffix {{ suffix }} +---- +== Variables + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +A suffix variable. + +**Default**: + +* val1 +* val2 +|==== + +=== A dynamic family + +`standard` + + +This family builds families dynamically. + +**Suffixes**: the value of the variable "var". + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**dynval1.var** ou **dynval2.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +"A dynamic variable with suffix _val1_" ou "A dynamic variable with suffix _val2_". + +**Default**: a value +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +var: + - val1 + - val2 +dynval1: + var: a value +dynval2: + var: a value +---- diff --git a/tests/docs/no_namespace/60_0family_dynamic_variable_suffix.md b/tests/docs/no_namespace/60_0family_dynamic_variable_suffix.md new file mode 100644 index 0000000..a9e733c --- /dev/null +++ b/tests/docs/no_namespace/60_0family_dynamic_variable_suffix.md @@ -0,0 +1,52 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: # A suffix variable + - val1 + - val2 +dyn{{ suffix }}: + description: A dynamic family + type: dynamic + dynamic: + type: variable + variable: _.var + var: a value # A dynamic variable with suffix {{ suffix }} +``` +# Variables + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A suffix variable.
**Default**:
- val1
- val2 | + +## A dynamic family + +`standard` + + +This family builds families dynamically. + +**Suffixes**: the value of the variable "var". + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dynval1.var** ou **dynval2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | "A dynamic variable with suffix *val1*" ou "A dynamic variable with suffix *val2*".
**Default**: a value | + + +# Example with all variables modifiable + +```yaml +--- +var: + - val1 + - val2 +dynval1: + var: a value +dynval2: + var: a value +``` diff --git a/tests/docs/no_namespace/60_0family_empty.adoc b/tests/docs/no_namespace/60_0family_empty.adoc new file mode 100644 index 0000000..895216f --- /dev/null +++ b/tests/docs/no_namespace/60_0family_empty.adoc @@ -0,0 +1,8 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.0' +general2: + type: family +---- diff --git a/tests/docs/no_namespace/60_0family_empty.md b/tests/docs/no_namespace/60_0family_empty.md new file mode 100644 index 0000000..252df76 --- /dev/null +++ b/tests/docs/no_namespace/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/no_namespace/60_0family_hidden.adoc b/tests/docs/no_namespace/60_0family_hidden.adoc new file mode 100644 index 0000000..95608e1 --- /dev/null +++ b/tests/docs/no_namespace/60_0family_hidden.adoc @@ -0,0 +1,17 @@ +== 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: # a variable +---- diff --git a/tests/docs/no_namespace/60_0family_hidden.md b/tests/docs/no_namespace/60_0family_hidden.md new file mode 100644 index 0000000..92e412b --- /dev/null +++ b/tests/docs/no_namespace/60_0family_hidden.md @@ -0,0 +1,21 @@ +--- +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: # a variable +``` diff --git a/tests/docs/no_namespace/60_0family_mode.adoc b/tests/docs/no_namespace/60_0family_mode.adoc new file mode 100644 index 0000000..f8e70b8 --- /dev/null +++ b/tests/docs/no_namespace/60_0family_mode.adoc @@ -0,0 +1,35 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +family: # a family + var: + description: A variable + mode: basic + default: non +---- +== Variables + +=== a family + +`basic` + +[cols="105a,105a",options="header"] +|==== +| Variable | Description +| +**family.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A variable. + +**Default**: non +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +family: + var: non +---- diff --git a/tests/docs/no_namespace/60_0family_mode.md b/tests/docs/no_namespace/60_0family_mode.md new file mode 100644 index 0000000..e003606 --- /dev/null +++ b/tests/docs/no_namespace/60_0family_mode.md @@ -0,0 +1,33 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +family: # a family + var: + description: A variable + mode: basic + default: non +``` +# Variables + +## a family + +`basic` + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **family.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable.
**Default**: non | + + +# Example with all variables modifiable + +```yaml +--- +family: + var: non +``` diff --git a/tests/docs/no_namespace/60_1family_dynamic_jinja.adoc b/tests/docs/no_namespace/60_1family_dynamic_jinja.adoc new file mode 100644 index 0000000..94f0850 --- /dev/null +++ b/tests/docs/no_namespace/60_1family_dynamic_jinja.adoc @@ -0,0 +1,67 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +var: # a suffix variable + - val1 + - val2 +dyn{{ suffix }}: + description: A dynamic family + type: dynamic + dynamic: + type: jinja + jinja: | + {% for val in _.var %} + {{ loop.index }} + {% endfor %} + description: index of suffix value + var: val # a dynamic variable +---- +== Variables + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +A suffix variable. + +**Default**: + +* val1 +* val2 +|==== + +=== A dynamic family + +`standard` + + +This family builds families dynamically. + +**Suffixes**: index of suffix value. + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**dyn1.var** ou **dyn2.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A dynamic variable. + +**Default**: val +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +var: + - val1 + - val2 +dyn1: + var: val +dyn2: + var: val +---- diff --git a/tests/docs/no_namespace/60_1family_dynamic_jinja.md b/tests/docs/no_namespace/60_1family_dynamic_jinja.md new file mode 100644 index 0000000..a6f5546 --- /dev/null +++ b/tests/docs/no_namespace/60_1family_dynamic_jinja.md @@ -0,0 +1,56 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: # a suffix variable + - val1 + - val2 +dyn{{ suffix }}: + description: A dynamic family + type: dynamic + dynamic: + type: jinja + jinja: | + {% for val in _.var %} + {{ loop.index }} + {% endfor %} + description: index of suffix value + var: val # a dynamic variable +``` +# Variables + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A suffix variable.
**Default**:
- val1
- val2 | + +## A dynamic family + +`standard` + + +This family builds families dynamically. + +**Suffixes**: index of suffix value. + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dyn1.var** ou **dyn2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A dynamic variable.
**Default**: val | + + +# Example with all variables modifiable + +```yaml +--- +var: + - val1 + - val2 +dyn1: + var: val +dyn2: + var: val +``` diff --git a/tests/docs/no_namespace/60_2family_dynamic_jinja_fill_sub_group.adoc b/tests/docs/no_namespace/60_2family_dynamic_jinja_fill_sub_group.adoc new file mode 100644 index 0000000..1723581 --- /dev/null +++ b/tests/docs/no_namespace/60_2family_dynamic_jinja_fill_sub_group.adoc @@ -0,0 +1,99 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +var1: # a suffix variable + - val1 + - val2 +dyn{{ suffix }}: + description: a dynamic family + type: dynamic + dynamic: + type: variable + variable: _.var1 + family: # a family + var: # with a variable +var2: + description: a second variable + default: + type: jinja + jinja: | + {{ _.dynval1.family.var }} + description: the value of var +---- +== Variables + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +A suffix variable. + +**Default**: + +* val1 +* val2 +|==== + +=== a dynamic family + +`basic` + + +This family builds families dynamically. + +**Suffixes**: the value of the variable "var1". + +==== a family + +`basic` + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**dynval1.family.var** ou **dynval2.family.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +With a variable. +|==== + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A second variable. + +**Default**: the value of var. +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +dynval1: + family: + var: example +dynval2: + family: + var: example +var2: example +---- +== Example with all variables modifiable + +[,yaml] +---- +var1: + - val1 + - val2 +dynval1: + family: + var: example +dynval2: + family: + var: example +var2: example +---- diff --git a/tests/docs/no_namespace/60_2family_dynamic_jinja_fill_sub_group.md b/tests/docs/no_namespace/60_2family_dynamic_jinja_fill_sub_group.md new file mode 100644 index 0000000..a23ca55 --- /dev/null +++ b/tests/docs/no_namespace/60_2family_dynamic_jinja_fill_sub_group.md @@ -0,0 +1,83 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: # a suffix variable + - val1 + - val2 +dyn{{ suffix }}: + description: a dynamic family + type: dynamic + dynamic: + type: variable + variable: _.var1 + family: # a family + var: # with a variable +var2: + description: a second variable + default: + type: jinja + jinja: | + {{ _.dynval1.family.var }} + description: the value of var +``` +# Variables + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A suffix variable.
**Default**:
- val1
- val2 | + +## a dynamic family + +`basic` + + +This family builds families dynamically. + +**Suffixes**: the value of the variable "var1". + +### a family + +`basic` + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dynval1.family.var** ou **dynval2.family.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | With a variable. | + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second variable.
**Default**: the value of var. | + + +# Example with mandatory variables not filled in + +```yaml +--- +dynval1: + family: + var: example +dynval2: + family: + var: example +var2: example +``` +# Example with all variables modifiable + +```yaml +--- +var1: + - val1 + - val2 +dynval1: + family: + var: example +dynval2: + family: + var: example +var2: example +``` diff --git a/tests/docs/no_namespace/60_2family_dynamic_jinja_fill_sub_group_2.adoc b/tests/docs/no_namespace/60_2family_dynamic_jinja_fill_sub_group_2.adoc new file mode 100644 index 0000000..ea0b451 --- /dev/null +++ b/tests/docs/no_namespace/60_2family_dynamic_jinja_fill_sub_group_2.adoc @@ -0,0 +1,92 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +var: # a suffix variable + - val1 + - val2 +dyn{{ suffix }}: + description: a dynamic family + type: dynamic + dynamic: + type: variable + variable: _.var + family: + description: a family inside dynamic family + var: + description: a dynamic variable + default: + type: suffix +var2: + description: a varible outside dynamic family + default: + type: jinja + jinja: | + {{ _.dynval1.family.var }} + description: the value of var +---- +== Variables + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +A suffix variable. + +**Default**: + +* val1 +* val2 +|==== + +=== a dynamic family + +`standard` + + +This family builds families dynamically. + +**Suffixes**: the value of the variable "var". + +==== a family inside dynamic family + +`standard` + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**dynval1.family.var** ou **dynval2.family.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A dynamic variable. + +**Default**: value of the suffix. +|==== + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A varible outside dynamic family. + +**Default**: the value of var. +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +var: + - val1 + - val2 +dynval1: + family: + var: val1 +dynval2: + family: + var: val2 +var2: val1 +---- diff --git a/tests/docs/no_namespace/60_2family_dynamic_jinja_fill_sub_group_2.md b/tests/docs/no_namespace/60_2family_dynamic_jinja_fill_sub_group_2.md new file mode 100644 index 0000000..09d1edc --- /dev/null +++ b/tests/docs/no_namespace/60_2family_dynamic_jinja_fill_sub_group_2.md @@ -0,0 +1,75 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: # a suffix variable + - val1 + - val2 +dyn{{ suffix }}: + description: a dynamic family + type: dynamic + dynamic: + type: variable + variable: _.var + family: + description: a family inside dynamic family + var: + description: a dynamic variable + default: + type: suffix +var2: + description: a varible outside dynamic family + default: + type: jinja + jinja: | + {{ _.dynval1.family.var }} + description: the value of var +``` +# Variables + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A suffix variable.
**Default**:
- val1
- val2 | + +## a dynamic family + +`standard` + + +This family builds families dynamically. + +**Suffixes**: the value of the variable "var". + +### a family inside dynamic family + +`standard` + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dynval1.family.var** ou **dynval2.family.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A dynamic variable.
**Default**: value of the suffix. | + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A varible outside dynamic family.
**Default**: the value of var. | + + +# Example with all variables modifiable + +```yaml +--- +var: + - val1 + - val2 +dynval1: + family: + var: val1 +dynval2: + family: + var: val2 +var2: val1 +``` diff --git a/tests/docs/no_namespace/60_2family_dynamic_outside_calc.adoc b/tests/docs/no_namespace/60_2family_dynamic_outside_calc.adoc new file mode 100644 index 0000000..2318838 --- /dev/null +++ b/tests/docs/no_namespace/60_2family_dynamic_outside_calc.adoc @@ -0,0 +1,81 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +var1: # a suffx variable + - val1 + - val2 +dyn{{ suffix }}: + description: a dynamic family + type: dynamic + dynamic: + type: variable + variable: _.var1 + var: val # a dynamic variable +newvar: + description: a second variable + default: + type: jinja + jinja: | + {{ _.dynval1.var }} + description: the value of var +---- +== Variables + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +A suffx variable. + +**Default**: + +* val1 +* val2 +|==== + +=== a dynamic family + +`standard` + + +This family builds families dynamically. + +**Suffixes**: the value of the variable "var1". + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**dynval1.var** ou **dynval2.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A dynamic variable. + +**Default**: val +|==== + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**newvar** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A second variable. + +**Default**: the value of var. +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +var1: + - val1 + - val2 +dynval1: + var: val +dynval2: + var: val +newvar: val +---- diff --git a/tests/docs/no_namespace/60_2family_dynamic_outside_calc.md b/tests/docs/no_namespace/60_2family_dynamic_outside_calc.md new file mode 100644 index 0000000..f295fe9 --- /dev/null +++ b/tests/docs/no_namespace/60_2family_dynamic_outside_calc.md @@ -0,0 +1,64 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: # a suffx variable + - val1 + - val2 +dyn{{ suffix }}: + description: a dynamic family + type: dynamic + dynamic: + type: variable + variable: _.var1 + var: val # a dynamic variable +newvar: + description: a second variable + default: + type: jinja + jinja: | + {{ _.dynval1.var }} + description: the value of var +``` +# Variables + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A suffx variable.
**Default**:
- val1
- val2 | + +## a dynamic family + +`standard` + + +This family builds families dynamically. + +**Suffixes**: the value of the variable "var1". + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dynval1.var** ou **dynval2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A dynamic variable.
**Default**: val | + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **newvar**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second variable.
**Default**: the value of var. | + + +# Example with all variables modifiable + +```yaml +--- +var1: + - val1 + - val2 +dynval1: + var: val +dynval2: + var: val +newvar: val +``` diff --git a/tests/docs/no_namespace/60_5family_dynamic_calc_suffix2.adoc b/tests/docs/no_namespace/60_5family_dynamic_calc_suffix2.adoc new file mode 100644 index 0000000..8cc509d --- /dev/null +++ b/tests/docs/no_namespace/60_5family_dynamic_calc_suffix2.adoc @@ -0,0 +1,66 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +var: # a suffix variable + - val1 + - val2 +dyn{{ suffix }}: + description: a dynamic family + type: dynamic + dynamic: + type: variable + variable: _.var + var: + description: Suffix has value + default: + type: suffix +---- +== Variables + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +A suffix variable. + +**Default**: + +* val1 +* val2 +|==== + +=== a dynamic family + +`standard` + + +This family builds families dynamically. + +**Suffixes**: the value of the variable "var". + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**dynval1.var** ou **dynval2.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +Suffix has value. + +**Default**: value of the suffix. +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +var: + - val1 + - val2 +dynval1: + var: val1 +dynval2: + var: val2 +---- diff --git a/tests/docs/no_namespace/60_5family_dynamic_calc_suffix2.md b/tests/docs/no_namespace/60_5family_dynamic_calc_suffix2.md new file mode 100644 index 0000000..390638c --- /dev/null +++ b/tests/docs/no_namespace/60_5family_dynamic_calc_suffix2.md @@ -0,0 +1,55 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: # a suffix variable + - val1 + - val2 +dyn{{ suffix }}: + description: a dynamic family + type: dynamic + dynamic: + type: variable + variable: _.var + var: + description: Suffix has value + default: + type: suffix +``` +# Variables + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A suffix variable.
**Default**:
- val1
- val2 | + +## a dynamic family + +`standard` + + +This family builds families dynamically. + +**Suffixes**: the value of the variable "var". + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dynval1.var** ou **dynval2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Suffix has value.
**Default**: value of the suffix. | + + +# Example with all variables modifiable + +```yaml +--- +var: + - val1 + - val2 +dynval1: + var: val1 +dynval2: + var: val2 +``` diff --git a/tests/docs/no_namespace/60_5family_dynamic_calc_suffix_param.adoc b/tests/docs/no_namespace/60_5family_dynamic_calc_suffix_param.adoc new file mode 100644 index 0000000..b76db4e --- /dev/null +++ b/tests/docs/no_namespace/60_5family_dynamic_calc_suffix_param.adoc @@ -0,0 +1,72 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +var: # A suffix variable + - val1 + - val2 +dyn{{ suffix }}: + description: A dynamic family + type: dynamic + dynamic: + type: variable + variable: _.var + var: + description: A dynamic variable + default: + type: jinja + jinja: | + {{ suffix }} + params: + suffix: + type: suffix + description: from suffix +---- +== Variables + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +A suffix variable. + +**Default**: + +* val1 +* val2 +|==== + +=== A dynamic family + +`standard` + + +This family builds families dynamically. + +**Suffixes**: the value of the variable "var". + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**dynval1.var** ou **dynval2.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A dynamic variable. + +**Default**: from suffix. +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +var: + - val1 + - val2 +dynval1: + var: val1 +dynval2: + var: val2 +---- diff --git a/tests/docs/no_namespace/60_5family_dynamic_calc_suffix_param.md b/tests/docs/no_namespace/60_5family_dynamic_calc_suffix_param.md new file mode 100644 index 0000000..a0aa23d --- /dev/null +++ b/tests/docs/no_namespace/60_5family_dynamic_calc_suffix_param.md @@ -0,0 +1,61 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: # A suffix variable + - val1 + - val2 +dyn{{ suffix }}: + description: A dynamic family + type: dynamic + dynamic: + type: variable + variable: _.var + var: + description: A dynamic variable + default: + type: jinja + jinja: | + {{ suffix }} + params: + suffix: + type: suffix + description: from suffix +``` +# Variables + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A suffix variable.
**Default**:
- val1
- val2 | + +## A dynamic family + +`standard` + + +This family builds families dynamically. + +**Suffixes**: the value of the variable "var". + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dynval1.var** ou **dynval2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A dynamic variable.
**Default**: from suffix. | + + +# Example with all variables modifiable + +```yaml +--- +var: + - val1 + - val2 +dynval1: + var: val1 +dynval2: + var: val2 +``` diff --git a/tests/docs/no_namespace/60_5family_dynamic_calc_variable.adoc b/tests/docs/no_namespace/60_5family_dynamic_calc_variable.adoc new file mode 100644 index 0000000..c370d26 --- /dev/null +++ b/tests/docs/no_namespace/60_5family_dynamic_calc_variable.adoc @@ -0,0 +1,91 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +var1: + description: A suffix variable + default: + - val1 + - val2 +dyn{{ suffix }}: + type: dynamic + dynamic: + type: variable + variable: _.var1 + propertyerror: false + var: + description: A dynamic variable +var2: + description: A variable calculated + default: + type: variable + variable: _.dynval1.var +---- +== Variables + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +A suffix variable. + +**Default**: + +* val1 +* val2 +|==== + +=== "dyn_val1_" ou "dyn_val2_" + +`basic` + + +This family builds families dynamically. + +**Suffixes**: the value of the variable "var1". + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**dynval1.var** ou **dynval2.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A dynamic variable. +|==== + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A variable calculated. + +**Default**: the value of the variable "dynval1.var". +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +dynval1: + var: example +dynval2: + var: example +var2: example +---- +== Example with all variables modifiable + +[,yaml] +---- +var1: + - val1 + - val2 +dynval1: + var: example +dynval2: + var: example +var2: example +---- diff --git a/tests/docs/no_namespace/60_5family_dynamic_calc_variable.md b/tests/docs/no_namespace/60_5family_dynamic_calc_variable.md new file mode 100644 index 0000000..44cb821 --- /dev/null +++ b/tests/docs/no_namespace/60_5family_dynamic_calc_variable.md @@ -0,0 +1,75 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: + description: A suffix variable + default: + - val1 + - val2 +dyn{{ suffix }}: + type: dynamic + dynamic: + type: variable + variable: _.var1 + propertyerror: false + var: + description: A dynamic variable +var2: + description: A variable calculated + default: + type: variable + variable: _.dynval1.var +``` +# Variables + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A suffix variable.
**Default**:
- val1
- val2 | + +## "dyn*val1*" ou "dyn*val2*" + +`basic` + + +This family builds families dynamically. + +**Suffixes**: the value of the variable "var1". + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dynval1.var** ou **dynval2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A dynamic variable. | + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable calculated.
**Default**: the value of the variable "dynval1.var". | + + +# Example with mandatory variables not filled in + +```yaml +--- +dynval1: + var: example +dynval2: + var: example +var2: example +``` +# Example with all variables modifiable + +```yaml +--- +var1: + - val1 + - val2 +dynval1: + var: example +dynval2: + var: example +var2: example +``` diff --git a/tests/docs/no_namespace/60_5family_dynamic_hidden_suffix.adoc b/tests/docs/no_namespace/60_5family_dynamic_hidden_suffix.adoc new file mode 100644 index 0000000..09d4db0 --- /dev/null +++ b/tests/docs/no_namespace/60_5family_dynamic_hidden_suffix.adoc @@ -0,0 +1,91 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +dyn{{ suffix }}: + description: a dynamic family + type: dynamic + dynamic: + - val1 + - val2 + hidden: + type: jinja + jinja: | + {% if suffix == 'val2' %} + disabled + {% endif %} + params: + suffix: + type: suffix + description: if suffix == 'val2' + + var: # a variable + family: # a family + var: # a new variable +---- +== Variables + +=== a dynamic family + +`basic` _`hidden`_ + +**Hidden**: if suffix == 'val2'. + + +This family builds families dynamically. + +**Suffixes**: + +* val1 +* val2 + +[cols="105a,105a",options="header"] +|==== +| Variable | Description +| +**dynval1.var** ou **dynval2.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A variable. +|==== + +==== a family + +`basic` + +[cols="105a,105a",options="header"] +|==== +| Variable | Description +| +**dynval1.family.var** ou **dynval2.family.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A new variable. +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +dynval1: + var: example + family: + var: example +dynval2: + var: example + family: + var: example +---- +== Example with all variables modifiable + +[,yaml] +---- +dynval1: + var: example + family: + var: example +dynval2: + var: example + family: + var: example +---- diff --git a/tests/docs/no_namespace/60_5family_dynamic_hidden_suffix.md b/tests/docs/no_namespace/60_5family_dynamic_hidden_suffix.md new file mode 100644 index 0000000..e60fd02 --- /dev/null +++ b/tests/docs/no_namespace/60_5family_dynamic_hidden_suffix.md @@ -0,0 +1,82 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +dyn{{ suffix }}: + description: a dynamic family + type: dynamic + dynamic: + - val1 + - val2 + hidden: + type: jinja + jinja: | + {% if suffix == 'val2' %} + disabled + {% endif %} + params: + suffix: + type: suffix + description: if suffix == 'val2' + + var: # a variable + family: # a family + var: # a new variable +``` +# Variables + +## a dynamic family + +`basic` _`hidden`_ + +**Hidden**: if suffix == 'val2'. + + +This family builds families dynamically. + +**Suffixes**:
- val1
- val2 + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dynval1.var** ou **dynval2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | + +### a family + +`basic` + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dynval1.family.var** ou **dynval2.family.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A new variable. | + + +# Example with mandatory variables not filled in + +```yaml +--- +dynval1: + var: example + family: + var: example +dynval2: + var: example + family: + var: example +``` +# Example with all variables modifiable + +```yaml +--- +dynval1: + var: example + family: + var: example +dynval2: + var: example + family: + var: example +``` diff --git a/tests/docs/no_namespace/60_5family_dynamic_variable_outside_suffix.adoc b/tests/docs/no_namespace/60_5family_dynamic_variable_outside_suffix.adoc new file mode 100644 index 0000000..31cc2ea --- /dev/null +++ b/tests/docs/no_namespace/60_5family_dynamic_variable_outside_suffix.adoc @@ -0,0 +1,82 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +var: # a suffix variable + - val1 + - val2 +dyn_{{ suffix }}: + description: a dynamic family + type: dynamic + dynamic: + type: variable + variable: _.var + var: + description: a variable inside dynamic family + default: + type: suffix +var2: + description: a variable + default: + type: variable + variable: _.dyn_val1.var +---- +== Variables + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +A suffix variable. + +**Default**: + +* val1 +* val2 +|==== + +=== a dynamic family + +`standard` + + +This family builds families dynamically. + +**Suffixes**: the value of the variable "var". + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**dyn_val1.var** ou **dyn_val2.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A variable inside dynamic family. + +**Default**: value of the suffix. +|==== + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A variable. + +**Default**: the value of the variable "dyn_val1.var". +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +var: + - val1 + - val2 +dyn_val1: + var: val1 +dyn_val2: + var: val2 +var2: val1 +---- diff --git a/tests/docs/no_namespace/60_5family_dynamic_variable_outside_suffix.md b/tests/docs/no_namespace/60_5family_dynamic_variable_outside_suffix.md new file mode 100644 index 0000000..7ab812e --- /dev/null +++ b/tests/docs/no_namespace/60_5family_dynamic_variable_outside_suffix.md @@ -0,0 +1,65 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: # a suffix variable + - val1 + - val2 +dyn_{{ suffix }}: + description: a dynamic family + type: dynamic + dynamic: + type: variable + variable: _.var + var: + description: a variable inside dynamic family + default: + type: suffix +var2: + description: a variable + default: + type: variable + variable: _.dyn_val1.var +``` +# Variables + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A suffix variable.
**Default**:
- val1
- val2 | + +## a dynamic family + +`standard` + + +This family builds families dynamically. + +**Suffixes**: the value of the variable "var". + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dyn_val1.var** ou **dyn_val2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable inside dynamic family.
**Default**: value of the suffix. | + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: the value of the variable "dyn_val1.var". | + + +# Example with all variables modifiable + +```yaml +--- +var: + - val1 + - val2 +dyn_val1: + var: val1 +dyn_val2: + var: val2 +var2: val1 +``` diff --git a/tests/docs/no_namespace/60_6family_dynamic_leadership.adoc b/tests/docs/no_namespace/60_6family_dynamic_leadership.adoc new file mode 100644 index 0000000..8eb3dd0 --- /dev/null +++ b/tests/docs/no_namespace/60_6family_dynamic_leadership.adoc @@ -0,0 +1,94 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +var: # a suffix variable + - val1 + - val2 +dyn{{ suffix }}: + description: a dynamic family + type: dynamic + dynamic: + type: variable + variable: _.var + leadership: + description: a leadership + type: leadership + leader: + description: a leader + multi: true + follower1: + description: a follower1 + mandatory: false + follower2: + description: a follower2 + mandatory: false +---- +== Variables + +[cols="96a,96a",options="header"] +|==== +| 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. + +**Suffixes**: the value of the variable "var". + +==== a leadership + +`basic` + + +This family contains lists of variable blocks. + +[cols="96a,96a",options="header"] +|==== +| Variable | Description +| +**dynval1.leadership.leader** ou **dynval2.leadership.leader** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | +A leader. +| +**dynval1.leadership.follower1** ou **dynval2.leadership.follower1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | +A follower1. +| +**dynval1.leadership.follower2** ou **dynval2.leadership.follower2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | +A follower2. +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +var: + - val1 + - val2 +dynval1: + leadership: + - leader: example + follower1: example + follower2: example +dynval2: + leadership: + - leader: example + follower1: example + follower2: example +---- diff --git a/tests/docs/no_namespace/60_6family_dynamic_leadership.md b/tests/docs/no_namespace/60_6family_dynamic_leadership.md new file mode 100644 index 0000000..db85ea1 --- /dev/null +++ b/tests/docs/no_namespace/60_6family_dynamic_leadership.md @@ -0,0 +1,78 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: # a suffix variable + - val1 + - val2 +dyn{{ suffix }}: + description: a dynamic family + type: dynamic + dynamic: + type: variable + variable: _.var + leadership: + description: a leadership + type: leadership + leader: + description: a leader + multi: true + follower1: + description: a follower1 + mandatory: false + follower2: + description: a follower2 + mandatory: false +``` +# Variables + +| 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. + +**Suffixes**: the value of the variable "var". + +### a leadership + +`basic` + + +This family contains lists of variable blocks. + +| Variable                                                                                       | Description                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dynval1.leadership.leader** ou **dynval2.leadership.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | A leader. | +| **dynval1.leadership.follower1** ou **dynval2.leadership.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A follower1. | +| **dynval1.leadership.follower2** ou **dynval2.leadership.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A follower2. | + + +# Example with all variables modifiable + +```yaml +--- +var: + - val1 + - val2 +dynval1: + leadership: + - leader: example + follower1: example + follower2: example +dynval2: + leadership: + - leader: example + follower1: example + follower2: example +``` diff --git a/tests/docs/no_namespace/60_9family_dynamic_calc_both.adoc b/tests/docs/no_namespace/60_9family_dynamic_calc_both.adoc new file mode 100644 index 0000000..0a1e3b5 --- /dev/null +++ b/tests/docs/no_namespace/60_9family_dynamic_calc_both.adoc @@ -0,0 +1,68 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +var: val2 # a suffix variable +dyn{{ suffix }}: + type: dynamic + description: a dynamic family + dynamic: + - val1 + - type: variable + variable: _.var + vardyn: # a dynamic variable +---- +== Variables + +[cols="105a,105a",options="header"] +|==== +| Variable | Description +| +**var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A suffix variable. + +**Default**: val2 +|==== + +=== a dynamic family + +`basic` + + +This family builds families dynamically. + +**Suffixes**: + +* val1 +* the value of the variable "var". + +[cols="105a,105a",options="header"] +|==== +| Variable | Description +| +**dynval1.vardyn** ou **dynval2.vardyn** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A dynamic variable. +|==== + + +== Example with mandatory variables not filled in + +[,yaml] +---- +dynval1: + vardyn: example +dynval2: + vardyn: example +---- +== Example with all variables modifiable + +[,yaml] +---- +var: val2 +dynval1: + vardyn: example +dynval2: + vardyn: example +---- diff --git a/tests/docs/no_namespace/60_9family_dynamic_calc_both.md b/tests/docs/no_namespace/60_9family_dynamic_calc_both.md new file mode 100644 index 0000000..6dc3929 --- /dev/null +++ b/tests/docs/no_namespace/60_9family_dynamic_calc_both.md @@ -0,0 +1,58 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: val2 # a suffix variable +dyn{{ suffix }}: + type: dynamic + description: a dynamic family + dynamic: + - val1 + - type: variable + variable: _.var + vardyn: # a dynamic variable +``` +# Variables + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A suffix variable.
**Default**: val2 | + +## a dynamic family + +`basic` + + +This family builds families dynamically. + +**Suffixes**:
- val1
- the value of the variable "var". + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dynval1.vardyn** ou **dynval2.vardyn**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A dynamic variable. | + + +# Example with mandatory variables not filled in + +```yaml +--- +dynval1: + vardyn: example +dynval2: + vardyn: example +``` +# Example with all variables modifiable + +```yaml +--- +var: val2 +dynval1: + vardyn: example +dynval2: + vardyn: example +``` diff --git a/tests/docs/no_namespace/68_0family_leadership_mode.adoc b/tests/docs/no_namespace/68_0family_leadership_mode.adoc new file mode 100644 index 0000000..7065cab --- /dev/null +++ b/tests/docs/no_namespace/68_0family_leadership_mode.adoc @@ -0,0 +1,55 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.0' +leader: + description: A leadership + type: leadership + leader: + description: A leader + multi: true + mandatory: false + follower1: + description: a follower1 + mandatory: false + follower2: + description: a follower2 + mode: basic +---- +== Variables + +=== A leadership + +`basic` + + +This family contains lists of variable blocks. + +[cols="105a,105a",options="header"] +|==== +| Variable | Description +| +**leader.leader** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `unique` `multiple` | +A leader. +| +**leader.follower1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | +A follower1. +| +**leader.follower2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A follower2. +|==== + + +== Example with all variables modifiable + +[,yaml] +---- +leader: + - leader: example + follower1: example + follower2: example +---- diff --git a/tests/docs/no_namespace/68_0family_leadership_mode.md b/tests/docs/no_namespace/68_0family_leadership_mode.md new file mode 100644 index 0000000..57ff558 --- /dev/null +++ b/tests/docs/no_namespace/68_0family_leadership_mode.md @@ -0,0 +1,48 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.0' +leader: + description: A leadership + type: leadership + leader: + description: A leader + multi: true + mandatory: false + follower1: + description: a follower1 + mandatory: false + follower2: + description: a follower2 + mode: basic +``` +# Variables + +## A leadership + +`basic` + + +This family contains lists of variable blocks. + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `unique` `multiple` | A leader. | +| **leader.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A follower1. | +| **leader.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A follower2. | + + +# Example with all variables modifiable + +```yaml +--- +leader: + - leader: example + follower1: example + follower2: example +``` diff --git a/tests/test_load.py b/tests/test_load.py new file mode 100644 index 0000000..e3ac952 --- /dev/null +++ b/tests/test_load.py @@ -0,0 +1,103 @@ +from pytest import fixture # , raises +from pathlib import Path +from ruamel.yaml import YAML +from rougail import RougailConfig +from rougail.output_doc import RougailOutputDoc + +from .custom import CustomOption + + +dico_dirs = Path('../rougail/tests/dictionaries') +test_ok = set() + +excludes = set([ + '60_5family_dynamic_unknown_suffix', + '60_5family_dynamic_variable_outside_sub_suffix', +]) + +for test in dico_dirs.iterdir(): + if (test / 'tiramisu').is_dir() and test.name not in excludes: + test_ok.add(test) + +test_ok = list(test_ok) +test_ok.sort() + +# test_ok = [dico_dirs / '60_0family_dynamic_variable_suffix'] + + +@fixture(scope="module", params=test_ok) +def test_dir(request): + return request.param + + +def _test_dictionaries(test_dir, output, namespace): + rougailconfig = RougailConfig.copy() + rougailconfig['step.output'] = 'doc' + rougailconfig['doc.output_format'] = output + rougailconfig['functions_files'] = [str(dico_dirs.parent / 'eosfunc' / 'test.py')] +# rougailconfig['tiramisu_cache'] = "cache.py" + dirs = [str(test_dir / 'dictionaries' / 'rougail')] + subfolder = test_dir / 'dictionaries' / 'rougail2' + if subfolder.is_dir(): + dirs.append(str(subfolder)) + rougailconfig['main_dictionaries'] = dirs + if namespace: + rougailconfig['main_namespace'] = 'Rougail' + else: + rougailconfig['main_namespace'] = None + extra_dictionaries = {} + extras = list((test_dir / 'dictionaries').iterdir()) + extras.sort() + for extra in extras: + if extra.name in ['rougail', 'rougail2']: + continue + if extra.is_dir(): + extra_dictionaries[extra.name] = [str(extra)] + if extra_dictionaries: + rougailconfig['extra_dictionaries'] = extra_dictionaries + rougailconfig['custom_types']['custom'] = CustomOption + inventory = RougailOutputDoc(rougailconfig=rougailconfig) + doc = inventory.formater.header() + yaml = YAML() + len_subdir = len(str(dico_dirs)) + 1 + if extra_dictionaries: + all_dirs = [[rougailconfig['main_dictionaries']], rougailconfig['extra_dictionaries'].values()] + else: + all_dirs = [[rougailconfig['main_dictionaries']]] + for r in all_dirs: + for dirs in r: + for d in dirs: + for f in Path(d).iterdir(): + if f.name.endswith('.yml') or f.name.endswith('.yaml'): + doc += inventory.formater.title(str(f)[len_subdir:].split('/', 1)[-1], 1) + 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' + else: + name = 'no_namespace' + doc_file = Path('tests') / 'docs' / name / (test_dir.name + {'github': '.md', 'asciidoc': '.adoc'}.get(output)) + with doc_file.open('w') as docfh: + docfh.write(doc) + + +def test_dictionaries_github(test_dir): + _test_dictionaries(test_dir, 'github', True) + + +def test_dictionaries_asciidoc(test_dir): + _test_dictionaries(test_dir, 'asciidoc', True) + + +def test_dictionaries_github_no_namespace(test_dir): + if (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(): + return + _test_dictionaries(test_dir, 'asciidoc', False)