[tutorial v1.1_040] A disabled family (config and doc)

2026-01-06 16:53:30 +01:00 · 2026-01-06 16:53:30 +01:00 · 5f4e3b5635
commit 5f4e3b5635
parent 44fde6fdb5
6 changed files with 75 additions and 87 deletions
--- 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_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))
+- [[tutorial v1.1_033] A variable with type "boolean"](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_033/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_033~1..v1.1_033))

-# [tutorial v1.1_033] A variable with type "boolean"
+# [tutorial v1.1_040] A disabled family

-[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_033~1..v1.1_033)
+[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_040~1..v1.1_040)

-[Read the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/disabled.html#a-variable-with-type-"boolean")
+[Read the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/disabled.html#a-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_033
+git switch --detach v1.1_040
 ```

 ## Structure
@ -39,14 +39,14 @@ git switch --detach v1.1_033


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

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

 ```yml
 %YAML 1.2
@ -54,8 +54,21 @@ Contents of the firefox/20-manual.yml file
 version: 1.1

 manual:
+  description: Manual proxy configuration
+  disabled: true

-  use_for_https: true  # Also use this proxy for HTTPS
+  http_proxy:  # HTTP Proxy
+
+    address:
+      description: HTTP address
+      type: domainname
+      params:
+        allow_ip: true
+
+    port:
+      description: HTTP Port
+      type: port
+      default: 8080
 ...

 ```
@ -68,39 +81,17 @@ rougail -m firefox/ -o doc
 |------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
 | **<a id="proxy_mode" name="proxy_mode">proxy_mode</a>**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Configure Proxy Access to the Internet.<br/>**Choices**: <br/>•&nbsp;No proxy **← (default)**<br/>•&nbsp;Auto-detect proxy settings for this network<br/>•&nbsp;Use system proxy settings<br/>•&nbsp;Manual proxy configuration<br/>•&nbsp;Automatic proxy configuration URL |

-#### Manual proxy configuration
-
-> [!NOTE]
-> 
-> **Path**: manual
-
-##### HTTP Proxy
-
-> [!NOTE]
-> 
-> **Path**: manual.http_proxy
-
-| Variable                                                                                                                                                                                                    | Description                                                                                                                                                                                                                |
-|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| **<a id="manual.http_proxy.address" name="manual.http_proxy.address">manual.http_proxy.address</a>**<br/>[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTP address.<br/>**Validators**: <br/>•&nbsp;type domainname<br/>•&nbsp;the domain name can be an IP                                                                                                                      |
-| **<a id="manual.http_proxy.port" name="manual.http_proxy.port">manual.http_proxy.port</a>**<br/>[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory`                | HTTP Port.<br/>**Validators**: <br/>•&nbsp;well-known ports (1 to 1023) are allowed<br/>•&nbsp;registred ports (1024 to 49151) are allowed<br/>•&nbsp;private ports (greater than 49152) are allowed<br/>**Default**: 8080 |
-
-| Variable                                                                                                                                                                                  | Description                                          |
-|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------|
-| **<a id="manual.use_for_https" name="manual.use_for_https">manual.use_for_https</a>**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Also use this proxy for HTTPS.<br/>**Default**: true |
-
 ### Let's generate the changelog

 ```shell
 rougail -m firefox/ -o doc --doc.contents changelog
 ```
-#### New variable
-
-| Variable                                                                                                                                                                                  | Description                                          |
-|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------|
-| **<a id="manual.use_for_https" name="manual.use_for_https">manual.use_for_https</a>**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Also use this proxy for HTTPS.<br/>**Default**: true |
+#### Deleted variables


+- manual.http_proxy.address
+- manual.http_proxy.port
+- manual.use_for_https
 ## User datas

 ### Example 1
@ -110,9 +101,6 @@ rougail -m firefox/ -o doc --doc.contents changelog

 ```yml
 ---
-manual:
-  http_proxy:
-    address: example.net
 ```
 #### Output

@ -124,15 +112,9 @@ rougail -m firefox/ -u yaml -yf config/01/config.yml
 > **Caption:**
 > - Variable
 > - <span style="color: #B8860B">Default value</span>
-> - <span style="color: #006400">Modified value</span>

 Variables:
 - :notebook: proxy_mode (Configure Proxy Access to the Internet): <span style="color: #B8860B">No proxy</span>
- :open_file_folder: manual (Manual proxy configuration)
-  - :open_file_folder: http_proxy (HTTP Proxy)
-    - :notebook: address (HTTP address): <span style="color: #006400">example.net</span> ← loaded from the YAML file "config/01/config.yml"
-    - :notebook: port (HTTP Port): <span style="color: #B8860B">8080</span>
-  - :notebook: use_for_https (Also use this proxy for HTTPS): <span style="color: #B8860B">true</span>
 ### Example 2

 #### config/02/config.yml
@ -140,9 +122,11 @@ Variables:

 ```yml
 ---
+proxy_mode: Manual proxy configuration
 manual:
  http_proxy:
-    address: example.net
+    address: http.proxy.net
+    port: 3128
  use_for_https: false
 ```
 #### Output
@ -150,21 +134,23 @@ 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: <span style="color: #EFBF04">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"</span>
+>     - port (HTTP Port): :bell: <span style="color: #EFBF04">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"</span>
+>   - use_for_https (Also use this proxy for HTTPS): :bell: <span style="color: #EFBF04">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"</span>
+
 > [!NOTE]
 >
 > **Caption:**
 > - Variable
-> - <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>
- :open_file_folder: manual (Manual proxy configuration)
-  - :open_file_folder: http_proxy (HTTP Proxy)
-    - :notebook: address (HTTP address): <span style="color: #006400">example.net</span> ← loaded from the YAML file "config/02/config.yml"
-    - :notebook: port (HTTP Port): <span style="color: #B8860B">8080</span>
-  - :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)
+- :notebook: proxy_mode (Configure Proxy Access to the Internet): <span style="color: #006400">Manual proxy configuration</span> ← loaded from the YAML file "config/02/config.yml" (:hourglass_flowing_sand: No proxy)


- [[tutorial v1.1_040] A disabled family](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_040/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_040~1..v1.1_040))
+- [[tutorial v1.1_041] A conditional disabled family](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))
--- a/config/01/config.yml
+++ b/config/01/config.yml
@ -1,4 +1 @@
 ---
