diff --git a/README.md b/README.md
index aa69785..07ff6d1 100644
--- a/README.md
+++ b/README.md
@@ -1,11 +1,11 @@
- [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_030~1..v1.1_030)
+[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_031~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
@@ -31,7 +31,7 @@ pip install rougail-cli rougail-output-exporter rougail-output-doc rougail-user-
Then switch to the tutorial page:
```shell
-git switch --detach v1.1_030
+git switch --detach v1.1_031
```
## Structure
@@ -39,10 +39,10 @@ git switch --detach v1.1_030
-.
- └── firefox
- ├── 00-proxy.yml
- └── 10-manual.yml
+.
+ └── firefox
+ ├── 00-proxy.yml
+ └── 10-manual.yml
Contents of the firefox/10-manual.yml file
@@ -59,6 +59,8 @@ manual: # Manual proxy configuration
address:
description: HTTP address
type: domainname
+ params:
+ allow_ip: true
...
```
@@ -83,9 +85,9 @@ rougail -m firefox/ -o doc
>
> **Path**: manual.http_proxy
-| Variable | Description |
-|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------|
-| **manual.http_proxy.address**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTP address.
**Validator**: type domainname |
+| Variable | Description |
+|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------|
+| **manual.http_proxy.address**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTP address.
**Validators**:
• type domainname
• the domain name can be an IP |
### Let's generate the changelog
@@ -94,9 +96,9 @@ rougail -m firefox/ -o doc --doc.contents changelog
```
#### Modified variable
-| Variable | Description |
-|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------|
-| **manual.http_proxy.address**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTP address.
**Validator**: type domainname |
+| Variable | Description |
+|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------|
+| **manual.http_proxy.address**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTP address.
**Validators**:
• type domainname
• the domain name can be an IP |
## User datas
@@ -145,23 +147,35 @@ manual:
```shell
rougail -m firefox/ -u yaml -yf config/02/config.yml
```
-> [!CAUTION]
->
-> - manual (Manual proxy configuration)
-> - http_proxy (HTTP Proxy)
-> - address (HTTP address)
-> - [#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"[/#EFBF04]
-> - [#C23636]:stop_sign: mandatory variable but has no value[/#C23636]
+> [!NOTE]
+>
+> **Caption:**
+> - Variable
+> - Default value
+> - Modified value
+
+Variables:
+- :notebook: proxy_mode (Configure Proxy Access to the Internet): No proxy
+- :open_file_folder: manual (Manual proxy configuration)
+ - :open_file_folder: http_proxy (HTTP Proxy)
+ - :notebook: address (HTTP address): 192.168.0.1 ← 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_data_error
```
-> [!CAUTION]
->
-> - manual (Manual proxy configuration)
-> - http_proxy (HTTP Proxy)
-> - address (HTTP address): :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"
+> [!NOTE]
+>
+> **Caption:**
+> - Variable
+> - Default value
+> - Modified value
+
+Variables:
+- :notebook: proxy_mode (Configure Proxy Access to the Internet): No proxy
+- :open_file_folder: manual (Manual proxy configuration)
+ - :open_file_folder: http_proxy (HTTP Proxy)
+ - :notebook: address (HTTP address): 192.168.0.1 ← loaded from the YAML file "config/02/config.yml"
### Example 3
#### config/03/config.yml
@@ -183,7 +197,7 @@ rougail -m firefox/ -u yaml -yf config/03/config.yml
> - manual (Manual proxy configuration)
> - http_proxy (HTTP Proxy)
> - address (HTTP address)
-> - [#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"[/#EFBF04]
+> - [#EFBF04]:bell: the value "not a valid domain name.com" is an invalid domain name, could be a IP, otherwise 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"[/#EFBF04]
> - [#C23636]:stop_sign: mandatory variable but has no value[/#C23636]
#### Output when invalid user datas is an error
@@ -194,7 +208,7 @@ rougail -m firefox/ -u yaml -yf config/03/config.yml --cli.invalid_user_data_err
>
> - manual (Manual proxy configuration)
> - http_proxy (HTTP Proxy)
-> - address (HTTP address): :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"
+> - address (HTTP address): :stop_sign: the value "not a valid domain name.com" is an invalid domain name, could be a IP, otherwise 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"
-- [[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))
+- [[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))
diff --git a/config/02/output_invalid.html b/config/02/output_invalid.html
index a675650..dca02a3 100644
--- a/config/02/output_invalid.html
+++ b/config/02/output_invalid.html
@@ -1,7 +1,11 @@
-🛑 Caution
-┗━━ manual (Manual proxy configuration)
- ┗━━ http_proxy (HTTP Proxy)
- ┗━━ address (HTTP address): 🛑 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"
+╭──────── Caption ────────╮
+│ Variable Default value │
+│ Modified value │
+╰─────────────────────────╯
+Variables:
+┣━━ 📓 proxy_mode (Configure Proxy Access to the Internet): No proxy
+┗━━ 📂 manual (Manual proxy configuration)
+ ┗━━ 📂 http_proxy (HTTP Proxy)
+ ┗━━ 📓 address (HTTP address): 192.168.0.1 ◀ loaded from the YAML file
+ "config/02/config.yml"
diff --git a/config/02/output_ro.html b/config/02/output_ro.html
index 62370be..dca02a3 100644
--- a/config/02/output_ro.html
+++ b/config/02/output_ro.html
@@ -1,9 +1,11 @@
-🛑 Caution
-┗━━ manual (Manual proxy configuration)
- ┗━━ http_proxy (HTTP Proxy)
- ┗━━ address (HTTP address)
- ┣━━ 🔔 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"
- ┗━━ 🛑 mandatory variable but has no value
+╭──────── Caption ────────╮
+│ Variable Default value │
+│ Modified value │
+╰─────────────────────────╯
+Variables:
+┣━━ 📓 proxy_mode (Configure Proxy Access to the Internet): No proxy
+┗━━ 📂 manual (Manual proxy configuration)
+ ┗━━ 📂 http_proxy (HTTP Proxy)
+ ┗━━ 📓 address (HTTP address): 192.168.0.1 ◀ loaded from the YAML file
+ "config/02/config.yml"
diff --git a/config/03/output_invalid.html b/config/03/output_invalid.html
index 1577759..b6c5a3d 100644
--- a/config/03/output_invalid.html
+++ b/config/03/output_invalid.html
@@ -2,8 +2,8 @@
┗━━ manual (Manual proxy configuration)
┗━━ http_proxy (HTTP Proxy)
┗━━ address (HTTP address): 🛑 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"
+ is an invalid domain name, could be a IP, otherwise 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"
diff --git a/config/03/output_ro.html b/config/03/output_ro.html
index 10189d0..b02c473 100644
--- a/config/03/output_ro.html
+++ b/config/03/output_ro.html
@@ -3,9 +3,9 @@
┗━━ http_proxy (HTTP Proxy)
┗━━ address (HTTP address)
┣━━ 🔔 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"
+ ┃ name, could be a IP, otherwise 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"
┗━━ 🛑 mandatory variable but has no value
diff --git a/tree.html b/tree.html
index bbe62fa..4af3212 100644
--- a/tree.html
+++ b/tree.html
@@ -1,6 +1,6 @@
-.
- └── firefox
- ├── 00-proxy.yml
- └── 10-manual.yml
+.
+ └── firefox
+ ├── 00-proxy.yml
+ └── 10-manual.yml
\ No newline at end of file