diff --git a/README.md b/README.md
index ed6c98bf..106b73c1 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +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_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))
-# [tutorial v1.1_010)] A first variable with only a name
+# [tutorial v1.1_011)] Describe the variable
-[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_010~1..v1.1_010)
+[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_011~1..v1.1_011)
## Screenshot
@@ -23,31 +23,31 @@
---
version: 1.1
-proxy_mode:
+proxy_mode: # Configure Proxy Access to the Internet
...
```
### Let's generate the documentation
```console
-foo@bar:~$ git switch --detach v1.1_010
+foo@bar:~$ git switch --detach v1.1_011
foo@bar:~$ rougail -m firefox/ -o doc
```
| Variable | Description |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| **proxy_mode**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | |
+| **proxy_mode**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Configure Proxy Access to the Internet. |
### Let's generate the changelog
```console
-foo@bar:~$ git switch --detach v1.1_010
+foo@bar:~$ git switch --detach v1.1_011
foo@bar:~$ rougail -m firefox/ -o doc --doc.contents changelog
```
-#### New variable
+#### Modified variable
| Variable | Description |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| **proxy_mode**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | |
+| **proxy_mode**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Configure Proxy Access to the Internet. |
## User datas
@@ -64,12 +64,12 @@ foo@bar:~$ rougail -m firefox/ -o doc --doc.contents changelog
#### Output
```console
-foo@bar:~$ git switch --detach v1.1_010
+foo@bar:~$ git switch --detach v1.1_011
foo@bar:~$ rougail -m firefox/ -u yaml -ff config/01/config.yaml
```
🛑 ERRORS ┗━━ The following variables are mandatory but have no value: - ┗━━ proxy_mode + ┗━━ Configure Proxy Access to the Internet### Example 2 @@ -84,14 +84,14 @@ proxy_mode: No proxy #### Output ```console -foo@bar:~$ git switch --detach v1.1_010 +foo@bar:~$ git switch --detach v1.1_011 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" +┗━━ 📓 Configure Proxy Access to the Internet: No proxy ◀ loaded from the YAML file "config/02/config.yaml"### Example 3 @@ -106,14 +106,14 @@ proxy_mode: Manual proxy configuration #### Output ```console -foo@bar:~$ git switch --detach v1.1_010 +foo@bar:~$ git switch --detach v1.1_011 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" +┗━━ 📓 Configure Proxy Access to the Internet: Manual proxy configuration ◀ loaded from the YAML file "config/03/config.yaml"### Example 4 @@ -128,14 +128,14 @@ proxy_mode: foo #### Output ```console -foo@bar:~$ git switch --detach v1.1_010 +foo@bar:~$ git switch --detach v1.1_011 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" +┗━━ 📓 Configure Proxy Access to the Internet: foo ◀ loaded from the YAML file "config/04/config.yaml"### Example 5 @@ -150,15 +150,15 @@ proxy_mode: 1 #### Output ```console -foo@bar:~$ git switch --detach v1.1_010 +foo@bar:~$ git switch --detach v1.1_011 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" +┗━━ the value "1" is an invalid string for "proxy_mode" (Configure Proxy Access to the Internet), 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 + ┗━━ Configure Proxy Access to the Internet-- [[tutorial v1.1_011] Describe the variable](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)) +- [[tutorial v1.1_012] Set a default value](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_012/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_012~1..v1.1_012)) diff --git a/config/01/output_ro.html b/config/01/output_ro.html index 45f12184..7ef594fb 100644 --- a/config/01/output_ro.html +++ b/config/01/output_ro.html @@ -1,4 +1,4 @@
🛑 ERRORS ┗━━ The following variables are mandatory but have no value: - ┗━━ proxy_mode + ┗━━ Configure Proxy Access to the Internetdiff --git a/config/02/output_ro.html b/config/02/output_ro.html index 34c6e753..873a28a0 100644 --- a/config/02/output_ro.html +++ b/config/02/output_ro.html @@ -2,5 +2,5 @@ │ Variable Modified value │ ╰─────────────────────────╯ Variables: -┗━━ 📓 proxy_mode: No proxy ◀ loaded from the YAML file "config/02/config.yaml" +┗━━ 📓 Configure Proxy Access to the Internet: No proxy ◀ loaded from the YAML file "config/02/config.yaml" diff --git a/config/03/output_ro.html b/config/03/output_ro.html index 92761293..d1b32109 100644 --- a/config/03/output_ro.html +++ b/config/03/output_ro.html @@ -2,5 +2,5 @@ │ Variable Modified value │ ╰─────────────────────────╯ Variables: -┗━━ 📓 proxy_mode: Manual proxy configuration ◀ loaded from the YAML file "config/03/config.yaml" +┗━━ 📓 Configure Proxy Access to the Internet: Manual proxy configuration ◀ loaded from the YAML file "config/03/config.yaml" diff --git a/config/04/output_ro.html b/config/04/output_ro.html index 6f357059..25cead20 100644 --- a/config/04/output_ro.html +++ b/config/04/output_ro.html @@ -2,5 +2,5 @@ │ Variable Modified value │ ╰─────────────────────────╯ Variables: -┗━━ 📓 proxy_mode: foo ◀ loaded from the YAML file "config/04/config.yaml" +┗━━ 📓 Configure Proxy Access to the Internet: foo ◀ loaded from the YAML file "config/04/config.yaml" diff --git a/config/05/output_ro.html b/config/05/output_ro.html index 4c1bcec9..0f885343 100644 --- a/config/05/output_ro.html +++ b/config/05/output_ro.html @@ -1,6 +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" +┗━━ the value "1" is an invalid string for "proxy_mode" (Configure Proxy Access to the Internet), 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 + ┗━━ Configure Proxy Access to the Internet