rougail-tutorials/README.md

- [Summary](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/branch/1.1/README.md)
- [[tutorial v1.1_022] Putting a variable inside of a family or a sub family](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_022/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_030~1..v1.1_030))

# [tutorial v1.1_030] A variable with type "domainname"

[Read the tutorial "A variable with type "domainname"" in the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/types.html#a-variable-with-type-domainname)


## 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_030
```

## Structure

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

Contents of the firefox/10-manual.yml file

```yml
%YAML 1.2
---
version: 1.1

manual:  # Manual proxy configuration

  http_proxy:  # HTTP Proxy

    address:
      description: HTTP address
      type: domainname
...

```

***
### Let's generate the documentation

```shell
rougail -m firefox/ -o doc
```
[View the documentation file](DOCUMENTATION.md)


***
### Let's generate the changelog

```shell
rougail -m firefox/ -o doc --doc.contents changelog --doc.changelog.previous_json_file previous.yml
```
[View the changelog file](CHANGELOG.md)

***
## User datas

### Example 1

#### config/01/config.yml


```yml
---
manual:
  http_proxy:
    address: example.net
```

***
#### Output

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

Variables:
- :notebook: proxy_mode (Configure Proxy Access to the Internet): <span style="color: #B8860B">No proxy</span>
- :open_file_folder: manual (Manual proxy configuration)
  - :open_file_folder: http_proxy (HTTP Proxy)
    - :notebook: address (HTTP address): <span style="color: #006400">example.net</span> ← loaded from the YAML file "config/01/config.yml"

***
### Example 2

#### config/02/config.yml


```yml
---
manual:
  http_proxy:
    address: 192.168.0.1
```

***
#### Output

```shell
rougail -m firefox/ -u yaml -yf config/02/config.yml
```
> [!CAUTION]
> 
> - manual (Manual proxy configuration)
>   - http_proxy (HTTP Proxy)
>     - address (HTTP address)
>       - <span style='color: #EFBF04'>:bell: the value "192.168.0.1" is an invalid domain name, must not be an IP, it will be ignored when loading from the YAML file "config/02/config.yml"</span>
>       - <span style='color: #C23636'>:stop_sign: mandatory variable but has no value</span>

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

```shell
rougail -m firefox/ -u yaml -yf config/02/config.yml --cli.invalid_user_data_error
```
> [!CAUTION]
> 
> - manual (Manual proxy configuration)
>   - http_proxy (HTTP Proxy)
>     - address (HTTP address)
>       - <span style='color: #C23636'>:stop_sign: the value "192.168.0.1" is an invalid domain name, must not be an IP, it has been loading from the YAML file "config/02/config.yml"</span>
>       - <span style='color: #C23636'>:stop_sign: mandatory variable but has no value</span>

***
### Example 3

#### config/03/config.yml


```yml
---
manual:
  http_proxy:
    address: not a valid domain name.com
```

***
#### Output

```shell
rougail -m firefox/ -u yaml -yf config/03/config.yml
```
> [!CAUTION]
> 
> - manual (Manual proxy configuration)
>   - http_proxy (HTTP Proxy)
>     - address (HTTP address)
>       - <span style='color: #EFBF04'>:bell: the value "not a valid domain name.com" is an invalid domain name, must start with lowercase characters followed by lowercase characters, number, "-" and "." characters are allowed, it will be ignored when loading from the YAML file "config/03/config.yml"</span>
>       - <span style='color: #C23636'>:stop_sign: mandatory variable but has no value</span>

***
#### 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]
> 
> - manual (Manual proxy configuration)
>   - http_proxy (HTTP Proxy)
>     - address (HTTP address)
>       - <span style='color: #C23636'>:stop_sign: the value "not a valid domain name.com" is an invalid domain name, must start with lowercase characters followed by lowercase characters, number, "-" and "." characters are allowed, it has been loading from the YAML file "config/03/config.yml"</span>
>       - <span style='color: #C23636'>:stop_sign: mandatory variable but has no value</span>

***


- [[tutorial v1.1_031] A variable with type’s parameters](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_031/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_031~1..v1.1_031))