[tutorial 030] A variable with type "boolean" (config and doc)

README.md

@@ -1,9 +1,9 @@
 - [Summary](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/branch/1.1/README.md)
-- [[tutorial 028] A conditional disabled family with a variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_028/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_028~1..v1.1_028))
+- [[tutorial 029] Type variable is optional](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_029/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_029~1..v1.1_029))
 
-# [tutorial 029] Type variable is optional
+# [tutorial 030] A variable with type "boolean"
 
-[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_029~1..v1.1_029)
+[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_030~1..v1.1_030)
 
 
 ## Screenshot
@@ -56,6 +56,19 @@ manual:
       type: port
       default: 8080
 
+```
+### firefox/20-manual.yml
+
+
+```yml
+---
+manual:
+
+  use_for_https:
+    description: Also use this proxy for HTTPS
+    type: boolean
+    default: true
+
 ```
 ### Generated documentation
 
@@ -64,8 +77,8 @@ foo@bar:~$ rougail -v 1.1 -m firefox/ -o doc -do github
 ```
 ### Variables
 
-| Variable                                                                                        | Description                                                                                     |
-|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| Variable                                                                                           | Description                                                                                        |
+|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
 | **proxy_mode**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory`                                                                                                                                                                                                                                                                                                                                                                                                                                          | Configure Proxy Access to the Internet.<br/>**Choices**: <br/>- No proxy ← (default)<br/>- Auto-detect proxy settings for this network<br/>- Use system proxy settings<br/>- Manual proxy configuration<br/>- Automatic proxy configuration URL                                                                                                                                                                                                                                                                                             |
 
 #### Manual proxy configuration
@@ -76,12 +89,140 @@ _`disabled`_
 
 ##### HTTP Proxy
 
-| Variable&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;   | Description&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;   |
-|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| Variable&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;   | Description&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;   |
+|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
 | **manual.http_proxy.address**<br/>[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory`                                                                                                                                                                                                                                                                                                                                                                                                                       | HTTP address.<br/>**Validator**: the domain name can be an IP                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
 | **manual.http_proxy.port**<br/>[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory`                                                                                                                                                                                                                                                                                                                                                                                                                                | HTTP Port.<br/>**Default**: 8080                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
 
+| Variable&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;   | Description&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;   |
+|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| **manual.use_for_https**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory`                                                                                                                                                                                                                                                                                                                                                                                                                               | Also use this proxy for HTTPS.<br/>**Default**: True                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
 
 
+## User data
 
-- [[tutorial 030] A variable with type "boolean"](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_030/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_030~1..v1.1_030))
+### Example 1
+
+#### config/01/config.yaml
+
+
+```yml
+---
+
+```
+#### Output
+
+```console
+foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/01/config.yaml
+```
+<pre>╭────────────────────────── Caption ──────────────────────────╮
+│ Variable                           <span style="color: #ffd700">Default value</span>            │
+│ <span style="color: #5c5cff">Undocumented variable</span>              Modified value           │
+│ <span style="color: #ff0000">Undocumented but modified variable</span> (<span style="color: #00aa00">Original default value</span>) │
+│ <span style="color: #ffaf00">Unmodifiable variable</span>                                       │
+╰─────────────────────────────────────────────────────────────╯
+Variables:
+<span style="color: #5c5cff">┗━━ </span>📓 proxy_mode: <span style="color: #ffd700">No proxy</span>
+</pre>
+### Example 2
+
+#### config/02/config.yaml
+
+
+```yml
+---
+proxy_mode: No proxy
+
+```
+#### Output
+
+```console
+foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/02/config.yaml
+```
+<pre>╭────────────────────────── Caption ──────────────────────────╮
+│ Variable                           <span style="color: #ffd700">Default value</span>            │
+│ <span style="color: #5c5cff">Undocumented variable</span>              Modified value           │
+│ <span style="color: #ff0000">Undocumented but modified variable</span> (<span style="color: #00aa00">Original default value</span>) │
+│ <span style="color: #ffaf00">Unmodifiable variable</span>                                       │
+╰─────────────────────────────────────────────────────────────╯
+Variables:
+<span style="color: #5c5cff">┗━━ </span>📓 proxy_mode: No proxy (<span style="color: #00aa00">No proxy</span>)
+</pre>
+### Example 3
+
+#### config/03/config.yaml
+
+
+```yml
+---
+proxy_mode: Manual proxy configuration
+
+```
+#### Output
+
+```console
+foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/03/config.yaml
+```
+<pre>🛑 ERRORS
+<span style="color: #ff0000">┣━━ </span>The following variables are mandatory but have no value:
+<span style="color: #ff0000">┗━━ </span>  - manual.http_proxy.address (HTTP address)
+</pre>
+### Example 4
+
+#### config/04/config.yaml
+
+
+```yml
+---
+proxy_mode: foo
+
+```
+#### Output
+
+```console
+foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/04/config.yaml
+```
+<pre>🛑 ERRORS
+<span style="color: #ff0000">┗━━ </span>"foo" is an invalid choice for "proxy_mode (Configure Proxy Access to the Internet)", only 
+<span style="color: #ff0000">    </span>"Auto-detect proxy settings for this network", "Automatic proxy configuration URL", "Manual proxy 
+<span style="color: #ff0000">    </span>configuration", "No proxy" and "Use system proxy settings" are allowed
+╭────────────────────────── Caption ──────────────────────────╮
+│ Variable                           <span style="color: #ffd700">Default value</span>            │
+│ <span style="color: #5c5cff">Undocumented variable</span>              Modified value           │
+│ <span style="color: #ff0000">Undocumented but modified variable</span> (<span style="color: #00aa00">Original default value</span>) │
+│ <span style="color: #ffaf00">Unmodifiable variable</span>                                       │
+╰─────────────────────────────────────────────────────────────╯
+Variables:
+<span style="color: #5c5cff">┗━━ </span>📓 proxy_mode: <span style="color: #ffd700">No proxy</span>
+</pre>
+### Example 5
+
+#### config/05/config.yaml
+
+
+```yml
+---
+proxy_mode: 1
+
+```
+#### Output
+
+```console
+foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/05/config.yaml
+```
+<pre>🛑 ERRORS
+<span style="color: #ff0000">┗━━ </span>"1" is an invalid choice for "proxy_mode (Configure Proxy Access to the Internet)", only "Auto-detect
+<span style="color: #ff0000">    </span>proxy settings for this network", "Automatic proxy configuration URL", "Manual proxy configuration", 
+<span style="color: #ff0000">    </span>"No proxy" and "Use system proxy settings" are allowed
+╭────────────────────────── Caption ──────────────────────────╮
+│ Variable                           <span style="color: #ffd700">Default value</span>            │
+│ <span style="color: #5c5cff">Undocumented variable</span>              Modified value           │
+│ <span style="color: #ff0000">Undocumented but modified variable</span> (<span style="color: #00aa00">Original default value</span>) │
+│ <span style="color: #ffaf00">Unmodifiable variable</span>                                       │
+╰─────────────────────────────────────────────────────────────╯
+Variables:
+<span style="color: #5c5cff">┗━━ </span>📓 proxy_mode: <span style="color: #ffd700">No proxy</span>
+</pre>
+
+
+- [[tutorial 031] Bases type is optional if default value](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))

