[tutorial 023] Family type is optional (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 021] A sub family](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_021/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_021~1..v1.1_021))
+- [[tutorial 022] A variable inside sub family](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_022/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_022~1..v1.1_022))
 
-# [tutorial 022] A variable inside sub family
+# [tutorial 023] Family type is optional
 
-[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_022~1..v1.1_022)
+[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_023~1..v1.1_023)
 
 
 ## Screenshot
@@ -38,11 +38,9 @@ proxy_mode:
 ---
 manual:
   description: Manual proxy configuration
-  type: family
 
   http_proxy:
     description: HTTP Proxy
-    type: family
 
     address:
       description: HTTP address
@@ -88,16 +86,6 @@ foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/01/config.yaml
 <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>
-#### Output in read write mode
-
-```console
-foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/01/config.yaml --exporter.read_write
-```
-<pre><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>
-</pre>
 ### Example 2
 
 #### config/02/config.yaml
@@ -105,7 +93,7 @@ foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/01/config.yaml --export
 
 ```yml
 ---
-proxy_mode: Manual proxy configuration
+proxy_mode: No proxy
 
 ```
 #### Output
@@ -117,16 +105,6 @@ foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/02/config.yaml
 <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>
-#### Output in read write mode
-
-```console
-foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/02/config.yaml --exporter.read_write
-```
-<pre><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>
-</pre>
 ### Example 3
 
 #### config/03/config.yaml
@@ -135,9 +113,6 @@ foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/02/config.yaml --export
 ```yml
 ---
 proxy_mode: Manual proxy configuration
-manual:
-  http_proxy:
-    address: example.net
 
 ```
 #### Output
@@ -145,33 +120,9 @@ manual:
 ```console
 foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/03/config.yaml
 ```
-<pre>╭────────────────────────── Caption ──────────────────────────╮
+<pre>🛑 ERRORS
-│ Variable                           <span style="color: #ffd700">Default value</span>            │
+<span style="color: #ff0000">┣━━ </span>The following variables are mandatory but have no value:
-│ <span style="color: #5c5cff">Undocumented variable</span>              Modified value           │
+<span style="color: #ff0000">┗━━ </span>  - manual.http_proxy.address (HTTP address)
-│ <span style="color: #ff0000">Undocumented but modified variable</span> (<span style="color: #00aa00">Original default value</span>) │
-╰─────────────────────────────────────────────────────────────╯
-Variables:
-<span style="color: #5c5cff">┣━━ </span>📓 proxy_mode: Manual proxy configuration (<span style="color: #00aa00">No proxy</span>)
-<span style="color: #5c5cff">┗━━ </span>📂 manual
-<span style="color: #5c5cff">    </span><span style="color: #5c5cff">┗━━ </span>📂 http_proxy
-<span style="color: #5c5cff">    </span><span style="color: #5c5cff">    </span><span style="color: #5c5cff">┗━━ </span>📓 address: example.net
-</pre>
-#### Output in read write mode
-
-```console
-foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/03/config.yaml --exporter.read_write
-```
-<pre><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>) │
-╰─────────────────────────────────────────────────────────────╯
-Variables:
-<span style="color: #5c5cff">┣━━ </span>📓 proxy_mode: Manual proxy configuration (<span style="color: #00aa00">No proxy</span>)
-<span style="color: #5c5cff">┗━━ </span>📂 manual
-<span style="color: #5c5cff">    </span><span style="color: #5c5cff">┗━━ </span>📂 http_proxy
-<span style="color: #5c5cff">    </span><span style="color: #5c5cff">    </span><span style="color: #5c5cff">┗━━ </span>📓 address: example.net
-</pre>
 </pre>
 ### Example 4
 
@@ -180,11 +131,7 @@ Variables:
 
 ```yml
 ---
-proxy_mode: Manual proxy configuration
+proxy_mode: foo
-manual:
-  http_proxy:
-    address: example.net
-    port: '3128'
 
 ```
 #### Output
