fix: description for all calculations

locale/fr/LC_MESSAGES/rougail_output_doc.po

@@ -5,8 +5,8 @@
 msgid ""
 msgstr ""
 "Project-Id-Version: \n"
-"POT-Creation-Date: 2025-04-29 23:02+0200\n"
+"POT-Creation-Date: 2025-05-03 22:46+0200\n"
-"PO-Revision-Date: 2025-04-29 23:06+0200\n"
+"PO-Revision-Date: 2025-05-03 22:48+0200\n"
 "Last-Translator: \n"
 "Language-Team: \n"
 "Language: fr\n"
@@ -68,87 +68,91 @@ msgstr "vérifier le mode existe déjà"
 msgid "Generate document in format"
 msgstr "Générer le document au format"
 
-#: src/rougail/output_doc/doc.py:89
+#: src/rougail/output_doc/doc.py:90
 msgid "mandatory"
 msgstr "obligatoire"
 
-#: src/rougail/output_doc/doc.py:90
+#: src/rougail/output_doc/doc.py:91
 msgid "hidden"
 msgstr "cachée"
 
-#: src/rougail/output_doc/doc.py:91
+#: src/rougail/output_doc/doc.py:92
 msgid "disabled"
 msgstr "désactivé"
 
-#: src/rougail/output_doc/doc.py:92
+#: src/rougail/output_doc/doc.py:93
 msgid "unique"
 msgstr "unique"
 
-#: src/rougail/output_doc/doc.py:93
+#: src/rougail/output_doc/doc.py:94
 msgid "auto modified"
 msgstr "auto modifiée"
 
-#: src/rougail/output_doc/doc.py:307
+#: src/rougail/output_doc/doc.py:309
 msgid "This family contains lists of variable blocks."
 msgstr "Cette famille contient des listes de bloc de variable."
 
-#: src/rougail/output_doc/doc.py:315
+#: src/rougail/output_doc/doc.py:317
 msgid "This family builds families dynamically."
 msgstr "Cette famille construit des familles dynamiquement."
 
-#: src/rougail/output_doc/doc.py:345
+#: src/rougail/output_doc/doc.py:347
 msgid "multiple"
 msgstr "multiple"
 
-#: src/rougail/output_doc/doc.py:366
+#: src/rougail/output_doc/doc.py:368
 msgid "No attribute \"description\" for \"{0}\" in {1}"
 msgstr "Aucun attribut \"description\" pour \"{0}\" dans {1}"
 
-#: src/rougail/output_doc/doc.py:480
+#: src/rougail/output_doc/doc.py:482
 msgid "(default)"
 msgstr "(défaut)"
 
-#: src/rougail/output_doc/doc.py:487
+#: src/rougail/output_doc/doc.py:489
 msgid "text based with regular expressions \"{0}\""
 msgstr "texte avec expression rationnelle \"{0}\""
 
-#: src/rougail/output_doc/doc.py:574
+#: src/rougail/output_doc/doc.py:578
 msgid "depends on a calculation"
 msgstr "dépend d'un calcul"
 
-#: src/rougail/output_doc/doc.py:575
+#: src/rougail/output_doc/doc.py:579
 msgid "\"{0}\" is a calculation for {1} but has no description in {2}"
 msgstr "\"{0}\" est un calcul pour {1} mais n'a pas de description dans {2}"
 
-#: src/rougail/output_doc/doc.py:597
+#: src/rougail/output_doc/doc.py:600 src/rougail/output_doc/doc.py:670
 msgid "depends on an undocumented variable"
 msgstr "dépends d'une variable non documentée"
 
-#: src/rougail/output_doc/doc.py:599
+#: src/rougail/output_doc/doc.py:602
 msgid "when the variable \"{0}\" hasn't the value \"{1}\""
 msgstr "lorsque la variable \"{0}\" n'a pas la valeur \"{1}\""
 
-#: src/rougail/output_doc/doc.py:601
+#: src/rougail/output_doc/doc.py:604
 msgid "when the variable \"{0}\" has the value \"{1}\""
 msgstr "lorsque la variable \"{0}\" a la valeur \"{1}\""
 
