stove/rougail-output-doc
2
0
Fork 0
Code Issues 1 Pull requests Projects Releases Packages Wiki Activity

feat: personalise column number

Browse source
This commit is contained in:
egarette@silique.fr 2025-11-29 22:21:06 +01:00
parent 3cde479202
commit 7bfdbcc46b
7479 changed files with 38835 additions and 47406 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

147
README.md
View file

@ -1,43 +1,132 @@
# Generate documentation
# Générer la documentation
> **🛈 Informations**
>
> **<a id="doc" name="doc">doc</a>**\
> `basic` *`disabled`*\
> **Disabled**: when "[Generate documentation](#doc)" is not set in "[Select for output](#step.output)"
> `basic` *`désactivé`*\
> **Désactivé** : lorsque "[Générer la documentation](#doc)" n'est pas spécifié dans "[Sélection pour sortie](#step.output)"
| Variable&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; | Description&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **<a id="doc.title_level" name="doc.title_level">doc.title_level</a>**<br/>[`integer`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory`<br/>**Command line**: <a id="doc.title_level" name="doc.title_level">--doc.title_level</a>, -dt<br/>**Environment variable**: <a id="doc.title_level" name="doc.title_level">ROUGAILCLI_DOC.TITLE_LEVEL</a> | Starting title level.<br/>**Default**: 1 |
| **<a id="doc.contents" name="doc.contents">doc.contents</a>**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple`<br/>**Command line**: <a id="doc.contents" name="doc.contents">--doc.contents</a><br/>**Environment variable**: <a id="doc.contents" name="doc.contents">ROUGAILCLI_DOC.CONTENTS</a> | Generated content.<br/>**Choices**: <br/>• variables **← (default)**<br/>• example<br/>• changelog |
| **<a id="doc.previous_json_file" name="doc.previous_json_file">doc.previous_json_file</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` *`disabled`*<br/>**Command line**: <a id="doc.previous_json_file" name="doc.previous_json_file">--doc.previous_json_file</a><br/>**Environment variable**: <a id="doc.previous_json_file" name="doc.previous_json_file">ROUGAILCLI_DOC.PREVIOUS_JSON_FILE</a> | Previous description file in JSON format.<br/>**Disabled**: changelog is not selected in "[Generated content](#doc.contents)" |
| **<a id="doc.without_family" name="doc.without_family">doc.without_family</a>**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` *`disabled`*<br/>**Command line**: <br/>• <a id="doc.without_family" name="doc.without_family">--doc.without_family</a><br/>• <a id="doc.without_family" name="doc.without_family">--doc.no-without_family</a><br/>**Environment variable**: <a id="doc.without_family" name="doc.without_family">ROUGAILCLI_DOC.WITHOUT_FAMILY</a> | Do not add families in documentation.<br/>**Default**: false<br/>**Disabled**: variables is not selected in "[Generated content](#doc.contents)" |
| **<a id="doc.root" name="doc.root">doc.root</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard`<br/>**Command line**: <a id="doc.root" name="doc.root">--doc.root</a><br/>**Environment variable**: <a id="doc.root" name="doc.root">ROUGAILCLI_DOC.ROOT</a> | Document the variables from this family. |
| **<a id="doc.with_commandline" name="doc.with_commandline">doc.with_commandline</a>**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` *`disabled`*<br/>**Command line**: <br/>• <a id="doc.with_commandline" name="doc.with_commandline">--doc.with_commandline</a><br/>• <a id="doc.with_commandline" name="doc.with_commandline">--doc.no-with_commandline</a><br/>**Environment variable**: <a id="doc.with_commandline" name="doc.with_commandline">ROUGAILCLI_DOC.WITH_COMMANDLINE</a> | Add command line informations in documentation.<br/>**Default**: false<br/>**Disabled**: if "[Generate document in format](#doc.output_format)" is json or variables is not selected in "[Generated content](#doc.contents)" |
| **<a id="doc.with_environment" name="doc.with_environment">doc.with_environment</a>**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` *`disabled`*<br/>**Command line**: <br/>• <a id="doc.with_environment" name="doc.with_environment">--doc.with_environment</a><br/>• <a id="doc.with_environment" name="doc.with_environment">--doc.no-with_environment</a><br/>**Environment variable**: <a id="doc.with_environment" name="doc.with_environment">ROUGAILCLI_DOC.WITH_ENVIRONMENT</a> | Add environment variable informations in documentation.<br/>**Default**: false<br/>**Disabled**: if "[Generate document in format](#doc.output_format)" is json or variables is not selected in "[Generated content](#doc.contents)" |
| **<a id="doc.environment_default_environment_name" name="doc.environment_default_environment_name">doc.environment_default_environment_name</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` *`disabled`*<br/>**Command line**: <a id="doc.environment_default_environment_name" name="doc.environment_default_environment_name">--doc.environment_default_environment_name</a><br/>**Environment variable**: <a id="doc.environment_default_environment_name" name="doc.environment_default_environment_name">ROUGAILCLI_DOC.ENVIRONMENT_DEFAULT_ENVIRONMENT_NAME</a> | Name of the default environment prefix.<br/>**Validator**: should only user uppercase characters<br/>**Default**: ROUGAIL<br/>**Disabled**: when "__.main_namespace" is not set or "[Add environment variable informations in documentation](#doc.with_environment)" is false |
| Variable&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; | Description&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **<a id="doc.title_level" name="doc.title_level">doc.title_level</a>**<br/>`integer` `standard` `obligatoire`<br/>**Ligne de commande** : -dt, <a id="doc.title_level" name="doc.title_level">--doc.title_level</a><br/>**Variable d'environnement** : <a id="doc.title_level" name="doc.title_level">ROUGAILCLI_DOC.TITLE_LEVEL</a> | Niveau de titre de départ.<br/>**Défaut** : 1 |
| **<a id="doc.contents" name="doc.contents">doc.contents</a>**<br/>`choice` `multiple` `standard` `obligatoire` `unique`<br/>**Ligne de commande** : -dc, <a id="doc.contents" name="doc.contents">--doc.contents</a><br/>**Variable d'environnement** : <a id="doc.contents" name="doc.contents">ROUGAILCLI_DOC.CONTENTS</a> | Contenu générer.<br/>**Choix** : <br/>• variables **← (défaut)**<br/>• example<br/>• changelog |
| **<a id="doc.previous_json_file" name="doc.previous_json_file">doc.previous_json_file</a>**<br/>`string` `basic` `obligatoire` *`désactivé`*<br/>**Ligne de commande** : -dp, <a id="doc.previous_json_file" name="doc.previous_json_file">--doc.previous_json_file</a><br/>**Variable d'environnement** : <a id="doc.previous_json_file" name="doc.previous_json_file">ROUGAILCLI_DOC.PREVIOUS_JSON_FILE</a> | Précédent fichier de description au format JSON.<br/>**Désactivé** : changelog n'est pas sélectionné dans "[Contenu générer](#doc.contents)" |
| **<a id="doc.without_family" name="doc.without_family">doc.without_family</a>**<br/>`boolean` `standard` `obligatoire` *`désactivé`*<br/>**Ligne de commande** : <br/>• -df, <a id="doc.without_family" name="doc.without_family">--doc.without_family</a><br/>• -ndf, -- id="doc.without_family" name="doc.without_family">--doc.no-without_family</a><br/>**Variable d'environnement** : <a id="doc.without_family" name="doc.without_family">ROUGAILCLI_DOC.WITHOUT_FAMILY</a> | Ne pas ajouter les familles dans la documentation.<br/>**Défaut** : false<br/>**Désactivé** : if "[Générer le document au format](#doc.output_format)" is json or "[Contenu générer](#doc.contents)" hasn't variable or changelog |
| **<a id="doc.root" name="doc.root">doc.root</a>**<br/>`string` `standard`<br/>**Ligne de commande** : -dr, <a id="doc.root" name="doc.root">--doc.root</a><br/>**Variable d'environnement** : <a id="doc.root" name="doc.root">ROUGAILCLI_DOC.ROOT</a> | Documente les variables depuis cette famille. |
| **<a id="doc.with_commandline" name="doc.with_commandline">doc.with_commandline</a>**<br/>`boolean` `standard` `obligatoire` *`désactivé`*<br/>**Ligne de commande** : <br/>• -dw, <a id="doc.with_commandline" name="doc.with_commandline">--doc.with_commandline</a><br/>• -ndw, -- id="doc.with_commandline" name="doc.with_commandline">--doc.no-with_commandline</a><br/>**Variable d'environnement** : <a id="doc.with_commandline" name="doc.with_commandline">ROUGAILCLI_DOC.WITH_COMMANDLINE</a> | Ajoute les informations de la ligne de commande dans la documentation.<br/>**Défaut** : false<br/>**Désactivé** : if "[Générer le document au format](#doc.output_format)" is json or "[Contenu générer](#doc.contents)" hasn't variable or changelog |
| **<a id="doc.with_environment" name="doc.with_environment">doc.with_environment</a>**<br/>`boolean` `standard` `obligatoire` *`désactivé`*<br/>**Ligne de commande** : <br/>• -de, <a id="doc.with_environment" name="doc.with_environment">--doc.with_environment</a><br/>• -nde, -- id="doc.with_environment" name="doc.with_environment">--doc.no-with_environment</a><br/>**Variable d'environnement** : <a id="doc.with_environment" name="doc.with_environment">ROUGAILCLI_DOC.WITH_ENVIRONMENT</a> | Ajoute les informations de variable d&#x27;environnement dans la documentation.<br/>**Défaut** : false<br/>**Désactivé** : if "[Générer le document au format](#doc.output_format)" is json or "[Contenu générer](#doc.contents)" hasn't variable or changelog |
| **<a id="doc.environment_default_environment_name" name="doc.environment_default_environment_name">doc.environment_default_environment_name</a>**<br/>`string` `standard` `obligatoire` *`désactivé`*<br/>**Ligne de commande** : -dd, <a id="doc.environment_default_environment_name" name="doc.environment_default_environment_name">--doc.environment_default_environment_name</a><br/>**Variable d'environnement** : <a id="doc.environment_default_environment_name" name="doc.environment_default_environment_name">ROUGAILCLI_DOC.ENVIRONMENT_DEFAULT_ENVIRONMENT_NAME</a> | Nom du préfixe d&#x27;environnement par défaut.<br/>**Validateur** : doit seulement utilise des caractères en majuscule<br/>**Défaut** : ROUGAIL<br/>**Désactivé** : si "__.main_namespace" n'est pas défini ou "[Ajoute les informations de variable d&#x27;environnement dans la documentation](#doc.with_environment)" est false |
# Families or variables for this family are in an other file name
# Les familles ou variables pour cette famille sont dans un autre fichier
> **🛈 Informations**
>
> **<a id="doc.other_root_filenames" name="doc.other_root_filenames">doc.other_root_filenames</a>**\
> This family contains lists of variable blocks.\
> `basic` *`disabled`*\
> **Disabled**: documentation must be splitted
> Cette famille contient des listes de bloc de variable.\
> `basic` *`désactivé`*\
> **Désactivé** : documentation doit être séparée
| Variable&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; | Description&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **<a id="doc.other_root_filenames.root_path" name="doc.other_root_filenames.root_path">doc.other_root_filenames.root_path</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple`<br/>**Command line**: <a id="doc.other_root_filenames.root_path" name="doc.other_root_filenames.root_path">--doc.other_root_filenames.root_path</a><br/>**Environment variable**: <a id="doc.other_root_filenames.root_path" name="doc.other_root_filenames.root_path">ROUGAILCLI_DOC.OTHER_ROOT_FILENAMES.ROOT_PATH</a> | Root family name. |
| **<a id="doc.other_root_filenames.filename" name="doc.other_root_filenames.filename">doc.other_root_filenames.filename</a>**<br/>[`unix_filename`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory`<br/>**Command line**: <a id="doc.other_root_filenames.filename" name="doc.other_root_filenames.filename">--doc.other_root_filenames.filename</a><br/>**Environment variable**: <a id="doc.other_root_filenames.filename" name="doc.other_root_filenames.filename">ROUGAILCLI_DOC.OTHER_ROOT_FILENAMES.FILENAME</a> | Name of the file.<br/>**Validators**: <br/>• this filename could be a relative path<br/>• file type allowed: "directory" and "file" |
| Variable&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; | Description&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **<a id="doc.other_root_filenames.root_path" name="doc.other_root_filenames.root_path">doc.other_root_filenames.root_path</a>**<br/>`string` `multiple` `standard` `unique`<br/>**Ligne de commande** : <a id="doc.other_root_filenames.root_path" name="doc.other_root_filenames.root_path">--doc.other_root_filenames.root_path</a><br/>**Variable d'environnement** : <a id="doc.other_root_filenames.root_path" name="doc.other_root_filenames.root_path">ROUGAILCLI_DOC.OTHER_ROOT_FILENAMES.ROOT_PATH</a> | Nom de la famille racine. |
| **<a id="doc.other_root_filenames.filename" name="doc.other_root_filenames.filename">doc.other_root_filenames.filename</a>**<br/>`UNIX filename` `basic` `obligatoire`<br/>**Ligne de commande** : <a id="doc.other_root_filenames.filename" name="doc.other_root_filenames.filename">--doc.other_root_filenames.filename</a><br/>**Variable d'environnement** : <a id="doc.other_root_filenames.filename" name="doc.other_root_filenames.filename">ROUGAILCLI_DOC.OTHER_ROOT_FILENAMES.FILENAME</a> | Nom du fichier.<br/>**Validateurs** : <br/>• this filename could be a relative path<br/>• file type allowed: "fichier" et "répertoire" |
| Variable&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; | Description&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **<a id="doc.disabled_modes" name="doc.disabled_modes">doc.disabled_modes</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` *`disabled`* `unique` `multiple`<br/>**Command line**: <a id="doc.disabled_modes" name="doc.disabled_modes">--doc.disabled_modes</a><br/>**Environment variable**: <a id="doc.disabled_modes" name="doc.disabled_modes">ROUGAILCLI_DOC.DISABLED_MODES</a> | Disable documentation for variables with those modes.<br/>**Validator**: verify if disable modes already exists<br/>**Disabled**: disabled when there is no mode available |
| **<a id="doc.change_default_value" name="doc.change_default_value">doc.change_default_value</a>**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory`<br/>**Command line**: <br/>• <a id="doc.change_default_value" name="doc.change_default_value">--doc.change_default_value</a><br/>• <a id="doc.change_default_value" name="doc.change_default_value">--doc.no-change_default_value</a><br/>**Environment variable**: <a id="doc.change_default_value" name="doc.change_default_value">ROUGAILCLI_DOC.CHANGE_DEFAULT_VALUE</a> | Modify values to document leaderships and dynamics families.<br/>**Default**: true |
| **<a id="doc.comment_examples" name="doc.comment_examples">doc.comment_examples</a>**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` *`disabled`*<br/>**Command line**: <br/>• <a id="doc.comment_examples" name="doc.comment_examples">--doc.comment_examples</a><br/>• <a id="doc.comment_examples" name="doc.comment_examples">--doc.no-comment_examples</a><br/>**Environment variable**: <a id="doc.comment_examples" name="doc.comment_examples">ROUGAILCLI_DOC.COMMENT_EXAMPLES</a> | Add description of variables and families when generate examples.<br/>**Default**: false<br/>**Disabled**: disabled when example in not in contents |
| **<a id="doc.comment_examples_column" name="doc.comment_examples_column">doc.comment_examples_column</a>**<br/>[`integer`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` *`disabled`*<br/>**Command line**: <a id="doc.comment_examples_column" name="doc.comment_examples_column">--doc.comment_examples_column</a><br/>**Environment variable**: <a id="doc.comment_examples_column" name="doc.comment_examples_column">ROUGAILCLI_DOC.COMMENT_EXAMPLES_COLUMN</a> | Comment in examples starts at column.<br/>**Default**: 30<br/>**Disabled**: when the variable "[Add description of variables and families when generate examples](#doc.comment_examples)" is accessible and has the value "false" |
| **<a id="doc.output_format" name="doc.output_format">doc.output_format</a>**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory`<br/>**Command line**: <a id="doc.output_format" name="doc.output_format">--doc.output_format</a>, -do<br/>**Environment variable**: <a id="doc.output_format" name="doc.output_format">ROUGAILCLI_DOC.OUTPUT_FORMAT</a> | Generate document in format.<br/>**Validator**: json output_format is not compatible with "changelog" and "example" contents<br/>**Choices**: <br/>• console **← (default)**<br/>• asciidoc<br/>• html<br/>• github<br/>• gitlab<br/>• json |
| **<a id="doc.force_true_color_terminal" name="doc.force_true_color_terminal">doc.force_true_color_terminal</a>**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory`<br/>**Command line**: <br/>• <a id="doc.force_true_color_terminal" name="doc.force_true_color_terminal">--doc.force_true_color_terminal</a><br/>• <a id="doc.force_true_color_terminal" name="doc.force_true_color_terminal">--doc.no-force_true_color_terminal</a><br/>**Environment variable**: <a id="doc.force_true_color_terminal" name="doc.force_true_color_terminal">ROUGAILCLI_DOC.FORCE_TRUE_COLOR_TERMINAL</a> | Force true color terminal.<br/>**Default**: false |
| Variable&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; | Description&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **<a id="doc.disabled_modes" name="doc.disabled_modes">doc.disabled_modes</a>**<br/>`string` `multiple` `standard` *`désactivé`* `unique`<br/>**Ligne de commande** : <a id="doc.disabled_modes" name="doc.disabled_modes">--doc.disabled_modes</a><br/>**Variable d'environnement** : <a id="doc.disabled_modes" name="doc.disabled_modes">ROUGAILCLI_DOC.DISABLED_MODES</a> | Désactiver la documentation des variables avec ces modes.<br/>**Validateur** : vérifier le mode existe déjà<br/>**Désactivé** : désactiver lorsqu'il n'y a pas de mode valable |
| **<a id="doc.change_default_value" name="doc.change_default_value">doc.change_default_value</a>**<br/>`boolean` `standard` `obligatoire`<br/>**Ligne de commande** : <br/>• <a id="doc.change_default_value" name="doc.change_default_value">--doc.change_default_value</a><br/>• -- id="doc.change_default_value" name="doc.change_default_value">--doc.no-change_default_value</a><br/>**Variable d'environnement** : <a id="doc.change_default_value" name="doc.change_default_value">ROUGAILCLI_DOC.CHANGE_DEFAULT_VALUE</a> | Valeurs modifiées pour documenter les familles leader ou dynamique.<br/>**Défaut** : true |
| **<a id="doc.comment_examples" name="doc.comment_examples">doc.comment_examples</a>**<br/>`boolean` `standard` `obligatoire` *`désactivé`*<br/>**Ligne de commande** : <br/>• -dx, <a id="doc.comment_examples" name="doc.comment_examples">--doc.comment_examples</a><br/>• -ndx, -- id="doc.comment_examples" name="doc.comment_examples">--doc.no-comment_examples</a><br/>**Variable d'environnement** : <a id="doc.comment_examples" name="doc.comment_examples">ROUGAILCLI_DOC.COMMENT_EXAMPLES</a> | Ajouter la description des variables et des familles lorsqu&#x27;on génère des exemples.<br/>**Défaut** : false<br/>**Désactivé** : désactiver lorsqu'il example n'est pas dans contents |
| **<a id="doc.comment_examples_column" name="doc.comment_examples_column">doc.comment_examples_column</a>**<br/>`integer` `standard` `obligatoire` *`désactivé`*<br/>**Ligne de commande** : <a id="doc.comment_examples_column" name="doc.comment_examples_column">--doc.comment_examples_column</a><br/>**Variable d'environnement** : <a id="doc.comment_examples_column" name="doc.comment_examples_column">ROUGAILCLI_DOC.COMMENT_EXAMPLES_COLUMN</a> | Commentaire dans les exemples commence à la colonne.<br/>**Défaut** : 30<br/>**Désactivé** : lorsque la variable "[Ajouter la description des variables et des familles lorsqu&#x27;on génère des exemples](#doc.comment_examples)" est accessible et a la valeur "false" |
| **<a id="doc.output_format" name="doc.output_format">doc.output_format</a>**<br/>`choice` `standard` `obligatoire`<br/>**Ligne de commande** : -do, <a id="doc.output_format" name="doc.output_format">--doc.output_format</a><br/>**Variable d'environnement** : <a id="doc.output_format" name="doc.output_format">ROUGAILCLI_DOC.OUTPUT_FORMAT</a> | Générer le document au format.<br/>**Validateur** : le format de sortie json n'est pas compatible avec "changelog" et example" de la variable contents<br/>**Choix** : <br/>• console **← (défaut)**<br/>• asciidoc<br/>• html<br/>• github<br/>• gitlab<br/>• json |
| **<a id="doc.table_model" name="doc.table_model">doc.table_model</a>**<br/>`choice` `standard` `obligatoire`<br/>**Ligne de commande** : -dm, <a id="doc.table_model" name="doc.table_model">--doc.table_model</a><br/>**Variable d'environnement** : <a id="doc.table_model" name="doc.table_model">ROUGAILCLI_DOC.TABLE_MODEL</a> | Generate document inside table model.<br/>**Validateur** : le format de sortie json n'est pas compatible avec "changelog" et example" de la variable contents<br/>**Choix** : <br/>• two_columns **← (défaut)**<br/>• three_columns<br/>• four_columns |
| **<a id="doc.force_true_color_terminal" name="doc.force_true_color_terminal">doc.force_true_color_terminal</a>**<br/>`boolean` `standard` `obligatoire`<br/>**Ligne de commande** : <br/>• <a id="doc.force_true_color_terminal" name="doc.force_true_color_terminal">--doc.force_true_color_terminal</a><br/>• -- id="doc.force_true_color_terminal" name="doc.force_true_color_terminal">--doc.no-force_true_color_terminal</a><br/>**Variable d'environnement** : <a id="doc.force_true_color_terminal" name="doc.force_true_color_terminal">ROUGAILCLI_DOC.FORCE_TRUE_COLOR_TERMINAL</a> | Force les vrais couleurs dans le terminal.<br/>**Défaut** : false |
# Générer la documentation
> **🛈 Informations**
>
> **<a id="doc" name="doc">doc</a>**\
> `basic` *`désactivé`*\
> **Désactivé** : lorsque "[Générer la documentation](#doc)" n'est pas spécifié dans "[Sélection pour sortie](#step.output)"
| Variable&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; | Description&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; | Default value&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **<a id="doc.title_level" name="doc.title_level">doc.title_level</a>**<br/>`integer` `standard` `obligatoire`<br/>**Ligne de commande** : -dt, <a id="doc.title_level" name="doc.title_level">--doc.title_level</a><br/>**Variable d'environnement** : <a id="doc.title_level" name="doc.title_level">ROUGAILCLI_DOC.TITLE_LEVEL</a> | Niveau de titre de départ. | 1 |
| **<a id="doc.contents" name="doc.contents">doc.contents</a>**<br/>`choice` `multiple` `standard` `obligatoire` `unique`<br/>**Ligne de commande** : -dc, <a id="doc.contents" name="doc.contents">--doc.contents</a><br/>**Variable d'environnement** : <a id="doc.contents" name="doc.contents">ROUGAILCLI_DOC.CONTENTS</a> | Contenu générer.<br/>**Choix** : <br/>• variables<br/>• example<br/>• changelog | <br/>• variables |
| **<a id="doc.previous_json_file" name="doc.previous_json_file">doc.previous_json_file</a>**<br/>`string` `basic` `obligatoire` *`désactivé`*<br/>**Ligne de commande** : -dp, <a id="doc.previous_json_file" name="doc.previous_json_file">--doc.previous_json_file</a><br/>**Variable d'environnement** : <a id="doc.previous_json_file" name="doc.previous_json_file">ROUGAILCLI_DOC.PREVIOUS_JSON_FILE</a> | Précédent fichier de description au format JSON.<br/>**Désactivé** : changelog n'est pas sélectionné dans "[Contenu générer](#doc.contents)" | |
| **<a id="doc.without_family" name="doc.without_family">doc.without_family</a>**<br/>`boolean` `standard` `obligatoire` *`désactivé`*<br/>**Ligne de commande** : <br/>• -df, <a id="doc.without_family" name="doc.without_family">--doc.without_family</a><br/>• -ndf, -- id="doc.without_family" name="doc.without_family">--doc.no-without_family</a><br/>**Variable d'environnement** : <a id="doc.without_family" name="doc.without_family">ROUGAILCLI_DOC.WITHOUT_FAMILY</a> | Ne pas ajouter les familles dans la documentation.<br/>**Désactivé** : if "[Générer le document au format](#doc.output_format)" is json or "[Contenu générer](#doc.contents)" hasn't variable or changelog | false |
| **<a id="doc.root" name="doc.root">doc.root</a>**<br/>`string` `standard`<br/>**Ligne de commande** : -dr, <a id="doc.root" name="doc.root">--doc.root</a><br/>**Variable d'environnement** : <a id="doc.root" name="doc.root">ROUGAILCLI_DOC.ROOT</a> | Documente les variables depuis cette famille. | |
| **<a id="doc.with_commandline" name="doc.with_commandline">doc.with_commandline</a>**<br/>`boolean` `standard` `obligatoire` *`désactivé`*<br/>**Ligne de commande** : <br/>• -dw, <a id="doc.with_commandline" name="doc.with_commandline">--doc.with_commandline</a><br/>• -ndw, -- id="doc.with_commandline" name="doc.with_commandline">--doc.no-with_commandline</a><br/>**Variable d'environnement** : <a id="doc.with_commandline" name="doc.with_commandline">ROUGAILCLI_DOC.WITH_COMMANDLINE</a> | Ajoute les informations de la ligne de commande dans la documentation.<br/>**Désactivé** : if "[Générer le document au format](#doc.output_format)" is json or "[Contenu générer](#doc.contents)" hasn't variable or changelog | false |
| **<a id="doc.with_environment" name="doc.with_environment">doc.with_environment</a>**<br/>`boolean` `standard` `obligatoire` *`désactivé`*<br/>**Ligne de commande** : <br/>• -de, <a id="doc.with_environment" name="doc.with_environment">--doc.with_environment</a><br/>• -nde, -- id="doc.with_environment" name="doc.with_environment">--doc.no-with_environment</a><br/>**Variable d'environnement** : <a id="doc.with_environment" name="doc.with_environment">ROUGAILCLI_DOC.WITH_ENVIRONMENT</a> | Ajoute les informations de variable d&#x27;environnement dans la documentation.<br/>**Désactivé** : if "[Générer le document au format](#doc.output_format)" is json or "[Contenu générer](#doc.contents)" hasn't variable or changelog | false |
| **<a id="doc.environment_default_environment_name" name="doc.environment_default_environment_name">doc.environment_default_environment_name</a>**<br/>`string` `standard` `obligatoire` *`désactivé`*<br/>**Ligne de commande** : -dd, <a id="doc.environment_default_environment_name" name="doc.environment_default_environment_name">--doc.environment_default_environment_name</a><br/>**Variable d'environnement** : <a id="doc.environment_default_environment_name" name="doc.environment_default_environment_name">ROUGAILCLI_DOC.ENVIRONMENT_DEFAULT_ENVIRONMENT_NAME</a> | Nom du préfixe d&#x27;environnement par défaut.<br/>**Validateur** : doit seulement utilise des caractères en majuscule<br/>**Désactivé** : si "__.main_namespace" n'est pas défini ou "[Ajoute les informations de variable d&#x27;environnement dans la documentation](#doc.with_environment)" est false | ROUGAIL |
# Les familles ou variables pour cette famille sont dans un autre fichier
> **🛈 Informations**
>
> **<a id="doc.other_root_filenames" name="doc.other_root_filenames">doc.other_root_filenames</a>**\
> Cette famille contient des listes de bloc de variable.\
> `basic` *`désactivé`*\
> **Désactivé** : documentation doit être séparée
| Variable&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; | Description&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; | Default value&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **<a id="doc.other_root_filenames.root_path" name="doc.other_root_filenames.root_path">doc.other_root_filenames.root_path</a>**<br/>`string` `multiple` `standard` `unique`<br/>**Ligne de commande** : <a id="doc.other_root_filenames.root_path" name="doc.other_root_filenames.root_path">--doc.other_root_filenames.root_path</a><br/>**Variable d'environnement** : <a id="doc.other_root_filenames.root_path" name="doc.other_root_filenames.root_path">ROUGAILCLI_DOC.OTHER_ROOT_FILENAMES.ROOT_PATH</a> | Nom de la famille racine. | |
| **<a id="doc.other_root_filenames.filename" name="doc.other_root_filenames.filename">doc.other_root_filenames.filename</a>**<br/>`UNIX filename` `basic` `obligatoire`<br/>**Ligne de commande** : <a id="doc.other_root_filenames.filename" name="doc.other_root_filenames.filename">--doc.other_root_filenames.filename</a><br/>**Variable d'environnement** : <a id="doc.other_root_filenames.filename" name="doc.other_root_filenames.filename">ROUGAILCLI_DOC.OTHER_ROOT_FILENAMES.FILENAME</a> | Nom du fichier.<br/>**Validateurs** : <br/>• this filename could be a relative path<br/>• file type allowed: "fichier" et "répertoire" | |
| Variable&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; | Description&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; | Default value&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **<a id="doc.disabled_modes" name="doc.disabled_modes">doc.disabled_modes</a>**<br/>`string` `multiple` `standard` *`désactivé`* `unique`<br/>**Ligne de commande** : <a id="doc.disabled_modes" name="doc.disabled_modes">--doc.disabled_modes</a><br/>**Variable d'environnement** : <a id="doc.disabled_modes" name="doc.disabled_modes">ROUGAILCLI_DOC.DISABLED_MODES</a> | Désactiver la documentation des variables avec ces modes.<br/>**Validateur** : vérifier le mode existe déjà<br/>**Désactivé** : désactiver lorsqu'il n'y a pas de mode valable | |
| **<a id="doc.change_default_value" name="doc.change_default_value">doc.change_default_value</a>**<br/>`boolean` `standard` `obligatoire`<br/>**Ligne de commande** : <br/>• <a id="doc.change_default_value" name="doc.change_default_value">--doc.change_default_value</a><br/>• -- id="doc.change_default_value" name="doc.change_default_value">--doc.no-change_default_value</a><br/>**Variable d'environnement** : <a id="doc.change_default_value" name="doc.change_default_value">ROUGAILCLI_DOC.CHANGE_DEFAULT_VALUE</a> | Valeurs modifiées pour documenter les familles leader ou dynamique. | true |
| **<a id="doc.comment_examples" name="doc.comment_examples">doc.comment_examples</a>**<br/>`boolean` `standard` `obligatoire` *`désactivé`*<br/>**Ligne de commande** : <br/>• -dx, <a id="doc.comment_examples" name="doc.comment_examples">--doc.comment_examples</a><br/>• -ndx, -- id="doc.comment_examples" name="doc.comment_examples">--doc.no-comment_examples</a><br/>**Variable d'environnement** : <a id="doc.comment_examples" name="doc.comment_examples">ROUGAILCLI_DOC.COMMENT_EXAMPLES</a> | Ajouter la description des variables et des familles lorsqu&#x27;on génère des exemples.<br/>**Désactivé** : désactiver lorsqu'il example n'est pas dans contents | false |
| **<a id="doc.comment_examples_column" name="doc.comment_examples_column">doc.comment_examples_column</a>**<br/>`integer` `standard` `obligatoire` *`désactivé`*<br/>**Ligne de commande** : <a id="doc.comment_examples_column" name="doc.comment_examples_column">--doc.comment_examples_column</a><br/>**Variable d'environnement** : <a id="doc.comment_examples_column" name="doc.comment_examples_column">ROUGAILCLI_DOC.COMMENT_EXAMPLES_COLUMN</a> | Commentaire dans les exemples commence à la colonne.<br/>**Désactivé** : lorsque la variable "[Ajouter la description des variables et des familles lorsqu&#x27;on génère des exemples](#doc.comment_examples)" est accessible et a la valeur "false" | 30 |
| **<a id="doc.output_format" name="doc.output_format">doc.output_format</a>**<br/>`choice` `standard` `obligatoire`<br/>**Ligne de commande** : -do, <a id="doc.output_format" name="doc.output_format">--doc.output_format</a><br/>**Variable d'environnement** : <a id="doc.output_format" name="doc.output_format">ROUGAILCLI_DOC.OUTPUT_FORMAT</a> | Générer le document au format.<br/>**Validateur** : le format de sortie json n'est pas compatible avec "changelog" et example" de la variable contents<br/>**Choix** : <br/>• console<br/>• asciidoc<br/>• html<br/>• github<br/>• gitlab<br/>• json | console |
| **<a id="doc.table_model" name="doc.table_model">doc.table_model</a>**<br/>`choice` `standard` `obligatoire`<br/>**Ligne de commande** : -dm, <a id="doc.table_model" name="doc.table_model">--doc.table_model</a><br/>**Variable d'environnement** : <a id="doc.table_model" name="doc.table_model">ROUGAILCLI_DOC.TABLE_MODEL</a> | Generate document inside table model.<br/>**Validateur** : le format de sortie json n'est pas compatible avec "changelog" et example" de la variable contents<br/>**Choix** : <br/>• two_columns<br/>• three_columns<br/>• four_columns | two_columns |
| **<a id="doc.force_true_color_terminal" name="doc.force_true_color_terminal">doc.force_true_color_terminal</a>**<br/>`boolean` `standard` `obligatoire`<br/>**Ligne de commande** : <br/>• <a id="doc.force_true_color_terminal" name="doc.force_true_color_terminal">--doc.force_true_color_terminal</a><br/>• -- id="doc.force_true_color_terminal" name="doc.force_true_color_terminal">--doc.no-force_true_color_terminal</a><br/>**Variable d'environnement** : <a id="doc.force_true_color_terminal" name="doc.force_true_color_terminal">ROUGAILCLI_DOC.FORCE_TRUE_COLOR_TERMINAL</a> | Force les vrais couleurs dans le terminal. | false |
# Générer la documentation
> **🛈 Informations**
>
> **<a id="doc" name="doc">doc</a>**\
> `basic` *`désactivé`*\
> **Désactivé** : lorsque "[Générer la documentation](#doc)" n'est pas spécifié dans "[Sélection pour sortie](#step.output)"
| Variable&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; | Description&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; | Default value&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; | Type&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **<a id="doc.title_level" name="doc.title_level">doc.title_level</a>**<br/>`standard` `obligatoire`<br/>**Ligne de commande** : -dt, <a id="doc.title_level" name="doc.title_level">--doc.title_level</a><br/>**Variable d'environnement** : <a id="doc.title_level" name="doc.title_level">ROUGAILCLI_DOC.TITLE_LEVEL</a> | Niveau de titre de départ. | 1 | `integer` |
| **<a id="doc.contents" name="doc.contents">doc.contents</a>**<br/>`standard` `obligatoire` `unique`<br/>**Ligne de commande** : -dc, <a id="doc.contents" name="doc.contents">--doc.contents</a><br/>**Variable d'environnement** : <a id="doc.contents" name="doc.contents">ROUGAILCLI_DOC.CONTENTS</a> | Contenu générer. | <br/>• variables | `choice` `multiple`<br/>**Choix** : <br/>• variables<br/>• example<br/>• changelog |
| **<a id="doc.previous_json_file" name="doc.previous_json_file">doc.previous_json_file</a>**<br/>`basic` `obligatoire` *`désactivé`*<br/>**Ligne de commande** : -dp, <a id="doc.previous_json_file" name="doc.previous_json_file">--doc.previous_json_file</a><br/>**Variable d'environnement** : <a id="doc.previous_json_file" name="doc.previous_json_file">ROUGAILCLI_DOC.PREVIOUS_JSON_FILE</a> | Précédent fichier de description au format JSON.<br/>**Désactivé** : changelog n'est pas sélectionné dans "[Contenu générer](#doc.contents)" | | `string` |
| **<a id="doc.without_family" name="doc.without_family">doc.without_family</a>**<br/>`standard` `obligatoire` *`désactivé`*<br/>**Ligne de commande** : <br/>• -df, <a id="doc.without_family" name="doc.without_family">--doc.without_family</a><br/>• -ndf, -- id="doc.without_family" name="doc.without_family">--doc.no-without_family</a><br/>**Variable d'environnement** : <a id="doc.without_family" name="doc.without_family">ROUGAILCLI_DOC.WITHOUT_FAMILY</a> | Ne pas ajouter les familles dans la documentation.<br/>**Désactivé** : if "[Générer le document au format](#doc.output_format)" is json or "[Contenu générer](#doc.contents)" hasn't variable or changelog | false | `boolean` |
| **<a id="doc.root" name="doc.root">doc.root</a>**<br/>`standard`<br/>**Ligne de commande** : -dr, <a id="doc.root" name="doc.root">--doc.root</a><br/>**Variable d'environnement** : <a id="doc.root" name="doc.root">ROUGAILCLI_DOC.ROOT</a> | Documente les variables depuis cette famille. | | `string` |
| **<a id="doc.with_commandline" name="doc.with_commandline">doc.with_commandline</a>**<br/>`standard` `obligatoire` *`désactivé`*<br/>**Ligne de commande** : <br/>• -dw, <a id="doc.with_commandline" name="doc.with_commandline">--doc.with_commandline</a><br/>• -ndw, -- id="doc.with_commandline" name="doc.with_commandline">--doc.no-with_commandline</a><br/>**Variable d'environnement** : <a id="doc.with_commandline" name="doc.with_commandline">ROUGAILCLI_DOC.WITH_COMMANDLINE</a> | Ajoute les informations de la ligne de commande dans la documentation.<br/>**Désactivé** : if "[Générer le document au format](#doc.output_format)" is json or "[Contenu générer](#doc.contents)" hasn't variable or changelog | false | `boolean` |
| **<a id="doc.with_environment" name="doc.with_environment">doc.with_environment</a>**<br/>`standard` `obligatoire` *`désactivé`*<br/>**Ligne de commande** : <br/>• -de, <a id="doc.with_environment" name="doc.with_environment">--doc.with_environment</a><br/>• -nde, -- id="doc.with_environment" name="doc.with_environment">--doc.no-with_environment</a><br/>**Variable d'environnement** : <a id="doc.with_environment" name="doc.with_environment">ROUGAILCLI_DOC.WITH_ENVIRONMENT</a> | Ajoute les informations de variable d&#x27;environnement dans la documentation.<br/>**Désactivé** : if "[Générer le document au format](#doc.output_format)" is json or "[Contenu générer](#doc.contents)" hasn't variable or changelog | false | `boolean` |
| **<a id="doc.environment_default_environment_name" name="doc.environment_default_environment_name">doc.environment_default_environment_name</a>**<br/>`standard` `obligatoire` *`désactivé`*<br/>**Ligne de commande** : -dd, <a id="doc.environment_default_environment_name" name="doc.environment_default_environment_name">--doc.environment_default_environment_name</a><br/>**Variable d'environnement** : <a id="doc.environment_default_environment_name" name="doc.environment_default_environment_name">ROUGAILCLI_DOC.ENVIRONMENT_DEFAULT_ENVIRONMENT_NAME</a> | Nom du préfixe d&#x27;environnement par défaut.<br/>**Validateur** : doit seulement utilise des caractères en majuscule<br/>**Désactivé** : si "__.main_namespace" n'est pas défini ou "[Ajoute les informations de variable d&#x27;environnement dans la documentation](#doc.with_environment)" est false | ROUGAIL | `string` |
# Les familles ou variables pour cette famille sont dans un autre fichier
> **🛈 Informations**
>
> **<a id="doc.other_root_filenames" name="doc.other_root_filenames">doc.other_root_filenames</a>**\
> Cette famille contient des listes de bloc de variable.\
> `basic` *`désactivé`*\
> **Désactivé** : documentation doit être séparée
| Variable&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; | Description&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; | Default value&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; | Type&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **<a id="doc.other_root_filenames.root_path" name="doc.other_root_filenames.root_path">doc.other_root_filenames.root_path</a>**<br/>`standard` `unique`<br/>**Ligne de commande** : <a id="doc.other_root_filenames.root_path" name="doc.other_root_filenames.root_path">--doc.other_root_filenames.root_path</a><br/>**Variable d'environnement** : <a id="doc.other_root_filenames.root_path" name="doc.other_root_filenames.root_path">ROUGAILCLI_DOC.OTHER_ROOT_FILENAMES.ROOT_PATH</a> | Nom de la famille racine. | | `string` `multiple` |
| **<a id="doc.other_root_filenames.filename" name="doc.other_root_filenames.filename">doc.other_root_filenames.filename</a>**<br/>`basic` `obligatoire`<br/>**Ligne de commande** : <a id="doc.other_root_filenames.filename" name="doc.other_root_filenames.filename">--doc.other_root_filenames.filename</a><br/>**Variable d'environnement** : <a id="doc.other_root_filenames.filename" name="doc.other_root_filenames.filename">ROUGAILCLI_DOC.OTHER_ROOT_FILENAMES.FILENAME</a> | Nom du fichier.<br/>**Validateurs** : <br/>• this filename could be a relative path<br/>• file type allowed: "fichier" et "répertoire" | | `UNIX filename` |
| Variable&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; | Description&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; | Default value&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; | Type&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **<a id="doc.disabled_modes" name="doc.disabled_modes">doc.disabled_modes</a>**<br/>`standard` *`désactivé`* `unique`<br/>**Ligne de commande** : <a id="doc.disabled_modes" name="doc.disabled_modes">--doc.disabled_modes</a><br/>**Variable d'environnement** : <a id="doc.disabled_modes" name="doc.disabled_modes">ROUGAILCLI_DOC.DISABLED_MODES</a> | Désactiver la documentation des variables avec ces modes.<br/>**Validateur** : vérifier le mode existe déjà<br/>**Désactivé** : désactiver lorsqu'il n'y a pas de mode valable | | `string` `multiple` |
| **<a id="doc.change_default_value" name="doc.change_default_value">doc.change_default_value</a>**<br/>`standard` `obligatoire`<br/>**Ligne de commande** : <br/>• <a id="doc.change_default_value" name="doc.change_default_value">--doc.change_default_value</a><br/>• -- id="doc.change_default_value" name="doc.change_default_value">--doc.no-change_default_value</a><br/>**Variable d'environnement** : <a id="doc.change_default_value" name="doc.change_default_value">ROUGAILCLI_DOC.CHANGE_DEFAULT_VALUE</a> | Valeurs modifiées pour documenter les familles leader ou dynamique. | true | `boolean` |
| **<a id="doc.comment_examples" name="doc.comment_examples">doc.comment_examples</a>**<br/>`standard` `obligatoire` *`désactivé`*<br/>**Ligne de commande** : <br/>• -dx, <a id="doc.comment_examples" name="doc.comment_examples">--doc.comment_examples</a><br/>• -ndx, -- id="doc.comment_examples" name="doc.comment_examples">--doc.no-comment_examples</a><br/>**Variable d'environnement** : <a id="doc.comment_examples" name="doc.comment_examples">ROUGAILCLI_DOC.COMMENT_EXAMPLES</a> | Ajouter la description des variables et des familles lorsqu&#x27;on génère des exemples.<br/>**Désactivé** : désactiver lorsqu'il example n'est pas dans contents | false | `boolean` |
| **<a id="doc.comment_examples_column" name="doc.comment_examples_column">doc.comment_examples_column</a>**<br/>`standard` `obligatoire` *`désactivé`*<br/>**Ligne de commande** : <a id="doc.comment_examples_column" name="doc.comment_examples_column">--doc.comment_examples_column</a><br/>**Variable d'environnement** : <a id="doc.comment_examples_column" name="doc.comment_examples_column">ROUGAILCLI_DOC.COMMENT_EXAMPLES_COLUMN</a> | Commentaire dans les exemples commence à la colonne.<br/>**Désactivé** : lorsque la variable "[Ajouter la description des variables et des familles lorsqu&#x27;on génère des exemples](#doc.comment_examples)" est accessible et a la valeur "false" | 30 | `integer` |
| **<a id="doc.output_format" name="doc.output_format">doc.output_format</a>**<br/>`standard` `obligatoire`<br/>**Ligne de commande** : -do, <a id="doc.output_format" name="doc.output_format">--doc.output_format</a><br/>**Variable d'environnement** : <a id="doc.output_format" name="doc.output_format">ROUGAILCLI_DOC.OUTPUT_FORMAT</a> | Générer le document au format.<br/>**Validateur** : le format de sortie json n'est pas compatible avec "changelog" et example" de la variable contents | console | `choice`<br/>**Choix** : <br/>• console<br/>• asciidoc<br/>• html<br/>• github<br/>• gitlab<br/>• json |
| **<a id="doc.table_model" name="doc.table_model">doc.table_model</a>**<br/>`standard` `obligatoire`<br/>**Ligne de commande** : -dm, <a id="doc.table_model" name="doc.table_model">--doc.table_model</a><br/>**Variable d'environnement** : <a id="doc.table_model" name="doc.table_model">ROUGAILCLI_DOC.TABLE_MODEL</a> | Generate document inside table model.<br/>**Validateur** : le format de sortie json n'est pas compatible avec "changelog" et example" de la variable contents | two_columns | `choice`<br/>**Choix** : <br/>• two_columns<br/>• three_columns<br/>• four_columns |
| **<a id="doc.force_true_color_terminal" name="doc.force_true_color_terminal">doc.force_true_color_terminal</a>**<br/>`standard` `obligatoire`<br/>**Ligne de commande** : <br/>• <a id="doc.force_true_color_terminal" name="doc.force_true_color_terminal">--doc.force_true_color_terminal</a><br/>• -- id="doc.force_true_color_terminal" name="doc.force_true_color_terminal">--doc.no-force_true_color_terminal</a><br/>**Variable d'environnement** : <a id="doc.force_true_color_terminal" name="doc.force_true_color_terminal">ROUGAILCLI_DOC.FORCE_TRUE_COLOR_TERMINAL</a> | Force les vrais couleurs dans le terminal. | false | `boolean` |

30
src/rougail/output_doc/changelog.py
View file

@ -52,12 +52,6 @@ class Changelog: # pylint: disable=no-member,too-few-public-methods
return self.display()
def parser(self, previous_families, new_families):
def add(new):
self.formatter.variable_to_string(new, self._added_variables)
def remove(previous):
self._removed_variables.append(previous)
done = []
for element in list(previous_families) + list(new_families):
if element in done:
@ -67,28 +61,28 @@ class Changelog: # pylint: disable=no-member,too-few-public-methods
new = new_families.get(element)
if not previous:
if new["type"] == "variable":
add(new)
self._added_variables.append(new)
else:
self.parser({}, new["children"])
elif not new:
if previous["type"] == "variable":
if "identifiers" in previous:
for identifiers in previous["identifiers"]:
remove(calc_path(previous["path"], self.formatter, identifiers))
self._removed_variables.append(calc_path(previous["path"], self.formatter, identifiers))
else:
remove(calc_path(previous["path"], self.formatter))
self._removed_variables.append(calc_path(previous["path"], self.formatter))
else:
self.parser(previous["children"], {})
elif previous["type"] != new["type"]:
if previous["type"] == "variable":
if "identifiers" in previous:
for identifiers in previous["identifiers"]:
remove(calc_path(previous["path"], self.formatter, identifiers))
self._removed_variables.append(calc_path(previous["path"], self.formatter, identifiers))
else:
remove(calc_path(previous["path"], self.formatter))
self._removed_variables.append(calc_path(previous["path"], self.formatter))
self.parser({}, new["children"])
else:
add(new)
self._added_variables.append(new)
self.parser(previous["children"], {})
elif previous["type"] != "variable":
self.parser(previous["children"], new["children"])
@ -144,9 +138,7 @@ class Changelog: # pylint: disable=no-member,too-few-public-methods
modified_attributes[prop] = (name, prop_previous, prop_new)
if not modified_attributes:
continue
self.formatter.variable_to_string(
new, self._modified_variables, modified_attributes
)
self._modified_variables.append((new, modified_attributes))
def display(self) -> str:
msg = ""
@ -155,10 +147,12 @@ class Changelog: # pylint: disable=no-member,too-few-public-methods
title = _("New variable")
else:
title = _("New variables")
for add in self._added_variables:
self.formatter.variable_to_string(add)
msg += self.formatter._run(
[
self.formatter.title(title, self.level),
self.formatter.table(self._added_variables),
self.formatter.table(),
self.formatter.end_family(self.level)
],
self.level,
@ -169,10 +163,12 @@ class Changelog: # pylint: disable=no-member,too-few-public-methods
title = _("Modified variable")
else:
title = _("Modified variables")
for mod, modified_attributes in self._modified_variables:
self.formatter.variable_to_string(mod, modified_attributes)
msg += self.formatter._run(
[
self.formatter.title(title, self.level),
self.formatter.table(self._modified_variables),
self.formatter.table(),
self.formatter.end_family(self.level)
],
self.level,

94
src/rougail/output_doc/config.py
View file

@ -21,28 +21,48 @@ from rougail.utils import load_modules
from .i18n import _
ROUGAIL_VARIABLE_TYPE = (
"https://rougail.readthedocs.io/en/latest/variable.html#variables-types"
)
OUTPUTS = None
TABLES = None
def get_outputs() -> None:
"""Load all outputs"""
module_name = "rougail.output_doc.output"
def get_outputs_or_tables(type_) -> None:
"""Load all outputs or tables"""
module_name = f"rougail.output_doc.{type_}"
outputs = {}
for path in (Path(__file__).parent / "output").iterdir():
names = []
for path in (Path(__file__).parent / type_).iterdir():
name = path.name
if not name.endswith(".py") or name.endswith("__.py"):
continue
module = load_modules(module_name + "." + name[:-3], str(path))
if "Formatter" not in dir(module):
continue
level = module.Formatter.level
if type_ == "output":
if "Formatter" not in dir(module):
continue
obj_class = module.Formatter
elif type_ == "table":
if "Table" not in dir(module):
continue
obj_class = module.Table
level = obj_class.level
if level in outputs:
raise ImportError(
_('duplicated level rougail-doc for output "{0}": {1} and {2}').format(
level, module.Formatter.name, outputs[level].name
_('duplicated level rougail-output-doc for {0} "{1}": {2} and {3}').format(
type_, level, obj_class.name, outputs[level].name
)
)
outputs[module.Formatter.level] = module.Formatter
if obj_class.name in names:
raise ImportError(
_('duplicated name "{0}" in rougail-output-doc').format(
obj_class.name
)
)
names.append(obj_class.name)
outputs[level] = obj_class
return {outputs[level].name: outputs[level] for level in sorted(outputs)}
@ -54,13 +74,28 @@ class OutPuts: # pylint: disable=R0903
) -> None:
global OUTPUTS
if OUTPUTS is None:
OUTPUTS = get_outputs()
OUTPUTS = get_outputs_or_tables("output")
def get(self) -> dict:
"""Get all outputs"""
return OUTPUTS
class Tables: # pylint: disable=R0903
"""Transformations applied on a object instance"""
def __init__(
self,
) -> None:
global TABLES
if TABLES is None:
TABLES = get_outputs_or_tables("table")
def get(self) -> dict:
"""Get all tables"""
return TABLES
def get_rougail_config(
*,
backward_compatibility=True, # pylint: disable=unused-argument
@ -68,6 +103,8 @@ def get_rougail_config(
"""Get documentation for output_doc modules"""
outputs = list(OutPuts().get())
output_format_default = outputs[0]
tables = list(Tables().get())
table_default = tables[0]
rougail_options = f"""
doc:
description: {_('Generate documentation')}
@ -85,6 +122,7 @@ doc:
contents:
description: {_('Generated content')}
alternative_name: dc
choices:
- variables
- example
@ -94,6 +132,7 @@ doc:
previous_json_file:
description: {_('Previous description file in JSON format')}
alternative_name: dp
disabled:
jinja: |-
{{{{ "changelog" not in _.contents }}}}
@ -103,6 +142,7 @@ doc:
without_family:
description: {_('Do not add families in documentation')}
default: false
alternative_name: df
disabled:
jinja: |-
{{{{ _.output_format == "json" or ("variables" not in _.contents and "changelog" not in _.contents) }}}}
@ -111,10 +151,12 @@ doc:
root:
description: {_('Document the variables from this family')}
alternative_name: dr
mandatory: false
with_commandline:
description: {_('Add command line informations in documentation')}
alternative_name: dw
default: false
disabled:
jinja: |-
@ -124,6 +166,7 @@ doc:
with_environment:
description: {_('Add environment variable informations in documentation')}
alternative_name: de
default: false
disabled:
jinja: |-
@ -133,15 +176,16 @@ doc:
environment_default_environment_name:
description: {_("Name of the default environment prefix")}
alternative_name: dd
default: ROUGAIL
validators:
- jinja: |-
{{{{ _.environment_default_environment_name | upper != _.environment_default_environment_name }}}}
{{{{ (_.environment_default_environment_name | upper) != _.environment_default_environment_name }}}}
return_type: boolean
description: {_("should only user uppercase characters")}
disabled:
jinja: |-
{{{{ __.main_namespace or _.with_environment is false }}}}
{{{{ __.main_namespace == none or _.with_environment is false }}}}
return_type: boolean
description: {_('when "__.main_namespace" is not set or "_.with_environment" is false')}
@ -186,6 +230,7 @@ doc:
comment_examples:
description: {_('Add description of variables and families when generate examples')}
alternative_name: dx
default: false
disabled:
jinja: |-
@ -204,7 +249,7 @@ doc:
output_format:
description: {_('Generate document in format')}
alternative_name: do
default: output_format_default
default: { output_format_default }
validators:
- jinja: |-
{{% if _.output_format == 'json' %}}
@ -214,12 +259,27 @@ doc:
{{% endif %}}
description: {_('json output_format is not compatible with "changelog" and "example" contents')}
choices:
""".replace(
"output_format_default", output_format_default
)
"""
for output in outputs:
rougail_options += f" - {output}\n"
rougail_options += f"""
table_model:
description: {_('Generate document inside table model')}
alternative_name: dm
default: { table_default }
validators:
- jinja: |-
{{% if _.output_format == 'json' %}}
{{% if "changelog" in _.contents or "example" in _.contents %}}
cannot add to contents "{{{{ _.contents }}}}" with output_format "json"
{{% endif %}}
{{% endif %}}
description: {_('json output_format is not compatible with "changelog" and "example" contents')}
choices:
"""
for table in tables:
rougail_options += f" - {table}\n"
rougail_options += f"""
force_true_color_terminal:
description: {_('Force true color terminal')}
default: false

38
src/rougail/output_doc/doc.py
View file

@ -363,12 +363,7 @@ class RougailOutputDoc(Examples, Changelog):
else:
multi = False
if multi:
informations["properties"].append(
{
"type": "multiple",
"name": _("multiple"),
}
)
informations["multiple"] = True
examples = variable.information.get("examples", None)
if examples is None:
examples = variable.information.get("test", None)
@ -474,11 +469,9 @@ class RougailOutputDoc(Examples, Changelog):
if example is not None:
if isinstance(example, tuple):
example = list(example)
for prop in informations["properties"]:
if prop["type"] == "multiple":
if not isinstance(example, list):
example = [example]
break
if informations.get("multiple"):
if not isinstance(example, list):
example = [example]
else:
if isinstance(example, list):
index = variable.index()
@ -497,25 +490,19 @@ class RougailOutputDoc(Examples, Changelog):
example = default
else:
example = self.get_type_default_value(
variable, informations["properties"]
variable, informations
)
if leader is not None and variable.isfollower():
example = [example] + [undefined] * (len(leader["gen_examples"][-1]) - 1)
return example
def get_type_default_value(self, variable, properties):
def get_type_default_value(self, variable, informations):
example = self.convert_option.get(variable.information.get("type"), {}).get(
"example", None
)
if example is None:
example = "xxx"
for prop in properties:
if prop["type"] == "multiple":
multi = True
break
else:
multi = False
if multi:
if informations.get("multiple"):
example = [example]
return example
@ -526,12 +513,7 @@ class RougailOutputDoc(Examples, Changelog):
):
variable_type = child.information.get("type")
doc_type = self.convert_option.get(variable_type, {"params": {}})
informations["properties"] = [
{
"type": "type",
"name": doc_type.get("msg", variable_type),
}
]
informations["variable_type"] = doc_type.get("msg", variable_type)
# extra parameters for types
option = child.get()
validators = []
@ -561,7 +543,7 @@ class RougailOutputDoc(Examples, Changelog):
)
)
break
if child.information.get("type") == "regexp":
if variable_type == "regexp":
validators.append(
_('text based with regular expressions "{0}"').format(child.pattern())
)
@ -572,7 +554,7 @@ class RougailOutputDoc(Examples, Changelog):
else:
key = _("Validators")
informations["validators"] = {"name": key, "values": validators}
if child.information.get("type") == "choice":
if variable_type == "choice":
choices = self._to_string(child, "choice", do_not_raise=True)
if choices is None:
choices = child.value.list()

4
src/rougail/output_doc/output/asciidoc.py
View file

@ -122,11 +122,11 @@ class Formatter(CommonFormatter):
"""Dump yaml part of documentation"""
return f"[,yaml]\n----\n---\n{dump(_dump)}\n----\n"
def table(self, datas: list, with_header: bool = True) -> str:
def table(self, with_header: bool = True) -> str:
"""Transform list to a table in string format
we change the first line because we want that col has the same width
"""
table = super().table(datas, with_header)
table = super().table(with_header)
stable = table.split("\n", 1)
return '[cols="1a,1a"]\n' + stable[1]

10
src/rougail/output_doc/output/console.py
View file

@ -175,14 +175,14 @@ class Formatter(CommonFormatter):
for l in line.split(self.enter_table):
self.max_line = max(self.max_line, len(l) + 1)
def table(self, datas: list, with_header: bool = True) -> str:
def table(self, with_header: bool = True) -> str:
"""Transform list to a table in string format"""
table = self.rich_table(show_lines=True)
if with_header:
table.add_column(_("Variable"), width=self.max_line)
table.add_column(_("Description"), width=self.max_line)
for data in datas:
table.add_row(str(data[0]), data[1])
for column in self.table_datas.headers():
table.add_column(column, width=self.max_line)
for data in self.table_datas.get():
table.add_row(*data)
return table
def family_informations(self) -> str:

4
src/rougail/output_doc/output/github.py
View file

@ -133,9 +133,7 @@ class Formatter(CommonFormatter):
def table_header(self, lst):
"""Manage the header of a table"""
return lst[0] + "&nbsp;" * (self.max_line_variable - len(lst[0])), lst[
1
] + "&nbsp;" * (self.max_line_description - len(lst[1]))
return [l + "&nbsp;" * (self.max_line_variable - len(l)) for l in lst]
def yaml(self, _dump):
"""Dump yaml part of documentation"""

17
src/rougail/output_doc/table/__init__.py Normal file
View file

@ -0,0 +1,17 @@
"""Loads output
Silique (https://www.silique.fr)
Copyright (C) 2025
This program is free software: you can redistribute it and/or modify it
under the terms of the GNU Lesser General Public License as published by the
Free Software Foundation, either version 3 of the License, or (at your
option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
details.
You should have received a copy of the GNU Lesser General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
"""

63
src/rougail/output_doc/table/four_columns.py Normal file
View file

@ -0,0 +1,63 @@
"""
Silique (https://www.silique.fr)
Copyright (C) 2025
This program is free software: you can redistribute it and/or modify it
under the terms of the GNU Lesser General Public License as published by the
Free Software Foundation, either version 3 of the License, or (at your
option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
details.
You should have received a copy of the GNU Lesser General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
"""
from ..i18n import _
from ..config import ROUGAIL_VARIABLE_TYPE
from .three_columns import Table as ThreeTable
class Table(ThreeTable):
"""The four columns table"""
name = "four_columns"
level = 50
def __init__(self, *args) -> None:
super().__init__(*args)
def _add(self) -> tuple:
first_column = self.get_column(self.paths, self.properties, self.commandlines, self.environments)
if first_column:
self.first_column = True
second_column = self.get_column(self.description, self.help_, self.validators, self.examples, self.tags, *self.calculated_properties)
if second_column:
self.second_column = True
third_column = self.get_column(self.default)
if third_column:
self.third_column = True
types = self.formatter.property_to_string(
self.informations, self.calculated_properties, self.modified_attributes, contents="type",
)
four_columns = self.get_column(types, self.choices)
return first_column, second_column, third_column, four_columns
def headers(self) -> tuple:
header = super().headers()
header.append(_("Type"))
return header
def get_columns(self):
if not self.second_column or not self.third_column:
raise Exception()
return [[col1] for col1, col2, c in self.columns]
return self.columns
def set_properties(self):
self.properties = self.formatter.property_to_string(
self.informations, self.calculated_properties, self.modified_attributes, contents="properties",
)

71
src/rougail/output_doc/table/three_columns.py Normal file
View file

@ -0,0 +1,71 @@
"""
Silique (https://www.silique.fr)
Copyright (C) 2025
This program is free software: you can redistribute it and/or modify it
under the terms of the GNU Lesser General Public License as published by the
Free Software Foundation, either version 3 of the License, or (at your
option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
details.
You should have received a copy of the GNU Lesser General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
"""
from ..i18n import _
from ..utils import CommonTable
class Table(CommonTable):
"""The three columns table"""
name = "three_columns"
level = 30
def __init__(self, *args) -> None:
super().__init__(*args)
self.second_column = False
self.third_column = False
def _add(self) -> tuple:
first_column = self.get_column(self.paths, self.properties, self.commandlines, self.environments)
if first_column:
self.first_column = True
second_column = self.get_column(self.description, self.help_, self.validators, self.choices, self.examples, self.tags, *self.calculated_properties)
if second_column:
self.second_column = True
third_column = self.get_column(self.default)
if third_column:
self.third_column = True
return first_column, second_column, third_column
def headers(self) -> tuple:
header = [_("Variable")]
if self.second_column:
header.append(_("Description"))
if self.third_column:
header.append(_("Default value"))
return header
def get_columns(self):
if not self.second_column or not self.third_column:
raise Exception()
return [[col1] for col1, col2, c in self.columns]
return self.columns
def set_default(self):
if "default" in self.informations:
self.default = self.formatter.convert_section_to_string(
"default", self.informations, self.modified_attributes, multi=self.multi, section_name=False
)
else:
self.default = None
def set_choices(self):
self.default_is_already_set, self.choices = self.formatter.convert_choices_to_string(
self.informations, self.modified_attributes, with_default=False
)

52
src/rougail/output_doc/table/two_columns.py Normal file
View file

@ -0,0 +1,52 @@
"""
Silique (https://www.silique.fr)
Copyright (C) 2025
This program is free software: you can redistribute it and/or modify it
under the terms of the GNU Lesser General Public License as published by the
Free Software Foundation, either version 3 of the License, or (at your
option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
details.
You should have received a copy of the GNU Lesser General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
"""
from ..i18n import _
from ..utils import CommonTable
class Table(CommonTable):
"""The two columns table"""
name = "two_columns"
level = 10
def __init__(self, *args) -> None:
super().__init__(*args)
self.second_column = False
def _add(self) -> tuple:
default = self.default if not self.default_is_already_set else None
first_column = self.get_column(self.paths, self.properties, self.commandlines, self.environments)
if first_column:
self.first_column = True
second_column = self.get_column(self.description, self.help_, self.validators, self.choices, default, self.examples, self.tags, *self.calculated_properties)
if second_column:
self.second_column = True
return first_column, second_column
def headers(self) -> tuple:
header = [_("Variable")]
if self.second_column:
header.append(_("Description"))
return header
def get_columns(self):
if not self.second_column:
return [[col1] for col1, col2 in self.columns]
return self.columns

364
src/rougail/output_doc/utils.py
View file

@ -32,11 +32,7 @@ except:
gen_argument_name = None
from .i18n import _
ROUGAIL_VARIABLE_TYPE = (
"https://rougail.readthedocs.io/en/latest/variable.html#variables-types"
)
from .config import Tables, ROUGAIL_VARIABLE_TYPE
ENTER = "\n\n"
@ -75,6 +71,116 @@ def to_phrase(msg, type_="variable"):
return msg[0].upper() + msg[1:]
class CommonTable:
"""Class with common function for table"""
def __init__(self, formatter: "CommonFormatter") -> None:
self.formatter = formatter
self.clear()
def clear(self):
self.columns = []
def get(self):
columns = self.get_columns()
self.clear()
return columns
def add(self, informations: dict, modified_attributes: dict, force_identifiers: Optional[str]) -> tuple:
self.informations = informations
self.modified_attributes = modified_attributes
self.force_identifiers = force_identifiers
self.calculated_properties = []
self.set_description()
self.set_type()
self.set_choices()
self.set_properties()
self.set_default()
self.set_examples()
self.set_paths()
self.set_commandline()
self.set_environment()
self.set_validators()
self.set_tags()
self.columns.append(self._add())
def set_description(self):
if "description" in self.informations:
self.description = self.formatter.get_description(
"variable", self.informations, self.modified_attributes, self.force_identifiers,
)
else:
self.description = None
self.help_ = self.formatter.convert_list_to_string("help", self.informations, self.modified_attributes)
def set_choices(self):
self.default_is_already_set, self.choices = self.formatter.convert_choices_to_string(
self.informations, self.modified_attributes
)
def set_type(self):
self.multi = self.informations.get("multiple", True)
self.type = self.informations["variable_type"]
def set_default(self):
if "default" in self.informations:
self.default = self.formatter.convert_section_to_string(
"default", self.informations, self.modified_attributes, multi=self.multi
)
else:
self.default = None
def set_examples(self):
self.examples = self.formatter.convert_section_to_string(
"examples", self.informations, self.modified_attributes, multi=True
)
def set_paths(self):
self.paths = self.formatter.join(self.formatter.display_paths(self.informations, self.modified_attributes, self.force_identifiers, is_variable=True))
def set_commandline(self):
if self.formatter.with_commandline and not self.informations.get('not_for_commandline', False):
commandlines = self.formatter.display_paths(self.informations, self.modified_attributes, self.force_identifiers, is_variable=True, is_bold=False, variable_prefix="--")
if self.type == 'boolean':
for path in list(commandlines):
commandlines.append("--" + gen_argument_name(path[2:], False, True, False))
if "alternative_name" in self.informations:
alternative_name = self.informations["alternative_name"]
commandlines[0] = f"-{alternative_name}, {commandlines[0]}"
if self.type == 'boolean':
commandlines[1] = "-" + gen_argument_name(alternative_name, True, True, False) + f", {commandlines[1]}"
self.commandlines = self.formatter.section(_("Command line"), commandlines)
else:
self.commandlines = None
def set_environment(self):
if self.formatter.with_environment:
environments = self.formatter.display_paths(self.informations, self.modified_attributes, self.force_identifiers, is_variable=True, is_bold=False, is_upper=True, variable_prefix=self.formatter.prefix)
self.environments = self.formatter.section(_("Environment variable"), environments)
else:
self.environments = None
def set_properties(self):
self.properties = self.formatter.property_to_string(
self.informations, self.calculated_properties, self.modified_attributes,
)
def set_validators(self):
self.validators = self.formatter.convert_section_to_string(
"validators", self.informations, self.modified_attributes, multi=True
)
def set_tags(self):
self.tags = self.formatter.convert_section_to_string(
"tags", self.informations, self.modified_attributes, multi=True
)
def get_column(self, *args):
contents = [arg for arg in args if arg]
self.formatter.columns(contents)
return self.formatter.join(contents)
class CommonFormatter:
"""Class with common function for formatter"""
@ -125,6 +231,8 @@ class CommonFormatter:
else:
if other_root_filenames:
self.other_root_filenames = dict(zip(other_root_filenames["root_path"], other_root_filenames["filename"]))
table_model = self.rougailconfig["doc.table_model"]
self.table_datas = Tables().get()[table_model](self)
def compute(self, data):
return "".join([d for d in data if d])
@ -287,15 +395,10 @@ class CommonFormatter:
dico: dict,
level: int,
*,
ori_table_datas: list = None,
init: bool = False,
) -> str:
"""Parse the dict to transform to dict"""
msg = []
if ori_table_datas is not None:
table_datas = ori_table_datas
else:
table_datas = []
ori_level = None
if init and self.root:
if self.with_family:
@ -303,25 +406,23 @@ class CommonFormatter:
dico = dico["children"]
for value in dico.values():
if value["type"] == "variable":
self.variable_to_string(value, table_datas)
else:
if self.with_family:
if value["type"] == "namespace":
namespace = ori_level is None
else:
namespace = False
if table_datas:
msg.append(self.table(table_datas))
table_datas = []
msg.extend(self.family_to_string(value["informations"], level, namespace))
msg.extend(self.dict_to_dict(value["children"], level + 1))
msg.append(self.end_family(level))
self.variable_to_string(value)
elif self.with_family:
if value["type"] == "namespace":
namespace = ori_level is None
else:
self.dict_to_dict(
value["children"], level + 1, ori_table_datas=table_datas
)
if (init or ori_table_datas is None) and table_datas:
msg.append(self.table(table_datas))
namespace = False
if self.table_datas.columns:
msg.append(self.table())
msg.extend(self.family_to_string(value["informations"], level, namespace))
msg.extend(self.dict_to_dict(value["children"], level + 1))
msg.append(self.end_family(level))
else:
self.dict_to_dict(
value["children"], level + 1,
)
if self.table_datas.columns and (init or self.with_family):
msg.append(self.table())
return msg
# FAMILY
@ -347,7 +448,7 @@ class CommonFormatter:
for help_ in helps:
msg.append(to_phrase(help_.strip()))
calculated_properties = []
property_str = self.property_to_string(informations, calculated_properties, {})[1]
property_str = self.property_to_string(informations, calculated_properties, {})
if property_str:
msg.append(property_str)
if calculated_properties:
@ -452,132 +553,18 @@ class CommonFormatter:
# VARIABLE
def variable_to_string(
self, informations: dict, table_datas: list, modified_attributes: dict = {}, force_identifiers: Optional[str]=None
self, informations: dict, modified_attributes: dict = {}, force_identifiers: Optional[str]=None
) -> None:
"""Manage variable"""
calculated_properties = []
multi, first_column = self.variable_first_column(
informations, calculated_properties, modified_attributes, force_identifiers
)
table_datas.append(
[
self.join(first_column),
self.join(
self.variable_second_column(
informations,
calculated_properties,
modified_attributes,
multi,
force_identifiers,
)
),
]
)
def variable_first_column(
self,
informations: dict,
calculated_properties: list,
modified_attributes: Optional[dict],
force_identifiers: Optional[str],
) -> list:
"""Collect string for the first column"""
multi, properties = self.property_to_string(
informations, calculated_properties, modified_attributes,
)
paths = self.display_paths(informations, modified_attributes, force_identifiers, is_variable=True)
first_col = [
self.join(paths),
properties,
]
if self.with_commandline and not informations.get('not_for_commandline', False):
paths = self.display_paths(informations, modified_attributes, force_identifiers, is_variable=True, is_bold=False, variable_prefix="--")
variable_type = informations["properties"][0]["name"]
if variable_type == 'boolean':
for path in list(paths):
paths.append("--" + gen_argument_name(path[2:], False, True, False))
if "alternative_name" in informations:
alternative_name = informations["alternative_name"]
paths[0] += f", -{alternative_name}"
if variable_type == 'boolean':
paths[1] += ", -" + gen_argument_name(alternative_name, True, True, False)
first_col.append(self.section(_("Command line"), paths))
if self.with_environment:
paths = self.display_paths(informations, modified_attributes, force_identifiers, is_variable=True, is_bold=False, is_upper=True, variable_prefix=self.prefix)
first_col.append(self.section(_("Environment variable"), paths))
self.columns(first_col)
return multi, first_col
def variable_second_column(
self,
informations: dict,
calculated_properties: list,
modified_attributes: dict,
multi: bool,
force_identifiers: Optional[str],
) -> list:
"""Collect string for the second column"""
second_col = []
#
if "description" in informations:
description = self.get_description(
"variable", informations, modified_attributes, force_identifiers,
)
second_col.append(description)
#
help_ = self.convert_list_to_string("help", informations, modified_attributes)
if help_:
second_col.append(help_)
#
validators = self.convert_section_to_string(
"validators", informations, modified_attributes, multi=True
)
if validators:
second_col.append(validators)
default_is_already_set, choices = self.convert_choices_to_string(
informations, modified_attributes
)
if choices:
second_col.append(choices)
if not default_is_already_set and "default" in informations:
self.convert_section_to_string(
"default", informations, modified_attributes, multi=multi
)
second_col.append(
self.convert_section_to_string(
"default", informations, modified_attributes, multi=multi
)
)
examples = self.convert_section_to_string(
"examples", informations, modified_attributes, multi=True
)
if examples:
second_col.append(examples)
tags = self.convert_section_to_string(
"tags", informations, modified_attributes, multi=True
)
if tags:
second_col.append(tags)
second_col.extend(calculated_properties)
self.columns(second_col)
return second_col
self.table_datas.add(informations, modified_attributes, force_identifiers)
def convert_section_to_string(
self, attribute: str, informations: dict, modified_attributes: dict, multi: bool
self, attribute: str, informations: dict, modified_attributes: dict, multi: bool, *, section_name: bool = True,
) -> str():
values = []
submessage = ""
if modified_attributes and attribute in modified_attributes:
name, previous, new = modified_attributes[attribute]
# if "identifiers" in modified_attributes:
# iname, iprevious, inew = modified_attributes["identifiers"]
# identifiers = iprevious.copy()
# for identifier in informations.get("identifiers", []):
# if identifier not in inew:
# identifiers.append(identifier)
#
# else:
# identifiers = informations.get("identifiers", [])
if isinstance(previous, list):
for p in previous:
submessage, m = self.message_to_string(p, submessage)
@ -612,10 +599,10 @@ class CommonFormatter:
if old["values"] in new:
values = self.underline(values)
if values != []:
return self.section(name, values, submessage=submessage)
return self.section(name, values, submessage=submessage, section_name=section_name)
def convert_choices_to_string(
self, informations: dict, modified_attributes: dict
self, informations: dict, modified_attributes: dict, with_default: bool = True,
) -> str():
default_is_already_set = False
if "choices" in informations:
@ -683,7 +670,7 @@ class CommonFormatter:
for choice in reversed(previous):
if isinstance(choice, dict):
choice = self.message_to_string(choice, None)[1]
if choice in old_default:
if with_default and choice in old_default:
choices_values.insert(
0, self.delete(dump(choice) + " ← " + _("(default)"))
)
@ -692,11 +679,11 @@ class CommonFormatter:
else:
new = []
for idx, val in enumerate(choices_values):
if val in old_default:
if with_default and val in old_default:
choices_values[idx] = (
dump(val) + " " + self.delete("← " + _("(default)"))
)
elif val in default:
elif with_default and val in default:
if val in new_default:
if val in new:
choices_values[idx] = self.underline(
@ -729,51 +716,60 @@ class CommonFormatter:
informations: dict,
calculated_properties: list,
modified_attributes: dict,
contents: str="all"
) -> str:
"""Transform properties to string"""
properties = []
modified_properties = []
if contents in ["all", "type"]:
if "type" in modified_attributes:
modified_properties.append(self.prop(modified_attributes["type"], italic=False, delete=True, underline=False))
if "multi" in modified_attributes:
modified_properties.append(self.prop("multiple", italic=False, delete=True, underline=False))
if "properties" in modified_attributes and contents in ["all", "properties"]:
modified_properties.extend(modified_attributes["properties"])
local_calculated_properties = {}
multi = False
if "properties" in modified_attributes:
if modified_properties:
previous, new = self.get_modified_properties(
*modified_attributes["properties"][1:]
*modified_properties
)
for p, annotation in previous.items():
if p not in new:
properties.append(self.prop(p, italic=False, delete=True, underline=False))
if annotation is not None:
local_calculated_properties[p] = [{"annotation": annotation, "delete": True}]
else:
previous = new = []
for prop in informations.get("properties", []):
others = []
if contents in ["all", "type"] and "variable_type" in informations:
others.append({"name": informations["variable_type"]})
if informations.get("multiple"):
others.append({"name": "multiple"})
if contents in ["all", "properties"] and "properties" in informations:
others.extend(informations["properties"])
for prop in others:
prop_name = prop["name"]
if prop_name not in previous and prop_name in new:
underline = True
else:
underline = False
if prop["type"] == "type":
properties.append(self.link(prop_name, ROUGAIL_VARIABLE_TYPE, underline))
else:
if prop["type"] == "multiple":
multi = True
if "annotation" in prop:
italic = True
prop_annotation = prop["annotation"]
if prop_name in new and (
prop_name not in previous
or new[prop_name] != previous[prop_name]
):
underline_ = True
if "annotation" in prop:
italic = True
prop_annotation = prop["annotation"]
if prop_name in new and (
prop_name not in previous
or new[prop_name] != previous[prop_name]
):
underline_ = True
# prop_annotation = self.underline(prop_annotation)
else:
underline_ = False
local_calculated_properties.setdefault(prop["name"], []).append(
{"annotation": prop_annotation, "underline": underline_}
)
else:
italic = False
properties.append(self.prop(prop_name, italic=italic, delete=False, underline=underline))
underline_ = False
local_calculated_properties.setdefault(prop["name"], []).append(
{"annotation": prop_annotation, "underline": underline_}
)
else:
italic = False
properties.append(self.prop(prop_name, italic=italic, delete=False, underline=underline))
if local_calculated_properties:
for (
calculated_property_name,
@ -798,8 +794,8 @@ class CommonFormatter:
)
)
if not properties:
return multi, ""
return multi, " ".join(properties)
return ""
return " ".join(properties)
def get_modified_properties(
self, previous: List[dict], new: List[dict]
@ -816,21 +812,20 @@ class CommonFormatter:
"""Manage column"""
return
def table(self, datas: list, with_header: bool = True) -> str:
def table(self, with_header: bool = True) -> str:
"""Transform list to a table in string format"""
if with_header:
headers = self.table_header([_("Variable"), _("Description")])
headers = self.table_header(self.table_datas.headers())
else:
headers = ()
msg = (
tabulate(
datas,
self.table_datas.get(),
headers=headers,
tablefmt=self._table_name,
)
+ "\n\n"
)
datas.clear()
return msg
def message_to_string(self, msg, ret, identifiers=[]):
@ -875,6 +870,7 @@ class CommonFormatter:
msg: str,
submessage: str = "",
type_ = "variable",
section_name=True,
) -> str:
"""Return something like Name: msg"""
submessage, msg = self.message_to_string(msg, submessage)
@ -896,7 +892,9 @@ class CommonFormatter:
submessage += dump(msg)
else:
submessage += msg
return _("{0}: {1}").format(self.bold(name), submessage)
if section_name:
return _("{0}: {1}").format(self.bold(name), submessage)
return submessage
def calc_path(path, formatter=None, identifiers: List[str] = None) -> str:

2
tests/results/test/00_0version_underscore.adoc
View file

@ -2,6 +2,6 @@
|====
| Variable | Description
| **version** +
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | A variable.
`string` `basic` `mandatory` | A variable.
|====

6
tests/results/test/00_0version_underscore.gitlab.md
View file

@ -1,4 +1,4 @@
| Variable | Description |
|-----------------------------------------------------------------------------------------------------------------------------------------------------------|---------------|
| **<a id="version" name="version">version</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. |
| Variable | Description |
|---------------------------------------------------------------------------------|---------------|
| **<a id="version" name="version">version</a>**<br/>`string` `basic` `mandatory` | A variable. |

4
tests/results/test/00_0version_underscore.html
View file

@ -1,9 +1,9 @@
<table>
<thead>
<tr><th>Variable </th><th>Description </th></tr>
<tr><th>Variable </th><th>Description </th></tr>
</thead>
<tbody>
<tr><td><b>version</b><br/><mark><a href='https://rougail.readthedocs.io/en/latest/variable.html#variables-types'>string</a></mark> <mark>basic</mark> <mark>mandatory</mark></td><td>A variable. </td></tr>
<tr><td><b>version</b><br/><mark>string</mark> <mark>basic</mark> <mark>mandatory</mark></td><td>A variable. </td></tr>
</tbody>
</table>

