stove/rougail-tutorials
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

[tutorial v1.1_011)] Describe the variable (config and doc)

Browse source
This commit is contained in:
egarette@silique.fr 2025-11-07 06:16:07 +01:00
parent 0fa0e87ebb
commit 7bdd0bc65c
6 changed files with 27 additions and 27 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

42
README.md
View file

@ -1,9 +1,9 @@
- [Summary](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/branch/1.1/README.md) - [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 ## Screenshot
@ -23,31 +23,31 @@
--- ---
version: 1.1 version: 1.1
proxy_mode: proxy_mode: # Configure Proxy Access to the Internet
... ...
``` ```
### Let's generate the documentation ### Let's generate the documentation
```console ```console
foo@bar:~$ git switch --detach v1.1_010 foo@bar:~$ git switch --detach v1.1_011
foo@bar:~$ rougail -m firefox/ -o doc foo@bar:~$ rougail -m firefox/ -o doc
``` ```
| Variable                                                                                        | Description                                                                                     | | Variable                                                                                        | Description                                                                                     |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **proxy_mode**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | | | **proxy_mode**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Configure Proxy Access to the Internet. |
### Let's generate the changelog ### Let's generate the changelog
```console ```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 foo@bar:~$ rougail -m firefox/ -o doc --doc.contents changelog
``` ```
#### New variable #### Modified 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; | | 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` | | | **proxy_mode**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | <ins>Configure Proxy Access to the Internet.</ins> |
## User datas ## User datas
@ -64,12 +64,12 @@ foo@bar:~$ rougail -m firefox/ -o doc --doc.contents changelog
#### Output #### Output
```console ```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 foo@bar:~$ rougail -m firefox/ -u yaml -ff config/01/config.yaml
``` ```
<pre><span style="font-weight: bold; color: #ff0000">🛑 ERRORS</span> <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>The following variables are mandatory but have no value:
<span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>proxy_mode <span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>Configure Proxy Access to the Internet
</pre> </pre>
### Example 2 ### Example 2
@ -84,14 +84,14 @@ proxy_mode: No proxy
#### Output #### Output
```console ```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 foo@bar:~$ rougail -m firefox/ -u yaml -ff config/02/config.yaml
``` ```
<pre>╭──────── Caption ────────╮ <pre>╭──────── Caption ────────╮
│ Variable Modified value │ │ Variable Modified value │
╰─────────────────────────╯ ╰─────────────────────────╯
Variables: Variables:
<span style="color: #5c5cff">┗━━ </span>📓 proxy_mode: No proxy ◀ loaded from the YAML file "config/02/config.yaml" <span style="color: #5c5cff">┗━━ </span>📓 Configure Proxy Access to the Internet: No proxy ◀ loaded from the YAML file "config/02/config.yaml"
</pre> </pre>
### Example 3 ### Example 3
@ -106,14 +106,14 @@ proxy_mode: Manual proxy configuration
#### Output #### Output
```console ```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 foo@bar:~$ rougail -m firefox/ -u yaml -ff config/03/config.yaml
``` ```
<pre>╭──────── Caption ────────╮ <pre>╭──────── Caption ────────╮
│ Variable Modified value │ │ Variable Modified value │
╰─────────────────────────╯ ╰─────────────────────────╯
Variables: Variables:
<span style="color: #5c5cff">┗━━ </span>📓 proxy_mode: Manual proxy configuration ◀ loaded from the YAML file "config/03/config.yaml" <span style="color: #5c5cff">┗━━ </span>📓 Configure Proxy Access to the Internet: Manual proxy configuration ◀ loaded from the YAML file "config/03/config.yaml"
</pre> </pre>
### Example 4 ### Example 4
@ -128,14 +128,14 @@ proxy_mode: foo
#### Output #### Output
```console ```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 foo@bar:~$ rougail -m firefox/ -u yaml -ff config/04/config.yaml
``` ```
<pre>╭──────── Caption ────────╮ <pre>╭──────── Caption ────────╮
│ Variable Modified value │ │ Variable Modified value │
╰─────────────────────────╯ ╰─────────────────────────╯
Variables: Variables:
<span style="color: #5c5cff">┗━━ </span>📓 proxy_mode: foo ◀ loaded from the YAML file "config/04/config.yaml" <span style="color: #5c5cff">┗━━ </span>📓 Configure Proxy Access to the Internet: foo ◀ loaded from the YAML file "config/04/config.yaml"
</pre> </pre>
### Example 5 ### Example 5
@ -150,15 +150,15 @@ proxy_mode: 1
#### Output #### Output
```console ```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 foo@bar:~$ rougail -m firefox/ -u yaml -ff config/05/config.yaml
``` ```
<pre><span style="font-weight: bold; color: #ffff00">🔔 WARNINGS</span> <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="color: #ffff00">┗━━ </span>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"
<span style="font-weight: bold; color: #ff0000">🛑 ERRORS</span> <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>The following variables are mandatory but have no value:
<span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>proxy_mode <span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>Configure Proxy Access to the Internet
</pre> </pre>
- [[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))

2
config/01/output_ro.html
View file

@ -1,4 +1,4 @@
<pre><span style="font-weight: bold; color: #ff0000">🛑 ERRORS</span> <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>The following variables are mandatory but have no value:
<span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>proxy_mode <span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>Configure Proxy Access to the Internet
</pre> </pre>

2
config/02/output_ro.html
View file

@ -2,5 +2,5 @@
│ Variable Modified value │ │ Variable Modified value │
╰─────────────────────────╯ ╰─────────────────────────╯
Variables: Variables:
<span style="color: #5c5cff">┗━━ </span>📓 proxy_mode: No proxy ◀ loaded from the YAML file "config/02/config.yaml" <span style="color: #5c5cff">┗━━ </span>📓 Configure Proxy Access to the Internet: No proxy ◀ loaded from the YAML file "config/02/config.yaml"
</pre> </pre>

2
config/03/output_ro.html
View file

@ -2,5 +2,5 @@
│ Variable Modified value │ │ Variable Modified value │
╰─────────────────────────╯ ╰─────────────────────────╯
Variables: Variables:
<span style="color: #5c5cff">┗━━ </span>📓 proxy_mode: Manual proxy configuration ◀ loaded from the YAML file "config/03/config.yaml" <span style="color: #5c5cff">┗━━ </span>📓 Configure Proxy Access to the Internet: Manual proxy configuration ◀ loaded from the YAML file "config/03/config.yaml"
</pre> </pre>

2
config/04/output_ro.html
View file

@ -2,5 +2,5 @@
│ Variable Modified value │ │ Variable Modified value │
╰─────────────────────────╯ ╰─────────────────────────╯
Variables: Variables:
<span style="color: #5c5cff">┗━━ </span>📓 proxy_mode: foo ◀ loaded from the YAML file "config/04/config.yaml" <span style="color: #5c5cff">┗━━ </span>📓 Configure Proxy Access to the Internet: foo ◀ loaded from the YAML file "config/04/config.yaml"
</pre> </pre>

4
config/05/output_ro.html
View file

@ -1,6 +1,6 @@
<pre><span style="font-weight: bold; color: #ffff00">🔔 WARNINGS</span> <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="color: #ffff00">┗━━ </span>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"
<span style="font-weight: bold; color: #ff0000">🛑 ERRORS</span> <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>The following variables are mandatory but have no value:
<span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>proxy_mode <span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>Configure Proxy Access to the Internet
</pre> </pre>