-#: src/rougail/output_doc/doc.py:616
+#: src/rougail/output_doc/doc.py:619
 msgid "the value of the variable \"{0}\""
 msgstr "la valeur de la variable \"{0}\""
 
-#: src/rougail/output_doc/doc.py:617
+#: src/rougail/output_doc/doc.py:620
 msgid "the value of an undocumented variable"
 msgstr "la valeur d'une variable non documentée"
 
-#: src/rougail/output_doc/doc.py:648
+#: src/rougail/output_doc/doc.py:651
 msgid "the values of undocumented variables"
 msgstr "les valeurs de variables non documentées"
 
-#: src/rougail/output_doc/doc.py:655
+#: src/rougail/output_doc/doc.py:668
+msgid "{0} (from an undocumented variable)"
+msgstr "{0} (issu d'une variable non documentée)"
+
+#: src/rougail/output_doc/doc.py:679
 msgid "the value of the identifier"
 msgstr "la valeur de l'identifiant"
 
-#: src/rougail/output_doc/doc.py:659
+#: src/rougail/output_doc/doc.py:683
 msgid "the value of the {0}"
 msgstr "la valeur de l'{0}"
 

locale/rougail_output_doc.pot

@@ -5,7 +5,7 @@
 msgid ""
 msgstr ""
 "Project-Id-Version: PACKAGE VERSION\n"
-"POT-Creation-Date: 2025-04-29 23:06+0200\n"
+"POT-Creation-Date: 2025-05-03 22:48+0200\n"
 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language-Team: LANGUAGE <LL@li.org>\n"
@@ -67,87 +67,91 @@ msgstr ""
 msgid "Generate document in format"
 msgstr ""
 
-#: src/rougail/output_doc/doc.py:89
+#: src/rougail/output_doc/doc.py:90
 msgid "mandatory"
 msgstr ""
 
-#: src/rougail/output_doc/doc.py:90
+#: src/rougail/output_doc/doc.py:91
 msgid "hidden"
 msgstr ""
 
-#: src/rougail/output_doc/doc.py:91
+#: src/rougail/output_doc/doc.py:92
 msgid "disabled"
 msgstr ""
 
-#: src/rougail/output_doc/doc.py:92
+#: src/rougail/output_doc/doc.py:93
 msgid "unique"
 msgstr ""
 
-#: src/rougail/output_doc/doc.py:93
+#: src/rougail/output_doc/doc.py:94
 msgid "auto modified"
 msgstr ""
 
-#: src/rougail/output_doc/doc.py:307
+#: src/rougail/output_doc/doc.py:309
 msgid "This family contains lists of variable blocks."
 msgstr ""
 
-#: src/rougail/output_doc/doc.py:315
+#: src/rougail/output_doc/doc.py:317
 msgid "This family builds families dynamically."
 msgstr ""
 
-#: src/rougail/output_doc/doc.py:345
+#: src/rougail/output_doc/doc.py:347
 msgid "multiple"
 msgstr ""
 
-#: src/rougail/output_doc/doc.py:366
+#: src/rougail/output_doc/doc.py:368
 msgid "No attribute \"description\" for \"{0}\" in {1}"
 msgstr ""
 
-#: src/rougail/output_doc/doc.py:480
+#: src/rougail/output_doc/doc.py:482
 msgid "(default)"
 msgstr ""
 
-#: src/rougail/output_doc/doc.py:487
+#: src/rougail/output_doc/doc.py:489
 msgid "text based with regular expressions \"{0}\""
 msgstr ""
 
-#: src/rougail/output_doc/doc.py:574
+#: src/rougail/output_doc/doc.py:578
 msgid "depends on a calculation"
 msgstr ""
 
-#: src/rougail/output_doc/doc.py:575
+#: src/rougail/output_doc/doc.py:579
 msgid "\"{0}\" is a calculation for {1} but has no description in {2}"
 msgstr ""
 
-#: src/rougail/output_doc/doc.py:597
+#: src/rougail/output_doc/doc.py:600 src/rougail/output_doc/doc.py:670
 msgid "depends on an undocumented variable"
 msgstr ""
 
-#: src/rougail/output_doc/doc.py:599
+#: src/rougail/output_doc/doc.py:602
 msgid "when the variable \"{0}\" hasn't the value \"{1}\""
 msgstr ""
 