config/01/config.yaml

@@ -0,0 +1 @@
+---

config/01/output_ro.html

@@ -0,0 +1,9 @@
+<pre>╭────────────────────────── Caption ──────────────────────────╮
+│ Variable                           <span style="color: #ffd700">Default value</span>            │
+│ <span style="color: #5c5cff">Undocumented variable</span>              Modified value           │
+│ <span style="color: #ff0000">Undocumented but modified variable</span> (<span style="color: #00aa00">Original default value</span>) │
+│ <span style="color: #ffaf00">Unmodifiable variable</span>                                       │
+╰─────────────────────────────────────────────────────────────╯
+Variables:
+<span style="color: #5c5cff">┗━━ </span>📓 proxy_mode: <span style="color: #ffd700">No proxy</span>
+</pre>

config/02/config.yaml

@@ -0,0 +1,2 @@
+---
+proxy_mode: No proxy

config/02/output_ro.html

@@ -0,0 +1,9 @@
+<pre>╭────────────────────────── Caption ──────────────────────────╮
+│ Variable                           <span style="color: #ffd700">Default value</span>            │
+│ <span style="color: #5c5cff">Undocumented variable</span>              Modified value           │
+│ <span style="color: #ff0000">Undocumented but modified variable</span> (<span style="color: #00aa00">Original default value</span>) │
+│ <span style="color: #ffaf00">Unmodifiable variable</span>                                       │
+╰─────────────────────────────────────────────────────────────╯
+Variables:
+<span style="color: #5c5cff">┗━━ </span>📓 proxy_mode: No proxy (<span style="color: #00aa00">No proxy</span>)
+</pre>