-manual:
-  http_proxy:
-    address: example.net
--- a/config/01/output_ro.html
+++ b/config/01/output_ro.html
@ -1,13 +1,6 @@
-<pre>╭──────── Caption ────────╮
+<pre>╭─────── Caption ────────╮
 │ Variable <span style="color: #ffd700">Default value</span> │
-│          <span style="color: #00aa00">Modified value</span> │
-╰─────────────────────────╯
+╰────────────────────────╯
 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>📂 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">example.net</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"
-<span style="color: #5c5cff">    </span><span style="color: #5c5cff">┃   </span><span style="color: #5c5cff">┗━━ </span>📓 port (HTTP Port): <span style="color: #ffd700">8080</span>
-<span style="color: #5c5cff">    </span><span style="color: #5c5cff">┗━━ </span>📓 use_for_https (Also use this proxy for HTTPS): <span style="color: #ffd700">true</span>
+<span style="color: #5c5cff">┗━━ </span>📓 proxy_mode (Configure Proxy Access to the Internet): <span style="color: #ffd700">No proxy</span>
 </pre>
--- a/config/02/config.yml
+++ b/config/02/config.yml
@ -1,5 +1,7 @@
 ---
+proxy_mode: Manual proxy configuration
 manual:
  http_proxy:
-    address: example.net
+    address: http.proxy.net
+    port: 3128
  use_for_https: false
