Table of Contents

• Two columns
• Generate documentation
• Changelog and variable documentation
• Changelog and variable documentation
• Examples configuration
• Families or variables for this family are in an other file name
• Three columns
• Generate documentation
• Changelog and variable documentation
• Changelog and variable documentation
• Examples configuration
• Families or variables for this family are in an other file name
• Four columns
• Generate documentation
• Changelog and variable documentation
• Changelog and variable documentation
• Examples configuration
• Families or variables for this family are in an other file name
• Five columns
• Generate documentation
• Changelog and variable documentation
• Changelog and variable documentation
• Examples configuration
• Families or variables for this family are in an other file name
• Six columns
• Generate documentation
• Changelog and variable documentation
• Changelog and variable documentation
• Examples configuration
• Families or variables for this family are in an other file name

Two columns

Generate documentation

🛈 Informations

doc
basic disabled
Disabled: if "Generate documentation" is not set in "Select for output"

Variable	Description
doc.contents choice multiple standard mandatory 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
doc.output_format choice standard mandatory Command line: -do, --doc.output_format Environment variable: ROUGAILCLI_DOC.OUTPUT_FORMAT	Generate document in format. Validator: json output_format is not compatible with "changelog" and "example" contents Choices: • console ← (default) • asciidoc • html • github • gitlab • json
doc.table_model choice standard mandatory Command line: -dm, --doc.table_model Environment variable: ROUGAILCLI_DOC.TABLE_MODEL	Generate document with this table model. Validator: json output_format is not compatible with "changelog" and "example" contents Choices: • two_columns ← (default) • three_columns • four_columns • five_columns • six_columns
doc.title_level integer standard mandatory Command line: -dt, --doc.title_level Environment variable: ROUGAILCLI_DOC.TITLE_LEVEL	Starting title level. Default: 1
doc.default_values boolean standard 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_terminal boolean standard mandatory disabled Command line: • --doc.true_color_terminal • --doc.no-true_color_terminal Environment variable: ROUGAILCLI_DOC.TRUE_COLOR_TERMINAL	Force true color terminal. Default: false Disabled: when the variable "Generate document in format" hasn't the value "console"

Changelog and variable documentation

🛈 Informations

doc.tables
standard disabled
Disabled: if "Generate document in format" is json or "Generated content" hasn't variable or changelog

Variable	Description
doc.tables.without_family boolean standard 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 standard 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 standard 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 standard mandatory disabled Command line: -dd, --doc.tables.environment_prefix Environment variable: ROUGAILCLI_DOC.TABLES.ENVIRONMENT_PREFIX	Name of the default environment prefix. Validator: should only user uppercase characters Default: ROUGAIL Disabled: when "__.main_namespace" is not set or "Add environment variable informations in documentation" is false

Changelog and variable documentation

🛈 Informations

doc.changelog
basic disabled
Disabled: if changelog in not in "Generated content"

Variable	Description
doc.changelog.previous_json_file string basic 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
standard disabled
Disabled: if example in not in "Generated content"

Variable	Description
doc.examples.comment boolean standard 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 standard 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" has the value "false"

Variable	Description
doc.root string standard Command line: -dr, --doc.root Environment variable: ROUGAILCLI_DOC.ROOT	Document the variables from this family.

Families or variables for this family are in an other file name

🛈 Informations

doc.other_root_filenames
This family contains lists of variable blocks.
basic disabled
Disabled: if "Document the variables from this family" haven't any value

Variable	Description
doc.other_root_filenames.root_path string multiple standard unique Command line: --doc.other_root_filenames.root_path Environment variable: ROUGAILCLI_DOC.OTHER_ROOT_FILENAMES.ROOT_PATH	Root family name.
doc.other_root_filenames.filename UNIX filename basic 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: "directory" and "file"

Three columns

Generate documentation

🛈 Informations

doc
basic disabled
Disabled: if "Generate documentation" is not set in "Select for output"

