98 lines
2 KiB
ReStructuredText
98 lines
2 KiB
ReStructuredText
Displays the data in a table
|
|
============================
|
|
|
|
.. note::
|
|
|
|
| The goal is not to display all the variables in the configuration, but only a selection using the labeling mechanism.
|
|
| **Path**: table
|
|
| `*disabled*`
|
|
| **Disabled**: if table is not set in "select for output" (step.output).
|
|
|
|
|
|
|
|
.. list-table::
|
|
|
|
* - Variable
|
|
- Description
|
|
|
|
* - **table.first_column**
|
|
|
|
`choice <https://rougail.readthedocs.io/en/latest/variable.html#variables-types>`__ `mandatory`
|
|
|
|
**Command line**:
|
|
|
|
--table.first_column
|
|
|
|
**Environment variable**: ROUGAILCLI_TABLE.FIRST_COLUMN
|
|
- Content of the first column.
|
|
|
|
**Validator**: Tag name must not have the same name has first column
|
|
|
|
**Choices**:
|
|
|
|
|
|
|
|
- description
|
|
|
|
- namespace
|
|
|
|
|
|
|
|
**Default**: First column is description if "Tag names" (table.columns) has only one value, otherwise it's namespace.
|
|
|
|
* - **table.columns**
|
|
|
|
`string <https://rougail.readthedocs.io/en/latest/variable.html#variables-types>`__ `multiple` `mandatory` `unique`
|
|
|
|
**Command line**:
|
|
|
|
--table.columns
|
|
|
|
**Environment variable**: ROUGAILCLI_TABLE.COLUMNS
|
|
- Tag names.
|
|
|
|
Each tag creates a column. The content of the columns comes from the variables with the defined tags.
|
|
|
|
* - **table.output_format**
|
|
|
|
`choice <https://rougail.readthedocs.io/en/latest/variable.html#variables-types>`__ `mandatory`
|
|
|
|
**Command line**:
|
|
|
|
--table.output_format
|
|
|
|
**Environment variable**: ROUGAILCLI_TABLE.OUTPUT_FORMAT
|
|
- Tag names.
|
|
|
|
**Choices**:
|
|
|
|
|
|
|
|
- console **← (default)**
|
|
|
|
- github
|
|
|
|
- asciidoc
|
|
|
|
- html
|
|
|
|
- rst
|
|
|
|
* - **table.header**
|
|
|
|
`boolean <https://rougail.readthedocs.io/en/latest/variable.html#variables-types>`__ `mandatory`
|
|
|
|
**Command line**:
|
|
|
|
|
|
|
|
- --table.header
|
|
|
|
- --table.no-header
|
|
|
|
|
|
|
|
**Environment variable**: ROUGAILCLI_TABLE.HEADER
|
|
- Add header in table.
|
|
|
|
**Default**: true
|