diff --git a/CHANGELOG.md b/CHANGELOG.md
index 8d5b4b4a..9252b305 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,5 +1,5 @@
# Modified variable
-| Variable | Description |
-|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------|
-| **manual.http_proxy.address**
~~`string`~~ [`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 |
diff --git a/DOCUMENTATION.md b/DOCUMENTATION.md
index 0177d492..bfd76032 100644
--- a/DOCUMENTATION.md
+++ b/DOCUMENTATION.md
@@ -14,6 +14,6 @@
>
> **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 |
diff --git a/README.md b/README.md
index a8ffeb8d..62eb4c0e 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,9 @@
- [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"](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_031~1..v1.1_031))
-# [tutorial v1.1_030] A variable with type "domainname"
+# [tutorial v1.1_031] A variable with type’s parameters
-[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)
+[Read the tutorial "A variable with type’s parameters" in the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/types.html#a-variable-with-type-s-parameters)
## Screenshot
@@ -25,16 +25,16 @@ 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
-.
- └── firefox
- ├── 00-proxy.yml
- └── 10-manual.yml
+.
+ └── firefox
+ ├── 00-proxy.yml
+ └── 10-manual.yml
Contents of the firefox/10-manual.yml file
@@ -51,6 +51,8 @@ manual: # Manual proxy configuration
address:
description: HTTP address
type: domainname
+ params:
+ allow_ip: true
...
```
@@ -125,13 +127,18 @@ manual:
```shell
rougail -m firefox/ -u yaml -yf config/02/config.yml
```
-> [!CAUTION]
->
-> - manual (Manual proxy configuration)
-> - http_proxy (HTTP Proxy)
-> - address (HTTP address)
-> - :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"
-> - :stop_sign: mandatory variable but has no value
+> [!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 data is an error
@@ -139,13 +146,18 @@ rougail -m firefox/ -u yaml -yf config/02/config.yml
```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"
-> - :stop_sign: mandatory variable but has no value
+> [!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
@@ -171,7 +183,7 @@ rougail -m firefox/ -u yaml -yf config/03/config.yml
> - manual (Manual proxy configuration)
> - http_proxy (HTTP Proxy)
> - address (HTTP address)
-> - :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"
+> - :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"
> - :stop_sign: mandatory variable but has no value
***
@@ -185,10 +197,10 @@ 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"
+> - :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"
> - :stop_sign: mandatory variable but has no value
***
-- [[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 e998e31d..dca02a3a 100644
--- a/config/02/output_invalid.html
+++ b/config/02/output_invalid.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 has been 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/02/output_ro.html b/config/02/output_ro.html
index 62370be7..dca02a3a 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 b0b8e3bb..e3ef4da5 100644
--- a/config/03/output_invalid.html
+++ b/config/03/output_invalid.html
@@ -3,8 +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 has
- ┃ been 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 has been loading from the YAML file
+ ┃ "config/03/config.yml"
┗━━ 🛑 mandatory variable but has no value
diff --git a/config/03/output_ro.html b/config/03/output_ro.html
index 10189d01..b02c4736 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 bbe62faa..4af32127 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