[tutorial 010] A first variable with only a name (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 000] A structured file with format version](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_000/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_000~1..v1.1_000))
+- [[tutorial 001] The format version in commandline](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_001/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_001~1..v1.1_001))
 
-# [tutorial 001] The format version in commandline
+# [tutorial 010] A first variable with only a name
 
-[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_001~1..v1.1_001)
+[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_010~1..v1.1_010)
 
 
 ## Screenshot
@@ -20,6 +20,7 @@
 
 ```yml
 ---
+proxy_mode:
 
 ```
 ### Generated documentation
@@ -27,6 +28,125 @@
 ```console
 foo@bar:~$ rougail -v 1.1 -m firefox/ -o doc -do github
 ```
+### Variables
+
+| Variable                                                                                          | Description                                                                                       |
+|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| **proxy_mode**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory`                                                                                                                                                                                                                                                                                                                                                                                                                                    | Proxy_mode.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
 
 
-- [[tutorial 010] A first variable with only a name](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_010/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_010~1..v1.1_010))
+## User data
+
+### 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>🛑 ERRORS
+<span style="color: #ff0000">┣━━ </span>The following variables are mandatory but have no value:
+<span style="color: #ff0000">┗━━ </span>  - proxy_mode
+</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
+</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>╭────────────────────────── 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: Manual proxy configuration
+</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>╭────────────────────────── 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: foo
+</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 string for "proxy_mode"
+<span style="color: #ff0000">┣━━ </span>The following variables are mandatory but have no value:
+<span style="color: #ff0000">┗━━ </span>  - proxy_mode
+</pre>
+
+
+- [[tutorial 011] The variable description](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_011/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_011~1..v1.1_011))

config/01/config.yaml

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

config/01/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>  - proxy_mode
+</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
+</pre>

config/03/config.yaml

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

config/03/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: Manual proxy configuration
+</pre>

config/04/config.yaml

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

config/04/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: foo
+</pre>

config/05/config.yaml

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

config/05/output_ro.html

@@ -0,0 +1,5 @@
+<pre>🛑 ERRORS
+<span style="color: #ff0000">┣━━ </span>"1" is an invalid string for "proxy_mode"
+<span style="color: #ff0000">┣━━ </span>The following variables are mandatory but have no value:
+<span style="color: #ff0000">┗━━ </span>  - proxy_mode
+</pre>