- [Summary](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/branch/1.1/README.md) - [[tutorial v1.1_000] Creating a structure file](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_000/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_000~1..v1.1_000)) # [tutorial v1.1_001] Let’s add our first variable [View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_001~1..v1.1_001) [Read the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/preliminary.html#let-s-add-our-first-variable) ## Screenshot Firefox Proxy setting

## Clone and install To test this tutorial, you need to download this repository and install Rougail: ```shell git clone -b 1.1 https://forge.cloud.silique.fr/stove/rougail-tutorials.git cd rougail-tutorials python -m venv venv_rougail . venv_rougail/bin/activate pip install rougail-cli rougail-output-exporter rougail-output-doc rougail-user-data-yaml ``` Then switch to the tutorial page: ```shell git switch --detach v1.1_001 ``` ## Structure

.
└── firefox
└── 00-proxy.yml

Contents of the firefox/00-proxy.yml file ```yml %YAML 1.2 --- version: 1.1 proxy_mode: ... ``` ### Let's generate the documentation ```shell rougail -m firefox/ -o doc ``` | Variable | |------------------------------------------------------------------------------------------------------------------------------------------------------------| | **proxy_mode**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | ### Let's generate the changelog ```shell rougail -m firefox/ -o doc --doc.contents changelog ``` #### New variable | Variable | |------------------------------------------------------------------------------------------------------------------------------------------------------------| | **proxy_mode**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | ## User datas ### Example 1 #### config/01/config.yml ```yml --- ``` #### Output ```shell rougail -m firefox/ -u yaml -yf config/01/config.yml ```

🛑 ERRORS
┗━━ The following variables are mandatory but have no value:
    ┗━━ proxy_mode

#### Output in read write mode ```shell rougail -m firefox/ -u yaml -yf config/01/config.yml --cli.read_write ```

╭──────────────────── Caption ─────────────────────╮
│ Undocumented but modified variable Default value │
╰──────────────────────────────────────────────────╯
Variables:
┗━━ 📓 proxy_mode: null

### Example 2 #### config/02/config.yml ```yml --- proxy_mode: No proxy ``` #### Output ```shell rougail -m firefox/ -u yaml -yf config/02/config.yml ```

╭───────────────────── Caption ─────────────────────╮
│ Undocumented but modified variable Modified value │
╰───────────────────────────────────────────────────╯
Variables:
┗━━ 📓 proxy_mode: No proxy ◀ loaded from the YAML file "config/02/config.yml"

### Example 3 #### config/03/config.yml ```yml --- proxy_mode: 1 ``` #### Output ```shell rougail -m firefox/ -u yaml -yf config/03/config.yml ```

🔔 WARNINGS
┗━━ the value "1" is an invalid string for "proxy_mode", which is not a string, 
    it will be ignored when loading from the YAML file "config/03/config.yml"
🛑 ERRORS
┗━━ The following variables are mandatory but have no value:
    ┗━━ proxy_mode

#### Output when invalid user datas is an error ```shell rougail -m firefox/ -u yaml -yf config/03/config.yml --cli.invalid_user_datas_error ```

🛑 ERRORS
┗━━ the value "1" is an invalid string for "proxy_mode", which is not a string, 
    it will be ignored when loading from the YAML file "config/03/config.yml"

- [[tutorial v1.1_002] Describe the variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_002/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_002~1..v1.1_002))