From 2a1172143a5320cc04ba2601e87cfb6168dd1127 Mon Sep 17 00:00:00 2001 From: Emmanuel Garette Date: Thu, 8 Jan 2026 20:22:31 +0100 Subject: [PATCH] [tutorial v1.1_053] A conditional hidden family (config and doc) --- README.md | 57 +++++++++++++++++++++++++--------------- config/01/output_ro.html | 21 +++++++-------- tree.html | 10 +++---- 3 files changed, 50 insertions(+), 38 deletions(-) diff --git a/README.md b/README.md index 5df0ccf..8113645 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_051] A conditional disabled family](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_051/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_051~1..v1.1_051)) +- [[tutorial v1.1_052] A hidden family](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_052/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_052~1..v1.1_052)) -# [tutorial v1.1_052] A hidden family +# [tutorial v1.1_053] A conditional hidden family -[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_052~1..v1.1_052) +[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_053~1..v1.1_053) -[Read the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/disabled.html#a-hidden-family) +[Read the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/disabled.html#a-conditional-hidden-family) ## 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_052 +git switch --detach v1.1_053 ``` ## Structure @@ -39,11 +39,11 @@ git switch --detach v1.1_052

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


Contents of the firefox/20-manual.yml file @@ -59,7 +59,8 @@ manual: https_proxy: description: HTTPS Proxy - hidden: true + hidden: + variable: _.use_for_https address: description: HTTPS address @@ -107,6 +108,19 @@ rougail -m firefox/ -o doc |-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------| | **manual.use_for_https**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Also use this proxy for HTTPS.
**Default**: true | +##### HTTPS Proxy + +> [!NOTE] +> +> **Path**: manual.https_proxy\ +> *`hidden`*\ +> **Hidden**: when the variable "[Also use this proxy for HTTPS](#manual.use_for_https)" has the value "true" + +| Variable | Description | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **manual.https_proxy.address**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTPS address.
**Validators**:
• type domainname
• the domain name can be an IP
**Default**: the value of the variable "[HTTP address](#manual.http_proxy.address)" | +| **manual.https_proxy.port**
[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTPS 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**: the value of the variable "[HTTP Port](#manual.http_proxy.port)" | + *** ### Let's generate the changelog @@ -114,11 +128,14 @@ rougail -m firefox/ -o doc ```shell rougail -m firefox/ -o doc --doc.contents changelog ``` -#### Deleted variables +#### New variables + +| Variable | Description | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **manual.https_proxy.address**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTPS address.
**Validators**:
• type domainname
• the domain name can be an IP
**Default**: the value of the variable "[HTTP address](#manual.http_proxy.address)" | +| **manual.https_proxy.port**
[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTPS 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**: the value of the variable "[HTTP Port](#manual.http_proxy.port)" | -- manual.https_proxy.address -- manual.https_proxy.port *** ## User datas @@ -145,16 +162,11 @@ manual: ```shell rougail -m firefox/ -u yaml -yf config/01/config.yml ``` -> [!WARNING] -> -> - manual (Manual proxy configuration) -> - https_proxy (HTTPS Proxy) -> - address (HTTPS address): :bell: family "https_proxy" (HTTPS Proxy) has property hidden, so cannot access to "address" (HTTPS address), it will be ignored when loading from the YAML file "config/01/config.yml" - > [!NOTE] > > **Caption:** > - Variable +> - Default value > - Modified value > - (:hourglass_flowing_sand: Original default value) @@ -165,6 +177,9 @@ Variables: - :notebook: address (HTTP address): http.proxy.net ← loaded from the YAML file "config/01/config.yml" - :notebook: port (HTTP Port): 3128 ← loaded from the YAML file "config/01/config.yml" (:hourglass_flowing_sand: 8080) - :notebook: use_for_https (Also use this proxy for HTTPS): false ← loaded from the YAML file "config/01/config.yml" (:hourglass_flowing_sand: true) + - :open_file_folder: https_proxy (HTTPS Proxy) + - :notebook: address (HTTPS address): https.proxy.net ← loaded from the YAML file "config/01/config.yml" (:hourglass_flowing_sand: http.proxy.net) + - :notebook: port (HTTPS Port): 3128 *** ### Example 2 @@ -206,4 +221,4 @@ Variables: *** -- [[tutorial v1.1_053] A conditional hidden family](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_053/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_053~1..v1.1_053)) +- [[tutorial v1.1_060] Family: a dynamic family](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_060/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_060~1..v1.1_060)) diff --git a/config/01/output_ro.html b/config/01/output_ro.html index 7c523a7..91925d4 100644 --- a/config/01/output_ro.html +++ b/config/01/output_ro.html @@ -1,13 +1,6 @@ -
🔔 Warning
-┗━━ manual (Manual proxy configuration)
-    ┗━━ https_proxy (HTTPS Proxy)
-        ┗━━ address (HTTPS address): 🔔 family "https_proxy" (HTTPS Proxy) has 
-            property hidden, so cannot access to "address" (HTTPS address), it 
-            will be ignored when loading from the YAML file 
-            "config/01/config.yml"
-
-╭────────────── Caption ───────────────╮
-│ Variable Modified value              │
+
╭────────────── Caption ───────────────╮
+│ Variable Default value               │
+│          Modified value              │
 │          (⏳ Original default value) │
 ╰──────────────────────────────────────╯
 Variables:
@@ -20,6 +13,10 @@ Variables:
     ┃   ┃   file "config/01/config.yml"
     ┃   ┗━━ 📓 port (HTTP Port): 3128 ◀ loaded from the YAML file 
     ┃       "config/01/config.yml" (⏳ 8080)
-    ┗━━ 📓 use_for_https (Also use this proxy for HTTPS): false ◀ loaded from 
-        the YAML file "config/01/config.yml" (⏳ true)
+    ┣━━ 📓 use_for_https (Also use this proxy for HTTPS): false ◀ loaded from 
+    ┃   the YAML file "config/01/config.yml" (⏳ true)
+    ┗━━ 📂 https_proxy (HTTPS Proxy)
+        ┣━━ 📓 address (HTTPS address): https.proxy.net ◀ loaded from the YAML 
+        ┃   file "config/01/config.yml" (⏳ http.proxy.net)
+        ┗━━ 📓 port (HTTPS Port): 3128
 

diff --git a/tree.html b/tree.html
index debd01e..2434d41 100644
--- a/tree.html
+++ b/tree.html
@@ -1,7 +1,7 @@
 

-.

-	└── firefox

-	    ├── 00-proxy.yml

-	    ├── 10-manual.yml

-	    └── 20-manual.yml

+.

+	└── firefox

+	    ├── 00-proxy.yml

+	    ├── 10-manual.yml

+	    └── 20-manual.yml

 


\ No newline at end of file