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

feat: add dot if needed

Browse source
This commit is contained in:
egarette@silique.fr 2026-03-29 12:42:01 +02:00
parent d76e676d4e
commit f9d3428bf3
4396 changed files with 14246 additions and 11605 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

30
README.fr.md
View file

@ -11,16 +11,16 @@ include_toc: true
> 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.\ > 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\ > **Chemin** : doc\
> *`désactivé`*\ > *`désactivé`*\
> **Désactivé** : si "[Sélection pour sortie](#step.output)" n'est pas doc > **Désactivé** : si "[sélection pour sortie](#step.output)" n'est pas doc.
| Variable | Description | Valeur par défaut | Type | Contrôle des accès | Validateur | | 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** : <br/>-do, --doc.output_format<br/>**Variable d'environnement** : 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/>•&nbsp;console<br/>•&nbsp;asciidoc<br/>•&nbsp;html<br/>•&nbsp;github<br/>•&nbsp;gitlab<br/>•&nbsp;json | | **<a id="doc.output_format" name="doc.output_format">doc.output_format</a>**<br/>**Ligne de commande** : <br/>-do, --doc.output_format<br/>**Variable d'environnement** : 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/>•&nbsp;console<br/>•&nbsp;asciidoc<br/>•&nbsp;html<br/>•&nbsp;github<br/>•&nbsp;gitlab<br/>•&nbsp;json |
| **<a id="doc.tabular_template" name="doc.tabular_template">doc.tabular_template</a>**<br/>**Ligne de commande** : <br/>-dm, --doc.tabular_template<br/>**Variable d'environnement** : 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/>•&nbsp;two_columns<br/>•&nbsp;three_columns<br/>•&nbsp;four_columns<br/>•&nbsp;five_columns<br/>•&nbsp;six_columns | | **<a id="doc.tabular_template" name="doc.tabular_template">doc.tabular_template</a>**<br/>**Ligne de commande** : <br/>-dm, --doc.tabular_template<br/>**Variable d'environnement** : 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)" json n\'est pas compatible avec cette variable. | **Choix** : <br/>•&nbsp;two_columns<br/>•&nbsp;three_columns<br/>•&nbsp;four_columns<br/>•&nbsp;five_columns<br/>•&nbsp;six_columns |
| **<a id="doc.contents" name="doc.contents">doc.contents</a>**<br/>**Ligne de commande** : <br/>-dc, --doc.contents<br/>**Variable d'environnement** : DOC.CONTENTS | Contenu généré.<br/>Vous pouvez générer trois type de documentation. Toutes les variables (&quot;variables&quot;), un exemple de fichier au format YAML (&quot;example&quot;) ou le journal des changements (&quot;changelog&quot;). | •&nbsp;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/>•&nbsp;variables<br/>•&nbsp;example<br/>•&nbsp;changelog | | **<a id="doc.contents" name="doc.contents">doc.contents</a>**<br/>**Ligne de commande** : <br/>-dc, --doc.contents<br/>**Variable d'environnement** : DOC.CONTENTS | Contenu généré.<br/>Vous pouvez générer trois type de documentation. Toutes les variables (&quot;variables&quot;), un exemple de fichier au format YAML (&quot;example&quot;) ou le journal des changements (&quot;changelog&quot;). | •&nbsp;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)" json n'est pas compatible avec le "[contenu généré](#doc.contents)" changelog ou example. | `unique`<br/>**Choix** : <br/>•&nbsp;variables<br/>•&nbsp;example<br/>•&nbsp;changelog |
| **<a id="doc.title_level" name="doc.title_level">doc.title_level</a>**<br/>**Ligne de commande** : <br/>-dt, --doc.title_level<br/>**Variable d'environnement** : 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.title_level" name="doc.title_level">doc.title_level</a>**<br/>**Ligne de commande** : <br/>-dt, --doc.title_level<br/>**Variable d'environnement** : 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/>•&nbsp;--doc.default_values<br/>•&nbsp;--doc.no-default_values<br/>**Variable d'environnement** : 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.default_values" name="doc.default_values">doc.default_values</a>**<br/>**Ligne de commande** : <br/>•&nbsp;--doc.default_values<br/>•&nbsp;--doc.no-default_values<br/>**Variable d'environnement** : 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/>•&nbsp;--doc.true_color<br/>•&nbsp;--doc.no-true_color<br/>**Variable d'environnement** : 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.true_color" name="doc.true_color">doc.true_color</a>**<br/>**Ligne de commande** : <br/>•&nbsp;--doc.true_color<br/>•&nbsp;--doc.no-true_color<br/>**Variable d'environnement** : 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". | |
### Les variables pour cette famille sont documentés dans un autre fichier ### Les variables pour cette famille sont documentés dans un autre fichier
@ -36,8 +36,8 @@ include_toc: true
| **<a id="doc.other_root_filenames.filename" name="doc.other_root_filenames.filename">doc.other_root_filenames.filename</a>**<br/>**Ligne de commande** : <br/>--doc.other_root_filenames.filename<br/>**Variable d'environnement** : DOC.OTHER_ROOT_FILENAMES.FILENAME | Nom du fichier. | [`UNIX filename`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | •&nbsp;le nom de fichier peut être une chemin relatif<br/>•&nbsp;type de fichier autorisé: "file". | | **<a id="doc.other_root_filenames.filename" name="doc.other_root_filenames.filename">doc.other_root_filenames.filename</a>**<br/>**Ligne de commande** : <br/>--doc.other_root_filenames.filename<br/>**Variable d'environnement** : DOC.OTHER_ROOT_FILENAMES.FILENAME | Nom du fichier. | [`UNIX filename`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | •&nbsp;le nom de fichier peut être une chemin relatif<br/>•&nbsp;type de fichier autorisé: "file". |
| Variable | Description | Valeur par défaut | Type | | Variable | Description | Valeur par défaut | Type |
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------|---------------------|---------------------------------------------------------------------------------------------------| |---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------|---------------------|---------------------------------------------------------------------------------------------------|
| **<a id="doc.document_a_type" name="doc.document_a_type">doc.document_a_type</a>**<br/>**Ligne de commande** : <br/>•&nbsp;--doc.document_a_type<br/>•&nbsp;--doc.no-document_a_type<br/>**Variable d'environnement** : DOC.DOCUMENT_A_TYPE | Documenter type de structure. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | | **<a id="doc.document_a_type" name="doc.document_a_type">doc.document_a_type</a>**<br/>**Ligne de commande** : <br/>•&nbsp;--doc.document_a_type<br/>•&nbsp;--doc.no-document_a_type<br/>**Variable d'environnement** : DOC.DOCUMENT_A_TYPE | Documenter un type de structure. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` |
### Documentation des variables et journal de changements ### Documentation des variables et journal de changements
@ -45,14 +45,14 @@ include_toc: true
> >
> **Chemin** : doc.tabulars\ > **Chemin** : doc.tabulars\
> *`désactivé`*\ > *`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 > **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 | | 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/>•&nbsp;-df, --doc.tabulars.without_family<br/>•&nbsp;-ndf, --doc.tabulars.no-without_family<br/>**Variable d'environnement** : 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.without_family" name="doc.tabulars.without_family">doc.tabulars.without_family</a>**<br/>**Ligne de commande** : <br/>•&nbsp;-df, --doc.tabulars.without_family<br/>•&nbsp;-ndf, --doc.tabulars.no-without_family<br/>**Variable d'environnement** : 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/>•&nbsp;-dw, --doc.tabulars.with_commandline<br/>•&nbsp;-ndw, --doc.tabulars.no-with_commandline<br/>**Variable d'environnement** : 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_commandline" name="doc.tabulars.with_commandline">doc.tabulars.with_commandline</a>**<br/>**Variable d'environnement** : DOC.TABULARS.WITH_COMMANDLINE | Add command line informations in 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/>•&nbsp;-de, --doc.tabulars.with_environment<br/>•&nbsp;-nde, --doc.tabulars.no-with_environment<br/>**Variable d'environnement** : DOC.TABULARS.WITH_ENVIRONMENT | Ajoute les informations de variable d&#x27;environnement 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/>•&nbsp;-de, --doc.tabulars.with_environment<br/>•&nbsp;-nde, --doc.tabulars.no-with_environment<br/>**Variable d'environnement** : DOC.TABULARS.WITH_ENVIRONMENT | Ajoute les informations de variable d&#x27;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** : <br/>-dv, --doc.tabulars.environment_prefix<br/>**Variable d'environnement** : DOC.TABULARS.ENVIRONMENT_PREFIX | Préfixe du nom des variables d&#x27;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&#x27;environnement dans la documentation](#doc.tabulars.with_environment)" est false | Doit seulement utilise des caractères en majuscule. | | **<a id="doc.tabulars.environment_prefix" name="doc.tabulars.environment_prefix">doc.tabulars.environment_prefix</a>**<br/>**Ligne de commande** : <br/>-dv, --doc.tabulars.environment_prefix<br/>**Variable d'environnement** : DOC.TABULARS.ENVIRONMENT_PREFIX | Préfixe du nom des variables d&#x27;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&#x27;environnement dans la documentation](#doc.tabulars.with_environment)" est false. | Doit seulement utilise des caractères en majuscule. |
### Documentation du journal des changements ### Documentation du journal des changements
@ -60,7 +60,7 @@ include_toc: true
> >
> **Chemin** : doc.changelog\ > **Chemin** : doc.changelog\
> *`désactivé`*\ > *`désactivé`*\
> **Désactivé** : changelog n'est pas défini dans "[Contenu généré](#doc.contents)" > **Désactivé** : changelog n'est pas défini dans "[contenu généré](#doc.contents)".
| Variable | Description | Type | | Variable | Description | Type |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------| |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------|
@ -72,11 +72,11 @@ include_toc: true
> >
> **Chemin** : doc.examples\ > **Chemin** : doc.examples\
> *`désactivé`*\ > *`désactivé`*\
> **Désactivé** : si example n'est pas défini dans "[Contenu généré](#doc.contents)" > **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 | | 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/>•&nbsp;-dx, --doc.examples.comment<br/>•&nbsp;-ndx, --doc.examples.no-comment<br/>**Variable d'environnement** : DOC.EXAMPLES.COMMENT | Ajouter la description des variables et des familles lorsqu&#x27;on génère des exemples. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | | | **<a id="doc.examples.comment" name="doc.examples.comment">doc.examples.comment</a>**<br/>**Ligne de commande** : <br/>•&nbsp;-dx, --doc.examples.comment<br/>•&nbsp;-ndx, --doc.examples.no-comment<br/>**Variable d'environnement** : DOC.EXAMPLES.COMMENT | Ajouter la description des variables et des familles lorsqu&#x27;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** : <br/>--doc.examples.comment_column<br/>**Variable d'environnement** : 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&#x27;on génère des exemples](#doc.examples.comment)" a la valeur "false" | | **<a id="doc.examples.comment_column" name="doc.examples.comment_column">doc.examples.comment_column</a>**<br/>**Ligne de commande** : <br/>--doc.examples.comment_column<br/>**Variable d'environnement** : 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&#x27;on génère des exemples](#doc.examples.comment)" a la valeur "false". |

26
README.md
View file

@ -11,16 +11,16 @@ include_toc: true
> The structural files contain all the information related to the variables. This output generates the documentation for all or some of these variables.\ > The structural files contain all the information related to the variables. This output generates the documentation for all or some of these variables.\
> **Path**: doc\ > **Path**: doc\
> *`disabled`*\ > *`disabled`*\
> **Disabled**: if "[Select for output](#step.output)" is not doc > **Disabled**: if "[select for output](#step.output)" is not doc.
| Variable | Description | Default value | Type | Access control | Validator | | Variable | Description | Default value | Type | Access control | Validator |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------|-----------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------| |----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------|-----------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------|
| **<a id="doc.output_format" name="doc.output_format">doc.output_format</a>**<br/>**Command line**: <br/>-do, --doc.output_format<br/>**Environment variable**: 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/>•&nbsp;console<br/>•&nbsp;asciidoc<br/>•&nbsp;html<br/>•&nbsp;github<br/>•&nbsp;gitlab<br/>•&nbsp;json | | **<a id="doc.output_format" name="doc.output_format">doc.output_format</a>**<br/>**Command line**: <br/>-do, --doc.output_format<br/>**Environment variable**: 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/>•&nbsp;console<br/>•&nbsp;asciidoc<br/>•&nbsp;html<br/>•&nbsp;github<br/>•&nbsp;gitlab<br/>•&nbsp;json |
| **<a id="doc.tabular_template" name="doc.tabular_template">doc.tabular_template</a>**<br/>**Command line**: <br/>-dm, --doc.tabular_template<br/>**Environment variable**: 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/>•&nbsp;two_columns<br/>•&nbsp;three_columns<br/>•&nbsp;four_columns<br/>•&nbsp;five_columns<br/>•&nbsp;six_columns | | **<a id="doc.tabular_template" name="doc.tabular_template">doc.tabular_template</a>**<br/>**Command line**: <br/>-dm, --doc.tabular_template<br/>**Environment variable**: 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. | **Choices**: <br/>•&nbsp;two_columns<br/>•&nbsp;three_columns<br/>•&nbsp;four_columns<br/>•&nbsp;five_columns<br/>•&nbsp;six_columns |
| **<a id="doc.contents" name="doc.contents">doc.contents</a>**<br/>**Command line**: <br/>-dc, --doc.contents<br/>**Environment variable**: DOC.CONTENTS | Generated content.<br/>You can generate three type of document. All variables (&quot;variables&quot;), an example file in YAML format (&quot;example&quot;) or change log (&quot;changelog&quot;). | •&nbsp;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/>•&nbsp;variables<br/>•&nbsp;example<br/>•&nbsp;changelog | | **<a id="doc.contents" name="doc.contents">doc.contents</a>**<br/>**Command line**: <br/>-dc, --doc.contents<br/>**Environment variable**: DOC.CONTENTS | Generated content.<br/>You can generate three type of document. All variables (&quot;variables&quot;), an example file in YAML format (&quot;example&quot;) or change log (&quot;changelog&quot;). | •&nbsp;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)". | `unique`<br/>**Choices**: <br/>•&nbsp;variables<br/>•&nbsp;example<br/>•&nbsp;changelog |
| **<a id="doc.title_level" name="doc.title_level">doc.title_level</a>**<br/>**Command line**: <br/>-dt, --doc.title_level<br/>**Environment variable**: DOC.TITLE_LEVEL | Starting title level. | 1 | [`integer`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | | | | **<a id="doc.title_level" name="doc.title_level">doc.title_level</a>**<br/>**Command line**: <br/>-dt, --doc.title_level<br/>**Environment variable**: DOC.TITLE_LEVEL | Starting title level. | 1 | [`integer`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | | |
| **<a id="doc.default_values" name="doc.default_values">doc.default_values</a>**<br/>**Command line**: <br/>•&nbsp;--doc.default_values<br/>•&nbsp;--doc.no-default_values<br/>**Environment variable**: 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.default_values" name="doc.default_values">doc.default_values</a>**<br/>**Command line**: <br/>•&nbsp;--doc.default_values<br/>•&nbsp;--doc.no-default_values<br/>**Environment variable**: 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.true_color" name="doc.true_color">doc.true_color</a>**<br/>**Command line**: <br/>•&nbsp;--doc.true_color<br/>•&nbsp;--doc.no-true_color<br/>**Environment variable**: 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.true_color" name="doc.true_color">doc.true_color</a>**<br/>**Command line**: <br/>•&nbsp;--doc.true_color<br/>•&nbsp;--doc.no-true_color<br/>**Environment variable**: 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". | |
### The variables in this family are documented in another file ### The variables in this family are documented in another file
@ -45,14 +45,14 @@ include_toc: true
> >
> **Path**: doc.tabulars\ > **Path**: doc.tabulars\
> *`disabled`*\ > *`disabled`*\
> **Disabled**: if "[The output format of the generated documentation](#doc.output_format)" is json or "[Generated content](#doc.contents)" hasn't variables or changelog > **Disabled**: if "[the output format of the generated documentation](#doc.output_format)" is json or "[generated content](#doc.contents)" hasn't variables or changelog.
| Variable | Description | Default value | Type | Access control | Validator | | 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/>•&nbsp;-df, --doc.tabulars.without_family<br/>•&nbsp;-ndf, --doc.tabulars.no-without_family<br/>**Environment variable**: 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.without_family" name="doc.tabulars.without_family">doc.tabulars.without_family</a>**<br/>**Command line**: <br/>•&nbsp;-df, --doc.tabulars.without_family<br/>•&nbsp;-ndf, --doc.tabulars.no-without_family<br/>**Environment variable**: 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/>•&nbsp;-dw, --doc.tabulars.with_commandline<br/>•&nbsp;-ndw, --doc.tabulars.no-with_commandline<br/>**Environment variable**: 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_commandline" name="doc.tabulars.with_commandline">doc.tabulars.with_commandline</a>**<br/>**Environment variable**: 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/>•&nbsp;-de, --doc.tabulars.with_environment<br/>•&nbsp;-nde, --doc.tabulars.no-with_environment<br/>**Environment variable**: 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.with_environment" name="doc.tabulars.with_environment">doc.tabulars.with_environment</a>**<br/>**Command line**: <br/>•&nbsp;-de, --doc.tabulars.with_environment<br/>•&nbsp;-nde, --doc.tabulars.no-with_environment<br/>**Environment variable**: 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**: <br/>-dv, --doc.tabulars.environment_prefix<br/>**Environment variable**: 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. | | **<a id="doc.tabulars.environment_prefix" name="doc.tabulars.environment_prefix">doc.tabulars.environment_prefix</a>**<br/>**Command line**: <br/>-dv, --doc.tabulars.environment_prefix<br/>**Environment variable**: 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 ### Changelog documentation
@ -60,7 +60,7 @@ include_toc: true
> >
> **Path**: doc.changelog\ > **Path**: doc.changelog\
> *`disabled`*\ > *`disabled`*\
> **Disabled**: if changelog in not in "[Generated content](#doc.contents)" > **Disabled**: if changelog in not in "[generated content](#doc.contents)".
| Variable | Description | Type | | Variable | Description | Type |
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------| |-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------|
@ -72,11 +72,11 @@ include_toc: true
> >
> **Path**: doc.examples\ > **Path**: doc.examples\
> *`disabled`*\ > *`disabled`*\
> **Disabled**: if example is not in "[Generated content](#doc.contents)" > **Disabled**: if example is not in "[generated content](#doc.contents)".
| Variable | Description | Default value | Type | Access control | | Variable | Description | Default value | Type | Access control |
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------|-----------------|-------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------| |---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------|-----------------|-------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **<a id="doc.examples.comment" name="doc.examples.comment">doc.examples.comment</a>**<br/>**Command line**: <br/>•&nbsp;-dx, --doc.examples.comment<br/>•&nbsp;-ndx, --doc.examples.no-comment<br/>**Environment variable**: 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" name="doc.examples.comment">doc.examples.comment</a>**<br/>**Command line**: <br/>•&nbsp;-dx, --doc.examples.comment<br/>•&nbsp;-ndx, --doc.examples.no-comment<br/>**Environment variable**: 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**: <br/>--doc.examples.comment_column<br/>**Environment variable**: 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" | | **<a id="doc.examples.comment_column" name="doc.examples.comment_column">doc.examples.comment_column</a>**<br/>**Command line**: <br/>--doc.examples.comment_column<br/>**Environment variable**: 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". |

126
locale/fr/LC_MESSAGES/rougail_output_doc.po
View file

@ -5,8 +5,8 @@
msgid "" msgid ""
msgstr "" msgstr ""
"Project-Id-Version: \n" "Project-Id-Version: \n"
"POT-Creation-Date: 2026-03-29 10:57+0200\n" "POT-Creation-Date: 2026-03-29 14:58+0200\n"
"PO-Revision-Date: 2026-03-29 10:58+0200\n" "PO-Revision-Date: 2026-03-29 14:58+0200\n"
"Last-Translator: \n" "Last-Translator: \n"
"Language-Team: \n" "Language-Team: \n"
"Language: fr\n" "Language: fr\n"
@ -48,140 +48,140 @@ msgstr ""
"ne peut trouver l'information \"{0}_calculation\", avez-vous annoté cette " "ne peut trouver l'information \"{0}_calculation\", avez-vous annoté cette "
"configuration ?" "configuration ?"
#: src/rougail/output_doc/collect.py:93 #: src/rougail/output_doc/collect.py:94
msgid "the value of the information \"{0}\" of the variable \"{1}\"" msgid "the value of the information \"{0}\" of the variable \"{1}\""
msgstr "la valeur de l'information \"{0}\" de la variable \"{1}\"" msgstr "la valeur de l'information \"{0}\" de la variable \"{1}\""
#: src/rougail/output_doc/collect.py:97 #: src/rougail/output_doc/collect.py:98
msgid "the value of the global information \"{0}\"" msgid "the value of the global information \"{0}\""
msgstr "la valeur de l'information globale \"{0}\"" msgstr "la valeur de l'information globale \"{0}\""
#: src/rougail/output_doc/collect.py:101 #: src/rougail/output_doc/collect.py:102
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/collect.py:108 #: src/rougail/output_doc/collect.py:109
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/collect.py:109 #: src/rougail/output_doc/collect.py:110
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/collect.py:172 #: src/rougail/output_doc/collect.py:173
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/collect.py:190 #: src/rougail/output_doc/collect.py:191
msgid "is \"{0}\"" msgid "is \"{0}\""
msgstr "est \"{0}\"" msgstr "est \"{0}\""
#: src/rougail/output_doc/collect.py:195 #: src/rougail/output_doc/collect.py:196
msgid "is accessible" msgid "is accessible"
msgstr "est accessible" msgstr "est accessible"
#: src/rougail/output_doc/collect.py:197 #: src/rougail/output_doc/collect.py:198
msgid "is defined" msgid "is defined"
msgstr "est définie" msgstr "est définie"
#: src/rougail/output_doc/collect.py:202 #: src/rougail/output_doc/collect.py:203
msgid "hasn't the value \"{0}\"" msgid "hasn't the value \"{0}\""
msgstr "n'a pas la valeur \"{0}\"" msgstr "n'a pas la valeur \"{0}\""
#: src/rougail/output_doc/collect.py:204 #: src/rougail/output_doc/collect.py:205
msgid "has the value \"{0}\"" msgid "has the value \"{0}\""
msgstr "a la valeur \"{0}\"" msgstr "a la valeur \"{0}\""
#: src/rougail/output_doc/collect.py:208 #: src/rougail/output_doc/collect.py:209
msgid "is {0}" msgid "is {0}"
msgstr "est {0}" msgstr "est {0}"
#: src/rougail/output_doc/collect.py:210 #: src/rougail/output_doc/collect.py:211
msgid "when the variable \"{{0}}\" {0}" msgid "when the variable \"{{0}}\" {0}."
msgstr "lorsque la variable \"{{0}}\" {0}" msgstr "lorsque la variable \"{{0}}\" {0}."
#: src/rougail/output_doc/collect.py:237 #: src/rougail/output_doc/collect.py:238
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/collect.py:239 #: src/rougail/output_doc/collect.py:240
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/collect.py:255 #: src/rougail/output_doc/collect.py:256
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/collect.py:261 #: src/rougail/output_doc/collect.py:262
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/collect.py:265 #: src/rougail/output_doc/collect.py:266
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/collect.py:302 #: src/rougail/output_doc/collect.py:303
msgid "when the identifier is \"{0}\"" msgid "when the identifier is \"{0}\""
msgstr "lorsque l'identifiant est \"{0}\"" msgstr "lorsque l'identifiant est \"{0}\""
#: src/rougail/output_doc/collect.py:304 #: src/rougail/output_doc/collect.py:305
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/collect.py:309 #: src/rougail/output_doc/collect.py:310
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/collect.py:396 #: src/rougail/output_doc/collect.py:397
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/collect.py:400 #: src/rougail/output_doc/collect.py:401
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/collect.py:410 #: src/rougail/output_doc/collect.py:411
msgid "This family is a namespace" msgid "This family is a namespace"
msgstr "Cette famille est un espace de nom" msgstr "Cette famille est un espace de nom"
#: src/rougail/output_doc/collect.py:461 #: src/rougail/output_doc/collect.py:462
msgid "Example" msgid "Example"
msgstr "Exemple" msgstr "Exemple"
#: src/rougail/output_doc/collect.py:464 #: src/rougail/output_doc/collect.py:465
msgid "Examples" msgid "Examples"
msgstr "Exemples" msgstr "Exemples"
#: src/rougail/output_doc/collect.py:470 #: src/rougail/output_doc/collect.py:471
msgid "Tag" msgid "Tag"
msgstr "Étiquette" msgstr "Étiquette"
#: src/rougail/output_doc/collect.py:473 #: src/rougail/output_doc/collect.py:474
msgid "Tags" msgid "Tags"
msgstr "Étiquettes" msgstr "Étiquettes"
#: src/rougail/output_doc/collect.py:567 #: src/rougail/output_doc/collect.py:568
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/collect.py:571 #: src/rougail/output_doc/collect.py:572
#: src/rougail/output_doc/tabular/six_columns.py:83 #: src/rougail/output_doc/tabular/six_columns.py:83
msgid "Validator" msgid "Validator"
msgstr "Validateur" msgstr "Validateur"
#: src/rougail/output_doc/collect.py:574 #: src/rougail/output_doc/collect.py:575
msgid "Validators" msgid "Validators"
msgstr "Validateurs" msgstr "Validateurs"
#: src/rougail/output_doc/collect.py:583 #: src/rougail/output_doc/collect.py:584
msgid "Choices" msgid "Choices"
msgstr "Choix" msgstr "Choix"
#: src/rougail/output_doc/collect.py:633 #: src/rougail/output_doc/collect.py:634
msgid "Default" msgid "Default"
msgstr "Défaut" msgstr "Défaut"
#: src/rougail/output_doc/collect.py:643 #: src/rougail/output_doc/collect.py:644
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}"
@ -198,8 +198,8 @@ msgid "is true if doc is activate"
msgstr "est true si doc est activé" msgstr "est true si doc est activé"
#: src/rougail/output_doc/config.py:119 #: src/rougail/output_doc/config.py:119
msgid "Generate documentation from structural files" msgid "generate documentation from structural files"
msgstr "Générer la documentation depuis les fichiers de structure" msgstr "générer la documentation depuis les fichiers de structure"
#: src/rougail/output_doc/config.py:120 #: src/rougail/output_doc/config.py:120
msgid "" msgid ""
@ -215,12 +215,12 @@ msgid "if \"step.output\" is not doc"
msgstr "si \"step.output\" n'est pas doc" msgstr "si \"step.output\" n'est pas doc"
#: src/rougail/output_doc/config.py:128 #: src/rougail/output_doc/config.py:128
msgid "The output format of the generated documentation" msgid "the output format of the generated documentation"
msgstr "Le format de sortie de la documentation générée" msgstr "le format de sortie de la documentation générée"
#: src/rougail/output_doc/config.py:137 #: src/rougail/output_doc/config.py:137
msgid "Generate document with this tabular model" msgid "generate document with this tabular model"
msgstr "Génère la documentation avec ce modèle de tableau" msgstr "génère la documentation avec ce modèle de tableau"
#: src/rougail/output_doc/config.py:138 #: src/rougail/output_doc/config.py:138
msgid "" msgid ""
@ -232,11 +232,11 @@ msgstr ""
#: src/rougail/output_doc/config.py:146 #: src/rougail/output_doc/config.py:146
msgid "\"_.output_format\" in json is not compatible with this variable" msgid "\"_.output_format\" in json is not compatible with this variable"
msgstr "\"_.output_format\" en json n\\'est pas compatible avec cette variable" msgstr "\"_.output_format\" json n\\'est pas compatible avec cette variable"
#: src/rougail/output_doc/config.py:153 #: src/rougail/output_doc/config.py:153
msgid "Generated content" msgid "generated content"
msgstr "Contenu généré" msgstr "contenu généré"
#: src/rougail/output_doc/config.py:154 #: src/rougail/output_doc/config.py:154
msgid "" msgid ""
@ -252,8 +252,8 @@ msgid ""
"\"_.output_format\" in json is not compatible with changelog or example " "\"_.output_format\" in json is not compatible with changelog or example "
"\"_.contents\"" "\"_.contents\""
msgstr "" msgstr ""
"\"_.output_format\" en json n'est pas compatible avec \"_.contents\" " "\"_.output_format\" json n'est pas compatible avec le \"_.contents\" "
"changelog or example" "changelog ou example"
#: src/rougail/output_doc/config.py:170 #: src/rougail/output_doc/config.py:170
msgid "Starting title level" msgid "Starting title level"
@ -304,7 +304,7 @@ msgstr "Nom du fichier"
#: src/rougail/output_doc/config.py:204 #: src/rougail/output_doc/config.py:204
msgid "Documentation a structural type" msgid "Documentation a structural type"
msgstr "Documenter type de structure" msgstr "Documenter un type de structure"
#: src/rougail/output_doc/config.py:208 #: src/rougail/output_doc/config.py:208
msgid "Variables and changelog documentation" msgid "Variables and changelog documentation"
@ -324,12 +324,12 @@ msgstr "Ne pas ajouter les familles dans la documentation"
#: src/rougail/output_doc/config.py:221 #: src/rougail/output_doc/config.py:221
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:226 #: src/rougail/output_doc/config.py:226
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:231 #: src/rougail/output_doc/config.py:231
msgid "Environment variables prefix name" msgid "Environment variables prefix name"
@ -373,9 +373,9 @@ msgid "if example is not in \"_.contents\""
msgstr "si example n'est pas défini dans \"_.contents\"" msgstr "si example n'est pas défini dans \"_.contents\""
#: src/rougail/output_doc/config.py:267 #: src/rougail/output_doc/config.py:267
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:272 #: src/rougail/output_doc/config.py:272
@ -420,29 +420,29 @@ msgstr "Variable"
msgid "Description" msgid "Description"
msgstr "Description" msgstr "Description"
#: src/rougail/output_doc/utils.py:198 #: src/rougail/output_doc/utils.py:204
msgid "Command line" msgid "Command line"
msgstr "Ligne de commande" msgstr "Ligne de commande"
#: src/rougail/output_doc/utils.py:216 #: src/rougail/output_doc/utils.py:222
msgid "Environment variable" msgid "Environment variable"
msgstr "Variable d'environnement" msgstr "Variable d'environnement"
#: src/rougail/output_doc/utils.py:526 #: src/rougail/output_doc/utils.py:532
msgid "Path" msgid "Path"
msgstr "Chemin" msgstr "Chemin"
#: src/rougail/output_doc/utils.py:536 #: src/rougail/output_doc/utils.py:542
msgid "Identifiers" msgid "Identifiers"
msgstr "Identifiants" msgstr "Identifiants"
#: src/rougail/output_doc/utils.py:790 src/rougail/output_doc/utils.py:799 #: src/rougail/output_doc/utils.py:796 src/rougail/output_doc/utils.py:805
#: src/rougail/output_doc/utils.py:805 src/rougail/output_doc/utils.py:811 #: src/rougail/output_doc/utils.py:811 src/rougail/output_doc/utils.py:817
#: src/rougail/output_doc/utils.py:815 #: src/rougail/output_doc/utils.py:821
msgid "(default)" msgid "(default)"
msgstr "(défaut)" msgstr "(défaut)"
#: src/rougail/output_doc/utils.py:1123 #: src/rougail/output_doc/utils.py:1129
msgid "{0}: {1}" msgid "{0}: {1}"
msgstr "{0} : {1}" msgstr "{0} : {1}"

102
locale/rougail_output_doc.pot
View file

@ -5,7 +5,7 @@
msgid "" msgid ""
msgstr "" msgstr ""
"Project-Id-Version: PACKAGE VERSION\n" "Project-Id-Version: PACKAGE VERSION\n"
"POT-Creation-Date: 2026-03-29 10:58+0200\n" "POT-Creation-Date: 2026-03-29 21:13+0200\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"
@ -43,140 +43,140 @@ msgstr ""
msgid "cannot find \"{0}_calculation\" information, do you have annotate this configuration?" msgid "cannot find \"{0}_calculation\" information, do you have annotate this configuration?"
msgstr "" msgstr ""
#: src/rougail/output_doc/collect.py:93 #: src/rougail/output_doc/collect.py:102
msgid "the value of the information \"{0}\" of the variable \"{1}\"" msgid "the value of the information \"{0}\" of the variable \"{1}\""
msgstr "" msgstr ""
#: src/rougail/output_doc/collect.py:97 #: src/rougail/output_doc/collect.py:106
msgid "the value of the global information \"{0}\"" msgid "the value of the global information \"{0}\""
msgstr "" msgstr ""
#: src/rougail/output_doc/collect.py:101 #: src/rougail/output_doc/collect.py:112
msgid "the value of the {0}" msgid "the value of the {0}"
msgstr "" msgstr ""
#: src/rougail/output_doc/collect.py:108 #: src/rougail/output_doc/collect.py:121
msgid "depends on a calculation" msgid "depends on a calculation"
msgstr "" msgstr ""
#: src/rougail/output_doc/collect.py:109 #: src/rougail/output_doc/collect.py:122
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/collect.py:172 #: src/rougail/output_doc/collect.py:185
msgid "depends on an undocumented variable" msgid "depends on an undocumented variable"
msgstr "" msgstr ""
#: src/rougail/output_doc/collect.py:190 #: src/rougail/output_doc/collect.py:203
msgid "is \"{0}\"" msgid "is \"{0}\""
msgstr "" msgstr ""
#: src/rougail/output_doc/collect.py:195 #: src/rougail/output_doc/collect.py:208
msgid "is accessible" msgid "is accessible"
msgstr "" msgstr ""
#: src/rougail/output_doc/collect.py:197 #: src/rougail/output_doc/collect.py:210
msgid "is defined" msgid "is defined"
msgstr "" msgstr ""
#: src/rougail/output_doc/collect.py:202 #: src/rougail/output_doc/collect.py:215
msgid "hasn't the value \"{0}\"" msgid "hasn't the value \"{0}\""
msgstr "" msgstr ""
#: src/rougail/output_doc/collect.py:204 #: src/rougail/output_doc/collect.py:217
msgid "has the value \"{0}\"" msgid "has the value \"{0}\""
msgstr "" msgstr ""
#: src/rougail/output_doc/collect.py:208 #: src/rougail/output_doc/collect.py:221
msgid "is {0}" msgid "is {0}"
msgstr "" msgstr ""
#: src/rougail/output_doc/collect.py:210 #: src/rougail/output_doc/collect.py:223
msgid "when the variable \"{{0}}\" {0}" msgid "when the variable \"{{0}}\" {0}."
msgstr "" msgstr ""
#: src/rougail/output_doc/collect.py:237 #: src/rougail/output_doc/collect.py:250
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/collect.py:239 #: src/rougail/output_doc/collect.py:252
msgid "the value of the variable \"{0}\"" msgid "the value of the variable \"{0}\""
msgstr "" msgstr ""
#: src/rougail/output_doc/collect.py:255 #: src/rougail/output_doc/collect.py:268
msgid "(from an undocumented variable)" msgid "(from an undocumented variable)"
msgstr "" msgstr ""
#: src/rougail/output_doc/collect.py:261 #: src/rougail/output_doc/collect.py:274
msgid "{0} (from an undocumented variable)" msgid "{0} (from an undocumented variable)"
msgstr "" msgstr ""
#: src/rougail/output_doc/collect.py:265 #: src/rougail/output_doc/collect.py:278
msgid "the value of an undocumented variable" msgid "the value of an undocumented variable"
msgstr "" msgstr ""
#: src/rougail/output_doc/collect.py:302 #: src/rougail/output_doc/collect.py:315
msgid "when the identifier is \"{0}\"" msgid "when the identifier is \"{0}\""
msgstr "" msgstr ""
#: src/rougail/output_doc/collect.py:304 #: src/rougail/output_doc/collect.py:317
msgid "when the identifier is not \"{0}\"" msgid "when the identifier is not \"{0}\""
msgstr "" msgstr ""
#: src/rougail/output_doc/collect.py:309 #: src/rougail/output_doc/collect.py:322
msgid "the value of the identifier" msgid "the value of the identifier"
msgstr "" msgstr ""
#: src/rougail/output_doc/collect.py:396 #: src/rougail/output_doc/collect.py:409
msgid "This family contains lists of variable blocks" msgid "This family contains lists of variable blocks"
msgstr "" msgstr ""
#: src/rougail/output_doc/collect.py:400 #: src/rougail/output_doc/collect.py:413
msgid "This family builds families dynamically" msgid "This family builds families dynamically"
msgstr "" msgstr ""
#: src/rougail/output_doc/collect.py:410 #: src/rougail/output_doc/collect.py:423
msgid "This family is a namespace" msgid "This family is a namespace"
msgstr "" msgstr ""
#: src/rougail/output_doc/collect.py:461 #: src/rougail/output_doc/collect.py:474
msgid "Example" msgid "Example"
msgstr "" msgstr ""
#: src/rougail/output_doc/collect.py:464 #: src/rougail/output_doc/collect.py:477
msgid "Examples" msgid "Examples"
msgstr "" msgstr ""
#: src/rougail/output_doc/collect.py:470 #: src/rougail/output_doc/collect.py:483
msgid "Tag" msgid "Tag"
msgstr "" msgstr ""
#: src/rougail/output_doc/collect.py:473 #: src/rougail/output_doc/collect.py:486
msgid "Tags" msgid "Tags"
msgstr "" msgstr ""
#: src/rougail/output_doc/collect.py:567 #: src/rougail/output_doc/collect.py:580
msgid "text based with regular expressions \"{0}\"" msgid "text based with regular expressions \"{0}\""
msgstr "" msgstr ""
#: src/rougail/output_doc/collect.py:571 #: src/rougail/output_doc/collect.py:584
#: src/rougail/output_doc/tabular/six_columns.py:83 #: src/rougail/output_doc/tabular/six_columns.py:83
msgid "Validator" msgid "Validator"
msgstr "" msgstr ""
#: src/rougail/output_doc/collect.py:574 #: src/rougail/output_doc/collect.py:587
msgid "Validators" msgid "Validators"
msgstr "" msgstr ""
#: src/rougail/output_doc/collect.py:583 #: src/rougail/output_doc/collect.py:596
msgid "Choices" msgid "Choices"
msgstr "" msgstr ""
#: src/rougail/output_doc/collect.py:633 #: src/rougail/output_doc/collect.py:646
msgid "Default" msgid "Default"
msgstr "" msgstr ""
#: src/rougail/output_doc/collect.py:643 #: src/rougail/output_doc/collect.py:656
msgid "No attribute \"description\" for \"{0}\" in {1}" msgid "No attribute \"description\" for \"{0}\" in {1}"
msgstr "" msgstr ""
@ -193,7 +193,7 @@ msgid "is true if doc is activate"
msgstr "" msgstr ""
#: src/rougail/output_doc/config.py:119 #: src/rougail/output_doc/config.py:119
msgid "Generate documentation from structural files" msgid "generate documentation from structural files"
msgstr "" msgstr ""
#: src/rougail/output_doc/config.py:120 #: src/rougail/output_doc/config.py:120
@ -205,11 +205,11 @@ msgid "if \"step.output\" is not doc"
msgstr "" msgstr ""
#: src/rougail/output_doc/config.py:128 #: src/rougail/output_doc/config.py:128
msgid "The output format of the generated documentation" msgid "the output format of the generated documentation"
msgstr "" msgstr ""
#: src/rougail/output_doc/config.py:137 #: src/rougail/output_doc/config.py:137
msgid "Generate document with this tabular model" msgid "generate document with this tabular model"
msgstr "" msgstr ""
#: src/rougail/output_doc/config.py:138 #: src/rougail/output_doc/config.py:138
@ -221,7 +221,7 @@ msgid "\"_.output_format\" in json is not compatible with this variable"
msgstr "" msgstr ""
#: src/rougail/output_doc/config.py:153 #: src/rougail/output_doc/config.py:153
msgid "Generated content" msgid "generated content"
msgstr "" msgstr ""
#: src/rougail/output_doc/config.py:154 #: src/rougail/output_doc/config.py:154
@ -281,11 +281,11 @@ msgid "Do not add families in documentation"
msgstr "" msgstr ""
#: src/rougail/output_doc/config.py:221 #: src/rougail/output_doc/config.py:221
msgid "Add command line informations in documentation" msgid "add command line informations in documentation"
msgstr "" msgstr ""
#: src/rougail/output_doc/config.py:226 #: src/rougail/output_doc/config.py:226
msgid "Add environment variable informations in documentation" msgid "add environment variable informations in documentation"
msgstr "" msgstr ""
#: src/rougail/output_doc/config.py:231 #: src/rougail/output_doc/config.py:231
@ -325,7 +325,7 @@ msgid "if example is not in \"_.contents\""
msgstr "" msgstr ""
#: src/rougail/output_doc/config.py:267 #: src/rougail/output_doc/config.py:267
msgid "Add description of variables and families when generate examples" msgid "add description of variables and families when generate examples"
msgstr "" msgstr ""
#: src/rougail/output_doc/config.py:272 #: src/rougail/output_doc/config.py:272
@ -370,29 +370,29 @@ msgstr ""
msgid "Description" msgid "Description"
msgstr "" msgstr ""
#: src/rougail/output_doc/utils.py:198 #: src/rougail/output_doc/utils.py:205
msgid "Command line" msgid "Command line"
msgstr "" msgstr ""
#: src/rougail/output_doc/utils.py:216 #: src/rougail/output_doc/utils.py:223
msgid "Environment variable" msgid "Environment variable"
msgstr "" msgstr ""
#: src/rougail/output_doc/utils.py:526 #: src/rougail/output_doc/utils.py:533
msgid "Path" msgid "Path"
msgstr "" msgstr ""
#: src/rougail/output_doc/utils.py:536 #: src/rougail/output_doc/utils.py:543
msgid "Identifiers" msgid "Identifiers"
msgstr "" msgstr ""
#: src/rougail/output_doc/utils.py:790 src/rougail/output_doc/utils.py:799 #: src/rougail/output_doc/utils.py:797 src/rougail/output_doc/utils.py:806
#: src/rougail/output_doc/utils.py:805 src/rougail/output_doc/utils.py:811 #: src/rougail/output_doc/utils.py:812 src/rougail/output_doc/utils.py:818
#: src/rougail/output_doc/utils.py:815 #: src/rougail/output_doc/utils.py:822
msgid "(default)" msgid "(default)"
msgstr "" msgstr ""
#: src/rougail/output_doc/utils.py:1123 #: src/rougail/output_doc/utils.py:1130
msgid "{0}: {1}" msgid "{0}: {1}"
msgstr "" msgstr ""

51
src/rougail/output_doc/collect.py
View file

@ -25,7 +25,7 @@ from rougail.tiramisu import display_xmlfiles
from rougail.utils import PROPERTY_ATTRIBUTE from rougail.utils import PROPERTY_ATTRIBUTE
from rougail.error import VariableCalculationDependencyError, RougailWarning, ExtensionError from rougail.error import VariableCalculationDependencyError, RougailWarning, ExtensionError
from .utils import dump, to_phrase, calc_path from .utils import dump, to_phrase, calc_path, add_dot
from .i18n import _ from .i18n import _
@ -61,32 +61,41 @@ class _ToString:
if value is not None: if value is not None:
values.append(value) values.append(value)
return values return values
ret = self._calculation_to_string(child, calculation, prop) ret = self._calculation_to_string(child, calculation, prop, inside_list=False)
if isinstance(ret, list) and len(ret) == 1: if isinstance(ret, list) and len(ret) == 1:
return ret[0] return ret[0]
return ret return ret
def _calculation_to_string(self, child, calculation, attribute_type): def _calculation_to_string(self, child, calculation, attribute_type, inside_list=True):
if "description" in calculation: if "description" in calculation:
values = calculation values = calculation
if self.document_a_type and "variables" in values: if self.document_a_type and "variables" in values:
for variable in list(values["variables"]): for variable in list(values["variables"]):
variable["path"] = self.doc_path(variable["path"]) variable["path"] = self.doc_path(variable["path"])
if not inside_list:
values["description"] = add_dot(values["description"])
elif "type" not in calculation: elif "type" not in calculation:
values = calculation["value"] values = calculation["value"]
if isinstance(values, str) and not inside_list:
values = add_dot(values)
elif calculation["type"] == "jinja": elif calculation["type"] == "jinja":
values = self._calculation_jinja_to_string( values = self._calculation_jinja_to_string(
child, calculation, attribute_type child, calculation, attribute_type
) )
if isinstance(values, str) and not inside_list:
values = add_dot(values)
elif calculation["type"] == "variable": elif calculation["type"] == "variable":
values = self._calculation_variable_to_string( values = self._calculation_variable_to_string(
child, calculation, attribute_type child, calculation, attribute_type
) )
if isinstance(values, str) and not inside_list:
values = add_dot(values)
elif calculation["type"] == "identifier": elif calculation["type"] == "identifier":
values = self._calculation_identifier_to_string( values = self._calculation_identifier_to_string(
child, calculation, attribute_type child, calculation, attribute_type
) )
if isinstance(values, str) and not inside_list:
values = add_dot(values)
elif calculation["type"] == "information": elif calculation["type"] == "information":
if "path" in calculation: if "path" in calculation:
variable_path = self.doc_path(calculation["path"]) variable_path = self.doc_path(calculation["path"])
@ -97,8 +106,12 @@ class _ToString:
values = _('the value of the global information "{0}"').format( values = _('the value of the global information "{0}"').format(
calculation["information"] calculation["information"]
) )
if not inside_list:
values = add_dot(values)
else: else:
values = _("the value of the {0}").format(calculation["type"]) values = _("the value of the {0}").format(calculation["type"])
if not inside_list:
values = add_dot(values)
return values return values
def _calculation_jinja_to_string(self, child, calculation, attribute_type): def _calculation_jinja_to_string(self, child, calculation, attribute_type):
@ -146,11 +159,7 @@ class _ToString:
if is_inaccessible: if is_inaccessible:
variables = [[None, None, None]] variables = [[None, None, None]]
else: else:
description = self._convert_description( description = option.description(uncalculated=True)
option.description(uncalculated=True),
"description",
its_a_path=False,
)
variables = [[variable_path, description, None]] variables = [[variable_path, description, None]]
for cpath, description, identifiers in variables: for cpath, description, identifiers in variables:
if not cpath: if not cpath:
@ -207,7 +216,7 @@ class _ToString:
submsg = display_list( submsg = display_list(
[_("is {0}").format(prop), submsg], separator="or", sort=False [_("is {0}").format(prop), submsg], separator="or", sort=False
) )
msg = _('when the variable "{{0}}" {0}').format(submsg) msg = _('when the variable "{{0}}" {0}.').format(submsg)
path_obj = { path_obj = {
"path": self.doc_path(variable_path), "path": self.doc_path(variable_path),
} }
@ -264,9 +273,7 @@ class _ToString:
else: else:
true_msg = _("the value of an undocumented variable") true_msg = _("the value of an undocumented variable")
try: try:
description = self._convert_description( description = child.description(uncalculated=True)
child.description(uncalculated=True), "description", its_a_path=False
)
except AttributeError: except AttributeError:
description = path description = path
return { return {
@ -328,9 +335,7 @@ class _ToString:
all_identifiers = child.identifiers() all_identifiers = child.identifiers()
for identifiers in all_identifiers: for identifiers in all_identifiers:
cpath = calc_path(path, identifiers=identifiers) cpath = calc_path(path, identifiers=identifiers)
description = self._convert_description( description = child.description(uncalculated=True)
child.description(uncalculated=True), "description", its_a_path=False
)
if child.isdynamic(): if child.isdynamic():
yield path, description, identifiers.copy() yield path, description, identifiers.copy()
else: else:
@ -649,20 +654,16 @@ class Collect(_ToString):
RougailWarning, RougailWarning,
) )
if family_type is not None: if family_type is not None:
# it's a vaariable # it's a variable
return self._convert_description( return child.description(uncalculated=True)
child.description(uncalculated=True), "family", its_a_path=True
)
return None return None
var_type = "variable" if family_type is None else "family" var_type = "variable" if family_type is None else "family"
return self._convert_description( return self._convert_description(
child.description(uncalculated=True), var_type, its_a_path=False child.description(uncalculated=True), var_type
) )
def _convert_description(self, description, type_, its_a_path=False): def _convert_description(self, description, type_):
if not its_a_path: return to_phrase(description, type_)
description = to_phrase(description, type_)
return description
def is_inaccessible_user_data(self, child, *, only_disabled=False): def is_inaccessible_user_data(self, child, *, only_disabled=False):
"""If family is not accessible in read_write mode (to load user_data), """If family is not accessible in read_write mode (to load user_data),

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

@ -116,7 +116,7 @@ cli:
description: {_('is true if doc is activate')} description: {_('is true if doc is activate')}
doc: doc:
description: {_('Generate documentation from structural files')} 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.')} 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: |-
@ -125,7 +125,7 @@ doc:
description: {_('if "step.output" is not doc')} description: {_('if "step.output" is not doc')}
output_format: output_format:
description: {_('The output format of the generated documentation')} description: {_('the output format of the generated documentation')}
alternative_name: do alternative_name: do
default: { output_format_default } default: { output_format_default }
choices: choices:
@ -134,7 +134,7 @@ doc:
rougail_options += f" - {output}\n" rougail_options += f" - {output}\n"
rougail_options += f""" rougail_options += f"""
tabular_template: tabular_template:
description: {_('Generate document with this tabular model')} 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.")} help: {_("The variables are documented with a tabular view. A template selection allows you to choose the content of each column.")}
alternative_name: dm alternative_name: dm
default: { tabular_default } default: { tabular_default }
@ -150,7 +150,7 @@ doc:
rougail_options += f" - {tabular}\n" rougail_options += f" - {tabular}\n"
rougail_options += f""" 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").')} 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 alternative_name: dc
choices: choices:
@ -192,13 +192,9 @@ doc:
description: {_("This file contains child variables of the family")} description: {_("This file contains child variables of the family")}
mandatory: false mandatory: false
filename: root_doc_path:
description: {_("Name of the file")} description: {_("Name of the file")}
type: unix_filename mandatory: false
params:
allow_relative: true
types:
- file
document_a_type: document_a_type:
description: {_("Documentation a structural type")} description: {_("Documentation a structural type")}
@ -218,12 +214,12 @@ doc:
alternative_name: df alternative_name: df
with_commandline: with_commandline:
description: {_('Add command line informations in documentation')} description: {_('add command line informations in documentation')}
alternative_name: dw
default: false default: false
commandline: false
with_environment: with_environment:
description: {_('Add environment variable informations in documentation')} description: {_('add environment variable informations in documentation')}
alternative_name: de alternative_name: de
default: false default: false
@ -264,7 +260,7 @@ doc:
description: {_('if example is not in "_.contents"')} description: {_('if example is not in "_.contents"')}
comment: comment:
description: {_('Add description of variables and families when generate examples')} description: {_('add description of variables and families when generate examples')}
alternative_name: dx alternative_name: dx
default: false default: false

BIN
src/rougail/output_doc/locale/fr/LC_MESSAGES/rougail_output_doc.mo
View file

Binary file not shown.

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

@ -61,8 +61,7 @@ def to_phrase(msg, type_="variable"):
msg = str(msg).strip() msg = str(msg).strip()
# a phrase must ends with a dot # a phrase must ends with a dot
if type_ == "variable": if type_ == "variable":
if not msg.endswith("."): msg = add_dot(msg)
msg += "."
elif type_ in ["family", "description"]: elif type_ in ["family", "description"]:
if msg.endswith("."): if msg.endswith("."):
msg = msg[:-1] msg = msg[:-1]
@ -72,6 +71,14 @@ def to_phrase(msg, type_="variable"):
return msg[0].upper() + msg[1:] return msg[0].upper() + msg[1:]
def add_dot(msg):
msg = str(msg).strip()
last_char = msg[-1]
if last_char not in [".", "?", "!", ",", ":", ";"]:
msg += "."
return msg
class CommonTabular: class CommonTabular:
"""Class with common function for tabular""" """Class with common function for tabular"""
@ -275,7 +282,7 @@ class CommonFormatter:
self.rougailconfig["doc.tabulars.environment_prefix"] + "_" self.rougailconfig["doc.tabulars.environment_prefix"] + "_"
) )
self.with_family = not self.rougailconfig["doc.tabulars.without_family"] self.with_family = not self.rougailconfig["doc.tabulars.without_family"]
self.other_root_filenames = None self.other_root_filenames = dict(self.rougailconfig["doc.other_root_filenames"].items())
tabular_template = self.rougailconfig["doc.tabular_template"] tabular_template = self.rougailconfig["doc.tabular_template"]
self.tabular_datas = Tabulars().get()[tabular_template](self) self.tabular_datas = Tabulars().get()[tabular_template](self)
@ -328,7 +335,7 @@ class CommonFormatter:
filename: Optional[str], filename: Optional[str],
) -> str: ) -> str:
"""Set a text link to variable anchor""" """Set a text link to variable anchor"""
return path return description
def stripped( def stripped(
self, self,
@ -590,6 +597,8 @@ class CommonFormatter:
informations: dict, informations: dict,
modified_attributes: dict, modified_attributes: dict,
force_identifiers: Optional[str], force_identifiers: Optional[str],
*,
with_to_phrase: bool=True,
) -> str(): ) -> str():
def _get_description(description, identifiers, delete=False, new=[]): def _get_description(description, identifiers, delete=False, new=[]):
if identifiers and "{{ identifier }}" in description: if identifiers and "{{ identifier }}" in description:
@ -614,9 +623,11 @@ class CommonFormatter:
"{{ identifier }}", self.italic(i[-1]) "{{ identifier }}", self.italic(i[-1])
) )
if new_description not in d: if new_description not in d:
d.append(self.to_phrase(new_description)) if with_to_phrase:
new_description = self.to_phrase(new_description)
d.append(new_description)
description = display_list(d, separator="or") description = display_list(d, separator="or")
else: elif with_to_phrase:
description = self.to_phrase(description) description = self.to_phrase(description)
if description in new: if description in new:
description = self.underline(description) description = self.underline(description)
@ -1045,12 +1056,15 @@ class CommonFormatter:
if path == root or path.startswith(f"{root}."): if path == root or path.startswith(f"{root}."):
filename = self.other_root_filenames[root] filename = self.other_root_filenames[root]
break break
else:
if "." in self.other_root_filenames:
filename = self.other_root_filenames["."]
if "identifiers" in msg["path"]: if "identifiers" in msg["path"]:
msg["identifiers"] = [msg["path"]["identifiers"]] msg["identifiers"] = [msg["path"]["identifiers"]]
path = self.link_variable( path = self.link_variable(
calc_path(msg["path"], formatter=self, identifiers=identifiers), calc_path(msg["path"], formatter=self, identifiers=identifiers),
msg["path"]["path"], msg["path"]["path"],
self.get_description("variable", msg, {}, None), self.get_description("variable", msg, {}, None, with_to_phrase=False),
filename=filename, filename=filename,
) )
msg = msg["message"].format(path) msg = msg["message"].format(path)
@ -1060,11 +1074,14 @@ class CommonFormatter:
for variable in msg["variables"]: for variable in msg["variables"]:
filename = None filename = None
if self.other_root_filenames: if self.other_root_filenames:
path = msg["path"] path = variable["path"]
for root in self.other_root_filenames: for root in self.other_root_filenames:
if path == root or path.startswith(f"{root}."): if path == root or path.startswith(f"{root}."):
filename = self.other_root_filenames[root] filename = self.other_root_filenames[root]
break break
else:
if "." in self.other_root_filenames:
filename = self.other_root_filenames["."]
identifiers = variable.get("identifiers") identifiers = variable.get("identifiers")
path = calc_path( path = calc_path(
variable, formatter=self, identifiers=identifiers variable, formatter=self, identifiers=identifiers
@ -1078,6 +1095,7 @@ class CommonFormatter:
variable, variable,
{}, {},
force_identifiers=identifiers, force_identifiers=identifiers,
with_to_phrase=False,
), ),
filename=filename, filename=filename,
) )

8
tests/changelog/00add_family/result.adoc
View file

@ -5,7 +5,7 @@
| Variable | Description | Variable | Description
| **family2.var2** + | **family2.var2** +
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A variable2. + `https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A variable2. +
**Default**: the value of the variable "family.var2" **Default**: the value of the variable "a second variable"
| **family2.var3** + | **family2.var3** +
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A third variable. + `https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A third variable. +
**Default**: string4 + **Default**: string4 +
@ -14,8 +14,8 @@
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `multiple` `standard` `mandatory` `unique` | 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 "first variable"
* the value of the variable "family.var2" * the value of the variable "a second variable"
* the value of the variable "family2.var3" * the value of the variable "a third variable"
|==== |====

4
tests/changelog/00add_family/result.gitlab.md
View file

@ -2,9 +2,9 @@
| 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) `multiple` `standard` `mandatory` `unique` | Fourth variable.<br/>**Default**: <br/>•&nbsp;the value of the variable "[First variable](#var1)"<br/>•&nbsp;the value of the variable "[A second variable](#family.var2)"<br/>•&nbsp;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/>•&nbsp;the value of the variable "[first variable](#var1)"<br/>•&nbsp;the value of the variable "[a second variable](#family.var2)"<br/>•&nbsp;the value of the variable "[a third variable](#family2.var3)" |
</details> </details>

10
tests/changelog/00add_family/result.html
View file

@ -5,11 +5,11 @@
<tr><th>Variable </th><th>Description </th></tr> <tr><th>Variable </th><th>Description </th></tr>
</thead> </thead>
<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 "a second variable"</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>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> <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 "first variable"</li>
<li>the value of the variable "family.var2"</li> <li>the value of the variable "a second variable"</li>
<li>the value of the variable "family2.var3"</li></ul> </td></tr> <li>the value of the variable "a third variable"</li></ul> </td></tr>
</tbody> </tbody>
</table> </table>

4
tests/changelog/00add_family/result.md
View file

@ -2,7 +2,7 @@
| 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) `multiple` `standard` `mandatory` `unique` | Fourth variable.<br/>**Default**: <br/>•&nbsp;the value of the variable "[First variable](#var1)"<br/>•&nbsp;the value of the variable "[A second variable](#family.var2)"<br/>•&nbsp;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/>•&nbsp;the value of the variable "[first variable](#var1)"<br/>•&nbsp;the value of the variable "[a second variable](#family.var2)"<br/>•&nbsp;the value of the variable "[a third variable](#family2.var3)" |

13
tests/changelog/00add_family/result.sh
View file

@ -5,7 +5,7 @@
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩ ┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
│ family2.var2 │ A variable2. │ │ family2.var2 │ A variable2. │
│  string   standard   mandatory  │ Default: the value of the variable │ │  string   standard   mandatory  │ Default: the value of the variable │
│ │ "family.var2" │ │ │ "a second variable" │
├───────────────────────────────────────┼──────────────────────────────────────┤ ├───────────────────────────────────────┼──────────────────────────────────────┤
│ family2.var3 │ A third variable. │ │ family2.var3 │ A third variable. │
│  string   standard   mandatory  │ Default: string4 │ │  string   standard   mandatory  │ Default: string4 │
@ -13,10 +13,11 @@
├───────────────────────────────────────┼──────────────────────────────────────┤ ├───────────────────────────────────────┼──────────────────────────────────────┤
│ family2.subfamily.variable │ Fourth variable. │ │ family2.subfamily.variable │ Fourth variable. │
│  string   multiple   standard    │ Default: │ │  string   multiple   standard    │ Default: │
│ mandatory   unique  │ • the value of the variable "var1" │ │ mandatory   unique  │ • the value of the variable "first │
│ │ • the value of the variable │ │ │ variable" │
│ │ "family.var2" │ │ │ • the value of the variable "a │
│ │ • the value of the variable │ │ │ second variable" │
│ │ "family2.var3" │ │ │ • the value of the variable "a third │
│ │ variable" │
└───────────────────────────────────────┴──────────────────────────────────────┘ └───────────────────────────────────────┴──────────────────────────────────────┘

4
tests/changelog/11mod_variable_choices10/result.adoc
View file

@ -9,7 +9,7 @@
* +++val1 ← (default)+++ * +++val1 ← (default)+++
* +++val2+++ * +++val2+++
* the value of the variable "source_variable_1" **← (default)** * the value of the variable "the first source variable" **← (default)**
* the value of the variable "source_variable_2" * the value of the variable "the second source variable"
|==== |====

2
tests/changelog/11mod_variable_choices10/result.gitlab.md
View file

@ -2,7 +2,7 @@
| 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/>•&nbsp;~~val1 ← (default)~~<br/>•&nbsp;~~val2~~<br/>•&nbsp;the value of the variable "[The first source variable](#source_variable_1)" **← (default)**<br/>•&nbsp;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/>•&nbsp;~~val1 ← (default)~~<br/>•&nbsp;~~val2~~<br/>•&nbsp;the value of the variable "[the first source variable](#source_variable_1)" **← (default)**<br/>•&nbsp;the value of the variable "[the second source variable](#source_variable_2)" |
</details> </details>

4
tests/changelog/11mod_variable_choices10/result.html
View file

@ -7,8 +7,8 @@
<tbody> <tbody>
<tr><td><b>my_variable</b><br/><mark><a href='https://rougail.readthedocs.io/en/latest/variable.html#variables-types'>choice</a></mark> <mark>standard</mark> <mark>mandatory</mark></td><td>A variable.<br/><b>Choices</b>: <ul><li><del>val1 ← (default)</del></li> <tr><td><b>my_variable</b><br/><mark><a href='https://rougail.readthedocs.io/en/latest/variable.html#variables-types'>choice</a></mark> <mark>standard</mark> <mark>mandatory</mark></td><td>A variable.<br/><b>Choices</b>: <ul><li><del>val1 ← (default)</del></li>
<li><del>val2</del></li> <li><del>val2</del></li>
<li>the value of the variable "source_variable_1" <b>← (default)</b></li> <li>the value of the variable "the first source variable" <b>← (default)</b></li>
<li>the value of the variable "source_variable_2"</li></ul> </td></tr> <li>the value of the variable "the second source variable"</li></ul> </td></tr>
</tbody> </tbody>
</table> </table>

2
tests/changelog/11mod_variable_choices10/result.md
View file

@ -2,5 +2,5 @@
| 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/>•&nbsp;~~val1 ← (default)~~<br/>•&nbsp;~~val2~~<br/>•&nbsp;the value of the variable "[The first source variable](#source_variable_1)" **← (default)**<br/>•&nbsp;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/>•&nbsp;~~val1 ← (default)~~<br/>•&nbsp;~~val2~~<br/>•&nbsp;the value of the variable "[the first source variable](#source_variable_1)" **← (default)**<br/>•&nbsp;the value of the variable "[the second source variable](#source_variable_2)" |

8
tests/changelog/11mod_variable_choices10/result.sh
View file

@ -7,9 +7,9 @@
│  choice   standard   mandatory  │ Choices: │ │  choice   standard   mandatory  │ Choices: │
│ │ • val1 ← (default) │ │ │ • val1 ← (default) │
│ │ • val2 │ │ │ • val2 │
│ │ • the value of the variable │ │ │ • the value of the variable "the │
│ │ "source_variable_1" ← (default) │ │ │ first source variable" ← (default) │
│ │ • the value of the variable │ │ │ • the value of the variable "the │
│ │ "source_variable_2" │ │ │ second source variable" │
└───────────────────────────────────────┴──────────────────────────────────────┘ └───────────────────────────────────────┴──────────────────────────────────────┘

4
tests/changelog/11mod_variable_choices11/result.adoc
View file

@ -7,8 +7,8 @@
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` `mandatory` | A variable. + `https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` `mandatory` | A variable. +
**Choices**: **Choices**:
* +++the value of the variable "source_variable_1"+++ * +++the value of the variable "the first source variable"+++
* +++the value of the variable "source_variable_2"+++ * +++the value of the variable "the second source variable"+++
* '#val1 **← (default)**#' * '#val1 **← (default)**#'
* '#val2#' * '#val2#'
|==== |====

2
tests/changelog/11mod_variable_choices11/result.gitlab.md
View file

@ -2,7 +2,7 @@
| 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/>•&nbsp;~~the value of the variable "[The first source variable](#source_variable_1)"~~<br/>•&nbsp;~~the value of the variable "[The second source variable](#source_variable_2)"~~<br/>•&nbsp;<ins>val1 **← (default)**</ins><br/>•&nbsp;<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/>•&nbsp;~~the value of the variable "[the first source variable](#source_variable_1)"~~<br/>•&nbsp;~~the value of the variable "[the second source variable](#source_variable_2)"~~<br/>•&nbsp;<ins>val1 **← (default)**</ins><br/>•&nbsp;<ins>val2</ins> |
</details> </details>

4
tests/changelog/11mod_variable_choices11/result.html
View file

@ -5,8 +5,8 @@
<tr><th>Variable </th><th>Description </th></tr> <tr><th>Variable </th><th>Description </th></tr>
</thead> </thead>
<tbody> <tbody>
<tr><td><b>my_variable</b><br/><mark><a href='https://rougail.readthedocs.io/en/latest/variable.html#variables-types'>choice</a></mark> <mark>standard</mark> <mark>mandatory</mark></td><td>A variable.<br/><b>Choices</b>: <ul><li><del>the value of the variable "source_variable_1"</del></li> <tr><td><b>my_variable</b><br/><mark><a href='https://rougail.readthedocs.io/en/latest/variable.html#variables-types'>choice</a></mark> <mark>standard</mark> <mark>mandatory</mark></td><td>A variable.<br/><b>Choices</b>: <ul><li><del>the value of the variable "the first source variable"</del></li>
<li><del>the value of the variable "source_variable_2"</del></li> <li><del>the value of the variable "the second source variable"</del></li>
<li><ins>val1 <b>← (default)</b></ins></li> <li><ins>val1 <b>← (default)</b></ins></li>
<li><ins>val2</ins></li></ul> </td></tr> <li><ins>val2</ins></li></ul> </td></tr>
</tbody> </tbody>

2
tests/changelog/11mod_variable_choices11/result.md
View file

@ -2,5 +2,5 @@
| 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/>•&nbsp;~~the value of the variable "[The first source variable](#source_variable_1)"~~<br/>•&nbsp;~~the value of the variable "[The second source variable](#source_variable_2)"~~<br/>•&nbsp;<ins>val1 **← (default)**</ins><br/>•&nbsp;<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/>•&nbsp;~~the value of the variable "[the first source variable](#source_variable_1)"~~<br/>•&nbsp;~~the value of the variable "[the second source variable](#source_variable_2)"~~<br/>•&nbsp;<ins>val1 **← (default)**</ins><br/>•&nbsp;<ins>val2</ins> |

8
tests/changelog/11mod_variable_choices11/result.sh
View file

@ -5,10 +5,10 @@
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩ ┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
│ my_variable │ A variable. │ │ my_variable │ A variable. │
│  choice   standard   mandatory  │ Choices: │ │  choice   standard   mandatory  │ Choices: │
│ │ • the value of the variable  │ │ │ • the value of the variable "the  │
│ │ "source_variable_1" │ │ │ first source variable" │
│ │ • the value of the variable  │ │ │ • the value of the variable "the  │
│ │ "source_variable_2" │ │ │ second source variable" │
│ │ • val1 ← (default) │ │ │ • val1 ← (default) │
│ │ • val2 │ │ │ • val2 │
└───────────────────────────────────────┴──────────────────────────────────────┘ └───────────────────────────────────────┴──────────────────────────────────────┘

2
tests/changelog/11mod_variable_choices12/result.adoc
View file

@ -9,6 +9,6 @@
* +++val1+++ * +++val1+++
* +++val2+++ * +++val2+++
* the value of the variable "source_variable_1" * the value of the variable "the first source variable"
|==== |====

2
tests/changelog/11mod_variable_choices12/result.gitlab.md
View file

@ -2,7 +2,7 @@
| 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/>•&nbsp;~~val1~~<br/>•&nbsp;~~val2~~<br/>•&nbsp;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/>•&nbsp;~~val1~~<br/>•&nbsp;~~val2~~<br/>•&nbsp;the value of the variable "[the first source variable](#source_variable_1)" |
</details> </details>

2
tests/changelog/11mod_variable_choices12/result.html
View file

@ -7,7 +7,7 @@
<tbody> <tbody>
<tr><td><b>my_variable</b><br/><mark><a href='https://rougail.readthedocs.io/en/latest/variable.html#variables-types'>choice</a></mark> <mark>basic</mark> <mark>mandatory</mark></td><td>A variable.<br/><b>Choices</b>: <ul><li><del>val1</del></li> <tr><td><b>my_variable</b><br/><mark><a href='https://rougail.readthedocs.io/en/latest/variable.html#variables-types'>choice</a></mark> <mark>basic</mark> <mark>mandatory</mark></td><td>A variable.<br/><b>Choices</b>: <ul><li><del>val1</del></li>
<li><del>val2</del></li> <li><del>val2</del></li>
<li>the value of the variable "source_variable_1"</li></ul> </td></tr> <li>the value of the variable "the first source variable"</li></ul> </td></tr>
</tbody> </tbody>
</table> </table>

2
tests/changelog/11mod_variable_choices12/result.md
View file

@ -2,5 +2,5 @@
| 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/>•&nbsp;~~val1~~<br/>•&nbsp;~~val2~~<br/>•&nbsp;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/>•&nbsp;~~val1~~<br/>•&nbsp;~~val2~~<br/>•&nbsp;the value of the variable "[the first source variable](#source_variable_1)" |

4
tests/changelog/11mod_variable_choices12/result.sh
View file

@ -7,7 +7,7 @@
│  choice   basic   mandatory  │ Choices: │ │  choice   basic   mandatory  │ Choices: │
│ │ • val1 │ │ │ • val1 │
│ │ • val2 │ │ │ • val2 │
│ │ • the value of the variable │ │ │ • the value of the variable "the │
│ │ "source_variable_1" │ │ │ first source variable" │
└───────────────────────────────────────┴──────────────────────────────────────┘ └───────────────────────────────────────┴──────────────────────────────────────┘

2
tests/changelog/11mod_variable_choices13/result.adoc
View file

@ -7,7 +7,7 @@
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `basic` `mandatory` | A variable. + `https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `basic` `mandatory` | A variable. +
**Choices**: **Choices**:
* +++the value of the variable "source_variable_1"+++ * +++the value of the variable "the first source variable"+++
* '#val1#' * '#val1#'
* '#val2#' * '#val2#'
|==== |====

2
tests/changelog/11mod_variable_choices13/result.gitlab.md
View file

@ -2,7 +2,7 @@
| 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/>•&nbsp;~~the value of the variable "[The first source variable](#source_variable_1)"~~<br/>•&nbsp;<ins>val1</ins><br/>•&nbsp;<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/>•&nbsp;~~the value of the variable "[the first source variable](#source_variable_1)"~~<br/>•&nbsp;<ins>val1</ins><br/>•&nbsp;<ins>val2</ins> |
</details> </details>

2
tests/changelog/11mod_variable_choices13/result.html
View file

@ -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>my_variable</b><br/><mark><a href='https://rougail.readthedocs.io/en/latest/variable.html#variables-types'>choice</a></mark> <mark>basic</mark> <mark>mandatory</mark></td><td>A variable.<br/><b>Choices</b>: <ul><li><del>the value of the variable "source_variable_1"</del></li> <tr><td><b>my_variable</b><br/><mark><a href='https://rougail.readthedocs.io/en/latest/variable.html#variables-types'>choice</a></mark> <mark>basic</mark> <mark>mandatory</mark></td><td>A variable.<br/><b>Choices</b>: <ul><li><del>the value of the variable "the first source variable"</del></li>
<li><ins>val1</ins></li> <li><ins>val1</ins></li>
<li><ins>val2</ins></li></ul> </td></tr> <li><ins>val2</ins></li></ul> </td></tr>
</tbody> </tbody>

2
tests/changelog/11mod_variable_choices13/result.md
View file

@ -2,5 +2,5 @@
| 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/>•&nbsp;~~the value of the variable "[The first source variable](#source_variable_1)"~~<br/>•&nbsp;<ins>val1</ins><br/>•&nbsp;<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/>•&nbsp;~~the value of the variable "[the first source variable](#source_variable_1)"~~<br/>•&nbsp;<ins>val1</ins><br/>•&nbsp;<ins>val2</ins> |

4
tests/changelog/11mod_variable_choices13/result.sh
View file

@ -5,8 +5,8 @@
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩ ┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
│ my_variable │ A variable. │ │ my_variable │ A variable. │
│  choice   basic   mandatory  │ Choices: │ │  choice   basic   mandatory  │ Choices: │
│ │ • the value of the variable  │ │ │ • the value of the variable "the  │
│ │ "source_variable_1" │ │ │ first source variable" │
│ │ • val1 │ │ │ • val1 │
│ │ • val2 │ │ │ • val2 │
└───────────────────────────────────────┴──────────────────────────────────────┘ └───────────────────────────────────────┴──────────────────────────────────────┘

4
tests/changelog/11mod_variable_choices9/result.adoc
View file

@ -9,8 +9,8 @@
* +++val1+++ * +++val1+++
* +++val2+++ * +++val2+++
* the value of the variable "source_variable_1" * the value of the variable "the first source variable"
* the value of the variable "source_variable_2" * the value of the variable "the second source variable"
**Default**: val1 **Default**: val1
|==== |====

2
tests/changelog/11mod_variable_choices9/result.gitlab.md
View file

@ -2,7 +2,7 @@
| 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/>•&nbsp;~~val1~~<br/>•&nbsp;~~val2~~<br/>•&nbsp;the value of the variable "[The first source variable](#source_variable_1)"<br/>•&nbsp;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/>•&nbsp;~~val1~~<br/>•&nbsp;~~val2~~<br/>•&nbsp;the value of the variable "[the first source variable](#source_variable_1)"<br/>•&nbsp;the value of the variable "[the second source variable](#source_variable_2)"<br/>**Default**: val1 |
</details> </details>

4
tests/changelog/11mod_variable_choices9/result.html
View file

@ -7,8 +7,8 @@
<tbody> <tbody>
<tr><td><b>my_variable</b><br/><mark><a href='https://rougail.readthedocs.io/en/latest/variable.html#variables-types'>choice</a></mark> <mark>standard</mark> <mark>mandatory</mark></td><td>A variable.<br/><b>Choices</b>: <ul><li><del>val1</del></li> <tr><td><b>my_variable</b><br/><mark><a href='https://rougail.readthedocs.io/en/latest/variable.html#variables-types'>choice</a></mark> <mark>standard</mark> <mark>mandatory</mark></td><td>A variable.<br/><b>Choices</b>: <ul><li><del>val1</del></li>
<li><del>val2</del></li> <li><del>val2</del></li>
<li>the value of the variable "source_variable_1"</li> <li>the value of the variable "the first source variable"</li>
<li>the value of the variable "source_variable_2"</li></ul><br/><b>Default</b>: val1 </td></tr> <li>the value of the variable "the second source variable"</li></ul><br/><b>Default</b>: val1 </td></tr>
</tbody> </tbody>
</table> </table>

2
tests/changelog/11mod_variable_choices9/result.md
View file

@ -2,5 +2,5 @@
| 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/>•&nbsp;~~val1~~<br/>•&nbsp;~~val2~~<br/>•&nbsp;the value of the variable "[The first source variable](#source_variable_1)"<br/>•&nbsp;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/>•&nbsp;~~val1~~<br/>•&nbsp;~~val2~~<br/>•&nbsp;the value of the variable "[the first source variable](#source_variable_1)"<br/>•&nbsp;the value of the variable "[the second source variable](#source_variable_2)"<br/>**Default**: val1 |

8
tests/changelog/11mod_variable_choices9/result.sh
View file

@ -7,10 +7,10 @@
│  choice   standard   mandatory  │ Choices: │ │  choice   standard   mandatory  │ Choices: │
│ │ • val1 │ │ │ • val1 │
│ │ • val2 │ │ │ • val2 │
│ │ • the value of the variable │ │ │ • the value of the variable "the │
│ │ "source_variable_1" │ │ │ first source variable" │
│ │ • the value of the variable │ │ │ • the value of the variable "the │
│ │ "source_variable_2" │ │ │ second source variable" │
│ │ Default: val1 │ │ │ Default: val1 │
└───────────────────────────────────────┴──────────────────────────────────────┘ └───────────────────────────────────────┴──────────────────────────────────────┘

2
tests/changelog/12mod_default_value4/result.adoc
View file

@ -6,6 +6,6 @@
| **variable_2** + | **variable_2** +
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | The second variable. + `https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | The second variable. +
**Default**: +++val1+++ + **Default**: +++val1+++ +
#the value of the variable "variable_1"# #the value of the variable "the first variable"#
|==== |====

2
tests/changelog/12mod_default_value4/result.gitlab.md
View file

@ -2,7 +2,7 @@
| Variable | Description | | Variable | Description |
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------| |-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------|
| **<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>the value of the variable "[The first variable](#variable_1)"</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>the value of the variable "[the first variable](#variable_1)"</ins> |
</details> </details>

2
tests/changelog/12mod_default_value4/result.html
View file

@ -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_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>the value of the variable "variable_1"</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>the value of the variable "the first variable"</ins></td></tr>
</tbody> </tbody>
</table> </table>

2
tests/changelog/12mod_default_value4/result.md
View file

@ -2,5 +2,5 @@
| Variable | Description | | Variable | Description |
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------| |-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------|
| **<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>the value of the variable "[The first variable](#variable_1)"</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>the value of the variable "[the first variable](#variable_1)"</ins> |

4
tests/changelog/12mod_default_value4/result.sh
View file

@ -5,7 +5,7 @@
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩ ┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
│ variable_2 │ The second variable. │ │ variable_2 │ The second variable. │
│  string   standard   mandatory  │ Default: val1 │ │  string   standard   mandatory  │ Default: val1 │
│ │ the value of the variable  │ │ │ the value of the variable "the first │
│ │ "variable_1" │ │ │ variable" │
└───────────────────────────────────────┴──────────────────────────────────────┘ └───────────────────────────────────────┴──────────────────────────────────────┘

2
tests/changelog/12mod_default_value5/result.adoc
View file

@ -8,6 +8,6 @@
**Default**: **Default**:
* +++val1+++ * +++val1+++
* '#the value of the variable "variable_1"#' * '#the value of the variable "the first variable"#'
|==== |====

2
tests/changelog/12mod_default_value5/result.gitlab.md
View file

@ -2,7 +2,7 @@
| Variable | Description | | Variable | Description |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------| |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------|
| **<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/>•&nbsp;~~val1~~<br/>•&nbsp;<ins>the value of the variable "[The first variable](#variable_1)"</ins> | | **<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/>•&nbsp;~~val1~~<br/>•&nbsp;<ins>the value of the variable "[the first variable](#variable_1)"</ins> |
</details> </details>

2
tests/changelog/12mod_default_value5/result.html
View file

@ -6,7 +6,7 @@
</thead> </thead>
<tbody> <tbody>
<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><del>val1</del></li> <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><del>val1</del></li>
<li><ins>the value of the variable "variable_1"</ins></li></ul> </td></tr> <li><ins>the value of the variable "the first variable"</ins></li></ul> </td></tr>
</tbody> </tbody>
</table> </table>

2
tests/changelog/12mod_default_value5/result.md
View file

@ -2,5 +2,5 @@
| Variable | Description | | Variable | Description |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------| |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------|
| **<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/>•&nbsp;~~val1~~<br/>•&nbsp;<ins>the value of the variable "[The first variable](#variable_1)"</ins> | | **<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/>•&nbsp;~~val1~~<br/>•&nbsp;<ins>the value of the variable "[the first variable](#variable_1)"</ins> |

4
tests/changelog/12mod_default_value5/result.sh
View file

@ -6,7 +6,7 @@
│ variable_2 │ The second variable. │ │ variable_2 │ The second variable. │
│  string   multiple   standard    │ Default: │ │  string   multiple   standard    │ Default: │
│ mandatory   unique  │ • val1 │ │ mandatory   unique  │ • val1 │
│ │ • the value of the variable  │ │ │ • the value of the variable "the  │
│ │ "variable_1" │ │ │ first variable" │
└───────────────────────────────────────┴──────────────────────────────────────┘ └───────────────────────────────────────┴──────────────────────────────────────┘

2
tests/changelog/30_mod_prop_calculation1/result.adoc
View file

@ -6,6 +6,6 @@
| **var** + | **var** +
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A first variable. + `https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A first variable. +
**Default**: no + **Default**: no +
**Mandatory**: +++if condition is yes+++ **Mandatory**: +++if condition is yes.+++
|==== |====

4
tests/changelog/30_mod_prop_calculation1/result.gitlab.md
View file

@ -1,8 +1,8 @@
<details><summary>Modified variable</summary> <details><summary>Modified variable</summary>
| Variable | Description | | Variable | Description |
|--------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------| |--------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------|
| **<a id="var" name="var">var</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A first variable.<br/>**Default**: no<br/>**Mandatory**: ~~if condition is yes~~ | | **<a id="var" name="var">var</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A first variable.<br/>**Default**: no<br/>**Mandatory**: ~~if condition is yes.~~ |
</details> </details>

2
tests/changelog/30_mod_prop_calculation1/result.html
View file

@ -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>var</b><br/><mark><a href='https://rougail.readthedocs.io/en/latest/variable.html#variables-types'>string</a></mark> <mark>standard</mark> <mark>mandatory</mark></td><td>A first variable.<br/><b>Default</b>: no<br/><b>Mandatory</b>: <del>if condition is yes</del></td></tr> <tr><td><b>var</b><br/><mark><a href='https://rougail.readthedocs.io/en/latest/variable.html#variables-types'>string</a></mark> <mark>standard</mark> <mark>mandatory</mark></td><td>A first variable.<br/><b>Default</b>: no<br/><b>Mandatory</b>: <del>if condition is yes.</del></td></tr>
</tbody> </tbody>
</table> </table>

4
tests/changelog/30_mod_prop_calculation1/result.md
View file

@ -1,6 +1,6 @@
# Modified variable # Modified variable
| Variable | Description | | Variable | Description |
|--------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------| |--------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------|
| **<a id="var" name="var">var</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A first variable.<br/>**Default**: no<br/>**Mandatory**: ~~if condition is yes~~ | | **<a id="var" name="var">var</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A first variable.<br/>**Default**: no<br/>**Mandatory**: ~~if condition is yes.~~ |

2
tests/changelog/30_mod_prop_calculation1/result.sh
View file

@ -5,6 +5,6 @@
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩ ┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
│ var │ A first variable. │ │ var │ A first variable. │
│  string   standard   mandatory  │ Default: no │ │  string   standard   mandatory  │ Default: no │
│ │ Mandatory: if condition is yes │ │ │ Mandatory: if condition is yes. │
└───────────────────────────────────────┴──────────────────────────────────────┘ └───────────────────────────────────────┴──────────────────────────────────────┘

4
tests/changelog/30_mod_prop_calculation2/result.adoc
View file

@ -6,7 +6,7 @@
| **var** + | **var** +
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `__mandatory__` | A first variable. + `https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `__mandatory__` | A first variable. +
**Default**: no + **Default**: no +
**Mandatory**: +++if condition is yes+++ + **Mandatory**: +++if condition is yes.+++ +
#if condition is not no# #if condition is not no.#
|==== |====

4
tests/changelog/30_mod_prop_calculation2/result.gitlab.md
View file

@ -1,8 +1,8 @@
<details><summary>Modified variable</summary> <details><summary>Modified variable</summary>
| Variable | Description | | Variable | Description |
|----------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------| |----------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------|
| **<a id="var" name="var">var</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` *`mandatory`* | A first variable.<br/>**Default**: no<br/>**Mandatory**: ~~if condition is yes~~<br/><ins>if condition is not no</ins> | | **<a id="var" name="var">var</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` *`mandatory`* | A first variable.<br/>**Default**: no<br/>**Mandatory**: ~~if condition is yes.~~<br/><ins>if condition is not no.</ins> |
</details> </details>

2
tests/changelog/30_mod_prop_calculation2/result.html
View file

@ -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>var</b><br/><mark><a href='https://rougail.readthedocs.io/en/latest/variable.html#variables-types'>string</a></mark> <mark>standard</mark> <mark><i>mandatory</i></mark></td><td>A first variable.<br/><b>Default</b>: no<br/><b>Mandatory</b>: <del>if condition is yes</del><br/><ins>if condition is not no</ins></td></tr> <tr><td><b>var</b><br/><mark><a href='https://rougail.readthedocs.io/en/latest/variable.html#variables-types'>string</a></mark> <mark>standard</mark> <mark><i>mandatory</i></mark></td><td>A first variable.<br/><b>Default</b>: no<br/><b>Mandatory</b>: <del>if condition is yes.</del><br/><ins>if condition is not no.</ins></td></tr>
</tbody> </tbody>
</table> </table>

4
tests/changelog/30_mod_prop_calculation2/result.md
View file

@ -1,6 +1,6 @@
# Modified variable # Modified variable
| Variable | Description | | Variable | Description |
|----------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------| |----------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------|
| **<a id="var" name="var">var</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` *`mandatory`* | A first variable.<br/>**Default**: no<br/>**Mandatory**: ~~if condition is yes~~<br/><ins>if condition is not no</ins> | | **<a id="var" name="var">var</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` *`mandatory`* | A first variable.<br/>**Default**: no<br/>**Mandatory**: ~~if condition is yes.~~<br/><ins>if condition is not no.</ins> |

4
tests/changelog/30_mod_prop_calculation2/result.sh
View file

@ -5,7 +5,7 @@
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩ ┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
│ var │ A first variable. │ │ var │ A first variable. │
│  string   standard   mandatory  │ Default: no │ │  string   standard   mandatory  │ Default: no │
│ │ Mandatory: if condition is yes │ │ │ Mandatory: if condition is yes. │
│ │ if condition is not no │ │ │ if condition is not no. │
└───────────────────────────────────────┴──────────────────────────────────────┘ └───────────────────────────────────────┴──────────────────────────────────────┘

2
tests/changelog/30_mod_prop_calculation3/result.adoc
View file

@ -6,6 +6,6 @@
| **var** + | **var** +
`+++hidden+++` `https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A first variable. + `+++hidden+++` `https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A first variable. +
**Default**: no + **Default**: no +
**Hidden**: +++if condition is yes+++ **Hidden**: +++if condition is yes.+++
|==== |====

4
tests/changelog/30_mod_prop_calculation3/result.gitlab.md
View file

@ -1,8 +1,8 @@
<details><summary>Modified variable</summary> <details><summary>Modified variable</summary>
| Variable | Description | | Variable | Description |
|---------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------| |---------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------|
| **<a id="var" name="var">var</a>**<br/>~~`hidden`~~ [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A first variable.<br/>**Default**: no<br/>**Hidden**: ~~if condition is yes~~ | | **<a id="var" name="var">var</a>**<br/>~~`hidden`~~ [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A first variable.<br/>**Default**: no<br/>**Hidden**: ~~if condition is yes.~~ |
</details> </details>

2
tests/changelog/30_mod_prop_calculation3/result.html
View file

@ -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>var</b><br/><mark><del>hidden</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>A first variable.<br/><b>Default</b>: no<br/><b>Hidden</b>: <del>if condition is yes</del></td></tr> <tr><td><b>var</b><br/><mark><del>hidden</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>A first variable.<br/><b>Default</b>: no<br/><b>Hidden</b>: <del>if condition is yes.</del></td></tr>
</tbody> </tbody>
</table> </table>

4
tests/changelog/30_mod_prop_calculation3/result.md
View file

@ -1,6 +1,6 @@
# Modified variable # Modified variable
| Variable | Description | | Variable | Description |
|---------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------| |---------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------|
| **<a id="var" name="var">var</a>**<br/>~~`hidden`~~ [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A first variable.<br/>**Default**: no<br/>**Hidden**: ~~if condition is yes~~ | | **<a id="var" name="var">var</a>**<br/>~~`hidden`~~ [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A first variable.<br/>**Default**: no<br/>**Hidden**: ~~if condition is yes.~~ |

2
tests/changelog/30_mod_prop_calculation3/result.sh
View file

@ -5,6 +5,6 @@
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩ ┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
│ var │ A first variable. │ │ var │ A first variable. │
│  hidden   string   standard    │ Default: no │ │  hidden   string   standard    │ Default: no │
│ mandatory  │ Hidden: if condition is yes │ │ mandatory  │ Hidden: if condition is yes. │
└───────────────────────────────────────┴──────────────────────────────────────┘ └───────────────────────────────────────┴──────────────────────────────────────┘

2
tests/changelog/30_mod_prop_calculation4/result.adoc
View file

@ -6,6 +6,6 @@
| **var** + | **var** +
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `#__hidden__#` | A first variable. + `https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `#__hidden__#` | A first variable. +
**Default**: no + **Default**: no +
**Hidden**: #if condition is yes# **Hidden**: #if condition is yes.#
|==== |====

4
tests/changelog/30_mod_prop_calculation4/result.gitlab.md
View file

@ -1,8 +1,8 @@
<details><summary>Modified variable</summary> <details><summary>Modified variable</summary>
| Variable | Description | | Variable | Description |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------| |------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------|
| **<a id="var" name="var">var</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` <ins>*`hidden`*</ins> | A first variable.<br/>**Default**: no<br/>**Hidden**: <ins>if condition is yes</ins> | | **<a id="var" name="var">var</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` <ins>*`hidden`*</ins> | A first variable.<br/>**Default**: no<br/>**Hidden**: <ins>if condition is yes.</ins> |
</details> </details>

2
tests/changelog/30_mod_prop_calculation4/result.html
View file

@ -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>var</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><i>hidden</i></ins></mark></td><td>A first variable.<br/><b>Default</b>: no<br/><b>Hidden</b>: <ins>if condition is yes</ins></td></tr> <tr><td><b>var</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><i>hidden</i></ins></mark></td><td>A first variable.<br/><b>Default</b>: no<br/><b>Hidden</b>: <ins>if condition is yes.</ins></td></tr>
</tbody> </tbody>
</table> </table>

4
tests/changelog/30_mod_prop_calculation4/result.md
View file

@ -1,6 +1,6 @@
# Modified variable # Modified variable
| Variable | Description | | Variable | Description |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------| |------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------|
| **<a id="var" name="var">var</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` <ins>*`hidden`*</ins> | A first variable.<br/>**Default**: no<br/>**Hidden**: <ins>if condition is yes</ins> | | **<a id="var" name="var">var</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` <ins>*`hidden`*</ins> | A first variable.<br/>**Default**: no<br/>**Hidden**: <ins>if condition is yes.</ins> |

2
tests/changelog/30_mod_prop_calculation4/result.sh
View file

@ -5,6 +5,6 @@
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩ ┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
│ var │ A first variable. │ │ var │ A first variable. │
│  string   standard   mandatory    │ Default: no │ │  string   standard   mandatory    │ Default: no │
│ hidden  │ Hidden: if condition is yes │ │ hidden  │ Hidden: if condition is yes. │
└───────────────────────────────────────┴──────────────────────────────────────┘ └───────────────────────────────────────┴──────────────────────────────────────┘

4
tests/changelog/40_dynamic_mod_default1/result.adoc
View file

@ -6,8 +6,8 @@
| **__val1___dyn.var2** + | **__val1___dyn.var2** +
**__val2___dyn.var2** + **__val2___dyn.var2** +
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A second variable. + `https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A second variable. +
**Default**: +++the value of the variable "__val1___dyn.var1"+++ + **Default**: +++the value of the variable "a first variable"+++ +
+++the value of the variable "__val2___dyn.var1"+++ + +++the value of the variable "a first variable"+++ +
#val# #val#
|==== |====

2
tests/changelog/40_dynamic_mod_default1/result.gitlab.md
View file

@ -2,7 +2,7 @@
| Variable | Description | | Variable | Description |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **<a id=":::identifier:::_dyn.var2" name=":::identifier:::_dyn.var2">*val1*_dyn.var2</a>**<br/>***val2*_dyn.var2**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second variable.<br/>**Default**: ~~the value of the variable "[A first variable](#:::identifier:::_dyn.var1)"~~<br/>~~the value of the variable "[A first variable](#:::identifier:::_dyn.var1)"~~<br/><ins>val</ins> | | **<a id=":::identifier:::_dyn.var2" name=":::identifier:::_dyn.var2">*val1*_dyn.var2</a>**<br/>***val2*_dyn.var2**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second variable.<br/>**Default**: ~~the value of the variable "[a first variable](#:::identifier:::_dyn.var1)"~~<br/>~~the value of the variable "[a first variable](#:::identifier:::_dyn.var1)"~~<br/><ins>val</ins> |
</details> </details>

2
tests/changelog/40_dynamic_mod_default1/result.html
View file

@ -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><i>val1</i>_dyn.var2</b><br/><b><i>val2</i>_dyn.var2</b><br/><mark><a href='https://rougail.readthedocs.io/en/latest/variable.html#variables-types'>string</a></mark> <mark>standard</mark> <mark>mandatory</mark></td><td>A second variable.<br/><b>Default</b>: <del>the value of the variable "<i>val1</i>_dyn.var1"</del><br/><del>the value of the variable "<i>val2</i>_dyn.var1"</del><br/><ins>val</ins></td></tr> <tr><td><b><i>val1</i>_dyn.var2</b><br/><b><i>val2</i>_dyn.var2</b><br/><mark><a href='https://rougail.readthedocs.io/en/latest/variable.html#variables-types'>string</a></mark> <mark>standard</mark> <mark>mandatory</mark></td><td>A second variable.<br/><b>Default</b>: <del>the value of the variable "a first variable"</del><br/><del>the value of the variable "a first variable"</del><br/><ins>val</ins></td></tr>
</tbody> </tbody>
</table> </table>

2
tests/changelog/40_dynamic_mod_default1/result.md
View file

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

6
tests/changelog/40_dynamic_mod_default1/result.sh
View file

@ -5,9 +5,9 @@
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩ ┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
│ val1_dyn.var2 │ A second variable. │ │ val1_dyn.var2 │ A second variable. │
│ val2_dyn.var2 │ Default: the value of the variable  │ │ val2_dyn.var2 │ Default: the value of the variable  │
│  string   standard   mandatory  │ "val1_dyn.var1" │ │  string   standard   mandatory  │ "a first variable" │
│ │ the value of the variable  │ │ │ the value of the variable "a first  │
│ │ "val2_dyn.var1" │ │ │ variable" │
│ │ val │ │ │ val │
└───────────────────────────────────────┴──────────────────────────────────────┘ └───────────────────────────────────────┴──────────────────────────────────────┘

4
tests/changelog/40_dynamic_mod_default2/result.adoc
View file

@ -9,7 +9,7 @@
**Default**: **Default**:
* +++val+++ * +++val+++
* '#the value of the variable "__val1___dyn.var1"#' * '#the value of the variable "a first variable"#'
* '#the value of the variable "__val2___dyn.var1"#' * '#the value of the variable "a first variable"#'
|==== |====

2
tests/changelog/40_dynamic_mod_default2/result.gitlab.md
View file

@ -2,7 +2,7 @@
| Variable | Description | | Variable | Description |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **<a id=":::identifier:::_dyn.var2" name=":::identifier:::_dyn.var2">*val1*_dyn.var2</a>**<br/>***val2*_dyn.var2**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second variable.<br/>**Default**: <br/>•&nbsp;~~val~~<br/>•&nbsp;<ins>the value of the variable "[A first variable](#:::identifier:::_dyn.var1)"</ins><br/>•&nbsp;<ins>the value of the variable "[A first variable](#:::identifier:::_dyn.var1)"</ins> | | **<a id=":::identifier:::_dyn.var2" name=":::identifier:::_dyn.var2">*val1*_dyn.var2</a>**<br/>***val2*_dyn.var2**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second variable.<br/>**Default**: <br/>•&nbsp;~~val~~<br/>•&nbsp;<ins>the value of the variable "[a first variable](#:::identifier:::_dyn.var1)"</ins><br/>•&nbsp;<ins>the value of the variable "[a first variable](#:::identifier:::_dyn.var1)"</ins> |
</details> </details>

4
tests/changelog/40_dynamic_mod_default2/result.html
View file

@ -6,8 +6,8 @@
</thead> </thead>
<tbody> <tbody>
<tr><td><b><i>val1</i>_dyn.var2</b><br/><b><i>val2</i>_dyn.var2</b><br/><mark><a href='https://rougail.readthedocs.io/en/latest/variable.html#variables-types'>string</a></mark> <mark>standard</mark> <mark>mandatory</mark></td><td>A second variable.<br/><b>Default</b>: <ul><li><del>val</del></li> <tr><td><b><i>val1</i>_dyn.var2</b><br/><b><i>val2</i>_dyn.var2</b><br/><mark><a href='https://rougail.readthedocs.io/en/latest/variable.html#variables-types'>string</a></mark> <mark>standard</mark> <mark>mandatory</mark></td><td>A second variable.<br/><b>Default</b>: <ul><li><del>val</del></li>
<li><ins>the value of the variable "<i>val1</i>_dyn.var1"</ins></li> <li><ins>the value of the variable "a first variable"</ins></li>
<li><ins>the value of the variable "<i>val2</i>_dyn.var1"</ins></li></ul> </td></tr> <li><ins>the value of the variable "a first variable"</ins></li></ul> </td></tr>
</tbody> </tbody>
</table> </table>

2
tests/changelog/40_dynamic_mod_default2/result.md
View file

@ -2,5 +2,5 @@
| Variable | Description | | Variable | Description |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **<a id=":::identifier:::_dyn.var2" name=":::identifier:::_dyn.var2">*val1*_dyn.var2</a>**<br/>***val2*_dyn.var2**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second variable.<br/>**Default**: <br/>•&nbsp;~~val~~<br/>•&nbsp;<ins>the value of the variable "[A first variable](#:::identifier:::_dyn.var1)"</ins><br/>•&nbsp;<ins>the value of the variable "[A first variable](#:::identifier:::_dyn.var1)"</ins> | | **<a id=":::identifier:::_dyn.var2" name=":::identifier:::_dyn.var2">*val1*_dyn.var2</a>**<br/>***val2*_dyn.var2**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second variable.<br/>**Default**: <br/>•&nbsp;~~val~~<br/>•&nbsp;<ins>the value of the variable "[a first variable](#:::identifier:::_dyn.var1)"</ins><br/>•&nbsp;<ins>the value of the variable "[a first variable](#:::identifier:::_dyn.var1)"</ins> |

8
tests/changelog/40_dynamic_mod_default2/result.sh
View file

@ -6,9 +6,9 @@
│ val1_dyn.var2 │ A second variable. │ │ val1_dyn.var2 │ A second variable. │
│ val2_dyn.var2 │ Default: │ │ val2_dyn.var2 │ Default: │
│  string   standard   mandatory  │ • val │ │  string   standard   mandatory  │ • val │
│ │ • the value of the variable  │ │ │ • the value of the variable "a first │
│ │ "val1_dyn.var1" │ │ │ variable" │
│ │ • the value of the variable  │ │ │ • the value of the variable "a first │
│ │ "val2_dyn.var1" │ │ │ variable" │
└───────────────────────────────────────┴──────────────────────────────────────┘ └───────────────────────────────────────┴──────────────────────────────────────┘

6
tests/force_optional.adoc
View file

@ -5,10 +5,10 @@
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `mandatory` | My var1. `https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `mandatory` | My var1.
| **var2** + | **var2** +
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `mandatory` | My var2. + `https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `mandatory` | My var2. +
**Default**: var calculated **Default**: var calculated.
| **var3** + | **var3** +
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `mandatory` `__hidden__` | My var3. + `https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `mandatory` `__hidden__` | My var3. +
**Hidden**: var could be hidden **Hidden**: var could be hidden.
| **var4** + | **var4** +
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `mandatory` | My var4. `https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `mandatory` | My var4.
| **var5** + | **var5** +
@ -25,7 +25,7 @@
* *
| **var8** + | **var8** +
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `mandatory` | My var8. + `https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `mandatory` | My var8. +
**Choices**: the a.unknown.variable values **Choices**: values of "a.unknown.variable".
|==== |====
== My var9 == My var9

2
tests/force_optional/00_file.yml
View file

@ -51,7 +51,7 @@ var8:
choices: choices:
jinja: | jinja: |
{{ a.unknown.variable }} {{ a.unknown.variable }}
description: the a.unknown.variable values description: values of "a.unknown.variable"
"var_{{ identifier }}": "var_{{ identifier }}":
description: my var9 description: my var9

2
tests/mode_advanced.adoc
View file

@ -5,6 +5,6 @@
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | My var1. `https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | My var1.
| **var2** + | **var2** +
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | My var2. + `https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | My var2. +
**Default**: the value of the variable "var1" **Default**: the value of the variable "my var1"
|==== |====

2
tests/mode_basic.adoc
View file

@ -6,6 +6,6 @@
**Default**: the value of an undocumented variable **Default**: the value of an undocumented variable
| **var3** + | **var3** +
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `advanced` `mandatory` `__hidden__` | My var3. + `https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `advanced` `mandatory` `__hidden__` | My var3. +
**Hidden**: var could be hidden **Hidden**: var could be hidden.
|==== |====

2
tests/mode_basic_standard.adoc
View file

@ -3,6 +3,6 @@
| Variable | Description | Variable | Description
| **var3** + | **var3** +
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `advanced` `mandatory` `__hidden__` | My var3. + `https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `advanced` `mandatory` `__hidden__` | My var3. +
**Hidden**: var could be hidden **Hidden**: var could be hidden.
|==== |====

2
tests/mode_standard.adoc
View file

@ -5,6 +5,6 @@
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | My var1. `https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | My var1.
| **var3** + | **var3** +
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `advanced` `mandatory` `__hidden__` | My var3. + `https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `advanced` `mandatory` `__hidden__` | My var3. +
**Hidden**: var could be hidden **Hidden**: var could be hidden.
|==== |====

4
tests/result_tutorial/041/doc.sh
View file

@ -65,7 +65,7 @@
│ │ • type domainname │ │ │ • type domainname │
│ │ • the domain name can be an IP │ │ │ • the domain name can be an IP │
│ │ Default: the value of the variable │ │ │ Default: the value of the variable │
│ │ "manual.http_proxy.address" │ │ │ "HTTP address" │
├───────────────────────────────────────┼──────────────────────────────────────┤ ├───────────────────────────────────────┼──────────────────────────────────────┤
│ manual.https_proxy.port │ HTTPS Port. │ │ manual.https_proxy.port │ HTTPS Port. │
│  port   standard   mandatory  │ Validators: │ │  port   standard   mandatory  │ Validators: │
@ -76,7 +76,7 @@
│ │ • private ports (greater than 49152) │ │ │ • private ports (greater than 49152) │
│ │ are allowed │ │ │ are allowed │
│ │ Default: the value of the variable │ │ │ Default: the value of the variable │
│ │ "manual.http_proxy.port" │ │ │ "HTTP Port" │
└───────────────────────────────────────┴──────────────────────────────────────┘ └───────────────────────────────────────┴──────────────────────────────────────┘

6
tests/result_tutorial/041/doc_changelog.sh
View file

@ -8,7 +8,7 @@
│ standard   mandatory  │ • type domainname │ │ standard   mandatory  │ • type domainname │
│ │ • the domain name can be an IP │ │ │ • the domain name can be an IP │
│ │ Default: the value of the variable  │ │ │ Default: the value of the variable  │
│ │ "manual.http_proxy.address" │ │ │ "HTTP address" │
├───────────────────────────────────────┼──────────────────────────────────────┤ ├───────────────────────────────────────┼──────────────────────────────────────┤
│ manual.https_proxy.port │ HTTPS Port. │ │ manual.https_proxy.port │ HTTPS Port. │
│  port   standard   mandatory  │ Validators: │ │  port   standard   mandatory  │ Validators: │
@ -19,7 +19,7 @@
│ │ • private ports (greater than 49152) │ │ │ • private ports (greater than 49152) │
│ │ are allowed │ │ │ are allowed │
│ │ Default: 8080 │ │ │ Default: 8080 │
│ │ the value of the variable  │ │ │ the value of the variable "HTTP  │
│ │ "manual.http_proxy.port" │ │ │ Port" │
└───────────────────────────────────────┴──────────────────────────────────────┘ └───────────────────────────────────────┴──────────────────────────────────────┘

2
tests/result_tutorial/051/doc.json
View file

@ -42,7 +42,7 @@
"ori_name": "disabled", "ori_name": "disabled",
"access_control": true, "access_control": true,
"annotation": { "annotation": {
"message": "when the variable \"{0}\" hasn't the value \"Manual proxy configuration\"", "message": "when the variable \"{0}\" hasn't the value \"Manual proxy configuration\".",
"path": { "path": {
"path": "proxy_mode" "path": "proxy_mode"
}, },

8
tests/result_tutorial/051/doc.sh
View file

@ -17,8 +17,8 @@
▌  ▌ 
▌ Path: manual ▌ Path: manual
▌  basic   disabled  ▌  basic   disabled 
▌ Disabled: when the variable "proxy_mode" hasn't the value "Manual proxy  ▌ Disabled: when the variable "Configure Proxy Access to the Internet" hasn't
configuration" the value "Manual proxy configuration".
HTTP Proxy HTTP Proxy
@ -67,7 +67,7 @@
│ │ • type domainname │ │ │ • type domainname │
│ │ • the domain name can be an IP │ │ │ • the domain name can be an IP │
│ │ Default: the value of the variable │ │ │ Default: the value of the variable │
│ │ "manual.http_proxy.address" │ │ │ "HTTP address" │
├───────────────────────────────────────┼──────────────────────────────────────┤ ├───────────────────────────────────────┼──────────────────────────────────────┤
│ manual.https_proxy.port │ HTTPS Port. │ │ manual.https_proxy.port │ HTTPS Port. │
│  port   standard   mandatory  │ Validators: │ │  port   standard   mandatory  │ Validators: │
@ -78,7 +78,7 @@
│ │ • private ports (greater than 49152) │ │ │ • private ports (greater than 49152) │
│ │ are allowed │ │ │ are allowed │
│ │ Default: the value of the variable │ │ │ Default: the value of the variable │
│ │ "manual.http_proxy.port" │ │ │ "HTTP Port" │
└───────────────────────────────────────┴──────────────────────────────────────┘ └───────────────────────────────────────┴──────────────────────────────────────┘

4
tests/result_tutorial/051/doc_changelog.sh
View file

@ -26,7 +26,7 @@
│ │ • type domainname │ │ │ • type domainname │
│ │ • the domain name can be an IP │ │ │ • the domain name can be an IP │
│ │ Default: the value of the variable │ │ │ Default: the value of the variable │
│ │ "manual.http_proxy.address" │ │ │ "HTTP address" │
├───────────────────────────────────────┼──────────────────────────────────────┤ ├───────────────────────────────────────┼──────────────────────────────────────┤
│ manual.https_proxy.port │ HTTPS Port. │ │ manual.https_proxy.port │ HTTPS Port. │
│  port   standard   mandatory  │ Validators: │ │  port   standard   mandatory  │ Validators: │
@ -37,6 +37,6 @@
│ │ • private ports (greater than 49152) │ │ │ • private ports (greater than 49152) │
│ │ are allowed │ │ │ are allowed │
│ │ Default: the value of the variable │ │ │ Default: the value of the variable │
│ │ "manual.http_proxy.port" │ │ │ "HTTP Port" │
└───────────────────────────────────────┴──────────────────────────────────────┘ └───────────────────────────────────────┴──────────────────────────────────────┘

2
tests/result_tutorial/052/doc.json
View file

@ -42,7 +42,7 @@
"ori_name": "disabled", "ori_name": "disabled",
"access_control": true, "access_control": true,
"annotation": { "annotation": {
"message": "when the variable \"{0}\" hasn't the value \"Manual proxy configuration\"", "message": "when the variable \"{0}\" hasn't the value \"Manual proxy configuration\".",
"path": { "path": {
"path": "proxy_mode" "path": "proxy_mode"
}, },

4
tests/result_tutorial/052/doc.sh
View file

@ -17,8 +17,8 @@
▌  ▌ 
▌ Path: manual ▌ Path: manual
▌  basic   disabled  ▌  basic   disabled 
▌ Disabled: when the variable "proxy_mode" hasn't the value "Manual proxy  ▌ Disabled: when the variable "Configure Proxy Access to the Internet" hasn't
configuration" the value "Manual proxy configuration".
HTTP Proxy HTTP Proxy

4
tests/result_tutorial/053/doc.json
View file

@ -42,7 +42,7 @@
"ori_name": "disabled", "ori_name": "disabled",
"access_control": true, "access_control": true,
"annotation": { "annotation": {
"message": "when the variable \"{0}\" hasn't the value \"Manual proxy configuration\"", "message": "when the variable \"{0}\" hasn't the value \"Manual proxy configuration\".",
"path": { "path": {
"path": "proxy_mode" "path": "proxy_mode"
}, },
@ -149,7 +149,7 @@
"ori_name": "hidden", "ori_name": "hidden",
"access_control": true, "access_control": true,
"annotation": { "annotation": {
"message": "when the variable \"{0}\" has the value \"true\"", "message": "when the variable \"{0}\" has the value \"true\".",
"path": { "path": {
"path": "manual.use_for_https" "path": "manual.use_for_https"
}, },

11
tests/result_tutorial/053/doc.sh
View file

@ -17,8 +17,8 @@
▌  ▌ 
▌ Path: manual ▌ Path: manual
▌  basic   disabled  ▌  basic   disabled 
▌ Disabled: when the variable "proxy_mode" hasn't the value "Manual proxy  ▌ Disabled: when the variable "Configure Proxy Access to the Internet" hasn't
configuration" the value "Manual proxy configuration".
HTTP Proxy HTTP Proxy
@ -58,7 +58,8 @@
▌  ▌ 
▌ Path: manual.https_proxy ▌ Path: manual.https_proxy
▌  standard   hidden  ▌  standard   hidden 
▌ Hidden: when the variable "manual.use_for_https" has the value "true" ▌ Hidden: when the variable "Also use this proxy for HTTPS" has the value
"true".
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ ┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃ Variable  ┃ Description  ┃ ┃ Variable  ┃ Description  ┃
@ -68,7 +69,7 @@
│ │ • type domainname │ │ │ • type domainname │
│ │ • the domain name can be an IP │ │ │ • the domain name can be an IP │
│ │ Default: the value of the variable │ │ │ Default: the value of the variable │
│ │ "manual.http_proxy.address" │ │ │ "HTTP address" │
├───────────────────────────────────────┼──────────────────────────────────────┤ ├───────────────────────────────────────┼──────────────────────────────────────┤
│ manual.https_proxy.port │ HTTPS Port. │ │ manual.https_proxy.port │ HTTPS Port. │
│  port   standard   mandatory  │ Validators: │ │  port   standard   mandatory  │ Validators: │
@ -79,7 +80,7 @@
│ │ • private ports (greater than 49152) │ │ │ • private ports (greater than 49152) │
│ │ are allowed │ │ │ are allowed │
│ │ Default: the value of the variable │ │ │ Default: the value of the variable │
│ │ "manual.http_proxy.port" │ │ │ "HTTP Port" │
└───────────────────────────────────────┴──────────────────────────────────────┘ └───────────────────────────────────────┴──────────────────────────────────────┘

4
tests/result_tutorial/053/doc_changelog.sh
View file

@ -8,7 +8,7 @@
│ │ • type domainname │ │ │ • type domainname │
│ │ • the domain name can be an IP │ │ │ • the domain name can be an IP │
│ │ Default: the value of the variable │ │ │ Default: the value of the variable │
│ │ "manual.http_proxy.address" │ │ │ "HTTP address" │
├───────────────────────────────────────┼──────────────────────────────────────┤ ├───────────────────────────────────────┼──────────────────────────────────────┤
│ manual.https_proxy.port │ HTTPS Port. │ │ manual.https_proxy.port │ HTTPS Port. │
│  port   standard   mandatory  │ Validators: │ │  port   standard   mandatory  │ Validators: │
@ -19,6 +19,6 @@
│ │ • private ports (greater than 49152) │ │ │ • private ports (greater than 49152) │
│ │ are allowed │ │ │ are allowed │
│ │ Default: the value of the variable │ │ │ Default: the value of the variable │
│ │ "manual.http_proxy.port" │ │ │ "HTTP Port" │
└───────────────────────────────────────┴──────────────────────────────────────┘ └───────────────────────────────────────┴──────────────────────────────────────┘

4
tests/result_tutorial/060/doc.json
View file

@ -42,7 +42,7 @@
"ori_name": "disabled", "ori_name": "disabled",
"access_control": true, "access_control": true,
"annotation": { "annotation": {
"message": "when the variable \"{0}\" hasn't the value \"Manual proxy configuration\"", "message": "when the variable \"{0}\" hasn't the value \"Manual proxy configuration\".",
"path": { "path": {
"path": "proxy_mode" "path": "proxy_mode"
}, },
@ -149,7 +149,7 @@
"ori_name": "hidden", "ori_name": "hidden",
"access_control": true, "access_control": true,
"annotation": { "annotation": {
"message": "when the variable \"{0}\" has the value \"true\"", "message": "when the variable \"{0}\" has the value \"true\".",
"path": { "path": {
"path": "manual.use_for_https" "path": "manual.use_for_https"
}, },

11
tests/result_tutorial/060/doc.sh
View file

@ -17,8 +17,8 @@
▌  ▌ 
▌ Path: manual ▌ Path: manual
▌  basic   disabled  ▌  basic   disabled 
▌ Disabled: when the variable "proxy_mode" hasn't the value "Manual proxy  ▌ Disabled: when the variable "Configure Proxy Access to the Internet" hasn't
configuration" the value "Manual proxy configuration".
HTTP Proxy HTTP Proxy
@ -61,7 +61,8 @@
▌  • manual.https_proxy ▌  • manual.https_proxy
▌  • manual.socks_proxy ▌  • manual.socks_proxy
▌  standard   hidden  ▌  standard   hidden 
▌ Hidden: when the variable "manual.use_for_https" has the value "true" ▌ Hidden: when the variable "Also use this proxy for HTTPS" has the value
"true".
▌ Identifiers: ▌ Identifiers:
▌  • HTTPS ▌  • HTTPS
▌  • SOCKS ▌  • SOCKS
@ -74,7 +75,7 @@
│  domainname   standard   mandatory  │ • type domainname │ │  domainname   standard   mandatory  │ • type domainname │
│ │ • the domain name can be an IP │ │ │ • the domain name can be an IP │
│ │ Default: the value of the variable │ │ │ Default: the value of the variable │
│ │ "manual.http_proxy.address" │ │ │ "HTTP address" │
├───────────────────────────────────────┼──────────────────────────────────────┤ ├───────────────────────────────────────┼──────────────────────────────────────┤
│ manual.https_proxy.port │ HTTPS or SOCKS port. │ │ manual.https_proxy.port │ HTTPS or SOCKS port. │
│ manual.socks_proxy.port │ Validators: │ │ manual.socks_proxy.port │ Validators: │
@ -85,7 +86,7 @@
│ │ • private ports (greater than 49152) │ │ │ • private ports (greater than 49152) │
│ │ are allowed │ │ │ are allowed │
│ │ Default: the value of the variable │ │ │ Default: the value of the variable │
│ │ "manual.http_proxy.port" │ │ │ "HTTP Port" │
└───────────────────────────────────────┴──────────────────────────────────────┘ └───────────────────────────────────────┴──────────────────────────────────────┘

4
tests/result_tutorial/060/doc_changelog.sh
View file

@ -8,7 +8,7 @@
│  domainname   standard   mandatory  │ • type domainname │ │  domainname   standard   mandatory  │ • type domainname │
│ │ • the domain name can be an IP │ │ │ • the domain name can be an IP │
│ │ Default: the value of the variable │ │ │ Default: the value of the variable │
│ │ "manual.http_proxy.address" │ │ │ "HTTP address" │
├───────────────────────────────────────┼──────────────────────────────────────┤ ├───────────────────────────────────────┼──────────────────────────────────────┤
│ manual.https_proxy.port │ HTTPS or SOCKS port. │ │ manual.https_proxy.port │ HTTPS or SOCKS port. │
│ manual.socks_proxy.port │ Validators: │ │ manual.socks_proxy.port │ Validators: │
@ -19,7 +19,7 @@
│ │ • private ports (greater than 49152) │ │ │ • private ports (greater than 49152) │
│ │ are allowed │ │ │ are allowed │
│ │ Default: the value of the variable │ │ │ Default: the value of the variable │
│ │ "manual.http_proxy.port" │ │ │ "HTTP Port" │
└───────────────────────────────────────┴──────────────────────────────────────┘ └───────────────────────────────────────┴──────────────────────────────────────┘
Deleted variables Deleted variables

6
tests/result_tutorial/061/doc.json
View file

@ -42,7 +42,7 @@
"ori_name": "disabled", "ori_name": "disabled",
"access_control": true, "access_control": true,
"annotation": { "annotation": {
"message": "when the variable \"{0}\" hasn't the value \"Manual proxy configuration\"", "message": "when the variable \"{0}\" hasn't the value \"Manual proxy configuration\".",
"path": { "path": {
"path": "proxy_mode" "path": "proxy_mode"
}, },
@ -149,7 +149,7 @@
"ori_name": "hidden", "ori_name": "hidden",
"access_control": true, "access_control": true,
"annotation": { "annotation": {
"message": "when the variable \"{0}\" has the value \"true\"", "message": "when the variable \"{0}\" has the value \"true\".",
"path": { "path": {
"path": "manual.use_for_https" "path": "manual.use_for_https"
}, },
@ -276,7 +276,7 @@
"name": "disabled", "name": "disabled",
"ori_name": "disabled", "ori_name": "disabled",
"access_control": true, "access_control": true,
"annotation": "when the identifier is \"HTTPS\"" "annotation": "when the identifier is \"HTTPS\"."
} }
], ],
"mode": "standard", "mode": "standard",

13
tests/result_tutorial/061/doc.sh
View file

@ -17,8 +17,8 @@
▌  ▌ 
▌ Path: manual ▌ Path: manual
▌  basic   disabled  ▌  basic   disabled 
▌ Disabled: when the variable "proxy_mode" hasn't the value "Manual proxy  ▌ Disabled: when the variable "Configure Proxy Access to the Internet" hasn't
configuration" the value "Manual proxy configuration".
HTTP Proxy HTTP Proxy
@ -61,7 +61,8 @@
▌  • manual.https_proxy ▌  • manual.https_proxy
▌  • manual.socks_proxy ▌  • manual.socks_proxy
▌  standard   hidden  ▌  standard   hidden 
▌ Hidden: when the variable "manual.use_for_https" has the value "true" ▌ Hidden: when the variable "Also use this proxy for HTTPS" has the value
"true".
▌ Identifiers: ▌ Identifiers:
▌  • HTTPS ▌  • HTTPS
▌  • SOCKS ▌  • SOCKS
@ -74,7 +75,7 @@
│  domainname   standard   mandatory  │ • type domainname │ │  domainname   standard   mandatory  │ • type domainname │
│ │ • the domain name can be an IP │ │ │ • the domain name can be an IP │
│ │ Default: the value of the variable │ │ │ Default: the value of the variable │
│ │ "manual.http_proxy.address" │ │ │ "HTTP address" │
├───────────────────────────────────────┼──────────────────────────────────────┤ ├───────────────────────────────────────┼──────────────────────────────────────┤
│ manual.https_proxy.port │ HTTPS or SOCKS port. │ │ manual.https_proxy.port │ HTTPS or SOCKS port. │
│ manual.socks_proxy.port │ Validators: │ │ manual.socks_proxy.port │ Validators: │
@ -85,14 +86,14 @@
│ │ • private ports (greater than 49152) │ │ │ • private ports (greater than 49152) │
│ │ are allowed │ │ │ are allowed │
│ │ Default: the value of the variable │ │ │ Default: the value of the variable │
│ │ "manual.http_proxy.port" │ │ │ "HTTP Port" │
├───────────────────────────────────────┼──────────────────────────────────────┤ ├───────────────────────────────────────┼──────────────────────────────────────┤
│ manual.socks_proxy.version │ SOCKS host version used by proxy. │ │ manual.socks_proxy.version │ SOCKS host version used by proxy. │
│  choice   standard   mandatory    │ Choices: │ │  choice   standard   mandatory    │ Choices: │
│ disabled  │ • v4 │ │ disabled  │ • v4 │
│ │ • v5 ← (default) │ │ │ • v5 ← (default) │
│ │ Disabled: when the identifier is │ │ │ Disabled: when the identifier is │
│ │ "HTTPS" │ │ │ "HTTPS". │
└───────────────────────────────────────┴──────────────────────────────────────┘ └───────────────────────────────────────┴──────────────────────────────────────┘

2
tests/result_tutorial/061/doc_changelog.sh
View file

@ -8,6 +8,6 @@
│ disabled  │ • v4 │ │ disabled  │ • v4 │
│ │ • v5 ← (default) │ │ │ • v5 ← (default) │
│ │ Disabled: when the identifier is │ │ │ Disabled: when the identifier is │
│ │ "HTTPS" │ │ │ "HTTPS". │
└───────────────────────────────────────┴──────────────────────────────────────┘ └───────────────────────────────────────┴──────────────────────────────────────┘

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