--- a/config/02/output_ro.html
+++ b/config/02/output_ro.html
@ -1,15 +1,25 @@
-<pre>╭────────────── Caption ───────────────╮
-│ Variable <span style="color: #ffd700">Default value</span>               │
-│          <span style="color: #00aa00">Modified 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>http_proxy (HTTP Proxy)
+<span style="color: #ffff00">    </span><span style="color: #ffff00">┃   </span><span style="color: #ffff00">┣━━ </span>address (HTTP address): <span style="color: #ffff00">🔔 family "manual" (Manual proxy </span>
+<span style="color: #ffff00">    </span><span style="color: #ffff00">┃   </span><span style="color: #ffff00">┃   </span><span style="color: #ffff00">configuration) has property disabled, so cannot access to "address" </span>
+<span style="color: #ffff00">    </span><span style="color: #ffff00">┃   </span><span style="color: #ffff00">┃   </span><span style="color: #ffff00">(HTTP address), it will be ignored when loading from the YAML file </span>
+<span style="color: #ffff00">    </span><span style="color: #ffff00">┃   </span><span style="color: #ffff00">┃   </span><span style="color: #ffff00">"config/02/config.yml"</span>
+<span style="color: #ffff00">    </span><span style="color: #ffff00">┃   </span><span style="color: #ffff00">┗━━ </span>port (HTTP Port): <span style="color: #ffff00">🔔 family "manual" (Manual proxy configuration) </span>
+<span style="color: #ffff00">    </span><span style="color: #ffff00">┃   </span><span style="color: #ffff00">    </span><span style="color: #ffff00">has property disabled, so cannot access to "port" (HTTP Port), it </span>
+<span style="color: #ffff00">    </span><span style="color: #ffff00">┃   </span><span style="color: #ffff00">    </span><span style="color: #ffff00">will be ignored when loading from the YAML file </span>
+<span style="color: #ffff00">    </span><span style="color: #ffff00">┃   </span><span style="color: #ffff00">    </span><span style="color: #ffff00">"config/02/config.yml"</span>
+<span style="color: #ffff00">    </span><span style="color: #ffff00">┗━━ </span>use_for_https (Also use this proxy for HTTPS): <span style="color: #ffff00">🔔 family "manual" </span>
+<span style="color: #ffff00">    </span><span style="color: #ffff00">    </span><span style="color: #ffff00">(Manual proxy configuration) has property disabled, so cannot access to </span>
+<span style="color: #ffff00">    </span><span style="color: #ffff00">    </span><span style="color: #ffff00">"use_for_https" (Also use this proxy for HTTPS), it will be ignored when</span>
+<span style="color: #ffff00">    </span><span style="color: #ffff00">    </span><span style="color: #ffff00">loading from the YAML file "config/02/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: #ffd700">No proxy</span>
-<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">example.net</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"
-<span style="color: #5c5cff">    </span><span style="color: #5c5cff">┃   </span><span style="color: #5c5cff">┗━━ </span>📓 port (HTTP Port): <span style="color: #ffd700">8080</span>
-<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>📓 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 
+<span style="color: #5c5cff">    </span>proxy)
 </pre>
--- 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_033/./">.</a><br/>
-	└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_033/./firefox/">firefox</a><br/>
-	    ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_033/./firefox/00-proxy.yml">00-proxy.yml</a><br/>
-	    ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_033/./firefox/10-manual.yml">10-manual.yml</a><br/>
-	    └── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_033/./firefox/20-manual.yml">20-manual.yml</a><br/>
+<a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_040/./">.</a><br/>
+	└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_040/./firefox/">firefox</a><br/>
+	    ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_040/./firefox/00-proxy.yml">00-proxy.yml</a><br/>
+	    ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_040/./firefox/10-manual.yml">10-manual.yml</a><br/>
+	    └── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_040/./firefox/20-manual.yml">20-manual.yml</a><br/>
 <br/><br/></p>