From 8044d4d292073f25c164bfc96543d9b823fa47b1 Mon Sep 17 00:00:00 2001 From: Emmanuel Garette Date: Thu, 8 Jan 2026 20:22:27 +0100 Subject: [PATCH] [tutorial v1.1_051] A conditional disabled family (config and doc) --- README.md | 106 +++++++++++++++++++++------------- config/02/cmd_unknown.txt | 1 - config/02/output_ro.html | 38 ++++++------ config/02/output_unknown.html | 15 ----- config/02/unknown | 0 tree.html | 10 ++-- 6 files changed, 88 insertions(+), 82 deletions(-) delete mode 100644 config/02/cmd_unknown.txt delete mode 100644 config/02/output_unknown.html delete mode 100644 config/02/unknown diff --git a/README.md b/README.md index c1ad121..6afc579 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_041] A default value calculated from another variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_041/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_041~1..v1.1_041)) +- [[tutorial v1.1_050] A disabled family](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_050/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_050~1..v1.1_050)) -# [tutorial v1.1_050] A disabled family +# [tutorial v1.1_051] A conditional disabled family -[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_050~1..v1.1_050) +[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_051~1..v1.1_051) -[Read the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/disabled.html#a-disabled-family) +[Read the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/disabled.html#a-conditional-disabled-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_050 +git switch --detach v1.1_051 ``` ## Structure @@ -39,11 +39,11 @@ git switch --detach v1.1_050

-.
- └── 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 @@ -55,7 +55,9 @@ version: 1.1 manual: description: Manual proxy configuration - disabled: true + disabled: + variable: _.proxy_mode + when_not: Manual proxy configuration http_proxy: # HTTP Proxy @@ -83,6 +85,40 @@ 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 + +> [!NOTE] +> +> **Path**: manual\ +> *`disabled`*\ +> **Disabled**: when the variable "[Configure Proxy Access to the Internet](#proxy_mode)" hasn't the value "Manual proxy configuration" + +##### HTTP Proxy + +> [!NOTE] +> +> **Path**: manual.http_proxy + +| 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 | +| **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 | + +##### HTTPS Proxy + +> [!NOTE] +> +> **Path**: manual.https_proxy + +| 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 @@ -90,14 +126,17 @@ rougail -m firefox/ -o doc ```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.
**Validators**:
• type domainname
• 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.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.http_proxy.address -- manual.http_proxy.port -- manual.use_for_https -- manual.https_proxy.address -- manual.https_proxy.port *** ## User datas @@ -147,39 +186,26 @@ manual: ```shell rougail -m firefox/ -u yaml -yf config/02/config.yml ``` -> [!WARNING] -> -> - manual (Manual proxy configuration) -> - http_proxy (HTTP Proxy) -> - address (HTTP address): :bell: family "manual" (Manual proxy configuration) has property disabled, so cannot access to "address" (HTTP address), it will be ignored when loading from the YAML file "config/02/config.yml" -> - port (HTTP Port): :bell: family "manual" (Manual proxy configuration) has property disabled, so cannot access to "port" (HTTP Port), it will be ignored when loading from the YAML file "config/02/config.yml" -> - use_for_https (Also use this proxy for HTTPS): :bell: family "manual" (Manual proxy configuration) has property disabled, so cannot access to "use_for_https" (Also use this proxy for HTTPS), it will be ignored when loading from the YAML file "config/02/config.yml" - > [!NOTE] > > **Caption:** > - Variable +> - Default value > - Modified value > - (:hourglass_flowing_sand: Original default value) Variables: - :notebook: proxy_mode (Configure Proxy Access to the Internet): Manual proxy configuration ← loaded from the YAML file "config/02/config.yml" (:hourglass_flowing_sand: No proxy) - -*** -#### Output when unknown user data is an error - -```shell -rougail -m firefox/ -u yaml -yf config/02/config.yml --cli.unknown_user_data_error -``` -> [!CAUTION] -> -> - manual (Manual proxy configuration) -> - http_proxy (HTTP Proxy) -> - address (HTTP address): :stop_sign: family "manual" (Manual proxy configuration) has property disabled, so cannot access to "address" (HTTP address), it has been loading from the YAML file "config/02/config.yml" -> - port (HTTP Port): :stop_sign: family "manual" (Manual proxy configuration) has property disabled, so cannot access to "port" (HTTP Port), it has been loading from the YAML file "config/02/config.yml" -> - use_for_https (Also use this proxy for HTTPS): :stop_sign: family "manual" (Manual proxy configuration) has property disabled, so cannot access to "use_for_https" (Also use this proxy for HTTPS), it has been loading from the YAML file "config/02/config.yml" +- :open_file_folder: manual (Manual proxy configuration) + - :open_file_folder: http_proxy (HTTP Proxy) + - :notebook: address (HTTP address): http.proxy.net ← loaded from the YAML file "config/02/config.yml" + - :notebook: port (HTTP Port): 3128 ← loaded from the YAML file "config/02/config.yml" (:hourglass_flowing_sand: 8080) + - :notebook: use_for_https (Also use this proxy for HTTPS): false ← loaded from the YAML file "config/02/config.yml" (:hourglass_flowing_sand: true) + - :open_file_folder: https_proxy (HTTPS Proxy) + - :notebook: address (HTTPS address): http.proxy.net + - :notebook: port (HTTPS Port): 3128 *** -- [[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)) diff --git a/config/02/cmd_unknown.txt b/config/02/cmd_unknown.txt deleted file mode 100644 index e3d1320..0000000 --- a/config/02/cmd_unknown.txt +++ /dev/null @@ -1 +0,0 @@ -rougail -m firefox/ -u yaml -yf config/02/config.yml --cli.unknown_user_data_error \ No newline at end of file diff --git a/config/02/output_ro.html b/config/02/output_ro.html index 8a5e02b..21f864f 100644 --- a/config/02/output_ro.html +++ b/config/02/output_ro.html @@ -1,25 +1,21 @@ -
🔔 Warning
-┗━━ manual (Manual proxy configuration)
-    ┣━━ http_proxy (HTTP Proxy)
-    ┃   ┣━━ address (HTTP address): 🔔 family "manual" (Manual proxy 
-    ┃   ┃   configuration) has property disabled, so cannot access to "address" 
-    ┃   ┃   (HTTP address), it will be ignored when loading from the YAML file 
-    ┃   ┃   "config/02/config.yml"
-    ┃   ┗━━ port (HTTP Port): 🔔 family "manual" (Manual proxy configuration) 
-    ┃       has property disabled, so cannot access to "port" (HTTP Port), it 
-    ┃       will be ignored when loading from the YAML file 
-    ┃       "config/02/config.yml"
-    ┗━━ use_for_https (Also use this proxy for HTTPS): 🔔 family "manual" 
-        (Manual proxy configuration) has property disabled, so cannot access to 
-        "use_for_https" (Also use this proxy for HTTPS), it will be ignored when
-        loading from the YAML file "config/02/config.yml"
-
-╭────────────── Caption ───────────────╮
-│ Variable Modified value              │
+
╭────────────── Caption ───────────────╮
+│ Variable Default value               │
+│          Modified value              │
 │          (⏳ Original default value) │
 ╰──────────────────────────────────────╯
 Variables:
-┗━━ 📓 proxy_mode (Configure Proxy Access to the Internet): Manual proxy 
-    configuration ◀ loaded from the YAML file "config/02/config.yml" (⏳ No 
-    proxy)
+┣━━ 📓 proxy_mode (Configure Proxy Access to the Internet): Manual proxy 
+┃   configuration ◀ loaded from the YAML file "config/02/config.yml" (⏳ No 
+┃   proxy)
+┗━━ 📂 manual (Manual proxy configuration)
+    ┣━━ 📂 http_proxy (HTTP Proxy)
+    ┃   ┣━━ 📓 address (HTTP address): http.proxy.net ◀ loaded from the YAML 
+    ┃   ┃   file "config/02/config.yml"
+    ┃   ┗━━ 📓 port (HTTP Port): 3128 ◀ loaded from the YAML file 
+    ┃       "config/02/config.yml" (⏳ 8080)
+    ┣━━ 📓 use_for_https (Also use this proxy for HTTPS): false ◀ loaded from 
+    ┃   the YAML file "config/02/config.yml" (⏳ true)
+    ┗━━ 📂 https_proxy (HTTPS Proxy)
+        ┣━━ 📓 address (HTTPS address): http.proxy.net
+        ┗━━ 📓 port (HTTPS Port): 3128
 

diff --git a/config/02/output_unknown.html b/config/02/output_unknown.html
deleted file mode 100644
index f66d223..0000000
--- a/config/02/output_unknown.html
+++ /dev/null
@@ -1,15 +0,0 @@
-
🛑 Caution
-┗━━ manual (Manual proxy configuration)
-    ┣━━ http_proxy (HTTP Proxy)
-    ┃   ┣━━ address (HTTP address): 🛑 family "manual" (Manual proxy 
-    ┃   ┃   configuration) has property disabled, so cannot access to "address" 
-    ┃   ┃   (HTTP address), it has been loading from the YAML file 
-    ┃   ┃   "config/02/config.yml"
-    ┃   ┗━━ port (HTTP Port): 🛑 family "manual" (Manual proxy configuration) 
-    ┃       has property disabled, so cannot access to "port" (HTTP Port), it 
-    ┃       has been loading from the YAML file "config/02/config.yml"
-    ┗━━ use_for_https (Also use this proxy for HTTPS): 🛑 family "manual" 
-        (Manual proxy configuration) has property disabled, so cannot access to 
-        "use_for_https" (Also use this proxy for HTTPS), it has been loading 
-        from the YAML file "config/02/config.yml"
-

diff --git a/config/02/unknown b/config/02/unknown
deleted file mode 100644
index e69de29..0000000
diff --git a/tree.html b/tree.html
index 091ad53..ca90cc9 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