From 021d393364414c46ed68925db06d0acf7b892c83 Mon Sep 17 00:00:00 2001 From: Emmanuel Garette Date: Tue, 2 Dec 2025 16:18:31 +0100 Subject: [PATCH] [tutorial v1.1_031] A variable with type's parameters (config and doc) --- README.md | 67 ++++++++++++++++++++--------------- config/02/output_invalid.html | 14 +++++--- config/02/output_ro.html | 19 +++++----- tree.html | 8 ++--- 4 files changed, 62 insertions(+), 46 deletions(-) diff --git a/README.md b/README.md index cc4c0bbc..3b9040b7 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 @@ -144,25 +146,32 @@ 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  │
+│ Undocumented but modified variable 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  │
+│ Undocumented but modified variable 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
 
@@ -202,4 +211,4 @@ rougail -m firefox/ -u yaml -yf config/03/config.yml --cli.invalid_user_datas_er
 

 
 
-- [[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 abfe5f30..8723e89e 100644
--- a/config/02/output_invalid.html
+++ b/config/02/output_invalid.html
@@ -1,5 +1,11 @@
-
🛑 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  │
+│ Undocumented but modified variable 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 e1ccaa14..8723e89e 100644
--- a/config/02/output_ro.html
+++ b/config/02/output_ro.html
@@ -1,10 +1,11 @@
-
🔔 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  │
+│ Undocumented but modified variable 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 ad160607..f3ac9c54 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