Variable	Description	Default value
doc.contents choice multiple standard mandatory 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
doc.output_format choice standard mandatory Command line: -do, --doc.output_format Environment variable: ROUGAILCLI_DOC.OUTPUT_FORMAT	Generate document in format. Validator: json output_format is not compatible with "changelog" and "example" contents Choices: • console • asciidoc • html • github • gitlab • json	console
doc.table_model choice standard mandatory Command line: -dm, --doc.table_model Environment variable: ROUGAILCLI_DOC.TABLE_MODEL	Generate document with this table model. Validator: json output_format is not compatible with "changelog" and "example" contents Choices: • two_columns • three_columns • four_columns • five_columns • six_columns	two_columns
doc.title_level integer standard mandatory Command line: -dt, --doc.title_level Environment variable: ROUGAILCLI_DOC.TITLE_LEVEL	Starting title level.	1
doc.default_values boolean standard 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_terminal boolean standard mandatory disabled Command line: • --doc.true_color_terminal • --doc.no-true_color_terminal Environment variable: ROUGAILCLI_DOC.TRUE_COLOR_TERMINAL	Force true color terminal. Disabled: when the variable "Generate document in format" hasn't the value "console"	false

Changelog and variable documentation

🛈 Informations

doc.tables
standard disabled
Disabled: if "Generate document in format" is json or "Generated content" hasn't variable or changelog

Variable	Description	Default value
doc.tables.without_family boolean standard 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 standard 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 standard 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 standard mandatory disabled Command line: -dd, --doc.tables.environment_prefix Environment variable: ROUGAILCLI_DOC.TABLES.ENVIRONMENT_PREFIX	Name of the default environment prefix. Validator: should only user uppercase characters Disabled: when "__.main_namespace" is not set or "Add environment variable informations in documentation" is false	ROUGAIL

Changelog and variable documentation

🛈 Informations

doc.changelog
basic disabled
Disabled: if changelog in not in "Generated content"

Variable	Description
doc.changelog.previous_json_file string basic 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
standard disabled
Disabled: if example in not in "Generated content"

Variable	Description	Default value
doc.examples.comment boolean standard 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 standard 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" has the value "false"	30

Variable	Description
doc.root string standard Command line: -dr, --doc.root Environment variable: ROUGAILCLI_DOC.ROOT	Document the variables from this family.

Families or variables for this family are in an other file name

🛈 Informations

doc.other_root_filenames
This family contains lists of variable blocks.
basic disabled
Disabled: if "Document the variables from this family" haven't any value

Variable	Description
doc.other_root_filenames.root_path string multiple standard unique Command line: --doc.other_root_filenames.root_path Environment variable: ROUGAILCLI_DOC.OTHER_ROOT_FILENAMES.ROOT_PATH	Root family name.
doc.other_root_filenames.filename UNIX filename basic 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: "directory" and "file"

Four columns

Generate documentation

🛈 Informations

doc
basic disabled
Disabled: if "Generate documentation" is not set in "Select for output"

Variable	Description	Default value	Type
doc.contents standard 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 multiple mandatory
doc.output_format standard Command line: -do, --doc.output_format Environment variable: ROUGAILCLI_DOC.OUTPUT_FORMAT	Generate document in format. Validator: json output_format is not compatible with "changelog" and "example" contents Choices: • console • asciidoc • html • github • gitlab • json	console	choice mandatory
doc.table_model standard Command line: -dm, --doc.table_model Environment variable: ROUGAILCLI_DOC.TABLE_MODEL	Generate document with this table model. Validator: json output_format is not compatible with "changelog" and "example" contents Choices: • two_columns • three_columns • four_columns • five_columns • six_columns	two_columns	choice mandatory
doc.title_level standard Command line: -dt, --doc.title_level Environment variable: ROUGAILCLI_DOC.TITLE_LEVEL	Starting title level.	1	integer mandatory
doc.default_values standard 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 mandatory
doc.true_color_terminal standard disabled Command line: • --doc.true_color_terminal • --doc.no-true_color_terminal Environment variable: ROUGAILCLI_DOC.TRUE_COLOR_TERMINAL	Force true color terminal. Disabled: when the variable "Generate document in format" hasn't the value "console"	false	boolean mandatory

