[tutorial v1.1_033] A variable with type "boolean" (config and doc)

2026-01-06 16:53:29 +01:00 · 2026-01-06 16:53:29 +01:00 · 15213ef7bd
commit 15213ef7bd
parent 7f55261f79
12 changed files with 52 additions and 146 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_031] A variable with type's parameters](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] 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_032] A variable with type "port"
+# [tutorial v1.1_033] A variable with type "boolean"

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

-[Read the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/disabled.html#a-variable-with-type-"port")
+[Read the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/disabled.html#a-variable-with-type-"boolean")


 ## 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_032
+git switch --detach v1.1_033
 ```

 ## Structure
@ -39,33 +39,23 @@ git switch --detach v1.1_032


 <p>
-<a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_032/./">.</a><br/>
-	└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_032/./firefox/">firefox</a><br/>
-	    ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_032/./firefox/00-proxy.yml">00-proxy.yml</a><br/>
-	    └── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_032/./firefox/10-manual.yml">10-manual.yml</a><br/>
+<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/>
 <br/><br/></p>

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

 ```yml
 %YAML 1.2
 ---
 version: 1.1

-manual:  # Manual proxy configuration
+manual:

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

 ```
@ -95,6 +85,10 @@ rougail -m firefox/ -o doc
 | **<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
@ -103,8 +97,8 @@ rougail -m firefox/ -o doc --doc.contents changelog
 #### New variable

 | Variable                                                                                                                                                                                  | Description                                          |
-|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| **<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 |
+|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------|
+| **<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 |


 ## User datas
@ -116,7 +110,6 @@ rougail -m firefox/ -o doc --doc.contents changelog

 ```yml
 ---
-proxy_mode: Manual proxy configuration
 manual:
  http_proxy:
    address: example.net
@ -132,14 +125,14 @@ rougail -m firefox/ -u yaml -yf config/01/config.yml
 > - 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: #006400">Manual proxy configuration</span> ← loaded from the YAML file "config/01/config.yml" (:hourglass_flowing_sand: No proxy)
+- :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
@ -147,54 +140,16 @@ Variables:

 ```yml
 ---
-proxy_mode: Manual proxy configuration
 manual:
  http_proxy:
    address: example.net
-    port: 3128
+  use_for_https: false
 ```
 #### Output

 ```shell
 rougail -m firefox/ -u yaml -yf config/02/config.yml
 ```
-> [!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/02/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">example.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)
-### Example 3
-
-#### config/03/config.yml
-
-
-```yml
---
-proxy_mode: Manual proxy configuration
-manual:
-  http_proxy:
-    address: example.net
-    port: 100000
-```
-#### Output
-
-```shell
-rougail -m firefox/ -u yaml -yf config/03/config.yml
-```
-> [!WARNING]
-> 
-> - manual (Manual proxy configuration)
->   - http_proxy (HTTP Proxy)
->     - port (HTTP Port): :bell: <span style="color: #EFBF04">the value "100000" is an invalid port, must be between 1 and 65535, it will be ignored when loading from the YAML file "config/03/config.yml"</span>
-
 > [!NOTE]
 >
 > **Caption:**
@ -204,21 +159,12 @@ rougail -m firefox/ -u yaml -yf config/03/config.yml
 > - (: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/03/config.yml" (:hourglass_flowing_sand: No proxy)
+- :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/03/config.yml"
+    - :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>
-#### Output when invalid user datas is an error
-
-```shell
-rougail -m firefox/ -u yaml -yf config/03/config.yml --cli.invalid_user_data_error
-```
-> [!CAUTION]
-> 
-> - manual (Manual proxy configuration)
->   - http_proxy (HTTP Proxy)
->     - port (HTTP Port): :stop_sign: <span style="color: #C23636">the value "100000" is an invalid port, must be between 1 and 65535, it has been loading from the YAML file "config/03/config.yml"</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)


- [[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_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))
--- a/config/01/config.yml
+++ b/config/01/config.yml
@ -1,5 +1,4 @@
 ---
-proxy_mode: Manual proxy configuration
 manual:
  http_proxy:
    address: example.net
--- a/config/01/output_ro.html
+++ b/config/01/output_ro.html
@ -1,15 +1,13 @@
-<pre>╭────────────── Caption ───────────────╮
+<pre>╭──────── Caption ────────╮
 │ Variable <span style="color: #ffd700">Default value</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/01/config.yml" (⏳ No 
-<span style="color: #5c5cff">┃   </span>proxy)
+<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>📂 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>
 </pre>
--- a/config/02/config.yml
+++ b/config/02/config.yml
@ -1,6 +1,5 @@
 ---
-proxy_mode: Manual proxy configuration
 manual:
  http_proxy:
    address: example.net
-    port: 3128
+  use_for_https: false
--- a/config/02/output_ro.html
+++ b/config/02/output_ro.html
@ -1,15 +1,15 @@
 <pre>╭────────────── Caption ───────────────╮
-│ Variable <span style="color: #00aa00">Modified value</span>              │
+│ Variable <span style="color: #ffd700">Default value</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 
-<span style="color: #5c5cff">┃   </span>proxy)
+<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: #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>📂 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)
 </pre>
--- a/config/03/cmd_invalid.txt
+++ b/config/03/cmd_invalid.txt
@ -1 +0,0 @@
-rougail -m firefox/ -u yaml -yf config/03/config.yml --cli.invalid_user_data_error
--- a/config/03/cmd_ro.txt
+++ b/config/03/cmd_ro.txt
@ -1 +0,0 @@
-rougail -m firefox/ -u yaml -yf config/03/config.yml
--- a/config/03/config.yml
+++ b/config/03/config.yml
@ -1,6 +0,0 @@
---
-proxy_mode: Manual proxy configuration
-manual:
-  http_proxy:
-    address: example.net
-    port: 100000
--- a/config/03/output_invalid.html
+++ b/config/03/output_invalid.html
@ -1,7 +0,0 @@
-<pre><span style="font-weight: bold; color: #ff0000">🛑 Caution</span>
-<span style="color: #ff0000">┗━━ </span>manual (Manual proxy configuration)
-<span style="color: #ff0000">    </span><span style="color: #ff0000">┗━━ </span>http_proxy (HTTP Proxy)
-<span style="color: #ff0000">    </span><span style="color: #ff0000">    </span><span style="color: #ff0000">┗━━ </span>port (HTTP Port): <span style="color: #ff0000">🛑 the value "100000" is an invalid port, must be </span>
-<span style="color: #ff0000">    </span><span style="color: #ff0000">    </span><span style="color: #ff0000">    </span><span style="color: #ff0000">between 1 and 65535, it has been loading from the YAML file </span>
-<span style="color: #ff0000">    </span><span style="color: #ff0000">    </span><span style="color: #ff0000">    </span><span style="color: #ff0000">"config/03/config.yml"</span>
-</pre>
--- a/config/03/output_ro.html
+++ b/config/03/output_ro.html
@ -1,22 +0,0 @@
-<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>port (HTTP Port): <span style="color: #ffff00">🔔 the value "100000" is an invalid port, must be </span>
-<span style="color: #ffff00">    </span><span style="color: #ffff00">    </span><span style="color: #ffff00">    </span><span style="color: #ffff00">between 1 and 65535, it will be ignored when loading from the YAML </span>
-<span style="color: #ffff00">    </span><span style="color: #ffff00">    </span><span style="color: #ffff00">    </span><span style="color: #ffff00">file "config/03/config.yml"</span>
-
-╭────────────── Caption ───────────────╮
-│ Variable <span style="color: #ffd700">Default value</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/03/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">example.net</span> ◀ loaded from the YAML file 
-<span style="color: #5c5cff">    </span><span style="color: #5c5cff">    </span><span style="color: #5c5cff">┃   </span>"config/03/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>
-</pre>
--- a/firefox.png
+++ b/firefox.png
--- a/tree.html
+++ b/tree.html
@ -1,6 +1,7 @@
 <p>
-<a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_032/./">.</a><br/>
-	└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_032/./firefox/">firefox</a><br/>
-	    ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_032/./firefox/00-proxy.yml">00-proxy.yml</a><br/>
-	    └── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_032/./firefox/10-manual.yml">10-manual.yml</a><br/>
+<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/>
 <br/><br/></p>
				`@ -1 +0,0 @@`
				`rougail -m firefox/ -u yaml -yf config/03/config.yml --cli.invalid_user_data_error`