-#: src/rougail/output_doc/doc.py:601
+#: src/rougail/output_doc/doc.py:604
 msgid "when the variable \"{0}\" has the value \"{1}\""
 msgstr ""
 
-#: src/rougail/output_doc/doc.py:616
+#: src/rougail/output_doc/doc.py:619
 msgid "the value of the variable \"{0}\""
 msgstr ""
 
-#: src/rougail/output_doc/doc.py:617
+#: src/rougail/output_doc/doc.py:620
 msgid "the value of an undocumented variable"
 msgstr ""
 
-#: src/rougail/output_doc/doc.py:648
+#: src/rougail/output_doc/doc.py:651
 msgid "the values of undocumented variables"
 msgstr ""
 
-#: src/rougail/output_doc/doc.py:655
+#: src/rougail/output_doc/doc.py:668
+msgid "{0} (from an undocumented variable)"
+msgstr ""
+
+#: src/rougail/output_doc/doc.py:679
 msgid "the value of the identifier"
 msgstr ""
 
-#: src/rougail/output_doc/doc.py:659
+#: src/rougail/output_doc/doc.py:683
 msgid "the value of the {0}"
 msgstr ""
 

src/rougail/output_doc/annotator.py

@@ -188,7 +188,7 @@ class Annotator(Walk):
                 data = self._calculation_to_string(path, prop, val, version)
                 if data is None:
                     continue
-                if "type" in data:
+                if "type" in data or "description" in data:
                     one_is_calculation = True
                 datas.append(data)
             if one_is_calculation:
@@ -221,6 +221,8 @@ class Annotator(Walk):
     ):
         if not isinstance(values, Calculation):
             return {"value": values}
+        if values.description:
+            return {"description": values.description}
         if isinstance(values, JinjaCalculation):
             return {
                 "type": "jinja",

src/rougail/output_doc/doc.py

@@ -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 _
@@ -170,7 +171,7 @@ class RougailOutputDoc(Examples):
                 return True
 
             calculation = child.information.get(f"{hidden_property}_calculation", None)
-            if calculation and calculation['type'] == 'variable':
+            if calculation and calculation.get('type') == 'variable':
                 variable_path, value, condition = calculation["value"]
                 variable = self.conf.forcepermissive.option(variable_path)
                 try:
@@ -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
@@ -565,6 +569,11 @@ class RougailOutputDoc(Examples):
         return self._calculation_to_string(variable, calculation, prop)
 
     def _calculation_to_string(self, child, calculation, prop):
+        if "description" in calculation:
+            values = calculation["description"]
+            if not values.endswith("."):
+                values += "."
+            return values
         if "type" not in calculation:
             return calculation["value"]
         if calculation["type"] == "jinja":
@@ -587,7 +596,6 @@ class RougailOutputDoc(Examples):
                 try:
                     variable.value.get()
                 except AttributeError as err:
-                    pass
                     variable = None
                 else:
                     uncalculated = variable.value.get(uncalculated=True)
@@ -610,7 +618,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 +655,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 undocumented 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"]

tests/mode_basic.adoc

@@ -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** +

tests/mode_basic_advanced.adoc

@@ -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.               
 |====
 

tests/results/test/00_2default_calculated_params_permissive.adoc

@@ -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.               
+|====
+

tests/results/test/00_2default_calculated_params_permissive.json

@@ -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."
+    ]
+  }
+}

tests/results/test/00_2default_calculated_params_permissive.md

@@ -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.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
+

tests/results/test/00_2default_calculated_params_permissive.sh

@@ -0,0 +1,6 @@
+┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
+┃ Variable                              ┃ Description                          ┃
+┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
+│ var2                                  │ A second variable.                   │
+│  string   standard   mandatory        │ Default: depends on a calculation.   │
+└───────────────────────────────────────┴──────────────────────────────────────┘

tests/results/test/00_2default_calculated_variable_description.adoc

@@ -0,0 +1,16 @@
+[cols="1a,1a"]
+|====
+| Variable   | Description   
+| 
+
+**var1** +
+`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory`            | 
+A first variable.               
+| 
+
+**var2** +
+`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory`            | 
+A second variable. +
+**Default**: value of a variable!.               
+|====
+

