[tutorial v1.1_052] A hidden family (config and doc)

2026-04-18 09:51:07 +02:00 · 2026-04-18 09:51:07 +02:00 · fecd6a7988
commit fecd6a7988
parent fff235e6c9
9 changed files with 156 additions and 58 deletions
--- 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_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_051~1..v1.1_051))
+- [[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_052~1..v1.1_052))

-# [tutorial v1.1_051] A conditional disabled family
+# [tutorial v1.1_052] A hidden family

-[Read the tutorial "A conditional disabled family" in the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/properties.html#a-conditional-disabled-family)
+[Read the tutorial "A hidden family" in the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/properties.html#a-hidden-family)


 ## Screenshot
@ -25,20 +25,20 @@ pip install rougail-cli rougail-output-exporter rougail-output-doc rougail-user-
 Then switch to the tutorial page:

 ```shell
-git switch --detach v1.1_051
+git switch --detach v1.1_052
 ```

 ## Structure

 <p>
-<a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_051/./">.</a><br/>
-	└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_051/./firefox/">firefox</a><br/>
-	    ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_051/./firefox/00-proxy.yml">00-proxy.yml</a><br/>
-	    ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_051/./firefox/10-manual.yml">10-manual.yml</a><br/>
-	    └── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_051/./firefox/20-manual.yml">20-manual.yml</a><br/>
+<a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_052/./">.</a><br/>
+	└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_052/./firefox/">firefox</a><br/>
+	    ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_052/./firefox/00-proxy.yml">00-proxy.yml</a><br/>
+	    ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_052/./firefox/10-manual.yml">10-manual.yml</a><br/>
+	    └── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_052/./firefox/20-manual.yml">20-manual.yml</a><br/>
 <br/><br/></p>

-Contents of the firefox/10-manual.yml file
+Contents of the firefox/20-manual.yml file

 ```yml
 %YAML 1.2
@ -46,36 +46,26 @@ Contents of the firefox/10-manual.yml file
 version: 1.1

 manual:
-  description: Manual proxy configuration
-  disabled:
-    variable: _.proxy_mode
-    when_not: Manual proxy configuration

-  http_proxy:  # HTTP Proxy
+  use_for_https: true  # Also use this proxy for HTTPS
+
+  https_proxy:
+    description: HTTPS Proxy
+    hidden: true

    address:
-      description: HTTP address
-      type: domainname
-      params:
-        allow_ip: true
+      description: HTTPS address
+      default:
+        variable: __.http_proxy.address

    port:
-      description: HTTP Port
-      type: port
-      default: 8080
+      description: HTTPS Port
+      default:
+        variable: __.http_proxy.port
 ...

 ```

-***
-### Let's generate the documentation
-
-```shell
-rougail -m firefox/ -o doc
-```
-[View the documentation file](DOCUMENTATION.md)
-
-
 ***
 ## User datas

@ -86,6 +76,14 @@ rougail -m firefox/ -o doc

 ```yml
 ---
+proxy_mode: Manual proxy configuration
+manual:
+  http_proxy:
+    address: http.proxy.net
+    port: 3128
+  use_for_https: false
+  https_proxy:
+    address: https.proxy.net
 ```

 ***
@ -94,14 +92,58 @@ rougail -m firefox/ -o doc
 ```shell
 rougail -m firefox/ -u yaml -yf config/01/config.yml
 ```
+> [!WARNING]
+> 
+> - manual (Manual proxy configuration)
+>   - https_proxy (HTTPS Proxy)
+>     - address (HTTPS address): :bell: <span style="color: #EFBF04">cannot modify the option "address" (HTTPS address) because is frozen, it will be ignored when loading from the YAML file "config/01/config.yml"</span>
+
 > [!NOTE]
 >
 > **Caption:**
 > - Variable
+> - <span style="color: #A52A2A">Unmodifiable variable</span>
 > - <span style="color: #B8860B">Default value</span>
+> - <span style="color: #006400">Modified value</span>
+> - (:hourglass_flowing_sand: Original default value)

 Variables:
- :notebook: proxy_mode (Configure Proxy Access to the Internet): <span style="color: #B8860B">No proxy</span>
+- :notebook: proxy_mode (Configure Proxy Access to the Internet): <span style="color: #006400">Manual proxy configuration</span> ← loaded from the YAML file "config/01/config.yml" (:hourglass_flowing_sand: No proxy)
+- :open_file_folder: manual (Manual proxy configuration)
+  - :open_file_folder: http_proxy (HTTP Proxy)
+    - :notebook: address (HTTP address): <span style="color: #006400">http.proxy.net</span> ← loaded from the YAML file "config/01/config.yml"
+    - :notebook: port (HTTP Port): <span style="color: #006400">3128</span> ← loaded from the YAML file "config/01/config.yml" (:hourglass_flowing_sand: 8080)
+  - :notebook: use_for_https (Also use this proxy for HTTPS): <span style="color: #006400">false</span> ← loaded from the YAML file "config/01/config.yml" (:hourglass_flowing_sand: true)
+  - :open_file_folder: <span style="color: #A52A2A">https_proxy (HTTPS Proxy)</span>
+    - :notebook: <span style="color: #A52A2A">address (HTTPS address)</span>: <span style="color: #B8860B">http.proxy.net</span>
+    - :notebook: <span style="color: #A52A2A">port (HTTPS Port)</span>: <span style="color: #B8860B">3128</span>
+
+***
+#### Output in read write mode
+
+```shell
+rougail -m firefox/ -u yaml -yf config/01/config.yml --cli.read_write
+```
+> [!WARNING]
+> 
+> - manual (Manual proxy configuration)
+>   - https_proxy (HTTPS Proxy)
+>     - address (HTTPS address): :bell: <span style="color: #EFBF04">cannot modify the option "address" (HTTPS address) because is frozen, it will be ignored when loading from the YAML file "config/01/config.yml"</span>
+
+> [!NOTE]
+>
+> **Caption:**
+> - Variable
+> - <span style="color: #006400">Modified value</span>
+> - (:hourglass_flowing_sand: Original default value)
+
+Variables:
+- :notebook: proxy_mode (Configure Proxy Access to the Internet): <span style="color: #006400">Manual proxy configuration</span> ← loaded from the YAML file "config/01/config.yml" (:hourglass_flowing_sand: No proxy)
+- :open_file_folder: manual (Manual proxy configuration)
+  - :open_file_folder: http_proxy (HTTP Proxy)
+    - :notebook: address (HTTP address): <span style="color: #006400">http.proxy.net</span> ← loaded from the YAML file "config/01/config.yml"
+    - :notebook: port (HTTP Port): <span style="color: #006400">3128</span> ← loaded from the YAML file "config/01/config.yml" (:hourglass_flowing_sand: 8080)
+  - :notebook: use_for_https (Also use this proxy for HTTPS): <span style="color: #006400">false</span> ← loaded from the YAML file "config/01/config.yml" (:hourglass_flowing_sand: true)

 ***
 ### Example 2
@ -116,7 +158,7 @@ manual:
  http_proxy:
    address: http.proxy.net
    port: 3128
-  use_for_https: false
+  use_for_https: true
 ```

 ***
@ -129,6 +171,7 @@ rougail -m firefox/ -u yaml -yf config/02/config.yml
 >
 > **Caption:**
 > - Variable
+> - <span style="color: #A52A2A">Unmodifiable variable</span>
 > - <span style="color: #B8860B">Default value</span>
 > - <span style="color: #006400">Modified value</span>
 > - (:hourglass_flowing_sand: Original default value)
@ -139,12 +182,12 @@ Variables:
  - :open_file_folder: http_proxy (HTTP Proxy)
    - :notebook: address (HTTP address): <span style="color: #006400">http.proxy.net</span> ← loaded from the YAML file "config/02/config.yml"
    - :notebook: port (HTTP Port): <span style="color: #006400">3128</span> ← loaded from the YAML file "config/02/config.yml" (:hourglass_flowing_sand: 8080)
-  - :notebook: use_for_https (Also use this proxy for HTTPS): <span style="color: #006400">false</span> ← loaded from the YAML file "config/02/config.yml" (:hourglass_flowing_sand: true)
-  - :open_file_folder: https_proxy (HTTPS Proxy)
-    - :notebook: address (HTTPS address): <span style="color: #B8860B">http.proxy.net</span>
-    - :notebook: port (HTTPS Port): <span style="color: #B8860B">3128</span>
+  - :notebook: use_for_https (Also use this proxy for HTTPS): <span style="color: #006400">true</span> ← loaded from the YAML file "config/02/config.yml" (:hourglass_flowing_sand: true)
+  - :open_file_folder: <span style="color: #A52A2A">https_proxy (HTTPS Proxy)</span>
+    - :notebook: <span style="color: #A52A2A">address (HTTPS address)</span>: <span style="color: #B8860B">http.proxy.net</span>
+    - :notebook: <span style="color: #A52A2A">port (HTTPS Port)</span>: <span style="color: #B8860B">3128</span>

 ***


- [[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_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))
--- a/config/01/cmd_rw.txt
+++ b/config/01/cmd_rw.txt
@ -0,0 +1 @@
+rougail -m firefox/ -u yaml -yf config/01/config.yml --cli.read_write
--- a/config/01/config.yml
+++ b/config/01/config.yml
@ -1 +1,9 @@
 ---
+proxy_mode: Manual proxy configuration
+manual:
+  http_proxy:
+    address: http.proxy.net
+    port: 3128
+  use_for_https: false
+  https_proxy:
+    address: https.proxy.net
--- a/config/01/output_ro.html
+++ b/config/01/output_ro.html
@ -1,6 +1,28 @@
-<pre>╭─────── Caption ────────╮
-│ Variable <span style="color: #ffd700">Default value</span> │
-╰────────────────────────╯
+<pre><span style="font-weight: bold; color: #ffff00">🔔 Warning</span>
+<span style="color: #ffff00">┗━━ </span>manual (Manual proxy configuration)
+<span style="color: #ffff00">    </span><span style="color: #ffff00">┗━━ </span>https_proxy (HTTPS Proxy)
+<span style="color: #ffff00">    </span><span style="color: #ffff00">    </span><span style="color: #ffff00">┗━━ </span>address (HTTPS address): <span style="color: #ffff00">🔔 cannot modify the option "address" </span>
+<span style="color: #ffff00">    </span><span style="color: #ffff00">    </span><span style="color: #ffff00">    </span><span style="color: #ffff00">(HTTPS address) because is frozen, it will be ignored when loading </span>
+<span style="color: #ffff00">    </span><span style="color: #ffff00">    </span><span style="color: #ffff00">    </span><span style="color: #ffff00">from the YAML file "config/01/config.yml"</span>
+
+╭───────────────────── Caption ─────────────────────╮
+│ Variable              <span style="color: #ffd700">Default value</span>               │
+│ <span style="color: #ffaf00">Unmodifiable variable</span> <span style="color: #00aa00">Modified value</span>              │
+│                       (⏳ Original default value) │
+╰───────────────────────────────────────────────────╯
 Variables:
-<span style="color: #5c5cff">┗━━ </span>📓 proxy_mode (Configure Proxy Access to the Internet): <span style="color: #ffd700">No proxy</span>
+<span style="color: #5c5cff">┣━━ </span>📓 proxy_mode (Configure Proxy Access to the Internet): <span style="color: #00aa00">Manual proxy </span>
+<span style="color: #5c5cff">┃   </span><span style="color: #00aa00">configuration</span> ◀ loaded from the YAML file "config/01/config.yml" (⏳ No 
+<span style="color: #5c5cff">┃   </span>proxy)
+<span style="color: #5c5cff">┗━━ </span>📂 manual (Manual proxy configuration)
+<span style="color: #5c5cff">    </span><span style="color: #5c5cff">┣━━ </span>📂 http_proxy (HTTP Proxy)
+<span style="color: #5c5cff">    </span><span style="color: #5c5cff">┃   </span><span style="color: #5c5cff">┣━━ </span>📓 address (HTTP address): <span style="color: #00aa00">http.proxy.net</span> ◀ loaded from the YAML 
+<span style="color: #5c5cff">    </span><span style="color: #5c5cff">┃   </span><span style="color: #5c5cff">┃   </span>file "config/01/config.yml"
+<span style="color: #5c5cff">    </span><span style="color: #5c5cff">┃   </span><span style="color: #5c5cff">┗━━ </span>📓 port (HTTP Port): <span style="color: #00aa00">3128</span> ◀ loaded from the YAML file 
+<span style="color: #5c5cff">    </span><span style="color: #5c5cff">┃   </span><span style="color: #5c5cff">    </span>"config/01/config.yml" (⏳ 8080)
+<span style="color: #5c5cff">    </span><span style="color: #5c5cff">┣━━ </span>📓 use_for_https (Also use this proxy for HTTPS): <span style="color: #00aa00">false</span> ◀ loaded from 
+<span style="color: #5c5cff">    </span><span style="color: #5c5cff">┃   </span>the YAML file "config/01/config.yml" (⏳ true)
+<span style="color: #5c5cff">    </span><span style="color: #5c5cff">┗━━ </span>📂 <span style="color: #ffaf00">https_proxy (HTTPS Proxy)</span>
+<span style="color: #5c5cff">    </span><span style="color: #5c5cff">    </span><span style="color: #5c5cff">┣━━ </span>📓 <span style="color: #ffaf00">address (HTTPS address)</span>: <span style="color: #ffd700">http.proxy.net</span>
+<span style="color: #5c5cff">    </span><span style="color: #5c5cff">    </span><span style="color: #5c5cff">┗━━ </span>📓 <span style="color: #ffaf00">port (HTTPS Port)</span>: <span style="color: #ffd700">3128</span>
 </pre>
--- a/config/01/output_rw.html
+++ b/config/01/output_rw.html
@ -0,0 +1,24 @@
+<pre><span style="font-weight: bold; color: #ffff00">🔔 Warning</span>
+<span style="color: #ffff00">┗━━ </span>manual (Manual proxy configuration)
+<span style="color: #ffff00">    </span><span style="color: #ffff00">┗━━ </span>https_proxy (HTTPS Proxy)
+<span style="color: #ffff00">    </span><span style="color: #ffff00">    </span><span style="color: #ffff00">┗━━ </span>address (HTTPS address): <span style="color: #ffff00">🔔 cannot modify the option "address" </span>
+<span style="color: #ffff00">    </span><span style="color: #ffff00">    </span><span style="color: #ffff00">    </span><span style="color: #ffff00">(HTTPS address) because is frozen, it will be ignored when loading </span>
+<span style="color: #ffff00">    </span><span style="color: #ffff00">    </span><span style="color: #ffff00">    </span><span style="color: #ffff00">from the YAML file "config/01/config.yml"</span>
+
+╭────────────── Caption ───────────────╮
+│ Variable <span style="color: #00aa00">Modified value</span>              │
+│          (⏳ Original default value) │
+╰──────────────────────────────────────╯
+Variables:
+<span style="color: #5c5cff">┣━━ </span>📓 proxy_mode (Configure Proxy Access to the Internet): <span style="color: #00aa00">Manual proxy </span>
+<span style="color: #5c5cff">┃   </span><span style="color: #00aa00">configuration</span> ◀ loaded from the YAML file "config/01/config.yml" (⏳ No 
+<span style="color: #5c5cff">┃   </span>proxy)
+<span style="color: #5c5cff">┗━━ </span>📂 manual (Manual proxy configuration)
+<span style="color: #5c5cff">    </span><span style="color: #5c5cff">┣━━ </span>📂 http_proxy (HTTP Proxy)
+<span style="color: #5c5cff">    </span><span style="color: #5c5cff">┃   </span><span style="color: #5c5cff">┣━━ </span>📓 address (HTTP address): <span style="color: #00aa00">http.proxy.net</span> ◀ loaded from the YAML 
+<span style="color: #5c5cff">    </span><span style="color: #5c5cff">┃   </span><span style="color: #5c5cff">┃   </span>file "config/01/config.yml"
+<span style="color: #5c5cff">    </span><span style="color: #5c5cff">┃   </span><span style="color: #5c5cff">┗━━ </span>📓 port (HTTP Port): <span style="color: #00aa00">3128</span> ◀ loaded from the YAML file 
+<span style="color: #5c5cff">    </span><span style="color: #5c5cff">┃   </span><span style="color: #5c5cff">    </span>"config/01/config.yml" (⏳ 8080)
+<span style="color: #5c5cff">    </span><span style="color: #5c5cff">┗━━ </span>📓 use_for_https (Also use this proxy for HTTPS): <span style="color: #00aa00">false</span> ◀ loaded from 
+<span style="color: #5c5cff">    </span><span style="color: #5c5cff">    </span>the YAML file "config/01/config.yml" (⏳ true)
+</pre>
--- a/config/02/config.yml
+++ b/config/02/config.yml
@ -4,4 +4,4 @@ manual:
  http_proxy:
    address: http.proxy.net
    port: 3128
-  use_for_https: false
+  use_for_https: true
--- a/config/02/output_ro.html
+++ b/config/02/output_ro.html
@ -1,8 +1,8 @@
-<pre>╭────────────── Caption ───────────────╮
-│ Variable <span style="color: #ffd700">Default value</span>               │
-│          <span style="color: #00aa00">Modified value</span>              │
-│          (⏳ Original default value) │
-╰──────────────────────────────────────╯
+<pre>╭───────────────────── Caption ─────────────────────╮
+│ Variable              <span style="color: #ffd700">Default value</span>               │
+│ <span style="color: #ffaf00">Unmodifiable variable</span> <span style="color: #00aa00">Modified value</span>              │
+│                       (⏳ Original default value) │
+╰───────────────────────────────────────────────────╯
 Variables:
 <span style="color: #5c5cff">┣━━ </span>📓 proxy_mode (Configure Proxy Access to the Internet): <span style="color: #00aa00">Manual proxy </span>
 <span style="color: #5c5cff">┃   </span><span style="color: #00aa00">configuration</span> ◀ loaded from the YAML file "config/02/config.yml" (⏳ No 
@ -13,9 +13,9 @@ Variables:
 <span style="color: #5c5cff">    </span><span style="color: #5c5cff">┃   </span><span style="color: #5c5cff">┃   </span>file "config/02/config.yml"
 <span style="color: #5c5cff">    </span><span style="color: #5c5cff">┃   </span><span style="color: #5c5cff">┗━━ </span>📓 port (HTTP Port): <span style="color: #00aa00">3128</span> ◀ loaded from the YAML file 
 <span style="color: #5c5cff">    </span><span style="color: #5c5cff">┃   </span><span style="color: #5c5cff">    </span>"config/02/config.yml" (⏳ 8080)
-<span style="color: #5c5cff">    </span><span style="color: #5c5cff">┣━━ </span>📓 use_for_https (Also use this proxy for HTTPS): <span style="color: #00aa00">false</span> ◀ loaded from 
-<span style="color: #5c5cff">    </span><span style="color: #5c5cff">┃   </span>the YAML file "config/02/config.yml" (⏳ true)
-<span style="color: #5c5cff">    </span><span style="color: #5c5cff">┗━━ </span>📂 https_proxy (HTTPS Proxy)
-<span style="color: #5c5cff">    </span><span style="color: #5c5cff">    </span><span style="color: #5c5cff">┣━━ </span>📓 address (HTTPS address): <span style="color: #ffd700">http.proxy.net</span>
-<span style="color: #5c5cff">    </span><span style="color: #5c5cff">    </span><span style="color: #5c5cff">┗━━ </span>📓 port (HTTPS Port): <span style="color: #ffd700">3128</span>
+<span style="color: #5c5cff">    </span><span style="color: #5c5cff">┣━━ </span>📓 use_for_https (Also use this proxy for HTTPS): <span style="color: #00aa00">true</span> ◀ loaded from the
+<span style="color: #5c5cff">    </span><span style="color: #5c5cff">┃   </span>YAML file "config/02/config.yml" (⏳ true)
+<span style="color: #5c5cff">    </span><span style="color: #5c5cff">┗━━ </span>📂 <span style="color: #ffaf00">https_proxy (HTTPS Proxy)</span>
+<span style="color: #5c5cff">    </span><span style="color: #5c5cff">    </span><span style="color: #5c5cff">┣━━ </span>📓 <span style="color: #ffaf00">address (HTTPS address)</span>: <span style="color: #ffd700">http.proxy.net</span>
+<span style="color: #5c5cff">    </span><span style="color: #5c5cff">    </span><span style="color: #5c5cff">┗━━ </span>📓 <span style="color: #ffaf00">port (HTTPS Port)</span>: <span style="color: #ffd700">3128</span>
 </pre>
--- a/firefox.png
+++ b/firefox.png
--- a/tree.html
+++ b/tree.html
@ -1,7 +1,7 @@
 <p>
-<a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_051/./">.</a><br/>
-	└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_051/./firefox/">firefox</a><br/>
-	    ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_051/./firefox/00-proxy.yml">00-proxy.yml</a><br/>
-	    ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_051/./firefox/10-manual.yml">10-manual.yml</a><br/>
-	    └── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_051/./firefox/20-manual.yml">20-manual.yml</a><br/>
+<a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_052/./">.</a><br/>
+	└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_052/./firefox/">firefox</a><br/>
+	    ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_052/./firefox/00-proxy.yml">00-proxy.yml</a><br/>
+	    ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_052/./firefox/10-manual.yml">10-manual.yml</a><br/>
+	    └── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_052/./firefox/20-manual.yml">20-manual.yml</a><br/>
 <br/><br/></p>
				`@ -0,0 +1 @@`
				`rougail -m firefox/ -u yaml -yf config/01/config.yml --cli.read_write`