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 c48deed840
2514 changed files with 6021 additions and 5996 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
README.fr.md
View file

@ -11,13 +11,13 @@ 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.\
> **Chemin** : doc\
> *`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 |
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------|-------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------|
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------|-------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------|
| **<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.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.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<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.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<br/>. | `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.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" | |
@ -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". |
| 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
@ -45,14 +45,14 @@ include_toc: true
>
> **Chemin** : doc.tabulars\
> *`désactivé`*\
> **Désactivé** : si "[Le format de sortie de la documentation générée](#doc.output_format)" en json ou si "[Contenu généré](#doc.contents)" n'est pas variables ou changelog
> **Désactivé** : si "[le format de sortie de la documentation générée](#doc.output_format)" en json ou si "[contenu généré](#doc.contents)" n'est pas variables ou changelog.
| Variable | Description | Valeur par défaut | Type | Contrôle des accès | Validateur |
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------|---------------------|---------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------|
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------|---------------------|---------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------|
| **<a id="doc.tabulars.without_family" name="doc.tabulars.without_family">doc.tabulars.without_family</a>**<br/>**Ligne de commande** : <br/>•&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/>**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 | 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.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
@ -60,7 +60,7 @@ include_toc: true
>
> **Chemin** : doc.changelog\
> *`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 |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------|
@ -72,7 +72,7 @@ include_toc: true
>
> **Chemin** : doc.examples\
> *`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 |
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------|---------------------|---------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|

18
README.md
View file

@ -11,13 +11,13 @@ 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.\
> **Path**: doc\
> *`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 |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------|-----------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------|
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------|-----------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------|
| **<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.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.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.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.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.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" | |
@ -45,14 +45,14 @@ include_toc: true
>
> **Path**: doc.tabulars\
> *`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 |
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------|-----------------|-------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------|
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------|-----------------|-------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------|
| **<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_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
@ -60,7 +60,7 @@ include_toc: true
>
> **Path**: doc.changelog\
> *`disabled`*\
> **Disabled**: if changelog in not in "[Generated content](#doc.contents)"
> **Disabled**: if changelog in not in "[generated content](#doc.contents)".
| Variable | Description | Type |
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------|
@ -72,7 +72,7 @@ include_toc: true
>
> **Path**: doc.examples\
> *`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 |
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------|-----------------|-------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|

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

@ -5,8 +5,8 @@
msgid ""
msgstr ""
"Project-Id-Version: \n"
"POT-Creation-Date: 2026-03-29 10:57+0200\n"
"PO-Revision-Date: 2026-03-29 10:58+0200\n"
"POT-Creation-Date: 2026-03-29 14:58+0200\n"
"PO-Revision-Date: 2026-03-29 14:58+0200\n"
"Last-Translator: \n"
"Language-Team: \n"
"Language: fr\n"
@ -48,140 +48,140 @@ msgstr ""
"ne peut trouver l'information \"{0}_calculation\", avez-vous annoté cette "
"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}\""
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}\""
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}"
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"
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}"
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"
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}\""
msgstr "est \"{0}\""
#: src/rougail/output_doc/collect.py:195
#: src/rougail/output_doc/collect.py:196
msgid "is accessible"
msgstr "est accessible"
#: src/rougail/output_doc/collect.py:197
#: src/rougail/output_doc/collect.py:198
msgid "is defined"
msgstr "est définie"
#: src/rougail/output_doc/collect.py:202
#: src/rougail/output_doc/collect.py:203
msgid "hasn't the value \"{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}\""
msgstr "a la valeur \"{0}\""
#: src/rougail/output_doc/collect.py:208
#: src/rougail/output_doc/collect.py:209
msgid "is {0}"
msgstr "est {0}"
#: src/rougail/output_doc/collect.py:210
#: src/rougail/output_doc/collect.py:211
msgid "when the 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"
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}\""
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)"
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)"
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"
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}\""
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}\""
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"
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"
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"
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"
msgstr "Cette famille est un espace de nom"
#: src/rougail/output_doc/collect.py:461
#: src/rougail/output_doc/collect.py:462
msgid "Example"
msgstr "Exemple"
#: src/rougail/output_doc/collect.py:464
#: src/rougail/output_doc/collect.py:465
msgid "Examples"
msgstr "Exemples"
#: src/rougail/output_doc/collect.py:470
#: src/rougail/output_doc/collect.py:471
msgid "Tag"
msgstr "Étiquette"
#: src/rougail/output_doc/collect.py:473
#: src/rougail/output_doc/collect.py:474
msgid "Tags"
msgstr "Étiquettes"
#: src/rougail/output_doc/collect.py:567
#: src/rougail/output_doc/collect.py:568
msgid "text based with regular expressions \"{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
msgid "Validator"
msgstr "Validateur"
#: src/rougail/output_doc/collect.py:574
#: src/rougail/output_doc/collect.py:575
msgid "Validators"
msgstr "Validateurs"
#: src/rougail/output_doc/collect.py:583
#: src/rougail/output_doc/collect.py:584
msgid "Choices"
msgstr "Choix"
#: src/rougail/output_doc/collect.py:633
#: src/rougail/output_doc/collect.py:634
msgid "Default"
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}"
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é"
#: src/rougail/output_doc/config.py:119
msgid "Generate documentation from structural files"
msgstr "Générer la documentation depuis les fichiers de structure"
msgid "generate documentation from structural files"
msgstr "générer la documentation depuis les fichiers de structure"
#: src/rougail/output_doc/config.py:120
msgid ""
@ -215,12 +215,12 @@ msgid "if \"step.output\" is not doc"
msgstr "si \"step.output\" n'est pas doc"
#: src/rougail/output_doc/config.py:128
msgid "The output format of the generated documentation"
msgstr "Le format de sortie de la documentation générée"
msgid "the output format of the generated documentation"
msgstr "le format de sortie de la documentation générée"
#: src/rougail/output_doc/config.py:137
msgid "Generate document with this tabular model"
msgstr "Génère la documentation avec ce modèle de tableau"
msgid "generate document with this tabular model"
msgstr "génère la documentation avec ce modèle de tableau"
#: src/rougail/output_doc/config.py:138
msgid ""
@ -232,11 +232,11 @@ msgstr ""
#: src/rougail/output_doc/config.py:146
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
msgid "Generated content"
msgstr "Contenu généré"
msgid "generated content"
msgstr "contenu généré"
#: src/rougail/output_doc/config.py:154
msgid ""
@ -252,8 +252,8 @@ msgid ""
"\"_.output_format\" in json is not compatible with changelog or example "
"\"_.contents\""
msgstr ""
"\"_.output_format\" en json n'est pas compatible avec \"_.contents\" "
"changelog or example"
"\"_.output_format\" json n'est pas compatible avec le \"_.contents\" "
"changelog ou example"
#: src/rougail/output_doc/config.py:170
msgid "Starting title level"
@ -304,7 +304,7 @@ msgstr "Nom du fichier"
#: src/rougail/output_doc/config.py:204
msgid "Documentation a structural type"
msgstr "Documenter type de structure"
msgstr "Documenter un type de structure"
#: src/rougail/output_doc/config.py:208
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
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
msgid "Add environment variable informations in documentation"
msgid "add environment variable informations in documentation"
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
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\""
#: 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 ""
"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"
#: src/rougail/output_doc/config.py:272
@ -420,29 +420,29 @@ msgstr "Variable"
msgid "Description"
msgstr "Description"
#: src/rougail/output_doc/utils.py:198
#: src/rougail/output_doc/utils.py:204
msgid "Command line"
msgstr "Ligne de commande"
#: src/rougail/output_doc/utils.py:216
#: src/rougail/output_doc/utils.py:222
msgid "Environment variable"
msgstr "Variable d'environnement"
#: src/rougail/output_doc/utils.py:526
#: src/rougail/output_doc/utils.py:532
msgid "Path"
msgstr "Chemin"
#: src/rougail/output_doc/utils.py:536
#: src/rougail/output_doc/utils.py:542
msgid "Identifiers"
msgstr "Identifiants"
#: src/rougail/output_doc/utils.py:790 src/rougail/output_doc/utils.py:799
#: src/rougail/output_doc/utils.py:805 src/rougail/output_doc/utils.py:811
#: src/rougail/output_doc/utils.py:815
#: src/rougail/output_doc/utils.py:796 src/rougail/output_doc/utils.py:805
#: src/rougail/output_doc/utils.py:811 src/rougail/output_doc/utils.py:817
#: src/rougail/output_doc/utils.py:821
msgid "(default)"
msgstr "(défaut)"
#: src/rougail/output_doc/utils.py:1123
#: src/rougail/output_doc/utils.py:1129
msgid "{0}: {1}"
msgstr "{0} : {1}"

100
locale/rougail_output_doc.pot
View file

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

21
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.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 _
@ -61,32 +61,41 @@ class _ToString:
if value is not None:
values.append(value)
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:
return ret[0]
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:
values = calculation
if self.document_a_type and "variables" in values:
for variable in list(values["variables"]):
variable["path"] = self.doc_path(variable["path"])
if not inside_list:
values["description"] = add_dot(values["description"])
elif "type" not in calculation:
values = calculation["value"]
if isinstance(values, str) and not inside_list:
values = add_dot(values)
elif calculation["type"] == "jinja":
values = self._calculation_jinja_to_string(
child, calculation, attribute_type
)
if isinstance(values, str) and not inside_list:
values = add_dot(values)
elif calculation["type"] == "variable":
values = self._calculation_variable_to_string(
child, calculation, attribute_type
)
if isinstance(values, str) and not inside_list:
values = add_dot(values)
elif calculation["type"] == "identifier":
values = self._calculation_identifier_to_string(
child, calculation, attribute_type
)
if isinstance(values, str) and not inside_list:
values = add_dot(values)
elif calculation["type"] == "information":
if "path" in calculation:
variable_path = self.doc_path(calculation["path"])
@ -97,8 +106,12 @@ class _ToString:
values = _('the value of the global information "{0}"').format(
calculation["information"]
)
if not inside_list:
values = add_dot(values)
else:
values = _("the value of the {0}").format(calculation["type"])
if not inside_list:
values = add_dot(values)
return values
def _calculation_jinja_to_string(self, child, calculation, attribute_type):

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

@ -116,7 +116,7 @@ cli:
description: {_('is true if doc is activate')}
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.')}
disabled:
jinja: |-
@ -125,7 +125,7 @@ doc:
description: {_('if "step.output" is not doc')}
output_format:
description: {_('The output format of the generated documentation')}
description: {_('the output format of the generated documentation')}
alternative_name: do
default: { output_format_default }
choices:
@ -134,7 +134,7 @@ doc:
rougail_options += f" - {output}\n"
rougail_options += f"""
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.")}
alternative_name: dm
default: { tabular_default }
@ -150,7 +150,7 @@ doc:
rougail_options += f" - {tabular}\n"
rougail_options += f"""
contents:
description: {_('Generated content')}
description: {_('generated content')}
help: {_('You can generate three type of document. All variables ("variables"), an example file in YAML format ("example") or change log ("changelog").')}
alternative_name: dc
choices:
@ -218,12 +218,12 @@ doc:
alternative_name: df
with_commandline:
description: {_('Add command line informations in documentation')}
description: {_('add command line informations in documentation')}
alternative_name: dw
default: false
with_environment:
description: {_('Add environment variable informations in documentation')}
description: {_('add environment variable informations in documentation')}
alternative_name: de
default: false
@ -264,7 +264,7 @@ doc:
description: {_('if example is not in "_.contents"')}
comment:
description: {_('Add description of variables and families when generate examples')}
description: {_('add description of variables and families when generate examples')}
alternative_name: dx
default: false

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

Binary file not shown.

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

@ -61,8 +61,7 @@ def to_phrase(msg, type_="variable"):
msg = str(msg).strip()
# a phrase must ends with a dot
if type_ == "variable":
if not msg.endswith("."):
msg += "."
msg = add_dot(msg)
elif type_ in ["family", "description"]:
if msg.endswith("."):
msg = msg[:-1]
@ -72,6 +71,13 @@ def to_phrase(msg, type_="variable"):
return msg[0].upper() + msg[1:]
def add_dot(msg):
last_char = msg[-1]
if last_char not in [".", "?", "!", ",", ":", ";"]:
msg += "."
return msg
class CommonTabular:
"""Class with common function for tabular"""

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

@ -6,6 +6,6 @@
| **var** +
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A first variable. +
**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>
| 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>

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

@ -5,7 +5,7 @@
<tr><th>Variable </th><th>Description </th></tr>
</thead>
<tbody>
<tr><td><b>var</b><br/><mark><a href='https://rougail.readthedocs.io/en/latest/variable.html#variables-types'>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>
</table>

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

@ -1,6 +1,6 @@
# Modified variable
| 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. │
│  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** +
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `__mandatory__` | A first variable. +
**Default**: no +
**Mandatory**: +++if condition is yes+++ +
#if condition is not no#
**Mandatory**: +++if condition is yes.+++ +
#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>
| 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>

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

@ -5,7 +5,7 @@
<tr><th>Variable </th><th>Description </th></tr>
</thead>
<tbody>
<tr><td><b>var</b><br/><mark><a href='https://rougail.readthedocs.io/en/latest/variable.html#variables-types'>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>
</table>

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

@ -1,6 +1,6 @@
# Modified variable
| 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. │
│  string   standard   mandatory  │ Default: no │
│ │ Mandatory: if condition is yes │
│ │ if condition is not no │
│ │ Mandatory: if condition is yes. │
│ │ if condition is not no. │
└───────────────────────────────────────┴──────────────────────────────────────┘

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

@ -6,6 +6,6 @@
| **var** +
`+++hidden+++` `https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | A first variable. +
**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>
| 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>

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

