rougail-output-table/README.md

---
gitea: none
include_toc: true
---
[🇬🇧 (EN)](README.md) - [🇫🇷 (FR)](README.fr.md)

## 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)"

| Variable                                                                                                                                                                               | Description                                                                                                          | Default value                                                                                             | Type                                                                                                      | Validator                                                                                                            |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------|
| **<a id="table.first_column" name="table.first_column">table.first_column</a>**<br/>**Command line**: --table.first_column<br/>**Environment variable**: TABLE.FIRST_COLUMN            | Content of the first column.                                                                                         | First column is description if "[Tag names](#table.columns)" has only one value, otherwise it's namespace | [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory`            | Tag name must not have the same name has first column.<br/>**Choices**: <br/>•&nbsp;description<br/>•&nbsp;namespace |
| **<a id="table.columns" name="table.columns">table.columns</a>**<br/>**Command line**: --table.columns<br/>**Environment variable**: TABLE.COLUMNS                                     | Tag names.<br/>Each tag creates a column. The content of the columns comes from the variables with the defined tags. |                                                                                                           | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` `mandatory` | `unique`                                                                                                             |
| **<a id="table.output_format" name="table.output_format">table.output_format</a>**<br/>**Command line**: --table.output_format<br/>**Environment variable**: TABLE.OUTPUT_FORMAT       | Tag names.                                                                                                           | console                                                                                                   | [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory`            | **Choices**: <br/>•&nbsp;console<br/>•&nbsp;github<br/>•&nbsp;asciidoc<br/>•&nbsp;html<br/>•&nbsp;rst                |
| **<a id="table.header" name="table.header">table.header</a>**<br/>**Command line**: <br/>•&nbsp;--table.header<br/>•&nbsp;--table.no-header<br/>**Environment variable**: TABLE.HEADER | Add header in table.                                                                                                 | true                                                                                                      | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory`           |                                                                                                                      |