--- gitea: none include_toc: true --- # Two columns ## Générer la documentation > **🛈 Informations** > > **doc**\ > `basic` *`désactivé`*\ > **Désactivé** : lorsque "[Générer la documentation](#doc)" n'est pas spécifié dans "[Sélection pour sortie](#step.output)" | Variable | Description | |---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **doc.title_level**
[`integer`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | Niveau de titre de départ.
**Défaut** : 1 | | **doc.contents**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` `standard` `obligatoire` `unique` | Contenu générer.
**Choix** :
• variables **← (défaut)**
• example
• changelog | | **doc.previous_json_file**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` *`désactivé`* | Précédent fichier de description au format JSON.
**Désactivé** : changelog n'est pas sélectionné dans "[Contenu générer](#doc.contents)" | | **doc.without_family**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` *`désactivé`* | Ne pas ajouter les familles dans la documentation.
**Défaut** : false
**Désactivé** : if "[Générer le document au format](#doc.output_format)" is json or "[Contenu générer](#doc.contents)" hasn't variable or changelog | | **doc.root**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | Documente les variables depuis cette famille. | | **doc.with_commandline**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` *`désactivé`* | Ajoute les informations de la ligne de commande dans la documentation.
**Défaut** : false
**Désactivé** : if "[Générer le document au format](#doc.output_format)" is json or "[Contenu générer](#doc.contents)" hasn't variable or changelog | | **doc.with_environment**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` *`désactivé`* | Ajoute les informations de variable d'environnement dans la documentation.
**Défaut** : false
**Désactivé** : if "[Générer le document au format](#doc.output_format)" is json or "[Contenu générer](#doc.contents)" hasn't variable or changelog | | **doc.environment_default_environment_name**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` *`désactivé`* | Nom du préfixe d'environnement par défaut.
**Validateur** : doit seulement utilise des caractères en majuscule
**Défaut** : ROUGAIL
**Désactivé** : si "__.main_namespace" n'est pas défini ou "[Ajoute les informations de variable d'environnement dans la documentation](#doc.with_environment)" est false | ## Les familles ou variables pour cette famille sont dans un autre fichier > **🛈 Informations** > > **doc.other_root_filenames**\ > Cette famille contient des listes de bloc de variable.\ > `basic` *`désactivé`*\ > **Désactivé** : documentation doit être séparée | Variable | Description | |-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------| | **doc.other_root_filenames.root_path**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` `standard` `unique` | Nom de la famille racine. | | **doc.other_root_filenames.filename**
[`UNIX filename`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | Nom du fichier.
**Validateurs** :
• this filename could be a relative path
• file type allowed: "fichier" et "répertoire" | | Variable | Description | |-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **doc.disabled_modes**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` `standard` *`désactivé`* `unique` | Désactiver la documentation des variables avec ces modes.
**Validateur** : vérifier le mode existe déjà
**Désactivé** : désactiver lorsqu'il n'y a pas de mode valable | | **doc.change_default_value**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | Valeurs modifiées pour documenter les familles leader ou dynamique.
**Défaut** : true | | **doc.comment_examples**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` *`désactivé`* | Ajouter la description des variables et des familles lorsqu'on génère des exemples.
**Défaut** : false
**Désactivé** : désactiver lorsqu'il example n'est pas dans contents | | **doc.comment_examples_column**
[`integer`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` *`désactivé`* | Commentaire dans les exemples commence à la colonne.
**Défaut** : 30
**Désactivé** : lorsque la variable "[Ajouter la description des variables et des familles lorsqu'on génère des exemples](#doc.comment_examples)" est accessible et a la valeur "false" | | **doc.output_format**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | Générer le document au format.
**Validateur** : le format de sortie json n'est pas compatible avec "changelog" et example" de la variable contents
**Choix** :
• console **← (défaut)**
• asciidoc
• html
• github
• gitlab
• json | | **doc.table_model**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | Generate document inside table model.
**Validateur** : le format de sortie json n'est pas compatible avec "changelog" et example" de la variable contents
**Choix** :
• two_columns **← (défaut)**
• three_columns
• four_columns
• five_columns
• six_columns | | **doc.force_true_color_terminal**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | Force les vrais couleurs dans le terminal.
**Défaut** : false | # Three columns ## Générer la documentation > **🛈 Informations** > > **doc**\ > `basic` *`désactivé`*\ > **Désactivé** : lorsque "[Générer la documentation](#doc)" n'est pas spécifié dans "[Sélection pour sortie](#step.output)" | Variable | Description | Default value | |---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------| | **doc.title_level**
[`integer`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | Niveau de titre de départ. | 1 | | **doc.contents**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` `standard` `obligatoire` `unique` | Contenu générer.
**Choix** :
• variables
• example
• changelog |
• variables | | **doc.previous_json_file**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` *`désactivé`* | Précédent fichier de description au format JSON.
**Désactivé** : changelog n'est pas sélectionné dans "[Contenu générer](#doc.contents)" | | | **doc.without_family**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` *`désactivé`* | Ne pas ajouter les familles dans la documentation.
**Désactivé** : if "[Générer le document au format](#doc.output_format)" is json or "[Contenu générer](#doc.contents)" hasn't variable or changelog | false | | **doc.root**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | Documente les variables depuis cette famille. | | | **doc.with_commandline**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` *`désactivé`* | Ajoute les informations de la ligne de commande dans la documentation.
**Désactivé** : if "[Générer le document au format](#doc.output_format)" is json or "[Contenu générer](#doc.contents)" hasn't variable or changelog | false | | **doc.with_environment**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` *`désactivé`* | Ajoute les informations de variable d'environnement dans la documentation.
**Désactivé** : if "[Générer le document au format](#doc.output_format)" is json or "[Contenu générer](#doc.contents)" hasn't variable or changelog | false | | **doc.environment_default_environment_name**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` *`désactivé`* | Nom du préfixe d'environnement par défaut.
**Validateur** : doit seulement utilise des caractères en majuscule
**Désactivé** : si "__.main_namespace" n'est pas défini ou "[Ajoute les informations de variable d'environnement dans la documentation](#doc.with_environment)" est false | ROUGAIL | ## Les familles ou variables pour cette famille sont dans un autre fichier > **🛈 Informations** > > **doc.other_root_filenames**\ > Cette famille contient des listes de bloc de variable.\ > `basic` *`désactivé`*\ > **Désactivé** : documentation doit être séparée | Variable | Description | |-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------| | **doc.other_root_filenames.root_path**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` `standard` `unique` | Nom de la famille racine. | | **doc.other_root_filenames.filename**
[`UNIX filename`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | Nom du fichier.
**Validateurs** :
• this filename could be a relative path
• file type allowed: "fichier" et "répertoire" | | Variable | Description | Default value | |-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------| | **doc.disabled_modes**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` `standard` *`désactivé`* `unique` | Désactiver la documentation des variables avec ces modes.
**Validateur** : vérifier le mode existe déjà
**Désactivé** : désactiver lorsqu'il n'y a pas de mode valable | | | **doc.change_default_value**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | Valeurs modifiées pour documenter les familles leader ou dynamique. | true | | **doc.comment_examples**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` *`désactivé`* | Ajouter la description des variables et des familles lorsqu'on génère des exemples.
**Désactivé** : désactiver lorsqu'il example n'est pas dans contents | false | | **doc.comment_examples_column**
[`integer`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` *`désactivé`* | Commentaire dans les exemples commence à la colonne.
**Désactivé** : lorsque la variable "[Ajouter la description des variables et des familles lorsqu'on génère des exemples](#doc.comment_examples)" est accessible et a la valeur "false" | 30 | | **doc.output_format**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | Générer le document au format.
**Validateur** : le format de sortie json n'est pas compatible avec "changelog" et example" de la variable contents
**Choix** :
• console
• asciidoc
• html
• github
• gitlab
• json | console | | **doc.table_model**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | Generate document inside table model.
**Validateur** : le format de sortie json n'est pas compatible avec "changelog" et example" de la variable contents
**Choix** :
• two_columns
• three_columns
• four_columns
• five_columns
• six_columns | two_columns | | **doc.force_true_color_terminal**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | Force les vrais couleurs dans le terminal. | false | # Four columns ## Générer la documentation > **🛈 Informations** > > **doc**\ > `basic` *`désactivé`*\ > **Désactivé** : lorsque "[Générer la documentation](#doc)" n'est pas spécifié dans "[Sélection pour sortie](#step.output)" | Variable | Description | Default value | Type | |--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------|-------------------------------------------------------------------------------------------------------------| | **doc.title_level**
`standard` | Niveau de titre de départ. | 1 | [`integer`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | | **doc.contents**
`standard` `unique` | Contenu générer.
**Choix** :
• variables
• example
• changelog |
• variables | [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` `obligatoire` | | **doc.previous_json_file**
`basic` *`désactivé`* | Précédent fichier de description au format JSON.
**Désactivé** : changelog n'est pas sélectionné dans "[Contenu générer](#doc.contents)" | | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | | **doc.without_family**
`standard` *`désactivé`* | Ne pas ajouter les familles dans la documentation.
**Désactivé** : if "[Générer le document au format](#doc.output_format)" is json or "[Contenu générer](#doc.contents)" hasn't variable or changelog | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | | **doc.root**
`standard` | Documente les variables depuis cette famille. | | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) | | **doc.with_commandline**
`standard` *`désactivé`* | Ajoute les informations de la ligne de commande dans la documentation.
**Désactivé** : if "[Générer le document au format](#doc.output_format)" is json or "[Contenu générer](#doc.contents)" hasn't variable or changelog | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | | **doc.with_environment**
`standard` *`désactivé`* | Ajoute les informations de variable d'environnement dans la documentation.
**Désactivé** : if "[Générer le document au format](#doc.output_format)" is json or "[Contenu générer](#doc.contents)" hasn't variable or changelog | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | | **doc.environment_default_environment_name**
`standard` *`désactivé`* | Nom du préfixe d'environnement par défaut.
**Validateur** : doit seulement utilise des caractères en majuscule
**Désactivé** : si "__.main_namespace" n'est pas défini ou "[Ajoute les informations de variable d'environnement dans la documentation](#doc.with_environment)" est false | ROUGAIL | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | ## Les familles ou variables pour cette famille sont dans un autre fichier > **🛈 Informations** > > **doc.other_root_filenames**\ > Cette famille contient des listes de bloc de variable.\ > `basic` *`désactivé`*\ > **Désactivé** : documentation doit être séparée | Variable | Description | Type | |---------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------| | **doc.other_root_filenames.root_path**
`standard` `unique` | Nom de la famille racine. | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` | | **doc.other_root_filenames.filename**
`basic` | Nom du fichier.
**Validateurs** :
• this filename could be a relative path
• file type allowed: "fichier" et "répertoire" | [`UNIX filename`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | | Variable | Description | Default value | Type | |-----------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------|---------------------------------------------------------------------------------------------------| | **doc.disabled_modes**
`standard` *`désactivé`* `unique` | Désactiver la documentation des variables avec ces modes.
**Validateur** : vérifier le mode existe déjà
**Désactivé** : désactiver lorsqu'il n'y a pas de mode valable | | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` | | **doc.change_default_value**
`standard` | Valeurs modifiées pour documenter les familles leader ou dynamique. | true | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | | **doc.comment_examples**
`standard` *`désactivé`* | Ajouter la description des variables et des familles lorsqu'on génère des exemples.
**Désactivé** : désactiver lorsqu'il example n'est pas dans contents | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | | **doc.comment_examples_column**
`standard` *`désactivé`* | Commentaire dans les exemples commence à la colonne.
**Désactivé** : lorsque la variable "[Ajouter la description des variables et des familles lorsqu'on génère des exemples](#doc.comment_examples)" est accessible et a la valeur "false" | 30 | [`integer`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | | **doc.output_format**
`standard` | Générer le document au format.
**Validateur** : le format de sortie json n'est pas compatible avec "changelog" et example" de la variable contents
**Choix** :
• console
• asciidoc
• html
• github
• gitlab
• json | console | [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | | **doc.table_model**
`standard` | Generate document inside table model.
**Validateur** : le format de sortie json n'est pas compatible avec "changelog" et example" de la variable contents
**Choix** :
• two_columns
• three_columns
• four_columns
• five_columns
• six_columns | two_columns | [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | | **doc.force_true_color_terminal**
`standard` | Force les vrais couleurs dans le terminal. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | # Five columns ## Générer la documentation > **🛈 Informations** > > **doc**\ > `basic` *`désactivé`*\ > **Désactivé** : lorsque "[Générer la documentation](#doc)" n'est pas spécifié dans "[Sélection pour sortie](#step.output)" | Variable | Description | Default value | Type | Access control | |---------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------|-----------------------|-------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **doc.title_level** | Niveau de titre de départ. | 1 | [`integer`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | `standard` | | **doc.contents**
`unique` | Contenu générer.
**Choix** :
• variables
• example
• changelog |
• variables | [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` `obligatoire` | `standard` | | **doc.previous_json_file** | Précédent fichier de description au format JSON. | | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | `basic` *`désactivé`*
**Désactivé** : changelog n'est pas sélectionné dans "[Contenu générer](#doc.contents)" | | **doc.without_family** | Ne pas ajouter les familles dans la documentation. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | `standard` *`désactivé`*
**Désactivé** : if "[Générer le document au format](#doc.output_format)" is json or "[Contenu générer](#doc.contents)" hasn't variable or changelog | | **doc.root** | Documente les variables depuis cette famille. | | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) | `standard` | | **doc.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` | `standard` *`désactivé`*
**Désactivé** : if "[Générer le document au format](#doc.output_format)" is json or "[Contenu générer](#doc.contents)" hasn't variable or changelog | | **doc.with_environment** | Ajoute les informations de variable d'environnement dans la documentation. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | `standard` *`désactivé`*
**Désactivé** : if "[Générer le document au format](#doc.output_format)" is json or "[Contenu générer](#doc.contents)" hasn't variable or changelog | | **doc.environment_default_environment_name** | Nom du préfixe d'environnement par défaut.
**Validateur** : doit seulement utilise des caractères en majuscule | ROUGAIL | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | `standard` *`désactivé`*
**Désactivé** : si "__.main_namespace" n'est pas défini ou "[Ajoute les informations de variable d'environnement dans la documentation](#doc.with_environment)" est false | ## Les familles ou variables pour cette famille sont dans un autre fichier > **🛈 Informations** > > **doc.other_root_filenames**\ > Cette famille contient des listes de bloc de variable.\ > `basic` *`désactivé`*\ > **Désactivé** : documentation doit être séparée | Variable | Description | Type | Access control | |----------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------|------------------| | **doc.other_root_filenames.root_path**
`unique` | Nom de la famille racine. | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` | `standard` | | **doc.other_root_filenames.filename** | Nom du fichier.
**Validateurs** :
• this filename could be a relative path
• file type allowed: "fichier" et "répertoire" | [`UNIX filename`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | `basic` | | Variable | Description | Default value | Type | Access control | |------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------|---------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **doc.disabled_modes**
`unique` | Désactiver la documentation des variables avec ces modes.
**Validateur** : vérifier le mode existe déjà | | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` | `standard` *`désactivé`*
**Désactivé** : désactiver lorsqu'il n'y a pas de mode valable | | **doc.change_default_value** | Valeurs modifiées pour documenter les familles leader ou dynamique. | true | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | `standard` | | **doc.comment_examples** | Ajouter la description des variables et des familles lorsqu'on génère des exemples. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | `standard` *`désactivé`*
**Désactivé** : désactiver lorsqu'il example n'est pas dans contents | | **doc.comment_examples_column** | Commentaire dans les exemples commence à la colonne. | 30 | [`integer`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | `standard` *`désactivé`*
**Désactivé** : lorsque la variable "[Ajouter la description des variables et des familles lorsqu'on génère des exemples](#doc.comment_examples)" est accessible et a la valeur "false" | | **doc.output_format** | Générer le document au format.
**Validateur** : le format de sortie json n'est pas compatible avec "changelog" et example" de la variable contents
**Choix** :
• console
• asciidoc
• html
• github
• gitlab
• json | console | [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | `standard` | | **doc.table_model** | Generate document inside table model.
**Validateur** : le format de sortie json n'est pas compatible avec "changelog" et example" de la variable contents
**Choix** :
• two_columns
• three_columns
• four_columns
• five_columns
• six_columns | two_columns | [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | `standard` | | **doc.force_true_color_terminal** | Force les vrais couleurs dans le terminal. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | `standard` | # Six columns ## Générer la documentation > **🛈 Informations** > > **doc**\ > `basic` *`désactivé`*\ > **Désactivé** : lorsque "[Générer la documentation](#doc)" n'est pas spécifié dans "[Sélection pour sortie](#step.output)" | Variable | Description | Default value | Type | Access control | Validateur | |---------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------|-----------------------|-------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------| | **doc.title_level** | Niveau de titre de départ. | 1 | [`integer`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | `standard` | | | **doc.contents**
`unique` | Contenu générer.
**Choix** :
• variables
• example
• changelog |
• variables | [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` `obligatoire` | `standard` | | | **doc.previous_json_file** | Précédent fichier de description au format JSON. | | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | `basic` *`désactivé`*
**Désactivé** : changelog n'est pas sélectionné dans "[Contenu générer](#doc.contents)" | | | **doc.without_family** | Ne pas ajouter les familles dans la documentation. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | `standard` *`désactivé`*
**Désactivé** : if "[Générer le document au format](#doc.output_format)" is json or "[Contenu générer](#doc.contents)" hasn't variable or changelog | | | **doc.root** | Documente les variables depuis cette famille. | | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) | `standard` | | | **doc.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` | `standard` *`désactivé`*
**Désactivé** : if "[Générer le document au format](#doc.output_format)" is json or "[Contenu générer](#doc.contents)" hasn't variable or changelog | | | **doc.with_environment** | Ajoute les informations de variable d'environnement dans la documentation. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | `standard` *`désactivé`*
**Désactivé** : if "[Générer le document au format](#doc.output_format)" is json or "[Contenu générer](#doc.contents)" hasn't variable or changelog | | | **doc.environment_default_environment_name** | Nom du préfixe d'environnement par défaut. | ROUGAIL | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | `standard` *`désactivé`*
**Désactivé** : si "__.main_namespace" n'est pas défini ou "[Ajoute les informations de variable d'environnement dans la documentation](#doc.with_environment)" est false | Doit seulement utilise des caractères en majuscule. | ## Les familles ou variables pour cette famille sont dans un autre fichier > **🛈 Informations** > > **doc.other_root_filenames**\ > Cette famille contient des listes de bloc de variable.\ > `basic` *`désactivé`*\ > **Désactivé** : documentation doit être séparée | Variable | Description | Type | Access control | Validateur | |----------------------------------------------------------------------------------------------------------------------------------------------|---------------------------|---------------------------------------------------------------------------------------------------------|------------------|-------------------------------------------------------------------------------------------------------------| | **doc.other_root_filenames.root_path**
`unique` | Nom de la famille racine. | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` | `standard` | | | **doc.other_root_filenames.filename** | Nom du fichier. | [`UNIX filename`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | `basic` |
• this filename could be a relative path
• file type allowed: "fichier" et "répertoire". | | Variable | Description | Default value | Type | Access control | Validateur | |------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------|---------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------| | **doc.disabled_modes**
`unique` | Désactiver la documentation des variables avec ces modes. | | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` | `standard` *`désactivé`*
**Désactivé** : désactiver lorsqu'il n'y a pas de mode valable | Vérifier le mode existe déjà. | | **doc.change_default_value** | Valeurs modifiées pour documenter les familles leader ou dynamique. | true | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | `standard` | | | **doc.comment_examples** | Ajouter la description des variables et des familles lorsqu'on génère des exemples. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | `standard` *`désactivé`*
**Désactivé** : désactiver lorsqu'il example n'est pas dans contents | | | **doc.comment_examples_column** | Commentaire dans les exemples commence à la colonne. | 30 | [`integer`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | `standard` *`désactivé`*
**Désactivé** : lorsque la variable "[Ajouter la description des variables et des familles lorsqu'on génère des exemples](#doc.comment_examples)" est accessible et a la valeur "false" | | | **doc.output_format** | Générer le document au format.
**Choix** :
• console
• asciidoc
• html
• github
• gitlab
• json | console | [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | `standard` | Le format de sortie json n'est pas compatible avec "changelog" et example" de la variable contents. | | **doc.table_model** | Generate document inside table model.
**Choix** :
• two_columns
• three_columns
• four_columns
• five_columns
• six_columns | two_columns | [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | `standard` | Le format de sortie json n'est pas compatible avec "changelog" et example" de la variable contents. | | **doc.force_true_color_terminal** | Force les vrais couleurs dans le terminal. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | `standard` | |