rougail-tutorials/README.md

- [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


<img src="firefox.png" width=50% height=50% alt="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



<p>
<a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_001/./">.</a><br/>
	└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_001/./firefox/">firefox</a><br/>
	    └── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_001/./firefox/00-proxy.yml">00-proxy.yml</a><br/>
<br/><br/></p>

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                                                                                                                                                   |
|------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **<a id="proxy_mode" name="proxy_mode">proxy_mode</a>**<br/>[`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                                                                                                                                                   |
|------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **<a id="proxy_mode" name="proxy_mode">proxy_mode</a>**<br/>[`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
```
> [!CAUTION]
> 
> - proxy_mode: :stop_sign: <span style="color: #C23636">mandatory variable but has no value</span>

***
#### Output in read write mode

```shell
rougail -m firefox/ -u yaml -yf config/01/config.yml --cli.read_write
```
> [!NOTE]
>
> **Caption:**
> - Variable
> - <span style="color: #B8860B">Default value</span>

Variables:
- :notebook: proxy_mode: <span style="color: #B8860B">null</span>

***
### Example 2

#### config/02/config.yml


```yml
---
proxy_mode: No proxy
```

***
#### Output

```shell
rougail -m firefox/ -u yaml -yf config/02/config.yml
```
> [!NOTE]
>
> **Caption:**
> - Variable
> - <span style="color: #006400">Modified value</span>

Variables:
- :notebook: proxy_mode: <span style="color: #006400">No proxy</span> ← 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
```
> [!CAUTION]
> 
> - proxy_mode
>   - [#EFBF04]:bell: the value "1" is an invalid string, it's not a string, it will be ignored when loading from the YAML file "config/03/config.yml"[/#EFBF04]
>   - [#C23636]:stop_sign: mandatory variable but has no value[/#C23636]

***
#### Output when invalid user data is an error

```shell
rougail -m firefox/ -u yaml -yf config/03/config.yml --cli.invalid_user_data_error
```
> [!CAUTION]
> 
> - proxy_mode: :stop_sign: <span style="color: #C23636">the value "1" is an invalid string, it's not a string, it has been loading from the YAML file "config/03/config.yml"</span>

***


- [[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))