@@ -193,34 +140,10 @@ manual:
 foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/04/config.yaml
 ```
 <pre>🛑 ERRORS
-<span style="color: #ff0000">┗━━ </span>unknown option "port" in optiondescription "manual.http_proxy" (HTTP Proxy)
+<span style="color: #ff0000">┣━━ </span>"foo" is an invalid choice for "proxy_mode (Configure Proxy Access to the Internet)", only "Auto-detect proxy settings for this network", "Automatic proxy configuration URL", "Manual proxy configuration", "No proxy" and "Use system 
-╭────────────────────────── Caption ──────────────────────────╮
+<span style="color: #ff0000">┃   </span>proxy settings" are allowed
-│ Variable                           <span style="color: #ffd700">Default value</span>            │
+<span style="color: #ff0000">┣━━ </span>The following variables are mandatory but have no value:
-│ <span style="color: #5c5cff">Undocumented variable</span>              Modified value           │
+<span style="color: #ff0000">┗━━ </span>  - manual.http_proxy.address (HTTP address)
-│ <span style="color: #ff0000">Undocumented but modified variable</span> (<span style="color: #00aa00">Original default value</span>) │
-╰─────────────────────────────────────────────────────────────╯
-Variables:
-<span style="color: #5c5cff">┣━━ </span>📓 proxy_mode: Manual proxy configuration (<span style="color: #00aa00">No proxy</span>)
-<span style="color: #5c5cff">┗━━ </span>📂 manual
-<span style="color: #5c5cff">    </span><span style="color: #5c5cff">┗━━ </span>📂 http_proxy
-<span style="color: #5c5cff">    </span><span style="color: #5c5cff">    </span><span style="color: #5c5cff">┗━━ </span>📓 address: example.net
-</pre>
-#### Output in read write mode
-
-```console
-foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/04/config.yaml --exporter.read_write
-```
-<pre><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>) │
-╰─────────────────────────────────────────────────────────────╯
-Variables:
-<span style="color: #5c5cff">┣━━ </span>📓 proxy_mode: Manual proxy configuration (<span style="color: #00aa00">No proxy</span>)
-<span style="color: #5c5cff">┗━━ </span>📂 manual
-<span style="color: #5c5cff">    </span><span style="color: #5c5cff">┗━━ </span>📂 http_proxy
-<span style="color: #5c5cff">    </span><span style="color: #5c5cff">    </span><span style="color: #5c5cff">┗━━ </span>📓 address: example.net
-</pre>
 </pre>
 ### Example 5
 
@@ -229,14 +152,7 @@ Variables:
 
 ```yml
 ---
-proxy_mode: Manual proxy configuration
+proxy_mode: 1
-manual:
-  http_proxy:
-    address: http.proxy.net
-    port: '3128'
-  use_for_https: false
-  https_proxy:
-    address: https.proxy.net
 
 ```
 #### Output
@@ -245,37 +161,11 @@ manual:
 foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/05/config.yaml
 ```
 <pre>🛑 ERRORS
-<span style="color: #ff0000">┣━━ </span>unknown option "port" in optiondescription "manual.http_proxy" (HTTP Proxy)
+<span style="color: #ff0000">┣━━ </span>"1" is an invalid choice for "proxy_mode (Configure Proxy Access to the Internet)", only "Auto-detect proxy settings for this network", "Automatic proxy configuration URL", "Manual proxy configuration", "No proxy" and "Use system 
-<span style="color: #ff0000">┣━━ </span>unknown option "use_for_https" in optiondescription "manual" (Manual proxy configuration)
+<span style="color: #ff0000">┃   </span>proxy settings" are allowed
-<span style="color: #ff0000">┗━━ </span>unknown option "https_proxy" in optiondescription "manual" (Manual proxy configuration)
+<span style="color: #ff0000">┣━━ </span>The following variables are mandatory but have no value:
-╭────────────────────────── Caption ──────────────────────────╮
+<span style="color: #ff0000">┗━━ </span>  - manual.http_proxy.address (HTTP address)
-│ 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>) │
-╰─────────────────────────────────────────────────────────────╯
-Variables:
-<span style="color: #5c5cff">┣━━ </span>📓 proxy_mode: Manual proxy configuration (<span style="color: #00aa00">No proxy</span>)
-<span style="color: #5c5cff">┗━━ </span>📂 manual
-<span style="color: #5c5cff">    </span><span style="color: #5c5cff">┗━━ </span>📂 http_proxy
-<span style="color: #5c5cff">    </span><span style="color: #5c5cff">    </span><span style="color: #5c5cff">┗━━ </span>📓 address: http.proxy.net
-</pre>
-#### Output in read write mode
-
-```console
-foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/05/config.yaml --exporter.read_write
-```
-<pre><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>) │
-╰─────────────────────────────────────────────────────────────╯
-Variables:
-<span style="color: #5c5cff">┣━━ </span>📓 proxy_mode: Manual proxy configuration (<span style="color: #00aa00">No proxy</span>)
-<span style="color: #5c5cff">┗━━ </span>📂 manual
-<span style="color: #5c5cff">    </span><span style="color: #5c5cff">┗━━ </span>📂 http_proxy
-<span style="color: #5c5cff">    </span><span style="color: #5c5cff">    </span><span style="color: #5c5cff">┗━━ </span>📓 address: http.proxy.net
-</pre>
 </pre>
 
 