@ -5,7 +5,7 @@
<tr><th>Variable </th><th>Description </th></tr>
</thead>
<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>
</table>

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

@ -1,6 +1,6 @@
# Modified variable
| 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. │
│  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** +
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `#__hidden__#` | A first variable. +
**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>
| 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>

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

@ -5,7 +5,7 @@
<tr><th>Variable </th><th>Description </th></tr>
</thead>
<tbody>
<tr><td><b>var</b><br/><mark><a href='https://rougail.readthedocs.io/en/latest/variable.html#variables-types'>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>
</table>

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

@ -1,6 +1,6 @@
# Modified variable
| 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. │
│  string   standard   mandatory    │ Default: no │
│ hidden  │ Hidden: if condition is yes │
│ hidden  │ Hidden: if condition is yes. │
└───────────────────────────────────────┴──────────────────────────────────────┘

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.
| **var2** +
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `mandatory` | My var2. +
**Default**: var calculated
**Default**: var calculated.
| **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** +
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `mandatory` | My var4.
| **var5** +
@ -25,7 +25,7 @@
*
| **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

2
tests/force_optional/00_file.yml
View file

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

2
tests/mode_basic.adoc
View file

@ -6,6 +6,6 @@
**Default**: the value of an undocumented variable
| **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
| **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.
| **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/result_tutorial/061/doc.json
View file

@ -276,7 +276,7 @@
"name": "disabled",
"ori_name": "disabled",
"access_control": true,
"annotation": "when the identifier is \"HTTPS\""
"annotation": "when the identifier is \"HTTPS\"."
}
],
"mode": "standard",

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

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

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

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

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

@ -148,7 +148,7 @@
"name": "hidden",
"ori_name": "hidden",
"access_control": true,
"annotation": "depends on a calculation"
"annotation": "depends on a calculation."
}
],
"mode": "standard",
@ -270,7 +270,7 @@
"name": "disabled",
"ori_name": "disabled",
"access_control": true,
"annotation": "when the identifier is \"HTTPS\""
"annotation": "when the identifier is \"HTTPS\"."
}
],
"mode": "standard",

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

