fix: better documentation variable with variable in default attribut
This commit is contained in:
parent
d8e52e26fd
commit
96866e99a4
66 changed files with 1236 additions and 117 deletions
|
|
@ -22,9 +22,10 @@ from itertools import chain
|
|||
from re import compile
|
||||
|
||||
from tiramisu import Calculation, undefined, groups
|
||||
from tiramisu.error import ConfigError, display_list
|
||||
from tiramisu.error import ConfigError, display_list, PropertiesOptionError
|
||||
from rougail.error import display_xmlfiles
|
||||
from rougail.object_model import PROPERTY_ATTRIBUTE
|
||||
from rougail.utils import normalize_family
|
||||
|
||||
from .config import OutPuts
|
||||
from .i18n import _
|
||||
|
|
@ -282,6 +283,7 @@ class RougailOutputDoc(Examples):
|
|||
def _dyn_path_to_italic(self, dico, child, path: str) -> str:
|
||||
display_path = path
|
||||
for identifier in child.identifiers():
|
||||
identifier = normalize_family(str(identifier))
|
||||
display_path = display_path.replace(
|
||||
"{{ identifier }}", self.formater.italic(identifier), 1
|
||||
)
|
||||
|
|
@ -534,7 +536,9 @@ class RougailOutputDoc(Examples):
|
|||
default = None
|
||||
return default
|
||||
if variable.information.get("default_value_makes_sense", True):
|
||||
default = variable.value.get(uncalculated=True)
|
||||
default_ = variable.value.get(uncalculated=True)
|
||||
if not isinstance(default_, Calculation):
|
||||
default = default_
|
||||
if default == []:
|
||||
default = None
|
||||
return default
|
||||
|
|
@ -587,7 +591,6 @@ class RougailOutputDoc(Examples):
|
|||
try:
|
||||
variable.value.get()
|
||||
except AttributeError as err:
|
||||
pass
|
||||
variable = None
|
||||
else:
|
||||
uncalculated = variable.value.get(uncalculated=True)
|
||||
|
|
@ -610,7 +613,7 @@ class RougailOutputDoc(Examples):
|
|||
return None
|
||||
else:
|
||||
try:
|
||||
self.conf.option(path).get()
|
||||
self.conf.forcepermissive.option(path).get()
|
||||
except AttributeError:
|
||||
return None
|
||||
true_msg = _('the value of the variable "{0}"')
|
||||
|
|
@ -647,7 +650,28 @@ class RougailOutputDoc(Examples):
|
|||
if all_is_undocumented and len(values) > 1:
|
||||
values = _("the values of undocumented variables")
|
||||
else:
|
||||
variable_path = calculation["ori_path"]
|
||||
variable = self.conf.forcepermissive.option(variable_path)
|
||||
try:
|
||||
isfollower = variable.isfollower()
|
||||
except AttributeError as err:
|
||||
pass
|
||||
else:
|
||||
if not isfollower and self._is_inaccessible_user_data(variable):
|
||||
try:
|
||||
uncalculated = variable.value.get(uncalculated=True)
|
||||
except PropertiesOptionError:
|
||||
true_msg = None
|
||||
# true_msg = _("depends on an undocumented variable")
|
||||
else:
|
||||
if uncalculated and not isinstance(uncalculated, Calculation):
|
||||
true_msg = _('{0} (from an uncalculated variable)').format(uncalculated)
|
||||
else:
|
||||
true_msg = _("depends on an undocumented variable")
|
||||
if true_msg:
|
||||
values = true_msg.format(calculation["ori_path"])
|
||||
else:
|
||||
values = None
|
||||
elif calculation["type"] == "identifier":
|
||||
if prop in PROPERTY_ATTRIBUTE:
|
||||
values = calculation["value"]
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
**var2** +
|
||||
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` |
|
||||
My var2. +
|
||||
**Default**: the value of the variable "var1".
|
||||
**Default**: depends on an undocumented variable.
|
||||
|
|
||||
|
||||
**var3** +
|
||||
|
|
|
|||
|
|
@ -6,6 +6,6 @@
|
|||
**var2** +
|
||||
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` |
|
||||
My var2. +
|
||||
**Default**: the value of the variable "var1".
|
||||
**Default**: depends on an undocumented variable.
|
||||
|====
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,11 @@
|
|||
[cols="1a,1a"]
|
||||
|====
|
||||
| Variable | Description
|
||||
|
|
||||
|
||||
**var2** +
|
||||
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` |
|
||||
A second variable. +
|
||||
**Default**: depends on a calculation.
|
||||
|====
|
||||
|
||||
|
|
@ -0,0 +1,29 @@
|
|||
{
|
||||
"var2": {
|
||||
"type": "variable",
|
||||
"default": "depends on a calculation.",
|
||||
"properties": [
|
||||
{
|
||||
"type": "type",
|
||||
"name": "string"
|
||||
},
|
||||
{
|
||||
"type": "mode",
|
||||
"name": "standard"
|
||||
},
|
||||
{
|
||||
"type": "property",
|
||||
"name": "mandatory"
|
||||
}
|
||||
],
|
||||
"paths": [
|
||||
"var2"
|
||||
],
|
||||
"names": [
|
||||
"var2"
|
||||
],
|
||||
"descriptions": [
|
||||
"A second variable."
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,4 @@
|
|||
| Variable | Description |
|
||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| **var2**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second variable.<br/>**Default**: depends on a calculation. |
|
||||
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
|
||||
┃[1m [0m[1mVariable [0m[1m [0m┃[1m [0m[1mDescription [0m[1m [0m┃
|
||||
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
|
||||
│ [1mvar2[0m │ A second variable. │
|
||||
│ [1;7m string [0m [1;7m standard [0m [1;7m mandatory [0m │ [1mDefault[0m: depends on a calculation. │
|
||||
└───────────────────────────────────────┴──────────────────────────────────────┘
|
||||
18
tests/results/test/04_5validators_multi3.adoc
Normal file
18
tests/results/test/04_5validators_multi3.adoc
Normal file
|
|
@ -0,0 +1,18 @@
|
|||
[cols="1a,1a"]
|
||||
|====
|
||||
| Variable | Description
|
||||
|
|
||||
|
||||
**var1** +
|
||||
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` `unique` `multiple` |
|
||||
A second variable. +
|
||||
**Validator**: value must be equal to index. +
|
||||
**Default**:
|
||||
|
||||
* 0
|
||||
* 1
|
||||
* 2
|
||||
|
||||
**Example**: 0
|
||||
|====
|
||||
|
||||
|
|
@ -1,15 +1,24 @@
|
|||
{
|
||||
"var1": {
|
||||
"type": "variable",
|
||||
"default": [
|
||||
0,
|
||||
1,
|
||||
2
|
||||
],
|
||||
"properties": [
|
||||
{
|
||||
"type": "type",
|
||||
"name": "string"
|
||||
"name": "number"
|
||||
},
|
||||
{
|
||||
"type": "mode",
|
||||
"name": "standard"
|
||||
},
|
||||
{
|
||||
"type": "property",
|
||||
"name": "mandatory"
|
||||
},
|
||||
{
|
||||
"type": "property",
|
||||
"name": "unique"
|
||||
|
|
@ -19,6 +28,9 @@
|
|||
"name": "multiple"
|
||||
}
|
||||
],
|
||||
"validators": [
|
||||
"value must be equal to index."
|
||||
],
|
||||
"paths": [
|
||||
"var1"
|
||||
],
|
||||
|
|
@ -26,37 +38,10 @@
|
|||
"var1"
|
||||
],
|
||||
"descriptions": [
|
||||
"A suffix variable."
|
||||
"A second variable."
|
||||
],
|
||||
"examples": [
|
||||
"val1",
|
||||
"val2"
|
||||
]
|
||||
},
|
||||
"var2": {
|
||||
"type": "variable",
|
||||
"properties": [
|
||||
{
|
||||
"type": "type",
|
||||
"name": "string"
|
||||
},
|
||||
{
|
||||
"type": "mode",
|
||||
"name": "standard"
|
||||
},
|
||||
{
|
||||
"type": "property",
|
||||
"name": "mandatory"
|
||||
}
|
||||
],
|
||||
"paths": [
|
||||
"var2"
|
||||
],
|
||||
"names": [
|
||||
"var2"
|
||||
],
|
||||
"descriptions": [
|
||||
"A variable calculated."
|
||||
0
|
||||
]
|
||||
}
|
||||
}
|
||||
4
tests/results/test/04_5validators_multi3.md
Normal file
4
tests/results/test/04_5validators_multi3.md
Normal file
|
|
@ -0,0 +1,4 @@
|
|||
| Variable | Description |
|
||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| **var1**<br/>[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A second variable.<br/>**Validator**: value must be equal to index.<br/>**Default**: <br/>- 0<br/>- 1<br/>- 2<br/>**Example**: 0 |
|
||||
|
||||
12
tests/results/test/04_5validators_multi3.sh
Normal file
12
tests/results/test/04_5validators_multi3.sh
Normal file
|
|
@ -0,0 +1,12 @@
|
|||
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
|
||||
┃[1m [0m[1mVariable [0m[1m [0m┃[1m [0m[1mDescription [0m[1m [0m┃
|
||||
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
|
||||
│ [1mvar1[0m │ A second variable. │
|
||||
│ [1;7m number [0m [1;7m standard [0m [1;7m mandatory [0m [1;7m [0m │ [1mValidator[0m: value must be equal to │
|
||||
│ [1;7munique [0m [1;7m multiple [0m │ index. │
|
||||
│ │ [1mDefault[0m: │
|
||||
│ │ - 0 │
|
||||
│ │ - 1 │
|
||||
│ │ - 2 │
|
||||
│ │ [1mExample[0m: 0 │
|
||||
└───────────────────────────────────────┴──────────────────────────────────────┘
|
||||
|
|
@ -0,0 +1,27 @@
|
|||
== A leadership
|
||||
|
||||
`basic`
|
||||
|
||||
This family contains lists of variable blocks.
|
||||
|
||||
[cols="1a,1a"]
|
||||
|====
|
||||
| Variable | Description
|
||||
|
|
||||
|
||||
**leadership.leader** +
|
||||
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `unique` `multiple` |
|
||||
The leader.
|
||||
|
|
||||
|
||||
**leadership.follower1** +
|
||||
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `multiple` |
|
||||
The first follower.
|
||||
|
|
||||
|
||||
**leadership.follower2** +
|
||||
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `multiple` |
|
||||
The second follower. +
|
||||
**Default**: value
|
||||
|====
|
||||
|
||||
|
|
@ -0,0 +1,118 @@
|
|||
{
|
||||
"leadership": {
|
||||
"type": "leadership",
|
||||
"informations": {
|
||||
"paths": [
|
||||
"leadership"
|
||||
],
|
||||
"names": [
|
||||
"leadership"
|
||||
],
|
||||
"description": "A leadership",
|
||||
"properties": [
|
||||
{
|
||||
"type": "mode",
|
||||
"name": "basic"
|
||||
}
|
||||
],
|
||||
"help": [
|
||||
"This family contains lists of variable blocks."
|
||||
]
|
||||
},
|
||||
"children": {
|
||||
"leadership.leader": {
|
||||
"type": "variable",
|
||||
"properties": [
|
||||
{
|
||||
"type": "type",
|
||||
"name": "string"
|
||||
},
|
||||
{
|
||||
"type": "mode",
|
||||
"name": "standard"
|
||||
},
|
||||
{
|
||||
"type": "property",
|
||||
"name": "unique"
|
||||
},
|
||||
{
|
||||
"type": "multiple",
|
||||
"name": "multiple"
|
||||
}
|
||||
],
|
||||
"paths": [
|
||||
"leadership.leader"
|
||||
],
|
||||
"names": [
|
||||
"leader"
|
||||
],
|
||||
"descriptions": [
|
||||
"The leader."
|
||||
]
|
||||
},
|
||||
"leadership.follower1": {
|
||||
"type": "variable",
|
||||
"properties": [
|
||||
{
|
||||
"type": "type",
|
||||
"name": "string"
|
||||
},
|
||||
{
|
||||
"type": "mode",
|
||||
"name": "basic"
|
||||
},
|
||||
{
|
||||
"type": "property",
|
||||
"name": "mandatory"
|
||||
},
|
||||
{
|
||||
"type": "multiple",
|
||||
"name": "multiple"
|
||||
}
|
||||
],
|
||||
"paths": [
|
||||
"leadership.follower1"
|
||||
],
|
||||
"names": [
|
||||
"follower1"
|
||||
],
|
||||
"descriptions": [
|
||||
"The first follower."
|
||||
]
|
||||
},
|
||||
"leadership.follower2": {
|
||||
"type": "variable",
|
||||
"default": [
|
||||
"value"
|
||||
],
|
||||
"properties": [
|
||||
{
|
||||
"type": "type",
|
||||
"name": "string"
|
||||
},
|
||||
{
|
||||
"type": "mode",
|
||||
"name": "standard"
|
||||
},
|
||||
{
|
||||
"type": "property",
|
||||
"name": "mandatory"
|
||||
},
|
||||
{
|
||||
"type": "multiple",
|
||||
"name": "multiple"
|
||||
}
|
||||
],
|
||||
"paths": [
|
||||
"leadership.follower2"
|
||||
],
|
||||
"names": [
|
||||
"follower2"
|
||||
],
|
||||
"descriptions": [
|
||||
"The second follower."
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,12 @@
|
|||
# A leadership
|
||||
|
||||
`basic`
|
||||
|
||||
This family contains lists of variable blocks.
|
||||
|
||||
| Variable | Description |
|
||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| **leadership.leader**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | The leader. |
|
||||
| **leadership.follower1**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `multiple` | The first follower. |
|
||||
| **leadership.follower2**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `multiple` | The second follower.<br/>**Default**: value |
|
||||
|
||||
|
|
@ -0,0 +1,26 @@
|
|||
|
||||
|
||||
[1;4;96mA leadership[0m
|
||||
|
||||
|
||||
[1;7m basic [0m
|
||||
|
||||
|
||||
This family contains lists of variable blocks.
|
||||
|
||||
|
||||
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
|
||||
┃[1m [0m[1mVariable [0m[1m [0m┃[1m [0m[1mDescription [0m[1m [0m┃
|
||||
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
|
||||
│ [1mleadership.leader[0m │ The leader. │
|
||||
│ [1;7m string [0m [1;7m standard [0m [1;7m unique [0m [1;7m [0m │ │
|
||||
│ [1;7mmultiple [0m │ │
|
||||
├───────────────────────────────────────┼──────────────────────────────────────┤
|
||||
│ [1mleadership.follower1[0m │ The first follower. │
|
||||
│ [1;7m string [0m [1;7m basic [0m [1;7m mandatory [0m [1;7m [0m │ │
|
||||
│ [1;7mmultiple [0m │ │
|
||||
├───────────────────────────────────────┼──────────────────────────────────────┤
|
||||
│ [1mleadership.follower2[0m │ The second follower. │
|
||||
│ [1;7m string [0m [1;7m standard [0m [1;7m mandatory [0m [1;7m [0m │ [1mDefault[0m: value │
|
||||
│ [1;7mmultiple [0m │ │
|
||||
└───────────────────────────────────────┴──────────────────────────────────────┘
|
||||
|
|
@ -25,15 +25,15 @@ This family builds families dynamically.
|
|||
| Variable | Description
|
||||
|
|
||||
|
||||
**dyn__val.1__.var1** +
|
||||
**dyn__val.2__.var1** +
|
||||
**dyn__val_1__.var1** +
|
||||
**dyn__val_2__.var1** +
|
||||
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` |
|
||||
A dynamic variable. +
|
||||
**Default**: the value of the identifier.
|
||||
|
|
||||
|
||||
**dyn__val.1__.var2** +
|
||||
**dyn__val.2__.var2** +
|
||||
**dyn__val_1__.var2** +
|
||||
**dyn__val_2__.var2** +
|
||||
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` |
|
||||
A dynamic variable. +
|
||||
**Default**: depends on a calculation.
|
||||
|
|
|
|||
|
|
@ -41,8 +41,8 @@
|
|||
"type": "dynamic",
|
||||
"informations": {
|
||||
"paths": [
|
||||
"dynval.1",
|
||||
"dynval.2"
|
||||
"dynval_1",
|
||||
"dynval_2"
|
||||
],
|
||||
"names": [
|
||||
"dynval_1",
|
||||
|
|
@ -63,8 +63,8 @@
|
|||
"children": {
|
||||
"dyn{{ identifier }}.var1": {
|
||||
"paths": [
|
||||
"dynval.1.var1",
|
||||
"dynval.2.var1"
|
||||
"dynval_1.var1",
|
||||
"dynval_2.var1"
|
||||
],
|
||||
"names": [
|
||||
"var1",
|
||||
|
|
@ -92,8 +92,8 @@
|
|||
},
|
||||
"dyn{{ identifier }}.var2": {
|
||||
"paths": [
|
||||
"dynval.1.var2",
|
||||
"dynval.2.var2"
|
||||
"dynval_1.var2",
|
||||
"dynval_2.var2"
|
||||
],
|
||||
"names": [
|
||||
"var2",
|
||||
|
|
|
|||
|
|
@ -12,6 +12,6 @@ This family builds families dynamically.
|
|||
|
||||
| Variable | Description |
|
||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| **dyn*val.1*.var1**<br/>**dyn*val.2*.var1**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A dynamic variable.<br/>**Default**: the value of the identifier. |
|
||||
| **dyn*val.1*.var2**<br/>**dyn*val.2*.var2**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A dynamic variable.<br/>**Default**: depends on a calculation. |
|
||||
| **dyn*val_1*.var1**<br/>**dyn*val_2*.var1**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A dynamic variable.<br/>**Default**: the value of the identifier. |
|
||||
| **dyn*val_1*.var2**<br/>**dyn*val_2*.var2**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A dynamic variable.<br/>**Default**: depends on a calculation. |
|
||||
|
||||
|
|
|
|||
|
|
@ -23,11 +23,11 @@ This family builds families dynamically.
|
|||
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
|
||||
┃[1m [0m[1mVariable [0m[1m [0m┃[1m [0m[1mDescription [0m[1m [0m┃
|
||||
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
|
||||
│ [1mdyn[0m[1;3mval.1[0m[1m.var1[0m │ A dynamic variable. │
|
||||
│ [1mdyn[0m[1;3mval.2[0m[1m.var1[0m │ [1mDefault[0m: the value of the │
|
||||
│ [1mdyn[0m[1;3mval_1[0m[1m.var1[0m │ A dynamic variable. │
|
||||
│ [1mdyn[0m[1;3mval_2[0m[1m.var1[0m │ [1mDefault[0m: the value of the │
|
||||
│ [1;7m string [0m [1;7m standard [0m [1;7m mandatory [0m │ identifier. │
|
||||
├───────────────────────────────────────┼──────────────────────────────────────┤
|
||||
│ [1mdyn[0m[1;3mval.1[0m[1m.var2[0m │ A dynamic variable. │
|
||||
│ [1mdyn[0m[1;3mval.2[0m[1m.var2[0m │ [1mDefault[0m: depends on a calculation. │
|
||||
│ [1mdyn[0m[1;3mval_1[0m[1m.var2[0m │ A dynamic variable. │
|
||||
│ [1mdyn[0m[1;3mval_2[0m[1m.var2[0m │ [1mDefault[0m: depends on a calculation. │
|
||||
│ [1;7m string [0m [1;7m standard [0m [1;7m mandatory [0m │ │
|
||||
└───────────────────────────────────────┴──────────────────────────────────────┘
|
||||
|
|
|
|||
|
|
@ -25,8 +25,8 @@ This family builds families dynamically.
|
|||
| Variable | Description
|
||||
|
|
||||
|
||||
**dyn__Val1__.var** +
|
||||
**dyn__VAL2__.var** +
|
||||
**dyn__val1__.var** +
|
||||
**dyn__val2__.var** +
|
||||
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` |
|
||||
A dynamic variable.
|
||||
|====
|
||||
|
|
|
|||
|
|
@ -41,8 +41,8 @@
|
|||
"type": "dynamic",
|
||||
"informations": {
|
||||
"paths": [
|
||||
"dynVal1",
|
||||
"dynVAL2"
|
||||
"dynval1",
|
||||
"dynval2"
|
||||
],
|
||||
"names": [
|
||||
"dynval1",
|
||||
|
|
@ -63,8 +63,8 @@
|
|||
"children": {
|
||||
"dyn{{ identifier }}.var": {
|
||||
"paths": [
|
||||
"dynVal1.var",
|
||||
"dynVAL2.var"
|
||||
"dynval1.var",
|
||||
"dynval2.var"
|
||||
],
|
||||
"names": [
|
||||
"var",
|
||||
|
|
|
|||
|
|
@ -12,5 +12,5 @@ This family builds families dynamically.
|
|||
|
||||
| Variable | Description |
|
||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| **dyn*Val1*.var**<br/>**dyn*VAL2*.var**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A dynamic variable. |
|
||||
| **dyn*val1*.var**<br/>**dyn*val2*.var**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A dynamic variable. |
|
||||
|
||||
|
|
|
|||
|
|
@ -23,7 +23,7 @@ This family builds families dynamically.
|
|||
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
|
||||
┃[1m [0m[1mVariable [0m[1m [0m┃[1m [0m[1mDescription [0m[1m [0m┃
|
||||
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
|
||||
│ [1mdyn[0m[1;3mVal1[0m[1m.var[0m │ A dynamic variable. │
|
||||
│ [1mdyn[0m[1;3mVAL2[0m[1m.var[0m │ │
|
||||
│ [1mdyn[0m[1;3mval1[0m[1m.var[0m │ A dynamic variable. │
|
||||
│ [1mdyn[0m[1;3mval2[0m[1m.var[0m │ │
|
||||
│ [1;7m string [0m [1;7m basic [0m [1;7m mandatory [0m │ │
|
||||
└───────────────────────────────────────┴──────────────────────────────────────┘
|
||||
|
|
|
|||
|
|
@ -0,0 +1,6 @@
|
|||
# Example with all variables modifiable
|
||||
|
||||
```yaml
|
||||
---
|
||||
var2: a_value
|
||||
```
|
||||
7
tests/results/test_examples/04_5validators_multi3.md
Normal file
7
tests/results/test_examples/04_5validators_multi3.md
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
# Example with all variables modifiable
|
||||
|
||||
```yaml
|
||||
---
|
||||
var1:
|
||||
- 0
|
||||
```
|
||||
|
|
@ -0,0 +1,11 @@
|
|||
# Example with all variables modifiable
|
||||
|
||||
```yaml
|
||||
---
|
||||
leadership:
|
||||
- leader: example
|
||||
follower1:
|
||||
- example
|
||||
follower2:
|
||||
- value
|
||||
```
|
||||
|
|
@ -1,15 +0,0 @@
|
|||
# Example with mandatory variables not filled in
|
||||
|
||||
```yaml
|
||||
---
|
||||
var2: example
|
||||
```
|
||||
# Example with all variables modifiable
|
||||
|
||||
```yaml
|
||||
---
|
||||
var1:
|
||||
- val1
|
||||
- val2
|
||||
var2: example
|
||||
```
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
== Variables for "Rougail"
|
||||
|
||||
[cols="1a,1a"]
|
||||
|====
|
||||
| Variable | Description
|
||||
|
|
||||
|
||||
**rougail.var2** +
|
||||
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` |
|
||||
A second variable. +
|
||||
**Default**: depends on a calculation.
|
||||
|====
|
||||
|
||||
|
|
@ -0,0 +1,49 @@
|
|||
{
|
||||
"rougail": {
|
||||
"type": "namespace",
|
||||
"informations": {
|
||||
"paths": [
|
||||
"rougail"
|
||||
],
|
||||
"names": [
|
||||
"rougail"
|
||||
],
|
||||
"description": "Rougail",
|
||||
"properties": [
|
||||
{
|
||||
"type": "mode",
|
||||
"name": "standard"
|
||||
}
|
||||
]
|
||||
},
|
||||
"children": {
|
||||
"rougail.var2": {
|
||||
"type": "variable",
|
||||
"default": "depends on a calculation.",
|
||||
"properties": [
|
||||
{
|
||||
"type": "type",
|
||||
"name": "string"
|
||||
},
|
||||
{
|
||||
"type": "mode",
|
||||
"name": "standard"
|
||||
},
|
||||
{
|
||||
"type": "property",
|
||||
"name": "mandatory"
|
||||
}
|
||||
],
|
||||
"paths": [
|
||||
"rougail.var2"
|
||||
],
|
||||
"names": [
|
||||
"var2"
|
||||
],
|
||||
"descriptions": [
|
||||
"A second variable."
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
# Variables for "Rougail"
|
||||
|
||||
| Variable | Description |
|
||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| **rougail.var2**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second variable.<br/>**Default**: depends on a calculation. |
|
||||
|
||||
|
|
@ -0,0 +1,11 @@
|
|||
|
||||
|
||||
[1;4;96mVariables for [0m[1;4;96m"Rougail"[0m
|
||||
|
||||
|
||||
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
|
||||
┃[1m [0m[1mVariable [0m[1m [0m┃[1m [0m[1mDescription [0m[1m [0m┃
|
||||
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
|
||||
│ [1mrougail.var2[0m │ A second variable. │
|
||||
│ [1;7m string [0m [1;7m standard [0m [1;7m mandatory [0m │ [1mDefault[0m: depends on a calculation. │
|
||||
└───────────────────────────────────────┴──────────────────────────────────────┘
|
||||
20
tests/results/test_namespace/04_5validators_multi3.adoc
Normal file
20
tests/results/test_namespace/04_5validators_multi3.adoc
Normal file
|
|
@ -0,0 +1,20 @@
|
|||
== Variables for "Rougail"
|
||||
|
||||
[cols="1a,1a"]
|
||||
|====
|
||||
| Variable | Description
|
||||
|
|
||||
|
||||
**rougail.var1** +
|
||||
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` `unique` `multiple` |
|
||||
A second variable. +
|
||||
**Validator**: value must be equal to index. +
|
||||
**Default**:
|
||||
|
||||
* 0
|
||||
* 1
|
||||
* 2
|
||||
|
||||
**Example**: 0
|
||||
|====
|
||||
|
||||
67
tests/results/test_namespace/04_5validators_multi3.json
Normal file
67
tests/results/test_namespace/04_5validators_multi3.json
Normal file
|
|
@ -0,0 +1,67 @@
|
|||
{
|
||||
"rougail": {
|
||||
"type": "namespace",
|
||||
"informations": {
|
||||
"paths": [
|
||||
"rougail"
|
||||
],
|
||||
"names": [
|
||||
"rougail"
|
||||
],
|
||||
"description": "Rougail",
|
||||
"properties": [
|
||||
{
|
||||
"type": "mode",
|
||||
"name": "standard"
|
||||
}
|
||||
]
|
||||
},
|
||||
"children": {
|
||||
"rougail.var1": {
|
||||
"type": "variable",
|
||||
"default": [
|
||||
0,
|
||||
1,
|
||||
2
|
||||
],
|
||||
"properties": [
|
||||
{
|
||||
"type": "type",
|
||||
"name": "number"
|
||||
},
|
||||
{
|
||||
"type": "mode",
|
||||
"name": "standard"
|
||||
},
|
||||
{
|
||||
"type": "property",
|
||||
"name": "mandatory"
|
||||
},
|
||||
{
|
||||
"type": "property",
|
||||
"name": "unique"
|
||||
},
|
||||
{
|
||||
"type": "multiple",
|
||||
"name": "multiple"
|
||||
}
|
||||
],
|
||||
"validators": [
|
||||
"value must be equal to index."
|
||||
],
|
||||
"paths": [
|
||||
"rougail.var1"
|
||||
],
|
||||
"names": [
|
||||
"var1"
|
||||
],
|
||||
"descriptions": [
|
||||
"A second variable."
|
||||
],
|
||||
"examples": [
|
||||
0
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
6
tests/results/test_namespace/04_5validators_multi3.md
Normal file
6
tests/results/test_namespace/04_5validators_multi3.md
Normal file
|
|
@ -0,0 +1,6 @@
|
|||
# Variables for "Rougail"
|
||||
|
||||
| Variable | Description |
|
||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| **rougail.var1**<br/>[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A second variable.<br/>**Validator**: value must be equal to index.<br/>**Default**: <br/>- 0<br/>- 1<br/>- 2<br/>**Example**: 0 |
|
||||
|
||||
17
tests/results/test_namespace/04_5validators_multi3.sh
Normal file
17
tests/results/test_namespace/04_5validators_multi3.sh
Normal file
|
|
@ -0,0 +1,17 @@
|
|||
|
||||
|
||||
[1;4;96mVariables for [0m[1;4;96m"Rougail"[0m
|
||||
|
||||
|
||||
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
|
||||
┃[1m [0m[1mVariable [0m[1m [0m┃[1m [0m[1mDescription [0m[1m [0m┃
|
||||
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
|
||||
│ [1mrougail.var1[0m │ A second variable. │
|
||||
│ [1;7m number [0m [1;7m standard [0m [1;7m mandatory [0m [1;7m [0m │ [1mValidator[0m: value must be equal to │
|
||||
│ [1;7munique [0m [1;7m multiple [0m │ index. │
|
||||
│ │ [1mDefault[0m: │
|
||||
│ │ - 0 │
|
||||
│ │ - 1 │
|
||||
│ │ - 2 │
|
||||
│ │ [1mExample[0m: 0 │
|
||||
└───────────────────────────────────────┴──────────────────────────────────────┘
|
||||
|
|
@ -0,0 +1,29 @@
|
|||
== Variables for "Rougail"
|
||||
|
||||
=== A leadership
|
||||
|
||||
`basic`
|
||||
|
||||
This family contains lists of variable blocks.
|
||||
|
||||
[cols="1a,1a"]
|
||||
|====
|
||||
| Variable | Description
|
||||
|
|
||||
|
||||
**rougail.leadership.leader** +
|
||||
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `unique` `multiple` |
|
||||
The leader.
|
||||
|
|
||||
|
||||
**rougail.leadership.follower1** +
|
||||
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `multiple` |
|
||||
The first follower.
|
||||
|
|
||||
|
||||
**rougail.leadership.follower2** +
|
||||
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `multiple` |
|
||||
The second follower. +
|
||||
**Default**: value
|
||||
|====
|
||||
|
||||
|
|
@ -0,0 +1,138 @@
|
|||
{
|
||||
"rougail": {
|
||||
"type": "namespace",
|
||||
"informations": {
|
||||
"paths": [
|
||||
"rougail"
|
||||
],
|
||||
"names": [
|
||||
"rougail"
|
||||
],
|
||||
"description": "Rougail",
|
||||
"properties": [
|
||||
{
|
||||
"type": "mode",
|
||||
"name": "basic"
|
||||
}
|
||||
]
|
||||
},
|
||||
"children": {
|
||||
"leadership": {
|
||||
"type": "leadership",
|
||||
"informations": {
|
||||
"paths": [
|
||||
"rougail.leadership"
|
||||
],
|
||||
"names": [
|
||||
"leadership"
|
||||
],
|
||||
"description": "A leadership",
|
||||
"properties": [
|
||||
{
|
||||
"type": "mode",
|
||||
"name": "basic"
|
||||
}
|
||||
],
|
||||
"help": [
|
||||
"This family contains lists of variable blocks."
|
||||
]
|
||||
},
|
||||
"children": {
|
||||
"rougail.leadership.leader": {
|
||||
"type": "variable",
|
||||
"properties": [
|
||||
{
|
||||
"type": "type",
|
||||
"name": "string"
|
||||
},
|
||||
{
|
||||
"type": "mode",
|
||||
"name": "standard"
|
||||
},
|
||||
{
|
||||
"type": "property",
|
||||
"name": "unique"
|
||||
},
|
||||
{
|
||||
"type": "multiple",
|
||||
"name": "multiple"
|
||||
}
|
||||
],
|
||||
"paths": [
|
||||
"rougail.leadership.leader"
|
||||
],
|
||||
"names": [
|
||||
"leader"
|
||||
],
|
||||
"descriptions": [
|
||||
"The leader."
|
||||
]
|
||||
},
|
||||
"rougail.leadership.follower1": {
|
||||
"type": "variable",
|
||||
"properties": [
|
||||
{
|
||||
"type": "type",
|
||||
"name": "string"
|
||||
},
|
||||
{
|
||||
"type": "mode",
|
||||
"name": "basic"
|
||||
},
|
||||
{
|
||||
"type": "property",
|
||||
"name": "mandatory"
|
||||
},
|
||||
{
|
||||
"type": "multiple",
|
||||
"name": "multiple"
|
||||
}
|
||||
],
|
||||
"paths": [
|
||||
"rougail.leadership.follower1"
|
||||
],
|
||||
"names": [
|
||||
"follower1"
|
||||
],
|
||||
"descriptions": [
|
||||
"The first follower."
|
||||
]
|
||||
},
|
||||
"rougail.leadership.follower2": {
|
||||
"type": "variable",
|
||||
"default": [
|
||||
"value"
|
||||
],
|
||||
"properties": [
|
||||
{
|
||||
"type": "type",
|
||||
"name": "string"
|
||||
},
|
||||
{
|
||||
"type": "mode",
|
||||
"name": "standard"
|
||||
},
|
||||
{
|
||||
"type": "property",
|
||||
"name": "mandatory"
|
||||
},
|
||||
{
|
||||
"type": "multiple",
|
||||
"name": "multiple"
|
||||
}
|
||||
],
|
||||
"paths": [
|
||||
"rougail.leadership.follower2"
|
||||
],
|
||||
"names": [
|
||||
"follower2"
|
||||
],
|
||||
"descriptions": [
|
||||
"The second follower."
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,14 @@
|
|||
# Variables for "Rougail"
|
||||
|
||||
## A leadership
|
||||
|
||||
`basic`
|
||||
|
||||
This family contains lists of variable blocks.
|
||||
|
||||
| Variable | Description |
|
||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| **rougail.leadership.leader**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | The leader. |
|
||||
| **rougail.leadership.follower1**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `multiple` | The first follower. |
|
||||
| **rougail.leadership.follower2**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `multiple` | The second follower.<br/>**Default**: value |
|
||||
|
||||
|
|
@ -0,0 +1,31 @@
|
|||
|
||||
|
||||
[1;4;96mVariables for [0m[1;4;96m"Rougail"[0m
|
||||
|
||||
|
||||
|
||||
|
||||
[1;4;92mA leadership[0m
|
||||
|
||||
|
||||
[1;7m basic [0m
|
||||
|
||||
|
||||
This family contains lists of variable blocks.
|
||||
|
||||
|
||||
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
|
||||
┃[1m [0m[1mVariable [0m[1m [0m┃[1m [0m[1mDescription [0m[1m [0m┃
|
||||
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
|
||||
│ [1mrougail.leadership.leader[0m │ The leader. │
|
||||
│ [1;7m string [0m [1;7m standard [0m [1;7m unique [0m [1;7m [0m │ │
|
||||
│ [1;7mmultiple [0m │ │
|
||||
├───────────────────────────────────────┼──────────────────────────────────────┤
|
||||
│ [1mrougail.leadership.follower1[0m │ The first follower. │
|
||||
│ [1;7m string [0m [1;7m basic [0m [1;7m mandatory [0m [1;7m [0m │ │
|
||||
│ [1;7mmultiple [0m │ │
|
||||
├───────────────────────────────────────┼──────────────────────────────────────┤
|
||||
│ [1mrougail.leadership.follower2[0m │ The second follower. │
|
||||
│ [1;7m string [0m [1;7m standard [0m [1;7m mandatory [0m [1;7m [0m │ [1mDefault[0m: value │
|
||||
│ [1;7mmultiple [0m │ │
|
||||
└───────────────────────────────────────┴──────────────────────────────────────┘
|
||||
|
|
@ -27,15 +27,15 @@ This family builds families dynamically.
|
|||
| Variable | Description
|
||||
|
|
||||
|
||||
**rougail.dyn__val.1__.var1** +
|
||||
**rougail.dyn__val.2__.var1** +
|
||||
**rougail.dyn__val_1__.var1** +
|
||||
**rougail.dyn__val_2__.var1** +
|
||||
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` |
|
||||
A dynamic variable. +
|
||||
**Default**: the value of the identifier.
|
||||
|
|
||||
|
||||
**rougail.dyn__val.1__.var2** +
|
||||
**rougail.dyn__val.2__.var2** +
|
||||
**rougail.dyn__val_1__.var2** +
|
||||
**rougail.dyn__val_2__.var2** +
|
||||
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` |
|
||||
A dynamic variable. +
|
||||
**Default**: depends on a calculation.
|
||||
|
|
|
|||
|
|
@ -59,8 +59,8 @@
|
|||
"type": "dynamic",
|
||||
"informations": {
|
||||
"paths": [
|
||||
"rougail.dynval.1",
|
||||
"rougail.dynval.2"
|
||||
"rougail.dynval_1",
|
||||
"rougail.dynval_2"
|
||||
],
|
||||
"names": [
|
||||
"dynval_1",
|
||||
|
|
@ -81,8 +81,8 @@
|
|||
"children": {
|
||||
"rougail.dyn{{ identifier }}.var1": {
|
||||
"paths": [
|
||||
"rougail.dynval.1.var1",
|
||||
"rougail.dynval.2.var1"
|
||||
"rougail.dynval_1.var1",
|
||||
"rougail.dynval_2.var1"
|
||||
],
|
||||
"names": [
|
||||
"var1",
|
||||
|
|
@ -110,8 +110,8 @@
|
|||
},
|
||||
"rougail.dyn{{ identifier }}.var2": {
|
||||
"paths": [
|
||||
"rougail.dynval.1.var2",
|
||||
"rougail.dynval.2.var2"
|
||||
"rougail.dynval_1.var2",
|
||||
"rougail.dynval_2.var2"
|
||||
],
|
||||
"names": [
|
||||
"var2",
|
||||
|
|
|
|||
|
|
@ -14,6 +14,6 @@ This family builds families dynamically.
|
|||
|
||||
| Variable | Description |
|
||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| **rougail.dyn*val.1*.var1**<br/>**rougail.dyn*val.2*.var1**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A dynamic variable.<br/>**Default**: the value of the identifier. |
|
||||
| **rougail.dyn*val.1*.var2**<br/>**rougail.dyn*val.2*.var2**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A dynamic variable.<br/>**Default**: depends on a calculation. |
|
||||
| **rougail.dyn*val_1*.var1**<br/>**rougail.dyn*val_2*.var1**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A dynamic variable.<br/>**Default**: the value of the identifier. |
|
||||
| **rougail.dyn*val_1*.var2**<br/>**rougail.dyn*val_2*.var2**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A dynamic variable.<br/>**Default**: depends on a calculation. |
|
||||
|
||||
|
|
|
|||
|
|
@ -28,11 +28,11 @@ This family builds families dynamically.
|
|||
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
|
||||
┃[1m [0m[1mVariable [0m[1m [0m┃[1m [0m[1mDescription [0m[1m [0m┃
|
||||
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
|
||||
│ [1mrougail.dyn[0m[1;3mval.1[0m[1m.var1[0m │ A dynamic variable. │
|
||||
│ [1mrougail.dyn[0m[1;3mval.2[0m[1m.var1[0m │ [1mDefault[0m: the value of the │
|
||||
│ [1mrougail.dyn[0m[1;3mval_1[0m[1m.var1[0m │ A dynamic variable. │
|
||||
│ [1mrougail.dyn[0m[1;3mval_2[0m[1m.var1[0m │ [1mDefault[0m: the value of the │
|
||||
│ [1;7m string [0m [1;7m standard [0m [1;7m mandatory [0m │ identifier. │
|
||||
├───────────────────────────────────────┼──────────────────────────────────────┤
|
||||
│ [1mrougail.dyn[0m[1;3mval.1[0m[1m.var2[0m │ A dynamic variable. │
|
||||
│ [1mrougail.dyn[0m[1;3mval.2[0m[1m.var2[0m │ [1mDefault[0m: depends on a calculation. │
|
||||
│ [1mrougail.dyn[0m[1;3mval_1[0m[1m.var2[0m │ A dynamic variable. │
|
||||
│ [1mrougail.dyn[0m[1;3mval_2[0m[1m.var2[0m │ [1mDefault[0m: depends on a calculation. │
|
||||
│ [1;7m string [0m [1;7m standard [0m [1;7m mandatory [0m │ │
|
||||
└───────────────────────────────────────┴──────────────────────────────────────┘
|
||||
|
|
|
|||
|
|
@ -27,8 +27,8 @@ This family builds families dynamically.
|
|||
| Variable | Description
|
||||
|
|
||||
|
||||
**rougail.dyn__Val1__.var** +
|
||||
**rougail.dyn__VAL2__.var** +
|
||||
**rougail.dyn__val1__.var** +
|
||||
**rougail.dyn__val2__.var** +
|
||||
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` |
|
||||
A dynamic variable.
|
||||
|====
|
||||
|
|
|
|||
|
|
@ -59,8 +59,8 @@
|
|||
"type": "dynamic",
|
||||
"informations": {
|
||||
"paths": [
|
||||
"rougail.dynVal1",
|
||||
"rougail.dynVAL2"
|
||||
"rougail.dynval1",
|
||||
"rougail.dynval2"
|
||||
],
|
||||
"names": [
|
||||
"dynval1",
|
||||
|
|
@ -81,8 +81,8 @@
|
|||
"children": {
|
||||
"rougail.dyn{{ identifier }}.var": {
|
||||
"paths": [
|
||||
"rougail.dynVal1.var",
|
||||
"rougail.dynVAL2.var"
|
||||
"rougail.dynval1.var",
|
||||
"rougail.dynval2.var"
|
||||
],
|
||||
"names": [
|
||||
"var",
|
||||
|
|
|
|||
|
|
@ -14,5 +14,5 @@ This family builds families dynamically.
|
|||
|
||||
| Variable | Description |
|
||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| **rougail.dyn*Val1*.var**<br/>**rougail.dyn*VAL2*.var**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A dynamic variable. |
|
||||
| **rougail.dyn*val1*.var**<br/>**rougail.dyn*val2*.var**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A dynamic variable. |
|
||||
|
||||
|
|
|
|||
|
|
@ -28,7 +28,7 @@ This family builds families dynamically.
|
|||
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
|
||||
┃[1m [0m[1mVariable [0m[1m [0m┃[1m [0m[1mDescription [0m[1m [0m┃
|
||||
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
|
||||
│ [1mrougail.dyn[0m[1;3mVal1[0m[1m.var[0m │ A dynamic variable. │
|
||||
│ [1mrougail.dyn[0m[1;3mVAL2[0m[1m.var[0m │ │
|
||||
│ [1mrougail.dyn[0m[1;3mval1[0m[1m.var[0m │ A dynamic variable. │
|
||||
│ [1mrougail.dyn[0m[1;3mval2[0m[1m.var[0m │ │
|
||||
│ [1;7m string [0m [1;7m basic [0m [1;7m mandatory [0m │ │
|
||||
└───────────────────────────────────────┴──────────────────────────────────────┘
|
||||
|
|
|
|||
|
|
@ -16,7 +16,6 @@ A suffix variable. +
|
|||
|
||||
**rougail.var2** +
|
||||
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` |
|
||||
A variable calculated. +
|
||||
**Default**: the value of the variable "rougail.dynval1.var".
|
||||
A variable calculated.
|
||||
|====
|
||||
|
||||
|
|
|
|||
|
|
@ -53,7 +53,6 @@
|
|||
},
|
||||
"rougail.var2": {
|
||||
"type": "variable",
|
||||
"default": "the value of the variable \"rougail.dynval1.var\".",
|
||||
"properties": [
|
||||
{
|
||||
"type": "type",
|
||||
|
|
|
|||
|
|
@ -3,5 +3,5 @@
|
|||
| Variable | Description |
|
||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| **rougail.var1**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A suffix variable.<br/>**Examples**: <br/>- val1<br/>- val2 |
|
||||
| **rougail.var2**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable calculated.<br/>**Default**: the value of the variable "rougail.dynval1.var". |
|
||||
| **rougail.var2**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable calculated. |
|
||||
|
||||
|
|
|
|||
|
|
@ -12,6 +12,5 @@
|
|||
│ │ - val2 │
|
||||
├───────────────────────────────────────┼──────────────────────────────────────┤
|
||||
│ [1mrougail.var2[0m │ A variable calculated. │
|
||||
│ [1;7m string [0m [1;7m standard [0m [1;7m mandatory [0m │ [1mDefault[0m: the value of the variable │
|
||||
│ │ "rougail.dynval1.var". │
|
||||
│ [1;7m string [0m [1;7m standard [0m [1;7m mandatory [0m │ │
|
||||
└───────────────────────────────────────┴──────────────────────────────────────┘
|
||||
|
|
|
|||
|
|
@ -1,9 +1,11 @@
|
|||
== Variables for "Rougail"
|
||||
|
||||
[cols="1a,1a"]
|
||||
|====
|
||||
| Variable | Description
|
||||
|
|
||||
|
||||
**var1** +
|
||||
**rougail.var1** +
|
||||
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `unique` `multiple` |
|
||||
A suffix variable. +
|
||||
**Examples**:
|
||||
|
|
@ -12,8 +14,9 @@ A suffix variable. +
|
|||
* val2
|
||||
|
|
||||
|
||||
**var2** +
|
||||
**rougail.var2** +
|
||||
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` |
|
||||
A variable calculated.
|
||||
A variable calculated. +
|
||||
**Default**: a value (from an uncalculated variable).
|
||||
|====
|
||||
|
||||
|
|
@ -0,0 +1,83 @@
|
|||
{
|
||||
"rougail": {
|
||||
"type": "namespace",
|
||||
"informations": {
|
||||
"paths": [
|
||||
"rougail"
|
||||
],
|
||||
"names": [
|
||||
"rougail"
|
||||
],
|
||||
"description": "Rougail",
|
||||
"properties": [
|
||||
{
|
||||
"type": "mode",
|
||||
"name": "standard"
|
||||
}
|
||||
]
|
||||
},
|
||||
"children": {
|
||||
"rougail.var1": {
|
||||
"type": "variable",
|
||||
"properties": [
|
||||
{
|
||||
"type": "type",
|
||||
"name": "string"
|
||||
},
|
||||
{
|
||||
"type": "mode",
|
||||
"name": "standard"
|
||||
},
|
||||
{
|
||||
"type": "property",
|
||||
"name": "unique"
|
||||
},
|
||||
{
|
||||
"type": "multiple",
|
||||
"name": "multiple"
|
||||
}
|
||||
],
|
||||
"paths": [
|
||||
"rougail.var1"
|
||||
],
|
||||
"names": [
|
||||
"var1"
|
||||
],
|
||||
"descriptions": [
|
||||
"A suffix variable."
|
||||
],
|
||||
"examples": [
|
||||
"val1",
|
||||
"val2"
|
||||
]
|
||||
},
|
||||
"rougail.var2": {
|
||||
"type": "variable",
|
||||
"default": "a value (from an uncalculated variable).",
|
||||
"properties": [
|
||||
{
|
||||
"type": "type",
|
||||
"name": "string"
|
||||
},
|
||||
{
|
||||
"type": "mode",
|
||||
"name": "standard"
|
||||
},
|
||||
{
|
||||
"type": "property",
|
||||
"name": "mandatory"
|
||||
}
|
||||
],
|
||||
"paths": [
|
||||
"rougail.var2"
|
||||
],
|
||||
"names": [
|
||||
"var2"
|
||||
],
|
||||
"descriptions": [
|
||||
"A variable calculated."
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -1,5 +1,7 @@
|
|||
# Variables for "Rougail"
|
||||
|
||||
| Variable | Description |
|
||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| **var1**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A suffix variable.<br/>**Examples**: <br/>- val1<br/>- val2 |
|
||||
| **var2**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable calculated. |
|
||||
| **rougail.var1**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A suffix variable.<br/>**Examples**: <br/>- val1<br/>- val2 |
|
||||
| **rougail.var2**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable calculated.<br/>**Default**: a value (from an uncalculated variable). |
|
||||
|
||||
|
|
@ -1,11 +1,17 @@
|
|||
|
||||
|
||||
[1;4;96mVariables for [0m[1;4;96m"Rougail"[0m
|
||||
|
||||
|
||||
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
|
||||
┃[1m [0m[1mVariable [0m[1m [0m┃[1m [0m[1mDescription [0m[1m [0m┃
|
||||
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
|
||||
│ [1mvar1[0m │ A suffix variable. │
|
||||
│ [1mrougail.var1[0m │ A suffix variable. │
|
||||
│ [1;7m string [0m [1;7m standard [0m [1;7m unique [0m [1;7m [0m │ [1mExamples[0m: │
|
||||
│ [1;7mmultiple [0m │ - val1 │
|
||||
│ │ - val2 │
|
||||
├───────────────────────────────────────┼──────────────────────────────────────┤
|
||||
│ [1mvar2[0m │ A variable calculated. │
|
||||
│ [1;7m string [0m [1;7m standard [0m [1;7m mandatory [0m │ │
|
||||
│ [1mrougail.var2[0m │ A variable calculated. │
|
||||
│ [1;7m string [0m [1;7m standard [0m [1;7m mandatory [0m │ [1mDefault[0m: a value (from an │
|
||||
│ │ uncalculated variable). │
|
||||
└───────────────────────────────────────┴──────────────────────────────────────┘
|
||||
|
|
@ -0,0 +1,45 @@
|
|||
== Variables for "Rougail"
|
||||
|
||||
[cols="1a,1a"]
|
||||
|====
|
||||
| Variable | Description
|
||||
|
|
||||
|
||||
**rougail.var** +
|
||||
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` |
|
||||
A identifier variable. +
|
||||
**Default**:
|
||||
|
||||
* val1
|
||||
* val2
|
||||
|====
|
||||
|
||||
=== A dynamic family
|
||||
|
||||
`basic`
|
||||
|
||||
This family builds families dynamically.
|
||||
|
||||
**Identifiers**: the value of the variable "rougail.var".
|
||||
|
||||
==== A dynamic family
|
||||
|
||||
`basic`
|
||||
|
||||
This family builds families dynamically.
|
||||
|
||||
**Identifiers**: the value of the variable "rougail.var".
|
||||
|
||||
[cols="1a,1a"]
|
||||
|====
|
||||
| Variable | Description
|
||||
|
|
||||
|
||||
**rougail.__val1__.__val1__.var** +
|
||||
**rougail.__val1__.__val2__.var** +
|
||||
**rougail.__val2__.__val1__.var** +
|
||||
**rougail.__val2__.__val2__.var** +
|
||||
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` |
|
||||
A dynamic variable.
|
||||
|====
|
||||
|
||||
|
|
@ -0,0 +1,148 @@
|
|||
{
|
||||
"rougail": {
|
||||
"type": "namespace",
|
||||
"informations": {
|
||||
"paths": [
|
||||
"rougail"
|
||||
],
|
||||
"names": [
|
||||
"rougail"
|
||||
],
|
||||
"description": "Rougail",
|
||||
"properties": [
|
||||
{
|
||||
"type": "mode",
|
||||
"name": "basic"
|
||||
}
|
||||
]
|
||||
},
|
||||
"children": {
|
||||
"rougail.var": {
|
||||
"type": "variable",
|
||||
"default": [
|
||||
"val1",
|
||||
"val2"
|
||||
],
|
||||
"properties": [
|
||||
{
|
||||
"type": "type",
|
||||
"name": "string"
|
||||
},
|
||||
{
|
||||
"type": "mode",
|
||||
"name": "standard"
|
||||
},
|
||||
{
|
||||
"type": "property",
|
||||
"name": "mandatory"
|
||||
},
|
||||
{
|
||||
"type": "property",
|
||||
"name": "unique"
|
||||
},
|
||||
{
|
||||
"type": "multiple",
|
||||
"name": "multiple"
|
||||
}
|
||||
],
|
||||
"paths": [
|
||||
"rougail.var"
|
||||
],
|
||||
"names": [
|
||||
"var"
|
||||
],
|
||||
"descriptions": [
|
||||
"A identifier variable."
|
||||
]
|
||||
},
|
||||
"{{ identifier }}": {
|
||||
"type": "dynamic",
|
||||
"informations": {
|
||||
"paths": [
|
||||
"rougail.val1",
|
||||
"rougail.val2"
|
||||
],
|
||||
"names": [
|
||||
"val1",
|
||||
"val2"
|
||||
],
|
||||
"description": "A dynamic family",
|
||||
"properties": [
|
||||
{
|
||||
"type": "mode",
|
||||
"name": "basic"
|
||||
}
|
||||
],
|
||||
"identifiers": "the value of the variable \"rougail.var\".",
|
||||
"help": [
|
||||
"This family builds families dynamically."
|
||||
]
|
||||
},
|
||||
"children": {
|
||||
"{{ identifier }}": {
|
||||
"type": "dynamic",
|
||||
"informations": {
|
||||
"paths": [
|
||||
"rougail.val1.val1",
|
||||
"rougail.val1.val2",
|
||||
"rougail.val2.val1",
|
||||
"rougail.val2.val2"
|
||||
],
|
||||
"names": [
|
||||
"val1",
|
||||
"val2",
|
||||
"val1",
|
||||
"val2"
|
||||
],
|
||||
"description": "A dynamic family",
|
||||
"properties": [
|
||||
{
|
||||
"type": "mode",
|
||||
"name": "basic"
|
||||
}
|
||||
],
|
||||
"identifiers": "the value of the variable \"rougail.var\".",
|
||||
"help": [
|
||||
"This family builds families dynamically."
|
||||
]
|
||||
},
|
||||
"children": {
|
||||
"rougail.{{ identifier }}.{{ identifier }}.var": {
|
||||
"paths": [
|
||||
"rougail.val1.val1.var",
|
||||
"rougail.val1.val2.var",
|
||||
"rougail.val2.val1.var",
|
||||
"rougail.val2.val2.var"
|
||||
],
|
||||
"names": [
|
||||
"var",
|
||||
"var",
|
||||
"var",
|
||||
"var"
|
||||
],
|
||||
"type": "variable",
|
||||
"properties": [
|
||||
{
|
||||
"type": "type",
|
||||
"name": "string"
|
||||
},
|
||||
{
|
||||
"type": "mode",
|
||||
"name": "basic"
|
||||
},
|
||||
{
|
||||
"type": "property",
|
||||
"name": "mandatory"
|
||||
}
|
||||
],
|
||||
"descriptions": [
|
||||
"A dynamic variable."
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,26 @@
|
|||
# Variables for "Rougail"
|
||||
|
||||
| Variable | Description |
|
||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| **rougail.var**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A identifier variable.<br/>**Default**: <br/>- val1<br/>- val2 |
|
||||
|
||||
## A dynamic family
|
||||
|
||||
`basic`
|
||||
|
||||
This family builds families dynamically.
|
||||
|
||||
**Identifiers**: the value of the variable "rougail.var".
|
||||
|
||||
### A dynamic family
|
||||
|
||||
`basic`
|
||||
|
||||
This family builds families dynamically.
|
||||
|
||||
**Identifiers**: the value of the variable "rougail.var".
|
||||
|
||||
| Variable | Description |
|
||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| **rougail.*val1*.*val1*.var**<br/>**rougail.*val1*.*val2*.var**<br/>**rougail.*val2*.*val1*.var**<br/>**rougail.*val2*.*val2*.var**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A dynamic variable. |
|
||||
|
||||
|
|
@ -0,0 +1,50 @@
|
|||
|
||||
|
||||
[1;4;96mVariables for [0m[1;4;96m"Rougail"[0m
|
||||
|
||||
|
||||
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
|
||||
┃[1m [0m[1mVariable [0m[1m [0m┃[1m [0m[1mDescription [0m[1m [0m┃
|
||||
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
|
||||
│ [1mrougail.var[0m │ A identifier variable. │
|
||||
│ [1;7m string [0m [1;7m standard [0m [1;7m mandatory [0m [1;7m [0m │ [1mDefault[0m: │
|
||||
│ [1;7munique [0m [1;7m multiple [0m │ - val1 │
|
||||
│ │ - val2 │
|
||||
└───────────────────────────────────────┴──────────────────────────────────────┘
|
||||
|
||||
|
||||
[1;4;92mA dynamic family[0m
|
||||
|
||||
|
||||
[1;7m basic [0m
|
||||
|
||||
|
||||
This family builds families dynamically.
|
||||
|
||||
|
||||
[1mIdentifiers[0m: the value of the variable [32m"rougail.var"[0m.
|
||||
|
||||
|
||||
|
||||
|
||||
[1;4;38;5;46mA dynamic family[0m
|
||||
|
||||
|
||||
[1;7m basic [0m
|
||||
|
||||
|
||||
This family builds families dynamically.
|
||||
|
||||
|
||||
[1mIdentifiers[0m: the value of the variable [32m"rougail.var"[0m.
|
||||
|
||||
|
||||
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
|
||||
┃[1m [0m[1mVariable [0m[1m [0m┃[1m [0m[1mDescription [0m[1m [0m┃
|
||||
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
|
||||
│ [1mrougail.[0m[1;3mval1[0m[1m.[0m[1;3mval1[0m[1m.var[0m │ A dynamic variable. │
|
||||
│ [1mrougail.[0m[1;3mval1[0m[1m.[0m[1;3mval2[0m[1m.var[0m │ │
|
||||
│ [1mrougail.[0m[1;3mval2[0m[1m.[0m[1;3mval1[0m[1m.var[0m │ │
|
||||
│ [1mrougail.[0m[1;3mval2[0m[1m.[0m[1;3mval2[0m[1m.var[0m │ │
|
||||
│ [1;7m string [0m [1;7m basic [0m [1;7m mandatory [0m │ │
|
||||
└───────────────────────────────────────┴──────────────────────────────────────┘
|
||||
|
|
@ -0,0 +1,7 @@
|
|||
# Example with all variables modifiable
|
||||
|
||||
```yaml
|
||||
---
|
||||
rougail:
|
||||
var2: a_value
|
||||
```
|
||||
|
|
@ -0,0 +1,8 @@
|
|||
# Example with all variables modifiable
|
||||
|
||||
```yaml
|
||||
---
|
||||
rougail:
|
||||
var1:
|
||||
- 0
|
||||
```
|
||||
|
|
@ -0,0 +1,12 @@
|
|||
# Example with all variables modifiable
|
||||
|
||||
```yaml
|
||||
---
|
||||
rougail:
|
||||
leadership:
|
||||
- leader: example
|
||||
follower1:
|
||||
- example
|
||||
follower2:
|
||||
- value
|
||||
```
|
||||
|
|
@ -0,0 +1,10 @@
|
|||
# Example with all variables modifiable
|
||||
|
||||
```yaml
|
||||
---
|
||||
rougail:
|
||||
var1:
|
||||
- val1
|
||||
- val2
|
||||
var2: a value
|
||||
```
|
||||
|
|
@ -0,0 +1,35 @@
|
|||
# Example with mandatory variables not filled in
|
||||
|
||||
```yaml
|
||||
---
|
||||
rougail:
|
||||
val1:
|
||||
val1:
|
||||
var: example
|
||||
val2:
|
||||
var: example
|
||||
val2:
|
||||
val1:
|
||||
var: example
|
||||
val2:
|
||||
var: example
|
||||
```
|
||||
# Example with all variables modifiable
|
||||
|
||||
```yaml
|
||||
---
|
||||
rougail:
|
||||
var:
|
||||
- val1
|
||||
- val2
|
||||
val1:
|
||||
val1:
|
||||
var: example
|
||||
val2:
|
||||
var: example
|
||||
val2:
|
||||
val1:
|
||||
var: example
|
||||
val2:
|
||||
var: example
|
||||
```
|
||||
|
|
@ -14,7 +14,7 @@ excludes = [
|
|||
]
|
||||
|
||||
test_ok = get_structures_list(excludes)
|
||||
# test_ok = [Path('../rougail-tests/structures/60_6family_dynamic_suffix_auto_multi2')]
|
||||
# test_ok = [Path('../rougail-tests/structures/60_0family_dynamic_upper_char')]
|
||||
|
||||
|
||||
os.environ['COLUMNS'] = '80'
|
||||
|
|
|
|||
|
|
@ -19,6 +19,7 @@ def _test(modes):
|
|||
inventory = RougailOutputDoc(config, rougailconfig=rougailconfig)
|
||||
doc = inventory.run()[1]
|
||||
result_file = test_dir / f'mode_{"_".join(modes)}.adoc'
|
||||
print(result_file)
|
||||
if not result_file.is_file():
|
||||
with open(str(result_file), 'w') as docfh:
|
||||
docfh.write(doc)
|
||||
|
|
|
|||
Loading…
Reference in a new issue