15
tests/results/test/00_0version_underscore.json
View file

@ -1,11 +1,13 @@
{
"version": {
"type": "variable",
"variable_type": "string",
"path": "version",
"names": [
"version"
],
"description": "A variable.",
"properties": [
{
"type": "type",
"name": "string"
},
{
"type": "mode",
"name": "basic"
@ -15,11 +17,6 @@
"name": "mandatory"
}
],
"path": "version",
"names": [
"version"
],
"description": "A variable.",
"gen_examples": [
"example"
],

6
tests/results/test/00_0version_underscore.md
View file

@ -1,4 +1,4 @@
| Variable&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; | Description&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **<a id="version" name="version">version</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. |
| Variable&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; | Description&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **<a id="version" name="version">version</a>**<br/>`string` `basic` `mandatory` | A variable. |

4
tests/results/test/00_1empty_variable.adoc
View file

@ -1,7 +1,7 @@
[cols="1a,1a"]
|====
| Variable | Description
| Variable
| **empty** +
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` |
`string` `basic` `mandatory`
|====

6
tests/results/test/00_1empty_variable.gitlab.md
View file

@ -1,4 +1,4 @@
| Variable | Description |
|-----------------------------------------------------------------------------------------------------------------------------------------------------|---------------|
| **<a id="empty" name="empty">empty</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | |
| Variable |
|---------------------------------------------------------------------------|
| **<a id="empty" name="empty">empty</a>**<br/>`string` `basic` `mandatory` |

4
tests/results/test/00_1empty_variable.html
View file

@ -1,9 +1,9 @@
<table>
<thead>
<tr><th>Variable </th><th>Description </th></tr>
<tr><th>Variable </th></tr>
</thead>
<tbody>
<tr><td><b>empty</b><br/><mark><a href='https://rougail.readthedocs.io/en/latest/variable.html#variables-types'>string</a></mark> <mark>basic</mark> <mark>mandatory</mark></td><td> </td></tr>
<tr><td><b>empty</b><br/><mark>string</mark> <mark>basic</mark> <mark>mandatory</mark></td></tr>
</tbody>
</table>

13
tests/results/test/00_1empty_variable.json
View file

@ -1,11 +1,12 @@
{
"empty": {
"type": "variable",
"variable_type": "string",
"path": "empty",
"names": [
"empty"
],
"properties": [
{
"type": "type",
"name": "string"
},
{
"type": "mode",
"name": "basic"
@ -15,10 +16,6 @@
"name": "mandatory"
}
],
"path": "empty",
"names": [
"empty"
],
"gen_examples": [
"example"
],

6
tests/results/test/00_1empty_variable.md
View file

@ -1,4 +1,4 @@
| Variable&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; | Description&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **<a id="empty" name="empty">empty</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | |
| Variable&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **<a id="empty" name="empty">empty</a>**<br/>`string` `basic` `mandatory` |

12
tests/results/test/00_1empty_variable.sh
View file

@ -1,6 +1,6 @@
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃ Variable  ┃ Description  ┃
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
│ empty │ │
│  string   basic   mandatory  │ │
└───────────────────────────────────────┴──────────────────────────────────────┘
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃ Variable  ┃
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
│ empty │
│  string   basic   mandatory  │
└──────────────────────────────────────────────────────────────────────────────┘

4
tests/results/test/00_2default_calculated.adoc
View file

@ -2,10 +2,10 @@
|====
| Variable | Description
| **var1** +
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A first variable. +
`string` `standard` `mandatory` | A first variable. +
**Default**: no
| **var2** +
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | A second variable. +
`string` `multiple` `standard` `mandatory` `unique` | A second variable. +
**Default**: the value of var1
|====

8
tests/results/test/00_2default_calculated.gitlab.md
View file

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

6
tests/results/test/00_2default_calculated.html
View file

@ -1,10 +1,10 @@
<table>
<thead>
<tr><th>Variable </th><th>Description </th></tr>
<tr><th>Variable </th><th>Description </th></tr>
</thead>
<tbody>
<tr><td><b>var1</b><br/><mark><a href='https://rougail.readthedocs.io/en/latest/variable.html#variables-types'>string</a></mark> <mark>standard</mark> <mark>mandatory</mark> </td><td>A first variable.<br/><b>Default</b>: no </td></tr>
<tr><td><b>var2</b><br/><mark><a href='https://rougail.readthedocs.io/en/latest/variable.html#variables-types'>string</a></mark> <mark>standard</mark> <mark>mandatory</mark> <mark>unique</mark> <mark>multiple</mark></td><td>A second variable.<br/><b>Default</b>: the value of var1</td></tr>
<tr><td><b>var1</b><br/><mark>string</mark> <mark>standard</mark> <mark>mandatory</mark> </td><td>A first variable.<br/><b>Default</b>: no </td></tr>
<tr><td><b>var2</b><br/><mark>string</mark> <mark>multiple</mark> <mark>standard</mark> <mark>mandatory</mark> <mark>unique</mark></td><td>A second variable.<br/><b>Default</b>: the value of var1</td></tr>
</tbody>
</table>

35
tests/results/test/00_2default_calculated.json
View file

@ -5,11 +5,13 @@
"name": "Default",
"values": "no"
},
"variable_type": "string",
"path": "var1",
"names": [
"var1"
],
"description": "A first variable.",
"properties": [
{
"type": "type",
"name": "string"
},
{
"type": "mode",
"name": "standard"
@ -19,11 +21,6 @@
"name": "mandatory"
}
],
"path": "var1",
"names": [
"var1"
],
"description": "A first variable.",
"gen_examples": [
"no"
],
@ -37,11 +34,13 @@
"description": "the value of var1"
}
},
"variable_type": "string",
"path": "var2",
"names": [
"var2"
],
"description": "A second variable.",
"properties": [
{
"type": "type",
"name": "string"
},
{
"type": "mode",
"name": "standard"
@ -53,17 +52,9 @@
{
"type": "property",
"name": "unique"
},
{
"type": "multiple",
"name": "multiple"
}
],
"path": "var2",
"names": [
"var2"
],
"description": "A second variable.",
"multiple": true,
"gen_examples": [
[
"no"

8
tests/results/test/00_2default_calculated.md
View file

@ -1,5 +1,5 @@
| Variable&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; | Description&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **<a id="var1" name="var1">var1</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A first variable.<br/>**Default**: no |
| **<a id="var2" name="var2">var2</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A second variable.<br/>**Default**: the value of var1 |
| Variable&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; | Description&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **<a id="var1" name="var1">var1</a>**<br/>`string` `standard` `mandatory` | A first variable.<br/>**Default**: no |
| **<a id="var2" name="var2">var2</a>**<br/>`string` `multiple` `standard` `mandatory` `unique` | A second variable.<br/>**Default**: the value of var1 |

4
tests/results/test/00_2default_calculated.sh
View file

@ -5,6 +5,6 @@
│  string   standard   mandatory  │ Default: no │
├───────────────────────────────────────┼──────────────────────────────────────┤
│ var2 │ A second variable. │
│  string   standard   mandatory    │ Default: the value of var1 │
│ unique   multiple  │ │
│  string   multiple   standard    │ Default: the value of var1 │
│ mandatory   unique  │ │
└───────────────────────────────────────┴──────────────────────────────────────┘

4
tests/results/test/00_2default_calculated_multi.adoc
View file

@ -2,14 +2,14 @@
|====
| Variable | Description
| **var1** +
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | A first variable. +
`string` `multiple` `standard` `mandatory` `unique` | A first variable. +
**Default**:
* no
* yes
* maybe
| **var2** +
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | A second variable. +
`string` `multiple` `standard` `mandatory` `unique` | A second variable. +
**Default**: the value of "var1"
|====

8
tests/results/test/00_2default_calculated_multi.gitlab.md
View file

@ -1,5 +1,5 @@
| Variable | Description |
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------|
| **<a id="var1" name="var1">var1</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A first variable.<br/>**Default**: <br/>• no<br/>• yes<br/>• maybe |
| **<a id="var2" name="var2">var2</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A second variable.<br/>**Default**: the value of "[a first variable](#var1)" |
| Variable | Description |
|-----------------------------------------------------------------------------------------------|------------------------------------------------------------------------------|
| **<a id="var1" name="var1">var1</a>**<br/>`string` `multiple` `standard` `mandatory` `unique` | A first variable.<br/>**Default**: <br/>• no<br/>• yes<br/>• maybe |
| **<a id="var2" name="var2">var2</a>**<br/>`string` `multiple` `standard` `mandatory` `unique` | A second variable.<br/>**Default**: the value of "[a first variable](#var1)" |

6
tests/results/test/00_2default_calculated_multi.html
View file

@ -1,12 +1,12 @@
<table>
<thead>
<tr><th>Variable </th><th>Description </th></tr>
<tr><th>Variable </th><th>Description </th></tr>
</thead>
<tbody>
<tr><td><b>var1</b><br/><mark><a href='https://rougail.readthedocs.io/en/latest/variable.html#variables-types'>string</a></mark> <mark>standard</mark> <mark>mandatory</mark> <mark>unique</mark> <mark>multiple</mark></td><td>A first variable.<br/><b>Default</b>: <ul><li>no</li>
<tr><td><b>var1</b><br/><mark>string</mark> <mark>multiple</mark> <mark>standard</mark> <mark>mandatory</mark> <mark>unique</mark></td><td>A first variable.<br/><b>Default</b>: <ul><li>no</li>
<li>yes</li>
<li>maybe</li></ul> </td></tr>
<tr><td><b>var2</b><br/><mark><a href='https://rougail.readthedocs.io/en/latest/variable.html#variables-types'>string</a></mark> <mark>standard</mark> <mark>mandatory</mark> <mark>unique</mark> <mark>multiple</mark></td><td>A second variable.<br/><b>Default</b>: the value of "var1"</td></tr>
<tr><td><b>var2</b><br/><mark>string</mark> <mark>multiple</mark> <mark>standard</mark> <mark>mandatory</mark> <mark>unique</mark></td><td>A second variable.<br/><b>Default</b>: the value of "var1"</td></tr>
</tbody>
</table>

40
tests/results/test/00_2default_calculated_multi.json
View file

@ -9,11 +9,13 @@
"maybe"
]
},
"variable_type": "string",
"path": "var1",
"names": [
"var1"
],
"description": "A first variable.",
"properties": [
{
"type": "type",
"name": "string"
},
{
"type": "mode",
"name": "standard"
@ -25,17 +27,9 @@
{
"type": "property",
"name": "unique"
},
{
"type": "multiple",
"name": "multiple"
}
],
"path": "var1",
"names": [
"var1"
],
"description": "A first variable.",
"multiple": true,
"gen_examples": [
[
"no",
@ -59,11 +53,13 @@
]
}
},
"variable_type": "string",
"path": "var2",
"names": [
"var2"
],
"description": "A second variable.",
"properties": [
{
"type": "type",
"name": "string"
},
{
"type": "mode",
"name": "standard"
@ -75,17 +71,9 @@
{
"type": "property",
"name": "unique"
},
{
"type": "multiple",
"name": "multiple"
}
],
"path": "var2",
"names": [
"var2"
],
"description": "A second variable.",
"multiple": true,
"gen_examples": [
[
"no",

8
tests/results/test/00_2default_calculated_multi.md
View file

@ -1,5 +1,5 @@
| Variable&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; | Description&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **<a id="var1" name="var1">var1</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A first variable.<br/>**Default**: <br/>• no<br/>• yes<br/>• maybe |
| **<a id="var2" name="var2">var2</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A second variable.<br/>**Default**: the value of "[a first variable](#var1)" |
| Variable&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; | Description&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **<a id="var1" name="var1">var1</a>**<br/>`string` `multiple` `standard` `mandatory` `unique` | A first variable.<br/>**Default**: <br/>• no<br/>• yes<br/>• maybe |
| **<a id="var2" name="var2">var2</a>**<br/>`string` `multiple` `standard` `mandatory` `unique` | A second variable.<br/>**Default**: the value of "[a first variable](#var1)" |

8
tests/results/test/00_2default_calculated_multi.sh
View file

@ -2,12 +2,12 @@
┃ Variable  ┃ Description  ┃
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
│ var1 │ A first variable. │
│  string   standard   mandatory    │ Default: │
│ unique   multiple  │ • no │
│  string   multiple   standard    │ Default: │
│ mandatory   unique  │ • no │
│ │ • yes │
│ │ • maybe │
├───────────────────────────────────────┼──────────────────────────────────────┤
│ var2 │ A second variable. │
│  string   standard   mandatory    │ Default: the value of "var1" │
│ unique   multiple  │ │
│  string   multiple   standard    │ Default: the value of "var1" │
│ mandatory   unique  │ │
└───────────────────────────────────────┴──────────────────────────────────────┘

2
tests/results/test/00_2default_calculated_params_permissive.adoc
View file

@ -2,7 +2,7 @@
|====
| Variable | Description
| **var2** +
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A second variable. +
`string` `standard` `mandatory` | A second variable. +
**Default**: depends on a calculation
|====

6
tests/results/test/00_2default_calculated_params_permissive.gitlab.md
View file

@ -1,4 +1,4 @@
| Variable | Description |
|-----------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------|
| **<a id="var2" name="var2">var2</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second variable.<br/>**Default**: depends on a calculation |
| Variable | Description |
|---------------------------------------------------------------------------|--------------------------------------------------------------|
| **<a id="var2" name="var2">var2</a>**<br/>`string` `standard` `mandatory` | A second variable.<br/>**Default**: depends on a calculation |

4
tests/results/test/00_2default_calculated_params_permissive.html
View file

@ -1,9 +1,9 @@
<table>
<thead>
<tr><th>Variable </th><th>Description </th></tr>
<tr><th>Variable </th><th>Description </th></tr>
</thead>
<tbody>
<tr><td><b>var2</b><br/><mark><a href='https://rougail.readthedocs.io/en/latest/variable.html#variables-types'>string</a></mark> <mark>standard</mark> <mark>mandatory</mark></td><td>A second variable.<br/><b>Default</b>: depends on a calculation</td></tr>
<tr><td><b>var2</b><br/><mark>string</mark> <mark>standard</mark> <mark>mandatory</mark></td><td>A second variable.<br/><b>Default</b>: depends on a calculation</td></tr>
</tbody>
</table>

15
tests/results/test/00_2default_calculated_params_permissive.json
View file

@ -5,11 +5,13 @@
"name": "Default",
"values": "depends on a calculation"
},
"variable_type": "string",
"path": "var2",
"names": [
"var2"
],
"description": "A second variable.",
"properties": [
{
"type": "type",
"name": "string"
},
{
"type": "mode",
"name": "standard"
@ -19,11 +21,6 @@
"name": "mandatory"
}
],
"path": "var2",
"names": [
"var2"
],
"description": "A second variable.",
"gen_examples": [
"a_value"
],

6
tests/results/test/00_2default_calculated_params_permissive.md
View file

@ -1,4 +1,4 @@
| Variable&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; | Description&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **<a id="var2" name="var2">var2</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second variable.<br/>**Default**: depends on a calculation |
| Variable&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; | Description&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **<a id="var2" name="var2">var2</a>**<br/>`string` `standard` `mandatory` | A second variable.<br/>**Default**: depends on a calculation |

4
tests/results/test/00_2default_calculated_variable.adoc
View file

@ -2,13 +2,13 @@
|====
| Variable | Description
| **var1** +
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[domainname]` `basic` `mandatory` `unique` `multiple` | A first variable. +
`domainname` `multiple` `basic` `mandatory` `unique` | A first variable. +
**Validators**:
* type domainname
* the domain name can be an IP
| **var2** +
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[domainname]` `standard` `mandatory` `unique` `multiple` | A second variable. +
`domainname` `multiple` `standard` `mandatory` `unique` | A second variable. +
**Validator**: type domainname +
**Default**: the value of the variable "var1"
|====

8
tests/results/test/00_2default_calculated_variable.gitlab.md
View file

@ -1,5 +1,5 @@
| Variable | Description |
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------|
| **<a id="var1" name="var1">var1</a>**<br/>[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | A first variable.<br/>**Validators**: <br/>• type domainname<br/>• the domain name can be an IP |
| **<a id="var2" name="var2">var2</a>**<br/>[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A second variable.<br/>**Validator**: type domainname<br/>**Default**: the value of the variable "[A first variable](#var1)" |
| Variable | Description |
|---------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------|
| **<a id="var1" name="var1">var1</a>**<br/>`domainname` `multiple` `basic` `mandatory` `unique` | A first variable.<br/>**Validators**: <br/>• type domainname<br/>• the domain name can be an IP |
| **<a id="var2" name="var2">var2</a>**<br/>`domainname` `multiple` `standard` `mandatory` `unique` | A second variable.<br/>**Validator**: type domainname<br/>**Default**: the value of the variable "[A first variable](#var1)" |

6
tests/results/test/00_2default_calculated_variable.html
View file

@ -1,11 +1,11 @@
<table>
<thead>
<tr><th>Variable </th><th>Description </th></tr>
<tr><th>Variable </th><th>Description </th></tr>
</thead>
<tbody>
<tr><td><b>var1</b><br/><mark><a href='https://rougail.readthedocs.io/en/latest/variable.html#variables-types'>domainname</a></mark> <mark>basic</mark> <mark>mandatory</mark> <mark>unique</mark> <mark>multiple</mark> </td><td>A first variable.<br/><b>Validators</b>: <ul><li>type domainname</li>
<tr><td><b>var1</b><br/><mark>domainname</mark> <mark>multiple</mark> <mark>basic</mark> <mark>mandatory</mark> <mark>unique</mark> </td><td>A first variable.<br/><b>Validators</b>: <ul><li>type domainname</li>
<li>the domain name can be an IP</li></ul> </td></tr>
<tr><td><b>var2</b><br/><mark><a href='https://rougail.readthedocs.io/en/latest/variable.html#variables-types'>domainname</a></mark> <mark>standard</mark> <mark>mandatory</mark> <mark>unique</mark> <mark>multiple</mark></td><td>A second variable.<br/><b>Validator</b>: type domainname<br/><b>Default</b>: the value of the variable "var1"</td></tr>
<tr><td><b>var2</b><br/><mark>domainname</mark> <mark>multiple</mark> <mark>standard</mark> <mark>mandatory</mark> <mark>unique</mark></td><td>A second variable.<br/><b>Validator</b>: type domainname<br/><b>Default</b>: the value of the variable "var1"</td></tr>
</tbody>
</table>

66
tests/results/test/00_2default_calculated_variable.json
View file

@ -1,28 +1,7 @@
{
"var1": {
"type": "variable",
"properties": [
{
"type": "type",
"name": "domainname"
},
{
"type": "mode",
"name": "basic"
},
{
"type": "property",
"name": "mandatory"
},
{
"type": "property",
"name": "unique"
},
{
"type": "multiple",
"name": "multiple"
}
],
"variable_type": "domainname",
"validators": {
"name": "Validators",
"values": [
@ -35,6 +14,21 @@
"var1"
],
"description": "A first variable.",
"properties": [
{
"type": "mode",
"name": "basic"
},
{
"type": "property",
"name": "mandatory"
},
{
"type": "property",
"name": "unique"
}
],
"multiple": true,
"gen_examples": [
[
"example.net"
@ -54,11 +48,17 @@
"description": "A first variable"
}
},
"variable_type": "domainname",
"validators": {
"name": "Validator",
"values": "type domainname"
},
"path": "var2",
"names": [
"var2"
],
"description": "A second variable.",
"properties": [
{
"type": "type",
"name": "domainname"
},
{
"type": "mode",
"name": "standard"
@ -70,21 +70,9 @@
{
"type": "property",
"name": "unique"
},
{
"type": "multiple",
"name": "multiple"
}
],
"validators": {
"name": "Validator",
"values": "type domainname"
},
"path": "var2",
"names": [
"var2"
],
"description": "A second variable.",
"multiple": true,
"gen_examples": [
[
"example.net"

8
tests/results/test/00_2default_calculated_variable.md
View file

@ -1,5 +1,5 @@
| Variable&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; | Description&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **<a id="var1" name="var1">var1</a>**<br/>[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | A first variable.<br/>**Validators**: <br/>• type domainname<br/>• the domain name can be an IP |
| **<a id="var2" name="var2">var2</a>**<br/>[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A second variable.<br/>**Validator**: type domainname<br/>**Default**: the value of the variable "[A first variable](#var1)" |
| Variable&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; | Description&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **<a id="var1" name="var1">var1</a>**<br/>`domainname` `multiple` `basic` `mandatory` `unique` | A first variable.<br/>**Validators**: <br/>• type domainname<br/>• the domain name can be an IP |
| **<a id="var2" name="var2">var2</a>**<br/>`domainname` `multiple` `standard` `mandatory` `unique` | A second variable.<br/>**Validator**: type domainname<br/>**Default**: the value of the variable "[A first variable](#var1)" |

8
tests/results/test/00_2default_calculated_variable.sh
View file

@ -2,12 +2,12 @@
┃ Variable  ┃ Description  ┃
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
│ var1 │ A first variable. │
│  domainname   basic   mandatory    │ Validators: │
│ unique   multiple  │ • type domainname │
│  domainname   multiple   basic    │ Validators: │
│ mandatory   unique  │ • type domainname │
│ │ • the domain name can be an IP │
├───────────────────────────────────────┼──────────────────────────────────────┤
│ var2 │ A second variable. │
│  domainname   standard   mandatory    │ Validator: type domainname │
│ unique   multiple  │ Default: the value of the variable │
│  domainname   multiple   standard    │ Validator: type domainname │
│ mandatory   unique  │ Default: the value of the variable │
│ │ "var1" │
└───────────────────────────────────────┴──────────────────────────────────────┘

4
tests/results/test/00_2default_calculated_variable_description.adoc
View file

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

8
tests/results/test/00_2default_calculated_variable_description.gitlab.md
View file

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

6
tests/results/test/00_2default_calculated_variable_description.html
View file

@ -1,10 +1,10 @@
<table>
<thead>
<tr><th>Variable </th><th>Description </th></tr>
<tr><th>Variable </th><th>Description </th></tr>
</thead>
<tbody>
<tr><td><b>var1</b><br/><mark><a href='https://rougail.readthedocs.io/en/latest/variable.html#variables-types'>string</a></mark> <mark>basic</mark> <mark>mandatory</mark> </td><td>A first variable. </td></tr>
<tr><td><b>var2</b><br/><mark><a href='https://rougail.readthedocs.io/en/latest/variable.html#variables-types'>string</a></mark> <mark>standard</mark> <mark>mandatory</mark></td><td>A second variable.<br/><b>Default</b>: value of a variable!</td></tr>
<tr><td><b>var1</b><br/><mark>string</mark> <mark>basic</mark> <mark>mandatory</mark> </td><td>A first variable. </td></tr>
<tr><td><b>var2</b><br/><mark>string</mark> <mark>standard</mark> <mark>mandatory</mark></td><td>A second variable.<br/><b>Default</b>: value of a variable!</td></tr>
</tbody>
</table>

30
tests/results/test/00_2default_calculated_variable_description.json
View file

@ -1,11 +1,13 @@
{
"var1": {
"type": "variable",
"variable_type": "string",
"path": "var1",
"names": [
"var1"
],
"description": "A first variable.",
"properties": [
{
"type": "type",
"name": "string"
},
{
"type": "mode",
"name": "basic"
@ -15,11 +17,6 @@
"name": "mandatory"
}
],
"path": "var1",
"names": [
"var1"
],
"description": "A first variable.",
"gen_examples": [
"example"
],
@ -33,11 +30,13 @@
"description": "value of a variable!"
}
},
"variable_type": "string",
"path": "var2",
"names": [
"var2"
],
"description": "A second variable.",
"properties": [
{
"type": "type",
"name": "string"
},
{
"type": "mode",
"name": "standard"
@ -47,11 +46,6 @@
"name": "mandatory"
}
],
"path": "var2",
"names": [
"var2"
],
"description": "A second variable.",
"gen_examples": [
"example"
],

8
tests/results/test/00_2default_calculated_variable_description.md
View file

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

6
tests/results/test/00_2default_calculated_variable_description_multi_line.adoc
View file

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

10
tests/results/test/00_2default_calculated_variable_description_multi_line.gitlab.md
View file

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

8
tests/results/test/00_2default_calculated_variable_description_multi_line.html
View file

@ -1,14 +1,14 @@
<table>
<thead>
<tr><th>Variable </th><th>Description </th></tr>
<tr><th>Variable </th><th>Description </th></tr>
</thead>
<tbody>
<tr><td><b>var1</b><br/><mark><a href='https://rougail.readthedocs.io/en/latest/variable.html#variables-types'>string</a></mark> <mark>basic</mark> <mark>mandatory</mark> </td><td>A first variable.</td></tr>
<tr><td><b>var2</b><br/><mark><a href='https://rougail.readthedocs.io/en/latest/variable.html#variables-types'>string</a></mark> <mark>standard</mark> <mark>mandatory</mark></td><td>A second variable.<br/><b>Default</b>: value
<tr><td><b>var1</b><br/><mark>string</mark> <mark>basic</mark> <mark>mandatory</mark> </td><td>A first variable.</td></tr>
<tr><td><b>var2</b><br/><mark>string</mark> <mark>standard</mark> <mark>mandatory</mark></td><td>A second variable.<br/><b>Default</b>: value
of
a
variable! </td></tr>
<tr><td><b>var3</b><br/><mark><a href='https://rougail.readthedocs.io/en/latest/variable.html#variables-types'>string</a></mark> <mark>basic</mark> <mark>mandatory</mark> </td><td>A new variable. </td></tr>
<tr><td><b>var3</b><br/><mark>string</mark> <mark>basic</mark> <mark>mandatory</mark> </td><td>A new variable. </td></tr>
</tbody>
</table>

45
tests/results/test/00_2default_calculated_variable_description_multi_line.json
View file

@ -1,11 +1,13 @@
{
"var1": {
"type": "variable",
"variable_type": "string",
"path": "var1",
"names": [
"var1"
],
"description": "A first variable.",
"properties": [
{
"type": "type",
"name": "string"
},
{
"type": "mode",
"name": "basic"
@ -15,11 +17,6 @@
"name": "mandatory"
}
],
"path": "var1",
"names": [
"var1"
],
"description": "A first variable.",
"gen_examples": [
"example"
],
@ -33,11 +30,13 @@
"description": "value\nof\na\nvariable!"
}
},
"variable_type": "string",
"path": "var2",
"names": [
"var2"
],
"description": "A second variable.",
"properties": [
{
"type": "type",
"name": "string"
},
{
"type": "mode",
"name": "standard"
@ -47,11 +46,6 @@
"name": "mandatory"
}
],
"path": "var2",
"names": [
"var2"
],
"description": "A second variable.",
"gen_examples": [
"example"
],
@ -59,11 +53,13 @@
},
"var3": {
"type": "variable",
"variable_type": "string",
"path": "var3",
"names": [
"var3"
],
"description": "A new variable.",
"properties": [
{
"type": "type",
"name": "string"
},
{
"type": "mode",
"name": "basic"
@ -73,11 +69,6 @@
"name": "mandatory"
}
],
"path": "var3",
"names": [
"var3"
],
"description": "A new variable.",
"gen_examples": [
"example"
],

10
tests/results/test/00_2default_calculated_variable_description_multi_line.md
View file

@ -1,6 +1,6 @@
| Variable&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; | Description&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **<a id="var1" name="var1">var1</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A first variable. |
| **<a id="var2" name="var2">var2</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second variable.<br/>**Default**: value<br/>of<br/>a<br/>variable! |
| **<a id="var3" name="var3">var3</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A new variable. |
| Variable&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; | Description&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **<a id="var1" name="var1">var1</a>**<br/>`string` `basic` `mandatory` | A first variable. |
| **<a id="var2" name="var2">var2</a>**<br/>`string` `standard` `mandatory` | A second variable.<br/>**Default**: value<br/>of<br/>a<br/>variable! |
| **<a id="var3" name="var3">var3</a>**<br/>`string` `basic` `mandatory` | A new variable. |

4
tests/results/test/00_2default_calculated_variable_transitive.adoc
View file

@ -2,13 +2,13 @@
|====
| Variable | Description
| **var1** +
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[domainname]` `basic` `mandatory` `unique` `multiple` | A first variable. +
`domainname` `multiple` `basic` `mandatory` `unique` | A first variable. +
**Validators**:
* type domainname
* the domain name can be an IP
| **var2** +
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[domainname]` `standard` `mandatory` `unique` `multiple` | A second variable. +
`domainname` `multiple` `standard` `mandatory` `unique` | A second variable. +
**Validators**:
* type domainname

8
tests/results/test/00_2default_calculated_variable_transitive.gitlab.md
View file

@ -1,5 +1,5 @@
| Variable | Description |
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **<a id="var1" name="var1">var1</a>**<br/>[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | A first variable.<br/>**Validators**: <br/>• type domainname<br/>• the domain name can be an IP |
| **<a id="var2" name="var2">var2</a>**<br/>[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A second variable.<br/>**Validators**: <br/>• type domainname<br/>• the domain name can be an IP<br/>**Default**: the value of the variable "[A first variable](#var1)" |
| Variable | Description |
|---------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **<a id="var1" name="var1">var1</a>**<br/>`domainname` `multiple` `basic` `mandatory` `unique` | A first variable.<br/>**Validators**: <br/>• type domainname<br/>• the domain name can be an IP |
| **<a id="var2" name="var2">var2</a>**<br/>`domainname` `multiple` `standard` `mandatory` `unique` | A second variable.<br/>**Validators**: <br/>• type domainname<br/>• the domain name can be an IP<br/>**Default**: the value of the variable "[A first variable](#var1)" |

6
tests/results/test/00_2default_calculated_variable_transitive.html
View file

@ -1,11 +1,11 @@
<table>
<thead>
<tr><th>Variable </th><th>Description </th></tr>
<tr><th>Variable </th><th>Description </th></tr>
</thead>
<tbody>
<tr><td><b>var1</b><br/><mark><a href='https://rougail.readthedocs.io/en/latest/variable.html#variables-types'>domainname</a></mark> <mark>basic</mark> <mark>mandatory</mark> <mark>unique</mark> <mark>multiple</mark> </td><td>A first variable.<br/><b>Validators</b>: <ul><li>type domainname</li>
<tr><td><b>var1</b><br/><mark>domainname</mark> <mark>multiple</mark> <mark>basic</mark> <mark>mandatory</mark> <mark>unique</mark> </td><td>A first variable.<br/><b>Validators</b>: <ul><li>type domainname</li>
<li>the domain name can be an IP</li></ul> </td></tr>
<tr><td><b>var2</b><br/><mark><a href='https://rougail.readthedocs.io/en/latest/variable.html#variables-types'>domainname</a></mark> <mark>standard</mark> <mark>mandatory</mark> <mark>unique</mark> <mark>multiple</mark></td><td>A second variable.<br/><b>Validators</b>: <ul><li>type domainname</li>
<tr><td><b>var2</b><br/><mark>domainname</mark> <mark>multiple</mark> <mark>standard</mark> <mark>mandatory</mark> <mark>unique</mark></td><td>A second variable.<br/><b>Validators</b>: <ul><li>type domainname</li>
<li>the domain name can be an IP</li></ul><br/><b>Default</b>: the value of the variable "var1" </td></tr>
</tbody>
</table>

76
tests/results/test/00_2default_calculated_variable_transitive.json
View file

@ -1,28 +1,7 @@
{
"var1": {
"type": "variable",
"properties": [
{
"type": "type",
"name": "domainname"
},
{
"type": "mode",
"name": "basic"
},
{
"type": "property",
"name": "mandatory"
},
{
"type": "property",
"name": "unique"
},
{
"type": "multiple",
"name": "multiple"
}
],
"variable_type": "domainname",
"validators": {
"name": "Validators",
"values": [
@ -35,6 +14,21 @@
"var1"
],
"description": "A first variable.",
"properties": [
{
"type": "mode",
"name": "basic"
},
{
"type": "property",
"name": "mandatory"
},
{
"type": "property",
"name": "unique"
}
],
"multiple": true,
"gen_examples": [
[
"example.net"
@ -54,28 +48,7 @@
"description": "A first variable"
}
},
"properties": [
{
"type": "type",
"name": "domainname"
},
{
"type": "mode",
"name": "standard"
},
{
"type": "property",
"name": "mandatory"
},
{
"type": "property",
"name": "unique"
},
{
"type": "multiple",
"name": "multiple"
}
],
"variable_type": "domainname",
"validators": {
"name": "Validators",
"values": [
@ -88,6 +61,21 @@
"var2"
],
"description": "A second variable.",
"properties": [
{
"type": "mode",
"name": "standard"
},
{
"type": "property",
"name": "mandatory"
},
{
"type": "property",
"name": "unique"
}
],
"multiple": true,
"gen_examples": [
[
"example.net"

8
tests/results/test/00_2default_calculated_variable_transitive.md
View file

@ -1,5 +1,5 @@
| Variable&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; | Description&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **<a id="var1" name="var1">var1</a>**<br/>[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | A first variable.<br/>**Validators**: <br/>• type domainname<br/>• the domain name can be an IP |
| **<a id="var2" name="var2">var2</a>**<br/>[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A second variable.<br/>**Validators**: <br/>• type domainname<br/>• the domain name can be an IP<br/>**Default**: the value of the variable "[A first variable](#var1)" |
| Variable&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; | Description&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **<a id="var1" name="var1">var1</a>**<br/>`domainname` `multiple` `basic` `mandatory` `unique` | A first variable.<br/>**Validators**: <br/>• type domainname<br/>• the domain name can be an IP |
| **<a id="var2" name="var2">var2</a>**<br/>`domainname` `multiple` `standard` `mandatory` `unique` | A second variable.<br/>**Validators**: <br/>• type domainname<br/>• the domain name can be an IP<br/>**Default**: the value of the variable "[A first variable](#var1)" |

8
tests/results/test/00_2default_calculated_variable_transitive.sh
View file

@ -2,13 +2,13 @@
┃ Variable  ┃ Description  ┃
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
│ var1 │ A first variable. │
│  domainname   basic   mandatory    │ Validators: │
│ unique   multiple  │ • type domainname │
│  domainname   multiple   basic    │ Validators: │
│ mandatory   unique  │ • type domainname │
│ │ • the domain name can be an IP │
├───────────────────────────────────────┼──────────────────────────────────────┤
│ var2 │ A second variable. │
│  domainname   standard   mandatory    │ Validators: │
│ unique   multiple  │ • type domainname │
│  domainname   multiple   standard    │ Validators: │
│ mandatory   unique  │ • type domainname │
│ │ • the domain name can be an IP │
│ │ Default: the value of the variable │
│ │ "var1" │

4
tests/results/test/00_4load_subfolder.adoc
View file

@ -2,8 +2,8 @@
|====
| Variable | Description
| **var1** +
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | A variable.
`string` `basic` `mandatory` | A variable.
| **var2** +
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | A variable.
`string` `basic` `mandatory` | A variable.
|====

8
tests/results/test/00_4load_subfolder.gitlab.md
View file

@ -1,5 +1,5 @@
| Variable | Description |
|--------------------------------------------------------------------------------------------------------------------------------------------------|---------------|
| **<a id="var1" name="var1">var1</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. |
| **<a id="var2" name="var2">var2</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. |
| Variable | Description |
|------------------------------------------------------------------------|---------------|
| **<a id="var1" name="var1">var1</a>**<br/>`string` `basic` `mandatory` | A variable. |
| **<a id="var2" name="var2">var2</a>**<br/>`string` `basic` `mandatory` | A variable. |

6
tests/results/test/00_4load_subfolder.html
View file

@ -1,10 +1,10 @@
<table>
<thead>
<tr><th>Variable </th><th>Description </th></tr>
<tr><th>Variable </th><th>Description </th></tr>
</thead>
<tbody>
<tr><td><b>var1</b><br/><mark><a href='https://rougail.readthedocs.io/en/latest/variable.html#variables-types'>string</a></mark> <mark>basic</mark> <mark>mandatory</mark></td><td>A variable. </td></tr>
<tr><td><b>var2</b><br/><mark><a href='https://rougail.readthedocs.io/en/latest/variable.html#variables-types'>string</a></mark> <mark>basic</mark> <mark>mandatory</mark></td><td>A variable. </td></tr>
<tr><td><b>var1</b><br/><mark>string</mark> <mark>basic</mark> <mark>mandatory</mark></td><td>A variable. </td></tr>
<tr><td><b>var2</b><br/><mark>string</mark> <mark>basic</mark> <mark>mandatory</mark></td><td>A variable. </td></tr>
</tbody>
</table>

30
tests/results/test/00_4load_subfolder.json
View file

@ -1,11 +1,13 @@
{
"var1": {
"type": "variable",
"variable_type": "string",
"path": "var1",
"names": [
"var1"
],
"description": "A variable.",
"properties": [
{
"type": "type",
"name": "string"
},
{
"type": "mode",
"name": "basic"
@ -15,11 +17,6 @@
"name": "mandatory"
}
],
"path": "var1",
"names": [
"var1"
],
"description": "A variable.",
"gen_examples": [
"example"
],
@ -27,11 +24,13 @@
},
"var2": {
"type": "variable",
"variable_type": "string",
"path": "var2",
"names": [
"var2"
],
"description": "A variable.",
"properties": [
{
"type": "type",
"name": "string"
},
{
"type": "mode",
"name": "basic"
@ -41,11 +40,6 @@
"name": "mandatory"
}
],
"path": "var2",
"names": [
"var2"
],
"description": "A variable.",
"gen_examples": [
"example"
],

8
tests/results/test/00_4load_subfolder.md
View file

@ -1,5 +1,5 @@
| Variable&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; | Description&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **<a id="var1" name="var1">var1</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. |
| **<a id="var2" name="var2">var2</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. |
| Variable&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; | Description&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **<a id="var1" name="var1">var1</a>**<br/>`string` `basic` `mandatory` | A variable. |
| **<a id="var2" name="var2">var2</a>**<br/>`string` `basic` `mandatory` | A variable. |

2
tests/results/test/00_5load_notype.adoc
View file

@ -2,7 +2,7 @@
|====
| Variable | Description
| **without_type** +
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A variable. +
`string` `standard` `mandatory` | A variable. +
**Default**: non
|====

6
tests/results/test/00_5load_notype.gitlab.md
View file

@ -1,4 +1,4 @@
| Variable | Description |
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------|
| **<a id="without_type" name="without_type">without_type</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.<br/>**Default**: non |
| Variable | Description |
|---------------------------------------------------------------------------------------------------|----------------------------------|
| **<a id="without_type" name="without_type">without_type</a>**<br/>`string` `standard` `mandatory` | A variable.<br/>**Default**: non |

4
tests/results/test/00_5load_notype.html
View file

@ -1,9 +1,9 @@
<table>
<thead>
<tr><th>Variable </th><th>Description </th></tr>
<tr><th>Variable </th><th>Description </th></tr>
</thead>
<tbody>
<tr><td><b>without_type</b><br/><mark><a href='https://rougail.readthedocs.io/en/latest/variable.html#variables-types'>string</a></mark> <mark>standard</mark> <mark>mandatory</mark></td><td>A variable.<br/><b>Default</b>: non</td></tr>
<tr><td><b>without_type</b><br/><mark>string</mark> <mark>standard</mark> <mark>mandatory</mark></td><td>A variable.<br/><b>Default</b>: non</td></tr>
</tbody>
</table>

15
tests/results/test/00_5load_notype.json
View file

@ -5,11 +5,13 @@
"name": "Default",
"values": "non"
},
"variable_type": "string",
"path": "without_type",
"names": [
"without_type"
],
"description": "A variable.",
"properties": [
{
"type": "type",
"name": "string"
},
{
"type": "mode",
"name": "standard"
@ -19,11 +21,6 @@
"name": "mandatory"
}
],
"path": "without_type",
"names": [
"without_type"
],
"description": "A variable.",
"gen_examples": [
"non"
],

6
tests/results/test/00_5load_notype.md
View file

@ -1,4 +1,4 @@
| Variable&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; | Description&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **<a id="without_type" name="without_type">without_type</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.<br/>**Default**: non |
| Variable&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; | Description&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **<a id="without_type" name="without_type">without_type</a>**<br/>`string` `standard` `mandatory` | A variable.<br/>**Default**: non |

12
tests/results/test/00_6boolean.adoc
View file

@ -2,22 +2,22 @@
|====
| Variable | Description
| **var1** +
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | The first variable. +
`boolean` `standard` `mandatory` | The first variable. +
**Default**: true
| **var2** +
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | The second variable. +
`boolean` `standard` `mandatory` | The second variable. +
**Default**: true
| **var3** +
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | The third variable. +
`boolean` `standard` `mandatory` | The third variable. +
**Default**: true
| **var4** +
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | The forth variable. +
`boolean` `standard` `mandatory` | The forth variable. +
**Default**: false
| **var5** +
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | The fifth variable. +
`boolean` `standard` `mandatory` | The fifth variable. +
**Default**: false
| **var6** +
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | The sixth variable. +
`boolean` `standard` `mandatory` | The sixth variable. +
**Default**: false
|====

16
tests/results/test/00_6boolean.gitlab.md
View file

@ -1,9 +1,9 @@
| Variable | Description |
|------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------|
| **<a id="var1" name="var1">var1</a>**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The first variable.<br/>**Default**: true |
| **<a id="var2" name="var2">var2</a>**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The second variable.<br/>**Default**: true |
| **<a id="var3" name="var3">var3</a>**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The third variable.<br/>**Default**: true |
| **<a id="var4" name="var4">var4</a>**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The forth variable.<br/>**Default**: false |
| **<a id="var5" name="var5">var5</a>**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The fifth variable.<br/>**Default**: false |
| **<a id="var6" name="var6">var6</a>**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The sixth variable.<br/>**Default**: false |
| Variable | Description |
|----------------------------------------------------------------------------|--------------------------------------------|
| **<a id="var1" name="var1">var1</a>**<br/>`boolean` `standard` `mandatory` | The first variable.<br/>**Default**: true |
| **<a id="var2" name="var2">var2</a>**<br/>`boolean` `standard` `mandatory` | The second variable.<br/>**Default**: true |
| **<a id="var3" name="var3">var3</a>**<br/>`boolean` `standard` `mandatory` | The third variable.<br/>**Default**: true |
| **<a id="var4" name="var4">var4</a>**<br/>`boolean` `standard` `mandatory` | The forth variable.<br/>**Default**: false |
| **<a id="var5" name="var5">var5</a>**<br/>`boolean` `standard` `mandatory` | The fifth variable.<br/>**Default**: false |
| **<a id="var6" name="var6">var6</a>**<br/>`boolean` `standard` `mandatory` | The sixth variable.<br/>**Default**: false |

14
tests/results/test/00_6boolean.html
View file

@ -1,14 +1,14 @@
<table>
<thead>
<tr><th>Variable </th><th>Description </th></tr>
<tr><th>Variable </th><th>Description </th></tr>
</thead>
<tbody>
<tr><td><b>var1</b><br/><mark><a href='https://rougail.readthedocs.io/en/latest/variable.html#variables-types'>boolean</a></mark> <mark>standard</mark> <mark>mandatory</mark></td><td>The first variable.<br/><b>Default</b>: true </td></tr>
<tr><td><b>var2</b><br/><mark><a href='https://rougail.readthedocs.io/en/latest/variable.html#variables-types'>boolean</a></mark> <mark>standard</mark> <mark>mandatory</mark></td><td>The second variable.<br/><b>Default</b>: true</td></tr>
<tr><td><b>var3</b><br/><mark><a href='https://rougail.readthedocs.io/en/latest/variable.html#variables-types'>boolean</a></mark> <mark>standard</mark> <mark>mandatory</mark></td><td>The third variable.<br/><b>Default</b>: true </td></tr>
<tr><td><b>var4</b><br/><mark><a href='https://rougail.readthedocs.io/en/latest/variable.html#variables-types'>boolean</a></mark> <mark>standard</mark> <mark>mandatory</mark></td><td>The forth variable.<br/><b>Default</b>: false</td></tr>
<tr><td><b>var5</b><br/><mark><a href='https://rougail.readthedocs.io/en/latest/variable.html#variables-types'>boolean</a></mark> <mark>standard</mark> <mark>mandatory</mark></td><td>The fifth variable.<br/><b>Default</b>: false</td></tr>
<tr><td><b>var6</b><br/><mark><a href='https://rougail.readthedocs.io/en/latest/variable.html#variables-types'>boolean</a></mark> <mark>standard</mark> <mark>mandatory</mark></td><td>The sixth variable.<br/><b>Default</b>: false</td></tr>
<tr><td><b>var1</b><br/><mark>boolean</mark> <mark>standard</mark> <mark>mandatory</mark></td><td>The first variable.<br/><b>Default</b>: true </td></tr>
<tr><td><b>var2</b><br/><mark>boolean</mark> <mark>standard</mark> <mark>mandatory</mark></td><td>The second variable.<br/><b>Default</b>: true</td></tr>
<tr><td><b>var3</b><br/><mark>boolean</mark> <mark>standard</mark> <mark>mandatory</mark></td><td>The third variable.<br/><b>Default</b>: true </td></tr>
<tr><td><b>var4</b><br/><mark>boolean</mark> <mark>standard</mark> <mark>mandatory</mark></td><td>The forth variable.<br/><b>Default</b>: false</td></tr>
<tr><td><b>var5</b><br/><mark>boolean</mark> <mark>standard</mark> <mark>mandatory</mark></td><td>The fifth variable.<br/><b>Default</b>: false</td></tr>
<tr><td><b>var6</b><br/><mark>boolean</mark> <mark>standard</mark> <mark>mandatory</mark></td><td>The sixth variable.<br/><b>Default</b>: false</td></tr>
</tbody>
</table>

90
tests/results/test/00_6boolean.json
View file

@ -5,11 +5,13 @@
"name": "Default",
"values": true
},
"variable_type": "boolean",
"path": "var1",
"names": [
"var1"
],
"description": "The first variable.",
"properties": [
{
"type": "type",
"name": "boolean"
},
{
"type": "mode",
"name": "standard"
@ -19,11 +21,6 @@
"name": "mandatory"
}
],
"path": "var1",
"names": [
"var1"
],
"description": "The first variable.",
"gen_examples": [
true
],
@ -35,11 +32,13 @@
"name": "Default",
"values": true
},
"variable_type": "boolean",
"path": "var2",
"names": [
"var2"
],
"description": "The second variable.",
"properties": [
{
"type": "type",
"name": "boolean"
},
{
"type": "mode",
"name": "standard"
@ -49,11 +48,6 @@
"name": "mandatory"
}
],
"path": "var2",
"names": [
"var2"
],
"description": "The second variable.",
"gen_examples": [
true
],
@ -65,11 +59,13 @@
"name": "Default",
"values": true
},
"variable_type": "boolean",
"path": "var3",
"names": [
"var3"
],
"description": "The third variable.",
"properties": [
{
"type": "type",
"name": "boolean"
},
{
"type": "mode",
"name": "standard"
@ -79,11 +75,6 @@
"name": "mandatory"
}
],
"path": "var3",
"names": [
"var3"
],
"description": "The third variable.",
"gen_examples": [
true
],
@ -95,11 +86,13 @@
"name": "Default",
"values": false
},
"variable_type": "boolean",
"path": "var4",
"names": [
"var4"
],
"description": "The forth variable.",
"properties": [
{
"type": "type",
"name": "boolean"
},
{
"type": "mode",
"name": "standard"
@ -109,11 +102,6 @@
"name": "mandatory"
}
],
"path": "var4",
"names": [
"var4"
],
"description": "The forth variable.",
"gen_examples": [
false
],
@ -125,11 +113,13 @@
"name": "Default",
"values": false
},
"variable_type": "boolean",
"path": "var5",
"names": [
"var5"
],
"description": "The fifth variable.",
"properties": [
{
"type": "type",
"name": "boolean"
},
{
"type": "mode",
"name": "standard"
@ -139,11 +129,6 @@
"name": "mandatory"
}
],
"path": "var5",
"names": [
"var5"
],
"description": "The fifth variable.",
"gen_examples": [
false
],
@ -155,11 +140,13 @@
"name": "Default",
"values": false
},
"variable_type": "boolean",
"path": "var6",
"names": [
"var6"
],
"description": "The sixth variable.",
"properties": [
{
"type": "type",
"name": "boolean"
},
{
"type": "mode",
"name": "standard"
@ -169,11 +156,6 @@
"name": "mandatory"
}
],
"path": "var6",
"names": [
"var6"
],
"description": "The sixth variable.",
"gen_examples": [
false
],

16
tests/results/test/00_6boolean.md
View file

@ -1,9 +1,9 @@
| Variable&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; | Description&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **<a id="var1" name="var1">var1</a>**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The first variable.<br/>**Default**: true |
| **<a id="var2" name="var2">var2</a>**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The second variable.<br/>**Default**: true |
| **<a id="var3" name="var3">var3</a>**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The third variable.<br/>**Default**: true |
| **<a id="var4" name="var4">var4</a>**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The forth variable.<br/>**Default**: false |
| **<a id="var5" name="var5">var5</a>**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The fifth variable.<br/>**Default**: false |
| **<a id="var6" name="var6">var6</a>**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The sixth variable.<br/>**Default**: false |
| Variable&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; | Description&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **<a id="var1" name="var1">var1</a>**<br/>`boolean` `standard` `mandatory` | The first variable.<br/>**Default**: true |
| **<a id="var2" name="var2">var2</a>**<br/>`boolean` `standard` `mandatory` | The second variable.<br/>**Default**: true |
| **<a id="var3" name="var3">var3</a>**<br/>`boolean` `standard` `mandatory` | The third variable.<br/>**Default**: true |
| **<a id="var4" name="var4">var4</a>**<br/>`boolean` `standard` `mandatory` | The forth variable.<br/>**Default**: false |
| **<a id="var5" name="var5">var5</a>**<br/>`boolean` `standard` `mandatory` | The fifth variable.<br/>**Default**: false |
| **<a id="var6" name="var6">var6</a>**<br/>`boolean` `standard` `mandatory` | The sixth variable.<br/>**Default**: false |

2
tests/results/test/00_6boolean_no_mandatory.adoc
View file

@ -2,7 +2,7 @@
|====
| Variable | Description
| **variable** +
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` | A variable. +
`boolean` `standard` | A variable. +
**Default**: true
|====

6
tests/results/test/00_6boolean_no_mandatory.gitlab.md
View file

@ -1,4 +1,4 @@
| Variable | Description |
|------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------|
| **<a id="variable" name="variable">variable</a>**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A variable.<br/>**Default**: true |
| Variable | Description |
|----------------------------------------------------------------------------|-----------------------------------|
| **<a id="variable" name="variable">variable</a>**<br/>`boolean` `standard` | A variable.<br/>**Default**: true |

4
tests/results/test/00_6boolean_no_mandatory.html
View file

@ -1,9 +1,9 @@
<table>
<thead>
<tr><th>Variable </th><th>Description </th></tr>
<tr><th>Variable </th><th>Description </th></tr>
</thead>
<tbody>
<tr><td><b>variable</b><br/><mark><a href='https://rougail.readthedocs.io/en/latest/variable.html#variables-types'>boolean</a></mark> <mark>standard</mark></td><td>A variable.<br/><b>Default</b>: true</td></tr>
<tr><td><b>variable</b><br/><mark>boolean</mark> <mark>standard</mark></td><td>A variable.<br/><b>Default</b>: true</td></tr>
</tbody>
</table>

17
tests/results/test/00_6boolean_no_mandatory.json
View file

@ -5,21 +5,18 @@
"name": "Default",
"values": true
},
"properties": [
{
"type": "type",
"name": "boolean"
},
{
"type": "mode",
"name": "standard"
}
],
"variable_type": "boolean",
"path": "variable",
"names": [
"variable"
],
"description": "A variable.",
"properties": [
{
"type": "mode",
"name": "standard"
}
],
"gen_examples": [
true
],

6
tests/results/test/00_6boolean_no_mandatory.md
View file

@ -1,4 +1,4 @@
| Variable&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; | Description&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **<a id="variable" name="variable">variable</a>**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A variable.<br/>**Default**: true |
| Variable&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; | Description&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **<a id="variable" name="variable">variable</a>**<br/>`boolean` `standard` | A variable.<br/>**Default**: true |

12
tests/results/test/00_6choice.adoc
View file

@ -2,21 +2,21 @@
|====
| Variable | Description
| **var1** +
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `basic` `mandatory` | The first variable. +
`choice` `basic` `mandatory` | The first variable. +
**Choices**:
* a
* b
* c
| **var2** +
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `basic` `mandatory` | The second variable. +
`choice` `basic` `mandatory` | The second variable. +
**Choices**:
* a
* b
* c
| **var3** +
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` | The third variable. +
`choice` `standard` | The third variable. +
**Choices**:
* a
@ -24,21 +24,21 @@
* c
* null **← (default)**
| **var4** +
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` | The forth variable. +
`choice` `standard` | The forth variable. +
**Choices**:
* null **← (default)**
* b
* c
| **var5** +
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` `mandatory` | The fifth variable. +
`choice` `standard` `mandatory` | The fifth variable. +
**Choices**:
* a **← (default)**
* b
* c
| **var6** +
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` `mandatory` | The sixth variable. +
`choice` `standard` `mandatory` | The sixth variable. +
**Choices**:
* 1 **← (default)**

16
tests/results/test/00_6choice.gitlab.md
View file

@ -1,9 +1,9 @@
| Variable | Description |
|-----------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------|
| **<a id="var1" name="var1">var1</a>**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The first variable.<br/>**Choices**: <br/>• a<br/>• b<br/>• c |
| **<a id="var2" name="var2">var2</a>**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The second variable.<br/>**Choices**: <br/>• a<br/>• b<br/>• c |
| **<a id="var3" name="var3">var3</a>**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | The third variable.<br/>**Choices**: <br/>• a<br/>• b<br/>• c<br/>• null **← (default)** |
| **<a id="var4" name="var4">var4</a>**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | The forth variable.<br/>**Choices**: <br/>• null **← (default)**<br/>• b<br/>• c |
| **<a id="var5" name="var5">var5</a>**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The fifth variable.<br/>**Choices**: <br/>• a **← (default)**<br/>• b<br/>• c |
| **<a id="var6" name="var6">var6</a>**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The sixth variable.<br/>**Choices**: <br/>• 1 **← (default)**<br/>• 2<br/>• 3 |
| Variable | Description |
|---------------------------------------------------------------------------|------------------------------------------------------------------------------------------|
| **<a id="var1" name="var1">var1</a>**<br/>`choice` `basic` `mandatory` | The first variable.<br/>**Choices**: <br/>• a<br/>• b<br/>• c |
| **<a id="var2" name="var2">var2</a>**<br/>`choice` `basic` `mandatory` | The second variable.<br/>**Choices**: <br/>• a<br/>• b<br/>• c |
| **<a id="var3" name="var3">var3</a>**<br/>`choice` `standard` | The third variable.<br/>**Choices**: <br/>• a<br/>• b<br/>• c<br/>• null **← (default)** |
| **<a id="var4" name="var4">var4</a>**<br/>`choice` `standard` | The forth variable.<br/>**Choices**: <br/>• null **← (default)**<br/>• b<br/>• c |
| **<a id="var5" name="var5">var5</a>**<br/>`choice` `standard` `mandatory` | The fifth variable.<br/>**Choices**: <br/>• a **← (default)**<br/>• b<br/>• c |
| **<a id="var6" name="var6">var6</a>**<br/>`choice` `standard` `mandatory` | The sixth variable.<br/>**Choices**: <br/>• 1 **← (default)**<br/>• 2<br/>• 3 |

14
tests/results/test/00_6choice.html
View file

@ -1,25 +1,25 @@
<table>
<thead>
<tr><th>Variable </th><th>Description </th></tr>
<tr><th>Variable </th><th>Description </th></tr>
</thead>
<tbody>
<tr><td><b>var1</b><br/><mark><a href='https://rougail.readthedocs.io/en/latest/variable.html#variables-types'>choice</a></mark> <mark>basic</mark> <mark>mandatory</mark> </td><td>The first variable.<br/><b>Choices</b>: <ul><li>a</li>
<tr><td><b>var1</b><br/><mark>choice</mark> <mark>basic</mark> <mark>mandatory</mark> </td><td>The first variable.<br/><b>Choices</b>: <ul><li>a</li>
<li>b</li>
<li>c</li></ul> </td></tr>
<tr><td><b>var2</b><br/><mark><a href='https://rougail.readthedocs.io/en/latest/variable.html#variables-types'>choice</a></mark> <mark>basic</mark> <mark>mandatory</mark> </td><td>The second variable.<br/><b>Choices</b>: <ul><li>a</li>
<tr><td><b>var2</b><br/><mark>choice</mark> <mark>basic</mark> <mark>mandatory</mark> </td><td>The second variable.<br/><b>Choices</b>: <ul><li>a</li>
<li>b</li>
<li>c</li></ul> </td></tr>
<tr><td><b>var3</b><br/><mark><a href='https://rougail.readthedocs.io/en/latest/variable.html#variables-types'>choice</a></mark> <mark>standard</mark> </td><td>The third variable.<br/><b>Choices</b>: <ul><li>a</li>
<tr><td><b>var3</b><br/><mark>choice</mark> <mark>standard</mark> </td><td>The third variable.<br/><b>Choices</b>: <ul><li>a</li>
<li>b</li>
<li>c</li>
<li>null <b>← (default)</b></li></ul> </td></tr>
<tr><td><b>var4</b><br/><mark><a href='https://rougail.readthedocs.io/en/latest/variable.html#variables-types'>choice</a></mark> <mark>standard</mark> </td><td>The forth variable.<br/><b>Choices</b>: <ul><li>null <b>← (default)</b></li>
<tr><td><b>var4</b><br/><mark>choice</mark> <mark>standard</mark> </td><td>The forth variable.<br/><b>Choices</b>: <ul><li>null <b>← (default)</b></li>
<li>b</li>
<li>c</li></ul> </td></tr>
<tr><td><b>var5</b><br/><mark><a href='https://rougail.readthedocs.io/en/latest/variable.html#variables-types'>choice</a></mark> <mark>standard</mark> <mark>mandatory</mark></td><td>The fifth variable.<br/><b>Choices</b>: <ul><li>a <b>← (default)</b></li>
<tr><td><b>var5</b><br/><mark>choice</mark> <mark>standard</mark> <mark>mandatory</mark></td><td>The fifth variable.<br/><b>Choices</b>: <ul><li>a <b>← (default)</b></li>
<li>b</li>
<li>c</li></ul> </td></tr>
<tr><td><b>var6</b><br/><mark><a href='https://rougail.readthedocs.io/en/latest/variable.html#variables-types'>choice</a></mark> <mark>standard</mark> <mark>mandatory</mark></td><td>The sixth variable.<br/><b>Choices</b>: <ul><li>1 <b>← (default)</b></li>
<tr><td><b>var6</b><br/><mark>choice</mark> <mark>standard</mark> <mark>mandatory</mark></td><td>The sixth variable.<br/><b>Choices</b>: <ul><li>1 <b>← (default)</b></li>
<li>2</li>
<li>3</li></ul> </td></tr>
</tbody>

128
tests/results/test/00_6choice.json
View file

@ -1,20 +1,7 @@
{
"var1": {
"type": "variable",
"properties": [
{
"type": "type",
"name": "choice"
},
{
"type": "mode",
"name": "basic"
},
{
"type": "property",
"name": "mandatory"
}
],
"variable_type": "choice",
"choices": {
"name": "Choices",
"values": [
@ -28,18 +15,7 @@
"var1"
],
"description": "The first variable.",
"gen_examples": [
"a_choice"
],
"mandatory_without_value": true
},
"var2": {
"type": "variable",
"properties": [
{
"type": "type",
"name": "choice"
},
{
"type": "mode",
"name": "basic"
@ -49,6 +25,14 @@
"name": "mandatory"
}
],
"gen_examples": [
"a_choice"
],
"mandatory_without_value": true
},
"var2": {
"type": "variable",
"variable_type": "choice",
"choices": {
"name": "Choices",
"values": [
@ -62,6 +46,16 @@
"var2"
],
"description": "The second variable.",
"properties": [
{
"type": "mode",
"name": "basic"
},
{
"type": "property",
"name": "mandatory"
}
],
"gen_examples": [
"a_choice"
],
@ -69,16 +63,7 @@
},
"var3": {
"type": "variable",
"properties": [
{
"type": "type",
"name": "choice"
},
{
"type": "mode",
"name": "standard"
}
],
"variable_type": "choice",
"choices": {
"name": "Choices",
"values": [
@ -93,6 +78,12 @@
"var3"
],
"description": "The third variable.",
"properties": [
{
"type": "mode",
"name": "standard"
}
],
"gen_examples": [
"a_choice"
],
@ -100,16 +91,7 @@
},
"var4": {
"type": "variable",
"properties": [
{
"type": "type",
"name": "choice"
},
{
"type": "mode",
"name": "standard"
}
],
"variable_type": "choice",
"choices": {
"name": "Choices",
"values": [
@ -123,6 +105,12 @@
"var4"
],
"description": "The forth variable.",
"properties": [
{
"type": "mode",
"name": "standard"
}
],
"gen_examples": [
"a_choice"
],
@ -134,20 +122,7 @@
"name": "Default",
"values": "a"
},
"properties": [
{
"type": "type",
"name": "choice"
},
{
"type": "mode",
"name": "standard"
},
{
"type": "property",
"name": "mandatory"
}
],
"variable_type": "choice",
"choices": {
"name": "Choices",
"values": [
@ -161,6 +136,16 @@
"var5"
],
"description": "The fifth variable.",
"properties": [
{
"type": "mode",
"name": "standard"
},
{
"type": "property",
"name": "mandatory"
}
],
"gen_examples": [
"a"
],
@ -172,20 +157,7 @@
"name": "Default",
"values": 1
},
"properties": [
{
"type": "type",
"name": "choice"
},
{
"type": "mode",
"name": "standard"
},
{
"type": "property",
"name": "mandatory"
}
],
"variable_type": "choice",
"choices": {
"name": "Choices",
"values": [
@ -199,6 +171,16 @@
"var6"
],
"description": "The sixth variable.",
"properties": [
{
"type": "mode",
"name": "standard"
},
{
"type": "property",
"name": "mandatory"
}
],
"gen_examples": [
1
],

16
tests/results/test/00_6choice.md
View file

@ -1,9 +1,9 @@
| Variable&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; | Description&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **<a id="var1" name="var1">var1</a>**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The first variable.<br/>**Choices**: <br/>• a<br/>• b<br/>• c |
| **<a id="var2" name="var2">var2</a>**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The second variable.<br/>**Choices**: <br/>• a<br/>• b<br/>• c |
| **<a id="var3" name="var3">var3</a>**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | The third variable.<br/>**Choices**: <br/>• a<br/>• b<br/>• c<br/>• null **← (default)** |
| **<a id="var4" name="var4">var4</a>**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | The forth variable.<br/>**Choices**: <br/>• null **← (default)**<br/>• b<br/>• c |
| **<a id="var5" name="var5">var5</a>**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The fifth variable.<br/>**Choices**: <br/>• a **← (default)**<br/>• b<br/>• c |
| **<a id="var6" name="var6">var6</a>**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The sixth variable.<br/>**Choices**: <br/>• 1 **← (default)**<br/>• 2<br/>• 3 |
| Variable&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; | Description&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **<a id="var1" name="var1">var1</a>**<br/>`choice` `basic` `mandatory` | The first variable.<br/>**Choices**: <br/>• a<br/>• b<br/>• c |
| **<a id="var2" name="var2">var2</a>**<br/>`choice` `basic` `mandatory` | The second variable.<br/>**Choices**: <br/>• a<br/>• b<br/>• c |
| **<a id="var3" name="var3">var3</a>**<br/>`choice` `standard` | The third variable.<br/>**Choices**: <br/>• a<br/>• b<br/>• c<br/>• null **← (default)** |
| **<a id="var4" name="var4">var4</a>**<br/>`choice` `standard` | The forth variable.<br/>**Choices**: <br/>• null **← (default)**<br/>• b<br/>• c |
| **<a id="var5" name="var5">var5</a>**<br/>`choice` `standard` `mandatory` | The fifth variable.<br/>**Choices**: <br/>• a **← (default)**<br/>• b<br/>• c |
| **<a id="var6" name="var6">var6</a>**<br/>`choice` `standard` `mandatory` | The sixth variable.<br/>**Choices**: <br/>• 1 **← (default)**<br/>• 2<br/>• 3 |

2
tests/results/test/00_6choice_calculation.adoc
View file

@ -2,7 +2,7 @@
|====
| Variable | Description
| **var** +
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` `mandatory` | A variable. +
`choice` `standard` `mandatory` | A variable. +
**Choices**: choices is 0 to 9 +
**Default**: 9
|====

6
tests/results/test/00_6choice_calculation.gitlab.md
View file

@ -1,4 +1,4 @@
| Variable | Description |
|--------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------|
| **<a id="var" name="var">var</a>**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.<br/>**Choices**: choices is 0 to 9<br/>**Default**: 9 |
| Variable | Description |
|------------------------------------------------------------------------|-------------------------------------------------------------------|
| **<a id="var" name="var">var</a>**<br/>`choice` `standard` `mandatory` | A variable.<br/>**Choices**: choices is 0 to 9<br/>**Default**: 9 |

4
tests/results/test/00_6choice_calculation.html
View file

@ -1,9 +1,9 @@
<table>
<thead>
<tr><th>Variable </th><th>Description </th></tr>
<tr><th>Variable </th><th>Description </th></tr>
</thead>
<tbody>
<tr><td><b>var</b><br/><mark><a href='https://rougail.readthedocs.io/en/latest/variable.html#variables-types'>choice</a></mark> <mark>standard</mark> <mark>mandatory</mark></td><td>A variable.<br/><b>Choices</b>: choices is 0 to 9<br/><b>Default</b>: 9</td></tr>
<tr><td><b>var</b><br/><mark>choice</mark> <mark>standard</mark> <mark>mandatory</mark></td><td>A variable.<br/><b>Choices</b>: choices is 0 to 9<br/><b>Default</b>: 9</td></tr>
</tbody>
</table>

25
tests/results/test/00_6choice_calculation.json
View file

@ -5,20 +5,7 @@
"name": "Default",
"values": 9
},
"properties": [
{
"type": "type",
"name": "choice"
},
{
"type": "mode",
"name": "standard"
},
{
"type": "property",
"name": "mandatory"
}
],
"variable_type": "choice",
"choices": {
"name": "Choices",
"values": {
@ -30,6 +17,16 @@
"var"
],
"description": "A variable.",
"properties": [
{
"type": "mode",
"name": "standard"
},
{
"type": "property",
"name": "mandatory"
}
],
"gen_examples": [
9
],

6
tests/results/test/00_6choice_calculation.md
View file

@ -1,4 +1,4 @@
| Variable&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; | Description&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **<a id="var" name="var">var</a>**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.<br/>**Choices**: choices is 0 to 9<br/>**Default**: 9 |
| Variable&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; | Description&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **<a id="var" name="var">var</a>**<br/>`choice` `standard` `mandatory` | A variable.<br/>**Choices**: choices is 0 to 9<br/>**Default**: 9 |

4
tests/results/test/00_6choice_link.adoc
View file

@ -2,14 +2,14 @@
|====
| Variable | Description
| **var1** +
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `basic` `mandatory` | The first variable. +
`choice` `basic` `mandatory` | The first variable. +
**Choices**:
* a
* b
* c
| **var2** +
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` `mandatory` | The second variable. +
`choice` `standard` `mandatory` | The second variable. +
**Choices**:
* a

8
tests/results/test/00_6choice_link.gitlab.md
View file

@ -1,5 +1,5 @@
| Variable | Description |
|-----------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------|
| **<a id="var1" name="var1">var1</a>**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The first variable.<br/>**Choices**: <br/>• a<br/>• b<br/>• c |
| **<a id="var2" name="var2">var2</a>**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The second variable.<br/>**Choices**: <br/>• a<br/>• b<br/>• c<br/>**Default**: the value of the variable "[The first variable](#var1)" |
| Variable | Description |
|---------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------|
| **<a id="var1" name="var1">var1</a>**<br/>`choice` `basic` `mandatory` | The first variable.<br/>**Choices**: <br/>• a<br/>• b<br/>• c |
| **<a id="var2" name="var2">var2</a>**<br/>`choice` `standard` `mandatory` | The second variable.<br/>**Choices**: <br/>• a<br/>• b<br/>• c<br/>**Default**: the value of the variable "[The first variable](#var1)" |

6
tests/results/test/00_6choice_link.html
View file

@ -1,12 +1,12 @@
<table>
<thead>
<tr><th>Variable </th><th>Description </th></tr>
<tr><th>Variable </th><th>Description </th></tr>
</thead>
<tbody>
<tr><td><b>var1</b><br/><mark><a href='https://rougail.readthedocs.io/en/latest/variable.html#variables-types'>choice</a></mark> <mark>basic</mark> <mark>mandatory</mark> </td><td>The first variable.<br/><b>Choices</b>: <ul><li>a</li>
<tr><td><b>var1</b><br/><mark>choice</mark> <mark>basic</mark> <mark>mandatory</mark> </td><td>The first variable.<br/><b>Choices</b>: <ul><li>a</li>
<li>b</li>
<li>c</li></ul> </td></tr>
<tr><td><b>var2</b><br/><mark><a href='https://rougail.readthedocs.io/en/latest/variable.html#variables-types'>choice</a></mark> <mark>standard</mark> <mark>mandatory</mark></td><td>The second variable.<br/><b>Choices</b>: <ul><li>a</li>
<tr><td><b>var2</b><br/><mark>choice</mark> <mark>standard</mark> <mark>mandatory</mark></td><td>The second variable.<br/><b>Choices</b>: <ul><li>a</li>
<li>b</li>
<li>c</li></ul><br/><b>Default</b>: the value of the variable "var1" </td></tr>
</tbody>

50
tests/results/test/00_6choice_link.json
View file

@ -1,20 +1,7 @@
{
"var1": {
"type": "variable",
"properties": [
{
"type": "type",
"name": "choice"
},
{
"type": "mode",
"name": "basic"
},
{
"type": "property",
"name": "mandatory"
}
],
"variable_type": "choice",
"choices": {
"name": "Choices",
"values": [
@ -28,6 +15,16 @@
"var1"
],
"description": "The first variable.",
"properties": [
{
"type": "mode",
"name": "basic"
},
{
"type": "property",
"name": "mandatory"
}
],
"gen_examples": [
"a_choice"
],
@ -45,20 +42,7 @@
"description": "The first variable"
}
},
"properties": [
{
"type": "type",
"name": "choice"
},
{
"type": "mode",
"name": "standard"
},
{
"type": "property",
"name": "mandatory"
}
],
"variable_type": "choice",
"choices": {
"name": "Choices",
"values": [
@ -72,6 +56,16 @@
"var2"
],
"description": "The second variable.",
"properties": [
{
"type": "mode",
"name": "standard"
},
{
"type": "property",
"name": "mandatory"
}
],
"gen_examples": [
"a_choice"
],

8
tests/results/test/00_6choice_link.md
View file

@ -1,5 +1,5 @@
| Variable&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; | Description&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **<a id="var1" name="var1">var1</a>**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The first variable.<br/>**Choices**: <br/>• a<br/>• b<br/>• c |
| **<a id="var2" name="var2">var2</a>**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The second variable.<br/>**Choices**: <br/>• a<br/>• b<br/>• c<br/>**Default**: the value of the variable "[The first variable](#var1)" |
| Variable&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; | Description&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **<a id="var1" name="var1">var1</a>**<br/>`choice` `basic` `mandatory` | The first variable.<br/>**Choices**: <br/>• a<br/>• b<br/>• c |
| **<a id="var2" name="var2">var2</a>**<br/>`choice` `standard` `mandatory` | The second variable.<br/>**Choices**: <br/>• a<br/>• b<br/>• c<br/>**Default**: the value of the variable "[The first variable](#var1)" |

4
tests/results/test/00_6choice_variable.adoc
View file

@ -2,14 +2,14 @@
|====
| Variable | Description
| **var1** +
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | A second variable. +
`string` `multiple` `standard` `mandatory` `unique` | A second variable. +
**Default**:
* a
* b
* c
| **var2** +
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` `mandatory` | A first variable. +
`choice` `standard` `mandatory` | A first variable. +
**Choices**: the value of the variable "var1" +
**Default**: a
|====

8
tests/results/test/00_6choice_variable.gitlab.md
View file

@ -1,5 +1,5 @@
| Variable | Description |
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------|
| **<a id="var1" name="var1">var1</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A second variable.<br/>**Default**: <br/>• a<br/>• b<br/>• c |
| **<a id="var2" name="var2">var2</a>**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A first variable.<br/>**Choices**: the value of the variable "[A second variable](#var1)"<br/>**Default**: a |
| Variable | Description |
|-----------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------|
| **<a id="var1" name="var1">var1</a>**<br/>`string` `multiple` `standard` `mandatory` `unique` | A second variable.<br/>**Default**: <br/>• a<br/>• b<br/>• c |
| **<a id="var2" name="var2">var2</a>**<br/>`choice` `standard` `mandatory` | A first variable.<br/>**Choices**: the value of the variable "[A second variable](#var1)"<br/>**Default**: a |

6
tests/results/test/00_6choice_variable.html
View file

@ -1,12 +1,12 @@
<table>
<thead>
<tr><th>Variable </th><th>Description </th></tr>
<tr><th>Variable </th><th>Description </th></tr>
</thead>
<tbody>
<tr><td><b>var1</b><br/><mark><a href='https://rougail.readthedocs.io/en/latest/variable.html#variables-types'>string</a></mark> <mark>standard</mark> <mark>mandatory</mark> <mark>unique</mark> <mark>multiple</mark></td><td>A second variable.<br/><b>Default</b>: <ul><li>a</li>
<tr><td><b>var1</b><br/><mark>string</mark> <mark>multiple</mark> <mark>standard</mark> <mark>mandatory</mark> <mark>unique</mark></td><td>A second variable.<br/><b>Default</b>: <ul><li>a</li>
<li>b</li>
<li>c</li></ul> </td></tr>
<tr><td><b>var2</b><br/><mark><a href='https://rougail.readthedocs.io/en/latest/variable.html#variables-types'>choice</a></mark> <mark>standard</mark> <mark>mandatory</mark> </td><td>A first variable.<br/><b>Choices</b>: the value of the variable "var1"<br/><b>Default</b>: a</td></tr>
<tr><td><b>var2</b><br/><mark>choice</mark> <mark>standard</mark> <mark>mandatory</mark> </td><td>A first variable.<br/><b>Choices</b>: the value of the variable "var1"<br/><b>Default</b>: a</td></tr>
</tbody>
</table>

Some files were not shown because too many files have changed in this diff Show more