@ -61,7 +61,7 @@
▌  • manual.https_proxy
▌  • manual.socks_proxy
▌  standard   hidden 
▌ Hidden: depends on a calculation
▌ Hidden: depends on a calculation.
▌ Identifiers:
▌  • HTTPS
▌  • SOCKS
@ -92,7 +92,7 @@
│ disabled  │ • v4 │
│ │ • v5 ← (default) │
│ │ Disabled: when the identifier is │
│ │ "HTTPS" │
│ │ "HTTPS". │
└───────────────────────────────────────┴──────────────────────────────────────┘

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

@ -149,7 +149,7 @@
"ori_name": "hidden",
"access_control": true,
"annotation": {
"description": "in HTTPS case if \"{0}\" is set to \"true\"",
"description": "in HTTPS case if \"{0}\" is set to \"true\".",
"variables": [
{
"path": "manual.use_for_https",
@ -278,7 +278,7 @@
"name": "disabled",
"ori_name": "disabled",
"access_control": true,
"annotation": "when the identifier is \"HTTPS\""
"annotation": "when the identifier is \"HTTPS\"."
}
],
"mode": "standard",

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

@ -61,7 +61,7 @@
▌  • manual.https_proxy
▌  • manual.socks_proxy
▌  standard   hidden 
▌ Hidden: in HTTPS case if "manual.use_for_https" is set to "true"
▌ Hidden: in HTTPS case if "manual.use_for_https" is set to "true".
▌ Identifiers:
▌  • HTTPS
▌  • SOCKS
@ -92,7 +92,7 @@
│ disabled  │ • v4 │
│ │ • v5 ← (default) │
│ │ Disabled: when the identifier is │
│ │ "HTTPS" │
│ │ "HTTPS". │
└───────────────────────────────────────┴──────────────────────────────────────┘

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

@ -149,7 +149,7 @@
"ori_name": "hidden",
"access_control": true,
"annotation": {
"description": "in HTTPS case if \"{0}\" is set to \"true\"",
"description": "in HTTPS case if \"{0}\" is set to \"true\".",
"variables": [
{
"path": "manual.use_for_https",
@ -278,7 +278,7 @@
"name": "disabled",
"ori_name": "disabled",
"access_control": true,
"annotation": "when the identifier is \"HTTPS\""
"annotation": "when the identifier is \"HTTPS\"."
}
],
"mode": "standard",

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

@ -61,7 +61,7 @@
▌  • manual.https_proxy
▌  • manual.socks_proxy
▌  standard   hidden 
▌ Hidden: in HTTPS case if "manual.use_for_https" is set to "true"
▌ Hidden: in HTTPS case if "manual.use_for_https" is set to "true".
▌ Identifiers:
▌  • HTTPS
▌  • SOCKS
@ -92,7 +92,7 @@
│ disabled  │ • v4 │
│ │ • v5 ← (default) │
│ │ Disabled: when the identifier is │
│ │ "HTTPS" │
│ │ "HTTPS". │
└───────────────────────────────────────┴──────────────────────────────────────┘

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

@ -149,7 +149,7 @@
"ori_name": "hidden",
"access_control": true,
"annotation": {
"description": "in HTTPS case if \"{0}\" is set to \"true\"",
"description": "in HTTPS case if \"{0}\" is set to \"true\".",
"variables": [
{
"path": "manual.use_for_https",
@ -278,7 +278,7 @@
"name": "disabled",
"ori_name": "disabled",
"access_control": true,
"annotation": "when the identifier is \"HTTPS\""
"annotation": "when the identifier is \"HTTPS\"."
}
],
"mode": "standard",

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

@ -61,7 +61,7 @@
▌  • manual.https_proxy
▌  • manual.socks_proxy
▌  standard   hidden 
▌ Hidden: in HTTPS case if "manual.use_for_https" is set to "true"
▌ Hidden: in HTTPS case if "manual.use_for_https" is set to "true".
▌ Identifiers:
▌  • HTTPS
▌  • SOCKS
@ -92,7 +92,7 @@
│ disabled  │ • v4 │
│ │ • v5 ← (default) │
│ │ Disabled: when the identifier is │
│ │ "HTTPS" │
│ │ "HTTPS". │
└───────────────────────────────────────┴──────────────────────────────────────┘

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

@ -149,7 +149,7 @@
"ori_name": "hidden",
"access_control": true,
"annotation": {
"description": "in HTTPS case if \"{0}\" is set to \"true\"",
"description": "in HTTPS case if \"{0}\" is set to \"true\".",
"variables": [
{
"path": "manual.use_for_https",
@ -278,7 +278,7 @@
"name": "disabled",
"ori_name": "disabled",
"access_control": true,
"annotation": "when the identifier is \"HTTPS\""
"annotation": "when the identifier is \"HTTPS\"."
}
],
"mode": "standard",

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

@ -61,7 +61,7 @@
▌  • manual.https_proxy
▌  • manual.socks_proxy
▌  standard   hidden 
▌ Hidden: in HTTPS case if "manual.use_for_https" is set to "true"
▌ Hidden: in HTTPS case if "manual.use_for_https" is set to "true".
▌ Identifiers:
▌  • HTTPS
▌  • SOCKS
@ -92,7 +92,7 @@
│ disabled  │ • v4 │
│ │ • v5 ← (default) │
│ │ Disabled: when the identifier is │
│ │ "HTTPS" │
│ │ "HTTPS". │
└───────────────────────────────────────┴──────────────────────────────────────┘

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

@ -480,7 +480,7 @@
"ori_name": "disabled",
"access_control": true,
"annotation": {
"description": "if \"{0}\" is not \"Manual proxy configuration\"\nor \"{1}\" is \"v4\"",
"description": "if \"{0}\" is not \"Manual proxy configuration\"\nor \"{1}\" is \"v4\".",
"variables": [
{
"path": "proxy_mode",

2
tests/result_tutorial/112/doc.sh
View file

@ -165,5 +165,5 @@
│ disabled  │ Disabled: if "proxy_mode" is not │
│ │ "Manual proxy configuration" │
│ │ or "manual.socks_proxy.version" is │
│ │ "v4" │
│ │ "v4". │
└───────────────────────────────────────┴──────────────────────────────────────┘

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

@ -8,6 +8,6 @@
│ disabled  │ Disabled: if "proxy_mode" is not  │
│ │ "Manual proxy configuration" │
│ │ or "manual.socks_proxy.version" is  │
│ │ "v4" │
│ │ "v4". │
└───────────────────────────────────────┴──────────────────────────────────────┘

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

@ -480,7 +480,7 @@
"ori_name": "disabled",
"access_control": true,
"annotation": {
"description": "if \"{0}\" is not \"Manual proxy configuration\"\nor \"{1}\" is \"v4\"",
"description": "if \"{0}\" is not \"Manual proxy configuration\"\nor \"{1}\" is \"v4\".",
"variables": [
{
"path": "proxy_mode",

2
tests/result_tutorial/120/doc.sh
View file

@ -165,5 +165,5 @@
│ disabled  │ Disabled: if "proxy_mode" is not │
│ │ "Manual proxy configuration" │
│ │ or "manual.socks_proxy.version" is │
│ │ "v4" │
│ │ "v4". │
└───────────────────────────────────────┴──────────────────────────────────────┘

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

@ -480,7 +480,7 @@
"ori_name": "disabled",
"access_control": true,
"annotation": {
"description": "if \"{0}\" is not \"Manual proxy configuration\"\nor \"{1}\" is \"v4\"",
"description": "if \"{0}\" is not \"Manual proxy configuration\"\nor \"{1}\" is \"v4\".",
"variables": [
{
"path": "proxy_mode",

2
tests/result_tutorial/130/doc.sh
View file

@ -165,5 +165,5 @@
│ disabled  │ Disabled: if "proxy_mode" is not │
│ │ "Manual proxy configuration" │
│ │ or "manual.socks_proxy.version" is │
│ │ "v4" │
│ │ "v4". │
└───────────────────────────────────────┴──────────────────────────────────────┘

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

@ -8,6 +8,6 @@
│ advanced   mandatory   disabled  │ Disabled: if "proxy_mode" is not │
│ │ "Manual proxy configuration" │
│ │ or "manual.socks_proxy.version" is │
│ │ "v4" │
│ │ "v4". │
└───────────────────────────────────────┴──────────────────────────────────────┘

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

@ -480,7 +480,7 @@
"ori_name": "disabled",
"access_control": true,
"annotation": {
"description": "if \"{0}\" is not \"Manual proxy configuration\"\nor \"{1}\" is \"v4\"",
"description": "if \"{0}\" is not \"Manual proxy configuration\"\nor \"{1}\" is \"v4\".",
"variables": [
{
"path": "proxy_mode",

2
tests/result_tutorial/140/doc.sh
View file

@ -165,7 +165,7 @@
│ disabled  │ Disabled: if "proxy_mode" is not │
│ │ "Manual proxy configuration" │
│ │ or "manual.socks_proxy.version" is │
│ │ "v4" │
│ │ "v4". │
└───────────────────────────────────────┴──────────────────────────────────────┘
DNS over HTTPS

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

@ -480,7 +480,7 @@
"ori_name": "disabled",
"access_control": true,
"annotation": {
"description": "if \"{0}\" is not \"Manual proxy configuration\"\nor \"{1}\" is \"v4\"",
"description": "if \"{0}\" is not \"Manual proxy configuration\"\nor \"{1}\" is \"v4\".",
"variables": [
{
"path": "proxy_mode",

2
tests/result_tutorial/141/doc.sh
View file

@ -165,7 +165,7 @@
│ disabled  │ Disabled: if "proxy_mode" is not │
│ │ "Manual proxy configuration" │
│ │ or "manual.socks_proxy.version" is │
│ │ "v4" │
│ │ "v4". │
└───────────────────────────────────────┴──────────────────────────────────────┘
DNS over HTTPS

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

@ -480,7 +480,7 @@
"ori_name": "disabled",
"access_control": true,
"annotation": {
"description": "if \"{0}\" is not \"Manual proxy configuration\"\nor \"{1}\" is \"v4\"",
"description": "if \"{0}\" is not \"Manual proxy configuration\"\nor \"{1}\" is \"v4\".",
"variables": [
{
"path": "proxy_mode",
@ -590,7 +590,7 @@
"ori_name": "disabled",
"access_control": true,
"annotation": {
"description": "if \"{0}\" is not \"Custom\"",
"description": "if \"{0}\" is not \"Custom\".",
"variables": [
{
"path": "dns_over_https.provider",

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

@ -165,7 +165,7 @@
│ disabled  │ Disabled: if "proxy_mode" is not │
│ │ "Manual proxy configuration" │
│ │ or "manual.socks_proxy.version" is │
│ │ "v4" │
│ │ "v4". │
└───────────────────────────────────────┴──────────────────────────────────────┘
DNS over HTTPS
@ -199,6 +199,6 @@
│ │ • the domain name can be a hostname │
│ │ Disabled: if │
│ │ "dns_over_https.provider" is not │
│ │ "Custom" │
│ │ "Custom". │
└───────────────────────────────────────┴──────────────────────────────────────┘

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

@ -13,6 +13,6 @@
│ │ • the domain name can be a hostname │
│ │ Disabled: if │
│ │ "dns_over_https.provider" is not │
│ │ "Custom" │
│ │ "Custom". │
└───────────────────────────────────────┴──────────────────────────────────────┘

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

@ -480,7 +480,7 @@
"ori_name": "disabled",
"access_control": true,
"annotation": {
"description": "if \"{0}\" is not \"Manual proxy configuration\"\nor \"{1}\" is \"v4\"",
"description": "if \"{0}\" is not \"Manual proxy configuration\"\nor \"{1}\" is \"v4\".",
"variables": [
{
"path": "proxy_mode",
@ -590,7 +590,7 @@
"ori_name": "disabled",
"access_control": true,
"annotation": {
"description": "if \"{0}\" is not \"Custom\"",
"description": "if \"{0}\" is not \"Custom\".",
"variables": [
{
"path": "dns_over_https.provider",

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

@ -165,7 +165,7 @@
│ disabled  │ Disabled: if "proxy_mode" is not │
│ │ "Manual proxy configuration" │
│ │ or "manual.socks_proxy.version" is │
│ │ "v4" │
│ │ "v4". │
└───────────────────────────────────────┴──────────────────────────────────────┘
DNS over HTTPS
@ -200,6 +200,6 @@
│ │ • must starts with 'https://' only │
│ │ Disabled: if │
│ │ "dns_over_https.provider" is not │
│ │ "Custom" │
│ │ "Custom". │
└───────────────────────────────────────┴──────────────────────────────────────┘

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

@ -14,6 +14,6 @@
│ │ • must starts with 'https://' only │
│ │ Disabled: if │
│ │ "dns_over_https.provider" is not │
│ │ "Custom" │
│ │ "Custom". │
└───────────────────────────────────────┴──────────────────────────────────────┘

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

@ -493,7 +493,7 @@
"ori_name": "disabled",
"access_control": true,
"annotation": {
"description": "if \"{0}\" is not \"Manual proxy configuration\"\nor \"{1}\" is \"v4\"",
"description": "if \"{0}\" is not \"Manual proxy configuration\"\nor \"{1}\" is \"v4\".",
"variables": [
{
"path": "firefox.proxy_mode",
@ -603,7 +603,7 @@
"ori_name": "disabled",
"access_control": true,
"annotation": {
"description": "if \"{0}\" is not \"Custom\"",
"description": "if \"{0}\" is not \"Custom\".",
"variables": [
{
"path": "firefox.dns_over_https.provider",

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

@ -175,7 +175,7 @@
│ │ not "Manual proxy configuration" │
│ │ or │
│ │ "firefox.manual.socks_proxy.version" │
│ │ is "v4" │
│ │ is "v4". │
└───────────────────────────────────────┴──────────────────────────────────────┘
DNS over HTTPS
@ -210,7 +210,7 @@
│ │ • must starts with 'https://' only │
│ │ Disabled: if │
│ │ "firefox.dns_over_https.provider" is │
│ │ not "Custom" │
│ │ not "Custom". │
└───────────────────────────────────────┴──────────────────────────────────────┘

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

@ -119,7 +119,7 @@
│ │ not "Manual proxy configuration" │
│ │ or │
│ │ "firefox.manual.socks_proxy.version" │
│ │ is "v4" │
│ │ is "v4". │
├───────────────────────────────────────┼──────────────────────────────────────┤
│ firefox.dns_over_https.enable_dns_ov… │ Enable DNS over HTTPS. │
│  boolean   standard   mandatory  │ Default: false │
@ -144,7 +144,7 @@
│ │ • must starts with 'https://' only │
│ │ Disabled: if │
│ │ "firefox.dns_over_https.provider" is │
│ │ not "Custom" │
│ │ not "Custom". │
└───────────────────────────────────────┴──────────────────────────────────────┘
Deleted variables

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

@ -493,7 +493,7 @@
"ori_name": "disabled",
"access_control": true,
"annotation": {
"description": "if \"{0}\" is not \"Manual proxy configuration\"\nor \"{1}\" is \"v4\"",
"description": "if \"{0}\" is not \"Manual proxy configuration\"\nor \"{1}\" is \"v4\".",
"variables": [
{
"path": "firefox.proxy_mode",
@ -603,7 +603,7 @@
"ori_name": "disabled",
"access_control": true,
"annotation": {
"description": "if \"{0}\" is not \"Custom\"",
"description": "if \"{0}\" is not \"Custom\".",
"variables": [
{
"path": "firefox.dns_over_https.provider",

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

@ -175,7 +175,7 @@
│ │ not "Manual proxy configuration" │
│ │ or │
│ │ "firefox.manual.socks_proxy.version" │
│ │ is "v4" │
│ │ is "v4". │
└───────────────────────────────────────┴──────────────────────────────────────┘
DNS over HTTPS
@ -210,7 +210,7 @@
│ │ • must starts with 'https://' only │
│ │ Disabled: if │
│ │ "firefox.dns_over_https.provider" is │
│ │ not "Custom" │
│ │ not "Custom". │
└───────────────────────────────────────┴──────────────────────────────────────┘

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

@ -493,7 +493,7 @@
"ori_name": "disabled",
"access_control": true,
"annotation": {
"description": "if \"{0}\" is not \"Manual proxy configuration\"\nor \"{1}\" is \"v4\"",
"description": "if \"{0}\" is not \"Manual proxy configuration\"\nor \"{1}\" is \"v4\".",
"variables": [
{
"path": "firefox.proxy_mode",
@ -603,7 +603,7 @@
"ori_name": "disabled",
"access_control": true,
"annotation": {
"description": "if \"{0}\" is not \"Custom\"",
"description": "if \"{0}\" is not \"Custom\".",
"variables": [
{
"path": "firefox.dns_over_https.provider",

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

@ -175,7 +175,7 @@
│ │ not "Manual proxy configuration" │
│ │ or │
│ │ "firefox.manual.socks_proxy.version" │
│ │ is "v4" │
│ │ is "v4". │
└───────────────────────────────────────┴──────────────────────────────────────┘
DNS over HTTPS
@ -210,7 +210,7 @@
│ │ • must starts with 'https://' only │
│ │ Disabled: if │
│ │ "firefox.dns_over_https.provider" is │
│ │ not "Custom" │
│ │ not "Custom". │
└───────────────────────────────────────┴──────────────────────────────────────┘

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

@ -493,7 +493,7 @@
"ori_name": "disabled",
"access_control": true,
"annotation": {
"description": "if \"{0}\" is not \"Manual proxy configuration\"\nor \"{1}\" is \"v4\"",
"description": "if \"{0}\" is not \"Manual proxy configuration\"\nor \"{1}\" is \"v4\".",
"variables": [
{
"path": "firefox.proxy_mode",
@ -603,7 +603,7 @@
"ori_name": "disabled",
"access_control": true,
"annotation": {
"description": "if \"{0}\" is not \"Custom\"",
"description": "if \"{0}\" is not \"Custom\".",
"variables": [
{
"path": "firefox.dns_over_https.provider",

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

@ -175,7 +175,7 @@
│ │ not "Manual proxy configuration" │
│ │ or │
│ │ "firefox.manual.socks_proxy.version" │
│ │ is "v4" │
│ │ is "v4". │
└───────────────────────────────────────┴──────────────────────────────────────┘
DNS over HTTPS
@ -210,7 +210,7 @@
│ │ • must starts with 'https://' only │
│ │ Disabled: if │
│ │ "firefox.dns_over_https.provider" is │
│ │ not "Custom" │
│ │ not "Custom". │
└───────────────────────────────────────┴──────────────────────────────────────┘

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

@ -493,7 +493,7 @@
"ori_name": "disabled",
"access_control": true,
"annotation": {
"description": "if \"{0}\" is not \"Manual proxy configuration\"\nor \"{1}\" is \"v4\"",
"description": "if \"{0}\" is not \"Manual proxy configuration\"\nor \"{1}\" is \"v4\".",
"variables": [
{
"path": "firefox.proxy_mode",
@ -603,7 +603,7 @@
"ori_name": "disabled",
"access_control": true,
"annotation": {
"description": "if \"{0}\" is not \"Custom\"",
"description": "if \"{0}\" is not \"Custom\".",
"variables": [
{
"path": "firefox.dns_over_https.provider",
@ -693,7 +693,7 @@
"default": {
"name": "Default",
"values": {
"description": "random color value"
"description": "random color value."
}
},
"variable_type": "regexp",

6
tests/result_tutorial/181/doc.sh
View file

@ -175,7 +175,7 @@
│ │ not "Manual proxy configuration" │
│ │ or │
│ │ "firefox.manual.socks_proxy.version" │
│ │ is "v4" │
│ │ is "v4". │
└───────────────────────────────────────┴──────────────────────────────────────┘
DNS over HTTPS
@ -210,7 +210,7 @@
│ │ • must starts with 'https://' only │
│ │ Disabled: if │
│ │ "firefox.dns_over_https.provider" is │
│ │ not "Custom" │
│ │ not "Custom". │
└───────────────────────────────────────┴──────────────────────────────────────┘
@ -241,7 +241,7 @@
│  regexp   standard   mandatory  │ Validator: text based with regular │
│ │ expressions │
│ │ "^#(?:[0-9a-f]{3}){1,2}$" │
│ │ Default: random color value │
│ │ Default: random color value. │
└───────────────────────────────────────┴──────────────────────────────────────┘

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

@ -7,6 +7,6 @@
│  basic   standard   regexp   standard │ Validator: text based with regular │
│ mandatory  │ expressions │
│ │ "^#(?:[0-9a-f]{3}){1,2}$" │
│ │ Default: random color value │
│ │ Default: random color value. │
└───────────────────────────────────────┴──────────────────────────────────────┘

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

@ -493,7 +493,7 @@
"ori_name": "disabled",
"access_control": true,
"annotation": {
"description": "if \"{0}\" is not \"Manual proxy configuration\"\nor \"{1}\" is \"v4\"",
"description": "if \"{0}\" is not \"Manual proxy configuration\"\nor \"{1}\" is \"v4\".",
"variables": [
{
"path": "firefox.proxy_mode",
@ -603,7 +603,7 @@
"ori_name": "disabled",
"access_control": true,
"annotation": {
"description": "if \"{0}\" is not \"Custom\"",
"description": "if \"{0}\" is not \"Custom\".",
"variables": [
{
"path": "firefox.dns_over_https.provider",
@ -699,7 +699,7 @@
"default": {
"name": "Default",
"values": {
"description": "random color value"
"description": "random color value."
}
},
"variable_type": "regexp",

6
tests/result_tutorial/182/doc.sh
View file

@ -175,7 +175,7 @@
│ │ not "Manual proxy configuration" │
│ │ or │
│ │ "firefox.manual.socks_proxy.version" │
│ │ is "v4" │
│ │ is "v4". │
└───────────────────────────────────────┴──────────────────────────────────────┘
DNS over HTTPS
@ -210,7 +210,7 @@
│ │ • must starts with 'https://' only │
│ │ Disabled: if │
│ │ "firefox.dns_over_https.provider" is │
│ │ not "Custom" │
│ │ not "Custom". │
└───────────────────────────────────────┴──────────────────────────────────────┘
@ -241,7 +241,7 @@
│  regexp   basic   mandatory   auto  │ Validator: text based with regular │
│ modified  │ expressions │
│ │ "^#(?:[0-9a-f]{3}){1,2}$" │
│ │ Default: random color value │
│ │ Default: random color value. │
└───────────────────────────────────────┴──────────────────────────────────────┘

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

@ -7,6 +7,6 @@
│  standard   basic   regexp   basic    │ Validator: text based with regular │
│ mandatory   auto modified  │ expressions │
│ │ "^#(?:[0-9a-f]{3}){1,2}$" │
│ │ Default: random color value │
│ │ Default: random color value. │
└───────────────────────────────────────┴──────────────────────────────────────┘

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

@ -493,7 +493,7 @@
"ori_name": "disabled",
"access_control": true,
"annotation": {
"description": "if \"{0}\" is not \"Manual proxy configuration\"\nor \"{1}\" is \"v4\"",
"description": "if \"{0}\" is not \"Manual proxy configuration\"\nor \"{1}\" is \"v4\".",
"variables": [
{
"path": "firefox.proxy_mode",
@ -603,7 +603,7 @@
"ori_name": "disabled",
"access_control": true,
"annotation": {
"description": "if \"{0}\" is not \"Custom\"",
"description": "if \"{0}\" is not \"Custom\".",
"variables": [
{
"path": "firefox.dns_over_https.provider",
@ -732,7 +732,7 @@
"default": {
"name": "Default",
"values": {
"description": "random color value"
"description": "random color value."
}
},
"variable_type": "regexp",

6
tests/result_tutorial/190/doc.sh
View file

@ -175,7 +175,7 @@
│ │ not "Manual proxy configuration" │
│ │ or │
│ │ "firefox.manual.socks_proxy.version" │
│ │ is "v4" │
│ │ is "v4". │
└───────────────────────────────────────┴──────────────────────────────────────┘
DNS over HTTPS
@ -210,7 +210,7 @@
│ │ • must starts with 'https://' only │
│ │ Disabled: if │
│ │ "firefox.dns_over_https.provider" is │
│ │ not "Custom" │
│ │ not "Custom". │
└───────────────────────────────────────┴──────────────────────────────────────┘
@ -252,7 +252,7 @@
│  regexp   basic   mandatory   auto  │ Validator: text based with regular │
│ modified  │ expressions │
│ │ "^#(?:[0-9a-f]{3}){1,2}$" │
│ │ Default: random color value │
│ │ Default: random color value. │
└───────────────────────────────────────┴──────────────────────────────────────┘

18
tests/result_tutorial/200/doc.json
View file

@ -493,7 +493,7 @@
"ori_name": "disabled",
"access_control": true,
"annotation": {
"description": "if \"{0}\" is not \"Manual proxy configuration\"\nor \"{1}\" is \"v4\"",
"description": "if \"{0}\" is not \"Manual proxy configuration\"\nor \"{1}\" is \"v4\".",
"variables": [
{
"path": "firefox.proxy_mode",
@ -603,7 +603,7 @@
"ori_name": "disabled",
"access_control": true,
"annotation": {
"description": "if \"{0}\" is not \"Custom\"",
"description": "if \"{0}\" is not \"Custom\".",
"variables": [
{
"path": "firefox.dns_over_https.provider",
@ -732,7 +732,7 @@
"default": {
"name": "Default",
"values": {
"description": "random color value"
"description": "random color value."
}
},
"variable_type": "regexp",
@ -758,7 +758,7 @@
"ori_name": "disabled",
"access_control": true,
"annotation": {
"description": "if type not in:\n- HTTP\n- HTTPS/SSL\n- SOCKS4\n- SOCKS5"
"description": "if type not in:\n- HTTP\n- HTTPS/SSL\n- SOCKS4\n- SOCKS5."
}
}
],
@ -767,7 +767,7 @@
"default": {
"name": "Default",
"values": {
"description": "copy HTTP address if proxy is not \"Manual\""
"description": "copy HTTP address if proxy is not \"Manual\"."
}
},
"variable_type": "domainname",
@ -797,7 +797,7 @@
"ori_name": "disabled",
"access_control": true,
"annotation": {
"description": "if type not in:\n- HTTP\n- HTTPS/SSL\n- SOCKS4\n- SOCKS5"
"description": "if type not in:\n- HTTP\n- HTTPS/SSL\n- SOCKS4\n- SOCKS5."
}
}
],
@ -806,7 +806,7 @@
"default": {
"name": "Default",
"values": {
"description": "copy HTTP port if proxy is not \"Manual\""
"description": "copy HTTP port if proxy is not \"Manual\"."
}
},
"variable_type": "port",
@ -836,7 +836,7 @@
"ori_name": "disabled",
"access_control": true,
"annotation": {
"description": "if type is not in:\n- PAC URL\n- WPAD"
"description": "if type is not in:\n- PAC URL\n- WPAD."
}
}
],
@ -845,7 +845,7 @@
"default": {
"name": "Default",
"values": {
"description": "copy HTTP address if proxy is \"Auto\""
"description": "copy HTTP address if proxy is \"Auto\"."
}
},
"variable_type": "web address",

18
tests/result_tutorial/200/doc.sh
View file

@ -175,7 +175,7 @@
│ │ not "Manual proxy configuration" │
│ │ or │
│ │ "firefox.manual.socks_proxy.version" │
│ │ is "v4" │
│ │ is "v4". │
└───────────────────────────────────────┴──────────────────────────────────────┘
DNS over HTTPS
@ -210,7 +210,7 @@
│ │ • must starts with 'https://' only │
│ │ Disabled: if │
│ │ "firefox.dns_over_https.provider" is │
│ │ not "Custom" │
│ │ not "Custom". │
└───────────────────────────────────────┴──────────────────────────────────────┘
@ -252,7 +252,7 @@
│  regexp   basic   mandatory   auto  │ Validator: text based with regular │
│ modified  │ expressions │
│ │ "^#(?:[0-9a-f]{3}){1,2}$" │
│ │ Default: random color value │
│ │ Default: random color value. │
├───────────────────────────────────────┼──────────────────────────────────────┤
│ foxyproxy.proxies.address │ IP address, DNS name, server name. │
│  domainname   standard   mandatory    │ Validators: │
@ -260,12 +260,12 @@
│ │ • the domain name can be a hostname │
│ │ • the domain name can be an IP │
│ │ Default: copy HTTP address if proxy │
│ │ is not "Manual" │
│ │ is not "Manual". │
│ │ Disabled: if type not in: │
│ │ - HTTP │
│ │ - HTTPS/SSL │
│ │ - SOCKS4 │
│ │ - SOCKS5 │
│ │ - SOCKS5. │
├───────────────────────────────────────┼──────────────────────────────────────┤
│ foxyproxy.proxies.port │ Port. │
│  port   standard   mandatory    │ Validators: │
@ -276,12 +276,12 @@
│ │ • private ports (greater than 49152) │
│ │ are allowed │
│ │ Default: copy HTTP port if proxy is │
│ │ not "Manual" │
│ │ not "Manual". │
│ │ Disabled: if type not in: │
│ │ - HTTP │
│ │ - HTTPS/SSL │
│ │ - SOCKS4 │
│ │ - SOCKS5 │
│ │ - SOCKS5. │
├───────────────────────────────────────┼──────────────────────────────────────┤
│ foxyproxy.proxies.url │ URL. │
│  web address   standard   mandatory  │ Validators: │
@ -292,10 +292,10 @@
│ │ • type domainname │
│ │ • the domain name can be a hostname │
│ │ Default: copy HTTP address if proxy │
│ │ is "Auto" │
│ │ is "Auto". │
│ │ Disabled: if type is not in: │
│ │ - PAC URL │
│ │ - WPAD │
│ │ - WPAD. │
└───────────────────────────────────────┴──────────────────────────────────────┘

12
tests/result_tutorial/200/doc_changelog.sh
View file

@ -9,12 +9,12 @@
│ │ • the domain name can be a hostname │
│ │ • the domain name can be an IP │
│ │ Default: copy HTTP address if proxy │
│ │ is not "Manual" │
│ │ is not "Manual". │
│ │ Disabled: if type not in: │
│ │ - HTTP │
│ │ - HTTPS/SSL │
│ │ - SOCKS4 │
│ │ - SOCKS5 │
│ │ - SOCKS5. │
├───────────────────────────────────────┼──────────────────────────────────────┤
│ foxyproxy.proxies.port │ Port. │
│  port   standard   mandatory    │ Validators: │
@ -25,12 +25,12 @@
│ │ • private ports (greater than 49152) │
│ │ are allowed │
│ │ Default: copy HTTP port if proxy is │
│ │ not "Manual" │
│ │ not "Manual". │
│ │ Disabled: if type not in: │
│ │ - HTTP │
│ │ - HTTPS/SSL │
│ │ - SOCKS4 │
│ │ - SOCKS5 │
│ │ - SOCKS5. │
├───────────────────────────────────────┼──────────────────────────────────────┤
│ foxyproxy.proxies.url │ URL. │
│  web address   standard   mandatory  │ Validators: │
@ -41,9 +41,9 @@
│ │ • type domainname │
│ │ • the domain name can be a hostname │
│ │ Default: copy HTTP address if proxy │
│ │ is "Auto" │
│ │ is "Auto". │
│ │ Disabled: if type is not in: │
│ │ - PAC URL │
│ │ - WPAD │
│ │ - WPAD. │
└───────────────────────────────────────┴──────────────────────────────────────┘

24
tests/result_tutorial/210/doc.json
View file

@ -493,7 +493,7 @@
"ori_name": "disabled",
"access_control": true,
"annotation": {
"description": "if \"{0}\" is not \"Manual proxy configuration\"\nor \"{1}\" is \"v4\"",
"description": "if \"{0}\" is not \"Manual proxy configuration\"\nor \"{1}\" is \"v4\".",
"variables": [
{
"path": "firefox.proxy_mode",
@ -603,7 +603,7 @@
"ori_name": "disabled",
"access_control": true,
"annotation": {
"description": "if \"{0}\" is not \"Custom\"",
"description": "if \"{0}\" is not \"Custom\".",
"variables": [
{
"path": "firefox.dns_over_https.provider",
@ -732,7 +732,7 @@
"default": {
"name": "Default",
"values": {
"description": "random color value"
"description": "random color value."
}
},
"variable_type": "regexp",
@ -758,7 +758,7 @@
"ori_name": "disabled",
"access_control": true,
"annotation": {
"description": "if type not in:\n- HTTP\n- HTTPS/SSL\n- SOCKS4\n- SOCKS5"
"description": "if type not in:\n- HTTP\n- HTTPS/SSL\n- SOCKS4\n- SOCKS5."
}
}
],
@ -767,7 +767,7 @@
"default": {
"name": "Default",
"values": {
"description": "copy HTTP address if proxy is not \"Manual\""
"description": "copy HTTP address if proxy is not \"Manual\"."
}
},
"variable_type": "domainname",
@ -797,7 +797,7 @@
"ori_name": "disabled",
"access_control": true,
"annotation": {
"description": "if type not in:\n- HTTP\n- HTTPS/SSL\n- SOCKS4\n- SOCKS5"
"description": "if type not in:\n- HTTP\n- HTTPS/SSL\n- SOCKS4\n- SOCKS5."
}
}
],
@ -806,7 +806,7 @@
"default": {
"name": "Default",
"values": {
"description": "copy HTTP port if proxy is not \"Manual\""
"description": "copy HTTP port if proxy is not \"Manual\"."
}
},
"variable_type": "port",
@ -830,7 +830,7 @@
"ori_name": "mandatory",
"access_control": false,
"annotation": {
"description": "if a password is set"
"description": "if a password is set."
}
},
{
@ -839,7 +839,7 @@
"ori_name": "disabled",
"access_control": true,
"annotation": {
"description": "if type not in:\n- HTTP\n- HTTPS/SSL\n- SOCKS4\n- SOCKS5"
"description": "if type not in:\n- HTTP\n- HTTPS/SSL\n- SOCKS4\n- SOCKS5."
}
}
],
@ -858,7 +858,7 @@
"ori_name": "disabled",
"access_control": true,
"annotation": {
"description": "if type not in:\n- HTTP\n- HTTPS/SSL\n- SOCKS4\n- SOCKS5"
"description": "if type not in:\n- HTTP\n- HTTPS/SSL\n- SOCKS4\n- SOCKS5."
}
}
],
@ -883,7 +883,7 @@
"ori_name": "disabled",
"access_control": true,
"annotation": {
"description": "if type is not in:\n- PAC URL\n- WPAD"
"description": "if type is not in:\n- PAC URL\n- WPAD."
}
}
],
@ -892,7 +892,7 @@
"default": {
"name": "Default",
"values": {
"description": "copy HTTP address if proxy is \"Auto\""
"description": "copy HTTP address if proxy is \"Auto\"."
}
},
"variable_type": "web address",

24
tests/result_tutorial/210/doc.sh
View file

@ -175,7 +175,7 @@
│ │ not "Manual proxy configuration" │
│ │ or │
│ │ "firefox.manual.socks_proxy.version" │
│ │ is "v4" │
│ │ is "v4". │
└───────────────────────────────────────┴──────────────────────────────────────┘
DNS over HTTPS
@ -210,7 +210,7 @@
│ │ • must starts with 'https://' only │
│ │ Disabled: if │
│ │ "firefox.dns_over_https.provider" is │
│ │ not "Custom" │
│ │ not "Custom". │
└───────────────────────────────────────┴──────────────────────────────────────┘
@ -252,7 +252,7 @@
│  regexp   basic   mandatory   auto  │ Validator: text based with regular │
│ modified  │ expressions │
│ │ "^#(?:[0-9a-f]{3}){1,2}$" │
│ │ Default: random color value │
│ │ Default: random color value. │
├───────────────────────────────────────┼──────────────────────────────────────┤
│ foxyproxy.proxies.address │ IP address, DNS name, server name. │
│  domainname   standard   mandatory    │ Validators: │
@ -260,12 +260,12 @@
│ │ • the domain name can be a hostname │
│ │ • the domain name can be an IP │
│ │ Default: copy HTTP address if proxy │
│ │ is not "Manual" │
│ │ is not "Manual". │
│ │ Disabled: if type not in: │
│ │ - HTTP │
│ │ - HTTPS/SSL │
│ │ - SOCKS4 │
│ │ - SOCKS5 │
│ │ - SOCKS5. │
├───────────────────────────────────────┼──────────────────────────────────────┤
│ foxyproxy.proxies.port │ Port. │
│  port   standard   mandatory    │ Validators: │
@ -276,27 +276,27 @@
│ │ • private ports (greater than 49152) │
│ │ are allowed │
│ │ Default: copy HTTP port if proxy is │
│ │ not "Manual" │
│ │ not "Manual". │
│ │ Disabled: if type not in: │
│ │ - HTTP │
│ │ - HTTPS/SSL │
│ │ - SOCKS4 │
│ │ - SOCKS5 │
│ │ - SOCKS5. │
├───────────────────────────────────────┼──────────────────────────────────────┤
│ foxyproxy.proxies.username │ Username. │
│  UNIX user   standard   mandatory    │ Mandatory: if a password is set │
│  UNIX user   standard   mandatory    │ Mandatory: if a password is set. │
│ disabled  │ Disabled: if type not in: │
│ │ - HTTP │
│ │ - HTTPS/SSL │
│ │ - SOCKS4 │
│ │ - SOCKS5 │
│ │ - SOCKS5. │
├───────────────────────────────────────┼──────────────────────────────────────┤
│ foxyproxy.proxies.password │ Password. │
│  secret   standard   disabled  │ Disabled: if type not in: │
│ │ - HTTP │
│ │ - HTTPS/SSL │
│ │ - SOCKS4 │
│ │ - SOCKS5 │
│ │ - SOCKS5. │
├───────────────────────────────────────┼──────────────────────────────────────┤
│ foxyproxy.proxies.url │ URL. │
│  web address   standard   mandatory  │ Validators: │
@ -307,10 +307,10 @@
│ │ • type domainname │
│ │ • the domain name can be a hostname │
│ │ Default: copy HTTP address if proxy │
│ │ is "Auto" │
│ │ is "Auto". │
│ │ Disabled: if type is not in: │
│ │ - PAC URL │
│ │ - WPAD │
│ │ - WPAD. │
└───────────────────────────────────────┴──────────────────────────────────────┘

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

@ -4,18 +4,18 @@
┃ Variable  ┃ Description  ┃
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
│ foxyproxy.proxies.username │ Username. │
│  UNIX user   standard   mandatory    │ Mandatory: if a password is set │
│  UNIX user   standard   mandatory    │ Mandatory: if a password is set. │
│ disabled  │ Disabled: if type not in: │
│ │ - HTTP │
│ │ - HTTPS/SSL │
│ │ - SOCKS4 │
│ │ - SOCKS5 │
│ │ - SOCKS5. │
├───────────────────────────────────────┼──────────────────────────────────────┤
│ foxyproxy.proxies.password │ Password. │
│  secret   standard   disabled  │ Disabled: if type not in: │
│ │ - HTTP │
│ │ - HTTPS/SSL │
│ │ - SOCKS4 │
│ │ - SOCKS5 │
│ │ - SOCKS5. │
└───────────────────────────────────────┴──────────────────────────────────────┘

24
tests/result_tutorial/211/doc.json
View file

@ -493,7 +493,7 @@
"ori_name": "disabled",
"access_control": true,
"annotation": {
"description": "if \"{0}\" is not \"Manual proxy configuration\"\nor \"{1}\" is \"v4\"",
"description": "if \"{0}\" is not \"Manual proxy configuration\"\nor \"{1}\" is \"v4\".",
"variables": [
{
"path": "firefox.proxy_mode",
@ -603,7 +603,7 @@
"ori_name": "disabled",
"access_control": true,
"annotation": {
"description": "if \"{0}\" is not \"Custom\"",
"description": "if \"{0}\" is not \"Custom\".",
"variables": [
{
"path": "firefox.dns_over_https.provider",
@ -732,7 +732,7 @@
"default": {
"name": "Default",
"values": {
"description": "random color value"
"description": "random color value."
}
},
"variable_type": "regexp",
@ -758,7 +758,7 @@
"ori_name": "disabled",
"access_control": true,
"annotation": {
"description": "if type not in:\n- HTTP\n- HTTPS/SSL\n- SOCKS4\n- SOCKS5"
"description": "if type not in:\n- HTTP\n- HTTPS/SSL\n- SOCKS4\n- SOCKS5."
}
}
],
@ -767,7 +767,7 @@
"default": {
"name": "Default",
"values": {
"description": "copy HTTP address if proxy is not \"Manual\""
"description": "copy HTTP address if proxy is not \"Manual\"."
}
},
"variable_type": "domainname",
@ -797,7 +797,7 @@
"ori_name": "disabled",
"access_control": true,
"annotation": {
"description": "if type not in:\n- HTTP\n- HTTPS/SSL\n- SOCKS4\n- SOCKS5"
"description": "if type not in:\n- HTTP\n- HTTPS/SSL\n- SOCKS4\n- SOCKS5."
}
}
],
@ -806,7 +806,7 @@
"default": {
"name": "Default",
"values": {
"description": "copy HTTP port if proxy is not \"Manual\""
"description": "copy HTTP port if proxy is not \"Manual\"."
}
},
"variable_type": "port",
@ -830,7 +830,7 @@
"ori_name": "disabled",
"access_control": true,
"annotation": {
"description": "if type not in:\n- HTTP\n- HTTPS/SSL\n- SOCKS4\n- SOCKS5"
"description": "if type not in:\n- HTTP\n- HTTPS/SSL\n- SOCKS4\n- SOCKS5."
}
}
],
@ -849,7 +849,7 @@
"ori_name": "hidden",
"access_control": true,
"annotation": {
"description": "if username is empty"
"description": "if username is empty."
}
},
{
@ -858,7 +858,7 @@
"ori_name": "disabled",
"access_control": true,
"annotation": {
"description": "if type not in:\n- HTTP\n- HTTPS/SSL\n- SOCKS4\n- SOCKS5"
"description": "if type not in:\n- HTTP\n- HTTPS/SSL\n- SOCKS4\n- SOCKS5."
}
}
],
@ -883,7 +883,7 @@
"ori_name": "disabled",
"access_control": true,
"annotation": {
"description": "if type is not in:\n- PAC URL\n- WPAD"
"description": "if type is not in:\n- PAC URL\n- WPAD."
}
}
],
@ -892,7 +892,7 @@
"default": {
"name": "Default",
"values": {
"description": "copy HTTP address if proxy is \"Auto\""
"description": "copy HTTP address if proxy is \"Auto\"."
}
},
"variable_type": "web address",

24
tests/result_tutorial/211/doc.sh
View file

@ -175,7 +175,7 @@
│ │ not "Manual proxy configuration" │
│ │ or │
│ │ "firefox.manual.socks_proxy.version" │
│ │ is "v4" │
│ │ is "v4". │
└───────────────────────────────────────┴──────────────────────────────────────┘
DNS over HTTPS
@ -210,7 +210,7 @@
│ │ • must starts with 'https://' only │
│ │ Disabled: if │
│ │ "firefox.dns_over_https.provider" is │
│ │ not "Custom" │
│ │ not "Custom". │
└───────────────────────────────────────┴──────────────────────────────────────┘
@ -252,7 +252,7 @@
│  regexp   basic   mandatory   auto  │ Validator: text based with regular │
│ modified  │ expressions │
│ │ "^#(?:[0-9a-f]{3}){1,2}$" │
│ │ Default: random color value │
│ │ Default: random color value. │
├───────────────────────────────────────┼──────────────────────────────────────┤
│ foxyproxy.proxies.address │ IP address, DNS name, server name. │
│  domainname   standard   mandatory    │ Validators: │
@ -260,12 +260,12 @@
│ │ • the domain name can be a hostname │
│ │ • the domain name can be an IP │
│ │ Default: copy HTTP address if proxy │
│ │ is not "Manual" │
│ │ is not "Manual". │
│ │ Disabled: if type not in: │
│ │ - HTTP │
│ │ - HTTPS/SSL │
│ │ - SOCKS4 │
│ │ - SOCKS5 │
│ │ - SOCKS5. │
├───────────────────────────────────────┼──────────────────────────────────────┤
│ foxyproxy.proxies.port │ Port. │
│  port   standard   mandatory    │ Validators: │
@ -276,27 +276,27 @@
│ │ • private ports (greater than 49152) │
│ │ are allowed │
│ │ Default: copy HTTP port if proxy is │
│ │ not "Manual" │
│ │ not "Manual". │
│ │ Disabled: if type not in: │
│ │ - HTTP │
│ │ - HTTPS/SSL │
│ │ - SOCKS4 │
│ │ - SOCKS5 │
│ │ - SOCKS5. │
├───────────────────────────────────────┼──────────────────────────────────────┤
│ foxyproxy.proxies.username │ Username. │
│  UNIX user   standard   disabled  │ Disabled: if type not in: │
│ │ - HTTP │
│ │ - HTTPS/SSL │
│ │ - SOCKS4 │
│ │ - SOCKS5 │
│ │ - SOCKS5. │
├───────────────────────────────────────┼──────────────────────────────────────┤
│ foxyproxy.proxies.password │ Password. │
│  secret   standard   hidden    │ Hidden: if username is empty │
│  secret   standard   hidden    │ Hidden: if username is empty. │
│ disabled  │ Disabled: if type not in: │
│ │ - HTTP │
│ │ - HTTPS/SSL │
│ │ - SOCKS4 │
│ │ - SOCKS5 │
│ │ - SOCKS5. │
├───────────────────────────────────────┼──────────────────────────────────────┤
│ foxyproxy.proxies.url │ URL. │
│  web address   standard   mandatory  │ Validators: │
@ -307,10 +307,10 @@
│ │ • type domainname │
│ │ • the domain name can be a hostname │
│ │ Default: copy HTTP address if proxy │
│ │ is "Auto" │
│ │ is "Auto". │
│ │ Disabled: if type is not in: │
│ │ - PAC URL │
│ │ - WPAD │
│ │ - WPAD. │
└───────────────────────────────────────┴──────────────────────────────────────┘

8
tests/result_tutorial/211/doc_changelog.sh
View file

@ -4,19 +4,19 @@
┃ Variable  ┃ Description  ┃
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
│ foxyproxy.proxies.username │ Username. │
│  mandatory   UNIX user   standard    │ Mandatory: if a password is set │
│  mandatory   UNIX user   standard    │ Mandatory: if a password is set. │
│ disabled  │ Disabled: if type not in: │
│ │ - HTTP │
│ │ - HTTPS/SSL │
│ │ - SOCKS4 │
│ │ - SOCKS5 │
│ │ - SOCKS5. │
├───────────────────────────────────────┼──────────────────────────────────────┤
│ foxyproxy.proxies.password │ Password. │
│  secret   standard   hidden    │ Hidden: if username is empty │
│  secret   standard   hidden    │ Hidden: if username is empty. │
│ disabled  │ Disabled: if type not in: │
│ │ - HTTP │
│ │ - HTTPS/SSL │
│ │ - SOCKS4 │
│ │ - SOCKS5 │
│ │ - SOCKS5. │
└───────────────────────────────────────┴──────────────────────────────────────┘

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

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

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

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

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

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

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

@ -42,7 +42,7 @@
"default": {
"name": "Default",
"values": {
"description": "the value of var1"
"description": "the value of var1."
}
},
"variable_type": "string",

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

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

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

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

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

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

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

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

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

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

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

@ -53,7 +53,7 @@
"default": {
"name": "Default",
"values": {
"description": "the value of \"{0}\"",
"description": "the value of \"{0}\".",
"variables": [
{
"path": "var1",

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