diff --git a/README.md b/README.md index 39ad96f7..7ae22db6 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_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_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_020)] A variable with type "domainname" +# [tutorial v1.1_021)] A variable with type's parameters -[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_020~1..v1.1_020) +[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_021~1..v1.1_021) ## Screenshot @@ -29,7 +29,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_020 +git switch --detach v1.1_021 ``` ## Structure @@ -37,10 +37,10 @@ git switch --detach v1.1_020

-.
- └── firefox
-     ├── 00-proxy.yml
-     └── 10-manual.yml
+.
+ └── firefox
+     ├── 00-proxy.yml
+     └── 10-manual.yml


Contents of the firefox/10-manual.yml file @@ -57,6 +57,8 @@ manual: # Manual proxy configuration address: description: HTTP address type: domainname + params: + allow_ip: true ... ``` @@ -83,7 +85,7 @@ rougail -m firefox/ -o doc | Variable                                                                                            | Description                                                                                         | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **manual.http_proxy.address**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTP address. | +| **manual.http_proxy.address**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTP address.
**Validator**: the domain name can be an IP | ### Let's generate the changelog @@ -92,9 +94,9 @@ rougail -m firefox/ -o doc --doc.contents changelog ``` #### Modified variable -| Variable                                                                                                                    | Description                                                                                                                 | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **manual.http_proxy.address**
~~`string`~~ [`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTP address. | +| Variable                                                                                            | Description                                                                                         | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **manual.http_proxy.address**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTP address.
**Validator**: the domain name can be an IP | ## User datas @@ -141,21 +143,30 @@ manual: ```shell rougail -m firefox/ -u yaml -yf config/02/config.yml ``` -
🔔 WARNINGS
-┗━━ 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"
-🛑 ERRORS
-┗━━ The following variables are mandatory but have no value:
-    ┗━━ Manual proxy configuration
-        ┗━━ HTTP Proxy
-            ┗━━ HTTP address
+
╭──────── Caption ────────╮
+│ Variable Default value  │
+│          Modified value │
+╰─────────────────────────╯
+Variables:
+┣━━ 📓 Configure Proxy Access to the Internet: No proxy
+┗━━ 📂 Manual proxy configuration
+    ┗━━ 📂 HTTP Proxy
+        ┗━━ 📓 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_datas_error
 ```
-
🛑 ERRORS
-┗━━ 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"
+
╭──────── Caption ────────╮
+│ Variable Default value  │
+│          Modified value │
+╰─────────────────────────╯
+Variables:
+┣━━ 📓 Configure Proxy Access to the Internet: No proxy
+┗━━ 📂 Manual proxy configuration
+    ┗━━ 📂 HTTP Proxy
+        ┗━━ 📓 HTTP address: 192.168.0.1 ◀ loaded from the YAML file "config/02/config.yml"
 

 ### Example 3
 
@@ -191,4 +202,4 @@ rougail -m firefox/ -u yaml -yf config/03/config.yml --cli.invalid_user_datas_er
 

 
 
-- [[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))
+- [[tutorial v1.1_022] A variable with type "port"](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))
diff --git a/config/02/output_invalid.html b/config/02/output_invalid.html
index 1522c120..2f748124 100644
--- a/config/02/output_invalid.html
+++ b/config/02/output_invalid.html
@@ -1,3 +1,10 @@
-
🛑 ERRORS
-┗━━ 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"
+
╭──────── Caption ────────╮
+│ Variable Default value  │
+│          Modified value │
+╰─────────────────────────╯
+Variables:
+┣━━ 📓 Configure Proxy Access to the Internet: No proxy
+┗━━ 📂 Manual proxy configuration
+    ┗━━ 📂 HTTP Proxy
+        ┗━━ 📓 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 7619b3bb..2f748124 100644
--- a/config/02/output_ro.html
+++ b/config/02/output_ro.html
@@ -1,8 +1,10 @@
-
🔔 WARNINGS
-┗━━ 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"
-🛑 ERRORS
-┗━━ The following variables are mandatory but have no value:
-    ┗━━ Manual proxy configuration
-        ┗━━ HTTP Proxy
-            ┗━━ HTTP address
+
╭──────── Caption ────────╮
+│ Variable Default value  │
+│          Modified value │
+╰─────────────────────────╯
+Variables:
+┣━━ 📓 Configure Proxy Access to the Internet: No proxy
+┗━━ 📂 Manual proxy configuration
+    ┗━━ 📂 HTTP Proxy
+        ┗━━ 📓 HTTP address: 192.168.0.1 ◀ loaded from the YAML file "config/02/config.yml"
 

diff --git a/tree.html b/tree.html
index a20586c6..ecb6b46e 100644
--- a/tree.html
+++ b/tree.html
@@ -25,10 +25,10 @@
 
 
 	
Directory Tree

-	.

-	└── firefox

-	    ├── 00-proxy.yml

-	    └── 10-manual.yml

+	.

+	└── firefox

+	    ├── 00-proxy.yml

+	    └── 10-manual.yml

 


 
 2 directories, 2 files