[tutorial 050] Family: "shorthand" mode (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 043] Jinja with a description](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_043/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_043~1..v1.1_043))
+- [[tutorial 044] A conditional disabled variable with identifier](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_044/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_044~1..v1.1_044))
 
-# [tutorial 044] A conditional disabled variable with identifier
+# [tutorial 050] Family: "shorthand" mode
 
-[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_044~1..v1.1_044)
+[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_050~1..v1.1_050)
 
 
 ## Screenshot
@@ -42,8 +42,7 @@ manual:
     variable: proxy_mode
     when_not: 'Manual proxy configuration'
 
-  http_proxy:
+  http_proxy:  # HTTP Proxy
-    description: HTTP Proxy
 
     address:
       description: HTTP address
@@ -151,6 +150,131 @@ This family builds families dynamically.
 | **manual.https_proxy.version** or **manual.socks_proxy.version**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` _`disabled`_                                                                                                                                                                                                                                                                                                                                                                                                                                                   | SOCKS host version used by proxy.<br/>**Choices**: <br/>- v4<br/>- v5 ← (default)<br/>**Disabled**: when the identifier is "HTTPS".                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
 
 
+## User data
+
+### Example 1
+
+#### config/01/config.yaml
 
 
-- [[tutorial 050] Family: "shorthand" mode](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_050~1..v1.1_050))
+```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)
+<span style="color: #ff0000">┗━━ </span>  - manual.socks_proxy.address (SOCKS 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 051] Variable: "shorthand" mode](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_051~1..v1.1_051))

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,5 @@
+<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)
+<span style="color: #ff0000">┗━━ </span>  - manual.socks_proxy.address (SOCKS 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>