-- [[tutorial 023] Family type is optional](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_023/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_023~1..v1.1_023))
+- [[tutorial 024] A variable with type "domainname"](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_024/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_024~1..v1.1_024))

config/01/output_rw.html

@@ -1,4 +0,0 @@
-<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/02/config.yaml

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

config/02/output_rw.html

@@ -1,4 +0,0 @@
-<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/03/config.yaml

@@ -1,5 +1,2 @@
 ---
 proxy_mode: Manual proxy configuration
-manual:
-  http_proxy:
-    address: example.net

config/03/output_ro.html

@@ -1,11 +1,4 @@
-<pre>╭────────────────────────── Caption ──────────────────────────╮
+<pre>🛑 ERRORS
-│ Variable                           <span style="color: #ffd700">Default value</span>            │
+<span style="color: #ff0000">┣━━ </span>The following variables are mandatory but have no value:
-│ <span style="color: #5c5cff">Undocumented variable</span>              Modified value           │
+<span style="color: #ff0000">┗━━ </span>  - manual.http_proxy.address (HTTP address)
-│ <span style="color: #ff0000">Undocumented but modified variable</span> (<span style="color: #00aa00">Original default value</span>) │
-╰─────────────────────────────────────────────────────────────╯
-Variables:
-<span style="color: #5c5cff">┣━━ </span>📓 proxy_mode: Manual proxy configuration (<span style="color: #00aa00">No proxy</span>)
-<span style="color: #5c5cff">┗━━ </span>📂 manual
-<span style="color: #5c5cff">    </span><span style="color: #5c5cff">┗━━ </span>📂 http_proxy
-<span style="color: #5c5cff">    </span><span style="color: #5c5cff">    </span><span style="color: #5c5cff">┗━━ </span>📓 address: example.net
 </pre>

config/03/output_rw.html

@@ -1,11 +0,0 @@
-<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>) │
-╰─────────────────────────────────────────────────────────────╯
-Variables:
-<span style="color: #5c5cff">┣━━ </span>📓 proxy_mode: Manual proxy configuration (<span style="color: #00aa00">No proxy</span>)
-<span style="color: #5c5cff">┗━━ </span>📂 manual
-<span style="color: #5c5cff">    </span><span style="color: #5c5cff">┗━━ </span>📂 http_proxy
-<span style="color: #5c5cff">    </span><span style="color: #5c5cff">    </span><span style="color: #5c5cff">┗━━ </span>📓 address: example.net
-</pre>

config/04/config.yaml

@@ -1,6 +1,2 @@
 ---
-proxy_mode: Manual proxy configuration
+proxy_mode: foo
-manual:
-  http_proxy:
-    address: example.net
-    port: '3128'

config/04/output_ro.html

@@ -1,13 +1,6 @@
 <pre>🛑 ERRORS