config/03/config.yaml

@@ -0,0 +1,2 @@
+---
+proxy_mode: Manual proxy configuration

config/03/output_ro.html

@@ -0,0 +1,4 @@
+<pre>🛑 ERRORS
+<span style="color: #ff0000">┣━━ </span>The following variables are mandatory but have no value:
+<span style="color: #ff0000">┗━━ </span>  - manual.http_proxy.address (HTTP address)
+</pre>

config/04/config.yaml

@@ -0,0 +1,2 @@
+---
+proxy_mode: foo

config/04/output_ro.html

@@ -0,0 +1,13 @@
+<pre>🛑 ERRORS
+<span style="color: #ff0000">┗━━ </span>"foo" is an invalid choice for "proxy_mode (Configure Proxy Access to the Internet)", only 
+<span style="color: #ff0000">    </span>"Auto-detect proxy settings for this network", "Automatic proxy configuration URL", "Manual proxy 
+<span style="color: #ff0000">    </span>configuration", "No proxy" and "Use system proxy settings" are allowed
+╭────────────────────────── Caption ──────────────────────────╮
+│ Variable                           <span style="color: #ffd700">Default value</span>            │
+│ <span style="color: #5c5cff">Undocumented variable</span>              Modified value           │
+│ <span style="color: #ff0000">Undocumented but modified variable</span> (<span style="color: #00aa00">Original default value</span>) │
+│ <span style="color: #ffaf00">Unmodifiable variable</span>                                       │
+╰─────────────────────────────────────────────────────────────╯
+Variables:
+<span style="color: #5c5cff">┗━━ </span>📓 proxy_mode: <span style="color: #ffd700">No proxy</span>
+</pre>

config/05/config.yaml

@@ -0,0 +1,2 @@
+---
+proxy_mode: 1

config/05/output_ro.html

@@ -0,0 +1,13 @@
+<pre>🛑 ERRORS
+<span style="color: #ff0000">┗━━ </span>"1" is an invalid choice for "proxy_mode (Configure Proxy Access to the Internet)", only "Auto-detect
+<span style="color: #ff0000">    </span>proxy settings for this network", "Automatic proxy configuration URL", "Manual proxy configuration", 
+<span style="color: #ff0000">    </span>"No proxy" and "Use system proxy settings" are allowed
+╭────────────────────────── Caption ──────────────────────────╮
+│ Variable                           <span style="color: #ffd700">Default value</span>            │
+│ <span style="color: #5c5cff">Undocumented variable</span>              Modified value           │
+│ <span style="color: #ff0000">Undocumented but modified variable</span> (<span style="color: #00aa00">Original default value</span>) │
+│ <span style="color: #ffaf00">Unmodifiable variable</span>                                       │
+╰─────────────────────────────────────────────────────────────╯
+Variables:
+<span style="color: #5c5cff">┗━━ </span>📓 proxy_mode: <span style="color: #ffd700">No proxy</span>
+</pre>