feat: personalise column number
This commit is contained in:
parent
3cde479202
commit
948e0b49ed
6289 changed files with 49531 additions and 62664 deletions
81
README.fr.md
Normal file
81
README.fr.md
Normal file
|
|
@ -0,0 +1,81 @@
|
||||||
|
---
|
||||||
|
gitea: none
|
||||||
|
include_toc: true
|
||||||
|
---
|
||||||
|
[🇬🇧 (EN)](README.md) - [🇫🇷 (FR)](README.fr.md)
|
||||||
|
|
||||||
|
## Générer la documentation depuis les fichiers de structure
|
||||||
|
|
||||||
|
> **🛈 Informations**
|
||||||
|
>
|
||||||
|
> Les fichiers de structure contiennent toutes les informations relatif aux variables. Cette sortie génère la documentation pour tout ou partie de ces variables.\
|
||||||
|
> **Chemin** : doc\
|
||||||
|
> *`désactivé`*\
|
||||||
|
> **Désactivé** : si doc n'est pas spécifié dans "[Sélection pour sortie](#step.output)"
|
||||||
|
|
||||||
|
| Variable | Description | Valeur par défaut | Type | Contrôle des accès | Validateur |
|
||||||
|
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------|-------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
|
| **<a id="doc.output_format" name="doc.output_format">doc.output_format</a>**<br/>**Ligne de commande** : -do, --doc.output_format<br/>**Variable d'environnement** : ROUGAILCLI_DOC.OUTPUT_FORMAT | Le format de sortie de la documentation générée. | console | [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | | **Choix** : <br/>• console<br/>• asciidoc<br/>• html<br/>• github<br/>• gitlab<br/>• json |
|
||||||
|
| **<a id="doc.tabular_template" name="doc.tabular_template">doc.tabular_template</a>**<br/>**Ligne de commande** : -dm, --doc.tabular_template<br/>**Variable d'environnement** : ROUGAILCLI_DOC.TABULAR_TEMPLATE | Génère la documentation avec ce modèle de tableau.<br/>Les variables sont documentées avec une vue tableau. Une sélection de modèle vous permet de choisir le contenu de chaque colonne. | two_columns | [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | *`désactivé`*<br/>**Désactivé** : "[Le format de sortie de la documentation générée](#doc.output_format)" en json n\'est pas compatible avec cette variable<br/> | **Choix** : <br/>• two_columns<br/>• three_columns<br/>• four_columns<br/>• five_columns<br/>• six_columns |
|
||||||
|
| **<a id="doc.contents" name="doc.contents">doc.contents</a>**<br/>**Ligne de commande** : -dc, --doc.contents<br/>**Variable d'environnement** : ROUGAILCLI_DOC.CONTENTS | Contenu généré.<br/>Vous pouvez générer trois type de documentation. Toutes les variables ("variables"), un exemple de fichier au format YAML ("example") ou le journal des changements ("changelog"). | • variables | [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` `obligatoire` | *`cachée`*<br/>**Cachée** : "[Le format de sortie de la documentation générée](#doc.output_format)" en json n'est pas compatible avec "[Contenu généré](#doc.contents)" changelog or example<br/> | `unique`<br/>**Choix** : <br/>• variables<br/>• example<br/>• changelog |
|
||||||
|
| **<a id="doc.title_level" name="doc.title_level">doc.title_level</a>**<br/>**Ligne de commande** : -dt, --doc.title_level<br/>**Variable d'environnement** : ROUGAILCLI_DOC.TITLE_LEVEL | Niveau de titre de départ. | 1 | [`integer`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | | |
|
||||||
|
| **<a id="doc.default_values" name="doc.default_values">doc.default_values</a>**<br/>**Ligne de commande** : <br/>• --doc.default_values<br/>• --doc.no-default_values<br/>**Variable d'environnement** : ROUGAILCLI_DOC.DEFAULT_VALUES | Modifier les valeurs pour documenter toutes les variables.<br/>Pour documenter les variables des leadership ou des familles dynamiques, il est parfois nécessaire de générer des valeurs, qui peuvent modifier les valeurs de la configuration. Soyez vigilent si vous réutilisez cette configuration. | true | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | | |
|
||||||
|
| **<a id="doc.true_color" name="doc.true_color">doc.true_color</a>**<br/>**Ligne de commande** : <br/>• --doc.true_color<br/>• --doc.no-true_color<br/>**Variable d'environnement** : ROUGAILCLI_DOC.TRUE_COLOR | Afficher la documentation dans la console en permanence avec un terminal en couleurs réelles. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | *`désactivé`*<br/>**Désactivé** : lorsque la variable "[Le format de sortie de la documentation générée](#doc.output_format)" n'a pas la valeur "console" | |
|
||||||
|
| **<a id="doc.root" name="doc.root">doc.root</a>**<br/>**Ligne de commande** : -dr, --doc.root<br/>**Variable d'environnement** : ROUGAILCLI_DOC.ROOT | Documenter les variables enfants de cette famille.<br/>Par défaut, toute les variables accessibles sont incluent dans la documentation. Il est possible de définir une famille a partir de laquelle la documentation doit être générée. | | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) | | |
|
||||||
|
|
||||||
|
### Les variables pour cette famille sont documentés dans un autre fichier
|
||||||
|
|
||||||
|
> **🛈 Informations**
|
||||||
|
>
|
||||||
|
> Si vous séparez les variables dans différents fichiers, le lien entre les variables va être cassé. Dans ce cas, vous devez définit différents nom de fichiers pour les fichiers contenant ces variables.\
|
||||||
|
> Cette famille contient des listes de bloc de variable.\
|
||||||
|
> **Chemin** : doc.other_root_filenames\
|
||||||
|
> *`désactivé`*\
|
||||||
|
> **Désactivé** : lorsque la variable "[Documenter les variables enfants de cette famille](#doc.root)" a la valeur "null"
|
||||||
|
|
||||||
|
| Variable | Description | Type | Validateur |
|
||||||
|
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------|---------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------|
|
||||||
|
| **<a id="doc.other_root_filenames.root_path" name="doc.other_root_filenames.root_path">doc.other_root_filenames.root_path</a>**<br/>**Ligne de commande** : --doc.other_root_filenames.root_path<br/>**Variable d'environnement** : ROUGAILCLI_DOC.OTHER_ROOT_FILENAMES.ROOT_PATH | Ce fichier contient les variables enfants de la famille. | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` | `unique` |
|
||||||
|
| **<a id="doc.other_root_filenames.filename" name="doc.other_root_filenames.filename">doc.other_root_filenames.filename</a>**<br/>**Ligne de commande** : --doc.other_root_filenames.filename<br/>**Variable d'environnement** : ROUGAILCLI_DOC.OTHER_ROOT_FILENAMES.FILENAME | Nom du fichier. | [`UNIX filename`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | • this filename could be a relative path<br/>• file type allowed: "file". |
|
||||||
|
|
||||||
|
### Documentation des variables et journal de changements
|
||||||
|
|
||||||
|
> **🛈 Informations**
|
||||||
|
>
|
||||||
|
> **Chemin** : doc.tabulars\
|
||||||
|
> *`désactivé`*\
|
||||||
|
> **Désactivé** : si "[Le format de sortie de la documentation générée](#doc.output_format)" en json ou si "[Contenu généré](#doc.contents)" n'est pas variables ou changelog
|
||||||
|
|
||||||
|
| Variable | Description | Valeur par défaut | Type | Contrôle des accès | Validateur |
|
||||||
|
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------|---------------------|---------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------|
|
||||||
|
| **<a id="doc.tabulars.without_family" name="doc.tabulars.without_family">doc.tabulars.without_family</a>**<br/>**Ligne de commande** : <br/>• -df, --doc.tabulars.without_family<br/>• -ndf, --doc.tabulars.no-without_family<br/>**Variable d'environnement** : ROUGAILCLI_DOC.TABULARS.WITHOUT_FAMILY | Ne pas ajouter les familles dans la documentation. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | | |
|
||||||
|
| **<a id="doc.tabulars.with_commandline" name="doc.tabulars.with_commandline">doc.tabulars.with_commandline</a>**<br/>**Ligne de commande** : <br/>• -dw, --doc.tabulars.with_commandline<br/>• -ndw, --doc.tabulars.no-with_commandline<br/>**Variable d'environnement** : ROUGAILCLI_DOC.TABULARS.WITH_COMMANDLINE | Ajoute les informations de la ligne de commande dans la documentation. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | | |
|
||||||
|
| **<a id="doc.tabulars.with_environment" name="doc.tabulars.with_environment">doc.tabulars.with_environment</a>**<br/>**Ligne de commande** : <br/>• -de, --doc.tabulars.with_environment<br/>• -nde, --doc.tabulars.no-with_environment<br/>**Variable d'environnement** : ROUGAILCLI_DOC.TABULARS.WITH_ENVIRONMENT | Ajoute les informations de variable d'environnement dans la documentation. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | | |
|
||||||
|
| **<a id="doc.tabulars.environment_prefix" name="doc.tabulars.environment_prefix">doc.tabulars.environment_prefix</a>**<br/>**Ligne de commande** : -dv, --doc.tabulars.environment_prefix<br/>**Variable d'environnement** : ROUGAILCLI_DOC.TABULARS.ENVIRONMENT_PREFIX | Préfixe du nom des variables d'environnement. | ROUGAIL | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | *`désactivé`*<br/>**Désactivé** : si "main_namespace" n'est pas défini ou "[Ajoute les informations de variable d'environnement dans la documentation](#doc.tabulars.with_environment)" est false | Doit seulement utilise des caractères en majuscule. |
|
||||||
|
|
||||||
|
### Documentation du journal des changements
|
||||||
|
|
||||||
|
> **🛈 Informations**
|
||||||
|
>
|
||||||
|
> **Chemin** : doc.changelog\
|
||||||
|
> *`désactivé`*\
|
||||||
|
> **Désactivé** : changelog n'est pas défini dans "[Contenu généré](#doc.contents)"
|
||||||
|
|
||||||
|
| Variable | Description | Type |
|
||||||
|
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------|
|
||||||
|
| **<a id="doc.changelog.previous_json_file" name="doc.changelog.previous_json_file">doc.changelog.previous_json_file</a>**<br/>**Ligne de commande** : -dp, --doc.changelog.previous_json_file<br/>**Variable d'environnement** : ROUGAILCLI_DOC.CHANGELOG.PREVIOUS_JSON_FILE | Précédent fichier de description au format JSON.<br/>Pour générer le journal des changements, vous devez comparer l'ancienne liste des variables (au format json) avec les variables courantes. | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` |
|
||||||
|
|
||||||
|
### Configuration des exemples
|
||||||
|
|
||||||
|
> **🛈 Informations**
|
||||||
|
>
|
||||||
|
> **Chemin** : doc.examples\
|
||||||
|
> *`désactivé`*\
|
||||||
|
> **Désactivé** : si example n'est pas défini dans "[Contenu généré](#doc.contents)"
|
||||||
|
|
||||||
|
| Variable | Description | Valeur par défaut | Type | Contrôle des accès |
|
||||||
|
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------|---------------------|---------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
|
| **<a id="doc.examples.comment" name="doc.examples.comment">doc.examples.comment</a>**<br/>**Ligne de commande** : <br/>• -dx, --doc.examples.comment<br/>• -ndx, --doc.examples.no-comment<br/>**Variable d'environnement** : ROUGAILCLI_DOC.EXAMPLES.COMMENT | Ajouter la description des variables et des familles lorsqu'on génère des exemples. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | |
|
||||||
|
| **<a id="doc.examples.comment_column" name="doc.examples.comment_column">doc.examples.comment_column</a>**<br/>**Ligne de commande** : --doc.examples.comment_column<br/>**Variable d'environnement** : ROUGAILCLI_DOC.EXAMPLES.COMMENT_COLUMN | Commentaire dans les exemples commence à la colonne. | 30 | [`integer`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | *`désactivé`*<br/>**Désactivé** : lorsque la variable "[Ajouter la description des variables et des familles lorsqu'on génère des exemples](#doc.examples.comment)" a la valeur "false" |
|
||||||
|
|
||||||
|
|
||||||
98
README.md
98
README.md
|
|
@ -1,43 +1,81 @@
|
||||||
# Generate documentation
|
---
|
||||||
|
gitea: none
|
||||||
|
include_toc: true
|
||||||
|
---
|
||||||
|
[🇬🇧 (EN)](README.md) - [🇫🇷 (FR)](README.fr.md)
|
||||||
|
|
||||||
|
## Generate documentation from structural files
|
||||||
|
|
||||||
> **🛈 Informations**
|
> **🛈 Informations**
|
||||||
>
|
>
|
||||||
> **<a id="doc" name="doc">doc</a>**\
|
> The structural files contain all the information related to the variables. This output generates the documentation for all or some of these variables.\
|
||||||
> `basic` *`disabled`*\
|
> **Path**: doc\
|
||||||
> **Disabled**: when "[Generate documentation](#doc)" is not set in "[Select for output](#step.output)"
|
> *`disabled`*\
|
||||||
|
> **Disabled**: if doc is not set in "[Select for output](#step.output)"
|
||||||
|
|
||||||
| Variable | Description |
|
| Variable | Description | Default value | Type | Access control | Validator |
|
||||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------|-----------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
| **<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.output_format" name="doc.output_format">doc.output_format</a>**<br/>**Command line**: -do, --doc.output_format<br/>**Environment variable**: ROUGAILCLI_DOC.OUTPUT_FORMAT | The output format of the generated documentation. | console | [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | | **Choices**: <br/>• console<br/>• asciidoc<br/>• html<br/>• github<br/>• gitlab<br/>• json |
|
||||||
| **<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.tabular_template" name="doc.tabular_template">doc.tabular_template</a>**<br/>**Command line**: -dm, --doc.tabular_template<br/>**Environment variable**: ROUGAILCLI_DOC.TABULAR_TEMPLATE | Generate document with this tabular model.<br/>The variables are documented with a tabular view. A template selection allows you to choose the content of each column. | two_columns | [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | *`disabled`*<br/>**Disabled**: "[The output format of the generated documentation](#doc.output_format)" in json is not compatible with this variable<br/> | **Choices**: <br/>• two_columns<br/>• three_columns<br/>• four_columns<br/>• five_columns<br/>• six_columns |
|
||||||
| **<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.contents" name="doc.contents">doc.contents</a>**<br/>**Command line**: -dc, --doc.contents<br/>**Environment variable**: ROUGAILCLI_DOC.CONTENTS | Generated content.<br/>You can generate three type of document. All variables ("variables"), an example file in YAML format ("example") or change log ("changelog"). | • variables | [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` `mandatory` | *`hidden`*<br/>**Hidden**: "[The output format of the generated documentation](#doc.output_format)" in json is not compatible with changelog or example "[Generated content](#doc.contents)"<br/> | `unique`<br/>**Choices**: <br/>• variables<br/>• example<br/>• changelog |
|
||||||
| **<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.title_level" name="doc.title_level">doc.title_level</a>**<br/>**Command line**: -dt, --doc.title_level<br/>**Environment variable**: ROUGAILCLI_DOC.TITLE_LEVEL | Starting title level. | 1 | [`integer`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | | |
|
||||||
| **<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.default_values" name="doc.default_values">doc.default_values</a>**<br/>**Command line**: <br/>• --doc.default_values<br/>• --doc.no-default_values<br/>**Environment variable**: ROUGAILCLI_DOC.DEFAULT_VALUES | Modify values to document all variables.<br/>To document leadership or dynamic family variables, it is sometimes necessary to generate values, which can change the values in the configuration. Be careful if you reuse this configuration. | true | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | | |
|
||||||
| **<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.true_color" name="doc.true_color">doc.true_color</a>**<br/>**Command line**: <br/>• --doc.true_color<br/>• --doc.no-true_color<br/>**Environment variable**: ROUGAILCLI_DOC.TRUE_COLOR | Display documentation in console always with true color terminal. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | *`disabled`*<br/>**Disabled**: when the variable "[The output format of the generated documentation](#doc.output_format)" hasn't the value "console" | |
|
||||||
| **<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.root" name="doc.root">doc.root</a>**<br/>**Command line**: -dr, --doc.root<br/>**Environment variable**: ROUGAILCLI_DOC.ROOT | Document the child variables of the family.<br/>By default, all accessible variables are included in the documentation. It is possible to define the family from which the documentation should be generated. | | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) | | |
|
||||||
| **<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 |
|
|
||||||
|
|
||||||
# Families or variables for this family are in an other file name
|
### The variables in this family are documented in another file
|
||||||
|
|
||||||
> **🛈 Informations**
|
> **🛈 Informations**
|
||||||
>
|
>
|
||||||
> **<a id="doc.other_root_filenames" name="doc.other_root_filenames">doc.other_root_filenames</a>**\
|
> If you separate the variables into different files, the links between the variables will break. Therefore, you must define different filenames for the files containing these variables.\
|
||||||
> This family contains lists of variable blocks.\
|
> This family contains lists of variable blocks.\
|
||||||
> `basic` *`disabled`*\
|
> **Path**: doc.other_root_filenames\
|
||||||
> **Disabled**: documentation must be splitted
|
> *`disabled`*\
|
||||||
|
> **Disabled**: when the variable "[Document the child variables of the family](#doc.root)" has the value "null"
|
||||||
|
|
||||||
| Variable | Description |
|
| Variable | Description | Type | Validator |
|
||||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------|-------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------|
|
||||||
| **<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.root_path" name="doc.other_root_filenames.root_path">doc.other_root_filenames.root_path</a>**<br/>**Command line**: --doc.other_root_filenames.root_path<br/>**Environment variable**: ROUGAILCLI_DOC.OTHER_ROOT_FILENAMES.ROOT_PATH | This file contains child variables of the family. | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` | `unique` |
|
||||||
| **<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" |
|
| **<a id="doc.other_root_filenames.filename" name="doc.other_root_filenames.filename">doc.other_root_filenames.filename</a>**<br/>**Command line**: --doc.other_root_filenames.filename<br/>**Environment variable**: ROUGAILCLI_DOC.OTHER_ROOT_FILENAMES.FILENAME | Name of the file. | [`UNIX filename`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | • this filename could be a relative path<br/>• file type allowed: "file". |
|
||||||
|
|
||||||
| Variable | Description |
|
### Variables and changelog documentation
|
||||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
||||||
| **<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 |
|
> **🛈 Informations**
|
||||||
| **<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 |
|
> **Path**: doc.tabulars\
|
||||||
| **<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" |
|
> *`disabled`*\
|
||||||
| **<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 |
|
> **Disabled**: if "[The output format of the generated documentation](#doc.output_format)" is json or "[Generated content](#doc.contents)" hasn't variables or changelog
|
||||||
| **<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 | Description | Default value | Type | Access control | Validator |
|
||||||
|
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------|-----------------|-------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------|
|
||||||
|
| **<a id="doc.tabulars.without_family" name="doc.tabulars.without_family">doc.tabulars.without_family</a>**<br/>**Command line**: <br/>• -df, --doc.tabulars.without_family<br/>• -ndf, --doc.tabulars.no-without_family<br/>**Environment variable**: ROUGAILCLI_DOC.TABULARS.WITHOUT_FAMILY | Do not add families in documentation. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | | |
|
||||||
|
| **<a id="doc.tabulars.with_commandline" name="doc.tabulars.with_commandline">doc.tabulars.with_commandline</a>**<br/>**Command line**: <br/>• -dw, --doc.tabulars.with_commandline<br/>• -ndw, --doc.tabulars.no-with_commandline<br/>**Environment variable**: ROUGAILCLI_DOC.TABULARS.WITH_COMMANDLINE | Add command line informations in documentation. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | | |
|
||||||
|
| **<a id="doc.tabulars.with_environment" name="doc.tabulars.with_environment">doc.tabulars.with_environment</a>**<br/>**Command line**: <br/>• -de, --doc.tabulars.with_environment<br/>• -nde, --doc.tabulars.no-with_environment<br/>**Environment variable**: ROUGAILCLI_DOC.TABULARS.WITH_ENVIRONMENT | Add environment variable informations in documentation. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | | |
|
||||||
|
| **<a id="doc.tabulars.environment_prefix" name="doc.tabulars.environment_prefix">doc.tabulars.environment_prefix</a>**<br/>**Command line**: -dv, --doc.tabulars.environment_prefix<br/>**Environment variable**: ROUGAILCLI_DOC.TABULARS.ENVIRONMENT_PREFIX | Environment variables prefix name. | ROUGAIL | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | *`disabled`*<br/>**Disabled**: if "main_namespace" is not set or "[Add environment variable informations in documentation](#doc.tabulars.with_environment)" is false | Should only use uppercase characters. |
|
||||||
|
|
||||||
|
### Changelog documentation
|
||||||
|
|
||||||
|
> **🛈 Informations**
|
||||||
|
>
|
||||||
|
> **Path**: doc.changelog\
|
||||||
|
> *`disabled`*\
|
||||||
|
> **Disabled**: if changelog in not in "[Generated content](#doc.contents)"
|
||||||
|
|
||||||
|
| Variable | Description | Type |
|
||||||
|
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------|
|
||||||
|
| **<a id="doc.changelog.previous_json_file" name="doc.changelog.previous_json_file">doc.changelog.previous_json_file</a>**<br/>**Command line**: -dp, --doc.changelog.previous_json_file<br/>**Environment variable**: ROUGAILCLI_DOC.CHANGELOG.PREVIOUS_JSON_FILE | Previous description file in JSON format.<br/>To generate the changelog, you need to compare the old list of variables (in json format) with the current variables. | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` |
|
||||||
|
|
||||||
|
### Examples configuration
|
||||||
|
|
||||||
|
> **🛈 Informations**
|
||||||
|
>
|
||||||
|
> **Path**: doc.examples\
|
||||||
|
> *`disabled`*\
|
||||||
|
> **Disabled**: if example is not in "[Generated content](#doc.contents)"
|
||||||
|
|
||||||
|
| Variable | Description | Default value | Type | Access control |
|
||||||
|
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------|-----------------|-------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
|
| **<a id="doc.examples.comment" name="doc.examples.comment">doc.examples.comment</a>**<br/>**Command line**: <br/>• -dx, --doc.examples.comment<br/>• -ndx, --doc.examples.no-comment<br/>**Environment variable**: ROUGAILCLI_DOC.EXAMPLES.COMMENT | Add description of variables and families when generate examples. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | |
|
||||||
|
| **<a id="doc.examples.comment_column" name="doc.examples.comment_column">doc.examples.comment_column</a>**<br/>**Command line**: --doc.examples.comment_column<br/>**Environment variable**: ROUGAILCLI_DOC.EXAMPLES.COMMENT_COLUMN | Comment in examples starts at column. | 30 | [`integer`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | *`disabled`*<br/>**Disabled**: when the variable "[Add description of variables and families when generate examples](#doc.examples.comment)" has the value "false" |
|
||||||
|
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -5,8 +5,8 @@
|
||||||
msgid ""
|
msgid ""
|
||||||
msgstr ""
|
msgstr ""
|
||||||
"Project-Id-Version: \n"
|
"Project-Id-Version: \n"
|
||||||
"POT-Creation-Date: 2025-11-27 22:14+0100\n"
|
"POT-Creation-Date: 2025-12-02 12:49+0100\n"
|
||||||
"PO-Revision-Date: 2025-11-27 22:14+0100\n"
|
"PO-Revision-Date: 2025-12-02 12:53+0100\n"
|
||||||
"Last-Translator: \n"
|
"Last-Translator: \n"
|
||||||
"Language-Team: \n"
|
"Language-Team: \n"
|
||||||
"Language: fr\n"
|
"Language: fr\n"
|
||||||
|
|
@ -32,260 +32,327 @@ msgstr "lorsque l'identifiant est \"{0}\""
|
||||||
msgid "when the identifier is not \"{0}\""
|
msgid "when the identifier is not \"{0}\""
|
||||||
msgstr "lorsque l'identifiant n'est pas \"{0}\""
|
msgstr "lorsque l'identifiant n'est pas \"{0}\""
|
||||||
|
|
||||||
#: src/rougail/output_doc/changelog.py:155
|
#: src/rougail/output_doc/changelog.py:147
|
||||||
msgid "New variable"
|
msgid "New variable"
|
||||||
msgstr "Nouvelle variable"
|
msgstr "Nouvelle variable"
|
||||||
|
|
||||||
#: src/rougail/output_doc/changelog.py:157
|
#: src/rougail/output_doc/changelog.py:149
|
||||||
msgid "New variables"
|
msgid "New variables"
|
||||||
msgstr "Nouvelles variables"
|
msgstr "Nouvelles variables"
|
||||||
|
|
||||||
#: src/rougail/output_doc/changelog.py:169
|
#: src/rougail/output_doc/changelog.py:163
|
||||||
msgid "Modified variable"
|
msgid "Modified variable"
|
||||||
msgstr "Variable modifiée"
|
msgstr "Variable modifiée"
|
||||||
|
|
||||||
#: src/rougail/output_doc/changelog.py:171
|
#: src/rougail/output_doc/changelog.py:165
|
||||||
msgid "Modified variables"
|
msgid "Modified variables"
|
||||||
msgstr "Variables modifiées"
|
msgstr "Variables modifiées"
|
||||||
|
|
||||||
#: src/rougail/output_doc/changelog.py:183
|
#: src/rougail/output_doc/changelog.py:179
|
||||||
msgid "Deleted variable"
|
msgid "Deleted variable"
|
||||||
msgstr "Variable supprimée"
|
msgstr "Variable supprimée"
|
||||||
|
|
||||||
#: src/rougail/output_doc/changelog.py:185
|
#: src/rougail/output_doc/changelog.py:181
|
||||||
msgid "Deleted variables"
|
msgid "Deleted variables"
|
||||||
msgstr "Variables supprimées"
|
msgstr "Variables supprimées"
|
||||||
|
|
||||||
#: src/rougail/output_doc/config.py:41
|
#: src/rougail/output_doc/config.py:54
|
||||||
msgid "duplicated level rougail-doc for output \"{0}\": {1} and {2}"
|
msgid "duplicated level rougail-output-doc for {0} \"{1}\": {2} and {3}"
|
||||||
msgstr "niveau dupliqué pour rougail-doc pour la sortie \"{0}\": {1} et {2}"
|
msgstr "niveau dupliqué pour rougail-doc pour {0} \"{1}\": {2} et {3}"
|
||||||
|
|
||||||
#: src/rougail/output_doc/config.py:73
|
#: src/rougail/output_doc/config.py:60
|
||||||
msgid "Generate documentation"
|
msgid "duplicated name \"{0}\" in rougail-output-doc"
|
||||||
msgstr "Générer la documentation"
|
msgstr "nom dupliqué \"{0}\" dans rougail-output-doc"
|
||||||
|
|
||||||
#: src/rougail/output_doc/config.py:79
|
#: src/rougail/output_doc/config.py:123
|
||||||
msgid "when \"doc\" is not set in \"step.output\""
|
msgid "Generate documentation from structural files"
|
||||||
msgstr "lorsque \"doc\" n'est pas spécifié dans \"step.output\""
|
msgstr "Générer la documentation depuis les fichiers de structure"
|
||||||
|
|
||||||
#: src/rougail/output_doc/config.py:82
|
#: src/rougail/output_doc/config.py:124
|
||||||
|
msgid ""
|
||||||
|
"The structural files contain all the information related to the variables. "
|
||||||
|
"This output generates the documentation for all or some of these variables."
|
||||||
|
msgstr ""
|
||||||
|
"Les fichiers de structure contiennent toutes les informations relatif aux "
|
||||||
|
"variables. Cette sortie génère la documentation pour tout ou partie de ces "
|
||||||
|
"variables."
|
||||||
|
|
||||||
|
#: src/rougail/output_doc/config.py:133
|
||||||
|
msgid "if doc is not set in \"step.output\""
|
||||||
|
msgstr "si doc n'est pas spécifié dans \"step.output\""
|
||||||
|
|
||||||
|
#: src/rougail/output_doc/config.py:136
|
||||||
|
msgid "The output format of the generated documentation"
|
||||||
|
msgstr "Le format de sortie de la documentation générée"
|
||||||
|
|
||||||
|
#: src/rougail/output_doc/config.py:145
|
||||||
|
msgid "Generate document with this tabular model"
|
||||||
|
msgstr "Génère la documentation avec ce modèle de tableau"
|
||||||
|
|
||||||
|
#: src/rougail/output_doc/config.py:146
|
||||||
|
msgid ""
|
||||||
|
"The variables are documented with a tabular view. A template selection "
|
||||||
|
"allows you to choose the content of each column."
|
||||||
|
msgstr ""
|
||||||
|
"Les variables sont documentées avec une vue tableau. Une sélection de modèle "
|
||||||
|
"vous permet de choisir le contenu de chaque colonne."
|
||||||
|
|
||||||
|
#: src/rougail/output_doc/config.py:153
|
||||||
|
msgid "\"_.output_format\" in json is not compatible with this variable"
|
||||||
|
msgstr "\"_.output_format\" en json n\\'est pas compatible avec cette variable"
|
||||||
|
|
||||||
|
#: src/rougail/output_doc/config.py:160
|
||||||
|
msgid "Generated content"
|
||||||
|
msgstr "Contenu généré"
|
||||||
|
|
||||||
|
#: src/rougail/output_doc/config.py:161
|
||||||
|
msgid ""
|
||||||
|
"You can generate three type of document. All variables (\"variables\"), an "
|
||||||
|
"example file in YAML format (\"example\") or change log (\"changelog\")."
|
||||||
|
msgstr ""
|
||||||
|
"Vous pouvez générer trois type de documentation. Toutes les variables "
|
||||||
|
"(\"variables\"), un exemple de fichier au format YAML (\"example\") ou le "
|
||||||
|
"journal des changements (\"changelog\")."
|
||||||
|
|
||||||
|
#: src/rougail/output_doc/config.py:173
|
||||||
|
msgid ""
|
||||||
|
"\"_.output_format\" in json is not compatible with changelog or example "
|
||||||
|
"\"_.contents\""
|
||||||
|
msgstr ""
|
||||||
|
"\"_.output_format\" en json n'est pas compatible avec \"_.contents\" "
|
||||||
|
"changelog or example"
|
||||||
|
|
||||||
|
#: src/rougail/output_doc/config.py:176
|
||||||
msgid "Starting title level"
|
msgid "Starting title level"
|
||||||
msgstr "Niveau de titre de départ"
|
msgstr "Niveau de titre de départ"
|
||||||
|
|
||||||
#: src/rougail/output_doc/config.py:87
|
#: src/rougail/output_doc/config.py:181
|
||||||
msgid "Generated content"
|
msgid "Modify values to document all variables"
|
||||||
msgstr "Contenu générer"
|
msgstr "Modifier les valeurs pour documenter toutes les variables"
|
||||||
|
|
||||||
#: src/rougail/output_doc/config.py:96
|
#: src/rougail/output_doc/config.py:182
|
||||||
msgid "Previous description file in JSON format"
|
msgid ""
|
||||||
msgstr "Précédent fichier de description au format JSON"
|
"To document leadership or dynamic family variables, it is sometimes "
|
||||||
|
"necessary to generate values, which can change the values in the "
|
||||||
|
"configuration. Be careful if you reuse this configuration."
|
||||||
|
msgstr ""
|
||||||
|
"Pour documenter les variables des leadership ou des familles dynamiques, il "
|
||||||
|
"est parfois nécessaire de générer des valeurs, qui peuvent modifier les "
|
||||||
|
"valeurs de la configuration. Soyez vigilent si vous réutilisez cette "
|
||||||
|
"configuration."
|
||||||
|
|
||||||
#: src/rougail/output_doc/config.py:101
|
#: src/rougail/output_doc/config.py:186
|
||||||
msgid "changelog is not selected in \"_.contents\""
|
msgid "Display documentation in console always with true color terminal"
|
||||||
msgstr "changelog n'est pas sélectionné dans \"_.contents\""
|
msgstr ""
|
||||||
|
"Afficher la documentation dans la console en permanence avec un terminal en "
|
||||||
|
"couleurs réelles"
|
||||||
|
|
||||||
#: src/rougail/output_doc/config.py:104
|
#: src/rougail/output_doc/config.py:193
|
||||||
|
msgid "Document the child variables of the family"
|
||||||
|
msgstr "Documenter les variables enfants de cette famille"
|
||||||
|
|
||||||
|
#: src/rougail/output_doc/config.py:194
|
||||||
|
msgid ""
|
||||||
|
"By default, all accessible variables are included in the documentation. It "
|
||||||
|
"is possible to define the family from which the documentation should be "
|
||||||
|
"generated."
|
||||||
|
msgstr ""
|
||||||
|
"Par défaut, toute les variables accessibles sont incluent dans la "
|
||||||
|
"documentation. Il est possible de définir une famille a partir de laquelle "
|
||||||
|
"la documentation doit être générée."
|
||||||
|
|
||||||
|
#: src/rougail/output_doc/config.py:199
|
||||||
|
msgid "The variables in this family are documented in another file"
|
||||||
|
msgstr "Les variables pour cette famille sont documentés dans un autre fichier"
|
||||||
|
|
||||||
|
#: src/rougail/output_doc/config.py:200
|
||||||
|
msgid ""
|
||||||
|
"If you separate the variables into different files, the links between the "
|
||||||
|
"variables will break. Therefore, you must define different filenames for the "
|
||||||
|
"files containing these variables."
|
||||||
|
msgstr ""
|
||||||
|
"Si vous séparez les variables dans différents fichiers, le lien entre les "
|
||||||
|
"variables va être cassé. Dans ce cas, vous devez définit différents nom de "
|
||||||
|
"fichiers pour les fichiers contenant ces variables."
|
||||||
|
|
||||||
|
#: src/rougail/output_doc/config.py:207
|
||||||
|
msgid "This file contains child variables of the family"
|
||||||
|
msgstr "Ce fichier contient les variables enfants de la famille"
|
||||||
|
|
||||||
|
#: src/rougail/output_doc/config.py:211
|
||||||
|
msgid "Name of the file"
|
||||||
|
msgstr "Nom du fichier"
|
||||||
|
|
||||||
|
#: src/rougail/output_doc/config.py:219
|
||||||
|
msgid "Variables and changelog documentation"
|
||||||
|
msgstr "Documentation des variables et journal de changements"
|
||||||
|
|
||||||
|
#: src/rougail/output_doc/config.py:224
|
||||||
|
msgid ""
|
||||||
|
"if \"_.output_format\" is json or \"_.contents\" hasn't variables or "
|
||||||
|
"changelog"
|
||||||
|
msgstr ""
|
||||||
|
"si \"_.output_format\" en json ou si \"_.contents\" n'est pas variables ou "
|
||||||
|
"changelog"
|
||||||
|
|
||||||
|
#: src/rougail/output_doc/config.py:227
|
||||||
msgid "Do not add families in documentation"
|
msgid "Do not add families in documentation"
|
||||||
msgstr "Ne pas ajouter les familles dans la documentation"
|
msgstr "Ne pas ajouter les familles dans la documentation"
|
||||||
|
|
||||||
#: src/rougail/output_doc/config.py:110
|
#: src/rougail/output_doc/config.py:232
|
||||||
msgid "variables is not selected in \"_.contents\""
|
|
||||||
msgstr "variables n'est pas sélectionné dans \"_.contents\""
|
|
||||||
|
|
||||||
#: src/rougail/output_doc/config.py:113
|
|
||||||
msgid "Document the variables from this family"
|
|
||||||
msgstr "Documente les variables depuis cette famille"
|
|
||||||
|
|
||||||
#: src/rougail/output_doc/config.py:117
|
|
||||||
msgid "Add command line informations in documentation"
|
msgid "Add command line informations in documentation"
|
||||||
msgstr "Ajoute les informations de la ligne de commande dans la documentation"
|
msgstr "Ajoute les informations de la ligne de commande dans la documentation"
|
||||||
|
|
||||||
#: src/rougail/output_doc/config.py:123 src/rougail/output_doc/config.py:132
|
#: src/rougail/output_doc/config.py:237
|
||||||
msgid ""
|
|
||||||
"if \"_.output_format\" is json or variables is not selected in \"_.contents\""
|
|
||||||
msgstr ""
|
|
||||||
"si \"_.output_format\" est json ou si variables n'est pas sélectionné dans "
|
|
||||||
"\"_.contents\""
|
|
||||||
|
|
||||||
#: src/rougail/output_doc/config.py:126
|
|
||||||
msgid "Add environment variable informations in documentation"
|
msgid "Add environment variable informations in documentation"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
"Ajoute les informations de variable d'environnement dans la documentation"
|
"Ajoute les informations de variable d'environnement dans la documentation"
|
||||||
|
|
||||||
#: src/rougail/output_doc/config.py:135
|
#: src/rougail/output_doc/config.py:242
|
||||||
msgid "Name of the default environment prefix"
|
msgid "Environment variables prefix name"
|
||||||
msgstr "Nom du préfixe d'environnement par défaut"
|
msgstr "Préfixe du nom des variables d'environnement"
|
||||||
|
|
||||||
#: src/rougail/output_doc/config.py:141
|
#: src/rougail/output_doc/config.py:249
|
||||||
msgid "should only user uppercase characters"
|
msgid "should only use uppercase characters"
|
||||||
msgstr "doit seulement utilise des caractères en majuscule"
|
msgstr "doit seulement utilise des caractères en majuscule"
|
||||||
|
|
||||||
#: src/rougail/output_doc/config.py:146
|
#: src/rougail/output_doc/config.py:254
|
||||||
|
msgid "if \"main_namespace\" is not set or \"_.with_environment\" is false"
|
||||||
|
msgstr ""
|
||||||
|
"si \"main_namespace\" n'est pas défini ou \"_.with_environment\" est false"
|
||||||
|
|
||||||
|
#: src/rougail/output_doc/config.py:257
|
||||||
|
msgid "Changelog documentation"
|
||||||
|
msgstr "Documentation du journal des changements"
|
||||||
|
|
||||||
|
#: src/rougail/output_doc/config.py:262
|
||||||
|
msgid "if changelog in not in \"_.contents\""
|
||||||
|
msgstr "changelog n'est pas défini dans \"_.contents\""
|
||||||
|
|
||||||
|
#: src/rougail/output_doc/config.py:265
|
||||||
|
msgid "Previous description file in JSON format"
|
||||||
|
msgstr "Précédent fichier de description au format JSON"
|
||||||
|
|
||||||
|
#: src/rougail/output_doc/config.py:266
|
||||||
msgid ""
|
msgid ""
|
||||||
"when \"__.main_namespace\" is not set or \"_.with_environment\" is false"
|
"To generate the changelog, you need to compare the old list of variables (in "
|
||||||
|
"json format) with the current variables."
|
||||||
msgstr ""
|
msgstr ""
|
||||||
"si \"__.main_namespace\" n'est pas défini ou \"_.with_environment\" est false"
|
"Pour générer le journal des changements, vous devez comparer l'ancienne "
|
||||||
|
"liste des variables (au format json) avec les variables courantes."
|
||||||
|
|
||||||
#: src/rougail/output_doc/config.py:149
|
#: src/rougail/output_doc/config.py:270
|
||||||
msgid "Families or variables for this family are in an other file name"
|
msgid "Examples configuration"
|
||||||
msgstr ""
|
msgstr "Configuration des exemples"
|
||||||
"Les familles ou variables pour cette famille sont dans un autre fichier"
|
|
||||||
|
|
||||||
#: src/rougail/output_doc/config.py:156
|
#: src/rougail/output_doc/config.py:275
|
||||||
msgid "documentation must be splitted"
|
msgid "if example is not in \"_.contents\""
|
||||||
msgstr "documentation doit être séparée"
|
msgstr "si example n'est pas défini dans \"_.contents\""
|
||||||
|
|
||||||
#: src/rougail/output_doc/config.py:159
|
#: src/rougail/output_doc/config.py:278
|
||||||
msgid "Root family name"
|
|
||||||
msgstr "Nom de la famille racine"
|
|
||||||
|
|
||||||
#: src/rougail/output_doc/config.py:163
|
|
||||||
msgid "Name of the file"
|
|
||||||
msgstr "Nom du fichier"
|
|
||||||
|
|
||||||
#: src/rougail/output_doc/config.py:169
|
|
||||||
msgid "Disable documentation for variables with those modes"
|
|
||||||
msgstr "Désactiver la documentation des variables avec ces modes"
|
|
||||||
|
|
||||||
#: src/rougail/output_doc/config.py:177
|
|
||||||
msgid "disabled when there is no mode available"
|
|
||||||
msgstr "désactiver lorsqu'il n'y a pas de mode valable"
|
|
||||||
|
|
||||||
#: src/rougail/output_doc/config.py:183
|
|
||||||
msgid "verify if disable modes already exists"
|
|
||||||
msgstr "vérifier le mode existe déjà"
|
|
||||||
|
|
||||||
#: src/rougail/output_doc/config.py:185
|
|
||||||
msgid "Modify values to document leaderships and dynamics families"
|
|
||||||
msgstr "Valeurs modifiées pour documenter les familles leader ou dynamique"
|
|
||||||
|
|
||||||
#: src/rougail/output_doc/config.py:188
|
|
||||||
msgid "Add description of variables and families when generate examples"
|
msgid "Add description of variables and families when generate examples"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
"Ajouter la description des variables et des familles lorsqu'on génère des "
|
"Ajouter la description des variables et des familles lorsqu'on génère des "
|
||||||
"exemples"
|
"exemples"
|
||||||
|
|
||||||
#: src/rougail/output_doc/config.py:194
|
#: src/rougail/output_doc/config.py:283
|
||||||
msgid "disabled when example in not in contents"
|
|
||||||
msgstr "désactiver lorsqu'il example n'est pas dans contents"
|
|
||||||
|
|
||||||
#: src/rougail/output_doc/config.py:197
|
|
||||||
msgid "Comment in examples starts at column"
|
msgid "Comment in examples starts at column"
|
||||||
msgstr "Commentaire dans les exemples commence à la colonne"
|
msgstr "Commentaire dans les exemples commence à la colonne"
|
||||||
|
|
||||||
#: src/rougail/output_doc/config.py:205
|
#: src/rougail/output_doc/doc.py:329
|
||||||
msgid "Generate document in format"
|
|
||||||
msgstr "Générer le document au format"
|
|
||||||
|
|
||||||
#: src/rougail/output_doc/config.py:215
|
|
||||||
msgid ""
|
|
||||||
"json output_format is not compatible with \"changelog\" and \"example\" "
|
|
||||||
"contents"
|
|
||||||
msgstr ""
|
|
||||||
"le format de sortie json n'est pas compatible avec \"changelog\" et "
|
|
||||||
"example\" de la variable contents"
|
|
||||||
|
|
||||||
#: src/rougail/output_doc/config.py:224
|
|
||||||
msgid "Force true color terminal"
|
|
||||||
msgstr "Force les vrais couleurs dans le terminal"
|
|
||||||
|
|
||||||
#: src/rougail/output_doc/doc.py:330
|
|
||||||
msgid "This family contains lists of variable blocks"
|
msgid "This family contains lists of variable blocks"
|
||||||
msgstr "Cette famille contient des listes de bloc de variable"
|
msgstr "Cette famille contient des listes de bloc de variable"
|
||||||
|
|
||||||
#: src/rougail/output_doc/doc.py:340
|
#: src/rougail/output_doc/doc.py:339
|
||||||
msgid "This family builds families dynamically"
|
msgid "This family builds families dynamically"
|
||||||
msgstr "Cette famille construit des familles dynamiquement"
|
msgstr "Cette famille construit des familles dynamiquement"
|
||||||
|
|
||||||
#: src/rougail/output_doc/doc.py:354
|
#: src/rougail/output_doc/doc.py:353
|
||||||
msgid "Default"
|
msgid "Default"
|
||||||
msgstr "Défaut"
|
msgstr "Défaut"
|
||||||
|
|
||||||
#: src/rougail/output_doc/doc.py:369
|
#: src/rougail/output_doc/doc.py:371
|
||||||
msgid "multiple"
|
|
||||||
msgstr "multiple"
|
|
||||||
|
|
||||||
#: src/rougail/output_doc/doc.py:377
|
|
||||||
msgid "Example"
|
msgid "Example"
|
||||||
msgstr "Exemple"
|
msgstr "Exemple"
|
||||||
|
|
||||||
#: src/rougail/output_doc/doc.py:380
|
#: src/rougail/output_doc/doc.py:374
|
||||||
msgid "Examples"
|
msgid "Examples"
|
||||||
msgstr "Exemples"
|
msgstr "Exemples"
|
||||||
|
|
||||||
#: src/rougail/output_doc/doc.py:389
|
#: src/rougail/output_doc/doc.py:383
|
||||||
msgid "Tag"
|
msgid "Tag"
|
||||||
msgstr "Étiquette"
|
msgstr "Étiquette"
|
||||||
|
|
||||||
#: src/rougail/output_doc/doc.py:392
|
#: src/rougail/output_doc/doc.py:386
|
||||||
msgid "Tags"
|
msgid "Tags"
|
||||||
msgstr "Étiquettes"
|
msgstr "Étiquettes"
|
||||||
|
|
||||||
#: src/rougail/output_doc/doc.py:424
|
#: src/rougail/output_doc/doc.py:418
|
||||||
msgid "No attribute \"description\" for \"{0}\" in {1}"
|
msgid "No attribute \"description\" for \"{0}\" in {1}"
|
||||||
msgstr "Aucun attribut \"description\" pour \"{0}\" dans {1}"
|
msgstr "Aucun attribut \"description\" pour \"{0}\" dans {1}"
|
||||||
|
|
||||||
#: src/rougail/output_doc/doc.py:562
|
#: src/rougail/output_doc/doc.py:553
|
||||||
msgid "text based with regular expressions \"{0}\""
|
msgid "text based with regular expressions \"{0}\""
|
||||||
msgstr "texte avec expression rationnelle \"{0}\""
|
msgstr "texte avec expression rationnelle \"{0}\""
|
||||||
|
|
||||||
#: src/rougail/output_doc/doc.py:566
|
#: src/rougail/output_doc/doc.py:557
|
||||||
|
#: src/rougail/output_doc/tabular/six_columns.py:65
|
||||||
msgid "Validator"
|
msgid "Validator"
|
||||||
msgstr "Validateur"
|
msgstr "Validateur"
|
||||||
|
|
||||||
#: src/rougail/output_doc/doc.py:569
|
#: src/rougail/output_doc/doc.py:560
|
||||||
msgid "Validators"
|
msgid "Validators"
|
||||||
msgstr "Validateurs"
|
msgstr "Validateurs"
|
||||||
|
|
||||||
#: src/rougail/output_doc/doc.py:578
|
#: src/rougail/output_doc/doc.py:569
|
||||||
msgid "Choices"
|
msgid "Choices"
|
||||||
msgstr "Choix"
|
msgstr "Choix"
|
||||||
|
|
||||||
#: src/rougail/output_doc/doc.py:681
|
#: src/rougail/output_doc/doc.py:672
|
||||||
msgid "the value of the identifier"
|
msgid "the value of the identifier"
|
||||||
msgstr "la valeur de l'identifiant"
|
msgstr "la valeur de l'identifiant"
|
||||||
|
|
||||||
#: src/rougail/output_doc/doc.py:685
|
#: src/rougail/output_doc/doc.py:676
|
||||||
msgid "the value of the {0}"
|
msgid "the value of the {0}"
|
||||||
msgstr "la valeur de l'{0}"
|
msgstr "la valeur de l'{0}"
|
||||||
|
|
||||||
#: src/rougail/output_doc/doc.py:694
|
#: src/rougail/output_doc/doc.py:685
|
||||||
msgid "depends on a calculation"
|
msgid "depends on a calculation"
|
||||||
msgstr "dépend d'un calcul"
|
msgstr "dépend d'un calcul"
|
||||||
|
|
||||||
#: src/rougail/output_doc/doc.py:700
|
#: src/rougail/output_doc/doc.py:691
|
||||||
msgid "\"{0}\" is a calculation for {1} but has no description in {2}"
|
msgid "\"{0}\" is a calculation for {1} but has no description in {2}"
|
||||||
msgstr "\"{0}\" est un calcul pour {1} mais n'a pas de description dans {2}"
|
msgstr "\"{0}\" est un calcul pour {1} mais n'a pas de description dans {2}"
|
||||||
|
|
||||||
#: src/rougail/output_doc/doc.py:728
|
#: src/rougail/output_doc/doc.py:719
|
||||||
msgid "the value of the variable \"{0}\""
|
msgid "the value of the variable \"{0}\""
|
||||||
msgstr "la valeur de la variable \"{0}\""
|
msgstr "la valeur de la variable \"{0}\""
|
||||||
|
|
||||||
#: src/rougail/output_doc/doc.py:730
|
#: src/rougail/output_doc/doc.py:721
|
||||||
msgid "the value of the variable \"{0}\" if it is defined"
|
msgid "the value of the variable \"{0}\" if it is defined"
|
||||||
msgstr "la valeur de la variable \"{0}\" si elle est définie"
|
msgstr "la valeur de la variable \"{0}\" si elle est définie"
|
||||||
|
|
||||||
#: src/rougail/output_doc/doc.py:750
|
#: src/rougail/output_doc/doc.py:741
|
||||||
msgid "the value of an undocumented variable"
|
msgid "the value of an undocumented variable"
|
||||||
msgstr "la valeur d'une variable non documentée"
|
msgstr "la valeur d'une variable non documentée"
|
||||||
|
|
||||||
#: src/rougail/output_doc/doc.py:753
|
#: src/rougail/output_doc/doc.py:744
|
||||||
msgid "the values of undocumented variables"
|
msgid "the values of undocumented variables"
|
||||||
msgstr "les valeurs de variables non documentées"
|
msgstr "les valeurs de variables non documentées"
|
||||||
|
|
||||||
#: src/rougail/output_doc/doc.py:776
|
#: src/rougail/output_doc/doc.py:767
|
||||||
msgid "(from an undocumented variable)"
|
msgid "(from an undocumented variable)"
|
||||||
msgstr "(issue d'une variable non documentée)"
|
msgstr "(issue d'une variable non documentée)"
|
||||||
|
|
||||||
#: src/rougail/output_doc/doc.py:784
|
#: src/rougail/output_doc/doc.py:775
|
||||||
msgid "{0} (from an undocumented variable)"
|
msgid "{0} (from an undocumented variable)"
|
||||||
msgstr "{0} (issue d'une variable non documentée)"
|
msgstr "{0} (issue d'une variable non documentée)"
|
||||||
|
|
||||||
#: src/rougail/output_doc/doc.py:788 src/rougail/output_doc/doc.py:840
|
#: src/rougail/output_doc/doc.py:779 src/rougail/output_doc/doc.py:831
|
||||||
msgid "depends on an undocumented variable"
|
msgid "depends on an undocumented variable"
|
||||||
msgstr "dépends d'une variable non documentée"
|
msgstr "dépends d'une variable non documentée"
|
||||||
|
|
||||||
#: src/rougail/output_doc/doc.py:862
|
#: src/rougail/output_doc/doc.py:853
|
||||||
msgid ""
|
msgid ""
|
||||||
"when the variable \"{{0}}\" is defined, accessible and hasn't the value "
|
"when the variable \"{{0}}\" is defined, accessible and hasn't the value "
|
||||||
"\"{0}\""
|
"\"{0}\""
|
||||||
|
|
@ -293,35 +360,35 @@ msgstr ""
|
||||||
"lorsque la variable \"{{0}}\" est définie, accessible et n'a pas la valeur "
|
"lorsque la variable \"{{0}}\" est définie, accessible et n'a pas la valeur "
|
||||||
"\"{0}\""
|
"\"{0}\""
|
||||||
|
|
||||||
#: src/rougail/output_doc/doc.py:866
|
#: src/rougail/output_doc/doc.py:857
|
||||||
msgid "when the variable \"{{0}}\" is defined and hasn't the value \"{0}\""
|
msgid "when the variable \"{{0}}\" is defined and hasn't the value \"{0}\""
|
||||||
msgstr "lorsque la variable \"{{0}}\" est définie et n'a pas la valeur \"{0}\""
|
msgstr "lorsque la variable \"{{0}}\" est définie et n'a pas la valeur \"{0}\""
|
||||||
|
|
||||||
#: src/rougail/output_doc/doc.py:870
|
#: src/rougail/output_doc/doc.py:861
|
||||||
msgid "when the variable \"{{0}}\" is accessible and hasn't the value \"{0}\""
|
msgid "when the variable \"{{0}}\" is accessible and hasn't the value \"{0}\""
|
||||||
msgstr ""
|
msgstr ""
|
||||||
"lorsque la variable \"{{0}}\" est acessible et n'a pas la valeur \"{0}\""
|
"lorsque la variable \"{{0}}\" est acessible et n'a pas la valeur \"{0}\""
|
||||||
|
|
||||||
#: src/rougail/output_doc/doc.py:872
|
#: src/rougail/output_doc/doc.py:863
|
||||||
msgid "when the variable \"{{0}}\" hasn't the value \"{0}\""
|
msgid "when the variable \"{{0}}\" hasn't the value \"{0}\""
|
||||||
msgstr "lorsque la variable \"{{0}}\" n'a pas la valeur \"{0}\""
|
msgstr "lorsque la variable \"{{0}}\" n'a pas la valeur \"{0}\""
|
||||||
|
|
||||||
#: src/rougail/output_doc/doc.py:876
|
#: src/rougail/output_doc/doc.py:867
|
||||||
msgid ""
|
msgid ""
|
||||||
"when the variable \"{{0}}\" is defined, is accessible and has the value "
|
"when the variable \"{{0}}\" is defined, is accessible and has the value "
|
||||||
"\"{0}\""
|
"\"{0}\""
|
||||||
msgstr ""
|
msgstr ""
|
||||||
"lorsque la variable \"{{0}}\" est définie, accessible et a la valeur \"{0}\""
|
"lorsque la variable \"{{0}}\" est définie, accessible et a la valeur \"{0}\""
|
||||||
|
|
||||||
#: src/rougail/output_doc/doc.py:880
|
#: src/rougail/output_doc/doc.py:871
|
||||||
msgid "when the variable \"{{0}}\" is defined and has the value \"{0}\""
|
msgid "when the variable \"{{0}}\" is defined and has the value \"{0}\""
|
||||||
msgstr "lorsque la variable \"{{0}}\" est définie et a la valeur \"{0}\""
|
msgstr "lorsque la variable \"{{0}}\" est définie et a la valeur \"{0}\""
|
||||||
|
|
||||||
#: src/rougail/output_doc/doc.py:884
|
#: src/rougail/output_doc/doc.py:875
|
||||||
msgid "when the variable \"{{0}}\" is accessible and has the value \"{0}\""
|
msgid "when the variable \"{{0}}\" is accessible and has the value \"{0}\""
|
||||||
msgstr "lorsque la variable \"{{0}}\" est accessible et a la valeur \"{0}\""
|
msgstr "lorsque la variable \"{{0}}\" est accessible et a la valeur \"{0}\""
|
||||||
|
|
||||||
#: src/rougail/output_doc/doc.py:886
|
#: src/rougail/output_doc/doc.py:877
|
||||||
msgid "when the variable \"{{0}}\" has the value \"{0}\""
|
msgid "when the variable \"{{0}}\" has the value \"{0}\""
|
||||||
msgstr "lorsque la variable \"{{0}}\" a la valeur \"{0}\""
|
msgstr "lorsque la variable \"{{0}}\" a la valeur \"{0}\""
|
||||||
|
|
||||||
|
|
@ -333,145 +400,161 @@ msgstr "Exemple avec des variables obligatoire non renseignée"
|
||||||
msgid "Example with all variables modifiable"
|
msgid "Example with all variables modifiable"
|
||||||
msgstr "Exemple avec toutes les variables modifiable"
|
msgstr "Exemple avec toutes les variables modifiable"
|
||||||
|
|
||||||
#: src/rougail/output_doc/output/asciidoc.py:152
|
#: src/rougail/output_doc/output/asciidoc.py:156
|
||||||
#: src/rougail/output_doc/output/console.py:189
|
#: src/rougail/output_doc/output/console.py:199
|
||||||
#: src/rougail/output_doc/output/github.py:188
|
#: src/rougail/output_doc/output/github.py:196
|
||||||
#: src/rougail/output_doc/output/gitlab.py:44
|
#: src/rougail/output_doc/output/gitlab.py:44
|
||||||
msgid "Informations"
|
msgid "Informations"
|
||||||
msgstr "Informations"
|
msgstr "Informations"
|
||||||
|
|
||||||
#: src/rougail/output_doc/output/console.py:182
|
#: src/rougail/output_doc/tabular/five_columns.py:59
|
||||||
#: src/rougail/output_doc/utils.py:896
|
msgid "Access control"
|
||||||
|
msgstr "Contrôle des accès"
|
||||||
|
|
||||||
|
#: src/rougail/output_doc/tabular/four_columns.py:53
|
||||||
|
msgid "Type"
|
||||||
|
msgstr "Type"
|
||||||
|
|
||||||
|
#: src/rougail/output_doc/tabular/three_columns.py:46
|
||||||
|
msgid "Default value"
|
||||||
|
msgstr "Valeur par défaut"
|
||||||
|
|
||||||
|
#: src/rougail/output_doc/tabular/two_columns.py:45
|
||||||
msgid "Variable"
|
msgid "Variable"
|
||||||
msgstr "Variable"
|
msgstr "Variable"
|
||||||
|
|
||||||
#: src/rougail/output_doc/output/console.py:183
|
#: src/rougail/output_doc/tabular/two_columns.py:47
|
||||||
#: src/rougail/output_doc/utils.py:896
|
|
||||||
msgid "Description"
|
msgid "Description"
|
||||||
msgstr "Description"
|
msgstr "Description"
|
||||||
|
|
||||||
#: src/rougail/output_doc/utils.py:48
|
#: src/rougail/output_doc/utils.py:152
|
||||||
msgid "the domain name can starts by a dot"
|
|
||||||
msgstr "le nom de domaine peut commencer par un point"
|
|
||||||
|
|
||||||
#: src/rougail/output_doc/utils.py:49
|
|
||||||
msgid "the domain name can be a hostname"
|
|
||||||
msgstr "le nom de domaine peut être un nom d'hôte"
|
|
||||||
|
|
||||||
#: src/rougail/output_doc/utils.py:50
|
|
||||||
msgid "the domain name can be an IP"
|
|
||||||
msgstr "le nom de domaine peut être une IP"
|
|
||||||
|
|
||||||
#: src/rougail/output_doc/utils.py:51
|
|
||||||
msgid "the domain name can be network in CIDR format"
|
|
||||||
msgstr "le nom de domaine peut être un réseau au format CIDR"
|
|
||||||
|
|
||||||
#: src/rougail/output_doc/utils.py:56 src/rougail/output_doc/utils.py:62
|
|
||||||
msgid "the minimum value is {0}"
|
|
||||||
msgstr "le valeur minimal est {0}"
|
|
||||||
|
|
||||||
#: src/rougail/output_doc/utils.py:57 src/rougail/output_doc/utils.py:63
|
|
||||||
msgid "the maximum value is {0}"
|
|
||||||
msgstr "le valeur maximal est {0}"
|
|
||||||
|
|
||||||
#: src/rougail/output_doc/utils.py:69
|
|
||||||
msgid "IP must be in CIDR format"
|
|
||||||
msgstr "IP doit être au format CIDR"
|
|
||||||
|
|
||||||
#: src/rougail/output_doc/utils.py:70
|
|
||||||
msgid "private IP are allowed"
|
|
||||||
msgstr "les IP privées sont autorisés"
|
|
||||||
|
|
||||||
#: src/rougail/output_doc/utils.py:71
|
|
||||||
msgid "reserved IP are allowed"
|
|
||||||
msgstr "les IP réservés sont autorisés"
|
|
||||||
|
|
||||||
#: src/rougail/output_doc/utils.py:76
|
|
||||||
msgid "network must be in CIDR format"
|
|
||||||
msgstr "réseau doit être au format CIDR"
|
|
||||||
|
|
||||||
#: src/rougail/output_doc/utils.py:81
|
|
||||||
msgid "the host name can be an IP"
|
|
||||||
msgstr "le nom d'hôte peut être une IP"
|
|
||||||
|
|
||||||
#: src/rougail/output_doc/utils.py:86
|
|
||||||
msgid "the domain name in web address can be an IP"
|
|
||||||
msgstr "le nom de domaine dans l'adresse web peut être une IP"
|
|
||||||
|
|
||||||
#: src/rougail/output_doc/utils.py:87
|
|
||||||
msgid "the domain name in web address can be only a hostname"
|
|
||||||
msgstr "le nom de domaine dans l'adresse web ne peut être qu'un nom d'hôte"
|
|
||||||
|
|
||||||
#: src/rougail/output_doc/utils.py:94
|
|
||||||
msgid "can be range of port"
|
|
||||||
msgstr "peut être un range de port"
|
|
||||||
|
|
||||||
#: src/rougail/output_doc/utils.py:95
|
|
||||||
msgid "can have the protocol"
|
|
||||||
msgstr "peut avoir un protocole"
|
|
||||||
|
|
||||||
#: src/rougail/output_doc/utils.py:96
|
|
||||||
msgid "port 0 is allowed"
|
|
||||||
msgstr "le port 0 est autorisé"
|
|
||||||
|
|
||||||
#: src/rougail/output_doc/utils.py:97
|
|
||||||
msgid "well-known ports (1 to 1023) are allowed"
|
|
||||||
msgstr "les ports connus (de 1 à 1023) sont autorisés"
|
|
||||||
|
|
||||||
#: src/rougail/output_doc/utils.py:98
|
|
||||||
msgid "registred ports (1024 to 49151) are allowed"
|
|
||||||
msgstr "les ports enregistrés (de 1024 à 49151) sont autorisés"
|
|
||||||
|
|
||||||
#: src/rougail/output_doc/utils.py:99
|
|
||||||
msgid "private ports (greater than 49152) are allowed"
|
|
||||||
msgstr "les ports privés (supérieurs à 49152) sont autorisés"
|
|
||||||
|
|
||||||
#: src/rougail/output_doc/utils.py:104
|
|
||||||
msgid "minimum length for the secret is {0} characters"
|
|
||||||
msgstr "longueur minimum pour le secret est de {0} caractères"
|
|
||||||
|
|
||||||
#: src/rougail/output_doc/utils.py:105
|
|
||||||
msgid "maximum length for the secret is {0} characters"
|
|
||||||
msgstr "longueur maximal pour le secret est de {0} caractères"
|
|
||||||
|
|
||||||
#: src/rougail/output_doc/utils.py:106
|
|
||||||
msgid "forbidden characters: {0}"
|
|
||||||
msgstr "caractères interdits: {0}"
|
|
||||||
|
|
||||||
#: src/rougail/output_doc/utils.py:111
|
|
||||||
msgid "this filename could be a relative path"
|
|
||||||
msgstr "ce nom de fichier peut être un chemin relative"
|
|
||||||
|
|
||||||
#: src/rougail/output_doc/utils.py:112
|
|
||||||
msgid "this file must exists"
|
|
||||||
msgstr "ce fichier doit exister"
|
|
||||||
|
|
||||||
#: src/rougail/output_doc/utils.py:113
|
|
||||||
msgid "file type allowed: {0}"
|
|
||||||
msgstr "type de fichier autorisé : {0}"
|
|
||||||
|
|
||||||
#: src/rougail/output_doc/utils.py:432
|
|
||||||
msgid "Identifiers"
|
|
||||||
msgstr "Identifiants"
|
|
||||||
|
|
||||||
#: src/rougail/output_doc/utils.py:578
|
|
||||||
msgid "Command line"
|
msgid "Command line"
|
||||||
msgstr "Ligne de commande"
|
msgstr "Ligne de commande"
|
||||||
|
|
||||||
#: src/rougail/output_doc/utils.py:581
|
#: src/rougail/output_doc/utils.py:159
|
||||||
msgid "Environment variable"
|
msgid "Environment variable"
|
||||||
msgstr "Variable d'environnement"
|
msgstr "Variable d'environnement"
|
||||||
|
|
||||||
#: src/rougail/output_doc/utils.py:762 src/rougail/output_doc/utils.py:771
|
#: src/rougail/output_doc/utils.py:458
|
||||||
#: src/rougail/output_doc/utils.py:777 src/rougail/output_doc/utils.py:783
|
msgid "Path"
|
||||||
#: src/rougail/output_doc/utils.py:787
|
msgstr "Chemin"
|
||||||
|
|
||||||
|
#: src/rougail/output_doc/utils.py:468
|
||||||
|
msgid "Identifiers"
|
||||||
|
msgstr "Identifiants"
|
||||||
|
|
||||||
|
#: src/rougail/output_doc/utils.py:684 src/rougail/output_doc/utils.py:693
|
||||||
|
#: src/rougail/output_doc/utils.py:699 src/rougail/output_doc/utils.py:705
|
||||||
|
#: src/rougail/output_doc/utils.py:709
|
||||||
msgid "(default)"
|
msgid "(default)"
|
||||||
msgstr "(défaut)"
|
msgstr "(défaut)"
|
||||||
|
|
||||||
#: src/rougail/output_doc/utils.py:973
|
#: src/rougail/output_doc/utils.py:960
|
||||||
msgid "{0}: {1}"
|
msgid "{0}: {1}"
|
||||||
msgstr "{0} : {1}"
|
msgstr "{0} : {1}"
|
||||||
|
|
||||||
|
#~ msgid "variables is not selected in \"_.contents\""
|
||||||
|
#~ msgstr "variables n'est pas sélectionné dans \"_.contents\""
|
||||||
|
|
||||||
|
#~ msgid "Name of the default environment prefix"
|
||||||
|
#~ msgstr "Nom du préfixe d'environnement par défaut"
|
||||||
|
|
||||||
|
#~ msgid "documentation must be splitted"
|
||||||
|
#~ msgstr "documentation doit être séparée"
|
||||||
|
|
||||||
|
#~ msgid "Root family name"
|
||||||
|
#~ msgstr "Nom de la famille racine"
|
||||||
|
|
||||||
|
#~ msgid "disabled when there is no mode available"
|
||||||
|
#~ msgstr "désactiver lorsqu'il n'y a pas de mode valable"
|
||||||
|
|
||||||
|
#~ msgid "verify if disable modes already exists"
|
||||||
|
#~ msgstr "vérifier si le mode existe déjà"
|
||||||
|
|
||||||
|
#~ msgid "Modify values to document leaderships and dynamics families"
|
||||||
|
#~ msgstr "Valeurs modifiées pour documenter les familles leader ou dynamique"
|
||||||
|
|
||||||
|
#~ msgid "Force true color terminal"
|
||||||
|
#~ msgstr "Force les vrais couleurs dans le terminal"
|
||||||
|
|
||||||
|
#~ msgid "multiple"
|
||||||
|
#~ msgstr "multiple"
|
||||||
|
|
||||||
|
#~ msgid "the domain name can starts by a dot"
|
||||||
|
#~ msgstr "le nom de domaine peut commencer par un point"
|
||||||
|
|
||||||
|
#~ msgid "the domain name can be a hostname"
|
||||||
|
#~ msgstr "le nom de domaine peut être un nom d'hôte"
|
||||||
|
|
||||||
|
#~ msgid "the domain name can be an IP"
|
||||||
|
#~ msgstr "le nom de domaine peut être une IP"
|
||||||
|
|
||||||
|
#~ msgid "the domain name can be network in CIDR format"
|
||||||
|
#~ msgstr "le nom de domaine peut être un réseau au format CIDR"
|
||||||
|
|
||||||
|
#~ msgid "the minimum value is {0}"
|
||||||
|
#~ msgstr "le valeur minimal est {0}"
|
||||||
|
|
||||||
|
#~ msgid "the maximum value is {0}"
|
||||||
|
#~ msgstr "le valeur maximal est {0}"
|
||||||
|
|
||||||
|
#~ msgid "IP must be in CIDR format"
|
||||||
|
#~ msgstr "IP doit être au format CIDR"
|
||||||
|
|
||||||
|
#~ msgid "private IP are allowed"
|
||||||
|
#~ msgstr "les IP privées sont autorisés"
|
||||||
|
|
||||||
|
#~ msgid "reserved IP are allowed"
|
||||||
|
#~ msgstr "les IP réservés sont autorisés"
|
||||||
|
|
||||||
|
#~ msgid "network must be in CIDR format"
|
||||||
|
#~ msgstr "réseau doit être au format CIDR"
|
||||||
|
|
||||||
|
#~ msgid "the host name can be an IP"
|
||||||
|
#~ msgstr "le nom d'hôte peut être une IP"
|
||||||
|
|
||||||
|
#~ msgid "the domain name in web address can be an IP"
|
||||||
|
#~ msgstr "le nom de domaine dans l'adresse web peut être une IP"
|
||||||
|
|
||||||
|
#~ msgid "the domain name in web address can be only a hostname"
|
||||||
|
#~ msgstr "le nom de domaine dans l'adresse web ne peut être qu'un nom d'hôte"
|
||||||
|
|
||||||
|
#~ msgid "can be range of port"
|
||||||
|
#~ msgstr "peut être un range de port"
|
||||||
|
|
||||||
|
#~ msgid "can have the protocol"
|
||||||
|
#~ msgstr "peut avoir un protocole"
|
||||||
|
|
||||||
|
#~ msgid "port 0 is allowed"
|
||||||
|
#~ msgstr "le port 0 est autorisé"
|
||||||
|
|
||||||
|
#~ msgid "well-known ports (1 to 1023) are allowed"
|
||||||
|
#~ msgstr "les ports connus (de 1 à 1023) sont autorisés"
|
||||||
|
|
||||||
|
#~ msgid "registred ports (1024 to 49151) are allowed"
|
||||||
|
#~ msgstr "les ports enregistrés (de 1024 à 49151) sont autorisés"
|
||||||
|
|
||||||
|
#~ msgid "private ports (greater than 49152) are allowed"
|
||||||
|
#~ msgstr "les ports privés (supérieurs à 49152) sont autorisés"
|
||||||
|
|
||||||
|
#~ msgid "minimum length for the secret is {0} characters"
|
||||||
|
#~ msgstr "longueur minimum pour le secret est de {0} caractères"
|
||||||
|
|
||||||
|
#~ msgid "maximum length for the secret is {0} characters"
|
||||||
|
#~ msgstr "longueur maximal pour le secret est de {0} caractères"
|
||||||
|
|
||||||
|
#~ msgid "forbidden characters: {0}"
|
||||||
|
#~ msgstr "caractères interdits: {0}"
|
||||||
|
|
||||||
|
#~ msgid "this filename could be a relative path"
|
||||||
|
#~ msgstr "ce nom de fichier peut être un chemin relative"
|
||||||
|
|
||||||
|
#~ msgid "this file must exists"
|
||||||
|
#~ msgstr "ce fichier doit exister"
|
||||||
|
|
||||||
|
#~ msgid "file type allowed: {0}"
|
||||||
|
#~ msgstr "type de fichier autorisé : {0}"
|
||||||
|
|
||||||
#~ msgid "Configuration rougail-doc"
|
#~ msgid "Configuration rougail-doc"
|
||||||
#~ msgstr "Configuration de rougail-doc"
|
#~ msgstr "Configuration de rougail-doc"
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -5,7 +5,7 @@
|
||||||
msgid ""
|
msgid ""
|
||||||
msgstr ""
|
msgstr ""
|
||||||
"Project-Id-Version: PACKAGE VERSION\n"
|
"Project-Id-Version: PACKAGE VERSION\n"
|
||||||
"POT-Creation-Date: 2025-11-27 22:14+0100\n"
|
"POT-Creation-Date: 2025-12-02 12:54+0100\n"
|
||||||
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
|
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
|
||||||
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
|
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
|
||||||
"Language-Team: LANGUAGE <LL@li.org>\n"
|
"Language-Team: LANGUAGE <LL@li.org>\n"
|
||||||
|
|
@ -31,275 +31,304 @@ msgstr ""
|
||||||
msgid "when the identifier is not \"{0}\""
|
msgid "when the identifier is not \"{0}\""
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: src/rougail/output_doc/changelog.py:155
|
#: src/rougail/output_doc/changelog.py:147
|
||||||
msgid "New variable"
|
msgid "New variable"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: src/rougail/output_doc/changelog.py:157
|
#: src/rougail/output_doc/changelog.py:149
|
||||||
msgid "New variables"
|
msgid "New variables"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: src/rougail/output_doc/changelog.py:169
|
#: src/rougail/output_doc/changelog.py:163
|
||||||
msgid "Modified variable"
|
msgid "Modified variable"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: src/rougail/output_doc/changelog.py:171
|
#: src/rougail/output_doc/changelog.py:165
|
||||||
msgid "Modified variables"
|
msgid "Modified variables"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: src/rougail/output_doc/changelog.py:183
|
#: src/rougail/output_doc/changelog.py:179
|
||||||
msgid "Deleted variable"
|
msgid "Deleted variable"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: src/rougail/output_doc/changelog.py:185
|
#: src/rougail/output_doc/changelog.py:181
|
||||||
msgid "Deleted variables"
|
msgid "Deleted variables"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: src/rougail/output_doc/config.py:41
|
#: src/rougail/output_doc/config.py:54
|
||||||
msgid "duplicated level rougail-doc for output \"{0}\": {1} and {2}"
|
msgid "duplicated level rougail-output-doc for {0} \"{1}\": {2} and {3}"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: src/rougail/output_doc/config.py:73
|
#: src/rougail/output_doc/config.py:60
|
||||||
msgid "Generate documentation"
|
msgid "duplicated name \"{0}\" in rougail-output-doc"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: src/rougail/output_doc/config.py:79
|
#: src/rougail/output_doc/config.py:123
|
||||||
msgid "when \"doc\" is not set in \"step.output\""
|
msgid "Generate documentation from structural files"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: src/rougail/output_doc/config.py:82
|
#: src/rougail/output_doc/config.py:124
|
||||||
msgid "Starting title level"
|
msgid "The structural files contain all the information related to the variables. This output generates the documentation for all or some of these variables."
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: src/rougail/output_doc/config.py:87
|
#: src/rougail/output_doc/config.py:133
|
||||||
msgid "Generated content"
|
msgid "if doc is not set in \"step.output\""
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: src/rougail/output_doc/config.py:96
|
#: src/rougail/output_doc/config.py:136
|
||||||
msgid "Previous description file in JSON format"
|
msgid "The output format of the generated documentation"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: src/rougail/output_doc/config.py:101
|
#: src/rougail/output_doc/config.py:145
|
||||||
msgid "changelog is not selected in \"_.contents\""
|
msgid "Generate document with this tabular model"
|
||||||
msgstr ""
|
|
||||||
|
|
||||||
#: src/rougail/output_doc/config.py:104
|
|
||||||
msgid "Do not add families in documentation"
|
|
||||||
msgstr ""
|
|
||||||
|
|
||||||
#: src/rougail/output_doc/config.py:110
|
|
||||||
msgid "variables is not selected in \"_.contents\""
|
|
||||||
msgstr ""
|
|
||||||
|
|
||||||
#: src/rougail/output_doc/config.py:113
|
|
||||||
msgid "Document the variables from this family"
|
|
||||||
msgstr ""
|
|
||||||
|
|
||||||
#: src/rougail/output_doc/config.py:117
|
|
||||||
msgid "Add command line informations in documentation"
|
|
||||||
msgstr ""
|
|
||||||
|
|
||||||
#: src/rougail/output_doc/config.py:123 src/rougail/output_doc/config.py:132
|
|
||||||
msgid "if \"_.output_format\" is json or variables is not selected in \"_.contents\""
|
|
||||||
msgstr ""
|
|
||||||
|
|
||||||
#: src/rougail/output_doc/config.py:126
|
|
||||||
msgid "Add environment variable informations in documentation"
|
|
||||||
msgstr ""
|
|
||||||
|
|
||||||
#: src/rougail/output_doc/config.py:135
|
|
||||||
msgid "Name of the default environment prefix"
|
|
||||||
msgstr ""
|
|
||||||
|
|
||||||
#: src/rougail/output_doc/config.py:141
|
|
||||||
msgid "should only user uppercase characters"
|
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: src/rougail/output_doc/config.py:146
|
#: src/rougail/output_doc/config.py:146
|
||||||
msgid "when \"__.main_namespace\" is not set or \"_.with_environment\" is false"
|
msgid "The variables are documented with a tabular view. A template selection allows you to choose the content of each column."
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: src/rougail/output_doc/config.py:149
|
#: src/rougail/output_doc/config.py:153
|
||||||
msgid "Families or variables for this family are in an other file name"
|
msgid "\"_.output_format\" in json is not compatible with this variable"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: src/rougail/output_doc/config.py:156
|
#: src/rougail/output_doc/config.py:160
|
||||||
msgid "documentation must be splitted"
|
msgid "Generated content"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: src/rougail/output_doc/config.py:159
|
#: src/rougail/output_doc/config.py:161
|
||||||
msgid "Root family name"
|
msgid "You can generate three type of document. All variables (\"variables\"), an example file in YAML format (\"example\") or change log (\"changelog\")."
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: src/rougail/output_doc/config.py:163
|
#: src/rougail/output_doc/config.py:173
|
||||||
msgid "Name of the file"
|
msgid "\"_.output_format\" in json is not compatible with changelog or example \"_.contents\""
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: src/rougail/output_doc/config.py:169
|
#: src/rougail/output_doc/config.py:176
|
||||||
msgid "Disable documentation for variables with those modes"
|
msgid "Starting title level"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: src/rougail/output_doc/config.py:177
|
#: src/rougail/output_doc/config.py:181
|
||||||
msgid "disabled when there is no mode available"
|
msgid "Modify values to document all variables"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: src/rougail/output_doc/config.py:183
|
#: src/rougail/output_doc/config.py:182
|
||||||
msgid "verify if disable modes already exists"
|
msgid "To document leadership or dynamic family variables, it is sometimes necessary to generate values, which can change the values in the configuration. Be careful if you reuse this configuration."
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: src/rougail/output_doc/config.py:185
|
#: src/rougail/output_doc/config.py:186
|
||||||
msgid "Modify values to document leaderships and dynamics families"
|
msgid "Display documentation in console always with true color terminal"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: src/rougail/output_doc/config.py:188
|
#: src/rougail/output_doc/config.py:193
|
||||||
msgid "Add description of variables and families when generate examples"
|
msgid "Document the child variables of the family"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: src/rougail/output_doc/config.py:194
|
#: src/rougail/output_doc/config.py:194
|
||||||
msgid "disabled when example in not in contents"
|
msgid "By default, all accessible variables are included in the documentation. It is possible to define the family from which the documentation should be generated."
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: src/rougail/output_doc/config.py:197
|
#: src/rougail/output_doc/config.py:199
|
||||||
msgid "Comment in examples starts at column"
|
msgid "The variables in this family are documented in another file"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: src/rougail/output_doc/config.py:205
|
#: src/rougail/output_doc/config.py:200
|
||||||
msgid "Generate document in format"
|
msgid "If you separate the variables into different files, the links between the variables will break. Therefore, you must define different filenames for the files containing these variables."
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: src/rougail/output_doc/config.py:215
|
#: src/rougail/output_doc/config.py:207
|
||||||
msgid "json output_format is not compatible with \"changelog\" and \"example\" contents"
|
msgid "This file contains child variables of the family"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#: src/rougail/output_doc/config.py:211
|
||||||
|
msgid "Name of the file"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#: src/rougail/output_doc/config.py:219
|
||||||
|
msgid "Variables and changelog documentation"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: src/rougail/output_doc/config.py:224
|
#: src/rougail/output_doc/config.py:224
|
||||||
msgid "Force true color terminal"
|
msgid "if \"_.output_format\" is json or \"_.contents\" hasn't variables or changelog"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: src/rougail/output_doc/doc.py:330
|
#: src/rougail/output_doc/config.py:227
|
||||||
|
msgid "Do not add families in documentation"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#: src/rougail/output_doc/config.py:232
|
||||||
|
msgid "Add command line informations in documentation"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#: src/rougail/output_doc/config.py:237
|
||||||
|
msgid "Add environment variable informations in documentation"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#: src/rougail/output_doc/config.py:242
|
||||||
|
msgid "Environment variables prefix name"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#: src/rougail/output_doc/config.py:249
|
||||||
|
msgid "should only use uppercase characters"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#: src/rougail/output_doc/config.py:254
|
||||||
|
msgid "if \"main_namespace\" is not set or \"_.with_environment\" is false"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#: src/rougail/output_doc/config.py:257
|
||||||
|
msgid "Changelog documentation"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#: src/rougail/output_doc/config.py:262
|
||||||
|
msgid "if changelog in not in \"_.contents\""
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#: src/rougail/output_doc/config.py:265
|
||||||
|
msgid "Previous description file in JSON format"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#: src/rougail/output_doc/config.py:266
|
||||||
|
msgid "To generate the changelog, you need to compare the old list of variables (in json format) with the current variables."
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#: src/rougail/output_doc/config.py:270
|
||||||
|
msgid "Examples configuration"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#: src/rougail/output_doc/config.py:275
|
||||||
|
msgid "if example is not in \"_.contents\""
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#: src/rougail/output_doc/config.py:278
|
||||||
|
msgid "Add description of variables and families when generate examples"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#: src/rougail/output_doc/config.py:283
|
||||||
|
msgid "Comment in examples starts at column"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#: src/rougail/output_doc/doc.py:329
|
||||||
msgid "This family contains lists of variable blocks"
|
msgid "This family contains lists of variable blocks"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: src/rougail/output_doc/doc.py:340
|
#: src/rougail/output_doc/doc.py:339
|
||||||
msgid "This family builds families dynamically"
|
msgid "This family builds families dynamically"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: src/rougail/output_doc/doc.py:354
|
#: src/rougail/output_doc/doc.py:353
|
||||||
msgid "Default"
|
msgid "Default"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: src/rougail/output_doc/doc.py:369
|
#: src/rougail/output_doc/doc.py:371
|
||||||
msgid "multiple"
|
|
||||||
msgstr ""
|
|
||||||
|
|
||||||
#: src/rougail/output_doc/doc.py:377
|
|
||||||
msgid "Example"
|
msgid "Example"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: src/rougail/output_doc/doc.py:380
|
#: src/rougail/output_doc/doc.py:374
|
||||||
msgid "Examples"
|
msgid "Examples"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: src/rougail/output_doc/doc.py:389
|
#: src/rougail/output_doc/doc.py:383
|
||||||
msgid "Tag"
|
msgid "Tag"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: src/rougail/output_doc/doc.py:392
|
#: src/rougail/output_doc/doc.py:386
|
||||||
msgid "Tags"
|
msgid "Tags"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: src/rougail/output_doc/doc.py:424
|
#: src/rougail/output_doc/doc.py:418
|
||||||
msgid "No attribute \"description\" for \"{0}\" in {1}"
|
msgid "No attribute \"description\" for \"{0}\" in {1}"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: src/rougail/output_doc/doc.py:562
|
#: src/rougail/output_doc/doc.py:553
|
||||||
msgid "text based with regular expressions \"{0}\""
|
msgid "text based with regular expressions \"{0}\""
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: src/rougail/output_doc/doc.py:566
|
#: src/rougail/output_doc/doc.py:557
|
||||||
|
#: src/rougail/output_doc/tabular/six_columns.py:65
|
||||||
msgid "Validator"
|
msgid "Validator"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: src/rougail/output_doc/doc.py:569
|
#: src/rougail/output_doc/doc.py:560
|
||||||
msgid "Validators"
|
msgid "Validators"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: src/rougail/output_doc/doc.py:578
|
#: src/rougail/output_doc/doc.py:569
|
||||||
msgid "Choices"
|
msgid "Choices"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: src/rougail/output_doc/doc.py:681
|
#: src/rougail/output_doc/doc.py:672
|
||||||
msgid "the value of the identifier"
|
msgid "the value of the identifier"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: src/rougail/output_doc/doc.py:685
|
#: src/rougail/output_doc/doc.py:676
|
||||||
msgid "the value of the {0}"
|
msgid "the value of the {0}"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: src/rougail/output_doc/doc.py:694
|
#: src/rougail/output_doc/doc.py:685
|
||||||
msgid "depends on a calculation"
|
msgid "depends on a calculation"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: src/rougail/output_doc/doc.py:700
|
#: src/rougail/output_doc/doc.py:691
|
||||||
msgid "\"{0}\" is a calculation for {1} but has no description in {2}"
|
msgid "\"{0}\" is a calculation for {1} but has no description in {2}"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: src/rougail/output_doc/doc.py:728
|
#: src/rougail/output_doc/doc.py:719
|
||||||
msgid "the value of the variable \"{0}\""
|
msgid "the value of the variable \"{0}\""
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: src/rougail/output_doc/doc.py:730
|
#: src/rougail/output_doc/doc.py:721
|
||||||
msgid "the value of the variable \"{0}\" if it is defined"
|
msgid "the value of the variable \"{0}\" if it is defined"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: src/rougail/output_doc/doc.py:750
|
#: src/rougail/output_doc/doc.py:741
|
||||||
msgid "the value of an undocumented variable"
|
msgid "the value of an undocumented variable"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: src/rougail/output_doc/doc.py:753
|
#: src/rougail/output_doc/doc.py:744
|
||||||
msgid "the values of undocumented variables"
|
msgid "the values of undocumented variables"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: src/rougail/output_doc/doc.py:776
|
#: src/rougail/output_doc/doc.py:767
|
||||||
msgid "(from an undocumented variable)"
|
msgid "(from an undocumented variable)"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: src/rougail/output_doc/doc.py:784
|
#: src/rougail/output_doc/doc.py:775
|
||||||
msgid "{0} (from an undocumented variable)"
|
msgid "{0} (from an undocumented variable)"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: src/rougail/output_doc/doc.py:788 src/rougail/output_doc/doc.py:840
|
#: src/rougail/output_doc/doc.py:779 src/rougail/output_doc/doc.py:831
|
||||||
msgid "depends on an undocumented variable"
|
msgid "depends on an undocumented variable"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: src/rougail/output_doc/doc.py:862
|
#: src/rougail/output_doc/doc.py:853
|
||||||
msgid "when the variable \"{{0}}\" is defined, accessible and hasn't the value \"{0}\""
|
msgid "when the variable \"{{0}}\" is defined, accessible and hasn't the value \"{0}\""
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: src/rougail/output_doc/doc.py:866
|
#: src/rougail/output_doc/doc.py:857
|
||||||
msgid "when the variable \"{{0}}\" is defined and hasn't the value \"{0}\""
|
msgid "when the variable \"{{0}}\" is defined and hasn't the value \"{0}\""
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: src/rougail/output_doc/doc.py:870
|
#: src/rougail/output_doc/doc.py:861
|
||||||
msgid "when the variable \"{{0}}\" is accessible and hasn't the value \"{0}\""
|
msgid "when the variable \"{{0}}\" is accessible and hasn't the value \"{0}\""
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: src/rougail/output_doc/doc.py:872
|
#: src/rougail/output_doc/doc.py:863
|
||||||
msgid "when the variable \"{{0}}\" hasn't the value \"{0}\""
|
msgid "when the variable \"{{0}}\" hasn't the value \"{0}\""
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: src/rougail/output_doc/doc.py:876
|
#: src/rougail/output_doc/doc.py:867
|
||||||
msgid "when the variable \"{{0}}\" is defined, is accessible and has the value \"{0}\""
|
msgid "when the variable \"{{0}}\" is defined, is accessible and has the value \"{0}\""
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: src/rougail/output_doc/doc.py:880
|
#: src/rougail/output_doc/doc.py:871
|
||||||
msgid "when the variable \"{{0}}\" is defined and has the value \"{0}\""
|
msgid "when the variable \"{{0}}\" is defined and has the value \"{0}\""
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: src/rougail/output_doc/doc.py:884
|
#: src/rougail/output_doc/doc.py:875
|
||||||
msgid "when the variable \"{{0}}\" is accessible and has the value \"{0}\""
|
msgid "when the variable \"{{0}}\" is accessible and has the value \"{0}\""
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: src/rougail/output_doc/doc.py:886
|
#: src/rougail/output_doc/doc.py:877
|
||||||
msgid "when the variable \"{{0}}\" has the value \"{0}\""
|
msgid "when the variable \"{{0}}\" has the value \"{0}\""
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
|
|
@ -311,142 +340,56 @@ msgstr ""
|
||||||
msgid "Example with all variables modifiable"
|
msgid "Example with all variables modifiable"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: src/rougail/output_doc/output/asciidoc.py:152
|
#: src/rougail/output_doc/output/asciidoc.py:156
|
||||||
#: src/rougail/output_doc/output/console.py:189
|
#: src/rougail/output_doc/output/console.py:199
|
||||||
#: src/rougail/output_doc/output/github.py:188
|
#: src/rougail/output_doc/output/github.py:196
|
||||||
#: src/rougail/output_doc/output/gitlab.py:44
|
#: src/rougail/output_doc/output/gitlab.py:44
|
||||||
msgid "Informations"
|
msgid "Informations"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: src/rougail/output_doc/output/console.py:182
|
#: src/rougail/output_doc/tabular/five_columns.py:59
|
||||||
#: src/rougail/output_doc/utils.py:896
|
msgid "Access control"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#: src/rougail/output_doc/tabular/four_columns.py:53
|
||||||
|
msgid "Type"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#: src/rougail/output_doc/tabular/three_columns.py:46
|
||||||
|
msgid "Default value"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#: src/rougail/output_doc/tabular/two_columns.py:45
|
||||||
msgid "Variable"
|
msgid "Variable"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: src/rougail/output_doc/output/console.py:183
|
#: src/rougail/output_doc/tabular/two_columns.py:47
|
||||||
#: src/rougail/output_doc/utils.py:896
|
|
||||||
msgid "Description"
|
msgid "Description"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: src/rougail/output_doc/utils.py:48
|
#: src/rougail/output_doc/utils.py:152
|
||||||
msgid "the domain name can starts by a dot"
|
|
||||||
msgstr ""
|
|
||||||
|
|
||||||
#: src/rougail/output_doc/utils.py:49
|
|
||||||
msgid "the domain name can be a hostname"
|
|
||||||
msgstr ""
|
|
||||||
|
|
||||||
#: src/rougail/output_doc/utils.py:50
|
|
||||||
msgid "the domain name can be an IP"
|
|
||||||
msgstr ""
|
|
||||||
|
|
||||||
#: src/rougail/output_doc/utils.py:51
|
|
||||||
msgid "the domain name can be network in CIDR format"
|
|
||||||
msgstr ""
|
|
||||||
|
|
||||||
#: src/rougail/output_doc/utils.py:56 src/rougail/output_doc/utils.py:62
|
|
||||||
msgid "the minimum value is {0}"
|
|
||||||
msgstr ""
|
|
||||||
|
|
||||||
#: src/rougail/output_doc/utils.py:57 src/rougail/output_doc/utils.py:63
|
|
||||||
msgid "the maximum value is {0}"
|
|
||||||
msgstr ""
|
|
||||||
|
|
||||||
#: src/rougail/output_doc/utils.py:69
|
|
||||||
msgid "IP must be in CIDR format"
|
|
||||||
msgstr ""
|
|
||||||
|
|
||||||
#: src/rougail/output_doc/utils.py:70
|
|
||||||
msgid "private IP are allowed"
|
|
||||||
msgstr ""
|
|
||||||
|
|
||||||
#: src/rougail/output_doc/utils.py:71
|
|
||||||
msgid "reserved IP are allowed"
|
|
||||||
msgstr ""
|
|
||||||
|
|
||||||
#: src/rougail/output_doc/utils.py:76
|
|
||||||
msgid "network must be in CIDR format"
|
|
||||||
msgstr ""
|
|
||||||
|
|
||||||
#: src/rougail/output_doc/utils.py:81
|
|
||||||
msgid "the host name can be an IP"
|
|
||||||
msgstr ""
|
|
||||||
|
|
||||||
#: src/rougail/output_doc/utils.py:86
|
|
||||||
msgid "the domain name in web address can be an IP"
|
|
||||||
msgstr ""
|
|
||||||
|
|
||||||
#: src/rougail/output_doc/utils.py:87
|
|
||||||
msgid "the domain name in web address can be only a hostname"
|
|
||||||
msgstr ""
|
|
||||||
|
|
||||||
#: src/rougail/output_doc/utils.py:94
|
|
||||||
msgid "can be range of port"
|
|
||||||
msgstr ""
|
|
||||||
|
|
||||||
#: src/rougail/output_doc/utils.py:95
|
|
||||||
msgid "can have the protocol"
|
|
||||||
msgstr ""
|
|
||||||
|
|
||||||
#: src/rougail/output_doc/utils.py:96
|
|
||||||
msgid "port 0 is allowed"
|
|
||||||
msgstr ""
|
|
||||||
|
|
||||||
#: src/rougail/output_doc/utils.py:97
|
|
||||||
msgid "well-known ports (1 to 1023) are allowed"
|
|
||||||
msgstr ""
|
|
||||||
|
|
||||||
#: src/rougail/output_doc/utils.py:98
|
|
||||||
msgid "registred ports (1024 to 49151) are allowed"
|
|
||||||
msgstr ""
|
|
||||||
|
|
||||||
#: src/rougail/output_doc/utils.py:99
|
|
||||||
msgid "private ports (greater than 49152) are allowed"
|
|
||||||
msgstr ""
|
|
||||||
|
|
||||||
#: src/rougail/output_doc/utils.py:104
|
|
||||||
msgid "minimum length for the secret is {0} characters"
|
|
||||||
msgstr ""
|
|
||||||
|
|
||||||
#: src/rougail/output_doc/utils.py:105
|
|
||||||
msgid "maximum length for the secret is {0} characters"
|
|
||||||
msgstr ""
|
|
||||||
|
|
||||||
#: src/rougail/output_doc/utils.py:106
|
|
||||||
msgid "forbidden characters: {0}"
|
|
||||||
msgstr ""
|
|
||||||
|
|
||||||
#: src/rougail/output_doc/utils.py:111
|
|
||||||
msgid "this filename could be a relative path"
|
|
||||||
msgstr ""
|
|
||||||
|
|
||||||
#: src/rougail/output_doc/utils.py:112
|
|
||||||
msgid "this file must exists"
|
|
||||||
msgstr ""
|
|
||||||
|
|
||||||
#: src/rougail/output_doc/utils.py:113
|
|
||||||
msgid "file type allowed: {0}"
|
|
||||||
msgstr ""
|
|
||||||
|
|
||||||
#: src/rougail/output_doc/utils.py:432
|
|
||||||
msgid "Identifiers"
|
|
||||||
msgstr ""
|
|
||||||
|
|
||||||
#: src/rougail/output_doc/utils.py:578
|
|
||||||
msgid "Command line"
|
msgid "Command line"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: src/rougail/output_doc/utils.py:581
|
#: src/rougail/output_doc/utils.py:159
|
||||||
msgid "Environment variable"
|
msgid "Environment variable"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: src/rougail/output_doc/utils.py:762 src/rougail/output_doc/utils.py:771
|
#: src/rougail/output_doc/utils.py:458
|
||||||
#: src/rougail/output_doc/utils.py:777 src/rougail/output_doc/utils.py:783
|
msgid "Path"
|
||||||
#: src/rougail/output_doc/utils.py:787
|
msgstr ""
|
||||||
|
|
||||||
|
#: src/rougail/output_doc/utils.py:468
|
||||||
|
msgid "Identifiers"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#: src/rougail/output_doc/utils.py:684 src/rougail/output_doc/utils.py:693
|
||||||
|
#: src/rougail/output_doc/utils.py:699 src/rougail/output_doc/utils.py:705
|
||||||
|
#: src/rougail/output_doc/utils.py:709
|
||||||
msgid "(default)"
|
msgid "(default)"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: src/rougail/output_doc/utils.py:973
|
#: src/rougail/output_doc/utils.py:960
|
||||||
msgid "{0}: {1}"
|
msgid "{0}: {1}"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -53,8 +53,8 @@ class Annotator(Walk):
|
||||||
if not objectspace.paths:
|
if not objectspace.paths:
|
||||||
return
|
return
|
||||||
self.objectspace = objectspace
|
self.objectspace = objectspace
|
||||||
self.change_default_value = self.objectspace.rougailconfig[
|
self.default_values = self.objectspace.rougailconfig[
|
||||||
"doc.change_default_value"
|
"doc.default_values"
|
||||||
]
|
]
|
||||||
self.regexp_description_get_paths = None
|
self.regexp_description_get_paths = None
|
||||||
self.populate_family()
|
self.populate_family()
|
||||||
|
|
@ -81,7 +81,7 @@ class Annotator(Walk):
|
||||||
)
|
)
|
||||||
|
|
||||||
def force_default_value_in_suffix_variable(self, family) -> None:
|
def force_default_value_in_suffix_variable(self, family) -> None:
|
||||||
if not self.change_default_value:
|
if not self.default_values:
|
||||||
return
|
return
|
||||||
if not isinstance(family.dynamic, list):
|
if not isinstance(family.dynamic, list):
|
||||||
self._force_default_value_in_suffix_variable(family, family.dynamic)
|
self._force_default_value_in_suffix_variable(family, family.dynamic)
|
||||||
|
|
@ -164,7 +164,7 @@ class Annotator(Walk):
|
||||||
variable.version,
|
variable.version,
|
||||||
)
|
)
|
||||||
if (
|
if (
|
||||||
self.change_default_value
|
self.default_values
|
||||||
and path in self.objectspace.leaders
|
and path in self.objectspace.leaders
|
||||||
and not default
|
and not default
|
||||||
):
|
):
|
||||||
|
|
|
||||||
|
|
@ -29,7 +29,7 @@ class Changelog: # pylint: disable=no-member,too-few-public-methods
|
||||||
def gen_doc_changelog(self):
|
def gen_doc_changelog(self):
|
||||||
"""Return changelog"""
|
"""Return changelog"""
|
||||||
self.level = self.rougailconfig["doc.title_level"]
|
self.level = self.rougailconfig["doc.title_level"]
|
||||||
self.previous_json_file = self.rougailconfig["doc.previous_json_file"]
|
self.previous_json_file = self.rougailconfig["doc.changelog.previous_json_file"]
|
||||||
with Path(self.previous_json_file).open() as outfh:
|
with Path(self.previous_json_file).open() as outfh:
|
||||||
previous_doc = loads(outfh.read())
|
previous_doc = loads(outfh.read())
|
||||||
self.load()
|
self.load()
|
||||||
|
|
@ -52,12 +52,6 @@ class Changelog: # pylint: disable=no-member,too-few-public-methods
|
||||||
return self.display()
|
return self.display()
|
||||||
|
|
||||||
def parser(self, previous_families, new_families):
|
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 = []
|
done = []
|
||||||
for element in list(previous_families) + list(new_families):
|
for element in list(previous_families) + list(new_families):
|
||||||
if element in done:
|
if element in done:
|
||||||
|
|
@ -67,28 +61,28 @@ class Changelog: # pylint: disable=no-member,too-few-public-methods
|
||||||
new = new_families.get(element)
|
new = new_families.get(element)
|
||||||
if not previous:
|
if not previous:
|
||||||
if new["type"] == "variable":
|
if new["type"] == "variable":
|
||||||
add(new)
|
self._added_variables.append(new)
|
||||||
else:
|
else:
|
||||||
self.parser({}, new["children"])
|
self.parser({}, new["children"])
|
||||||
elif not new:
|
elif not new:
|
||||||
if previous["type"] == "variable":
|
if previous["type"] == "variable":
|
||||||
if "identifiers" in previous:
|
if "identifiers" in previous:
|
||||||
for identifiers in previous["identifiers"]:
|
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:
|
else:
|
||||||
remove(calc_path(previous["path"], self.formatter))
|
self._removed_variables.append(calc_path(previous["path"], self.formatter))
|
||||||
else:
|
else:
|
||||||
self.parser(previous["children"], {})
|
self.parser(previous["children"], {})
|
||||||
elif previous["type"] != new["type"]:
|
elif previous["type"] != new["type"]:
|
||||||
if previous["type"] == "variable":
|
if previous["type"] == "variable":
|
||||||
if "identifiers" in previous:
|
if "identifiers" in previous:
|
||||||
for identifiers in previous["identifiers"]:
|
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:
|
else:
|
||||||
remove(calc_path(previous["path"], self.formatter))
|
self._removed_variables.append(calc_path(previous["path"], self.formatter))
|
||||||
self.parser({}, new["children"])
|
self.parser({}, new["children"])
|
||||||
else:
|
else:
|
||||||
add(new)
|
self._added_variables.append(new)
|
||||||
self.parser(previous["children"], {})
|
self.parser(previous["children"], {})
|
||||||
elif previous["type"] != "variable":
|
elif previous["type"] != "variable":
|
||||||
self.parser(previous["children"], new["children"])
|
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)
|
modified_attributes[prop] = (name, prop_previous, prop_new)
|
||||||
if not modified_attributes:
|
if not modified_attributes:
|
||||||
continue
|
continue
|
||||||
self.formatter.variable_to_string(
|
self._modified_variables.append((new, modified_attributes))
|
||||||
new, self._modified_variables, modified_attributes
|
|
||||||
)
|
|
||||||
|
|
||||||
def display(self) -> str:
|
def display(self) -> str:
|
||||||
msg = ""
|
msg = ""
|
||||||
|
|
@ -155,10 +147,12 @@ class Changelog: # pylint: disable=no-member,too-few-public-methods
|
||||||
title = _("New variable")
|
title = _("New variable")
|
||||||
else:
|
else:
|
||||||
title = _("New variables")
|
title = _("New variables")
|
||||||
|
for add in self._added_variables:
|
||||||
|
self.formatter.variable_to_string(add)
|
||||||
msg += self.formatter._run(
|
msg += self.formatter._run(
|
||||||
[
|
[
|
||||||
self.formatter.title(title, self.level),
|
self.formatter.title(title, self.level),
|
||||||
self.formatter.table(self._added_variables),
|
self.formatter.tabular(),
|
||||||
self.formatter.end_family(self.level)
|
self.formatter.end_family(self.level)
|
||||||
],
|
],
|
||||||
self.level,
|
self.level,
|
||||||
|
|
@ -169,10 +163,12 @@ class Changelog: # pylint: disable=no-member,too-few-public-methods
|
||||||
title = _("Modified variable")
|
title = _("Modified variable")
|
||||||
else:
|
else:
|
||||||
title = _("Modified variables")
|
title = _("Modified variables")
|
||||||
|
for mod, modified_attributes in self._modified_variables:
|
||||||
|
self.formatter.variable_to_string(mod, modified_attributes)
|
||||||
msg += self.formatter._run(
|
msg += self.formatter._run(
|
||||||
[
|
[
|
||||||
self.formatter.title(title, self.level),
|
self.formatter.title(title, self.level),
|
||||||
self.formatter.table(self._modified_variables),
|
self.formatter.tabular(),
|
||||||
self.formatter.end_family(self.level)
|
self.formatter.end_family(self.level)
|
||||||
],
|
],
|
||||||
self.level,
|
self.level,
|
||||||
|
|
@ -186,7 +182,7 @@ class Changelog: # pylint: disable=no-member,too-few-public-methods
|
||||||
msg += self.formatter._run(
|
msg += self.formatter._run(
|
||||||
[
|
[
|
||||||
self.formatter.title(title, self.level),
|
self.formatter.title(title, self.level),
|
||||||
self.formatter.list(self._removed_variables, inside_table=False),
|
self.formatter.list(self._removed_variables, inside_tabular=False),
|
||||||
self.formatter.end_family(self.level)
|
self.formatter.end_family(self.level)
|
||||||
],
|
],
|
||||||
self.level,
|
self.level,
|
||||||
|
|
|
||||||
|
|
@ -21,28 +21,48 @@ from rougail.utils import load_modules
|
||||||
from .i18n import _
|
from .i18n import _
|
||||||
|
|
||||||
|
|
||||||
|
ROUGAIL_VARIABLE_TYPE = (
|
||||||
|
"https://rougail.readthedocs.io/en/latest/variable.html#variables-types"
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
OUTPUTS = None
|
OUTPUTS = None
|
||||||
|
TABULARS = None
|
||||||
|
|
||||||
|
|
||||||
def get_outputs() -> None:
|
def get_outputs_or_tabulars(type_) -> None:
|
||||||
"""Load all outputs"""
|
"""Load all outputs or tabulars"""
|
||||||
module_name = "rougail.output_doc.output"
|
module_name = f"rougail.output_doc.{type_}"
|
||||||
outputs = {}
|
outputs = {}
|
||||||
for path in (Path(__file__).parent / "output").iterdir():
|
names = []
|
||||||
|
for path in (Path(__file__).parent / type_).iterdir():
|
||||||
name = path.name
|
name = path.name
|
||||||
if not name.endswith(".py") or name.endswith("__.py"):
|
if not name.endswith(".py") or name.endswith("__.py"):
|
||||||
continue
|
continue
|
||||||
module = load_modules(module_name + "." + name[:-3], str(path))
|
module = load_modules(module_name + "." + name[:-3], str(path))
|
||||||
if "Formatter" not in dir(module):
|
if type_ == "output":
|
||||||
continue
|
if "Formatter" not in dir(module):
|
||||||
level = module.Formatter.level
|
continue
|
||||||
|
obj_class = module.Formatter
|
||||||
|
elif type_ == "tabular":
|
||||||
|
if "Tabular" not in dir(module):
|
||||||
|
continue
|
||||||
|
obj_class = module.Tabular
|
||||||
|
level = obj_class.level
|
||||||
if level in outputs:
|
if level in outputs:
|
||||||
raise ImportError(
|
raise ImportError(
|
||||||
_('duplicated level rougail-doc for output "{0}": {1} and {2}').format(
|
_('duplicated level rougail-output-doc for {0} "{1}": {2} and {3}').format(
|
||||||
level, module.Formatter.name, outputs[level].name
|
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)}
|
return {outputs[level].name: outputs[level] for level in sorted(outputs)}
|
||||||
|
|
||||||
|
|
||||||
|
|
@ -54,13 +74,28 @@ class OutPuts: # pylint: disable=R0903
|
||||||
) -> None:
|
) -> None:
|
||||||
global OUTPUTS
|
global OUTPUTS
|
||||||
if OUTPUTS is None:
|
if OUTPUTS is None:
|
||||||
OUTPUTS = get_outputs()
|
OUTPUTS = get_outputs_or_tabulars("output")
|
||||||
|
|
||||||
def get(self) -> dict:
|
def get(self) -> dict:
|
||||||
"""Get all outputs"""
|
"""Get all outputs"""
|
||||||
return OUTPUTS
|
return OUTPUTS
|
||||||
|
|
||||||
|
|
||||||
|
class Tabulars: # pylint: disable=R0903
|
||||||
|
"""Transformations applied on a object instance"""
|
||||||
|
|
||||||
|
def __init__(
|
||||||
|
self,
|
||||||
|
) -> None:
|
||||||
|
global TABULARS
|
||||||
|
if TABULARS is None:
|
||||||
|
TABULARS = get_outputs_or_tabulars("tabular")
|
||||||
|
|
||||||
|
def get(self) -> dict:
|
||||||
|
"""Get all tabulars"""
|
||||||
|
return TABULARS
|
||||||
|
|
||||||
|
|
||||||
def get_rougail_config(
|
def get_rougail_config(
|
||||||
*,
|
*,
|
||||||
backward_compatibility=True, # pylint: disable=unused-argument
|
backward_compatibility=True, # pylint: disable=unused-argument
|
||||||
|
|
@ -68,95 +103,110 @@ def get_rougail_config(
|
||||||
"""Get documentation for output_doc modules"""
|
"""Get documentation for output_doc modules"""
|
||||||
outputs = list(OutPuts().get())
|
outputs = list(OutPuts().get())
|
||||||
output_format_default = outputs[0]
|
output_format_default = outputs[0]
|
||||||
|
tabulars = list(Tabulars().get())
|
||||||
|
tabular_default = tabulars[0]
|
||||||
rougail_options = f"""
|
rougail_options = f"""
|
||||||
|
cli:
|
||||||
|
|
||||||
|
read_write:
|
||||||
|
redefine: true
|
||||||
|
exists: true
|
||||||
|
default:
|
||||||
|
jinja: |-
|
||||||
|
{{% if __.step.output is not propertyerror and "doc" in __.step.output %}}
|
||||||
|
true
|
||||||
|
{{% else %}}
|
||||||
|
false
|
||||||
|
{{% endif %}}
|
||||||
|
|
||||||
doc:
|
doc:
|
||||||
description: {_('Generate documentation')}
|
description: {_('Generate documentation from structural files')}
|
||||||
|
help: {_('The structural files contain all the information related to the variables. This output generates the documentation for all or some of these variables.')}
|
||||||
disabled:
|
disabled:
|
||||||
jinja: |
|
jinja: |-
|
||||||
{{% if step.output is propertyerror or step.output != 'doc' %}}
|
{{% if step.output is propertyerror or step.output != 'doc' %}}
|
||||||
disabled
|
true
|
||||||
|
{{% else %}}
|
||||||
|
false
|
||||||
{{% endif %}}
|
{{% endif %}}
|
||||||
description: {_('when "doc" is not set in "step.output"')}
|
return_type: boolean
|
||||||
|
description: {_('if doc is not set in "step.output"')}
|
||||||
title_level:
|
|
||||||
description: {_('Starting title level')}
|
|
||||||
alternative_name: dt
|
|
||||||
default: 1
|
|
||||||
|
|
||||||
|
output_format:
|
||||||
|
description: {_('The output format of the generated documentation')}
|
||||||
|
alternative_name: do
|
||||||
|
default: { output_format_default }
|
||||||
|
choices:
|
||||||
|
"""
|
||||||
|
for output in outputs:
|
||||||
|
rougail_options += f" - {output}\n"
|
||||||
|
rougail_options += f"""
|
||||||
|
tabular_template:
|
||||||
|
description: {_('Generate document with this tabular model')}
|
||||||
|
help: {_("The variables are documented with a tabular view. A template selection allows you to choose the content of each column.")}
|
||||||
|
alternative_name: dm
|
||||||
|
default: { tabular_default }
|
||||||
|
disabled:
|
||||||
|
jinja: |-
|
||||||
|
{{{{ _.output_format == 'json' }}}}
|
||||||
|
return_type: boolean
|
||||||
|
description: >
|
||||||
|
{_('"_.output_format" in json is not compatible with this variable')}
|
||||||
|
choices:
|
||||||
|
"""
|
||||||
|
for tabular in tabulars:
|
||||||
|
rougail_options += f" - {tabular}\n"
|
||||||
|
rougail_options += f"""
|
||||||
contents:
|
contents:
|
||||||
description: {_('Generated content')}
|
description: {_('Generated content')}
|
||||||
|
help: {_('You can generate three type of document. All variables ("variables"), an example file in YAML format ("example") or change log ("changelog").')}
|
||||||
|
alternative_name: dc
|
||||||
choices:
|
choices:
|
||||||
- variables
|
- variables
|
||||||
- example
|
- example
|
||||||
- changelog
|
- changelog
|
||||||
default:
|
default:
|
||||||
- variables
|
- variables
|
||||||
|
hidden:
|
||||||
previous_json_file:
|
|
||||||
description: {_('Previous description file in JSON format')}
|
|
||||||
disabled:
|
|
||||||
jinja: |-
|
jinja: |-
|
||||||
{{{{ "changelog" not in _.contents }}}}
|
{{{{ _.output_format == 'json' }}}}
|
||||||
return_type: boolean
|
return_type: boolean
|
||||||
description: {_('changelog is not selected in "_.contents"')}
|
description: >
|
||||||
|
{_('"_.output_format" in json is not compatible with changelog or example "_.contents"')}
|
||||||
|
|
||||||
without_family:
|
title_level:
|
||||||
description: {_('Do not add families in documentation')}
|
description: {_('Starting title level')}
|
||||||
|
alternative_name: dt
|
||||||
|
default: 1
|
||||||
|
|
||||||
|
default_values:
|
||||||
|
description: {_('Modify values to document all variables')}
|
||||||
|
help: {_('To document leadership or dynamic family variables, it is sometimes necessary to generate values, which can change the values in the configuration. Be careful if you reuse this configuration.')}
|
||||||
|
default: true
|
||||||
|
|
||||||
|
true_color:
|
||||||
|
description: {_('Display documentation in console always with true color terminal')}
|
||||||
default: false
|
default: false
|
||||||
disabled:
|
disabled:
|
||||||
jinja: |-
|
variable: _.output_format
|
||||||
{{{{ _.output_format == "json" or ("variables" not in _.contents and "changelog" not in _.contents) }}}}
|
when_not: console
|
||||||
return_type: boolean
|
|
||||||
description: {_('if "_.output_format" is json or "_.contents" hasn\'t variable or changelog')}
|
|
||||||
|
|
||||||
root:
|
root:
|
||||||
description: {_('Document the variables from this family')}
|
description: {_('Document the child variables of the family')}
|
||||||
|
help: {_('By default, all accessible variables are included in the documentation. It is possible to define the family from which the documentation should be generated.')}
|
||||||
|
alternative_name: dr
|
||||||
mandatory: false
|
mandatory: false
|
||||||
|
|
||||||
with_commandline:
|
|
||||||
description: {_('Add command line informations in documentation')}
|
|
||||||
default: false
|
|
||||||
disabled:
|
|
||||||
jinja: |-
|
|
||||||
{{{{ _.output_format == "json" or ("variables" not in _.contents and "changelog" not in _.contents) }}}}
|
|
||||||
return_type: boolean
|
|
||||||
description: {_('if "_.output_format" is json or "_.contents" hasn\'t variable or changelog')}
|
|
||||||
|
|
||||||
with_environment:
|
|
||||||
description: {_('Add environment variable informations in documentation')}
|
|
||||||
default: false
|
|
||||||
disabled:
|
|
||||||
jinja: |-
|
|
||||||
{{{{ _.output_format == "json" or ("variables" not in _.contents and "changelog" not in _.contents) }}}}
|
|
||||||
return_type: boolean
|
|
||||||
description: {_('if "_.output_format" is json or "_.contents" hasn\'t variable or changelog')}
|
|
||||||
|
|
||||||
environment_default_environment_name:
|
|
||||||
description: {_("Name of the default environment prefix")}
|
|
||||||
default: ROUGAIL
|
|
||||||
validators:
|
|
||||||
- jinja: |-
|
|
||||||
{{{{ _.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 }}}}
|
|
||||||
return_type: boolean
|
|
||||||
description: {_('when "__.main_namespace" is not set or "_.with_environment" is false')}
|
|
||||||
|
|
||||||
other_root_filenames:
|
other_root_filenames:
|
||||||
description: {_("Families or variables for this family are in an other file name")}
|
description: {_("The variables in this family are documented in another file")}
|
||||||
|
help: {_("If you separate the variables into different files, the links between the variables will break. Therefore, you must define different filenames for the files containing these variables.")}
|
||||||
type: leadership
|
type: leadership
|
||||||
disabled:
|
disabled:
|
||||||
jinja: |-
|
variable: _.root
|
||||||
{{% if not _.root %}}
|
when: null
|
||||||
Documents are not splitted
|
|
||||||
{{% endif %}}
|
|
||||||
description: {_('documentation must be splitted')}
|
|
||||||
|
|
||||||
root_path:
|
root_path:
|
||||||
description: {_("Root family name")}
|
description: {_("This file contains child variables of the family")}
|
||||||
mandatory: false
|
mandatory: false
|
||||||
|
|
||||||
filename:
|
filename:
|
||||||
|
|
@ -164,65 +214,79 @@ doc:
|
||||||
type: unix_filename
|
type: unix_filename
|
||||||
params:
|
params:
|
||||||
allow_relative: true
|
allow_relative: true
|
||||||
|
types:
|
||||||
|
- file
|
||||||
|
|
||||||
disabled_modes:
|
tabulars:
|
||||||
description: {_('Disable documentation for variables with those modes')}
|
description: {_('Variables and changelog documentation')}
|
||||||
multi: true
|
|
||||||
mandatory: false
|
|
||||||
disabled:
|
|
||||||
jinja: |
|
|
||||||
{{% if not modes_level %}}
|
|
||||||
there is no mode
|
|
||||||
{{% endif %}}
|
|
||||||
description: {_('disabled when there is no mode available')}
|
|
||||||
validators:
|
|
||||||
- jinja: |
|
|
||||||
{{% if _.disabled_modes not in modes_level %}}
|
|
||||||
this mode is not available
|
|
||||||
{{% endif %}}
|
|
||||||
description: {_('verify if disable modes already exists')}
|
|
||||||
|
|
||||||
change_default_value: true # {_('Modify values to document leaderships and dynamics families')}
|
|
||||||
|
|
||||||
comment_examples:
|
|
||||||
description: {_('Add description of variables and families when generate examples')}
|
|
||||||
default: false
|
|
||||||
disabled:
|
disabled:
|
||||||
jinja: |-
|
jinja: |-
|
||||||
{{{{ "example" not in _.contents }}}}
|
{{{{ step.output is propertyerror or "doc" not in step.output or _.output_format == "json" or ("variables" not in _.contents and "changelog" not in _.contents) }}}}
|
||||||
return_type: boolean
|
return_type: boolean
|
||||||
description: {_('disabled when example in not in contents')}
|
description: {_('if "_.output_format" is json or "_.contents" hasn\'t variables or changelog')}
|
||||||
|
|
||||||
comment_examples_column:
|
without_family:
|
||||||
description: {_('Comment in examples starts at column')}
|
description: {_('Do not add families in documentation')}
|
||||||
default: 30
|
|
||||||
disabled:
|
|
||||||
variable: _.comment_examples
|
|
||||||
propertyerror: false
|
|
||||||
when: false
|
|
||||||
|
|
||||||
output_format:
|
|
||||||
description: {_('Generate document in format')}
|
|
||||||
alternative_name: do
|
|
||||||
default: output_format_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:
|
|
||||||
""".replace(
|
|
||||||
"output_format_default", output_format_default
|
|
||||||
)
|
|
||||||
for output in outputs:
|
|
||||||
rougail_options += f" - {output}\n"
|
|
||||||
rougail_options += f"""
|
|
||||||
force_true_color_terminal:
|
|
||||||
description: {_('Force true color terminal')}
|
|
||||||
default: false
|
default: false
|
||||||
|
alternative_name: df
|
||||||
|
|
||||||
|
with_commandline:
|
||||||
|
description: {_('Add command line informations in documentation')}
|
||||||
|
alternative_name: dw
|
||||||
|
default: false
|
||||||
|
|
||||||
|
with_environment:
|
||||||
|
description: {_('Add environment variable informations in documentation')}
|
||||||
|
alternative_name: de
|
||||||
|
default: false
|
||||||
|
|
||||||
|
environment_prefix:
|
||||||
|
description: {_("Environment variables prefix name")}
|
||||||
|
alternative_name: dv
|
||||||
|
default: ROUGAIL
|
||||||
|
validators:
|
||||||
|
- jinja: |-
|
||||||
|
{{{{ (_.environment_prefix | upper) != _.environment_prefix }}}}
|
||||||
|
return_type: boolean
|
||||||
|
description: {_("should only use uppercase characters")}
|
||||||
|
disabled:
|
||||||
|
jinja: |-
|
||||||
|
{{{{ ___.main_namespace is not defined or ___.main_namespace == none or _.with_environment is false }}}}
|
||||||
|
return_type: boolean
|
||||||
|
description: {_('if "main_namespace" is not set or "_.with_environment" is false')}
|
||||||
|
|
||||||
|
changelog:
|
||||||
|
description: {_('Changelog documentation')}
|
||||||
|
disabled:
|
||||||
|
jinja: |-
|
||||||
|
{{{{ step.output is propertyerror or "doc" not in step.output or _.output_format == "json" or "changelog" not in _.contents }}}}
|
||||||
|
return_type: boolean
|
||||||
|
description: {_('if changelog in not in "_.contents"')}
|
||||||
|
|
||||||
|
previous_json_file:
|
||||||
|
description: {_('Previous description file in JSON format')}
|
||||||
|
help: {_('To generate the changelog, you need to compare the old list of variables (in json format) with the current variables.')}
|
||||||
|
alternative_name: dp
|
||||||
|
|
||||||
|
examples:
|
||||||
|
description: {_('Examples configuration')}
|
||||||
|
disabled:
|
||||||
|
jinja: |-
|
||||||
|
{{{{ step.output is propertyerror or "doc" not in step.output or "example" not in _.contents }}}}
|
||||||
|
return_type: boolean
|
||||||
|
description: {_('if example is not in "_.contents"')}
|
||||||
|
|
||||||
|
comment:
|
||||||
|
description: {_('Add description of variables and families when generate examples')}
|
||||||
|
alternative_name: dx
|
||||||
|
default: false
|
||||||
|
|
||||||
|
comment_column:
|
||||||
|
description: {_('Comment in examples starts at column')}
|
||||||
|
default: 30
|
||||||
|
disabled:
|
||||||
|
variable: _.comment
|
||||||
|
when: false
|
||||||
"""
|
"""
|
||||||
return {
|
return {
|
||||||
"name": "doc",
|
"name": "doc",
|
||||||
|
|
@ -232,5 +296,4 @@ doc:
|
||||||
"level": 50,
|
"level": 50,
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
__all__ = ("OutPuts", "get_rougail_config")
|
__all__ = ("OutPuts", "get_rougail_config")
|
||||||
|
|
|
||||||
|
|
@ -67,16 +67,15 @@ class RougailOutputDoc(Examples, Changelog):
|
||||||
self.outputs = OutPuts().get()
|
self.outputs = OutPuts().get()
|
||||||
self.conf = config
|
self.conf = config
|
||||||
self.modes_level = rougailconfig["modes_level"]
|
self.modes_level = rougailconfig["modes_level"]
|
||||||
|
self.disabled_modes = []
|
||||||
if self.modes_level:
|
if self.modes_level:
|
||||||
self.disabled_modes = rougailconfig["doc.disabled_modes"]
|
for mode in self.modes_level:
|
||||||
if self.disabled_modes:
|
for prop in self.conf.property.get():
|
||||||
self.conf.property.setdefault(
|
if mode != prop:
|
||||||
frozenset(self.disabled_modes), "read_write", "append"
|
continue
|
||||||
)
|
self.disabled_modes.append(prop)
|
||||||
else:
|
# self.conf.property.read_write()
|
||||||
self.disabled_modes = []
|
# # self.conf.property.remove("cache")
|
||||||
self.conf.property.read_write()
|
|
||||||
# self.conf.property.remove("cache")
|
|
||||||
self.rougailconfig = rougailconfig
|
self.rougailconfig = rougailconfig
|
||||||
self.informations = None
|
self.informations = None
|
||||||
try:
|
try:
|
||||||
|
|
@ -363,12 +362,7 @@ class RougailOutputDoc(Examples, Changelog):
|
||||||
else:
|
else:
|
||||||
multi = False
|
multi = False
|
||||||
if multi:
|
if multi:
|
||||||
informations["properties"].append(
|
informations["multiple"] = True
|
||||||
{
|
|
||||||
"type": "multiple",
|
|
||||||
"name": _("multiple"),
|
|
||||||
}
|
|
||||||
)
|
|
||||||
examples = variable.information.get("examples", None)
|
examples = variable.information.get("examples", None)
|
||||||
if examples is None:
|
if examples is None:
|
||||||
examples = variable.information.get("test", None)
|
examples = variable.information.get("test", None)
|
||||||
|
|
@ -451,6 +445,12 @@ class RougailOutputDoc(Examples, Changelog):
|
||||||
informations["properties"].extend(properties)
|
informations["properties"].extend(properties)
|
||||||
else:
|
else:
|
||||||
informations["properties"] = properties
|
informations["properties"] = properties
|
||||||
|
properties = child.property.get(uncalculated=True)
|
||||||
|
for mode in self.modes_level:
|
||||||
|
if mode not in properties:
|
||||||
|
continue
|
||||||
|
informations["mode"] = mode
|
||||||
|
break
|
||||||
return True
|
return True
|
||||||
|
|
||||||
def _convert_description(self, description, type_, its_a_path=False):
|
def _convert_description(self, description, type_, its_a_path=False):
|
||||||
|
|
@ -474,11 +474,9 @@ class RougailOutputDoc(Examples, Changelog):
|
||||||
if example is not None:
|
if example is not None:
|
||||||
if isinstance(example, tuple):
|
if isinstance(example, tuple):
|
||||||
example = list(example)
|
example = list(example)
|
||||||
for prop in informations["properties"]:
|
if informations.get("multiple"):
|
||||||
if prop["type"] == "multiple":
|
if not isinstance(example, list):
|
||||||
if not isinstance(example, list):
|
example = [example]
|
||||||
example = [example]
|
|
||||||
break
|
|
||||||
else:
|
else:
|
||||||
if isinstance(example, list):
|
if isinstance(example, list):
|
||||||
index = variable.index()
|
index = variable.index()
|
||||||
|
|
@ -497,25 +495,19 @@ class RougailOutputDoc(Examples, Changelog):
|
||||||
example = default
|
example = default
|
||||||
else:
|
else:
|
||||||
example = self.get_type_default_value(
|
example = self.get_type_default_value(
|
||||||
variable, informations["properties"]
|
variable, informations
|
||||||
)
|
)
|
||||||
if leader is not None and variable.isfollower():
|
if leader is not None and variable.isfollower():
|
||||||
example = [example] + [undefined] * (len(leader["gen_examples"][-1]) - 1)
|
example = [example] + [undefined] * (len(leader["gen_examples"][-1]) - 1)
|
||||||
return example
|
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 = self.convert_option.get(variable.information.get("type"), {}).get(
|
||||||
"example", None
|
"example", None
|
||||||
)
|
)
|
||||||
if example is None:
|
if example is None:
|
||||||
example = "xxx"
|
example = "xxx"
|
||||||
for prop in properties:
|
if informations.get("multiple"):
|
||||||
if prop["type"] == "multiple":
|
|
||||||
multi = True
|
|
||||||
break
|
|
||||||
else:
|
|
||||||
multi = False
|
|
||||||
if multi:
|
|
||||||
example = [example]
|
example = [example]
|
||||||
return example
|
return example
|
||||||
|
|
||||||
|
|
@ -526,12 +518,7 @@ class RougailOutputDoc(Examples, Changelog):
|
||||||
):
|
):
|
||||||
variable_type = child.information.get("type")
|
variable_type = child.information.get("type")
|
||||||
doc_type = self.convert_option.get(variable_type, {"params": {}})
|
doc_type = self.convert_option.get(variable_type, {"params": {}})
|
||||||
informations["properties"] = [
|
informations["variable_type"] = doc_type.get("msg", variable_type)
|
||||||
{
|
|
||||||
"type": "type",
|
|
||||||
"name": doc_type.get("msg", variable_type),
|
|
||||||
}
|
|
||||||
]
|
|
||||||
# extra parameters for types
|
# extra parameters for types
|
||||||
option = child.get()
|
option = child.get()
|
||||||
validators = []
|
validators = []
|
||||||
|
|
@ -561,7 +548,7 @@ class RougailOutputDoc(Examples, Changelog):
|
||||||
)
|
)
|
||||||
)
|
)
|
||||||
break
|
break
|
||||||
if child.information.get("type") == "regexp":
|
if variable_type == "regexp":
|
||||||
validators.append(
|
validators.append(
|
||||||
_('text based with regular expressions "{0}"').format(child.pattern())
|
_('text based with regular expressions "{0}"').format(child.pattern())
|
||||||
)
|
)
|
||||||
|
|
@ -572,7 +559,7 @@ class RougailOutputDoc(Examples, Changelog):
|
||||||
else:
|
else:
|
||||||
key = _("Validators")
|
key = _("Validators")
|
||||||
informations["validators"] = {"name": key, "values": 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)
|
choices = self._to_string(child, "choice", do_not_raise=True)
|
||||||
if choices is None:
|
if choices is None:
|
||||||
choices = child.value.list()
|
choices = child.value.list()
|
||||||
|
|
@ -588,16 +575,6 @@ class RougailOutputDoc(Examples, Changelog):
|
||||||
):
|
):
|
||||||
informations = []
|
informations = []
|
||||||
properties = child.property.get(uncalculated=True)
|
properties = child.property.get(uncalculated=True)
|
||||||
for mode in self.modes_level:
|
|
||||||
if mode not in properties:
|
|
||||||
continue
|
|
||||||
informations.append(
|
|
||||||
{
|
|
||||||
"type": "mode",
|
|
||||||
"name": mode,
|
|
||||||
}
|
|
||||||
)
|
|
||||||
break
|
|
||||||
for prop, translated_prop in self.property_to_string:
|
for prop, translated_prop in self.property_to_string:
|
||||||
if "not_for_commandline" in properties:
|
if "not_for_commandline" in properties:
|
||||||
child_informations["not_for_commandline"] = True
|
child_informations["not_for_commandline"] = True
|
||||||
|
|
@ -606,6 +583,8 @@ class RougailOutputDoc(Examples, Changelog):
|
||||||
prop_obj = {
|
prop_obj = {
|
||||||
"type": "property",
|
"type": "property",
|
||||||
"name": translated_prop,
|
"name": translated_prop,
|
||||||
|
"ori_name": prop,
|
||||||
|
"access_control": prop in HIDDEN_PROPERTIES,
|
||||||
}
|
}
|
||||||
elif child.information.get(f"{prop}_calculation", False):
|
elif child.information.get(f"{prop}_calculation", False):
|
||||||
annotation = self._to_string(child, prop)
|
annotation = self._to_string(child, prop)
|
||||||
|
|
@ -617,11 +596,15 @@ class RougailOutputDoc(Examples, Changelog):
|
||||||
prop_obj = {
|
prop_obj = {
|
||||||
"type": "property",
|
"type": "property",
|
||||||
"name": translated_prop,
|
"name": translated_prop,
|
||||||
|
"ori_name": prop,
|
||||||
|
"access_control": prop in HIDDEN_PROPERTIES,
|
||||||
}
|
}
|
||||||
else:
|
else:
|
||||||
prop_obj = {
|
prop_obj = {
|
||||||
"type": "property",
|
"type": "property",
|
||||||
"name": translated_prop,
|
"name": translated_prop,
|
||||||
|
"ori_name": prop,
|
||||||
|
"access_control": prop in HIDDEN_PROPERTIES,
|
||||||
"annotation": annotation,
|
"annotation": annotation,
|
||||||
}
|
}
|
||||||
else:
|
else:
|
||||||
|
|
@ -764,10 +747,10 @@ class RougailOutputDoc(Examples, Changelog):
|
||||||
else:
|
else:
|
||||||
# FIXME A MUTUALISER AUSSI
|
# FIXME A MUTUALISER AUSSI
|
||||||
variable_path = calculation["ori_path"]
|
variable_path = calculation["ori_path"]
|
||||||
variable = self.conf.forcepermissive.option(variable_path)
|
variable = self.conf.unrestraint.option(variable_path)
|
||||||
try:
|
try:
|
||||||
isfollower = variable.isfollower()
|
isfollower = variable.isfollower()
|
||||||
except AttributeError as err:
|
except AttributeError:
|
||||||
pass
|
pass
|
||||||
else:
|
else:
|
||||||
if not isfollower and self.is_inaccessible_user_data(variable):
|
if not isfollower and self.is_inaccessible_user_data(variable):
|
||||||
|
|
|
||||||
|
|
@ -32,10 +32,10 @@ class Examples: # pylint: disable=no-member,too-few-public-methods
|
||||||
def gen_doc_examples(self):
|
def gen_doc_examples(self):
|
||||||
"""Return examples"""
|
"""Return examples"""
|
||||||
root = self.rougailconfig["doc.root"]
|
root = self.rougailconfig["doc.root"]
|
||||||
self.comment_examples = self.rougailconfig["doc.comment_examples"]
|
self.comment_examples = self.rougailconfig["doc.examples.comment"]
|
||||||
self.level = self.rougailconfig["doc.title_level"]
|
self.level = self.rougailconfig["doc.title_level"]
|
||||||
if self.comment_examples:
|
if self.comment_examples:
|
||||||
self.comment_examples_column = self.rougailconfig["doc.comment_examples_column"]
|
self.comment_examples_column = self.rougailconfig["doc.examples.comment_column"]
|
||||||
self._build_examples(root)
|
self._build_examples(root)
|
||||||
return_string = ""
|
return_string = ""
|
||||||
datas = []
|
datas = []
|
||||||
|
|
|
||||||
Binary file not shown.
|
|
@ -25,7 +25,7 @@ class Formatter(CommonFormatter):
|
||||||
"""The asciidoc formatter"""
|
"""The asciidoc formatter"""
|
||||||
|
|
||||||
name = "asciidoc"
|
name = "asciidoc"
|
||||||
_table_name = "asciidoc"
|
_tabular_name = "asciidoc"
|
||||||
level = 40
|
level = 40
|
||||||
|
|
||||||
def title(
|
def title(
|
||||||
|
|
@ -41,7 +41,7 @@ class Formatter(CommonFormatter):
|
||||||
self,
|
self,
|
||||||
lst: List[str],
|
lst: List[str],
|
||||||
) -> str:
|
) -> str:
|
||||||
"""Display line in table from a list"""
|
"""Display line in tabular from a list"""
|
||||||
string = ""
|
string = ""
|
||||||
previous = ""
|
previous = ""
|
||||||
for line in lst:
|
for line in lst:
|
||||||
|
|
@ -94,12 +94,16 @@ class Formatter(CommonFormatter):
|
||||||
self,
|
self,
|
||||||
choices: list,
|
choices: list,
|
||||||
*,
|
*,
|
||||||
inside_table: bool=True,
|
inside_tabular: bool=True,
|
||||||
type_: str="variable",
|
type_: str="variable",
|
||||||
|
with_enter: bool = True,
|
||||||
) -> str:
|
) -> str:
|
||||||
"""Display a liste of element"""
|
"""Display a liste of element"""
|
||||||
prefix = "\n\n* "
|
|
||||||
char = "\n* "
|
char = "\n* "
|
||||||
|
if with_enter:
|
||||||
|
prefix = "\n\n* "
|
||||||
|
else:
|
||||||
|
prefix = char
|
||||||
return prefix + char.join([dump(choice) for choice in choices])
|
return prefix + char.join([dump(choice) for choice in choices])
|
||||||
|
|
||||||
def prop(
|
def prop(
|
||||||
|
|
@ -122,12 +126,12 @@ class Formatter(CommonFormatter):
|
||||||
"""Dump yaml part of documentation"""
|
"""Dump yaml part of documentation"""
|
||||||
return f"[,yaml]\n----\n---\n{dump(_dump)}\n----\n"
|
return f"[,yaml]\n----\n---\n{dump(_dump)}\n----\n"
|
||||||
|
|
||||||
def table(self, datas: list, with_header: bool = True) -> str:
|
def tabular(self, with_header: bool = True) -> str:
|
||||||
"""Transform list to a table in string format
|
"""Transform list to a tabular in string format
|
||||||
we change the first line because we want that col has the same width
|
we change the first line because we want that col has the same width
|
||||||
"""
|
"""
|
||||||
table = super().table(datas, with_header)
|
tabular = super().tabular(with_header)
|
||||||
stable = table.split("\n", 1)
|
stable = tabular.split("\n", 1)
|
||||||
return '[cols="1a,1a"]\n' + stable[1]
|
return '[cols="1a,1a"]\n' + stable[1]
|
||||||
|
|
||||||
def link(
|
def link(
|
||||||
|
|
|
||||||
|
|
@ -27,7 +27,7 @@ class Formatter(CommonFormatter):
|
||||||
|
|
||||||
name = "console"
|
name = "console"
|
||||||
level = 10
|
level = 10
|
||||||
enter_table = "\n"
|
enter_tabular = "\n"
|
||||||
titles_color = {
|
titles_color = {
|
||||||
"title1": "bright_cyan underline bold",
|
"title1": "bright_cyan underline bold",
|
||||||
"title2": "bright_green underline bold",
|
"title2": "bright_green underline bold",
|
||||||
|
|
@ -55,7 +55,7 @@ class Formatter(CommonFormatter):
|
||||||
return self.compute(dico)
|
return self.compute(dico)
|
||||||
|
|
||||||
def compute(self, dico):
|
def compute(self, dico):
|
||||||
if self.rougailconfig["doc.force_true_color_terminal"]:
|
if self.rougailconfig["doc.true_color"]:
|
||||||
force_terminal = 'xterm-256color'
|
force_terminal = 'xterm-256color'
|
||||||
else:
|
else:
|
||||||
force_terminal = None
|
force_terminal = None
|
||||||
|
|
@ -78,8 +78,8 @@ class Formatter(CommonFormatter):
|
||||||
self,
|
self,
|
||||||
lst: List[str],
|
lst: List[str],
|
||||||
) -> str:
|
) -> str:
|
||||||
"""Display line in table from a list"""
|
"""Display line in tabular from a list"""
|
||||||
return self.enter_table.join(lst)
|
return self.enter_tabular.join(lst)
|
||||||
|
|
||||||
def bold(
|
def bold(
|
||||||
self,
|
self,
|
||||||
|
|
@ -120,19 +120,29 @@ class Formatter(CommonFormatter):
|
||||||
self,
|
self,
|
||||||
choices: list,
|
choices: list,
|
||||||
*,
|
*,
|
||||||
inside_table: bool=True,
|
inside_tabular: bool=True,
|
||||||
type_: str="variable",
|
type_: str="variable",
|
||||||
|
with_enter: bool = True,
|
||||||
) -> str:
|
) -> str:
|
||||||
"""Display a liste of element"""
|
"""Display a liste of element"""
|
||||||
|
|
||||||
if type_ == "variable":
|
if type_ == "variable":
|
||||||
char = f"{self.enter_table} • "
|
if with_enter:
|
||||||
|
char = first_char = f"{self.enter_tabular}• "
|
||||||
|
else:
|
||||||
|
first_char = "• "
|
||||||
|
char = f"{self.enter_tabular}{first_char}"
|
||||||
else:
|
else:
|
||||||
char = f"\n{self.family_informations_starts_line()} • "
|
char = first_char = f"\n{self.family_informations_starts_line()} • "
|
||||||
ret = ""
|
ret = ""
|
||||||
for choice in choices:
|
for idx, choice in enumerate(choices):
|
||||||
if not isinstance(choice, str):
|
if not isinstance(choice, str):
|
||||||
choice = dump(choice)
|
choice = dump(choice)
|
||||||
ret += char + choice
|
if not idx:
|
||||||
|
c = first_char
|
||||||
|
else:
|
||||||
|
c = char
|
||||||
|
ret += c + choice
|
||||||
return ret
|
return ret
|
||||||
|
|
||||||
def prop(
|
def prop(
|
||||||
|
|
@ -172,18 +182,18 @@ class Formatter(CommonFormatter):
|
||||||
) -> None:
|
) -> None:
|
||||||
"""count columns length"""
|
"""count columns length"""
|
||||||
for line in col:
|
for line in col:
|
||||||
for l in line.split(self.enter_table):
|
for l in line.split(self.enter_tabular):
|
||||||
self.max_line = max(self.max_line, len(l) + 1)
|
self.max_line = max(self.max_line, len(l) + 1)
|
||||||
|
|
||||||
def table(self, datas: list, with_header: bool = True) -> str:
|
def tabular(self, with_header: bool = True) -> str:
|
||||||
"""Transform list to a table in string format"""
|
"""Transform list to a tabular in string format"""
|
||||||
table = self.rich_table(show_lines=True)
|
tabular = self.rich_table(show_lines=True)
|
||||||
if with_header:
|
if with_header:
|
||||||
table.add_column(_("Variable"), width=self.max_line)
|
for column in self.tabular_datas.headers():
|
||||||
table.add_column(_("Description"), width=self.max_line)
|
tabular.add_column(column, width=self.max_line)
|
||||||
for data in datas:
|
for data in self.tabular_datas.get():
|
||||||
table.add_row(str(data[0]), data[1])
|
tabular.add_row(*data)
|
||||||
return table
|
return tabular
|
||||||
|
|
||||||
def family_informations(self) -> str:
|
def family_informations(self) -> str:
|
||||||
info = "[blue]" + self.bold(f"🛈 {_('Informations')}") + "[/blue]"
|
info = "[blue]" + self.bold(f"🛈 {_('Informations')}") + "[/blue]"
|
||||||
|
|
|
||||||
|
|
@ -32,9 +32,9 @@ class Formatter(CommonFormatter):
|
||||||
"""The markdown (for github) formatter"""
|
"""The markdown (for github) formatter"""
|
||||||
|
|
||||||
name = "github"
|
name = "github"
|
||||||
_table_name = "github"
|
_tabular_name = "github"
|
||||||
level = 50
|
level = 50
|
||||||
enter_table = "<br/>"
|
enter_tabular = "<br/>"
|
||||||
|
|
||||||
def __init__(self, rougailconfig, **kwarg) -> None:
|
def __init__(self, rougailconfig, **kwarg) -> None:
|
||||||
self.max_line_variable = 0
|
self.max_line_variable = 0
|
||||||
|
|
@ -54,8 +54,8 @@ class Formatter(CommonFormatter):
|
||||||
self,
|
self,
|
||||||
lst: List[str],
|
lst: List[str],
|
||||||
) -> str:
|
) -> str:
|
||||||
"""Display line in table from a list"""
|
"""Display line in tabular from a list"""
|
||||||
return self.enter_table.join([l.replace("\n", self.enter_table) for l in lst])
|
return self.enter_tabular.join([l.replace("\n", self.enter_tabular) for l in lst])
|
||||||
|
|
||||||
def bold(
|
def bold(
|
||||||
self,
|
self,
|
||||||
|
|
@ -90,28 +90,37 @@ class Formatter(CommonFormatter):
|
||||||
text: str,
|
text: str,
|
||||||
) -> str:
|
) -> str:
|
||||||
"""Return stripped text (as help)"""
|
"""Return stripped text (as help)"""
|
||||||
return text.strip().replace("\n", self.enter_table)
|
return text.strip().replace("\n", self.enter_tabular)
|
||||||
|
|
||||||
def list(
|
def list(
|
||||||
self,
|
self,
|
||||||
choices: list,
|
choices: list,
|
||||||
*,
|
*,
|
||||||
inside_table: bool=True,
|
inside_tabular: bool=True,
|
||||||
type_: str="variable",
|
type_: str="variable",
|
||||||
|
with_enter: bool = True,
|
||||||
):
|
):
|
||||||
"""Display a liste of element"""
|
"""Display a liste of element"""
|
||||||
if type_ == 'variable':
|
if type_ == 'variable':
|
||||||
if inside_table:
|
if inside_tabular:
|
||||||
char = f"{self.enter_table}• "
|
if with_enter:
|
||||||
|
char = first_char = f"{self.enter_tabular}• "
|
||||||
|
else:
|
||||||
|
first_char = f"• "
|
||||||
|
char = f"{self.enter_tabular}{first_char}"
|
||||||
else:
|
else:
|
||||||
char = "\n- "
|
first_char = char = "\n- "
|
||||||
else:
|
else:
|
||||||
char = f"\n{self.family_informations_starts_line()}- "
|
char = first_char = f"\n{self.family_informations_starts_line()}- "
|
||||||
ret = ""
|
ret = ""
|
||||||
for choice in choices:
|
for idx, choice in enumerate(choices):
|
||||||
if not isinstance(choice, str):
|
if not isinstance(choice, str):
|
||||||
choice = dump(choice)
|
choice = dump(choice)
|
||||||
ret += char + choice
|
if not idx:
|
||||||
|
c = first_char
|
||||||
|
else:
|
||||||
|
c = char
|
||||||
|
ret += c + choice
|
||||||
return ret
|
return ret
|
||||||
|
|
||||||
def prop(
|
def prop(
|
||||||
|
|
@ -131,11 +140,10 @@ class Formatter(CommonFormatter):
|
||||||
prop = self.underline(prop)
|
prop = self.underline(prop)
|
||||||
return prop
|
return prop
|
||||||
|
|
||||||
def table_header(self, lst):
|
def tabular_header(self, lst):
|
||||||
"""Manage the header of a table"""
|
"""Manage the header of a tabular"""
|
||||||
return lst[0] + " " * (self.max_line_variable - len(lst[0])), lst[
|
return lst
|
||||||
1
|
return [l + " " * (self.max_line_variable - len(l)) for l in lst]
|
||||||
] + " " * (self.max_line_description - len(lst[1]))
|
|
||||||
|
|
||||||
def yaml(self, _dump):
|
def yaml(self, _dump):
|
||||||
"""Dump yaml part of documentation"""
|
"""Dump yaml part of documentation"""
|
||||||
|
|
@ -177,7 +185,7 @@ class Formatter(CommonFormatter):
|
||||||
) -> None:
|
) -> None:
|
||||||
"""count columns length"""
|
"""count columns length"""
|
||||||
for line in col:
|
for line in col:
|
||||||
for l in line.split(self.enter_table):
|
for l in line.split(self.enter_tabular):
|
||||||
self.max_line_variable = max(self.max_line_variable, len(l) + 1)
|
self.max_line_variable = max(self.max_line_variable, len(l) + 1)
|
||||||
self.max_line_description = self.max_line_variable
|
self.max_line_description = self.max_line_variable
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -25,7 +25,7 @@ class Formatter(CommonFormatter):
|
||||||
"""The asciidoc formatter"""
|
"""The asciidoc formatter"""
|
||||||
|
|
||||||
name = "html"
|
name = "html"
|
||||||
_table_name = "unsafehtml"
|
_tabular_name = "unsafehtml"
|
||||||
level = 45
|
level = 45
|
||||||
|
|
||||||
def title(
|
def title(
|
||||||
|
|
@ -40,7 +40,7 @@ class Formatter(CommonFormatter):
|
||||||
self,
|
self,
|
||||||
lst: List[str],
|
lst: List[str],
|
||||||
) -> str:
|
) -> str:
|
||||||
"""Display line in table from a list"""
|
"""Display line in tabular from a list"""
|
||||||
string = ""
|
string = ""
|
||||||
previous = ""
|
previous = ""
|
||||||
for line in lst:
|
for line in lst:
|
||||||
|
|
@ -93,8 +93,9 @@ class Formatter(CommonFormatter):
|
||||||
self,
|
self,
|
||||||
choices: list,
|
choices: list,
|
||||||
*,
|
*,
|
||||||
inside_table: bool=True,
|
inside_tabular: bool=True,
|
||||||
type_: str="variable",
|
type_: str="variable",
|
||||||
|
with_enter: bool = True,
|
||||||
) -> str:
|
) -> str:
|
||||||
"""Display a liste of element"""
|
"""Display a liste of element"""
|
||||||
prefix = "<ul>"
|
prefix = "<ul>"
|
||||||
|
|
|
||||||
17
src/rougail/output_doc/tabular/__init__.py
Normal file
17
src/rougail/output_doc/tabular/__init__.py
Normal 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/>.
|
||||||
|
"""
|
||||||
78
src/rougail/output_doc/tabular/five_columns.py
Normal file
78
src/rougail/output_doc/tabular/five_columns.py
Normal file
|
|
@ -0,0 +1,78 @@
|
||||||
|
"""
|
||||||
|
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 .four_columns import Tabular as FourTabular
|
||||||
|
|
||||||
|
|
||||||
|
class Tabular(FourTabular):
|
||||||
|
"""The five columns tabular"""
|
||||||
|
|
||||||
|
name = "five_columns"
|
||||||
|
level = 60
|
||||||
|
|
||||||
|
def clear(self):
|
||||||
|
super().clear()
|
||||||
|
self.five_column = False
|
||||||
|
|
||||||
|
def _add(self) -> tuple:
|
||||||
|
first_column = self.add_first_column()
|
||||||
|
second_column = self.get_column(self.description, self.help_, self.validators, self.choices, self.examples, self.tags)
|
||||||
|
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_column = self.get_column(types)
|
||||||
|
if four_column:
|
||||||
|
self.four_column = True
|
||||||
|
mode = self.formatter.property_to_string(
|
||||||
|
self.informations, self.calculated_properties, self.modified_attributes, contents=["mode", "access_control"],
|
||||||
|
)
|
||||||
|
five_column = self.get_column(mode, *self.calculated_properties)
|
||||||
|
if five_column:
|
||||||
|
self.five_column = True
|
||||||
|
return first_column, second_column, third_column, four_column, five_column
|
||||||
|
|
||||||
|
def headers(self) -> tuple:
|
||||||
|
header = super().headers()
|
||||||
|
if self.five_column:
|
||||||
|
header.append(_("Access control"))
|
||||||
|
return header
|
||||||
|
|
||||||
|
def get_columns(self):
|
||||||
|
for column in self.columns:
|
||||||
|
ret = [column[0]]
|
||||||
|
if self.second_column:
|
||||||
|
ret.append(column[1])
|
||||||
|
if self.third_column:
|
||||||
|
ret.append(column[2])
|
||||||
|
if self.four_column:
|
||||||
|
ret.append(column[3])
|
||||||
|
if self.five_column:
|
||||||
|
ret.append(column[4])
|
||||||
|
yield ret
|
||||||
|
|
||||||
|
def set_properties(self):
|
||||||
|
self.properties = self.formatter.property_to_string(
|
||||||
|
self.informations, self.calculated_properties, self.modified_attributes, contents=["properties", "validator"],
|
||||||
|
)
|
||||||
70
src/rougail/output_doc/tabular/four_columns.py
Normal file
70
src/rougail/output_doc/tabular/four_columns.py
Normal file
|
|
@ -0,0 +1,70 @@
|
||||||
|
"""
|
||||||
|
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 Tabular as ThreeTabular
|
||||||
|
|
||||||
|
|
||||||
|
class Tabular(ThreeTabular):
|
||||||
|
"""The four columns tabular"""
|
||||||
|
|
||||||
|
name = "four_columns"
|
||||||
|
level = 50
|
||||||
|
|
||||||
|
def clear(self):
|
||||||
|
super().clear()
|
||||||
|
self.four_column = False
|
||||||
|
|
||||||
|
def _add(self) -> tuple:
|
||||||
|
first_column = self.add_first_column()
|
||||||
|
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
|
||||||
|
types = self.formatter.property_to_string(
|
||||||
|
self.informations, self.calculated_properties, self.modified_attributes, contents="type",
|
||||||
|
)
|
||||||
|
four_column = self.get_column(types)
|
||||||
|
if four_column:
|
||||||
|
self.four_column = True
|
||||||
|
return first_column, second_column, third_column, four_column
|
||||||
|
|
||||||
|
def headers(self) -> tuple:
|
||||||
|
header = super().headers()
|
||||||
|
if self.four_column:
|
||||||
|
header.append(_("Type"))
|
||||||
|
return header
|
||||||
|
|
||||||
|
def get_columns(self):
|
||||||
|
for column in self.columns:
|
||||||
|
ret = [column[0]]
|
||||||
|
if self.second_column:
|
||||||
|
ret.append(column[1])
|
||||||
|
if self.third_column:
|
||||||
|
ret.append(column[2])
|
||||||
|
if self.four_column:
|
||||||
|
ret.append(column[3])
|
||||||
|
yield ret
|
||||||
|
|
||||||
|
def set_properties(self):
|
||||||
|
self.properties = self.formatter.property_to_string(
|
||||||
|
self.informations, self.calculated_properties, self.modified_attributes, contents=["properties", "mode", "access_control", "validator"],
|
||||||
|
)
|
||||||
91
src/rougail/output_doc/tabular/six_columns.py
Normal file
91
src/rougail/output_doc/tabular/six_columns.py
Normal file
|
|
@ -0,0 +1,91 @@
|
||||||
|
"""
|
||||||
|
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 .five_columns import Tabular as FiveTabular
|
||||||
|
|
||||||
|
|
||||||
|
class Tabular(FiveTabular):
|
||||||
|
"""The six columns tabular"""
|
||||||
|
|
||||||
|
name = "six_columns"
|
||||||
|
level = 70
|
||||||
|
|
||||||
|
def clear(self):
|
||||||
|
super().clear()
|
||||||
|
self.six_column = False
|
||||||
|
|
||||||
|
def _add(self) -> tuple:
|
||||||
|
first_column = self.add_first_column()
|
||||||
|
second_column = self.get_column(self.description, self.help_, self.examples, self.tags)
|
||||||
|
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_column = self.get_column(types)
|
||||||
|
if four_column:
|
||||||
|
self.four_column = True
|
||||||
|
mode = self.formatter.property_to_string(
|
||||||
|
self.informations, self.calculated_properties, self.modified_attributes, contents=["mode", "access_control"],
|
||||||
|
)
|
||||||
|
five_column = self.get_column(mode, *self.calculated_properties)
|
||||||
|
if five_column:
|
||||||
|
self.five_column = True
|
||||||
|
validators = self.formatter.property_to_string(
|
||||||
|
self.informations, self.calculated_properties, self.modified_attributes, contents=["validator"],
|
||||||
|
)
|
||||||
|
six_column = self.get_column(validators, self.validators, self.choices)
|
||||||
|
if six_column:
|
||||||
|
self.six_column = True
|
||||||
|
return first_column, second_column, third_column, four_column, five_column, six_column
|
||||||
|
|
||||||
|
def headers(self) -> tuple:
|
||||||
|
header = super().headers()
|
||||||
|
if self.six_column:
|
||||||
|
header.append(_("Validator"))
|
||||||
|
return header
|
||||||
|
|
||||||
|
def get_columns(self):
|
||||||
|
for column in self.columns:
|
||||||
|
ret = [column[0]]
|
||||||
|
if self.second_column:
|
||||||
|
ret.append(column[1])
|
||||||
|
if self.third_column:
|
||||||
|
ret.append(column[2])
|
||||||
|
if self.four_column:
|
||||||
|
ret.append(column[3])
|
||||||
|
if self.five_column:
|
||||||
|
ret.append(column[4])
|
||||||
|
if self.six_column:
|
||||||
|
ret.append(column[5])
|
||||||
|
yield ret
|
||||||
|
|
||||||
|
def set_properties(self):
|
||||||
|
self.properties = self.formatter.property_to_string(
|
||||||
|
self.informations, self.calculated_properties, self.modified_attributes, contents=["properties"],
|
||||||
|
)
|
||||||
|
|
||||||
|
def set_validators(self):
|
||||||
|
self.validators = self.formatter.convert_section_to_string(
|
||||||
|
"validators", self.informations, self.modified_attributes, multi=True, section_name=False, with_to_phrase=True,
|
||||||
|
)
|
||||||
69
src/rougail/output_doc/tabular/three_columns.py
Normal file
69
src/rougail/output_doc/tabular/three_columns.py
Normal file
|
|
@ -0,0 +1,69 @@
|
||||||
|
"""
|
||||||
|
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 .two_columns import Tabular as TwoTabular
|
||||||
|
|
||||||
|
|
||||||
|
class Tabular(TwoTabular):
|
||||||
|
"""The three columns tabular"""
|
||||||
|
|
||||||
|
name = "three_columns"
|
||||||
|
level = 30
|
||||||
|
|
||||||
|
def clear(self):
|
||||||
|
super().clear()
|
||||||
|
self.third_column = False
|
||||||
|
|
||||||
|
def _add(self) -> tuple:
|
||||||
|
first_column = self.add_first_column()
|
||||||
|
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:
|
||||||
|
headers = super().headers()
|
||||||
|
if self.third_column:
|
||||||
|
headers.append(_("Default value"))
|
||||||
|
return headers
|
||||||
|
|
||||||
|
def get_columns(self):
|
||||||
|
for column in self.columns:
|
||||||
|
ret = [column[0]]
|
||||||
|
if self.second_column:
|
||||||
|
ret.append(column[1])
|
||||||
|
if self.third_column:
|
||||||
|
ret.append(column[2])
|
||||||
|
yield ret
|
||||||
|
|
||||||
|
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
|
||||||
|
)
|
||||||
55
src/rougail/output_doc/tabular/two_columns.py
Normal file
55
src/rougail/output_doc/tabular/two_columns.py
Normal file
|
|
@ -0,0 +1,55 @@
|
||||||
|
"""
|
||||||
|
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 CommonTabular
|
||||||
|
|
||||||
|
|
||||||
|
class Tabular(CommonTabular):
|
||||||
|
"""The two columns tabular"""
|
||||||
|
|
||||||
|
name = "two_columns"
|
||||||
|
level = 10
|
||||||
|
|
||||||
|
def clear(self):
|
||||||
|
super().clear()
|
||||||
|
self.second_column = False
|
||||||
|
|
||||||
|
def _add(self) -> tuple:
|
||||||
|
first_column = self.add_first_column()
|
||||||
|
default = self.default if not self.default_is_already_set else None
|
||||||
|
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 add_first_column(self) -> str:
|
||||||
|
return self.get_column(self.paths, self.properties, self.commandlines, self.environments)
|
||||||
|
|
||||||
|
def headers(self) -> tuple:
|
||||||
|
headers = [_("Variable")]
|
||||||
|
if self.second_column:
|
||||||
|
headers.append(_("Description"))
|
||||||
|
return headers
|
||||||
|
|
||||||
|
def get_columns(self):
|
||||||
|
for column in self.columns:
|
||||||
|
ret = [column[0]]
|
||||||
|
if self.second_column:
|
||||||
|
ret.append(column[1])
|
||||||
|
yield ret
|
||||||
|
|
@ -32,11 +32,7 @@ except:
|
||||||
gen_argument_name = None
|
gen_argument_name = None
|
||||||
|
|
||||||
from .i18n import _
|
from .i18n import _
|
||||||
|
from .config import Tabulars, ROUGAIL_VARIABLE_TYPE
|
||||||
|
|
||||||
ROUGAIL_VARIABLE_TYPE = (
|
|
||||||
"https://rougail.readthedocs.io/en/latest/variable.html#variables-types"
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
ENTER = "\n\n"
|
ENTER = "\n\n"
|
||||||
|
|
@ -75,10 +71,120 @@ def to_phrase(msg, type_="variable"):
|
||||||
return msg[0].upper() + msg[1:]
|
return msg[0].upper() + msg[1:]
|
||||||
|
|
||||||
|
|
||||||
|
class CommonTabular:
|
||||||
|
"""Class with common function for tabular"""
|
||||||
|
|
||||||
|
def __init__(self, formatter: "CommonFormatter") -> None:
|
||||||
|
self.formatter = formatter
|
||||||
|
self.clear()
|
||||||
|
|
||||||
|
def clear(self):
|
||||||
|
self.columns = []
|
||||||
|
|
||||||
|
def get(self):
|
||||||
|
columns = list(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="--", with_anchor=False)
|
||||||
|
if self.type == 'boolean':
|
||||||
|
for path in self.formatter.display_paths(self.informations, self.modified_attributes, self.force_identifiers, is_variable=True, is_bold=False, is_upper=False, with_anchor=False, variable_prefix="--"):
|
||||||
|
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, with_anchor=False)
|
||||||
|
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 CommonFormatter:
|
||||||
"""Class with common function for formatter"""
|
"""Class with common function for formatter"""
|
||||||
|
|
||||||
enter_table = "\n"
|
enter_tabular = "\n"
|
||||||
# tabulate module name
|
# tabulate module name
|
||||||
name = None
|
name = None
|
||||||
|
|
||||||
|
|
@ -105,16 +211,16 @@ class CommonFormatter:
|
||||||
return ""
|
return ""
|
||||||
|
|
||||||
def options(self):
|
def options(self):
|
||||||
self.with_commandline = self.rougailconfig["doc.with_commandline"]
|
self.with_commandline = self.rougailconfig["doc.tabulars.with_commandline"]
|
||||||
self.with_environment = self.rougailconfig["doc.with_environment"]
|
self.with_environment = self.rougailconfig["doc.tabulars.with_environment"]
|
||||||
if self.with_environment and not gen_argument_name:
|
if self.with_environment and not gen_argument_name:
|
||||||
raise Exception('please install tiramisu_cmdline_parser')
|
raise Exception('please install tiramisu_cmdline_parser')
|
||||||
if not self.rougailconfig["main_namespace"] and self.with_environment:
|
if not self.rougailconfig["main_namespace"] and self.with_environment:
|
||||||
if self.support_namespace:
|
if self.support_namespace:
|
||||||
self.prefix = ""
|
self.prefix = ""
|
||||||
else:
|
else:
|
||||||
self.prefix = self.rougailconfig["doc.environment_default_environment_name"] + "_"
|
self.prefix = self.rougailconfig["doc.tabulars.environment_prefix"] + "_"
|
||||||
self.with_family = not self.rougailconfig["doc.without_family"]
|
self.with_family = not self.rougailconfig["doc.tabulars.without_family"]
|
||||||
self.root = self.rougailconfig["doc.root"]
|
self.root = self.rougailconfig["doc.root"]
|
||||||
self.other_root_filenames = None
|
self.other_root_filenames = None
|
||||||
if self.root:
|
if self.root:
|
||||||
|
|
@ -125,6 +231,8 @@ class CommonFormatter:
|
||||||
else:
|
else:
|
||||||
if other_root_filenames:
|
if other_root_filenames:
|
||||||
self.other_root_filenames = dict(zip(other_root_filenames["root_path"], other_root_filenames["filename"]))
|
self.other_root_filenames = dict(zip(other_root_filenames["root_path"], other_root_filenames["filename"]))
|
||||||
|
tabular_template = self.rougailconfig["doc.tabular_template"]
|
||||||
|
self.tabular_datas = Tabulars().get()[tabular_template](self)
|
||||||
|
|
||||||
def compute(self, data):
|
def compute(self, data):
|
||||||
return "".join([d for d in data if d])
|
return "".join([d for d in data if d])
|
||||||
|
|
@ -142,7 +250,7 @@ class CommonFormatter:
|
||||||
self,
|
self,
|
||||||
lst: List[str],
|
lst: List[str],
|
||||||
) -> str:
|
) -> str:
|
||||||
"""Display line in table from a list"""
|
"""Display line in tabular from a list"""
|
||||||
raise NotImplementedError()
|
raise NotImplementedError()
|
||||||
|
|
||||||
def bold(
|
def bold(
|
||||||
|
|
@ -186,8 +294,9 @@ class CommonFormatter:
|
||||||
self,
|
self,
|
||||||
choices: list,
|
choices: list,
|
||||||
*,
|
*,
|
||||||
inside_table: bool=True,
|
inside_tabular: bool=True,
|
||||||
type_: str="variable",
|
type_: str="variable",
|
||||||
|
with_enter: bool = False,
|
||||||
) -> str:
|
) -> str:
|
||||||
"""Display a liste of element"""
|
"""Display a liste of element"""
|
||||||
raise NotImplementedError()
|
raise NotImplementedError()
|
||||||
|
|
@ -229,7 +338,13 @@ class CommonFormatter:
|
||||||
variable_prefix: str="",
|
variable_prefix: str="",
|
||||||
is_bold: bool=True,
|
is_bold: bool=True,
|
||||||
is_upper: bool=False,
|
is_upper: bool=False,
|
||||||
|
with_anchor: bool=True,
|
||||||
) -> str:
|
) -> str:
|
||||||
|
if with_anchor:
|
||||||
|
anchor = self.anchor
|
||||||
|
else:
|
||||||
|
def anchor(path, true_path):
|
||||||
|
return path
|
||||||
ret_paths = []
|
ret_paths = []
|
||||||
path = informations["path"]
|
path = informations["path"]
|
||||||
if is_bold:
|
if is_bold:
|
||||||
|
|
@ -261,19 +376,19 @@ class CommonFormatter:
|
||||||
if variable_prefix:
|
if variable_prefix:
|
||||||
path_ = variable_prefix + upper(path_)
|
path_ = variable_prefix + upper(path_)
|
||||||
if not idx:
|
if not idx:
|
||||||
path_ = self.anchor(path_, path)
|
path_ = anchor(path_, path)
|
||||||
if identifier in new:
|
if identifier in new:
|
||||||
path_ = self.underline(path_)
|
path_ = self.underline(path_)
|
||||||
ret_paths.append(bold(path_))
|
ret_paths.append(bold(path_))
|
||||||
else:
|
else:
|
||||||
ret_paths.append(bold(self.anchor(variable_prefix + upper(path), path)))
|
ret_paths.append(bold(anchor(variable_prefix + upper(path), path)))
|
||||||
return ret_paths
|
return ret_paths
|
||||||
|
|
||||||
def table_header(
|
def tabular_header(
|
||||||
self,
|
self,
|
||||||
lst: list,
|
lst: list,
|
||||||
) -> tuple:
|
) -> tuple:
|
||||||
"""Manage the header of a table"""
|
"""Manage the header of a tabular"""
|
||||||
return lst
|
return lst
|
||||||
|
|
||||||
def _run(self, dico: dict, level: int, dico_is_already_treated: bool) -> str:
|
def _run(self, dico: dict, level: int, dico_is_already_treated: bool) -> str:
|
||||||
|
|
@ -287,41 +402,34 @@ class CommonFormatter:
|
||||||
dico: dict,
|
dico: dict,
|
||||||
level: int,
|
level: int,
|
||||||
*,
|
*,
|
||||||
ori_table_datas: list = None,
|
|
||||||
init: bool = False,
|
init: bool = False,
|
||||||
) -> str:
|
) -> str:
|
||||||
"""Parse the dict to transform to dict"""
|
"""Parse the dict to transform to dict"""
|
||||||
msg = []
|
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 init and self.root:
|
||||||
if self.with_family:
|
if self.with_family:
|
||||||
msg.extend(self.family_to_string(dico["informations"], level, False))
|
msg.extend(self.family_to_string(dico["informations"], level, False))
|
||||||
|
level += 1
|
||||||
dico = dico["children"]
|
dico = dico["children"]
|
||||||
for value in dico.values():
|
for value in dico.values():
|
||||||
if value["type"] == "variable":
|
if value["type"] == "variable":
|
||||||
self.variable_to_string(value, table_datas)
|
self.variable_to_string(value)
|
||||||
else:
|
elif self.with_family:
|
||||||
if self.with_family:
|
if init and value["type"] == "namespace":
|
||||||
if value["type"] == "namespace":
|
namespace = True
|
||||||
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))
|
|
||||||
else:
|
else:
|
||||||
self.dict_to_dict(
|
namespace = False
|
||||||
value["children"], level + 1, ori_table_datas=table_datas
|
if self.tabular_datas.columns:
|
||||||
)
|
msg.append(self.tabular())
|
||||||
if (init or ori_table_datas is None) and table_datas:
|
msg.extend(self.family_to_string(value["informations"], level, namespace))
|
||||||
msg.append(self.table(table_datas))
|
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.tabular_datas.columns and (init or self.with_family):
|
||||||
|
msg.append(self.tabular())
|
||||||
return msg
|
return msg
|
||||||
|
|
||||||
# FAMILY
|
# FAMILY
|
||||||
|
|
@ -338,16 +446,18 @@ class CommonFormatter:
|
||||||
ret = [self.namespace_to_title(informations, level)]
|
ret = [self.namespace_to_title(informations, level)]
|
||||||
else:
|
else:
|
||||||
ret = [self.title(self.get_description("family", informations, {}, None), level)]
|
ret = [self.title(self.get_description("family", informations, {}, None), level)]
|
||||||
|
# ret.append(self.anchor("", informations["path"]) + ENTER)
|
||||||
fam_info = self.family_informations()
|
fam_info = self.family_informations()
|
||||||
if fam_info:
|
if fam_info:
|
||||||
ret.append(fam_info)
|
ret.append(fam_info)
|
||||||
msg = self.display_paths(informations, {}, None)
|
msg = []
|
||||||
helps = informations.get("help")
|
helps = informations.get("help")
|
||||||
if helps:
|
if helps:
|
||||||
for help_ in helps:
|
for help_ in helps:
|
||||||
msg.append(to_phrase(help_.strip()))
|
msg.append(to_phrase(help_.strip()))
|
||||||
|
msg.append(self.section(_("Path"), self.display_paths(informations, {}, None, with_anchor=False, is_bold=False), type_="family"))
|
||||||
calculated_properties = []
|
calculated_properties = []
|
||||||
property_str = self.property_to_string(informations, calculated_properties, {})[1]
|
property_str = self.property_to_string(informations, calculated_properties, {})
|
||||||
if property_str:
|
if property_str:
|
||||||
msg.append(property_str)
|
msg.append(property_str)
|
||||||
if calculated_properties:
|
if calculated_properties:
|
||||||
|
|
@ -452,132 +562,18 @@ class CommonFormatter:
|
||||||
|
|
||||||
# VARIABLE
|
# VARIABLE
|
||||||
def variable_to_string(
|
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:
|
) -> None:
|
||||||
"""Manage variable"""
|
"""Manage variable"""
|
||||||
calculated_properties = []
|
self.tabular_datas.add(informations, modified_attributes, force_identifiers)
|
||||||
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
|
|
||||||
|
|
||||||
def convert_section_to_string(
|
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, with_to_phrase = False
|
||||||
) -> str():
|
) -> str():
|
||||||
values = []
|
values = []
|
||||||
submessage = ""
|
submessage = ""
|
||||||
if modified_attributes and attribute in modified_attributes:
|
if modified_attributes and attribute in modified_attributes:
|
||||||
name, previous, new = modified_attributes[attribute]
|
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):
|
if isinstance(previous, list):
|
||||||
for p in previous:
|
for p in previous:
|
||||||
submessage, m = self.message_to_string(p, submessage)
|
submessage, m = self.message_to_string(p, submessage)
|
||||||
|
|
@ -597,7 +593,7 @@ class CommonFormatter:
|
||||||
old_value = self.underline(old_value)
|
old_value = self.underline(old_value)
|
||||||
values.append(old_value)
|
values.append(old_value)
|
||||||
if multi:
|
if multi:
|
||||||
values = self.list(values)
|
values = self.list(values, with_enter=section_name)
|
||||||
else:
|
else:
|
||||||
values = self.join(values)
|
values = self.join(values)
|
||||||
elif values:
|
elif values:
|
||||||
|
|
@ -612,10 +608,10 @@ class CommonFormatter:
|
||||||
if old["values"] in new:
|
if old["values"] in new:
|
||||||
values = self.underline(values)
|
values = self.underline(values)
|
||||||
if values != []:
|
if values != []:
|
||||||
return self.section(name, values, submessage=submessage)
|
return self.section(name, values, submessage=submessage, section_name=section_name, with_to_phrase=with_to_phrase)
|
||||||
|
|
||||||
def convert_choices_to_string(
|
def convert_choices_to_string(
|
||||||
self, informations: dict, modified_attributes: dict
|
self, informations: dict, modified_attributes: dict, with_default: bool = True,
|
||||||
) -> str():
|
) -> str():
|
||||||
default_is_already_set = False
|
default_is_already_set = False
|
||||||
if "choices" in informations:
|
if "choices" in informations:
|
||||||
|
|
@ -683,7 +679,7 @@ class CommonFormatter:
|
||||||
for choice in reversed(previous):
|
for choice in reversed(previous):
|
||||||
if isinstance(choice, dict):
|
if isinstance(choice, dict):
|
||||||
choice = self.message_to_string(choice, None)[1]
|
choice = self.message_to_string(choice, None)[1]
|
||||||
if choice in old_default:
|
if with_default and choice in old_default:
|
||||||
choices_values.insert(
|
choices_values.insert(
|
||||||
0, self.delete(dump(choice) + " ← " + _("(default)"))
|
0, self.delete(dump(choice) + " ← " + _("(default)"))
|
||||||
)
|
)
|
||||||
|
|
@ -692,11 +688,11 @@ class CommonFormatter:
|
||||||
else:
|
else:
|
||||||
new = []
|
new = []
|
||||||
for idx, val in enumerate(choices_values):
|
for idx, val in enumerate(choices_values):
|
||||||
if val in old_default:
|
if with_default and val in old_default:
|
||||||
choices_values[idx] = (
|
choices_values[idx] = (
|
||||||
dump(val) + " " + self.delete("← " + _("(default)"))
|
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_default:
|
||||||
if val in new:
|
if val in new:
|
||||||
choices_values[idx] = self.underline(
|
choices_values[idx] = self.underline(
|
||||||
|
|
@ -729,34 +725,97 @@ class CommonFormatter:
|
||||||
informations: dict,
|
informations: dict,
|
||||||
calculated_properties: list,
|
calculated_properties: list,
|
||||||
modified_attributes: dict,
|
modified_attributes: dict,
|
||||||
|
contents: list = ["type", "properties", "mode", "access_control", "validator"]
|
||||||
) -> str:
|
) -> str:
|
||||||
"""Transform properties to string"""
|
"""Transform properties to string"""
|
||||||
properties = []
|
properties = []
|
||||||
local_calculated_properties = {}
|
modified_properties = []
|
||||||
multi = False
|
if "type" in contents:
|
||||||
|
if "type" in modified_attributes:
|
||||||
|
properties.append(self.prop(modified_attributes["type"], italic=False, delete=True, underline=False))
|
||||||
|
if "multi" in modified_attributes:
|
||||||
|
properties.append(self.prop("multiple", italic=False, delete=True, underline=False))
|
||||||
|
if "properties" not in contents and "properties" in modified_attributes:
|
||||||
|
for prop in modified_attributes["properties"]:
|
||||||
|
if prop["ori_name"] == "mandatory":
|
||||||
|
properties.append(self.prop(prop["ori_name"], italic=False, delete=True, underline=False))
|
||||||
|
break
|
||||||
|
if "mode" in contents and "mode" in modified_attributes:
|
||||||
|
properties.append(self.prop(modified_attributes["mode"], italic=False, delete=True, underline=False))
|
||||||
if "properties" in modified_attributes:
|
if "properties" in modified_attributes:
|
||||||
|
if "properties" in contents:
|
||||||
|
for props in modified_attributes["properties"]:
|
||||||
|
if not props:
|
||||||
|
continue
|
||||||
|
for prop in props:
|
||||||
|
if prop.get("access_control"):
|
||||||
|
if "access_control" in contents:
|
||||||
|
modified_properties.append(prop)
|
||||||
|
elif prop["ori_name"] != "unique" or "unique" in contents:
|
||||||
|
modified_properties.append(prop)
|
||||||
|
elif "access_control" in contents:
|
||||||
|
for prop in modified_attributes["properties"]:
|
||||||
|
if prop.get("access_control"):
|
||||||
|
modified_properties.append(prop)
|
||||||
|
elif "validator" in contents:
|
||||||
|
for prop in modified_attributes["properties"]:
|
||||||
|
if prop["name"] == "unique":
|
||||||
|
modified_properties.append(prop)
|
||||||
|
local_calculated_properties = {}
|
||||||
|
if "properties" in contents and "properties" in modified_attributes:
|
||||||
previous, new = self.get_modified_properties(
|
previous, new = self.get_modified_properties(
|
||||||
*modified_attributes["properties"][1:]
|
*modified_attributes["properties"][1:]
|
||||||
)
|
)
|
||||||
for p, annotation in previous.items():
|
for p, data in previous.items():
|
||||||
|
if "type" not in contents and data[0] == "mandatory":
|
||||||
|
continue
|
||||||
|
if "validator" not in contents and data[0] == "unique":
|
||||||
|
continue
|
||||||
if p not in new:
|
if p not in new:
|
||||||
properties.append(self.prop(p, italic=False, delete=True, underline=False))
|
properties.append(self.prop(p, italic=False, delete=True, underline=False))
|
||||||
if annotation is not None:
|
if data[1] is not None:
|
||||||
local_calculated_properties[p] = [{"annotation": annotation, "delete": True}]
|
local_calculated_properties[p] = [{"annotation": data[1], "delete": True}]
|
||||||
|
|
||||||
else:
|
else:
|
||||||
previous = new = []
|
previous = new = []
|
||||||
for prop in informations.get("properties", []):
|
others = []
|
||||||
|
if "type" in contents and "variable_type" in informations:
|
||||||
|
others.append({"name": informations["variable_type"], "type": "type"})
|
||||||
|
if informations.get("multiple"):
|
||||||
|
others.append({"name": "multiple", "type": "multiple"})
|
||||||
|
if "properties" not in contents and "properties" in informations:
|
||||||
|
for prop in informations["properties"]:
|
||||||
|
if prop["ori_name"] == "mandatory":
|
||||||
|
others.append(prop)
|
||||||
|
break
|
||||||
|
if "mode" in contents and "mode" in informations:
|
||||||
|
others.append({"name": informations["mode"], "type": "mode"})
|
||||||
|
if "properties" in informations:
|
||||||
|
if "properties" in contents:
|
||||||
|
for prop in informations["properties"]:
|
||||||
|
if prop.get("access_control"):
|
||||||
|
if "access_control" in contents:
|
||||||
|
others.append(prop)
|
||||||
|
elif prop["ori_name"] != "unique" or "validator" in contents:
|
||||||
|
others.append(prop)
|
||||||
|
elif "access_control" in contents:
|
||||||
|
for prop in informations["properties"]:
|
||||||
|
if prop.get("access_control"):
|
||||||
|
others.append(prop)
|
||||||
|
elif "validator" in contents:
|
||||||
|
for prop in informations["properties"]:
|
||||||
|
if prop["name"] == "unique":
|
||||||
|
others.append(prop)
|
||||||
|
for prop in others:
|
||||||
prop_name = prop["name"]
|
prop_name = prop["name"]
|
||||||
|
if "type" not in contents and prop.get("ori_name", prop_name) == "mandatory":
|
||||||
|
continue
|
||||||
if prop_name not in previous and prop_name in new:
|
if prop_name not in previous and prop_name in new:
|
||||||
underline = True
|
underline = True
|
||||||
else:
|
else:
|
||||||
underline = False
|
underline = False
|
||||||
if prop["type"] == "type":
|
if prop["type"] == "type":
|
||||||
properties.append(self.link(prop_name, ROUGAIL_VARIABLE_TYPE, underline))
|
properties.append(self.link(prop_name, ROUGAIL_VARIABLE_TYPE, underline=underline))
|
||||||
else:
|
else:
|
||||||
if prop["type"] == "multiple":
|
|
||||||
multi = True
|
|
||||||
if "annotation" in prop:
|
if "annotation" in prop:
|
||||||
italic = True
|
italic = True
|
||||||
prop_annotation = prop["annotation"]
|
prop_annotation = prop["annotation"]
|
||||||
|
|
@ -765,7 +824,7 @@ class CommonFormatter:
|
||||||
or new[prop_name] != previous[prop_name]
|
or new[prop_name] != previous[prop_name]
|
||||||
):
|
):
|
||||||
underline_ = True
|
underline_ = True
|
||||||
# prop_annotation = self.underline(prop_annotation)
|
# prop_annotation = self.underline(prop_annotation)
|
||||||
else:
|
else:
|
||||||
underline_ = False
|
underline_ = False
|
||||||
local_calculated_properties.setdefault(prop["name"], []).append(
|
local_calculated_properties.setdefault(prop["name"], []).append(
|
||||||
|
|
@ -798,14 +857,14 @@ class CommonFormatter:
|
||||||
)
|
)
|
||||||
)
|
)
|
||||||
if not properties:
|
if not properties:
|
||||||
return multi, ""
|
return ""
|
||||||
return multi, " ".join(properties)
|
return " ".join(properties)
|
||||||
|
|
||||||
def get_modified_properties(
|
def get_modified_properties(
|
||||||
self, previous: List[dict], new: List[dict]
|
self, previous: List[dict], new: List[dict]
|
||||||
) -> Tuple[dict, dict]:
|
) -> Tuple[dict, dict]:
|
||||||
def modified_properties_parser(dico):
|
def modified_properties_parser(dico):
|
||||||
return {d["name"]: d.get("annotation") for d in dico}
|
return {d["name"]: (d["ori_name"], d.get("annotation")) for d in dico}
|
||||||
|
|
||||||
return modified_properties_parser(previous), modified_properties_parser(new)
|
return modified_properties_parser(previous), modified_properties_parser(new)
|
||||||
|
|
||||||
|
|
@ -816,21 +875,20 @@ class CommonFormatter:
|
||||||
"""Manage column"""
|
"""Manage column"""
|
||||||
return
|
return
|
||||||
|
|
||||||
def table(self, datas: list, with_header: bool = True) -> str:
|
def tabular(self, with_header: bool = True) -> str:
|
||||||
"""Transform list to a table in string format"""
|
"""Transform list to a tabular in string format"""
|
||||||
if with_header:
|
if with_header:
|
||||||
headers = self.table_header([_("Variable"), _("Description")])
|
headers = self.tabular_header(self.tabular_datas.headers())
|
||||||
else:
|
else:
|
||||||
headers = ()
|
headers = ()
|
||||||
msg = (
|
msg = (
|
||||||
tabulate(
|
tabulate(
|
||||||
datas,
|
self.tabular_datas.get(),
|
||||||
headers=headers,
|
headers=headers,
|
||||||
tablefmt=self._table_name,
|
tablefmt=self._tabular_name,
|
||||||
)
|
)
|
||||||
+ "\n\n"
|
+ "\n\n"
|
||||||
)
|
)
|
||||||
datas.clear()
|
|
||||||
return msg
|
return msg
|
||||||
|
|
||||||
def message_to_string(self, msg, ret, identifiers=[]):
|
def message_to_string(self, msg, ret, identifiers=[]):
|
||||||
|
|
@ -875,6 +933,8 @@ class CommonFormatter:
|
||||||
msg: str,
|
msg: str,
|
||||||
submessage: str = "",
|
submessage: str = "",
|
||||||
type_ = "variable",
|
type_ = "variable",
|
||||||
|
section_name=True,
|
||||||
|
with_to_phrase=False
|
||||||
) -> str:
|
) -> str:
|
||||||
"""Return something like Name: msg"""
|
"""Return something like Name: msg"""
|
||||||
submessage, msg = self.message_to_string(msg, submessage)
|
submessage, msg = self.message_to_string(msg, submessage)
|
||||||
|
|
@ -882,7 +942,7 @@ class CommonFormatter:
|
||||||
if len(msg) == 1:
|
if len(msg) == 1:
|
||||||
submessage, elt = self.message_to_string(msg[0], submessage)
|
submessage, elt = self.message_to_string(msg[0], submessage)
|
||||||
if isinstance(elt, list):
|
if isinstance(elt, list):
|
||||||
submessage += self.list(elt, type_=type_)
|
submessage += self.list(elt, type_=type_, with_enter=section_name)
|
||||||
else:
|
else:
|
||||||
submessage += elt
|
submessage += elt
|
||||||
else:
|
else:
|
||||||
|
|
@ -890,13 +950,17 @@ class CommonFormatter:
|
||||||
for p in msg:
|
for p in msg:
|
||||||
submessage, elt = self.message_to_string(p, submessage)
|
submessage, elt = self.message_to_string(p, submessage)
|
||||||
lst.append(elt)
|
lst.append(elt)
|
||||||
submessage += self.list(lst, type_=type_)
|
submessage += self.list(lst, type_=type_, with_enter=section_name)
|
||||||
msg = ""
|
msg = ""
|
||||||
if not isinstance(msg, str):
|
if not isinstance(msg, str):
|
||||||
submessage += dump(msg)
|
submessage += dump(msg)
|
||||||
else:
|
else:
|
||||||
submessage += msg
|
submessage += msg
|
||||||
return _("{0}: {1}").format(self.bold(name), submessage)
|
if section_name:
|
||||||
|
return _("{0}: {1}").format(self.bold(name), submessage)
|
||||||
|
if with_to_phrase:
|
||||||
|
return to_phrase(submessage)
|
||||||
|
return submessage
|
||||||
|
|
||||||
|
|
||||||
def calc_path(path, formatter=None, identifiers: List[str] = None) -> str:
|
def calc_path(path, formatter=None, identifiers: List[str] = None) -> str:
|
||||||
|
|
|
||||||
|
|
@ -11,7 +11,7 @@
|
||||||
**Default**: string4 +
|
**Default**: string4 +
|
||||||
**Example**: string5
|
**Example**: string5
|
||||||
| **family2.subfamily.variable** +
|
| **family2.subfamily.variable** +
|
||||||
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | Fourth variable. +
|
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `multiple` `standard` `mandatory` `unique` | Fourth variable. +
|
||||||
**Default**:
|
**Default**:
|
||||||
|
|
||||||
* the value of the variable "var1"
|
* the value of the variable "var1"
|
||||||
|
|
|
||||||
|
|
@ -1,10 +1,10 @@
|
||||||
<details><summary>New variables</summary>
|
<details><summary>New variables</summary>
|
||||||
|
|
||||||
| Variable | Description |
|
| Variable | Description |
|
||||||
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
| **<a id="family2.var2" name="family2.var2">family2.var2</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable2.<br/>**Default**: the value of the variable "[A second variable](#family.var2)" |
|
| **<a id="family2.var2" name="family2.var2">family2.var2</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable2.<br/>**Default**: the value of the variable "[A second variable](#family.var2)" |
|
||||||
| **<a id="family2.var3" name="family2.var3">family2.var3</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A third variable.<br/>**Default**: string4<br/>**Example**: string5 |
|
| **<a id="family2.var3" name="family2.var3">family2.var3</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A third variable.<br/>**Default**: string4<br/>**Example**: string5 |
|
||||||
| **<a id="family2.subfamily.variable" name="family2.subfamily.variable">family2.subfamily.variable</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | Fourth variable.<br/>**Default**: <br/>• the value of the variable "[First variable](#var1)"<br/>• the value of the variable "[A second variable](#family.var2)"<br/>• the value of the variable "[A third variable](#family2.var3)" |
|
| **<a id="family2.subfamily.variable" name="family2.subfamily.variable">family2.subfamily.variable</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` `standard` `mandatory` `unique` | Fourth variable.<br/>**Default**: <br/>• the value of the variable "[First variable](#var1)"<br/>• the value of the variable "[A second variable](#family.var2)"<br/>• the value of the variable "[A third variable](#family2.var3)" |
|
||||||
|
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -7,7 +7,7 @@
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr><td><b>family2.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 variable2.<br/><b>Default</b>: the value of the variable "family.var2" </td></tr>
|
<tr><td><b>family2.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 variable2.<br/><b>Default</b>: the value of the variable "family.var2" </td></tr>
|
||||||
<tr><td><b>family2.var3</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 third variable.<br/><b>Default</b>: string4<br/><b>Example</b>: string5</td></tr>
|
<tr><td><b>family2.var3</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 third variable.<br/><b>Default</b>: string4<br/><b>Example</b>: string5</td></tr>
|
||||||
<tr><td><b>family2.subfamily.variable</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>Fourth variable.<br/><b>Default</b>: <ul><li>the value of the variable "var1"</li>
|
<tr><td><b>family2.subfamily.variable</b><br/><mark><a href='https://rougail.readthedocs.io/en/latest/variable.html#variables-types'>string</a></mark> <mark>multiple</mark> <mark>standard</mark> <mark>mandatory</mark> <mark>unique</mark></td><td>Fourth variable.<br/><b>Default</b>: <ul><li>the value of the variable "var1"</li>
|
||||||
<li>the value of the variable "family.var2"</li>
|
<li>the value of the variable "family.var2"</li>
|
||||||
<li>the value of the variable "family2.var3"</li></ul> </td></tr>
|
<li>the value of the variable "family2.var3"</li></ul> </td></tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
|
|
|
||||||
|
|
@ -1,8 +1,8 @@
|
||||||
# New variables
|
# New variables
|
||||||
|
|
||||||
| Variable | Description |
|
| Variable | Description |
|
||||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
| **<a id="family2.var2" name="family2.var2">family2.var2</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable2.<br/>**Default**: the value of the variable "[A second variable](#family.var2)" |
|
| **<a id="family2.var2" name="family2.var2">family2.var2</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable2.<br/>**Default**: the value of the variable "[A second variable](#family.var2)" |
|
||||||
| **<a id="family2.var3" name="family2.var3">family2.var3</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A third variable.<br/>**Default**: string4<br/>**Example**: string5 |
|
| **<a id="family2.var3" name="family2.var3">family2.var3</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A third variable.<br/>**Default**: string4<br/>**Example**: string5 |
|
||||||
| **<a id="family2.subfamily.variable" name="family2.subfamily.variable">family2.subfamily.variable</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | Fourth variable.<br/>**Default**: <br/>• the value of the variable "[First variable](#var1)"<br/>• the value of the variable "[A second variable](#family.var2)"<br/>• the value of the variable "[A third variable](#family2.var3)" |
|
| **<a id="family2.subfamily.variable" name="family2.subfamily.variable">family2.subfamily.variable</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` `standard` `mandatory` `unique` | Fourth variable.<br/>**Default**: <br/>• the value of the variable "[First variable](#var1)"<br/>• the value of the variable "[A second variable](#family.var2)"<br/>• the value of the variable "[A third variable](#family2.var3)" |
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -12,11 +12,11 @@
|
||||||
│ │ [1mExample[0m: string5 │
|
│ │ [1mExample[0m: string5 │
|
||||||
├───────────────────────────────────────┼──────────────────────────────────────┤
|
├───────────────────────────────────────┼──────────────────────────────────────┤
|
||||||
│ [1mfamily2.subfamily.variable[0m │ Fourth variable. │
|
│ [1mfamily2.subfamily.variable[0m │ Fourth variable. │
|
||||||
│ [1;7m string [0m [1;7m standard [0m [1;7m mandatory [0m [1;7m [0m │ [1mDefault[0m: │
|
│ [1;7m string [0m [1;7m multiple [0m [1;7m standard [0m [1;7m [0m │ [1mDefault[0m: │
|
||||||
│ [1;7munique [0m [1;7m multiple [0m │ • the value of the variable "var1" │
|
│ [1;7mmandatory [0m [1;7m unique [0m │ • the value of the variable "var1" │
|
||||||
│ │ • the value of the variable │
|
│ │ • the value of the variable │
|
||||||
│ │ "family.var2" │
|
│ │ "family.var2" │
|
||||||
│ │ • the value of the variable │
|
│ │ • the value of the variable │
|
||||||
│ │ "family2.var3" │
|
│ │ "family2.var3" │
|
||||||
└───────────────────────────────────────┴──────────────────────────────────────┘
|
└───────────────────────────────────────┴──────────────────────────────────────┘
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,8 +1,8 @@
|
||||||
# New variable
|
# New variable
|
||||||
|
|
||||||
| Variable | Description |
|
| Variable | Description |
|
||||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------|
|
||||||
| **<a id="variable_to_family" name="variable_to_family">variable_to_family</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable that became a family. |
|
| **<a id="variable_to_family" name="variable_to_family">variable_to_family</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable that became a family. |
|
||||||
|
|
||||||
# Deleted variable
|
# Deleted variable
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -10,5 +10,5 @@
|
||||||
[1;4;96mDeleted variable[0m
|
[1;4;96mDeleted variable[0m
|
||||||
|
|
||||||
|
|
||||||
• variable_to_family.var
|
• variable_to_family.var
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,6 @@
|
||||||
# New variable
|
# New variable
|
||||||
|
|
||||||
| Variable | Description |
|
| Variable | Description |
|
||||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------|
|
||||||
| **<a id="family.var3" name="family.var3">family.var3</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A third variable. |
|
| **<a id="family.var3" name="family.var3">family.var3</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A third variable. |
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,8 +1,8 @@
|
||||||
# New variable
|
# New variable
|
||||||
|
|
||||||
| Variable | Description |
|
| Variable | Description |
|
||||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------|
|
||||||
| **<a id="variable_to_family.var" name="variable_to_family.var">variable_to_family.var</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A second variable. |
|
| **<a id="variable_to_family.var" name="variable_to_family.var">variable_to_family.var</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A second variable. |
|
||||||
|
|
||||||
# Deleted variable
|
# Deleted variable
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -10,5 +10,5 @@
|
||||||
[1;4;96mDeleted variable[0m
|
[1;4;96mDeleted variable[0m
|
||||||
|
|
||||||
|
|
||||||
• variable_to_family
|
• variable_to_family
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,7 +1,7 @@
|
||||||
# New variables
|
# New variables
|
||||||
|
|
||||||
| Variable | Description |
|
| Variable | Description |
|
||||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------|
|
||||||
| **<a id="family.var3" name="family.var3">family.var3</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A third variable. |
|
| **<a id="family.var3" name="family.var3">family.var3</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A third variable. |
|
||||||
| **<a id="family2.var4" name="family2.var4">family2.var4</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A fourth variable. |
|
| **<a id="family2.var4" name="family2.var4">family2.var4</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A fourth variable. |
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,7 +1,7 @@
|
||||||
[1;4;96mDeleted variables[0m
|
[1;4;96mDeleted variables[0m
|
||||||
|
|
||||||
|
|
||||||
• family2.var2
|
• family2.var2
|
||||||
• family2.var3
|
• family2.var3
|
||||||
• family2.subfamily.variable
|
• family2.subfamily.variable
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,5 +1,5 @@
|
||||||
[1;4;96mDeleted variable[0m
|
[1;4;96mDeleted variable[0m
|
||||||
|
|
||||||
|
|
||||||
• family.var3
|
• family.var3
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,6 @@
|
||||||
[1;4;96mDeleted variables[0m
|
[1;4;96mDeleted variables[0m
|
||||||
|
|
||||||
|
|
||||||
• family.var3
|
• family.var3
|
||||||
• family2.var4
|
• family2.var4
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,6 @@
|
||||||
# Modified variable
|
# Modified variable
|
||||||
|
|
||||||
| Variable | Description |
|
| Variable | Description |
|
||||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|--------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------|
|
||||||
| **<a id="var1" name="var1">var1</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | <ins>New description.</ins> |
|
| **<a id="var1" name="var1">var1</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | <ins>New description.</ins> |
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,6 @@
|
||||||
# Modified variable
|
# Modified variable
|
||||||
|
|
||||||
| Variable | Description |
|
| Variable | Description |
|
||||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|--------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------|
|
||||||
| **<a id="var1" name="var1">var1</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | ~~First variable.~~<br/><ins>New description.</ins> |
|
| **<a id="var1" name="var1">var1</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | ~~First variable.~~<br/><ins>New description.</ins> |
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,6 @@
|
||||||
# Modified variable
|
# Modified variable
|
||||||
|
|
||||||
| Variable | Description |
|
| Variable | Description |
|
||||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|--------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------|
|
||||||
| **<a id="var1" name="var1">var1</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | First variable.<br/>~~First help.~~<br/><ins>Modified help.</ins> |
|
| **<a id="var1" name="var1">var1</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | First variable.<br/>~~First help.~~<br/><ins>Modified help.</ins> |
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,6 @@
|
||||||
# Modified variable
|
# Modified variable
|
||||||
|
|
||||||
| Variable | Description |
|
| Variable | Description |
|
||||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|--------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------|
|
||||||
| **<a id="var1" name="var1">var1</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | First variable.<br/>**Validator**: ~~"not valid1" is not allowed~~<br/><ins>"not valid2" is not allowed</ins> |
|
| **<a id="var1" name="var1">var1</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | First variable.<br/>**Validator**: ~~"not valid1" is not allowed~~<br/><ins>"not valid2" is not allowed</ins> |
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,8 +1,8 @@
|
||||||
<details><summary>Modified variable</summary>
|
<details><summary>Modified variable</summary>
|
||||||
|
|
||||||
| Variable | Description |
|
| Variable | Description |
|
||||||
|--------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|--------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
| **<a id="var1" name="var1">var1</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | First variable.<br/>**Validators**: <br/>• ~~"not valid2" is not allowed~~<br/>• "not valid1" is not allowed<br/>• <ins>"not valid3" is not allowed</ins> |
|
| **<a id="var1" name="var1">var1</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | First variable.<br/>**Validators**: <br/>• ~~"not valid2" is not allowed~~<br/>• "not valid1" is not allowed<br/>• <ins>"not valid3" is not allowed</ins> |
|
||||||
|
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,6 @@
|
||||||
# Modified variable
|
# Modified variable
|
||||||
|
|
||||||
| Variable | Description |
|
| Variable | Description |
|
||||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|--------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
| **<a id="var1" name="var1">var1</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | First variable.<br/>**Validators**: <br/>• ~~"not valid2" is not allowed~~<br/>• "not valid1" is not allowed<br/>• <ins>"not valid3" is not allowed</ins> |
|
| **<a id="var1" name="var1">var1</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | First variable.<br/>**Validators**: <br/>• ~~"not valid2" is not allowed~~<br/>• "not valid1" is not allowed<br/>• <ins>"not valid3" is not allowed</ins> |
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -5,8 +5,8 @@
|
||||||
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
|
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
|
||||||
│ [1mvar1[0m │ First variable. │
|
│ [1mvar1[0m │ First variable. │
|
||||||
│ [1;7m string [0m [1;7m basic [0m [1;7m mandatory [0m │ [1mValidators[0m: │
|
│ [1;7m string [0m [1;7m basic [0m [1;7m mandatory [0m │ [1mValidators[0m: │
|
||||||
│ │ • [9m"not valid2" is not allowed[0m │
|
│ │ • [9m"not valid2" is not allowed[0m │
|
||||||
│ │ • "not valid1" is not allowed │
|
│ │ • "not valid1" is not allowed │
|
||||||
│ │ • [4m"not valid3" is not allowed[0m │
|
│ │ • [4m"not valid3" is not allowed[0m │
|
||||||
└───────────────────────────────────────┴──────────────────────────────────────┘
|
└───────────────────────────────────────┴──────────────────────────────────────┘
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,8 +1,8 @@
|
||||||
<details><summary>Modified variable</summary>
|
<details><summary>Modified variable</summary>
|
||||||
|
|
||||||
| Variable | Description |
|
| Variable | Description |
|
||||||
|--------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|--------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
| **<a id="var1" name="var1">var1</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | First variable.<br/>**Validators**: <br/>• ~~"not valid1" is not allowed~~<br/>• ~~"not valid3" is not allowed~~<br/>• <ins>"not valid4" is not allowed</ins><br/>• "not valid2" is not allowed<br/>• <ins>"not valid5" is not allowed</ins> |
|
| **<a id="var1" name="var1">var1</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | First variable.<br/>**Validators**: <br/>• ~~"not valid1" is not allowed~~<br/>• ~~"not valid3" is not allowed~~<br/>• <ins>"not valid4" is not allowed</ins><br/>• "not valid2" is not allowed<br/>• <ins>"not valid5" is not allowed</ins> |
|
||||||
|
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,6 @@
|
||||||
# Modified variable
|
# Modified variable
|
||||||
|
|
||||||
| Variable | Description |
|
| Variable | Description |
|
||||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|--------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
| **<a id="var1" name="var1">var1</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | First variable.<br/>**Validators**: <br/>• ~~"not valid1" is not allowed~~<br/>• ~~"not valid3" is not allowed~~<br/>• <ins>"not valid4" is not allowed</ins><br/>• "not valid2" is not allowed<br/>• <ins>"not valid5" is not allowed</ins> |
|
| **<a id="var1" name="var1">var1</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | First variable.<br/>**Validators**: <br/>• ~~"not valid1" is not allowed~~<br/>• ~~"not valid3" is not allowed~~<br/>• <ins>"not valid4" is not allowed</ins><br/>• "not valid2" is not allowed<br/>• <ins>"not valid5" is not allowed</ins> |
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -5,10 +5,10 @@
|
||||||
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
|
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
|
||||||
│ [1mvar1[0m │ First variable. │
|
│ [1mvar1[0m │ First variable. │
|
||||||
│ [1;7m string [0m [1;7m basic [0m [1;7m mandatory [0m │ [1mValidators[0m: │
|
│ [1;7m string [0m [1;7m basic [0m [1;7m mandatory [0m │ [1mValidators[0m: │
|
||||||
│ │ • [9m"not valid1" is not allowed[0m │
|
│ │ • [9m"not valid1" is not allowed[0m │
|
||||||
│ │ • [9m"not valid3" is not allowed[0m │
|
│ │ • [9m"not valid3" is not allowed[0m │
|
||||||
│ │ • [4m"not valid4" is not allowed[0m │
|
│ │ • [4m"not valid4" is not allowed[0m │
|
||||||
│ │ • "not valid2" is not allowed │
|
│ │ • "not valid2" is not allowed │
|
||||||
│ │ • [4m"not valid5" is not allowed[0m │
|
│ │ • [4m"not valid5" is not allowed[0m │
|
||||||
└───────────────────────────────────────┴──────────────────────────────────────┘
|
└───────────────────────────────────────┴──────────────────────────────────────┘
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,8 +1,8 @@
|
||||||
<details><summary>Modified variable</summary>
|
<details><summary>Modified variable</summary>
|
||||||
|
|
||||||
| Variable | Description |
|
| Variable | Description |
|
||||||
|-----------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------|
|
|-----------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------|
|
||||||
| **<a id="var1" name="var1">var1</a>**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | First variable.<br/>**Choices**: <br/>• val1 ~~← (default)~~<br/>• val2 <ins>**← (default)**</ins> |
|
| **<a id="var1" name="var1">var1</a>**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | First variable.<br/>**Choices**: <br/>• val1 ~~← (default)~~<br/>• val2 <ins>**← (default)**</ins> |
|
||||||
|
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,6 @@
|
||||||
# Modified variable
|
# Modified variable
|
||||||
|
|
||||||
| Variable | Description |
|
| Variable | Description |
|
||||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|-----------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------|
|
||||||
| **<a id="var1" name="var1">var1</a>**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | First variable.<br/>**Choices**: <br/>• val1 ~~← (default)~~<br/>• val2 <ins>**← (default)**</ins> |
|
| **<a id="var1" name="var1">var1</a>**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | First variable.<br/>**Choices**: <br/>• val1 ~~← (default)~~<br/>• val2 <ins>**← (default)**</ins> |
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -5,7 +5,7 @@
|
||||||
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
|
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
|
||||||
│ [1mvar1[0m │ First variable. │
|
│ [1mvar1[0m │ First variable. │
|
||||||
│ [1;7m choice [0m [1;7m standard [0m [1;7m mandatory [0m │ [1mChoices[0m: │
|
│ [1;7m choice [0m [1;7m standard [0m [1;7m mandatory [0m │ [1mChoices[0m: │
|
||||||
│ │ • val1 [9m← (default)[0m │
|
│ │ • val1 [9m← (default)[0m │
|
||||||
│ │ • val2 [1;4m← (default)[0m │
|
│ │ • val2 [1;4m← (default)[0m │
|
||||||
└───────────────────────────────────────┴──────────────────────────────────────┘
|
└───────────────────────────────────────┴──────────────────────────────────────┘
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,8 +1,8 @@
|
||||||
<details><summary>Modified variable</summary>
|
<details><summary>Modified variable</summary>
|
||||||
|
|
||||||
| Variable | Description |
|
| Variable | Description |
|
||||||
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
| **<a id="my_variable" name="my_variable">my_variable</a>**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.<br/>**Choices**: <br/>• ~~val1 ← (default)~~<br/>• ~~val2~~<br/>• the value of the variable "[The first source variable](#source_variable_1)" **← (default)**<br/>• the value of the variable "[The second source variable](#source_variable_2)" |
|
| **<a id="my_variable" name="my_variable">my_variable</a>**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.<br/>**Choices**: <br/>• ~~val1 ← (default)~~<br/>• ~~val2~~<br/>• the value of the variable "[The first source variable](#source_variable_1)" **← (default)**<br/>• the value of the variable "[The second source variable](#source_variable_2)" |
|
||||||
|
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,6 @@
|
||||||
# Modified variable
|
# Modified variable
|
||||||
|
|
||||||
| Variable | Description |
|
| Variable | Description |
|
||||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
| **<a id="my_variable" name="my_variable">my_variable</a>**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.<br/>**Choices**: <br/>• ~~val1 ← (default)~~<br/>• ~~val2~~<br/>• the value of the variable "[The first source variable](#source_variable_1)" **← (default)**<br/>• the value of the variable "[The second source variable](#source_variable_2)" |
|
| **<a id="my_variable" name="my_variable">my_variable</a>**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.<br/>**Choices**: <br/>• ~~val1 ← (default)~~<br/>• ~~val2~~<br/>• the value of the variable "[The first source variable](#source_variable_1)" **← (default)**<br/>• the value of the variable "[The second source variable](#source_variable_2)" |
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -5,11 +5,11 @@
|
||||||
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
|
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
|
||||||
│ [1mmy_variable[0m │ A variable. │
|
│ [1mmy_variable[0m │ A variable. │
|
||||||
│ [1;7m choice [0m [1;7m standard [0m [1;7m mandatory [0m │ [1mChoices[0m: │
|
│ [1;7m choice [0m [1;7m standard [0m [1;7m mandatory [0m │ [1mChoices[0m: │
|
||||||
│ │ • [9mval1 ← (default)[0m │
|
│ │ • [9mval1 ← (default)[0m │
|
||||||
│ │ • [9mval2[0m │
|
│ │ • [9mval2[0m │
|
||||||
│ │ • the value of the variable │
|
│ │ • the value of the variable │
|
||||||
│ │ "source_variable_1" [1m← (default)[0m │
|
│ │ "source_variable_1" [1m← (default)[0m │
|
||||||
│ │ • the value of the variable │
|
│ │ • the value of the variable │
|
||||||
│ │ "source_variable_2" │
|
│ │ "source_variable_2" │
|
||||||
└───────────────────────────────────────┴──────────────────────────────────────┘
|
└───────────────────────────────────────┴──────────────────────────────────────┘
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,8 +1,8 @@
|
||||||
<details><summary>Modified variable</summary>
|
<details><summary>Modified variable</summary>
|
||||||
|
|
||||||
| Variable | Description |
|
| Variable | Description |
|
||||||
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
| **<a id="my_variable" name="my_variable">my_variable</a>**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.<br/>**Choices**: <br/>• ~~the value of the variable "[The first source variable](#source_variable_1)"~~<br/>• ~~the value of the variable "[The second source variable](#source_variable_2)"~~<br/>• <ins>val1 **← (default)**</ins><br/>• <ins>val2</ins> |
|
| **<a id="my_variable" name="my_variable">my_variable</a>**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.<br/>**Choices**: <br/>• ~~the value of the variable "[The first source variable](#source_variable_1)"~~<br/>• ~~the value of the variable "[The second source variable](#source_variable_2)"~~<br/>• <ins>val1 **← (default)**</ins><br/>• <ins>val2</ins> |
|
||||||
|
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,6 @@
|
||||||
# Modified variable
|
# Modified variable
|
||||||
|
|
||||||
| Variable | Description |
|
| Variable | Description |
|
||||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
| **<a id="my_variable" name="my_variable">my_variable</a>**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.<br/>**Choices**: <br/>• ~~the value of the variable "[The first source variable](#source_variable_1)"~~<br/>• ~~the value of the variable "[The second source variable](#source_variable_2)"~~<br/>• <ins>val1 **← (default)**</ins><br/>• <ins>val2</ins> |
|
| **<a id="my_variable" name="my_variable">my_variable</a>**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.<br/>**Choices**: <br/>• ~~the value of the variable "[The first source variable](#source_variable_1)"~~<br/>• ~~the value of the variable "[The second source variable](#source_variable_2)"~~<br/>• <ins>val1 **← (default)**</ins><br/>• <ins>val2</ins> |
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -5,11 +5,11 @@
|
||||||
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
|
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
|
||||||
│ [1mmy_variable[0m │ A variable. │
|
│ [1mmy_variable[0m │ A variable. │
|
||||||
│ [1;7m choice [0m [1;7m standard [0m [1;7m mandatory [0m │ [1mChoices[0m: │
|
│ [1;7m choice [0m [1;7m standard [0m [1;7m mandatory [0m │ [1mChoices[0m: │
|
||||||
│ │ • [9mthe value of the variable [0m │
|
│ │ • [9mthe value of the variable [0m │
|
||||||
│ │ [9m"source_variable_1"[0m │
|
│ │ [9m"source_variable_1"[0m │
|
||||||
│ │ • [9mthe value of the variable [0m │
|
│ │ • [9mthe value of the variable [0m │
|
||||||
│ │ [9m"source_variable_2"[0m │
|
│ │ [9m"source_variable_2"[0m │
|
||||||
│ │ • [4mval1 [0m[1;4m← (default)[0m │
|
│ │ • [4mval1 [0m[1;4m← (default)[0m │
|
||||||
│ │ • [4mval2[0m │
|
│ │ • [4mval2[0m │
|
||||||
└───────────────────────────────────────┴──────────────────────────────────────┘
|
└───────────────────────────────────────┴──────────────────────────────────────┘
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,8 +1,8 @@
|
||||||
<details><summary>Modified variable</summary>
|
<details><summary>Modified variable</summary>
|
||||||
|
|
||||||
| Variable | Description |
|
| Variable | Description |
|
||||||
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------|
|
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
| **<a id="my_variable" name="my_variable">my_variable</a>**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable.<br/>**Choices**: <br/>• ~~val1~~<br/>• ~~val2~~<br/>• the value of the variable "[The first source variable](#source_variable_1)" |
|
| **<a id="my_variable" name="my_variable">my_variable</a>**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable.<br/>**Choices**: <br/>• ~~val1~~<br/>• ~~val2~~<br/>• the value of the variable "[The first source variable](#source_variable_1)" |
|
||||||
|
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,6 @@
|
||||||
# Modified variable
|
# Modified variable
|
||||||
|
|
||||||
| Variable | Description |
|
| Variable | Description |
|
||||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
| **<a id="my_variable" name="my_variable">my_variable</a>**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable.<br/>**Choices**: <br/>• ~~val1~~<br/>• ~~val2~~<br/>• the value of the variable "[The first source variable](#source_variable_1)" |
|
| **<a id="my_variable" name="my_variable">my_variable</a>**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable.<br/>**Choices**: <br/>• ~~val1~~<br/>• ~~val2~~<br/>• the value of the variable "[The first source variable](#source_variable_1)" |
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -5,9 +5,9 @@
|
||||||
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
|
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
|
||||||
│ [1mmy_variable[0m │ A variable. │
|
│ [1mmy_variable[0m │ A variable. │
|
||||||
│ [1;7m choice [0m [1;7m basic [0m [1;7m mandatory [0m │ [1mChoices[0m: │
|
│ [1;7m choice [0m [1;7m basic [0m [1;7m mandatory [0m │ [1mChoices[0m: │
|
||||||
│ │ • [9mval1[0m │
|
│ │ • [9mval1[0m │
|
||||||
│ │ • [9mval2[0m │
|
│ │ • [9mval2[0m │
|
||||||
│ │ • the value of the variable │
|
│ │ • the value of the variable │
|
||||||
│ │ "source_variable_1" │
|
│ │ "source_variable_1" │
|
||||||
└───────────────────────────────────────┴──────────────────────────────────────┘
|
└───────────────────────────────────────┴──────────────────────────────────────┘
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,8 +1,8 @@
|
||||||
<details><summary>Modified variable</summary>
|
<details><summary>Modified variable</summary>
|
||||||
|
|
||||||
| Variable | Description |
|
| Variable | Description |
|
||||||
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
| **<a id="my_variable" name="my_variable">my_variable</a>**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable.<br/>**Choices**: <br/>• ~~the value of the variable "[The first source variable](#source_variable_1)"~~<br/>• <ins>val1</ins><br/>• <ins>val2</ins> |
|
| **<a id="my_variable" name="my_variable">my_variable</a>**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable.<br/>**Choices**: <br/>• ~~the value of the variable "[The first source variable](#source_variable_1)"~~<br/>• <ins>val1</ins><br/>• <ins>val2</ins> |
|
||||||
|
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,6 @@
|
||||||
# Modified variable
|
# Modified variable
|
||||||
|
|
||||||
| Variable | Description |
|
| Variable | Description |
|
||||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
| **<a id="my_variable" name="my_variable">my_variable</a>**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable.<br/>**Choices**: <br/>• ~~the value of the variable "[The first source variable](#source_variable_1)"~~<br/>• <ins>val1</ins><br/>• <ins>val2</ins> |
|
| **<a id="my_variable" name="my_variable">my_variable</a>**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable.<br/>**Choices**: <br/>• ~~the value of the variable "[The first source variable](#source_variable_1)"~~<br/>• <ins>val1</ins><br/>• <ins>val2</ins> |
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -5,9 +5,9 @@
|
||||||
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
|
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
|
||||||
│ [1mmy_variable[0m │ A variable. │
|
│ [1mmy_variable[0m │ A variable. │
|
||||||
│ [1;7m choice [0m [1;7m basic [0m [1;7m mandatory [0m │ [1mChoices[0m: │
|
│ [1;7m choice [0m [1;7m basic [0m [1;7m mandatory [0m │ [1mChoices[0m: │
|
||||||
│ │ • [9mthe value of the variable [0m │
|
│ │ • [9mthe value of the variable [0m │
|
||||||
│ │ [9m"source_variable_1"[0m │
|
│ │ [9m"source_variable_1"[0m │
|
||||||
│ │ • [4mval1[0m │
|
│ │ • [4mval1[0m │
|
||||||
│ │ • [4mval2[0m │
|
│ │ • [4mval2[0m │
|
||||||
└───────────────────────────────────────┴──────────────────────────────────────┘
|
└───────────────────────────────────────┴──────────────────────────────────────┘
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -4,7 +4,7 @@
|
||||||
|====
|
|====
|
||||||
| Variable | Description
|
| Variable | Description
|
||||||
| **var1** +
|
| **var1** +
|
||||||
`+++basic+++` `https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `#standard#` `mandatory` | First variable. +
|
`+++(None, ['basic'], ['standard'])+++` `https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` `mandatory` | First variable. +
|
||||||
**Choices**:
|
**Choices**:
|
||||||
|
|
||||||
* val1
|
* val1
|
||||||
|
|
|
||||||
|
|
@ -1,8 +1,8 @@
|
||||||
<details><summary>Modified variable</summary>
|
<details><summary>Modified variable</summary>
|
||||||
|
|
||||||
| Variable | Description |
|
| Variable | Description |
|
||||||
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------|
|
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------|
|
||||||
| **<a id="var1" name="var1">var1</a>**<br/>~~`basic`~~ [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) <ins>`standard`</ins> `mandatory` | First variable.<br/>**Choices**: <br/>• val1<br/>• val2 <ins>**← (default)**</ins> |
|
| **<a id="var1" name="var1">var1</a>**<br/>~~`(None, ['basic'], ['standard'])`~~ [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | First variable.<br/>**Choices**: <br/>• val1<br/>• val2 <ins>**← (default)**</ins> |
|
||||||
|
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,10 +2,10 @@
|
||||||
|
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr><th>Variable </th><th>Description </th></tr>
|
<tr><th>Variable </th><th>Description </th></tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr><td><b>var1</b><br/><mark><del>basic</del></mark> <mark><a href='https://rougail.readthedocs.io/en/latest/variable.html#variables-types'>choice</a></mark> <mark><ins>standard</ins></mark> <mark>mandatory</mark></td><td>First variable.<br/><b>Choices</b>: <ul><li>val1</li>
|
<tr><td><b>var1</b><br/><mark><del>(None, ['basic'], ['standard'])</del></mark> <mark><a href='https://rougail.readthedocs.io/en/latest/variable.html#variables-types'>choice</a></mark> <mark>standard</mark> <mark>mandatory</mark></td><td>First variable.<br/><b>Choices</b>: <ul><li>val1</li>
|
||||||
<li>val2 <ins><b>← (default)</b></ins></li></ul> </td></tr>
|
<li>val2 <ins><b>← (default)</b></ins></li></ul> </td></tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,6 @@
|
||||||
# Modified variable
|
# Modified variable
|
||||||
|
|
||||||
| Variable | Description |
|
| Variable | Description |
|
||||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------|
|
||||||
| **<a id="var1" name="var1">var1</a>**<br/>~~`basic`~~ [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) <ins>`standard`</ins> `mandatory` | First variable.<br/>**Choices**: <br/>• val1<br/>• val2 <ins>**← (default)**</ins> |
|
| **<a id="var1" name="var1">var1</a>**<br/>~~`(None, ['basic'], ['standard'])`~~ [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | First variable.<br/>**Choices**: <br/>• val1<br/>• val2 <ins>**← (default)**</ins> |
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -4,8 +4,8 @@
|
||||||
┃[1m [0m[1mVariable [0m[1m [0m┃[1m [0m[1mDescription [0m[1m [0m┃
|
┃[1m [0m[1mVariable [0m[1m [0m┃[1m [0m[1mDescription [0m[1m [0m┃
|
||||||
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
|
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
|
||||||
│ [1mvar1[0m │ First variable. │
|
│ [1mvar1[0m │ First variable. │
|
||||||
│ [1;7m [0m[1;7;9mbasic[0m[1;7m [0m [1;7m choice [0m [1;7m [0m[1;4;7mstandard[0m[1;7m [0m [1;7m [0m │ [1mChoices[0m: │
|
│ [1;7m [0m[1;7;9m(None, ['basic'], ['standard'])[0m[1;7m [0m [1;7m [0m │ [1mChoices[0m: │
|
||||||
│ [1;7mmandatory [0m │ • val1 │
|
│ [1;7mchoice [0m [1;7m standard [0m [1;7m mandatory [0m │ • val1 │
|
||||||
│ │ • val2 [1;4m← (default)[0m │
|
│ │ • val2 [1;4m← (default)[0m │
|
||||||
└───────────────────────────────────────┴──────────────────────────────────────┘
|
└───────────────────────────────────────┴──────────────────────────────────────┘
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -4,7 +4,7 @@
|
||||||
|====
|
|====
|
||||||
| Variable | Description
|
| Variable | Description
|
||||||
| **var1** +
|
| **var1** +
|
||||||
`+++basic+++` `+++mandatory+++` `https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `#standard#` | First variable. +
|
`+++(None, ['basic'], ['standard'])+++` `+++mandatory+++` `https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` | First variable. +
|
||||||
**Choices**:
|
**Choices**:
|
||||||
|
|
||||||
* null +++← (default)+++
|
* null +++← (default)+++
|
||||||
|
|
|
||||||
|
|
@ -1,8 +1,8 @@
|
||||||
<details><summary>Modified variable</summary>
|
<details><summary>Modified variable</summary>
|
||||||
|
|
||||||
| Variable | Description |
|
| Variable | Description |
|
||||||
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------|
|
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------|
|
||||||
| **<a id="var1" name="var1">var1</a>**<br/>~~`basic`~~ ~~`mandatory`~~ [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) <ins>`standard`</ins> | First variable.<br/>**Choices**: <br/>• null ~~← (default)~~<br/>• val1<br/>• val2 <ins>**← (default)**</ins> |
|
| **<a id="var1" name="var1">var1</a>**<br/>~~`(None, ['basic'], ['standard'])`~~ ~~`mandatory`~~ [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | First variable.<br/>**Choices**: <br/>• null ~~← (default)~~<br/>• val1<br/>• val2 <ins>**← (default)**</ins> |
|
||||||
|
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,10 +2,10 @@
|
||||||
|
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr><th>Variable </th><th>Description </th></tr>
|
<tr><th>Variable </th><th>Description </th></tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr><td><b>var1</b><br/><mark><del>basic</del></mark> <mark><del>mandatory</del></mark> <mark><a href='https://rougail.readthedocs.io/en/latest/variable.html#variables-types'>choice</a></mark> <mark><ins>standard</ins></mark></td><td>First variable.<br/><b>Choices</b>: <ul><li>null <del>← (default)</del></li>
|
<tr><td><b>var1</b><br/><mark><del>(None, ['basic'], ['standard'])</del></mark> <mark><del>mandatory</del></mark> <mark><a href='https://rougail.readthedocs.io/en/latest/variable.html#variables-types'>choice</a></mark> <mark>standard</mark></td><td>First variable.<br/><b>Choices</b>: <ul><li>null <del>← (default)</del></li>
|
||||||
<li>val1</li>
|
<li>val1</li>
|
||||||
<li>val2 <ins><b>← (default)</b></ins></li></ul> </td></tr>
|
<li>val2 <ins><b>← (default)</b></ins></li></ul> </td></tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,6 @@
|
||||||
# Modified variable
|
# Modified variable
|
||||||
|
|
||||||
| Variable | Description |
|
| Variable | Description |
|
||||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------|
|
||||||
| **<a id="var1" name="var1">var1</a>**<br/>~~`basic`~~ ~~`mandatory`~~ [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) <ins>`standard`</ins> | First variable.<br/>**Choices**: <br/>• null ~~← (default)~~<br/>• val1<br/>• val2 <ins>**← (default)**</ins> |
|
| **<a id="var1" name="var1">var1</a>**<br/>~~`(None, ['basic'], ['standard'])`~~ ~~`mandatory`~~ [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | First variable.<br/>**Choices**: <br/>• null ~~← (default)~~<br/>• val1<br/>• val2 <ins>**← (default)**</ins> |
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -4,9 +4,9 @@
|
||||||
┃[1m [0m[1mVariable [0m[1m [0m┃[1m [0m[1mDescription [0m[1m [0m┃
|
┃[1m [0m[1mVariable [0m[1m [0m┃[1m [0m[1mDescription [0m[1m [0m┃
|
||||||
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
|
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
|
||||||
│ [1mvar1[0m │ First variable. │
|
│ [1mvar1[0m │ First variable. │
|
||||||
│ [1;7m [0m[1;7;9mbasic[0m[1;7m [0m [1;7m [0m[1;7;9mmandatory[0m[1;7m [0m [1;7m choice [0m [1;7m [0m │ [1mChoices[0m: │
|
│ [1;7m [0m[1;7;9m(None, ['basic'], ['standard'])[0m[1;7m [0m [1;7m [0m │ [1mChoices[0m: │
|
||||||
│ [1;4;7mstandard[0m[1;7m [0m │ • null [9m← (default)[0m │
|
│ [1;7;9mmandatory[0m[1;7m [0m [1;7m choice [0m [1;7m standard [0m │ • null [9m← (default)[0m │
|
||||||
│ │ • val1 │
|
│ │ • val1 │
|
||||||
│ │ • val2 [1;4m← (default)[0m │
|
│ │ • val2 [1;4m← (default)[0m │
|
||||||
└───────────────────────────────────────┴──────────────────────────────────────┘
|
└───────────────────────────────────────┴──────────────────────────────────────┘
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,8 +1,8 @@
|
||||||
<details><summary>Modified variable</summary>
|
<details><summary>Modified variable</summary>
|
||||||
|
|
||||||
| Variable | Description |
|
| Variable | Description |
|
||||||
|-----------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------|
|
|-----------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------|
|
||||||
| **<a id="var1" name="var1">var1</a>**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | First variable.<br/>**Choices**: <br/>• ~~val3 ← (default)~~<br/>• val1<br/>• val2 <ins>**← (default)**</ins> |
|
| **<a id="var1" name="var1">var1</a>**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | First variable.<br/>**Choices**: <br/>• ~~val3 ← (default)~~<br/>• val1<br/>• val2 <ins>**← (default)**</ins> |
|
||||||
|
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,6 @@
|
||||||
# Modified variable
|
# Modified variable
|
||||||
|
|
||||||
| Variable | Description |
|
| Variable | Description |
|
||||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|-----------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------|
|
||||||
| **<a id="var1" name="var1">var1</a>**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | First variable.<br/>**Choices**: <br/>• ~~val3 ← (default)~~<br/>• val1<br/>• val2 <ins>**← (default)**</ins> |
|
| **<a id="var1" name="var1">var1</a>**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | First variable.<br/>**Choices**: <br/>• ~~val3 ← (default)~~<br/>• val1<br/>• val2 <ins>**← (default)**</ins> |
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -5,8 +5,8 @@
|
||||||
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
|
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
|
||||||
│ [1mvar1[0m │ First variable. │
|
│ [1mvar1[0m │ First variable. │
|
||||||
│ [1;7m choice [0m [1;7m standard [0m [1;7m mandatory [0m │ [1mChoices[0m: │
|
│ [1;7m choice [0m [1;7m standard [0m [1;7m mandatory [0m │ [1mChoices[0m: │
|
||||||
│ │ • [9mval3 ← (default)[0m │
|
│ │ • [9mval3 ← (default)[0m │
|
||||||
│ │ • val1 │
|
│ │ • val1 │
|
||||||
│ │ • val2 [1;4m← (default)[0m │
|
│ │ • val2 [1;4m← (default)[0m │
|
||||||
└───────────────────────────────────────┴──────────────────────────────────────┘
|
└───────────────────────────────────────┴──────────────────────────────────────┘
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,8 +1,8 @@
|
||||||
<details><summary>Modified variable</summary>
|
<details><summary>Modified variable</summary>
|
||||||
|
|
||||||
| Variable | Description |
|
| Variable | Description |
|
||||||
|-----------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------|
|
|-----------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------|
|
||||||
| **<a id="var1" name="var1">var1</a>**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | First variable.<br/>**Choices**: <br/>• ~~val3~~<br/>• val1<br/>• val2 **← (default)** |
|
| **<a id="var1" name="var1">var1</a>**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | First variable.<br/>**Choices**: <br/>• ~~val3~~<br/>• val1<br/>• val2 **← (default)** |
|
||||||
|
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,6 @@
|
||||||
# Modified variable
|
# Modified variable
|
||||||
|
|
||||||
| Variable | Description |
|
| Variable | Description |
|
||||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|-----------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------|
|
||||||
| **<a id="var1" name="var1">var1</a>**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | First variable.<br/>**Choices**: <br/>• ~~val3~~<br/>• val1<br/>• val2 **← (default)** |
|
| **<a id="var1" name="var1">var1</a>**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | First variable.<br/>**Choices**: <br/>• ~~val3~~<br/>• val1<br/>• val2 **← (default)** |
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -5,8 +5,8 @@
|
||||||
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
|
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
|
||||||
│ [1mvar1[0m │ First variable. │
|
│ [1mvar1[0m │ First variable. │
|
||||||
│ [1;7m choice [0m [1;7m standard [0m [1;7m mandatory [0m │ [1mChoices[0m: │
|
│ [1;7m choice [0m [1;7m standard [0m [1;7m mandatory [0m │ [1mChoices[0m: │
|
||||||
│ │ • [9mval3[0m │
|
│ │ • [9mval3[0m │
|
||||||
│ │ • val1 │
|
│ │ • val1 │
|
||||||
│ │ • val2 [1m← (default)[0m │
|
│ │ • val2 [1m← (default)[0m │
|
||||||
└───────────────────────────────────────┴──────────────────────────────────────┘
|
└───────────────────────────────────────┴──────────────────────────────────────┘
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,8 +1,8 @@
|
||||||
<details><summary>Modified variable</summary>
|
<details><summary>Modified variable</summary>
|
||||||
|
|
||||||
| Variable | Description |
|
| Variable | Description |
|
||||||
|-----------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------|
|
|-----------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------|
|
||||||
| **<a id="var1" name="var1">var1</a>**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | First variable.<br/>**Choices**: <br/>• val1<br/>• val2 **← (default)**<br/>• <ins>val3</ins> |
|
| **<a id="var1" name="var1">var1</a>**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | First variable.<br/>**Choices**: <br/>• val1<br/>• val2 **← (default)**<br/>• <ins>val3</ins> |
|
||||||
|
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,6 @@
|
||||||
# Modified variable
|
# Modified variable
|
||||||
|
|
||||||
| Variable | Description |
|
| Variable | Description |
|
||||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|-----------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------|
|
||||||
| **<a id="var1" name="var1">var1</a>**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | First variable.<br/>**Choices**: <br/>• val1<br/>• val2 **← (default)**<br/>• <ins>val3</ins> |
|
| **<a id="var1" name="var1">var1</a>**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | First variable.<br/>**Choices**: <br/>• val1<br/>• val2 **← (default)**<br/>• <ins>val3</ins> |
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -5,8 +5,8 @@
|
||||||
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
|
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
|
||||||
│ [1mvar1[0m │ First variable. │
|
│ [1mvar1[0m │ First variable. │
|
||||||
│ [1;7m choice [0m [1;7m standard [0m [1;7m mandatory [0m │ [1mChoices[0m: │
|
│ [1;7m choice [0m [1;7m standard [0m [1;7m mandatory [0m │ [1mChoices[0m: │
|
||||||
│ │ • val1 │
|
│ │ • val1 │
|
||||||
│ │ • val2 [1m← (default)[0m │
|
│ │ • val2 [1m← (default)[0m │
|
||||||
│ │ • [4mval3[0m │
|
│ │ • [4mval3[0m │
|
||||||
└───────────────────────────────────────┴──────────────────────────────────────┘
|
└───────────────────────────────────────┴──────────────────────────────────────┘
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,8 +1,8 @@
|
||||||
<details><summary>Modified variable</summary>
|
<details><summary>Modified variable</summary>
|
||||||
|
|
||||||
| Variable | Description |
|
| Variable | Description |
|
||||||
|-----------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------|
|
|-----------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------|
|
||||||
| **<a id="var1" name="var1">var1</a>**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | First variable.<br/>**Choices**: <br/>• val1<br/>• val2 ~~← (default)~~<br/>• <ins>val3 **← (default)**</ins> |
|
| **<a id="var1" name="var1">var1</a>**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | First variable.<br/>**Choices**: <br/>• val1<br/>• val2 ~~← (default)~~<br/>• <ins>val3 **← (default)**</ins> |
|
||||||
|
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,6 @@
|
||||||
# Modified variable
|
# Modified variable
|
||||||
|
|
||||||
| Variable | Description |
|
| Variable | Description |
|
||||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|-----------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------|
|
||||||
| **<a id="var1" name="var1">var1</a>**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | First variable.<br/>**Choices**: <br/>• val1<br/>• val2 ~~← (default)~~<br/>• <ins>val3 **← (default)**</ins> |
|
| **<a id="var1" name="var1">var1</a>**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | First variable.<br/>**Choices**: <br/>• val1<br/>• val2 ~~← (default)~~<br/>• <ins>val3 **← (default)**</ins> |
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -5,8 +5,8 @@
|
||||||
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
|
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
|
||||||
│ [1mvar1[0m │ First variable. │
|
│ [1mvar1[0m │ First variable. │
|
||||||
│ [1;7m choice [0m [1;7m standard [0m [1;7m mandatory [0m │ [1mChoices[0m: │
|
│ [1;7m choice [0m [1;7m standard [0m [1;7m mandatory [0m │ [1mChoices[0m: │
|
||||||
│ │ • val1 │
|
│ │ • val1 │
|
||||||
│ │ • val2 [9m← (default)[0m │
|
│ │ • val2 [9m← (default)[0m │
|
||||||
│ │ • [4mval3 [0m[1;4m← (default)[0m │
|
│ │ • [4mval3 [0m[1;4m← (default)[0m │
|
||||||
└───────────────────────────────────────┴──────────────────────────────────────┘
|
└───────────────────────────────────────┴──────────────────────────────────────┘
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -4,7 +4,7 @@
|
||||||
|====
|
|====
|
||||||
| Variable | Description
|
| Variable | Description
|
||||||
| **var1** +
|
| **var1** +
|
||||||
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` `mandatory` `unique` `multiple` | First variable. +
|
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `multiple` `standard` `mandatory` `unique` | First variable. +
|
||||||
**Choices**:
|
**Choices**:
|
||||||
|
|
||||||
* val1 +++← (default)+++
|
* val1 +++← (default)+++
|
||||||
|
|
|
||||||
|
|
@ -1,8 +1,8 @@
|
||||||
<details><summary>Modified variable</summary>
|
<details><summary>Modified variable</summary>
|
||||||
|
|
||||||
| Variable | Description |
|
| Variable | Description |
|
||||||
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------|
|
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
| **<a id="var1" name="var1">var1</a>**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | First variable.<br/>**Choices**: <br/>• val1 ~~← (default)~~<br/>• val2 **← (default)**<br/>• val3 <ins>**← (default)**</ins> |
|
| **<a id="var1" name="var1">var1</a>**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` `standard` `mandatory` `unique` | First variable.<br/>**Choices**: <br/>• val1 ~~← (default)~~<br/>• val2 **← (default)**<br/>• val3 <ins>**← (default)**</ins> |
|
||||||
|
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -5,7 +5,7 @@
|
||||||
<tr><th>Variable </th><th>Description </th></tr>
|
<tr><th>Variable </th><th>Description </th></tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr><td><b>var1</b><br/><mark><a href='https://rougail.readthedocs.io/en/latest/variable.html#variables-types'>choice</a></mark> <mark>standard</mark> <mark>mandatory</mark> <mark>unique</mark> <mark>multiple</mark></td><td>First variable.<br/><b>Choices</b>: <ul><li>val1 <del>← (default)</del></li>
|
<tr><td><b>var1</b><br/><mark><a href='https://rougail.readthedocs.io/en/latest/variable.html#variables-types'>choice</a></mark> <mark>multiple</mark> <mark>standard</mark> <mark>mandatory</mark> <mark>unique</mark></td><td>First variable.<br/><b>Choices</b>: <ul><li>val1 <del>← (default)</del></li>
|
||||||
<li>val2 <b>← (default)</b></li>
|
<li>val2 <b>← (default)</b></li>
|
||||||
<li>val3 <ins><b>← (default)</b></ins></li></ul> </td></tr>
|
<li>val3 <ins><b>← (default)</b></ins></li></ul> </td></tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,6 @@
|
||||||
# Modified variable
|
# Modified variable
|
||||||
|
|
||||||
| Variable | Description |
|
| Variable | Description |
|
||||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
| **<a id="var1" name="var1">var1</a>**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | First variable.<br/>**Choices**: <br/>• val1 ~~← (default)~~<br/>• val2 **← (default)**<br/>• val3 <ins>**← (default)**</ins> |
|
| **<a id="var1" name="var1">var1</a>**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` `standard` `mandatory` `unique` | First variable.<br/>**Choices**: <br/>• val1 ~~← (default)~~<br/>• val2 **← (default)**<br/>• val3 <ins>**← (default)**</ins> |
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -4,9 +4,9 @@
|
||||||
┃[1m [0m[1mVariable [0m[1m [0m┃[1m [0m[1mDescription [0m[1m [0m┃
|
┃[1m [0m[1mVariable [0m[1m [0m┃[1m [0m[1mDescription [0m[1m [0m┃
|
||||||
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
|
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
|
||||||
│ [1mvar1[0m │ First variable. │
|
│ [1mvar1[0m │ First variable. │
|
||||||
│ [1;7m choice [0m [1;7m standard [0m [1;7m mandatory [0m [1;7m [0m │ [1mChoices[0m: │
|
│ [1;7m choice [0m [1;7m multiple [0m [1;7m standard [0m [1;7m [0m │ [1mChoices[0m: │
|
||||||
│ [1;7munique [0m [1;7m multiple [0m │ • val1 [9m← (default)[0m │
|
│ [1;7mmandatory [0m [1;7m unique [0m │ • val1 [9m← (default)[0m │
|
||||||
│ │ • val2 [1m← (default)[0m │
|
│ │ • val2 [1m← (default)[0m │
|
||||||
│ │ • val3 [1;4m← (default)[0m │
|
│ │ • val3 [1;4m← (default)[0m │
|
||||||
└───────────────────────────────────────┴──────────────────────────────────────┘
|
└───────────────────────────────────────┴──────────────────────────────────────┘
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,8 +1,8 @@
|
||||||
<details><summary>Modified variable</summary>
|
<details><summary>Modified variable</summary>
|
||||||
|
|
||||||
| Variable | Description |
|
| Variable | Description |
|
||||||
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
| **<a id="my_variable" name="my_variable">my_variable</a>**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.<br/>**Choices**: <br/>• ~~val1~~<br/>• ~~val2~~<br/>• the value of the variable "[The first source variable](#source_variable_1)"<br/>• the value of the variable "[The second source variable](#source_variable_2)"<br/>**Default**: val1 |
|
| **<a id="my_variable" name="my_variable">my_variable</a>**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.<br/>**Choices**: <br/>• ~~val1~~<br/>• ~~val2~~<br/>• the value of the variable "[The first source variable](#source_variable_1)"<br/>• the value of the variable "[The second source variable](#source_variable_2)"<br/>**Default**: val1 |
|
||||||
|
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,6 @@
|
||||||
# Modified variable
|
# Modified variable
|
||||||
|
|
||||||
| Variable | Description |
|
| Variable | Description |
|
||||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
| **<a id="my_variable" name="my_variable">my_variable</a>**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.<br/>**Choices**: <br/>• ~~val1~~<br/>• ~~val2~~<br/>• the value of the variable "[The first source variable](#source_variable_1)"<br/>• the value of the variable "[The second source variable](#source_variable_2)"<br/>**Default**: val1 |
|
| **<a id="my_variable" name="my_variable">my_variable</a>**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.<br/>**Choices**: <br/>• ~~val1~~<br/>• ~~val2~~<br/>• the value of the variable "[The first source variable](#source_variable_1)"<br/>• the value of the variable "[The second source variable](#source_variable_2)"<br/>**Default**: val1 |
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -5,11 +5,11 @@
|
||||||
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
|
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
|
||||||
│ [1mmy_variable[0m │ A variable. │
|
│ [1mmy_variable[0m │ A variable. │
|
||||||
│ [1;7m choice [0m [1;7m standard [0m [1;7m mandatory [0m │ [1mChoices[0m: │
|
│ [1;7m choice [0m [1;7m standard [0m [1;7m mandatory [0m │ [1mChoices[0m: │
|
||||||
│ │ • [9mval1[0m │
|
│ │ • [9mval1[0m │
|
||||||
│ │ • [9mval2[0m │
|
│ │ • [9mval2[0m │
|
||||||
│ │ • the value of the variable │
|
│ │ • the value of the variable │
|
||||||
│ │ "source_variable_1" │
|
│ │ "source_variable_1" │
|
||||||
│ │ • the value of the variable │
|
│ │ • the value of the variable │
|
||||||
│ │ "source_variable_2" │
|
│ │ "source_variable_2" │
|
||||||
│ │ [1mDefault[0m: val1 │
|
│ │ [1mDefault[0m: val1 │
|
||||||
└───────────────────────────────────────┴──────────────────────────────────────┘
|
└───────────────────────────────────────┴──────────────────────────────────────┘
|
||||||
|
|
|
||||||
|
|
@ -4,7 +4,7 @@
|
||||||
|====
|
|====
|
||||||
| Variable | Description
|
| Variable | Description
|
||||||
| **variable_1** +
|
| **variable_1** +
|
||||||
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | The first variable. +
|
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `multiple` `standard` `mandatory` `unique` | The first variable. +
|
||||||
**Default**:
|
**Default**:
|
||||||
|
|
||||||
* +++val1+++
|
* +++val1+++
|
||||||
|
|
|
||||||
|
|
@ -1,9 +1,9 @@
|
||||||
<details><summary>Modified variables</summary>
|
<details><summary>Modified variables</summary>
|
||||||
|
|
||||||
| Variable | Description |
|
| Variable | Description |
|
||||||
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------|
|
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------|
|
||||||
| **<a id="variable_1" name="variable_1">variable_1</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The first variable.<br/>**Default**: <br/>• ~~val1~~<br/>• val2<br/>• <ins>val3</ins> |
|
| **<a id="variable_1" name="variable_1">variable_1</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` `standard` `mandatory` `unique` | The first variable.<br/>**Default**: <br/>• ~~val1~~<br/>• val2<br/>• <ins>val3</ins> |
|
||||||
| **<a id="variable_2" name="variable_2">variable_2</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The second variable.<br/>**Default**: ~~val1~~<br/><ins>val2</ins> |
|
| **<a id="variable_2" name="variable_2">variable_2</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The second variable.<br/>**Default**: ~~val1~~<br/><ins>val2</ins> |
|
||||||
|
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -5,7 +5,7 @@
|
||||||
<tr><th>Variable </th><th>Description </th></tr>
|
<tr><th>Variable </th><th>Description </th></tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr><td><b>variable_1</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>The first variable.<br/><b>Default</b>: <ul><li><del>val1</del></li>
|
<tr><td><b>variable_1</b><br/><mark><a href='https://rougail.readthedocs.io/en/latest/variable.html#variables-types'>string</a></mark> <mark>multiple</mark> <mark>standard</mark> <mark>mandatory</mark> <mark>unique</mark></td><td>The first variable.<br/><b>Default</b>: <ul><li><del>val1</del></li>
|
||||||
<li>val2</li>
|
<li>val2</li>
|
||||||
<li><ins>val3</ins></li></ul> </td></tr>
|
<li><ins>val3</ins></li></ul> </td></tr>
|
||||||
<tr><td><b>variable_2</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>The second variable.<br/><b>Default</b>: <del>val1</del><br/><ins>val2</ins></td></tr>
|
<tr><td><b>variable_2</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>The second variable.<br/><b>Default</b>: <del>val1</del><br/><ins>val2</ins></td></tr>
|
||||||
|
|
|
||||||
|
|
@ -1,7 +1,7 @@
|
||||||
# Modified variables
|
# Modified variables
|
||||||
|
|
||||||
| Variable | Description |
|
| Variable | Description |
|
||||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------|
|
||||||
| **<a id="variable_1" name="variable_1">variable_1</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The first variable.<br/>**Default**: <br/>• ~~val1~~<br/>• val2<br/>• <ins>val3</ins> |
|
| **<a id="variable_1" name="variable_1">variable_1</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` `standard` `mandatory` `unique` | The first variable.<br/>**Default**: <br/>• ~~val1~~<br/>• val2<br/>• <ins>val3</ins> |
|
||||||
| **<a id="variable_2" name="variable_2">variable_2</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The second variable.<br/>**Default**: ~~val1~~<br/><ins>val2</ins> |
|
| **<a id="variable_2" name="variable_2">variable_2</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The second variable.<br/>**Default**: ~~val1~~<br/><ins>val2</ins> |
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -4,10 +4,10 @@
|
||||||
┃[1m [0m[1mVariable [0m[1m [0m┃[1m [0m[1mDescription [0m[1m [0m┃
|
┃[1m [0m[1mVariable [0m[1m [0m┃[1m [0m[1mDescription [0m[1m [0m┃
|
||||||
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
|
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
|
||||||
│ [1mvariable_1[0m │ The first variable. │
|
│ [1mvariable_1[0m │ The first variable. │
|
||||||
│ [1;7m string [0m [1;7m standard [0m [1;7m mandatory [0m [1;7m [0m │ [1mDefault[0m: │
|
│ [1;7m string [0m [1;7m multiple [0m [1;7m standard [0m [1;7m [0m │ [1mDefault[0m: │
|
||||||
│ [1;7munique [0m [1;7m multiple [0m │ • [9mval1[0m │
|
│ [1;7mmandatory [0m [1;7m unique [0m │ • [9mval1[0m │
|
||||||
│ │ • val2 │
|
│ │ • val2 │
|
||||||
│ │ • [4mval3[0m │
|
│ │ • [4mval3[0m │
|
||||||
├───────────────────────────────────────┼──────────────────────────────────────┤
|
├───────────────────────────────────────┼──────────────────────────────────────┤
|
||||||
│ [1mvariable_2[0m │ The second variable. │
|
│ [1mvariable_2[0m │ The second variable. │
|
||||||
│ [1;7m string [0m [1;7m standard [0m [1;7m mandatory [0m │ [1mDefault[0m: [9mval1[0m │
|
│ [1;7m string [0m [1;7m standard [0m [1;7m mandatory [0m │ [1mDefault[0m: [9mval1[0m │
|
||||||
|
|
|
||||||
|
|
@ -4,10 +4,10 @@
|
||||||
|====
|
|====
|
||||||
| Variable | Description
|
| Variable | Description
|
||||||
| **variable_1** +
|
| **variable_1** +
|
||||||
`+++unique+++` `+++multiple+++` `https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | The first variable. +
|
`+++unique+++` `https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | The first variable. +
|
||||||
**Default**: val1
|
**Default**: val1
|
||||||
| **variable_2** +
|
| **variable_2** +
|
||||||
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `#unique#` `#multiple#` | The second variable. +
|
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `multiple` `standard` `mandatory` `#unique#` | The second variable. +
|
||||||
**Default**:
|
**Default**:
|
||||||
|
|
||||||
* val1
|
* val1
|
||||||
|
|
|
||||||
|
|
@ -1,9 +1,9 @@
|
||||||
<details><summary>Modified variables</summary>
|
<details><summary>Modified variables</summary>
|
||||||
|
|
||||||
| Variable | Description |
|
| Variable | Description |
|
||||||
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------|
|
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------|
|
||||||
| **<a id="variable_1" name="variable_1">variable_1</a>**<br/>~~`unique`~~ ~~`multiple`~~ [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The first variable.<br/>**Default**: val1 |
|
| **<a id="variable_1" name="variable_1">variable_1</a>**<br/>~~`unique`~~ [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The first variable.<br/>**Default**: val1 |
|
||||||
| **<a id="variable_2" name="variable_2">variable_2</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` <ins>`unique`</ins> <ins>`multiple`</ins> | The second variable.<br/>**Default**: <br/>• val1 |
|
| **<a id="variable_2" name="variable_2">variable_2</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` `standard` `mandatory` <ins>`unique`</ins> | The second variable.<br/>**Default**: <br/>• val1 |
|
||||||
|
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,11 +2,11 @@
|
||||||
|
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr><th>Variable </th><th>Description </th></tr>
|
<tr><th>Variable </th><th>Description </th></tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr><td><b>variable_1</b><br/><mark><del>unique</del></mark> <mark><del>multiple</del></mark> <mark><a href='https://rougail.readthedocs.io/en/latest/variable.html#variables-types'>string</a></mark> <mark>standard</mark> <mark>mandatory</mark></td><td>The first variable.<br/><b>Default</b>: val1 </td></tr>
|
<tr><td><b>variable_1</b><br/><mark><del>unique</del></mark> <mark><a href='https://rougail.readthedocs.io/en/latest/variable.html#variables-types'>string</a></mark> <mark>standard</mark> <mark>mandatory</mark> </td><td>The first variable.<br/><b>Default</b>: val1 </td></tr>
|
||||||
<tr><td><b>variable_2</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><ins>unique</ins></mark> <mark><ins>multiple</ins></mark></td><td>The second variable.<br/><b>Default</b>: <ul><li>val1</li></ul></td></tr>
|
<tr><td><b>variable_2</b><br/><mark><a href='https://rougail.readthedocs.io/en/latest/variable.html#variables-types'>string</a></mark> <mark>multiple</mark> <mark>standard</mark> <mark>mandatory</mark> <mark><ins>unique</ins></mark></td><td>The second variable.<br/><b>Default</b>: <ul><li>val1</li></ul></td></tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,7 +1,7 @@
|
||||||
# Modified variables
|
# Modified variables
|
||||||
|
|
||||||
| Variable | Description |
|
| Variable | Description |
|
||||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------|
|
||||||
| **<a id="variable_1" name="variable_1">variable_1</a>**<br/>~~`unique`~~ ~~`multiple`~~ [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The first variable.<br/>**Default**: val1 |
|
| **<a id="variable_1" name="variable_1">variable_1</a>**<br/>~~`unique`~~ [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The first variable.<br/>**Default**: val1 |
|
||||||
| **<a id="variable_2" name="variable_2">variable_2</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` <ins>`unique`</ins> <ins>`multiple`</ins> | The second variable.<br/>**Default**: <br/>• val1 |
|
| **<a id="variable_2" name="variable_2">variable_2</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` `standard` `mandatory` <ins>`unique`</ins> | The second variable.<br/>**Default**: <br/>• val1 |
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -4,11 +4,11 @@
|
||||||
┃[1m [0m[1mVariable [0m[1m [0m┃[1m [0m[1mDescription [0m[1m [0m┃
|
┃[1m [0m[1mVariable [0m[1m [0m┃[1m [0m[1mDescription [0m[1m [0m┃
|
||||||
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
|
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
|
||||||
│ [1mvariable_1[0m │ The first variable. │
|
│ [1mvariable_1[0m │ The first variable. │
|
||||||
│ [1;7m [0m[1;7;9munique[0m[1;7m [0m [1;7m [0m[1;7;9mmultiple[0m[1;7m [0m [1;7m string [0m [1;7m [0m │ [1mDefault[0m: val1 │
|
│ [1;7m [0m[1;7;9munique[0m[1;7m [0m [1;7m string [0m [1;7m standard [0m [1;7m [0m │ [1mDefault[0m: val1 │
|
||||||
│ [1;7mstandard [0m [1;7m mandatory [0m │ │
|
│ [1;7mmandatory [0m │ │
|
||||||
├───────────────────────────────────────┼──────────────────────────────────────┤
|
├───────────────────────────────────────┼──────────────────────────────────────┤
|
||||||
│ [1mvariable_2[0m │ The second variable. │
|
│ [1mvariable_2[0m │ The second variable. │
|
||||||
│ [1;7m string [0m [1;7m standard [0m [1;7m mandatory [0m [1;7m [0m │ [1mDefault[0m: │
|
│ [1;7m string [0m [1;7m multiple [0m [1;7m standard [0m [1;7m [0m │ [1mDefault[0m: │
|
||||||
│ [1;4;7munique[0m[1;7m [0m [1;7m [0m[1;4;7mmultiple[0m[1;7m [0m │ • val1 │
|
│ [1;7mmandatory [0m [1;7m [0m[1;4;7munique[0m[1;7m [0m │ • val1 │
|
||||||
└───────────────────────────────────────┴──────────────────────────────────────┘
|
└───────────────────────────────────────┴──────────────────────────────────────┘
|
||||||
|
|
||||||
|
|
|
||||||
Some files were not shown because too many files have changed in this diff Show more
Loading…
Reference in a new issue