first commit
This commit is contained in:
parent
988987a9f3
commit
db53c752dc
606 changed files with 30531 additions and 0 deletions
580
src/rougail/output_doc/__init__.py
Normal file
580
src/rougail/output_doc/__init__.py
Normal file
|
@ -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
|
204
src/rougail/output_doc/annotator.py
Normal file
204
src/rougail/output_doc/annotator.py
Normal file
|
@ -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,
|
||||||
|
)
|
36
src/rougail/output_doc/cli.py
Normal file
36
src/rougail/output_doc/cli.py
Normal file
|
@ -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',)
|
96
src/rougail/output_doc/config.py
Normal file
96
src/rougail/output_doc/config.py
Normal file
|
@ -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')
|
25
src/rougail/output_doc/output/__init__.py
Normal file
25
src/rougail/output_doc/output/__init__.py
Normal file
|
@ -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
|
108
src/rougail/output_doc/output/asciidoc.py
Normal file
108
src/rougail/output_doc/output/asciidoc.py
Normal file
|
@ -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
|
98
src/rougail/output_doc/output/github.py
Normal file
98
src/rougail/output_doc/output/github.py
Normal file
|
@ -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 = "<br/>- "
|
||||||
|
char = "<br/>- "
|
||||||
|
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 "<br/>".join(lst)
|
||||||
|
|
||||||
|
def to_string(self,
|
||||||
|
text: str,
|
||||||
|
) -> str:
|
||||||
|
return text.strip().replace('\n', '<br/>')
|
||||||
|
|
||||||
|
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
|
0
tests/__init__.py
Normal file
0
tests/__init__.py
Normal file
7
tests/custom.py
Normal file
7
tests/custom.py
Normal file
|
@ -0,0 +1,7 @@
|
||||||
|
from os import environ
|
||||||
|
environ['TIRAMISU_LOCALE'] = 'en'
|
||||||
|
from tiramisu import StrOption
|
||||||
|
|
||||||
|
|
||||||
|
class CustomOption(StrOption):
|
||||||
|
pass
|
0
tests/docs/base/00_0empty.adoc
Normal file
0
tests/docs/base/00_0empty.adoc
Normal file
4
tests/docs/base/00_0empty.md
Normal file
4
tests/docs/base/00_0empty.md
Normal file
|
@ -0,0 +1,4 @@
|
||||||
|
---
|
||||||
|
gitea: none
|
||||||
|
include_toc: true
|
||||||
|
---
|
33
tests/docs/base/00_0version_underscore.adoc
Normal file
33
tests/docs/base/00_0version_underscore.adoc
Normal file
|
@ -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
|
||||||
|
----
|
32
tests/docs/base/00_0version_underscore.md
Normal file
32
tests/docs/base/00_0version_underscore.md
Normal file
|
@ -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**<br/>[`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
|
||||||
|
```
|
33
tests/docs/base/00_1empty_variable.adoc
Normal file
33
tests/docs/base/00_1empty_variable.adoc
Normal file
|
@ -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
|
||||||
|
----
|
32
tests/docs/base/00_1empty_variable.md
Normal file
32
tests/docs/base/00_1empty_variable.md
Normal file
|
@ -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**<br/>[`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
|
||||||
|
```
|
42
tests/docs/base/00_2default_calculated.adoc
Normal file
42
tests/docs/base/00_2default_calculated.adoc
Normal file
|
@ -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
|
||||||
|
----
|
36
tests/docs/base/00_2default_calculated.md
Normal file
36
tests/docs/base/00_2default_calculated.md
Normal file
|
@ -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**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A first variable.<br/>**Default**: no |
|
||||||
|
| **rougail.var2**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A second variable.<br/>**Default**: the value of var1. |
|
||||||
|
|
||||||
|
|
||||||
|
# Example with all variables modifiable
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
---
|
||||||
|
rougail:
|
||||||
|
var1: no
|
||||||
|
var2:
|
||||||
|
- no
|
||||||
|
```
|
56
tests/docs/base/00_2default_calculated_multi.adoc
Normal file
56
tests/docs/base/00_2default_calculated_multi.adoc
Normal file
|
@ -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
|
||||||
|
----
|
46
tests/docs/base/00_2default_calculated_multi.md
Normal file
46
tests/docs/base/00_2default_calculated_multi.md
Normal file
|
@ -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**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A first variable.<br/>**Default**: <br/>- no<br/>- yes<br/>- maybe |
|
||||||
|
| **rougail.var2**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A second variable.<br/>**Default**: the value of _.var1. |
|
||||||
|
|
||||||
|
|
||||||
|
# Example with all variables modifiable
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
---
|
||||||
|
rougail:
|
||||||
|
var1:
|
||||||
|
- no
|
||||||
|
- yes
|
||||||
|
- maybe
|
||||||
|
var2:
|
||||||
|
- no
|
||||||
|
- yes
|
||||||
|
- maybe
|
||||||
|
```
|
48
tests/docs/base/00_4load_subfolder.adoc
Normal file
48
tests/docs/base/00_4load_subfolder.adoc
Normal file
|
@ -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
|
||||||
|
----
|
44
tests/docs/base/00_4load_subfolder.md
Normal file
44
tests/docs/base/00_4load_subfolder.md
Normal file
|
@ -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**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. |
|
||||||
|
| **rougail.var2**<br/>[`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
|
||||||
|
```
|
29
tests/docs/base/00_5load_notype.adoc
Normal file
29
tests/docs/base/00_5load_notype.adoc
Normal file
|
@ -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
|
||||||
|
----
|
27
tests/docs/base/00_5load_notype.md
Normal file
27
tests/docs/base/00_5load_notype.md
Normal file
|
@ -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**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.<br/>**Default**: non |
|
||||||
|
|
||||||
|
|
||||||
|
# Example with all variables modifiable
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
---
|
||||||
|
rougail:
|
||||||
|
without_type: non
|
||||||
|
```
|
72
tests/docs/base/00_6boolean.adoc
Normal file
72
tests/docs/base/00_6boolean.adoc
Normal file
|
@ -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
|
||||||
|
----
|
50
tests/docs/base/00_6boolean.md
Normal file
50
tests/docs/base/00_6boolean.md
Normal file
|
@ -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**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The first variable.<br/>**Default**: True |
|
||||||
|
| **rougail.var2**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The second variable.<br/>**Default**: True |
|
||||||
|
| **rougail.var3**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The third variable.<br/>**Default**: True |
|
||||||
|
| **rougail.var4**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The forth variable.<br/>**Default**: False |
|
||||||
|
| **rougail.var5**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The fifth variable.<br/>**Default**: False |
|
||||||
|
| **rougail.var6**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The sixth variable.<br/>**Default**: False |
|
||||||
|
|
||||||
|
|
||||||
|
# Example with all variables modifiable
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
---
|
||||||
|
rougail:
|
||||||
|
var1: true
|
||||||
|
var2: true
|
||||||
|
var3: true
|
||||||
|
var4: false
|
||||||
|
var5: false
|
||||||
|
var6: false
|
||||||
|
```
|
30
tests/docs/base/00_6boolean_no_mandatory.adoc
Normal file
30
tests/docs/base/00_6boolean_no_mandatory.adoc
Normal file
|
@ -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
|
||||||
|
----
|
28
tests/docs/base/00_6boolean_no_mandatory.md
Normal file
28
tests/docs/base/00_6boolean_no_mandatory.md
Normal file
|
@ -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**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A variable.<br/>**Default**: True |
|
||||||
|
|
||||||
|
|
||||||
|
# Example with all variables modifiable
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
---
|
||||||
|
rougail:
|
||||||
|
variable: true
|
||||||
|
```
|
129
tests/docs/base/00_6choice.adoc
Normal file
129
tests/docs/base/00_6choice.adoc
Normal file
|
@ -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
|
||||||
|
----
|
82
tests/docs/base/00_6choice.md
Normal file
82
tests/docs/base/00_6choice.md
Normal file
|
@ -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**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The first variable.<br/>**Choices**: <br/>- a<br/>- b<br/>- c |
|
||||||
|
| **rougail.var2**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The second variable.<br/>**Choices**: <br/>- a<br/>- b<br/>- c |
|
||||||
|
| **rougail.var3**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | The third variable.<br/>**Choices**: <br/>- a<br/>- b<br/>- c<br/>- null |
|
||||||
|
| **rougail.var4**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | The forth variable.<br/>**Choices**: <br/>- null<br/>- b<br/>- c |
|
||||||
|
| **rougail.var5**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The fifth variable.<br/>**Choices**: <br/>- a ← (default)<br/>- b<br/>- c |
|
||||||
|
| **rougail.var6**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The sixth variable.<br/>**Choices**: <br/>- 1 ← (default)<br/>- 2<br/>- 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
|
||||||
|
```
|
38
tests/docs/base/00_6choice_calculation.adoc
Normal file
38
tests/docs/base/00_6choice_calculation.adoc
Normal file
|
@ -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
|
||||||
|
----
|
35
tests/docs/base/00_6choice_calculation.md
Normal file
35
tests/docs/base/00_6choice_calculation.md
Normal file
|
@ -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**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.<br/>**Choices**: choices is 0 to 9.<br/>**Default**: 9 |
|
||||||
|
|
||||||
|
|
||||||
|
# Example with all variables modifiable
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
---
|
||||||
|
rougail:
|
||||||
|
var: 9
|
||||||
|
```
|
50
tests/docs/base/00_6choice_variable.adoc
Normal file
50
tests/docs/base/00_6choice_variable.adoc
Normal file
|
@ -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
|
||||||
|
----
|
39
tests/docs/base/00_6choice_variable.md
Normal file
39
tests/docs/base/00_6choice_variable.md
Normal file
|
@ -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**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A second variable.<br/>**Default**: <br/>- a<br/>- b<br/>- c |
|
||||||
|
| **rougail.var2**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A first variable.<br/>**Choices**: the value of the variable "rougail.var1".<br/>**Default**: a |
|
||||||
|
|
||||||
|
|
||||||
|
# Example with all variables modifiable
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
---
|
||||||
|
rougail:
|
||||||
|
var1:
|
||||||
|
- a
|
||||||
|
- b
|
||||||
|
- c
|
||||||
|
var2: a
|
||||||
|
```
|
45
tests/docs/base/00_6custom.adoc
Normal file
45
tests/docs/base/00_6custom.adoc
Normal file
|
@ -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
|
||||||
|
----
|
40
tests/docs/base/00_6custom.md
Normal file
40
tests/docs/base/00_6custom.md
Normal file
|
@ -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**<br/>[`custom`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The first variable. |
|
||||||
|
| **rougail.custom2**<br/>[`custom`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The seconf variable.<br/>**Default**: value |
|
||||||
|
|
||||||
|
|
||||||
|
# Example with mandatory variables not filled in
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
---
|
||||||
|
rougail:
|
||||||
|
custom1: xxx
|
||||||
|
```
|
||||||
|
# Example with all variables modifiable
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
---
|
||||||
|
rougail:
|
||||||
|
custom1: xxx
|
||||||
|
custom2: value
|
||||||
|
```
|
30
tests/docs/base/00_6domainname.adoc
Normal file
30
tests/docs/base/00_6domainname.adoc
Normal file
|
@ -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
|
||||||
|
----
|
28
tests/docs/base/00_6domainname.md
Normal file
28
tests/docs/base/00_6domainname.md
Normal file
|
@ -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**<br/>[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A domain name variable.<br/>**Default**: my.domain.name |
|
||||||
|
|
||||||
|
|
||||||
|
# Example with all variables modifiable
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
---
|
||||||
|
rougail:
|
||||||
|
variable: my.domain.name
|
||||||
|
```
|
33
tests/docs/base/00_6domainname_params.adoc
Normal file
33
tests/docs/base/00_6domainname_params.adoc
Normal file
|
@ -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
|
||||||
|
----
|
30
tests/docs/base/00_6domainname_params.md
Normal file
30
tests/docs/base/00_6domainname_params.md
Normal file
|
@ -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**<br/>[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A domain name variable.<br/>**Validator**: the domain name can be an IP<br/>**Default**: my.domain.name |
|
||||||
|
|
||||||
|
|
||||||
|
# Example with all variables modifiable
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
---
|
||||||
|
rougail:
|
||||||
|
variable: my.domain.name
|
||||||
|
```
|
72
tests/docs/base/00_6float.adoc
Normal file
72
tests/docs/base/00_6float.adoc
Normal file
|
@ -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
|
||||||
|
----
|
50
tests/docs/base/00_6float.md
Normal file
50
tests/docs/base/00_6float.md
Normal file
|
@ -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**<br/>[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The first variable.<br/>**Default**: 0.0 |
|
||||||
|
| **rougail.var2**<br/>[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The second variable.<br/>**Default**: 0.0 |
|
||||||
|
| **rougail.var3**<br/>[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The third variable.<br/>**Default**: 0.0 |
|
||||||
|
| **rougail.var4**<br/>[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The forth variable.<br/>**Default**: 10.1 |
|
||||||
|
| **rougail.var5**<br/>[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The fifth variable.<br/>**Default**: 10.1 |
|
||||||
|
| **rougail.var6**<br/>[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The sixth variable.<br/>**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
|
||||||
|
```
|
72
tests/docs/base/00_6number.adoc
Normal file
72
tests/docs/base/00_6number.adoc
Normal file
|
@ -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
|
||||||
|
----
|
50
tests/docs/base/00_6number.md
Normal file
50
tests/docs/base/00_6number.md
Normal file
|
@ -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**<br/>[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The first variable.<br/>**Default**: 0 |
|
||||||
|
| **rougail.var2**<br/>[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The second variable.<br/>**Default**: 0 |
|
||||||
|
| **rougail.var3**<br/>[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The third variable.<br/>**Default**: 0 |
|
||||||
|
| **rougail.var4**<br/>[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | This forth variable.<br/>**Default**: 10 |
|
||||||
|
| **rougail.var5**<br/>[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The fifth variable.<br/>**Default**: 10 |
|
||||||
|
| **rougail.var6**<br/>[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The sixth variable.<br/>**Default**: 10 |
|
||||||
|
|
||||||
|
|
||||||
|
# Example with all variables modifiable
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
---
|
||||||
|
rougail:
|
||||||
|
var1: 0
|
||||||
|
var2: 0
|
||||||
|
var3: 0
|
||||||
|
var4: 10
|
||||||
|
var5: 10
|
||||||
|
var6: 10
|
||||||
|
```
|
77
tests/docs/base/00_6string.adoc
Normal file
77
tests/docs/base/00_6string.adoc
Normal file
|
@ -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
|
||||||
|
----
|
58
tests/docs/base/00_6string.md
Normal file
58
tests/docs/base/00_6string.md
Normal file
|
@ -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**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The first variable. |
|
||||||
|
| **rougail.var2**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The second variable. |
|
||||||
|
| **rougail.var3**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The third variable. |
|
||||||
|
| **rougail.var4**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The forth variable.<br/>**Default**: value |
|
||||||
|
| **rougail.var5**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The fifth variable.<br/>**Default**: value |
|
||||||
|
| **rougail.var6**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The sixth variable.<br/>**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
|
||||||
|
```
|
38
tests/docs/base/00_7choice_quote.adoc
Normal file
38
tests/docs/base/00_7choice_quote.adoc
Normal file
|
@ -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'
|
||||||
|
----
|
32
tests/docs/base/00_7choice_quote.md
Normal file
32
tests/docs/base/00_7choice_quote.md
Normal file
|
@ -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**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A choice.<br/>**Choices**: <br/>- quote' ← (default)<br/>- quote"<br/>- quote"' |
|
||||||
|
|
||||||
|
|
||||||
|
# Example with all variables modifiable
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
---
|
||||||
|
rougail:
|
||||||
|
var: quote'
|
||||||
|
```
|
46
tests/docs/base/00_7help_quote.adoc
Normal file
46
tests/docs/base/00_7help_quote.adoc
Normal file
|
@ -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
|
||||||
|
----
|
40
tests/docs/base/00_7help_quote.md
Normal file
40
tests/docs/base/00_7help_quote.md
Normal file
|
@ -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**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The first variable.<br/>Message with '. |
|
||||||
|
| **rougail.var2**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The second variable.<br/>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
|
||||||
|
```
|
29
tests/docs/base/00_7value_doublequote.adoc
Normal file
29
tests/docs/base/00_7value_doublequote.adoc
Normal file
|
@ -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"
|
||||||
|
----
|
27
tests/docs/base/00_7value_doublequote.md
Normal file
27
tests/docs/base/00_7value_doublequote.md
Normal file
|
@ -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**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.<br/>**Default**: quote" |
|
||||||
|
|
||||||
|
|
||||||
|
# Example with all variables modifiable
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
---
|
||||||
|
rougail:
|
||||||
|
variable: quote"
|
||||||
|
```
|
29
tests/docs/base/00_7value_doublequote2.adoc
Normal file
29
tests/docs/base/00_7value_doublequote2.adoc
Normal file
|
@ -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'"
|
||||||
|
----
|
27
tests/docs/base/00_7value_doublequote2.md
Normal file
27
tests/docs/base/00_7value_doublequote2.md
Normal file
|
@ -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**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.<br/>**Default**: quote'" |
|
||||||
|
|
||||||
|
|
||||||
|
# Example with all variables modifiable
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
---
|
||||||
|
rougail:
|
||||||
|
variable: quote'"
|
||||||
|
```
|
10
tests/docs/base/00_7value_doublequote3.adoc
Normal file
10
tests/docs/base/00_7value_doublequote3.adoc
Normal file
|
@ -0,0 +1,10 @@
|
||||||
|
== dictionaries/rougail/00-base.yml
|
||||||
|
|
||||||
|
[,yaml]
|
||||||
|
----
|
||||||
|
version: '1.0'
|
||||||
|
variable:
|
||||||
|
description: a variable
|
||||||
|
hidden: true
|
||||||
|
default: quote\"\'
|
||||||
|
----
|
14
tests/docs/base/00_7value_doublequote3.md
Normal file
14
tests/docs/base/00_7value_doublequote3.md
Normal file
|
@ -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\"\'
|
||||||
|
```
|
29
tests/docs/base/00_7value_quote.adoc
Normal file
29
tests/docs/base/00_7value_quote.adoc
Normal file
|
@ -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'
|
||||||
|
----
|
27
tests/docs/base/00_7value_quote.md
Normal file
27
tests/docs/base/00_7value_quote.md
Normal file
|
@ -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**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.<br/>**Default**: quote' |
|
||||||
|
|
||||||
|
|
||||||
|
# Example with all variables modifiable
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
---
|
||||||
|
rougail:
|
||||||
|
variable: quote'
|
||||||
|
```
|
44
tests/docs/base/00_8calculation_information.adoc
Normal file
44
tests/docs/base/00_8calculation_information.adoc
Normal file
|
@ -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
|
||||||
|
----
|
42
tests/docs/base/00_8calculation_information.md
Normal file
42
tests/docs/base/00_8calculation_information.md
Normal file
|
@ -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**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.<br/>**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
|
||||||
|
```
|
85
tests/docs/base/00_8test.adoc
Normal file
85
tests/docs/base/00_8test.adoc
Normal file
|
@ -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
|
||||||
|
----
|
66
tests/docs/base/00_8test.md
Normal file
66
tests/docs/base/00_8test.md
Normal file
|
@ -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**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The first variable.<br/>**Example**: test |
|
||||||
|
| **rougail.var2**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The second variable.<br/>**Default**: value<br/>**Example**: test |
|
||||||
|
| **rougail.var3**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The third variable.<br/>**Example**: test1 |
|
||||||
|
| **rougail.var4**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The forth variable.<br/>**Example**: None |
|
||||||
|
| **rougail.var5**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The fifth variable.<br/>**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
|
||||||
|
```
|
63
tests/docs/base/00_9choice_variable_multi.adoc
Normal file
63
tests/docs/base/00_9choice_variable_multi.adoc
Normal file
|
@ -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
|
||||||
|
----
|
51
tests/docs/base/00_9choice_variable_multi.md
Normal file
51
tests/docs/base/00_9choice_variable_multi.md
Normal file
|
@ -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**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | A first variable.<br/>**Choices**: <br/>- val1<br/>- val2 |
|
||||||
|
| **rougail.variable2**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A second variable.<br/>**Choices**: <br/>- val1<br/>- 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
|
||||||
|
```
|
54
tests/docs/base/00_9choice_variables.adoc
Normal file
54
tests/docs/base/00_9choice_variables.adoc
Normal file
|
@ -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
|
||||||
|
----
|
39
tests/docs/base/00_9choice_variables.md
Normal file
39
tests/docs/base/00_9choice_variables.md
Normal file
|
@ -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**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The first source variable.<br/>**Default**: val1 |
|
||||||
|
| **rougail.source_variable_2**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The second source variable.<br/>**Default**: val2 |
|
||||||
|
| **rougail.my_variable**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.<br/>**Choices**: <br/>- the value of the variable "rougail.source_variable_1".<br/>- the value of the variable "rougail.source_variable_2".<br/>**Default**: val1 |
|
||||||
|
|
||||||
|
|
||||||
|
# Example with all variables modifiable
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
---
|
||||||
|
rougail:
|
||||||
|
source_variable_1: val1
|
||||||
|
source_variable_2: val2
|
||||||
|
my_variable: val1
|
||||||
|
```
|
38
tests/docs/base/00_9default_calculation.adoc
Normal file
38
tests/docs/base/00_9default_calculation.adoc
Normal file
|
@ -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
|
||||||
|
----
|
36
tests/docs/base/00_9default_calculation.md
Normal file
36
tests/docs/base/00_9default_calculation.md
Normal file
|
@ -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**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.<br/>**Default**: concat all parameters. |
|
||||||
|
|
||||||
|
|
||||||
|
# Example with all variables modifiable
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
---
|
||||||
|
rougail:
|
||||||
|
variable: string_1_True_None
|
||||||
|
```
|
44
tests/docs/base/00_9default_calculation_information.adoc
Normal file
44
tests/docs/base/00_9default_calculation_information.adoc
Normal file
|
@ -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
|
||||||
|
----
|
42
tests/docs/base/00_9default_calculation_information.md
Normal file
42
tests/docs/base/00_9default_calculation_information.md
Normal file
|
@ -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**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.<br/>**Default**: returns the information. |
|
||||||
|
|
||||||
|
|
||||||
|
# Example with mandatory variables not filled in
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
---
|
||||||
|
rougail:
|
||||||
|
var: example
|
||||||
|
```
|
||||||
|
# Example with all variables modifiable
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
---
|
||||||
|
rougail:
|
||||||
|
var: example
|
||||||
|
```
|
|
@ -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
|
||||||
|
----
|
|
@ -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**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A first variable. |
|
||||||
|
| **rougail.var2**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second variable.<br/>**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
|
||||||
|
```
|
54
tests/docs/base/00_9default_calculation_param_optional.adoc
Normal file
54
tests/docs/base/00_9default_calculation_param_optional.adoc
Normal file
|
@ -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
|
||||||
|
----
|
48
tests/docs/base/00_9default_calculation_param_optional.md
Normal file
48
tests/docs/base/00_9default_calculation_param_optional.md
Normal file
|
@ -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**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A first variable.<br/>**Default**: returns a value. |
|
||||||
|
| **rougail.var2**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second variable.<br/>**Default**: no |
|
||||||
|
|
||||||
|
|
||||||
|
# Example with all variables modifiable
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
---
|
||||||
|
rougail:
|
||||||
|
var1: no
|
||||||
|
var2: no
|
||||||
|
```
|
46
tests/docs/base/00_9default_information_other_variable.adoc
Normal file
46
tests/docs/base/00_9default_information_other_variable.adoc
Normal file
|
@ -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
|
||||||
|
----
|
41
tests/docs/base/00_9default_information_other_variable.md
Normal file
41
tests/docs/base/00_9default_information_other_variable.md
Normal file
|
@ -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**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A first variable. |
|
||||||
|
| **rougail.var2**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second variable.<br/>**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
|
||||||
|
```
|
39
tests/docs/base/00_9default_integer.adoc
Normal file
39
tests/docs/base/00_9default_integer.adoc
Normal file
|
@ -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
|
||||||
|
----
|
36
tests/docs/base/00_9default_integer.md
Normal file
36
tests/docs/base/00_9default_integer.md
Normal file
|
@ -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**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.<br/>**Choices**: choice for 0 to 9.<br/>**Default**: 9 |
|
||||||
|
|
||||||
|
|
||||||
|
# Example with all variables modifiable
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
---
|
||||||
|
rougail:
|
||||||
|
var: 9
|
||||||
|
```
|
54
tests/docs/base/00_9extra.adoc
Normal file
54
tests/docs/base/00_9extra.adoc
Normal file
|
@ -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
|
||||||
|
----
|
46
tests/docs/base/00_9extra.md
Normal file
46
tests/docs/base/00_9extra.md
Normal file
|
@ -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**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.<br/>**Default**: rougail |
|
||||||
|
|
||||||
|
|
||||||
|
# Variables for "extra"
|
||||||
|
|
||||||
|
| Variable | Description |
|
||||||
|
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
|
| **extra.variable**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.<br/>**Default**: return no. |
|
||||||
|
|
||||||
|
|
||||||
|
# Example with all variables modifiable
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
---
|
||||||
|
rougail:
|
||||||
|
variable: rougail
|
||||||
|
extra:
|
||||||
|
variable: no
|
||||||
|
```
|
83
tests/docs/base/00_9extra_calculation.adoc
Normal file
83
tests/docs/base/00_9extra_calculation.adoc
Normal file
|
@ -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
|
||||||
|
----
|
67
tests/docs/base/00_9extra_calculation.md
Normal file
67
tests/docs/base/00_9extra_calculation.md
Normal file
|
@ -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**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.<br/>**Default**: value |
|
||||||
|
|
||||||
|
|
||||||
|
# Variables for "extra"
|
||||||
|
|
||||||
|
| Variable | Description |
|
||||||
|
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
|
| **extra.variable1**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A first variable.<br/>**Default**: the value of the variable "rougail.variable". |
|
||||||
|
| **extra.variable2**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second variable.<br/>**Default**: copy the value of rougail.variable. |
|
||||||
|
| **extra.variable3**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A third variable.<br/>**Default**: copy the value of rougail.variable. |
|
||||||
|
|
||||||
|
|
||||||
|
# Example with all variables modifiable
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
---
|
||||||
|
rougail:
|
||||||
|
variable: value
|
||||||
|
extra:
|
||||||
|
variable1: value
|
||||||
|
variable2: value
|
||||||
|
variable3: value
|
||||||
|
```
|
126
tests/docs/base/01_6boolean_multi.adoc
Normal file
126
tests/docs/base/01_6boolean_multi.adoc
Normal file
|
@ -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
|
||||||
|
----
|
80
tests/docs/base/01_6boolean_multi.md
Normal file
80
tests/docs/base/01_6boolean_multi.md
Normal file
|
@ -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**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The first variable.<br/>**Default**: <br/>- true |
|
||||||
|
| **rougail.var2**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The second variable.<br/>**Default**: <br/>- true |
|
||||||
|
| **rougail.var3**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The third variable.<br/>**Default**: <br/>- true |
|
||||||
|
| **rougail.var4**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The forth variable.<br/>**Default**: <br/>- false |
|
||||||
|
| **rougail.var5**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The fifth variable.<br/>**Default**: <br/>- false |
|
||||||
|
| **rougail.var6**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The sixth variable.<br/>**Default**: <br/>- false |
|
||||||
|
| **rougail.var7**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The seventh variable.<br/>**Default**: <br/>- true |
|
||||||
|
| **rougail.var8**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The eighth variable.<br/>**Default**: <br/>- true |
|
||||||
|
|
||||||
|
|
||||||
|
# Example with all variables modifiable
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
---
|
||||||
|
rougail:
|
||||||
|
var1:
|
||||||
|
- true
|
||||||
|
var2:
|
||||||
|
- true
|
||||||
|
var3:
|
||||||
|
- true
|
||||||
|
var4:
|
||||||
|
- false
|
||||||
|
var5:
|
||||||
|
- false
|
||||||
|
var6:
|
||||||
|
- false
|
||||||
|
var7:
|
||||||
|
- true
|
||||||
|
var8:
|
||||||
|
- true
|
||||||
|
```
|
52
tests/docs/base/01_6custom_multi.adoc
Normal file
52
tests/docs/base/01_6custom_multi.adoc
Normal file
|
@ -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
|
||||||
|
----
|
45
tests/docs/base/01_6custom_multi.md
Normal file
45
tests/docs/base/01_6custom_multi.md
Normal file
|
@ -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**<br/>[`custom`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | A first custom variable. |
|
||||||
|
| **rougail.custom2**<br/>[`custom`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A second custom variable.<br/>**Default**: <br/>- value |
|
||||||
|
|
||||||
|
|
||||||
|
# Example with mandatory variables not filled in
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
---
|
||||||
|
rougail:
|
||||||
|
custom1:
|
||||||
|
- xxx
|
||||||
|
```
|
||||||
|
# Example with all variables modifiable
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
---
|
||||||
|
rougail:
|
||||||
|
custom1:
|
||||||
|
- xxx
|
||||||
|
custom2:
|
||||||
|
- value
|
||||||
|
```
|
126
tests/docs/base/01_6float_multi.adoc
Normal file
126
tests/docs/base/01_6float_multi.adoc
Normal file
|
@ -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
|
||||||
|
----
|
80
tests/docs/base/01_6float_multi.md
Normal file
80
tests/docs/base/01_6float_multi.md
Normal file
|
@ -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**<br/>[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The first variable.<br/>**Default**: <br/>- 0.0 |
|
||||||
|
| **rougail.var2**<br/>[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The second variable.<br/>**Default**: <br/>- 0.0 |
|
||||||
|
| **rougail.var3**<br/>[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The third variable.<br/>**Default**: <br/>- 0.0 |
|
||||||
|
| **rougail.var4**<br/>[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The forth variable.<br/>**Default**: <br/>- 10.1 |
|
||||||
|
| **rougail.var5**<br/>[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The fifth variable.<br/>**Default**: <br/>- 10.1 |
|
||||||
|
| **rougail.var6**<br/>[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The sixth variable.<br/>**Default**: <br/>- 10.1 |
|
||||||
|
| **rougail.var7**<br/>[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The seventh variable.<br/>**Default**: <br/>- 0.0 |
|
||||||
|
| **rougail.var8**<br/>[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The eighth variable.<br/>**Default**: <br/>- 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
|
||||||
|
```
|
126
tests/docs/base/01_6number_multi.adoc
Normal file
126
tests/docs/base/01_6number_multi.adoc
Normal file
|
@ -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
|
||||||
|
----
|
80
tests/docs/base/01_6number_multi.md
Normal file
80
tests/docs/base/01_6number_multi.md
Normal file
|
@ -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**<br/>[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The first variable.<br/>**Default**: <br/>- 0 |
|
||||||
|
| **rougail.var2**<br/>[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The second variable.<br/>**Default**: <br/>- 0 |
|
||||||
|
| **rougail.var3**<br/>[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The third variable.<br/>**Default**: <br/>- 0 |
|
||||||
|
| **rougail.var4**<br/>[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The forth variable.<br/>**Default**: <br/>- 10 |
|
||||||
|
| **rougail.var5**<br/>[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The fifth variable.<br/>**Default**: <br/>- 10 |
|
||||||
|
| **rougail.var6**<br/>[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The sixth variable.<br/>**Default**: <br/>- 10 |
|
||||||
|
| **rougail.var7**<br/>[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The seventh variable.<br/>**Default**: <br/>- 0 |
|
||||||
|
| **rougail.var8**<br/>[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The eighth variable.<br/>**Default**: <br/>- 0 |
|
||||||
|
|
||||||
|
|
||||||
|
# Example with all variables modifiable
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
---
|
||||||
|
rougail:
|
||||||
|
var1:
|
||||||
|
- 0
|
||||||
|
var2:
|
||||||
|
- 0
|
||||||
|
var3:
|
||||||
|
- 0
|
||||||
|
var4:
|
||||||
|
- 10
|
||||||
|
var5:
|
||||||
|
- 10
|
||||||
|
var6:
|
||||||
|
- 10
|
||||||
|
var7:
|
||||||
|
- 0
|
||||||
|
var8:
|
||||||
|
- 0
|
||||||
|
```
|
123
tests/docs/base/01_6string_multi.adoc
Normal file
123
tests/docs/base/01_6string_multi.adoc
Normal file
|
@ -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
|
||||||
|
----
|
86
tests/docs/base/01_6string_multi.md
Normal file
86
tests/docs/base/01_6string_multi.md
Normal file
|
@ -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**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | The first variable. |
|
||||||
|
| **rougail.var2**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | The second variable. |
|
||||||
|
| **rougail.var3**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The third variable. |
|
||||||
|
| **rougail.var4**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The forth variable.<br/>**Default**: <br/>- value |
|
||||||
|
| **rougail.var5**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The fifth variable.<br/>**Default**: <br/>- value |
|
||||||
|
| **rougail.var6**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The sixth variable.<br/>**Default**: <br/>- value |
|
||||||
|
| **rougail.var7**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The seventh variable.<br/>**Default**: <br/>- value |
|
||||||
|
| **rougail.var8**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The eighth variable.<br/>**Default**: <br/>- 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
|
||||||
|
```
|
33
tests/docs/base/01_7value_multi_doublequote.adoc
Normal file
33
tests/docs/base/01_7value_multi_doublequote.adoc
Normal file
|
@ -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"
|
||||||
|
----
|
29
tests/docs/base/01_7value_multi_doublequote.md
Normal file
29
tests/docs/base/01_7value_multi_doublequote.md
Normal file
|
@ -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**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A variable.<br/>**Default**: <br/>- quote" |
|
||||||
|
|
||||||
|
|
||||||
|
# Example with all variables modifiable
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
---
|
||||||
|
rougail:
|
||||||
|
variable:
|
||||||
|
- quote"
|
||||||
|
```
|
33
tests/docs/base/01_7value_multi_doublequote2.adoc
Normal file
33
tests/docs/base/01_7value_multi_doublequote2.adoc
Normal file
|
@ -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'"
|
||||||
|
----
|
29
tests/docs/base/01_7value_multi_doublequote2.md
Normal file
29
tests/docs/base/01_7value_multi_doublequote2.md
Normal file
|
@ -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**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A variable.<br/>**Default**: <br/>- quote'" |
|
||||||
|
|
||||||
|
|
||||||
|
# Example with all variables modifiable
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
---
|
||||||
|
rougail:
|
||||||
|
variable:
|
||||||
|
- quote'"
|
||||||
|
```
|
33
tests/docs/base/01_7value_multi_quote.adoc
Normal file
33
tests/docs/base/01_7value_multi_quote.adoc
Normal file
|
@ -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'
|
||||||
|
----
|
29
tests/docs/base/01_7value_multi_quote.md
Normal file
29
tests/docs/base/01_7value_multi_quote.md
Normal file
|
@ -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**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A variable.<br/>**Default**: <br/>- quote' |
|
||||||
|
|
||||||
|
|
||||||
|
# Example with all variables modifiable
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
---
|
||||||
|
rougail:
|
||||||
|
variable:
|
||||||
|
- quote'
|
||||||
|
```
|
39
tests/docs/base/01_8calculation_information_multi.adoc
Normal file
39
tests/docs/base/01_8calculation_information_multi.adoc
Normal file
|
@ -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:
|
||||||
|
- '[]'
|
||||||
|
----
|
37
tests/docs/base/01_8calculation_information_multi.md
Normal file
37
tests/docs/base/01_8calculation_information_multi.md
Normal file
|
@ -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**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A variable.<br/>**Default**: get information test_information. |
|
||||||
|
|
||||||
|
|
||||||
|
# Example with all variables modifiable
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
---
|
||||||
|
rougail:
|
||||||
|
variable:
|
||||||
|
- '[]'
|
||||||
|
```
|
55
tests/docs/base/01_9choice_variable_multi.adoc
Normal file
55
tests/docs/base/01_9choice_variable_multi.adoc
Normal file
|
@ -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
|
||||||
|
----
|
Some files were not shown because too many files have changed in this diff Show more
Loading…
Reference in a new issue