Changelog and variable documentation

🛈 Informations

doc.tables
standard disabled
Disabled: if "Generate document in format" is json or "Generated content" hasn't variable or changelog

Variable	Description	Default value	Type
doc.tables.without_family standard 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 mandatory
doc.tables.with_commandline standard 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 mandatory
doc.tables.with_environment standard 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 mandatory
doc.tables.environment_prefix standard disabled Command line: -dd, --doc.tables.environment_prefix Environment variable: ROUGAILCLI_DOC.TABLES.ENVIRONMENT_PREFIX	Name of the default environment prefix. Validator: should only user uppercase characters Disabled: when "__.main_namespace" is not set or "Add environment variable informations in documentation" is false	ROUGAIL	string mandatory

Changelog and variable documentation

🛈 Informations

doc.changelog
basic disabled
Disabled: if changelog in not in "Generated content"

Variable	Description	Type
doc.changelog.previous_json_file basic 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 mandatory

Examples configuration

🛈 Informations

doc.examples
standard disabled
Disabled: if example in not in "Generated content"

Variable	Description	Default value	Type
doc.examples.comment standard 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 mandatory
doc.examples.comment_column standard 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" has the value "false"	30	integer mandatory

Variable	Description	Type
doc.root standard Command line: -dr, --doc.root Environment variable: ROUGAILCLI_DOC.ROOT	Document the variables from this family.	string

Families or variables for this family are in an other file name

🛈 Informations

doc.other_root_filenames
This family contains lists of variable blocks.
basic disabled
Disabled: if "Document the variables from this family" haven't any value

Variable	Description	Type
doc.other_root_filenames.root_path standard unique Command line: --doc.other_root_filenames.root_path Environment variable: ROUGAILCLI_DOC.OTHER_ROOT_FILENAMES.ROOT_PATH	Root family name.	string multiple
doc.other_root_filenames.filename basic 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: "directory" and "file"	UNIX filename mandatory

Five columns

Generate documentation

🛈 Informations

doc
basic disabled
Disabled: if "Generate documentation" is not set in "Select for output"

Variable	Description	Default value	Type	Access control
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 multiple mandatory	standard
doc.output_format Command line: -do, --doc.output_format Environment variable: ROUGAILCLI_DOC.OUTPUT_FORMAT	Generate document in format. Validator: json output_format is not compatible with "changelog" and "example" contents Choices: • console • asciidoc • html • github • gitlab • json	console	choice mandatory	standard
doc.table_model Command line: -dm, --doc.table_model Environment variable: ROUGAILCLI_DOC.TABLE_MODEL	Generate document with this table model. Validator: json output_format is not compatible with "changelog" and "example" contents Choices: • two_columns • three_columns • four_columns • five_columns • six_columns	two_columns	choice mandatory	standard
doc.title_level Command line: -dt, --doc.title_level Environment variable: ROUGAILCLI_DOC.TITLE_LEVEL	Starting title level.	1	integer mandatory	standard
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 mandatory	standard
doc.true_color_terminal Command line: • --doc.true_color_terminal • --doc.no-true_color_terminal Environment variable: ROUGAILCLI_DOC.TRUE_COLOR_TERMINAL	Force true color terminal.	false	boolean mandatory	standard disabled Disabled: when the variable "Generate document in format" hasn't the value "console"

Changelog and variable documentation

🛈 Informations

doc.tables
standard disabled
Disabled: if "Generate document in format" is json or "Generated content" 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 mandatory	standard
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 mandatory	standard
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 mandatory	standard
doc.tables.environment_prefix Command line: -dd, --doc.tables.environment_prefix Environment variable: ROUGAILCLI_DOC.TABLES.ENVIRONMENT_PREFIX	Name of the default environment prefix. Validator: should only user uppercase characters	ROUGAIL	string mandatory	standard disabled Disabled: when "__.main_namespace" is not set or "Add environment variable informations in documentation" is false

