From 8d8fe3f587ac28b26811191a05ef022f0bd18911 Mon Sep 17 00:00:00 2001 From: Emmanuel Garette Date: Sun, 9 Nov 2025 19:31:15 +0100 Subject: [PATCH] [tutorial v1.1_031)] A conditional disabled family (config and doc) --- README.md | 71 ++++++++++++++++++++++++++++------------ config/02/output_ro.html | 13 ++++---- tree.html | 10 +++--- 3 files changed, 62 insertions(+), 32 deletions(-) diff --git a/README.md b/README.md index ce3ad6e7..ac00eee3 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_023] A variable with type "boolean"](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_023/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_023~1..v1.1_023)) +- [[tutorial v1.1_030] A disabled family](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 disabled family +# [tutorial v1.1_031)] A conditional disabled family -[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) ## 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_030 +git switch --detach v1.1_031 ``` ## Structure @@ -37,11 +37,11 @@ git switch --detach v1.1_030

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


Contents of the firefox/10-manual.yml file @@ -53,7 +53,9 @@ version: 1.1 manual: description: Manual proxy configuration - disabled: true + disabled: + variable: _.proxy_mode + when_not: Manual proxy configuration http_proxy: # HTTP Proxy @@ -79,17 +81,43 @@ rougail -m firefox/ -o doc |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **proxy_mode**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Configure Proxy Access to the Internet.
**Choices**:
- No proxy **← (default)**
- Auto-detect proxy settings for this network
- Use system proxy settings
- Manual proxy configuration
- Automatic proxy configuration URL | +#### Manual proxy configuration + +**manual** + +*`disabled`* + +**Disabled**: when the variable "proxy_mode" hasn't the value "Manual proxy configuration" + +##### HTTP Proxy + +**manual.http_proxy** + + + +| 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 | +| **manual.http_proxy.port**
[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTP Port.
**Validators**:
- well-known ports (1 to 1023) are allowed
- registred ports (1024 to 49151) are allowed
- private ports (greater than 49152) are allowed
**Default**: 8080 | + +| Variable                                                                                            | Description                                                                                         | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **manual.use_for_https**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Also use this proxy for HTTPS.
**Default**: true | + ### Let's generate the changelog ```shell rougail -m firefox/ -o doc --doc.contents changelog ``` -#### Deleted variables +#### New variables + +| 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 | +| **manual.http_proxy.port**
[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTP Port.
**Validators**:
- well-known ports (1 to 1023) are allowed
- registred ports (1024 to 49151) are allowed
- private ports (greater than 49152) are allowed
**Default**: 8080 | +| **manual.use_for_https**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Also use this proxy for HTTPS.
**Default**: true | -- manual.http_proxy.address -- manual.http_proxy.port -- manual.use_for_https ## User datas ### Example 1 @@ -130,17 +158,18 @@ manual: ```shell rougail -m firefox/ -u yaml -yf config/02/config.yml ``` -
🔔 WARNINGS
-┣━━ family "manual" (Manual proxy configuration) is disabled, "manual.http_proxy.address" (HTTP address) will be ignored when loading from the YAML file "config/02/config.yml"
-┣━━ family "manual" (Manual proxy configuration) is disabled, "manual.http_proxy.port" (HTTP Port) will be ignored when loading from the YAML file "config/02/config.yml"
-┗━━ family "manual" (Manual proxy configuration) is disabled, "manual.use_for_https" (Also use this proxy for HTTPS) will be ignored when loading from the YAML file "config/02/config.yml"
-╭────────────── Caption ───────────────╮
+
╭────────────── Caption ───────────────╮
 │ Variable Modified value              │
 │          (⏳ Original default value) │
 ╰──────────────────────────────────────╯
 Variables:
-┗━━ 📓 Configure Proxy Access to the Internet: Manual proxy configuration ◀ loaded from the YAML file "config/02/config.yml" (⏳ No proxy)
+┣━━ 📓 Configure Proxy Access to the Internet: Manual proxy configuration ◀ loaded from the YAML file "config/02/config.yml" (⏳ No proxy)
+┗━━ 📂 Manual proxy configuration
+    ┣━━ 📂 HTTP Proxy
+    ┃   ┣━━ 📓 HTTP address: http.proxy.net ◀ loaded from the YAML file "config/02/config.yml"
+    ┃   ┗━━ 📓 HTTP Port: 3128 ◀ loaded from the YAML file "config/02/config.yml" (⏳ 8080)
+    ┗━━ 📓 Also use this proxy for HTTPS: false ◀ loaded from the YAML file "config/02/config.yml" (⏳ true)
 

 
 
-- [[tutorial v1.1_031] A conditional disabled family](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] Copy HTTP manual proxy to HTTPS manual proxy](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_ro.html b/config/02/output_ro.html
index 003d5220..52b36002 100644
--- a/config/02/output_ro.html
+++ b/config/02/output_ro.html
@@ -1,11 +1,12 @@
-
🔔 WARNINGS
-┣━━ family "manual" (Manual proxy configuration) is disabled, "manual.http_proxy.address" (HTTP address) will be ignored when loading from the YAML file "config/02/config.yml"
-┣━━ family "manual" (Manual proxy configuration) is disabled, "manual.http_proxy.port" (HTTP Port) will be ignored when loading from the YAML file "config/02/config.yml"
-┗━━ family "manual" (Manual proxy configuration) is disabled, "manual.use_for_https" (Also use this proxy for HTTPS) will be ignored when loading from the YAML file "config/02/config.yml"
-╭────────────── Caption ───────────────╮
+
╭────────────── Caption ───────────────╮
 │ Variable Modified value              │
 │          (⏳ Original default value) │
 ╰──────────────────────────────────────╯
 Variables:
-┗━━ 📓 Configure Proxy Access to the Internet: Manual proxy configuration ◀ loaded from the YAML file "config/02/config.yml" (⏳ No proxy)
+┣━━ 📓 Configure Proxy Access to the Internet: Manual proxy configuration ◀ loaded from the YAML file "config/02/config.yml" (⏳ No proxy)
+┗━━ 📂 Manual proxy configuration
+    ┣━━ 📂 HTTP Proxy
+    ┃   ┣━━ 📓 HTTP address: http.proxy.net ◀ loaded from the YAML file "config/02/config.yml"
+    ┃   ┗━━ 📓 HTTP Port: 3128 ◀ loaded from the YAML file "config/02/config.yml" (⏳ 8080)
+    ┗━━ 📓 Also use this proxy for HTTPS: false ◀ loaded from the YAML file "config/02/config.yml" (⏳ true)
 

diff --git a/tree.html b/tree.html
index 1c2df933..2d49ce3d 100644
--- a/tree.html
+++ b/tree.html
@@ -25,11 +25,11 @@
 
 
 	
Directory Tree

-	.

-	└── firefox

-	    ├── 00-proxy.yml

-	    ├── 10-manual.yml

-	    └── 20-manual.yml

+	.

+	└── firefox

+	    ├── 00-proxy.yml

+	    ├── 10-manual.yml

+	    └── 20-manual.yml

 


 
 2 directories, 3 files