@ -1,9 +1,9 @@
- [Summary ](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/branch/1.1/README.md )
- [Summary ](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/branch/1.1/README.md )
- [[tutorial v1.1_011] Or a sub family](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_011/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_011~1..v1.1_011 ))
- [[tutorial v1.1_012] Putting a variable inside of a family or a sub family](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_012/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_012~1..v1.1_012 ))
# [tutorial v1.1_012)] Putting a variable inside of a family or a sub family
# [tutorial v1.1_020)] A variable with type "domainname"
[View the diff ](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_0 1 2~1..v1.1_01 2)
[View the diff ](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_0 20 ~1..v1.1_020 )
## Screenshot
## Screenshot
@ -29,7 +29,7 @@ pip install rougail-cli rougail-output-exporter rougail-output-doc rougail-user-
Then switch to the tutorial page:
Then switch to the tutorial page:
```shell
```shell
git switch --detach v1.1_01 2
git switch --detach v1.1_020
```
```
## Structure
## Structure
@ -37,10 +37,10 @@ git switch --detach v1.1_012
< p >
< p >
< a href = "https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_0 1 2/./"> .< / a > < br / >
< a href = "https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_0 20 /./"> .< / a > < br / >
└── < a href = "https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_0 1 2/./firefox/"> firefox< / a > < br / >
└── < a href = "https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_0 20 /./firefox/"> firefox< / a > < br / >
├── < a href = "https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_0 1 2/./firefox/00-proxy.yml"> 00-proxy.yml< / a > < br / >
├── < a href = "https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_0 20 /./firefox/00-proxy.yml"> 00-proxy.yml< / a > < br / >
└── < a href = "https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_0 1 2/./firefox/10-manual.yml"> 10-manual.yml< / a > < br / >
└── < a href = "https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_0 20 /./firefox/10-manual.yml"> 10-manual.yml< / a > < br / >
< br / > < br / > < / p >
< br / > < br / > < / p >
Contents of the firefox/10-manual.yml file
Contents of the firefox/10-manual.yml file
@ -54,7 +54,9 @@ manual: # Manual proxy configuration
http_proxy: # HTTP Proxy
http_proxy: # HTTP Proxy
address: # HTTP address
address:
description: HTTP address
type: domainname
...
...
```
```
@ -79,20 +81,20 @@ rougail -m firefox/ -o doc
| Variable | Description |
| Variable | Description |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |------------------------ ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **manual.http_proxy.address** < br /> [`string `](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTP address. |
| **manual.http_proxy.address** < br /> [`domainname `](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTP address. |
### Let's generate the changelog
### Let's generate the changelog
```shell
```shell
rougail -m firefox/ -o doc --doc.contents changelog
rougail -m firefox/ -o doc --doc.contents changelog
```
```
#### New variable
#### Modified variable
| Variable | Description |
| Variable | Description |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |------------------------------------------------------------------------------------------------------------------------------------------------------------------------ ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **manual.http_proxy.address** < br /> [`string`]( https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTP address. |
| **manual.http_proxy.address** < br /> ~~`string`~~ [<ins>`domainname`</ins> ]( https://rougail.readthedocs.io/en/latest/variable.html#variables-types ) `mandatory` | HTTP address. |
## User datas
## User datas
@ -104,17 +106,24 @@ rougail -m firefox/ -o doc --doc.contents changelog
```yml
```yml
---
---
manual:
http_proxy:
address: example.net
```
```
#### Output
#### Output
```shell
```shell
rougail -m firefox/ -u yaml -yf config/01/config.yml
rougail -m firefox/ -u yaml -yf config/01/config.yml
```
```
< pre >< span style = "font-weight: bold; color: #ff0000 " > 🛑 ERRORS</ span >
< pre > ╭──────── Caption ────────╮
< span style = "color: #ff0000 " > ┗━━ </ span > The following variables are mandatory but have no value:
│ Variable < span style = "color: #ffd700 " > Default value</ span > │
< span style = "color: #ff0000 " > </ span >< span style = "color: #ff0000 " > ┗━━ </ span > Manual proxy configuration
│ Modified value │
< span style = "color: #ff0000 " > </ span >< span style = "color: #ff0000 " > </ span >< span style = "color: #ff0000 " > ┗━━ </ span > HTTP Proxy
╰─────────────────────────╯
< span style = "color: #ff0000 " > </ span >< span style = "color: #ff0000 " > </ span >< span style = "color: #ff0000 " > </ span >< span style = "color: #ff0000 " > ┗━━ </ span > HTTP address
Variables:
< span style = "color: #5c5cff " > ┣━━ </ span > 📓 Configure Proxy Access to the Internet: < span style = "color: #ffd700 " > No proxy</ span >
< span style = "color: #5c5cff " > ┗━━ </ span > 📂 Manual proxy configuration
< span style = "color: #5c5cff " > </ span >< span style = "color: #5c5cff " > ┗━━ </ span > 📂 HTTP Proxy
< span style = "color: #5c5cff " > </ span >< span style = "color: #5c5cff " > </ span >< span style = "color: #5c5cff " > ┗━━ </ span > 📓 HTTP address: example.net ◀ loaded from the YAML file "config/01/config.yml"
< / pre >
< / pre >
### Example 2
### Example 2
@ -125,22 +134,28 @@ rougail -m firefox/ -u yaml -yf config/01/config.yml
---
---
manual:
manual:
http_proxy:
http_proxy:
address: example.net
address: 192.168.0.1
```
```
#### Output
#### Output
```shell
```shell
rougail -m firefox/ -u yaml -yf config/02/config.yml
rougail -m firefox/ -u yaml -yf config/02/config.yml
```
```
< pre > ╭──────── Caption ────────╮
< pre >< span style = "font-weight: bold; color: #ffff00 " > 🔔 WARNINGS</ span >
│ Variable < span style = "color: #ffd700 " > Default value</ span > │
< span style = "color: #ffff00 " > ┗━━ </ span > the value "192.168.0.1" is an invalid domain name for "manual.http_proxy.address" (HTTP address), must not be an IP, it will be ignored when loading from the YAML file "config/02/config.yml"
│ Modified value │
< span style = "font-weight: bold; color: #ff0000 " > 🛑 ERRORS</ span >
╰─────────────────────────╯
< span style = "color: #ff0000 " > ┗━━ </ span > The following variables are mandatory but have no value:
Variables:
< span style = "color: #ff0000 " > </ span >< span style = "color: #ff0000 " > ┗━━ </ span > Manual proxy configuration
< span style = "color: #5c5cff " > ┣━━ </ span > 📓 Configure Proxy Access to the Internet: < span style = "color: #ffd700 " > No proxy</ span >
< span style = "color: #ff0000 " > </ span >< span style = "color: #ff0000 " > </ span >< span style = "color: #ff0000 " > ┗━━ </ span > HTTP Proxy
< span style = "color: #5c5cff " > ┗━━ </ span > 📂 Manual proxy configuration
< span style = "color: #ff0000 " > </ span >< span style = "color: #ff0000 " > </ span >< span style = "color: #ff0000 " > </ span >< span style = "color: #ff0000 " > ┗━━ </ span > HTTP address
< span style = "color: #5c5cff " > </ span >< span style = "color: #5c5cff " > ┗━━ </ span > 📂 HTTP Proxy
< / pre >
< span style = "color: #5c5cff " > </ span >< span style = "color: #5c5cff " > </ span >< span style = "color: #5c5cff " > ┗━━ </ span > 📓 HTTP address: example.net ◀ loaded from the YAML file "config/02/config.yml"
#### Output when invalid user datas is an error
```shell
rougail -m firefox/ -u yaml -yf config/02/config.yml --cli.invalid_user_datas_error
```
< pre >< span style = "font-weight: bold; color: #ff0000 " > 🛑 ERRORS</ span >
< span style = "color: #ff0000 " > ┗━━ </ span > the value "192.168.0.1" is an invalid domain name for "manual.http_proxy.address" (HTTP address), must not be an IP, it will be ignored when loading from the YAML file "config/02/config.yml"
< / pre >
< / pre >
### Example 3
### Example 3
@ -151,8 +166,7 @@ Variables:
---
---
manual:
manual:
http_proxy:
http_proxy:
address: example.net
address: not a valid domain name
port: 3128
```
```
#### Output
#### Output
@ -160,17 +174,21 @@ manual:
rougail -m firefox/ -u yaml -yf config/03/config.yml
rougail -m firefox/ -u yaml -yf config/03/config.yml
```
```
< pre >< span style = "font-weight: bold; color: #ffff00 " > 🔔 WARNINGS</ span >
< pre >< span style = "font-weight: bold; color: #ffff00 " > 🔔 WARNINGS</ span >
< span style = "color: #ffff00 " > ┗━━ </ span > variable or family "manual.http_proxy.port" does not exist, it will be ignored when loading from the YAML file "config/03/config.yml"
< span style = "color: #ffff00 " > ┗━━ </ span > the value "not a valid domain name" is an invalid domain name for "manual.http_proxy.address" (HTTP address), must have dot, it will be ignored when loading from the YAML file "config/03/config.yml"
╭──────── Caption ────────╮
< span style = "font-weight: bold; color: #ff0000 " > 🛑 ERRORS</ span >
│ Variable < span style = "color: #ffd700 " > Default value</ span > │
< span style = "color: #ff0000 " > ┗━━ </ span > The following variables are mandatory but have no value:
│ Modified value │
< span style = "color: #ff0000 " > </ span >< span style = "color: #ff0000 " > ┗━━ </ span > Manual proxy configuration
╰─────────────────────────╯
< span style = "color: #ff0000 " > </ span >< span style = "color: #ff0000 " > </ span >< span style = "color: #ff0000 " > ┗━━ </ span > HTTP Proxy
Variables:
< span style = "color: #ff0000 " > </ span >< span style = "color: #ff0000 " > </ span >< span style = "color: #ff0000 " > </ span >< span style = "color: #ff0000 " > ┗━━ </ span > HTTP address
< span style = "color: #5c5cff " > ┣━━ </ span > 📓 Configure Proxy Access to the Internet: < span style = "color: #ffd700 " > No proxy</ span >
< / pre >
< span style = "color: #5c5cff " > ┗━━ </ span > 📂 Manual proxy configuration
#### Output when invalid user datas is an error
< span style = "color: #5c5cff " > </ span >< span style = "color: #5c5cff " > ┗━━ </ span > 📂 HTTP Proxy
< span style = "color: #5c5cff " > </ span >< span style = "color: #5c5cff " > </ span >< span style = "color: #5c5cff " > ┗━━ </ span > 📓 HTTP address: example.net ◀ loaded from the YAML file "config/03/config.yml"
```shell
rougail -m firefox/ -u yaml -yf config/03/config.yml --cli.invalid_user_datas_error
```
< pre >< span style = "font-weight: bold; color: #ff0000 " > 🛑 ERRORS</ span >
< span style = "color: #ff0000 " > ┗━━ </ span > the value "not a valid domain name" is an invalid domain name for "manual.http_proxy.address" (HTTP address), must have dot, it will be ignored when loading from the YAML file "config/03/config.yml"
< / pre >
< / pre >
- [[tutorial v1.1_020] A variable with type "domainname"](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_020/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_020~1..v1.1_020))
- [[tutorial v1.1_021] A variable with type's parameters](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_021/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_021~1..v1.1_021 ))