@ -1,11 +1,11 @@
- [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_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_022~1..v1.1_022 ))
- [[tutorial v1.1_030] A variable with type "domainname"](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_030/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"
# [tutorial v1.1_031)] A variable with type's parameters
[View the diff ](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_03 0~1..v1.1_030 )
[View the diff ](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_03 1~1..v1.1_031 )
[Read the documentation ](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/disabled.html#a-variable-with-type -"domainname" )
[Read the documentation ](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/disabled.html#a-variable-with-type 's-parameters )
## Screenshot
## Screenshot
@ -31,7 +31,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_030
git switch --detach v1.1_031
```
```
## Structure
## Structure
@ -39,10 +39,10 @@ git switch --detach v1.1_030
< p >
< p >
< a href = "https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_03 0 /./"> .< / a > < br / >
< a href = "https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_03 1 /./"> .< / a > < br / >
└── < a href = "https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_03 0 /./firefox/"> firefox< / a > < br / >
└── < a href = "https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_03 1 /./firefox/"> firefox< / a > < br / >
├── < a href = "https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_03 0 /./firefox/00-proxy.yml"> 00-proxy.yml< / a > < br / >
├── < a href = "https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_03 1 /./firefox/00-proxy.yml"> 00-proxy.yml< / a > < br / >
└── < a href = "https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_03 0 /./firefox/10-manual.yml"> 10-manual.yml< / a > < br / >
└── < a href = "https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_03 1 /./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
@ -59,6 +59,8 @@ manual: # Manual proxy configuration
address:
address:
description: HTTP address
description: HTTP address
type: domainname
type: domainname
params:
allow_ip: true
...
...
```
```
@ -85,7 +87,7 @@ rougail -m firefox/ -o doc
| Variable | Description |
| Variable | Description |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **manual.http_proxy.address** < br /> [`domainname`](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.< br /> **Validator**: the domain name can be an IP |
### Let's generate the changelog
### Let's generate the changelog
@ -94,111 +96,11 @@ rougail -m firefox/ -o doc --doc.contents changelog
```
```
#### Modified variable
#### Modified variable
| Variable | Description |
| Variable | Description |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |------------------------------------------------------------------------------------------------------------------------------------------------ ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **manual.http_proxy.address** < br /> ~~`string`~~ [<ins> `domainname`</ins> ]( 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.< br /> **Validator**: < ins > the domain name can be an IP</ ins > |
## User datas
### Example 1
#### config/01/config.yml
```yml
- [[tutorial v1.1_032] A variable with type "port"](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_032/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_032~1..v1.1_032))
---
manual:
http_proxy:
address: example.net
```
#### Output
```shell
rougail -m firefox/ -u yaml -yf config/01/config.yml
```
< pre > ╭──────── Caption ────────╮
│ Variable < span style = "color: #ffd700 " > Default value</ span > │
│ Modified value │
╰─────────────────────────╯
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 >
### 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
```
< pre >< span style = "font-weight: bold; color: #ffff00 " > 🔔 WARNINGS</ 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"
< span style = "font-weight: bold; color: #ff0000 " > 🛑 ERRORS</ span >
< span style = "color: #ff0000 " > ┗━━ </ span > The following variables are mandatory but have no 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
< span style = "color: #ff0000 " > </ span >< span style = "color: #ff0000 " > </ span >< span style = "color: #ff0000 " > </ span >< span style = "color: #ff0000 " > ┗━━ </ span > HTTP address
< / pre >
#### 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"
< span style = "color: #ff0000 " > ┗━━ </ span > The following variables are mandatory but have no 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
< span style = "color: #ff0000 " > </ span >< span style = "color: #ff0000 " > </ span >< span style = "color: #ff0000 " > </ span >< span style = "color: #ff0000 " > ┗━━ </ span > HTTP address
< / pre >
### Example 3
#### config/03/config.yml
```yml
---
manual:
http_proxy:
address: not a valid domain name
```
#### Output
```shell
rougail -m firefox/ -u yaml -yf config/03/config.yml
```
< pre >< span style = "font-weight: bold; color: #ffff00 " > 🔔 WARNINGS</ span >
< 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"
< span style = "font-weight: bold; color: #ff0000 " > 🛑 ERRORS</ span >
< span style = "color: #ff0000 " > ┗━━ </ span > The following variables are mandatory but have no 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
< span style = "color: #ff0000 " > </ span >< span style = "color: #ff0000 " > </ span >< span style = "color: #ff0000 " > </ span >< span style = "color: #ff0000 " > ┗━━ </ span > HTTP address
< / pre >
#### Output when invalid user datas is an error
```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"
< span style = "color: #ff0000 " > ┗━━ </ span > The following variables are mandatory but have no 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
< span style = "color: #ff0000 " > </ span >< span style = "color: #ff0000 " > </ span >< span style = "color: #ff0000 " > </ span >< span style = "color: #ff0000 " > ┗━━ </ span > HTTP address
< / pre >
- [[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))