--- gitea: none include_toc: true --- # Two columns ## Generate documentation > **🛈 Informations** > > **doc**\ > *`disabled`*\ > **Disabled**: if doc is not set in "[Select for output](#step.output)" | Variable | Description | |-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **doc.output_format**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory`
**Command line**: -do, --doc.output_format
**Environment variable**: ROUGAILCLI_DOC.OUTPUT_FORMAT | Generate document in format.
**Choices**:
• console **← (default)**
• asciidoc
• html
• github
• gitlab
• json | | **doc.table_model**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` *`disabled`*
**Command line**: -dm, --doc.table_model
**Environment variable**: ROUGAILCLI_DOC.TABLE_MODEL | Generate document with this table model.
**Choices**:
• two_columns **← (default)**
• three_columns
• four_columns
• five_columns
• six_columns
**Disabled**: the value json is not compatible with changelog and example "[Generated content](#doc.contents)" | | **doc.contents**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` `mandatory` *`hidden`* `unique`
**Command line**: -dc, --doc.contents
**Environment variable**: ROUGAILCLI_DOC.CONTENTS | Generated content.
You can generate three type of document. All variables ("variables"), an example file in YAML format ("example") or change log ("changelog").
**Choices**:
• variables **← (default)**
• example
• changelog
**Hidden**: the value json is not compatible with changelog and example "[Generated content](#doc.contents)" | | **doc.title_level**
[`integer`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory`
**Command line**: -dt, --doc.title_level
**Environment variable**: ROUGAILCLI_DOC.TITLE_LEVEL | Starting title level.
**Default**: 1 | | **doc.default_values**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory`
**Command line**:
• --doc.default_values
• --doc.no-default_values
**Environment variable**: ROUGAILCLI_DOC.DEFAULT_VALUES | Modify values to document all variables.
To document leadership or dynamic family variables, it is sometimes necessary to generate values, which can change the values in the configuration. Be careful if you reuse this configuration.
**Default**: true | | **doc.true_color**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` *`disabled`*
**Command line**:
• --doc.true_color
• --doc.no-true_color
**Environment variable**: ROUGAILCLI_DOC.TRUE_COLOR | Display documentation in console always with true color terminal.
**Default**: false
**Disabled**: when the variable "[Generate document in format](#doc.output_format)" hasn't the value "console" | | **doc.root**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types)
**Command line**: -dr, --doc.root
**Environment variable**: ROUGAILCLI_DOC.ROOT | Document the child variables of the family. | ### The variables in this family are documented in another file > **🛈 Informations** > > **doc.other_root_filenames**\ > This family contains lists of variable blocks.\ > *`disabled`*\ > **Disabled**: if "[Document the child variables of the family](#doc.root)" haven't any value | Variable | Description | |-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------| | **doc.other_root_filenames.root_path**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` `unique`
**Command line**: --doc.other_root_filenames.root_path
**Environment variable**: ROUGAILCLI_DOC.OTHER_ROOT_FILENAMES.ROOT_PATH | Family name. | | **doc.other_root_filenames.filename**
[`UNIX filename`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory`
**Command line**: --doc.other_root_filenames.filename
**Environment variable**: ROUGAILCLI_DOC.OTHER_ROOT_FILENAMES.FILENAME | Name of the file.
**Validators**:
• this filename could be a relative path
• file type allowed: "file" | ### Variable and changelog documentation > **🛈 Informations** > > **doc.tables**\ > *`disabled`*\ > **Disabled**: if "[Generate document in format](#doc.output_format)" is json or "[Generated content](#doc.contents)" hasn't variable or changelog | Variable | Description | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **doc.tables.without_family**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory`
**Command line**:
• -df, --doc.tables.without_family
• -ndf, --doc.tables.no-without_family
**Environment variable**: ROUGAILCLI_DOC.TABLES.WITHOUT_FAMILY | Do not add families in documentation.
**Default**: false | | **doc.tables.with_commandline**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory`
**Command line**:
• -dw, --doc.tables.with_commandline
• -ndw, --doc.tables.no-with_commandline
**Environment variable**: ROUGAILCLI_DOC.TABLES.WITH_COMMANDLINE | Add command line informations in documentation.
**Default**: false | | **doc.tables.with_environment**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory`
**Command line**:
• -de, --doc.tables.with_environment
• -nde, --doc.tables.no-with_environment
**Environment variable**: ROUGAILCLI_DOC.TABLES.WITH_ENVIRONMENT | Add environment variable informations in documentation.
**Default**: false | | **doc.tables.environment_prefix**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` *`disabled`*
**Command line**: -dv, --doc.tables.environment_prefix
**Environment variable**: ROUGAILCLI_DOC.TABLES.ENVIRONMENT_PREFIX | Environment variable prefix name.
**Validator**: should only use uppercase characters
**Default**: ROUGAIL
**Disabled**: if "main_namespace" is not set or "[Add environment variable informations in documentation](#doc.tables.with_environment)" is false | ### Changelog documentation > **🛈 Informations** > > **doc.changelog**\ > *`disabled`*\ > **Disabled**: if changelog in not in "[Generated content](#doc.contents)" | Variable | Description | |----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **doc.changelog.previous_json_file**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory`
**Command line**: -dp, --doc.changelog.previous_json_file
**Environment variable**: ROUGAILCLI_DOC.CHANGELOG.PREVIOUS_JSON_FILE | Previous description file in JSON format.
To generate the changelog, you need to compare the old list of variables (in json format) with the current variables. | ### Examples configuration > **🛈 Informations** > > **doc.examples**\ > *`disabled`*\ > **Disabled**: if example is not in "[Generated content](#doc.contents)" | Variable | Description | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **doc.examples.comment**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory`
**Command line**:
• -dx, --doc.examples.comment
• -ndx, --doc.examples.no-comment
**Environment variable**: ROUGAILCLI_DOC.EXAMPLES.COMMENT | Add description of variables and families when generate examples.
**Default**: false | | **doc.examples.comment_column**
[`integer`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` *`disabled`*
**Command line**: --doc.examples.comment_column
**Environment variable**: ROUGAILCLI_DOC.EXAMPLES.COMMENT_COLUMN | Comment in examples starts at column.
**Default**: 30
**Disabled**: when the variable "[Add description of variables and families when generate examples](#doc.examples.comment)" has the value "false" | # Three columns ## Generate documentation > **🛈 Informations** > > **doc**\ > *`disabled`*\ > **Disabled**: if doc is not set in "[Select for output](#step.output)" | Variable | Description | Default value | |-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------| | **doc.output_format**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory`
**Command line**: -do, --doc.output_format
**Environment variable**: ROUGAILCLI_DOC.OUTPUT_FORMAT | Generate document in format.
**Choices**:
• console
• asciidoc
• html
• github
• gitlab
• json | console | | **doc.table_model**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` *`disabled`*
**Command line**: -dm, --doc.table_model
**Environment variable**: ROUGAILCLI_DOC.TABLE_MODEL | Generate document with this table model.
**Choices**:
• two_columns
• three_columns
• four_columns
• five_columns
• six_columns
**Disabled**: the value json is not compatible with changelog and example "[Generated content](#doc.contents)" | two_columns | | **doc.contents**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` `mandatory` *`hidden`* `unique`
**Command line**: -dc, --doc.contents
**Environment variable**: ROUGAILCLI_DOC.CONTENTS | Generated content.
You can generate three type of document. All variables ("variables"), an example file in YAML format ("example") or change log ("changelog").
**Choices**:
• variables
• example
• changelog
**Hidden**: the value json is not compatible with changelog and example "[Generated content](#doc.contents)" | • variables | | **doc.title_level**
[`integer`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory`
**Command line**: -dt, --doc.title_level
**Environment variable**: ROUGAILCLI_DOC.TITLE_LEVEL | Starting title level. | 1 | | **doc.default_values**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory`
**Command line**:
• --doc.default_values
• --doc.no-default_values
**Environment variable**: ROUGAILCLI_DOC.DEFAULT_VALUES | Modify values to document all variables.
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 | | **doc.true_color**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` *`disabled`*
**Command line**:
• --doc.true_color
• --doc.no-true_color
**Environment variable**: ROUGAILCLI_DOC.TRUE_COLOR | Display documentation in console always with true color terminal.
**Disabled**: when the variable "[Generate document in format](#doc.output_format)" hasn't the value "console" | false | | **doc.root**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types)
**Command line**: -dr, --doc.root
**Environment variable**: ROUGAILCLI_DOC.ROOT | Document the child variables of the family. | | ### The variables in this family are documented in another file > **🛈 Informations** > > **doc.other_root_filenames**\ > This family contains lists of variable blocks.\ > *`disabled`*\ > **Disabled**: if "[Document the child variables of the family](#doc.root)" haven't any value | Variable | Description | |-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------| | **doc.other_root_filenames.root_path**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` `unique`
**Command line**: --doc.other_root_filenames.root_path
**Environment variable**: ROUGAILCLI_DOC.OTHER_ROOT_FILENAMES.ROOT_PATH | Family name. | | **doc.other_root_filenames.filename**
[`UNIX filename`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory`
**Command line**: --doc.other_root_filenames.filename
**Environment variable**: ROUGAILCLI_DOC.OTHER_ROOT_FILENAMES.FILENAME | Name of the file.
**Validators**:
• this filename could be a relative path
• file type allowed: "file" | ### Variable and changelog documentation > **🛈 Informations** > > **doc.tables**\ > *`disabled`*\ > **Disabled**: if "[Generate document in format](#doc.output_format)" is json or "[Generated content](#doc.contents)" hasn't variable or changelog | Variable | Description | Default value | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------| | **doc.tables.without_family**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory`
**Command line**:
• -df, --doc.tables.without_family
• -ndf, --doc.tables.no-without_family
**Environment variable**: ROUGAILCLI_DOC.TABLES.WITHOUT_FAMILY | Do not add families in documentation. | false | | **doc.tables.with_commandline**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory`
**Command line**:
• -dw, --doc.tables.with_commandline
• -ndw, --doc.tables.no-with_commandline
**Environment variable**: ROUGAILCLI_DOC.TABLES.WITH_COMMANDLINE | Add command line informations in documentation. | false | | **doc.tables.with_environment**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory`
**Command line**:
• -de, --doc.tables.with_environment
• -nde, --doc.tables.no-with_environment
**Environment variable**: ROUGAILCLI_DOC.TABLES.WITH_ENVIRONMENT | Add environment variable informations in documentation. | false | | **doc.tables.environment_prefix**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` *`disabled`*
**Command line**: -dv, --doc.tables.environment_prefix
**Environment variable**: ROUGAILCLI_DOC.TABLES.ENVIRONMENT_PREFIX | Environment variable prefix name.
**Validator**: should only use uppercase characters
**Disabled**: if "main_namespace" is not set or "[Add environment variable informations in documentation](#doc.tables.with_environment)" is false | ROUGAIL | ### Changelog documentation > **🛈 Informations** > > **doc.changelog**\ > *`disabled`*\ > **Disabled**: if changelog in not in "[Generated content](#doc.contents)" | Variable | Description | |----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **doc.changelog.previous_json_file**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory`
**Command line**: -dp, --doc.changelog.previous_json_file
**Environment variable**: ROUGAILCLI_DOC.CHANGELOG.PREVIOUS_JSON_FILE | Previous description file in JSON format.
To generate the changelog, you need to compare the old list of variables (in json format) with the current variables. | ### Examples configuration > **🛈 Informations** > > **doc.examples**\ > *`disabled`*\ > **Disabled**: if example is not in "[Generated content](#doc.contents)" | Variable | Description | Default value | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------| | **doc.examples.comment**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory`
**Command line**:
• -dx, --doc.examples.comment
• -ndx, --doc.examples.no-comment
**Environment variable**: ROUGAILCLI_DOC.EXAMPLES.COMMENT | Add description of variables and families when generate examples. | false | | **doc.examples.comment_column**
[`integer`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` *`disabled`*
**Command line**: --doc.examples.comment_column
**Environment variable**: ROUGAILCLI_DOC.EXAMPLES.COMMENT_COLUMN | Comment in examples starts at column.
**Disabled**: when the variable "[Add description of variables and families when generate examples](#doc.examples.comment)" has the value "false" | 30 | # Four columns ## Generate documentation > **🛈 Informations** > > **doc**\ > *`disabled`*\ > **Disabled**: if doc is not set in "[Select for output](#step.output)" | Variable | Description | Default value | Type | |---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------|-----------------------------------------------------------------------------------------------------------| | **doc.output_format**
**Command line**: -do, --doc.output_format
**Environment variable**: ROUGAILCLI_DOC.OUTPUT_FORMAT | Generate document in format.
**Choices**:
• console
• asciidoc
• html
• github
• gitlab
• json | console | [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | | **doc.table_model**
*`disabled`*
**Command line**: -dm, --doc.table_model
**Environment variable**: ROUGAILCLI_DOC.TABLE_MODEL | Generate document with this table model.
**Choices**:
• two_columns
• three_columns
• four_columns
• five_columns
• six_columns
**Disabled**: the value json is not compatible with changelog and example "[Generated content](#doc.contents)" | two_columns | [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | | **doc.contents**
*`hidden`* `unique`
**Command line**: -dc, --doc.contents
**Environment variable**: ROUGAILCLI_DOC.CONTENTS | Generated content.
You can generate three type of document. All variables ("variables"), an example file in YAML format ("example") or change log ("changelog").
**Choices**:
• variables
• example
• changelog
**Hidden**: the value json is not compatible with changelog and example "[Generated content](#doc.contents)" | • variables | [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` `mandatory` | | **doc.title_level**
**Command line**: -dt, --doc.title_level
**Environment variable**: ROUGAILCLI_DOC.TITLE_LEVEL | Starting title level. | 1 | [`integer`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | | **doc.default_values**
**Command line**:
• --doc.default_values
• --doc.no-default_values
**Environment variable**: ROUGAILCLI_DOC.DEFAULT_VALUES | Modify values to document all variables.
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` | | **doc.true_color**
*`disabled`*
**Command line**:
• --doc.true_color
• --doc.no-true_color
**Environment variable**: ROUGAILCLI_DOC.TRUE_COLOR | Display documentation in console always with true color terminal.
**Disabled**: when the variable "[Generate document in format](#doc.output_format)" hasn't the value "console" | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | | **doc.root**
**Command line**: -dr, --doc.root
**Environment variable**: ROUGAILCLI_DOC.ROOT | Document the child variables of the family. | | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) | ### The variables in this family are documented in another file > **🛈 Informations** > > **doc.other_root_filenames**\ > This family contains lists of variable blocks.\ > *`disabled`*\ > **Disabled**: if "[Document the child variables of the family](#doc.root)" haven't any value | Variable | Description | Type | |-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------| | **doc.other_root_filenames.root_path**
`unique`
**Command line**: --doc.other_root_filenames.root_path
**Environment variable**: ROUGAILCLI_DOC.OTHER_ROOT_FILENAMES.ROOT_PATH | Family name. | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` | | **doc.other_root_filenames.filename**
**Command line**: --doc.other_root_filenames.filename
**Environment variable**: ROUGAILCLI_DOC.OTHER_ROOT_FILENAMES.FILENAME | Name of the file.
**Validators**:
• this filename could be a relative path
• file type allowed: "file" | [`UNIX filename`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | ### Variable and changelog documentation > **🛈 Informations** > > **doc.tables**\ > *`disabled`*\ > **Disabled**: if "[Generate document in format](#doc.output_format)" is json or "[Generated content](#doc.contents)" hasn't variable or changelog | Variable | Description | Default value | Type | |--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------|-------------------------------------------------------------------------------------------------| | **doc.tables.without_family**
**Command line**:
• -df, --doc.tables.without_family
• -ndf, --doc.tables.no-without_family
**Environment variable**: ROUGAILCLI_DOC.TABLES.WITHOUT_FAMILY | Do not add families in documentation. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | | **doc.tables.with_commandline**
**Command line**:
• -dw, --doc.tables.with_commandline
• -ndw, --doc.tables.no-with_commandline
**Environment variable**: ROUGAILCLI_DOC.TABLES.WITH_COMMANDLINE | Add command line informations in documentation. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | | **doc.tables.with_environment**
**Command line**:
• -de, --doc.tables.with_environment
• -nde, --doc.tables.no-with_environment
**Environment variable**: ROUGAILCLI_DOC.TABLES.WITH_ENVIRONMENT | Add environment variable informations in documentation. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | | **doc.tables.environment_prefix**
*`disabled`*
**Command line**: -dv, --doc.tables.environment_prefix
**Environment variable**: ROUGAILCLI_DOC.TABLES.ENVIRONMENT_PREFIX | Environment variable prefix name.
**Validator**: should only use uppercase characters
**Disabled**: if "main_namespace" is not set or "[Add environment variable informations in documentation](#doc.tables.with_environment)" is false | ROUGAIL | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | ### Changelog documentation > **🛈 Informations** > > **doc.changelog**\ > *`disabled`*\ > **Disabled**: if changelog in not in "[Generated content](#doc.contents)" | Variable | Description | Type | |-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------| | **doc.changelog.previous_json_file**
**Command line**: -dp, --doc.changelog.previous_json_file
**Environment variable**: ROUGAILCLI_DOC.CHANGELOG.PREVIOUS_JSON_FILE | Previous description file in JSON format.
To generate the changelog, you need to compare the old list of variables (in json format) with the current variables. | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | ### Examples configuration > **🛈 Informations** > > **doc.examples**\ > *`disabled`*\ > **Disabled**: if example is not in "[Generated content](#doc.contents)" | Variable | Description | Default value | Type | |--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------|-------------------------------------------------------------------------------------------------| | **doc.examples.comment**
**Command line**:
• -dx, --doc.examples.comment
• -ndx, --doc.examples.no-comment
**Environment variable**: ROUGAILCLI_DOC.EXAMPLES.COMMENT | Add description of variables and families when generate examples. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | | **doc.examples.comment_column**
*`disabled`*
**Command line**: --doc.examples.comment_column
**Environment variable**: ROUGAILCLI_DOC.EXAMPLES.COMMENT_COLUMN | Comment in examples starts at column.
**Disabled**: when the variable "[Add description of variables and families when generate examples](#doc.examples.comment)" has the value "false" | 30 | [`integer`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | # Five columns ## Generate documentation > **🛈 Informations** > > **doc**\ > *`disabled`*\ > **Disabled**: if doc is not set in "[Select for output](#step.output)" | Variable | Description | Default value | Type | Access control | |---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------|-----------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------| | **doc.output_format**
**Command line**: -do, --doc.output_format
**Environment variable**: ROUGAILCLI_DOC.OUTPUT_FORMAT | Generate document in format.
**Choices**:
• console
• asciidoc
• html
• github
• gitlab
• json | console | [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | | | **doc.table_model**
**Command line**: -dm, --doc.table_model
**Environment variable**: ROUGAILCLI_DOC.TABLE_MODEL | Generate document with this table model.
**Choices**:
• two_columns
• three_columns
• four_columns
• five_columns
• six_columns | two_columns | [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | *`disabled`*
**Disabled**: the value json is not compatible with changelog and example "[Generated content](#doc.contents)" | | **doc.contents**
`unique`
**Command line**: -dc, --doc.contents
**Environment variable**: ROUGAILCLI_DOC.CONTENTS | Generated content.
You can generate three type of document. All variables ("variables"), an example file in YAML format ("example") or change log ("changelog").
**Choices**:
• variables
• example
• changelog | • variables | [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` `mandatory` | *`hidden`*
**Hidden**: the value json is not compatible with changelog and example "[Generated content](#doc.contents)" | | **doc.title_level**
**Command line**: -dt, --doc.title_level
**Environment variable**: ROUGAILCLI_DOC.TITLE_LEVEL | Starting title level. | 1 | [`integer`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | | | **doc.default_values**
**Command line**:
• --doc.default_values
• --doc.no-default_values
**Environment variable**: ROUGAILCLI_DOC.DEFAULT_VALUES | Modify values to document all variables.
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` | | | **doc.true_color**
**Command line**:
• --doc.true_color
• --doc.no-true_color
**Environment variable**: ROUGAILCLI_DOC.TRUE_COLOR | Display documentation in console always with true color terminal. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | *`disabled`*
**Disabled**: when the variable "[Generate document in format](#doc.output_format)" hasn't the value "console" | | **doc.root**
**Command line**: -dr, --doc.root
**Environment variable**: ROUGAILCLI_DOC.ROOT | Document the child variables of the family. | | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) | | ### The variables in this family are documented in another file > **🛈 Informations** > > **doc.other_root_filenames**\ > This family contains lists of variable blocks.\ > *`disabled`*\ > **Disabled**: if "[Document the child variables of the family](#doc.root)" haven't any value | Variable | Description | Type | |-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------| | **doc.other_root_filenames.root_path**
`unique`
**Command line**: --doc.other_root_filenames.root_path
**Environment variable**: ROUGAILCLI_DOC.OTHER_ROOT_FILENAMES.ROOT_PATH | Family name. | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` | | **doc.other_root_filenames.filename**
**Command line**: --doc.other_root_filenames.filename
**Environment variable**: ROUGAILCLI_DOC.OTHER_ROOT_FILENAMES.FILENAME | Name of the file.
**Validators**:
• this filename could be a relative path
• file type allowed: "file" | [`UNIX filename`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | ### Variable and changelog documentation > **🛈 Informations** > > **doc.tables**\ > *`disabled`*\ > **Disabled**: if "[Generate document in format](#doc.output_format)" is json or "[Generated content](#doc.contents)" hasn't variable or changelog | Variable | Description | Default value | Type | Access control | |--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------|-----------------|-------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **doc.tables.without_family**
**Command line**:
• -df, --doc.tables.without_family
• -ndf, --doc.tables.no-without_family
**Environment variable**: ROUGAILCLI_DOC.TABLES.WITHOUT_FAMILY | Do not add families in documentation. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | | | **doc.tables.with_commandline**
**Command line**:
• -dw, --doc.tables.with_commandline
• -ndw, --doc.tables.no-with_commandline
**Environment variable**: ROUGAILCLI_DOC.TABLES.WITH_COMMANDLINE | Add command line informations in documentation. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | | | **doc.tables.with_environment**
**Command line**:
• -de, --doc.tables.with_environment
• -nde, --doc.tables.no-with_environment
**Environment variable**: ROUGAILCLI_DOC.TABLES.WITH_ENVIRONMENT | Add environment variable informations in documentation. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | | | **doc.tables.environment_prefix**
**Command line**: -dv, --doc.tables.environment_prefix
**Environment variable**: ROUGAILCLI_DOC.TABLES.ENVIRONMENT_PREFIX | Environment variable prefix name.
**Validator**: should only use uppercase characters | ROUGAIL | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | *`disabled`*
**Disabled**: if "main_namespace" is not set or "[Add environment variable informations in documentation](#doc.tables.with_environment)" is false | ### Changelog documentation > **🛈 Informations** > > **doc.changelog**\ > *`disabled`*\ > **Disabled**: if changelog in not in "[Generated content](#doc.contents)" | Variable | Description | Type | |-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------| | **doc.changelog.previous_json_file**
**Command line**: -dp, --doc.changelog.previous_json_file
**Environment variable**: ROUGAILCLI_DOC.CHANGELOG.PREVIOUS_JSON_FILE | Previous description file in JSON format.
To generate the changelog, you need to compare the old list of variables (in json format) with the current variables. | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | ### Examples configuration > **🛈 Informations** > > **doc.examples**\ > *`disabled`*\ > **Disabled**: if example is not in "[Generated content](#doc.contents)" | Variable | Description | Default value | Type | Access control | |--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------|-----------------|-------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **doc.examples.comment**
**Command line**:
• -dx, --doc.examples.comment
• -ndx, --doc.examples.no-comment
**Environment variable**: ROUGAILCLI_DOC.EXAMPLES.COMMENT | Add description of variables and families when generate examples. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | | | **doc.examples.comment_column**
**Command line**: --doc.examples.comment_column
**Environment variable**: ROUGAILCLI_DOC.EXAMPLES.COMMENT_COLUMN | Comment in examples starts at column. | 30 | [`integer`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | *`disabled`*
**Disabled**: when the variable "[Add description of variables and families when generate examples](#doc.examples.comment)" has the value "false" | # Six columns ## Generate documentation > **🛈 Informations** > > **doc**\ > *`disabled`*\ > **Disabled**: if doc is not set in "[Select for output](#step.output)" | Variable | Description | Default value | Type | Access control | Validator | |---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------|-----------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------|-------------| | **doc.output_format**
**Command line**: -do, --doc.output_format
**Environment variable**: ROUGAILCLI_DOC.OUTPUT_FORMAT | Generate document in format.
**Choices**:
• console
• asciidoc
• html
• github
• gitlab
• json | console | [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | | | | **doc.table_model**
**Command line**: -dm, --doc.table_model
**Environment variable**: ROUGAILCLI_DOC.TABLE_MODEL | Generate document with this table model.
**Choices**:
• two_columns
• three_columns
• four_columns
• five_columns
• six_columns | two_columns | [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | *`disabled`*
**Disabled**: the value json is not compatible with changelog and example "[Generated content](#doc.contents)" | | | **doc.contents**
**Command line**: -dc, --doc.contents
**Environment variable**: ROUGAILCLI_DOC.CONTENTS | Generated content.
You can generate three type of document. All variables ("variables"), an example file in YAML format ("example") or change log ("changelog").
**Choices**:
• variables
• example
• changelog | • variables | [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` `mandatory` | *`hidden`*
**Hidden**: the value json is not compatible with changelog and example "[Generated content](#doc.contents)" | `unique` | | **doc.title_level**
**Command line**: -dt, --doc.title_level
**Environment variable**: ROUGAILCLI_DOC.TITLE_LEVEL | Starting title level. | 1 | [`integer`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | | | | **doc.default_values**
**Command line**:
• --doc.default_values
• --doc.no-default_values
**Environment variable**: ROUGAILCLI_DOC.DEFAULT_VALUES | Modify values to document all variables.
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` | | | | **doc.true_color**
**Command line**:
• --doc.true_color
• --doc.no-true_color
**Environment variable**: ROUGAILCLI_DOC.TRUE_COLOR | Display documentation in console always with true color terminal. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | *`disabled`*
**Disabled**: when the variable "[Generate document in format](#doc.output_format)" hasn't the value "console" | | | **doc.root**
**Command line**: -dr, --doc.root
**Environment variable**: ROUGAILCLI_DOC.ROOT | Document the child variables of the family. | | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) | | | ### The variables in this family are documented in another file > **🛈 Informations** > > **doc.other_root_filenames**\ > This family contains lists of variable blocks.\ > *`disabled`*\ > **Disabled**: if "[Document the child variables of the family](#doc.root)" haven't any value | Variable | Description | Type | Validator | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------|-------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------| | **doc.other_root_filenames.root_path**
**Command line**: --doc.other_root_filenames.root_path
**Environment variable**: ROUGAILCLI_DOC.OTHER_ROOT_FILENAMES.ROOT_PATH | Family name. | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` | `unique` | | **doc.other_root_filenames.filename**
**Command line**: --doc.other_root_filenames.filename
**Environment variable**: ROUGAILCLI_DOC.OTHER_ROOT_FILENAMES.FILENAME | Name of the file. | [`UNIX filename`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | • this filename could be a relative path
• file type allowed: "file". | ### Variable and changelog documentation > **🛈 Informations** > > **doc.tables**\ > *`disabled`*\ > **Disabled**: if "[Generate document in format](#doc.output_format)" is json or "[Generated content](#doc.contents)" hasn't variable or changelog | Variable | Description | Default value | Type | Access control | Validator | |--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------|-----------------|-------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------| | **doc.tables.without_family**
**Command line**:
• -df, --doc.tables.without_family
• -ndf, --doc.tables.no-without_family
**Environment variable**: ROUGAILCLI_DOC.TABLES.WITHOUT_FAMILY | Do not add families in documentation. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | | | | **doc.tables.with_commandline**
**Command line**:
• -dw, --doc.tables.with_commandline
• -ndw, --doc.tables.no-with_commandline
**Environment variable**: ROUGAILCLI_DOC.TABLES.WITH_COMMANDLINE | Add command line informations in documentation. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | | | | **doc.tables.with_environment**
**Command line**:
• -de, --doc.tables.with_environment
• -nde, --doc.tables.no-with_environment
**Environment variable**: ROUGAILCLI_DOC.TABLES.WITH_ENVIRONMENT | Add environment variable informations in documentation. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | | | | **doc.tables.environment_prefix**
**Command line**: -dv, --doc.tables.environment_prefix
**Environment variable**: ROUGAILCLI_DOC.TABLES.ENVIRONMENT_PREFIX | Environment variable prefix name. | ROUGAIL | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | *`disabled`*
**Disabled**: if "main_namespace" is not set or "[Add environment variable informations in documentation](#doc.tables.with_environment)" is false | Should only use uppercase characters. | ### Changelog documentation > **🛈 Informations** > > **doc.changelog**\ > *`disabled`*\ > **Disabled**: if changelog in not in "[Generated content](#doc.contents)" | Variable | Description | Type | |-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------| | **doc.changelog.previous_json_file**
**Command line**: -dp, --doc.changelog.previous_json_file
**Environment variable**: ROUGAILCLI_DOC.CHANGELOG.PREVIOUS_JSON_FILE | Previous description file in JSON format.
To generate the changelog, you need to compare the old list of variables (in json format) with the current variables. | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | ### Examples configuration > **🛈 Informations** > > **doc.examples**\ > *`disabled`*\ > **Disabled**: if example is not in "[Generated content](#doc.contents)" | Variable | Description | Default value | Type | Access control | |--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------|-----------------|-------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **doc.examples.comment**
**Command line**:
• -dx, --doc.examples.comment
• -ndx, --doc.examples.no-comment
**Environment variable**: ROUGAILCLI_DOC.EXAMPLES.COMMENT | Add description of variables and families when generate examples. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | | | **doc.examples.comment_column**
**Command line**: --doc.examples.comment_column
**Environment variable**: ROUGAILCLI_DOC.EXAMPLES.COMMENT_COLUMN | Comment in examples starts at column. | 30 | [`integer`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | *`disabled`*
**Disabled**: when the variable "[Add description of variables and families when generate examples](#doc.examples.comment)" has the value "false" |