diff --git a/README.md b/README.md
index 9730dc1f..78054670 100644
--- a/README.md
+++ b/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**
[`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 | Description |
+|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| **proxy_mode**
[`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
```
-
╭─ Caption ─╮ -│ │ -╰───────────╯ +🛑 ERRORS +┗━━ The following variables are mandatory but have no value: + ┗━━ proxy_mode ++### 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 +``` +╭──────── Caption ────────╮ +│ Variable Modified value │ +╰─────────────────────────╯ Variables: +┗━━ 📓 proxy_mode: No proxy ◀ loaded from the YAML file "config/02/config.yaml" ++### 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 +``` +╭──────── Caption ────────╮ +│ Variable Modified value │ +╰─────────────────────────╯ +Variables: +┗━━ 📓 proxy_mode: Manual proxy configuration ◀ loaded from the YAML file "config/03/config.yaml" ++### 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 +``` +╭──────── Caption ────────╮ +│ Variable Modified value │ +╰─────────────────────────╯ +Variables: +┗━━ 📓 proxy_mode: foo ◀ loaded from the YAML file "config/04/config.yaml" ++### 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 +``` +🔔 WARNINGS +┗━━ 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" +🛑 ERRORS +┗━━ The following variables are mandatory but have no value: + ┗━━ proxy_mode-- [[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)) diff --git a/config/01/output_ro.html b/config/01/output_ro.html index b3c7713f..45f12184 100644 --- a/config/01/output_ro.html +++ b/config/01/output_ro.html @@ -1,5 +1,4 @@ -╭─ Caption ─╮ -│ │ -╰───────────╯ -Variables: +🛑 ERRORS +┗━━ The following variables are mandatory but have no value: + ┗━━ proxy_modediff --git a/config/02/config.yaml b/config/02/config.yaml new file mode 100644 index 00000000..d9144882 --- /dev/null +++ b/config/02/config.yaml @@ -0,0 +1,2 @@ +--- +proxy_mode: No proxy diff --git a/config/02/output_ro.html b/config/02/output_ro.html new file mode 100644 index 00000000..34c6e753 --- /dev/null +++ b/config/02/output_ro.html @@ -0,0 +1,6 @@ +╭──────── Caption ────────╮ +│ Variable Modified value │ +╰─────────────────────────╯ +Variables: +┗━━ 📓 proxy_mode: No proxy ◀ loaded from the YAML file "config/02/config.yaml" +diff --git a/config/03/config.yaml b/config/03/config.yaml new file mode 100644 index 00000000..74edb225 --- /dev/null +++ b/config/03/config.yaml @@ -0,0 +1,2 @@ +--- +proxy_mode: Manual proxy configuration diff --git a/config/03/output_ro.html b/config/03/output_ro.html new file mode 100644 index 00000000..92761293 --- /dev/null +++ b/config/03/output_ro.html @@ -0,0 +1,6 @@ +╭──────── Caption ────────╮ +│ Variable Modified value │ +╰─────────────────────────╯ +Variables: +┗━━ 📓 proxy_mode: Manual proxy configuration ◀ loaded from the YAML file "config/03/config.yaml" +diff --git a/config/04/config.yaml b/config/04/config.yaml new file mode 100644 index 00000000..e3fa25da --- /dev/null +++ b/config/04/config.yaml @@ -0,0 +1,2 @@ +--- +proxy_mode: foo diff --git a/config/04/output_ro.html b/config/04/output_ro.html new file mode 100644 index 00000000..6f357059 --- /dev/null +++ b/config/04/output_ro.html @@ -0,0 +1,6 @@ +╭──────── Caption ────────╮ +│ Variable Modified value │ +╰─────────────────────────╯ +Variables: +┗━━ 📓 proxy_mode: foo ◀ loaded from the YAML file "config/04/config.yaml" +diff --git a/config/05/config.yaml b/config/05/config.yaml new file mode 100644 index 00000000..bf6f64ca --- /dev/null +++ b/config/05/config.yaml @@ -0,0 +1,2 @@ +--- +proxy_mode: 1 diff --git a/config/05/output_ro.html b/config/05/output_ro.html new file mode 100644 index 00000000..4c1bcec9 --- /dev/null +++ b/config/05/output_ro.html @@ -0,0 +1,6 @@ +🔔 WARNINGS +┗━━ 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" +🛑 ERRORS +┗━━ The following variables are mandatory but have no value: + ┗━━ proxy_mode +diff --git a/firefox.png b/firefox.png index 050f837f..45725ac6 100644 Binary files a/firefox.png and b/firefox.png differ