[tutorial v1.1_001)] A first variable with only a name (config and doc)

README.md

@@ -1,8 +1,9 @@
 - [Summary](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/branch/1.1/README.md)
+- [[tutorial v1.1_000] An empty 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 v1.1_000)] An empty structured file with format version
+# [tutorial v1.1_001)] A first variable with only a name
 
-[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_000~1..v1.1_000)
+[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_001~1..v1.1_001)
 
 
 ## Screenshot
@@ -21,9 +22,34 @@
 %YAML 1.2
 ---
 version: 1.1
+
+proxy_mode:
 ...
 
 ```
+### Let's generate the documentation
+
+```console
+foo@bar:~$ git switch --detach v1.1_001
+foo@bar:~$ rougail -m firefox/ -o doc
+```
+| Variable                                                                                          | Description                                                                                       |
+|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| **proxy_mode**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory`                                                                                                                                                                                                                                                                                                                                                                                                                                    |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
+
+### Let's generate the changelog
+
+```console
+foo@bar:~$ git switch --detach v1.1_001
+foo@bar:~$ rougail -m firefox/ -o doc --doc.contents changelog
+```
+#### New variable
+
+| 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;   | 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;   |
+|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| **proxy_mode**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory`                                                                                                                                                                                                                                                                                                                                                                                                                                    |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
+
+
 ## User datas
 
 ### Example 1
@@ -38,14 +64,101 @@ version: 1.1
 #### Output
 
 ```console
-foo@bar:~$ git switch --detach v1.1_000
+foo@bar:~$ git switch --detach v1.1_001
 foo@bar:~$ rougail -m firefox/ -u yaml -ff config/01/config.yaml
 ```
-<pre>╭─ Caption ─╮
+<pre><span style="font-weight: bold; color: #ff0000">🛑 ERRORS</span>
-│           │
+<span style="color: #ff0000">┗━━ </span>The following variables are mandatory but have no value:
-╰───────────╯
+<span style="color: #ff0000">    </span><span style="color: #ff0000">┗━━ </span>proxy_mode
+</pre>
+### Example 2
+
+#### config/02/config.yaml
+
+
+```yml
+---
+proxy_mode: No proxy
+
+```
+#### Output
+
+```console
+foo@bar:~$ git switch --detach v1.1_001
+foo@bar:~$ rougail -m firefox/ -u yaml -ff config/02/config.yaml
+```
+<pre>╭──────── Caption ────────╮
+│ Variable Modified value │
+╰─────────────────────────╯
 Variables:
+<span style="color: #5c5cff">┗━━ </span>📓 proxy_mode: No proxy ◀ loaded from the YAML file "config/02/config.yaml"
+</pre>
+### Example 3
+
+#### config/03/config.yaml
+
+
+```yml
+---
+proxy_mode: Manual proxy configuration
+
+```
+#### Output
+
+```console
+foo@bar:~$ git switch --detach v1.1_001
+foo@bar:~$ rougail -m firefox/ -u yaml -ff config/03/config.yaml
+```
+<pre>╭──────── Caption ────────╮
+│ Variable Modified value │
+╰─────────────────────────╯
+Variables:
+<span style="color: #5c5cff">┗━━ </span>📓 proxy_mode: Manual proxy configuration ◀ loaded from the YAML file "config/03/config.yaml"
+</pre>
+### Example 4
+
+#### config/04/config.yaml
+
+
+```yml
+---
+proxy_mode: foo
+
+```
+#### Output
+
+```console
+foo@bar:~$ git switch --detach v1.1_001
+foo@bar:~$ rougail -m firefox/ -u yaml -ff config/04/config.yaml
+```
+<pre>╭──────── Caption ────────╮
+│ Variable Modified value │
+╰─────────────────────────╯
+Variables:
+<span style="color: #5c5cff">┗━━ </span>📓 proxy_mode: foo ◀ loaded from the YAML file "config/04/config.yaml"
+</pre>
+### Example 5
+
+#### config/05/config.yaml
+
+
+```yml
+---
+proxy_mode: 1
+
+```
+#### Output
+
+```console
+foo@bar:~$ git switch --detach v1.1_001
+foo@bar:~$ rougail -m firefox/ -u yaml -ff config/05/config.yaml
+```
+<pre><span style="font-weight: bold; color: #ffff00">🔔 WARNINGS</span>
+<span style="color: #ffff00">┗━━ </span>the value "1" is an invalid string for "proxy_mode", which is not a string, it will be ignored when loading from the YAML file "config/05/config.yaml"
+<span style="font-weight: bold; color: #ff0000">🛑 ERRORS</span>
+<span style="color: #ff0000">┗━━ </span>The following variables are mandatory but have no value:
+<span style="color: #ff0000">    </span><span style="color: #ff0000">┗━━ </span>proxy_mode
 </pre>
 
 
-- [[tutorial v1.1_001] A first variable with only a name](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 v1.1_002] Describe the variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_002/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_002~1..v1.1_002))

config/01/output_ro.html

@@ -1,5 +1,4 @@
-<pre>╭─ Caption ─╮
+<pre><span style="font-weight: bold; color: #ff0000">🛑 ERRORS</span>
-│           │
+<span style="color: #ff0000">┗━━ </span>The following variables are mandatory but have no value:
-╰───────────╯
+<span style="color: #ff0000">    </span><span style="color: #ff0000">┗━━ </span>proxy_mode
-Variables:
 </pre>

config/02/config.yaml

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

config/02/output_ro.html

@@ -0,0 +1,6 @@
+<pre>╭──────── Caption ────────╮
+│ Variable Modified value │
+╰─────────────────────────╯
+Variables:
+<span style="color: #5c5cff">┗━━ </span>📓 proxy_mode: No proxy ◀ loaded from the YAML file "config/02/config.yaml"
+</pre>

config/03/config.yaml

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

config/03/output_ro.html

@@ -0,0 +1,6 @@
+<pre>╭──────── Caption ────────╮
+│ Variable Modified value │
+╰─────────────────────────╯
+Variables:
+<span style="color: #5c5cff">┗━━ </span>📓 proxy_mode: Manual proxy configuration ◀ loaded from the YAML file "config/03/config.yaml"
+</pre>

config/04/config.yaml

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

config/04/output_ro.html

@@ -0,0 +1,6 @@
+<pre>╭──────── Caption ────────╮
+│ Variable Modified value │
+╰─────────────────────────╯
+Variables:
+<span style="color: #5c5cff">┗━━ </span>📓 proxy_mode: foo ◀ loaded from the YAML file "config/04/config.yaml"
+</pre>

config/05/config.yaml

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

config/05/output_ro.html

@@ -0,0 +1,6 @@
+<pre><span style="font-weight: bold; color: #ffff00">🔔 WARNINGS</span>
+<span style="color: #ffff00">┗━━ </span>the value "1" is an invalid string for "proxy_mode", which is not a string, it will be ignored when loading from the YAML file "config/05/config.yaml"
+<span style="font-weight: bold; color: #ff0000">🛑 ERRORS</span>
+<span style="color: #ff0000">┗━━ </span>The following variables are mandatory but have no value:
+<span style="color: #ff0000">    </span><span style="color: #ff0000">┗━━ </span>proxy_mode
+</pre>