-<span style="color: #ff0000">┗━━ </span>unknown option "port" in optiondescription "manual.http_proxy" (HTTP Proxy)
+<span style="color: #ff0000">┣━━ </span>"foo" is an invalid choice for "proxy_mode (Configure Proxy Access to the Internet)", only "Auto-detect proxy settings for this network", "Automatic proxy configuration URL", "Manual proxy configuration", "No proxy" and "Use system 
-╭────────────────────────── Caption ──────────────────────────╮
+<span style="color: #ff0000">┃   </span>proxy settings" are allowed
-│ Variable                           <span style="color: #ffd700">Default value</span>            │
+<span style="color: #ff0000">┣━━ </span>The following variables are mandatory but have no value:
-│ <span style="color: #5c5cff">Undocumented variable</span>              Modified value           │
+<span style="color: #ff0000">┗━━ </span>  - manual.http_proxy.address (HTTP address)
-│ <span style="color: #ff0000">Undocumented but modified variable</span> (<span style="color: #00aa00">Original default value</span>) │
-╰─────────────────────────────────────────────────────────────╯
-Variables:
-<span style="color: #5c5cff">┣━━ </span>📓 proxy_mode: Manual proxy configuration (<span style="color: #00aa00">No proxy</span>)
-<span style="color: #5c5cff">┗━━ </span>📂 manual
-<span style="color: #5c5cff">    </span><span style="color: #5c5cff">┗━━ </span>📂 http_proxy
-<span style="color: #5c5cff">    </span><span style="color: #5c5cff">    </span><span style="color: #5c5cff">┗━━ </span>📓 address: example.net
 </pre>

config/04/output_rw.html

@@ -1,11 +0,0 @@
-<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>) │
-╰─────────────────────────────────────────────────────────────╯
-Variables:
-<span style="color: #5c5cff">┣━━ </span>📓 proxy_mode: Manual proxy configuration (<span style="color: #00aa00">No proxy</span>)
-<span style="color: #5c5cff">┗━━ </span>📂 manual
-<span style="color: #5c5cff">    </span><span style="color: #5c5cff">┗━━ </span>📂 http_proxy
-<span style="color: #5c5cff">    </span><span style="color: #5c5cff">    </span><span style="color: #5c5cff">┗━━ </span>📓 address: example.net
-</pre>

config/05/config.yaml

@@ -1,9 +1,2 @@
 ---
-proxy_mode: Manual proxy configuration
+proxy_mode: 1
-manual:
-  http_proxy:
-    address: http.proxy.net
-    port: '3128'
-  use_for_https: false
-  https_proxy:
-    address: https.proxy.net

config/05/output_ro.html

@@ -1,15 +1,6 @@
 <pre>🛑 ERRORS
-<span style="color: #ff0000">┣━━ </span>unknown option "port" in optiondescription "manual.http_proxy" (HTTP Proxy)
+<span style="color: #ff0000">┣━━ </span>"1" is an invalid choice for "proxy_mode (Configure Proxy Access to the Internet)", only "Auto-detect proxy settings for this network", "Automatic proxy configuration URL", "Manual proxy configuration", "No proxy" and "Use system 
-<span style="color: #ff0000">┣━━ </span>unknown option "use_for_https" in optiondescription "manual" (Manual proxy configuration)
+<span style="color: #ff0000">┃   </span>proxy settings" are allowed
-<span style="color: #ff0000">┗━━ </span>unknown option "https_proxy" in optiondescription "manual" (Manual proxy configuration)
+<span style="color: #ff0000">┣━━ </span>The following variables are mandatory but have no value:
-╭────────────────────────── Caption ──────────────────────────╮
+<span style="color: #ff0000">┗━━ </span>  - manual.http_proxy.address (HTTP address)
-│ 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>) │
-╰─────────────────────────────────────────────────────────────╯
-Variables:
-<span style="color: #5c5cff">┣━━ </span>📓 proxy_mode: Manual proxy configuration (<span style="color: #00aa00">No proxy</span>)
-<span style="color: #5c5cff">┗━━ </span>📂 manual
-<span style="color: #5c5cff">    </span><span style="color: #5c5cff">┗━━ </span>📂 http_proxy
-<span style="color: #5c5cff">    </span><span style="color: #5c5cff">    </span><span style="color: #5c5cff">┗━━ </span>📓 address: http.proxy.net
 </pre>

config/05/output_rw.html

@@ -1,11 +0,0 @@
-<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>) │
-╰─────────────────────────────────────────────────────────────╯
-Variables:
-<span style="color: #5c5cff">┣━━ </span>📓 proxy_mode: Manual proxy configuration (<span style="color: #00aa00">No proxy</span>)
-<span style="color: #5c5cff">┗━━ </span>📂 manual
-<span style="color: #5c5cff">    </span><span style="color: #5c5cff">┗━━ </span>📂 http_proxy
-<span style="color: #5c5cff">    </span><span style="color: #5c5cff">    </span><span style="color: #5c5cff">┗━━ </span>📓 address: http.proxy.net
-</pre>