Changelog and variable documentation

🛈 Informations

doc.changelog
basic disabled
Disabled: if changelog in not in "Generated content"

Variable	Description	Type	Access control
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 mandatory	basic

Examples configuration

🛈 Informations

doc.examples
standard disabled
Disabled: if example in not in "Generated content"

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 mandatory	standard
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 mandatory	standard disabled Disabled: when the variable "Add description of variables and families when generate examples" has the value "false"

Variable	Description	Type	Access control
doc.root Command line: -dr, --doc.root Environment variable: ROUGAILCLI_DOC.ROOT	Document the variables from this family.	string	standard

Families or variables for this family are in an other file name

🛈 Informations

doc.other_root_filenames
This family contains lists of variable blocks.
basic disabled
Disabled: if "Document the variables from this family" haven't any value

Variable	Description	Type	Access control
doc.other_root_filenames.root_path unique Command line: --doc.other_root_filenames.root_path Environment variable: ROUGAILCLI_DOC.OTHER_ROOT_FILENAMES.ROOT_PATH	Root family name.	string multiple	standard
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: "directory" and "file"	UNIX filename mandatory	basic

Six columns

Generate documentation

🛈 Informations

doc
basic disabled
Disabled: if "Generate documentation" is not set in "Select for output"

Variable	Description	Default value	Type	Access control	Validator
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 multiple mandatory	standard	unique
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 mandatory	standard	Json output_format is not compatible with "changelog" and "example" contents.
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 mandatory	standard	Json output_format is not compatible with "changelog" and "example" contents.
doc.title_level Command line: -dt, --doc.title_level Environment variable: ROUGAILCLI_DOC.TITLE_LEVEL	Starting title level.	1	integer mandatory	standard
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 mandatory	standard
doc.true_color_terminal Command line: • --doc.true_color_terminal • --doc.no-true_color_terminal Environment variable: ROUGAILCLI_DOC.TRUE_COLOR_TERMINAL	Force true color terminal.	false	boolean mandatory	standard disabled Disabled: when the variable "Generate document in format" hasn't the value "console"

Changelog and variable documentation

🛈 Informations

doc.tables
standard disabled
Disabled: if "Generate document in format" is json or "Generated content" 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 mandatory	standard
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 mandatory	standard
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 mandatory	standard
doc.tables.environment_prefix Command line: -dd, --doc.tables.environment_prefix Environment variable: ROUGAILCLI_DOC.TABLES.ENVIRONMENT_PREFIX	Name of the default environment prefix.	ROUGAIL	string mandatory	standard disabled Disabled: when "__.main_namespace" is not set or "Add environment variable informations in documentation" is false	Should only user uppercase characters.

Changelog and variable documentation

🛈 Informations

doc.changelog
basic disabled
Disabled: if changelog in not in "Generated content"

Variable	Description	Type	Access control
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 mandatory	basic

Examples configuration

🛈 Informations

doc.examples
standard disabled
Disabled: if example in not in "Generated content"

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 mandatory	standard
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 mandatory	standard disabled Disabled: when the variable "Add description of variables and families when generate examples" has the value "false"

Variable	Description	Type	Access control
doc.root Command line: -dr, --doc.root Environment variable: ROUGAILCLI_DOC.ROOT	Document the variables from this family.	string	standard

Families or variables for this family are in an other file name

🛈 Informations

doc.other_root_filenames
This family contains lists of variable blocks.
basic disabled
Disabled: if "Document the variables from this family" haven't any value

Variable	Description	Type	Access control	Validator
doc.other_root_filenames.root_path Command line: --doc.other_root_filenames.root_path Environment variable: ROUGAILCLI_DOC.OTHER_ROOT_FILENAMES.ROOT_PATH	Root family name.	string multiple	standard	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 mandatory	basic	• this filename could be a relative path • file type allowed: "directory" and "file".