tests/results/test/00_2default_calculated_variable_description.json

@@ -8,15 +8,11 @@
       },
       {
         "type": "mode",
-        "name": "standard"
+        "name": "basic"
       },
       {
         "type": "property",
-        "name": "unique"
+        "name": "mandatory"
-      },
-      {
-        "type": "multiple",
-        "name": "multiple"
       }
     ],
     "paths": [
@@ -26,15 +22,12 @@
       "var1"
     ],
     "descriptions": [
-      "A suffix variable."
+      "A first variable."
-    ],
-    "examples": [
-      "val1",
-      "val2"
     ]
   },
   "var2": {
     "type": "variable",
+    "default": "value of a variable!.",
     "properties": [
       {
         "type": "type",
@@ -56,7 +49,7 @@
       "var2"
     ],
     "descriptions": [
-      "A variable calculated."
+      "A second variable."
     ]
   }
 }

tests/results/test/00_2default_calculated_variable_description.md

@@ -0,0 +1,5 @@
+| Variable                                                                                                     | Description                                                                                                  |
+|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| **var1**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | A first variable.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
+| **var2**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | A second variable.<br/>**Default**: value of a variable!.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
+

tests/results/test/00_2default_calculated_variable_description.sh

@@ -0,0 +1,9 @@
+┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
+┃ Variable                              ┃ Description                          ┃
+┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
+│ var1                                  │ A first variable.                    │
+│  string   basic   mandatory           │                                      │
+├───────────────────────────────────────┼──────────────────────────────────────┤
+│ var2                                  │ A second variable.                   │
+│  string   standard   mandatory        │ Default: value of a variable!.       │
+└───────────────────────────────────────┴──────────────────────────────────────┘

tests/results/test/04_5validators_multi3.adoc

@@ -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               
+|====
+

tests/results/test/04_5validators_multi3.json

@@ -0,0 +1,47 @@
+{
+  "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": [
+      "var1"
+    ],
+    "names": [
+      "var1"
+    ],
+    "descriptions": [
+      "A second variable."
+    ],
+    "examples": [
+      0
+    ]
+  }
+}

tests/results/test/04_5validators_multi3.md

@@ -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                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+

tests/results/test/04_5validators_multi3.sh

@@ -0,0 +1,12 @@
+┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
+┃ Variable                              ┃ Description                          ┃
+┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
+│ var1                                  │ A second variable.                   │
+│  number   standard   mandatory        │ Validator: value must be equal to    │
+│ unique   multiple                     │ index.                               │
+│                                       │ Default:                             │
+│                                       │ - 0                                  │
+│                                       │ - 1                                  │
+│                                       │ - 2                                  │
+│                                       │ Example: 0                           │
+└───────────────────────────────────────┴──────────────────────────────────────┘

tests/results/test/40_6leadership_follower_multi_no_mandatory.adoc

@@ -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               
+|====
+

tests/results/test/40_6leadership_follower_multi_no_mandatory.json

@@ -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."
+        ]
+      }
+    }
+  }
+}

tests/results/test/40_6leadership_follower_multi_no_mandatory.md

@@ -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                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
+

tests/results/test/40_6leadership_follower_multi_no_mandatory.sh

@@ -0,0 +1,26 @@
+
+
+A leadership
+
+
+ basic 
+
+
+This family contains lists of variable blocks.
+
+
+┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
+┃ Variable                              ┃ Description                          ┃
+┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
+│ leadership.leader                     │ The leader.                          │
+│  string   standard   unique           │                                      │
+│ multiple                              │                                      │
+├───────────────────────────────────────┼──────────────────────────────────────┤
+│ leadership.follower1                  │ The first follower.                  │
+│  string   basic   mandatory           │                                      │
+│ multiple                              │                                      │
+├───────────────────────────────────────┼──────────────────────────────────────┤
+│ leadership.follower2                  │ The second follower.                 │
+│  string   standard   mandatory        │ Default: value                       │
+│ multiple                              │                                      │
+└───────────────────────────────────────┴──────────────────────────────────────┘

tests/results/test/60_0family_dynamic_forbidden_char.adoc

@@ -25,15 +25,15 @@ This family builds families dynamically.
 | Variable   | Description   
 | 
 
-**dyn__val.1__.var1** +
+**dyn__val_1__.var1** +
-**dyn__val.2__.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_1__.var2** +
-**dyn__val.2__.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.               

tests/results/test/60_0family_dynamic_forbidden_char.json

@@ -41,8 +41,8 @@
     "type": "dynamic",
     "informations": {
       "paths": [
-        "dynval.1",
+        "dynval_1",
-        "dynval.2"
+        "dynval_2"
       ],
       "names": [
         "dynval_1",
@@ -63,8 +63,8 @@
     "children": {
       "dyn{{ identifier }}.var1": {
         "paths": [
-          "dynval.1.var1",
+          "dynval_1.var1",
-          "dynval.2.var1"
+          "dynval_2.var1"
         ],
         "names": [
           "var1",
@@ -92,8 +92,8 @@
       },
       "dyn{{ identifier }}.var2": {
         "paths": [
-          "dynval.1.var2",
+          "dynval_1.var2",
-          "dynval.2.var2"
+          "dynval_2.var2"
         ],
         "names": [
           "var2",

tests/results/test/60_0family_dynamic_forbidden_char.md

@@ -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*.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*.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.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
 

tests/results/test/60_0family_dynamic_forbidden_char.sh

@@ -23,11 +23,11 @@ This family builds families dynamically.
 ┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
 ┃ Variable                              ┃ Description                          ┃
 ┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
-│ dynval.1.var1                         │ A dynamic variable.                  │
+│ dynval_1.var1                         │ A dynamic variable.                  │
-│ dynval.2.var1                         │ Default: the value of the            │
+│ dynval_2.var1                         │ Default: the value of the            │
 │  string   standard   mandatory        │ identifier.                          │
 ├───────────────────────────────────────┼──────────────────────────────────────┤
-│ dynval.1.var2                         │ A dynamic variable.                  │
+│ dynval_1.var2                         │ A dynamic variable.                  │
-│ dynval.2.var2                         │ Default: depends on a calculation.   │
+│ dynval_2.var2                         │ Default: depends on a calculation.   │
 │  string   standard   mandatory        │                                      │
 └───────────────────────────────────────┴──────────────────────────────────────┘

tests/results/test/60_0family_dynamic_upper_char.adoc

@@ -25,8 +25,8 @@ This family builds families dynamically.
 | Variable   | Description   
 | 
 
-**dyn__Val1__.var** +
+**dyn__val1__.var** +
-**dyn__VAL2__.var** +
+**dyn__val2__.var** +
 `https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory`            | 
 A dynamic variable.               
 |====

tests/results/test/60_0family_dynamic_upper_char.json

@@ -41,8 +41,8 @@
     "type": "dynamic",
     "informations": {
       "paths": [
-        "dynVal1",
+        "dynval1",
-        "dynVAL2"
+        "dynval2"
       ],
       "names": [
         "dynval1",
@@ -63,8 +63,8 @@
     "children": {
       "dyn{{ identifier }}.var": {
         "paths": [
-          "dynVal1.var",
+          "dynval1.var",
-          "dynVAL2.var"
+          "dynval2.var"
         ],
         "names": [
           "var",

tests/results/test/60_0family_dynamic_upper_char.md

@@ -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.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 

tests/results/test/60_0family_dynamic_upper_char.sh

@@ -23,7 +23,7 @@ This family builds families dynamically.
 ┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
 ┃ Variable                              ┃ Description                          ┃
 ┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
-│ dynVal1.var                           │ A dynamic variable.                  │
+│ dynval1.var                           │ A dynamic variable.                  │
-│ dynVAL2.var                           │                                      │
+│ dynval2.var                           │                                      │
 │  string   basic   mandatory           │                                      │
 └───────────────────────────────────────┴──────────────────────────────────────┘

tests/results/test/warnings_00_0empty

@@ -0,0 +1 @@
+[]

tests/results/test/warnings_00_0version_underscore

@@ -0,0 +1 @@
+[]

tests/results/test/warnings_00_1empty_variable

@@ -0,0 +1 @@
+["No attribute \"description\" for \"empty\" in \"../../rougail-tests/structures/00_1empty_variable/rougail/00-base.yml\""]

tests/results/test/warnings_00_2default_calculated

@@ -0,0 +1 @@
+[]

tests/results/test/warnings_00_2default_calculated_multi

@@ -0,0 +1 @@
+[]

tests/results/test/warnings_00_2default_calculated_params_permissive

@@ -0,0 +1 @@
+["\"default\" is a calculation for var2 but has no description in \"../../rougail-tests/structures/00_2default_calculated_params_permissive/rougail/00-base.yml\""]

tests/results/test/warnings_00_2default_calculated_variable_description

@@ -0,0 +1 @@
+[]

tests/results/test/warnings_00_2default_calculated_variable_transitive

@@ -0,0 +1 @@
+[]

tests/results/test/warnings_00_4load_subfolder

@@ -0,0 +1 @@
+[]

tests/results/test/warnings_00_5load_notype

@@ -0,0 +1 @@
+[]

tests/results/test/warnings_00_6boolean

@@ -0,0 +1 @@
+[]

tests/results/test/warnings_00_6boolean_no_mandatory

@@ -0,0 +1 @@
+[]

tests/results/test/warnings_00_6choice

@@ -0,0 +1 @@
+[]

tests/results/test/warnings_00_6choice_calculation

@@ -0,0 +1 @@
+[]

tests/results/test/warnings_00_6choice_link

@@ -0,0 +1 @@
+[]

tests/results/test/warnings_00_6choice_variable

@@ -0,0 +1 @@
+[]

tests/results/test/warnings_00_6choice_variable_link

@@ -0,0 +1 @@
+[]

tests/results/test/warnings_00_6choice_variable_link2

@@ -0,0 +1 @@
+["No attribute \"description\" for \"family\" in \"../../rougail-tests/structures/00_6choice_variable_link2/rougail/00-base.yml\""]

tests/results/test/warnings_00_6custom

@@ -0,0 +1 @@
+[]

tests/results/test/warnings_00_6domainname

@@ -0,0 +1 @@
+[]

tests/results/test/warnings_00_6domainname_params

@@ -0,0 +1 @@
+[]

tests/results/test/warnings_00_6float

@@ -0,0 +1 @@
+[]

tests/results/test/warnings_00_6number

@@ -0,0 +1 @@
+[]

tests/results/test/warnings_00_6port

@@ -0,0 +1 @@
+[]

tests/results/test/warnings_00_6regexp

@@ -0,0 +1 @@
+[]

tests/results/test/warnings_00_6regexp_link

@@ -0,0 +1 @@
+[]

tests/results/test/warnings_00_6secret

@@ -0,0 +1 @@
+[]

tests/results/test/warnings_00_6secret_param

@@ -0,0 +1 @@
+[]

tests/results/test/warnings_00_6string

@@ -0,0 +1 @@
+[]

tests/results/test/warnings_00_7choice_quote

@@ -0,0 +1 @@
+[]

tests/results/test/warnings_00_7help

@@ -0,0 +1 @@
+[]

tests/results/test/warnings_00_7help_quote

@@ -0,0 +1 @@
+[]

tests/results/test/warnings_00_7help_sup

@@ -0,0 +1 @@
+[]

tests/results/test/warnings_00_7value_doublequote

@@ -0,0 +1 @@
+[]

tests/results/test/warnings_00_7value_doublequote2

@@ -0,0 +1 @@
+[]

tests/results/test/warnings_00_7value_doublequote3

@@ -0,0 +1 @@
+[]

tests/results/test/warnings_00_7value_quote

@@ -0,0 +1 @@
+[]

tests/results/test/warnings_00_8calculation_information

@@ -0,0 +1 @@
+[]

tests/results/test/warnings_00_8test

@@ -0,0 +1 @@
+[]

tests/results/test/warnings_00_9choice_variable_multi

@@ -0,0 +1 @@
+[]

tests/results/test/warnings_00_9choice_variables

@@ -0,0 +1 @@
+[]

tests/results/test/warnings_00_9default_calculation

@@ -0,0 +1 @@
+[]

tests/results/test/warnings_00_9default_calculation_information

@@ -0,0 +1 @@
+[]

tests/results/test/warnings_00_9default_calculation_information_other_variable

@@ -0,0 +1 @@
+["\"default\" is a calculation for var2 but has no description in \"../../rougail-tests/structures/00_9default_calculation_information_other_variable/rougail/00-base.yml\""]

tests/results/test/warnings_00_9default_calculation_multi_optional

@@ -0,0 +1 @@
+["No attribute \"description\" for \"my_variable\" in \"../../rougail-tests/structures/00_9default_calculation_multi_optional/rougail/00-base.yml\"", "No attribute \"description\" for \"my_calculated_variable\" in \"../../rougail-tests/structures/00_9default_calculation_multi_optional/rougail/00-base.yml\""]

tests/results/test/warnings_00_9default_calculation_multi_optional2

@@ -0,0 +1 @@
+["No attribute \"description\" for \"my_variable\" in \"../../rougail-tests/structures/00_9default_calculation_multi_optional2/rougail/00-base.yml\"", "No attribute \"description\" for \"my_calculated_variable\" in \"../../rougail-tests/structures/00_9default_calculation_multi_optional2/rougail/00-base.yml\""]

tests/results/test/warnings_00_9default_calculation_optional

@@ -0,0 +1 @@
+["No attribute \"description\" for \"my_calculated_variable\" in \"../../rougail-tests/structures/00_9default_calculation_optional/rougail/00-base.yml\""]

tests/results/test/warnings_00_9default_calculation_optional_exists

@@ -0,0 +1 @@
+["No attribute \"description\" for \"my_variable\" in \"../../rougail-tests/structures/00_9default_calculation_optional_exists/rougail/00-base.yml\"", "No attribute \"description\" for \"my_calculated_variable\" in \"../../rougail-tests/structures/00_9default_calculation_optional_exists/rougail/00-base.yml\""]

tests/results/test/warnings_00_9default_calculation_param_optional

@@ -0,0 +1 @@
+[]

tests/results/test/warnings_00_9default_information_other_variable

@@ -0,0 +1 @@
+[]

tests/results/test/warnings_00_9default_information_other_variable2

@@ -0,0 +1 @@
+[]

tests/results/test/warnings_00_9default_integer

@@ -0,0 +1 @@
+[]

tests/results/test/warnings_01_6boolean_multi

@@ -0,0 +1 @@
+[]

tests/results/test/warnings_01_6custom_multi

@@ -0,0 +1 @@
+[]

tests/results/test/warnings_01_6float_multi

@@ -0,0 +1 @@
+[]

tests/results/test/warnings_01_6number_multi

@@ -0,0 +1 @@
+[]

tests/results/test/warnings_01_6string_empty

@@ -0,0 +1 @@
+[]

tests/results/test/warnings_01_6string_multi

@@ -0,0 +1 @@
+[]

tests/results/test/warnings_01_7value_multi_doublequote

@@ -0,0 +1 @@
+[]

tests/results/test/warnings_01_7value_multi_doublequote2

@@ -0,0 +1 @@
+[]

tests/results/test/warnings_01_7value_multi_quote

@@ -0,0 +1 @@
+[]

tests/results/test/warnings_01_8calculation_information_multi

@@ -0,0 +1 @@
+[]

tests/results/test/warnings_01_9choice_variable_multi

@@ -0,0 +1 @@
+[]

tests/results/test/warnings_04_0type_param

@@ -0,0 +1 @@
+[]

tests/results/test/warnings_04_1auto_save

@@ -0,0 +1 @@
+[]

tests/results/test/warnings_04_1auto_save_and_calculated

@@ -0,0 +1 @@
+[]

tests/results/test/warnings_04_1auto_save_and_calculated_hidden

@@ -0,0 +1 @@
+[]

tests/results/test/warnings_04_1auto_save_and_hidden

@@ -0,0 +1 @@
+[]

tests/results/test/warnings_04_1default_calculation_hidden

@@ -0,0 +1 @@
+["\"default\" is a calculation for var3 but has no description in \"../../rougail-tests/structures/04_1default_calculation_hidden/rougail/00-base.yml\""]