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

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

Browse source
This commit is contained in:
egarette@silique.fr 2026-01-08 20:21:57 +01:00
parent bc0b9e0260
commit 233681d99a
9 changed files with 43 additions and 52 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

63
README.md
View file

@ -1,11 +1,11 @@
- [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] Creating a structure file](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_001] Let’s add our first variable](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_001] Let’s add our first variable # [tutorial v1.1_002] Describe the variable
[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_002~1..v1.1_002)
[Read the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/preliminary.html#let-s-add-our-first-variable) [Read the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/preliminary.html#describe-the-variable)
## Screenshot ## Screenshot
@ -31,7 +31,7 @@ pip install rougail-cli rougail-output-exporter rougail-output-doc rougail-user-
Then switch to the tutorial page: Then switch to the tutorial page:
```shell ```shell
git switch --detach v1.1_001 git switch --detach v1.1_002
``` ```
## Structure ## Structure
@ -39,9 +39,9 @@ git switch --detach v1.1_001
<p> <p>
<a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_001/./">.</a><br/> <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_002/./">.</a><br/>
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_001/./firefox/">firefox</a><br/> └── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_002/./firefox/">firefox</a><br/>
    └── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_001/./firefox/00-proxy.yml">00-proxy.yml</a><br/>     └── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_002/./firefox/00-proxy.yml">00-proxy.yml</a><br/>
<br/><br/></p> <br/><br/></p>
Contents of the firefox/00-proxy.yml file Contents of the firefox/00-proxy.yml file
@ -51,7 +51,7 @@ Contents of the firefox/00-proxy.yml file
--- ---
version: 1.1 version: 1.1
proxy_mode: proxy_mode: # Configure Proxy Access to the Internet
... ...
``` ```
@ -62,9 +62,9 @@ proxy_mode:
```shell ```shell
rougail -m firefox/ -o doc rougail -m firefox/ -o doc
``` ```
| Variable | | Variable | Description |
|------------------------------------------------------------------------------------------------------------------------------------------------------------| |------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------|
| **<a id="proxy_mode" name="proxy_mode">proxy_mode</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | | **<a id="proxy_mode" name="proxy_mode">proxy_mode</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Configure Proxy Access to the Internet. |
*** ***
@ -73,11 +73,11 @@ rougail -m firefox/ -o doc
```shell ```shell
rougail -m firefox/ -o doc --doc.contents changelog rougail -m firefox/ -o doc --doc.contents changelog
``` ```
#### New variable #### Modified variable
| Variable | | Variable | Description |
|------------------------------------------------------------------------------------------------------------------------------------------------------------| |------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------|
| **<a id="proxy_mode" name="proxy_mode">proxy_mode</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | | **<a id="proxy_mode" name="proxy_mode">proxy_mode</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | <ins>Configure Proxy Access to the Internet.</ins> |
*** ***
@ -100,7 +100,7 @@ rougail -m firefox/ -u yaml -yf config/01/config.yml
``` ```
> [!CAUTION] > [!CAUTION]
> >
> - proxy_mode: :stop_sign: <span style="color: #C23636">mandatory variable but has no value</span> > - proxy_mode (Configure Proxy Access to the Internet): :stop_sign: <span style="color: #C23636">mandatory variable but has no value</span>
*** ***
#### Output in read write mode #### Output in read write mode
@ -115,7 +115,7 @@ rougail -m firefox/ -u yaml -yf config/01/config.yml --cli.read_write
> - <span style="color: #B8860B">Default value</span> > - <span style="color: #B8860B">Default value</span>
Variables: Variables:
- :notebook: proxy_mode: <span style="color: #B8860B">null</span> - :notebook: proxy_mode (Configure Proxy Access to the Internet): <span style="color: #B8860B">null</span>
*** ***
### Example 2 ### Example 2
@ -141,7 +141,7 @@ rougail -m firefox/ -u yaml -yf config/02/config.yml
> - <span style="color: #006400">Modified value</span> > - <span style="color: #006400">Modified value</span>
Variables: Variables:
- :notebook: proxy_mode: <span style="color: #006400">No proxy</span> ← loaded from the YAML file "config/02/config.yml" - :notebook: proxy_mode (Configure Proxy Access to the Internet): <span style="color: #006400">No proxy</span> ← loaded from the YAML file "config/02/config.yml"
*** ***
### Example 3 ### Example 3
@ -151,7 +151,7 @@ Variables:
```yml ```yml
--- ---
proxy_mode: 1 proxy_mode: foo
``` ```
*** ***
@ -160,23 +160,16 @@ proxy_mode: 1
```shell ```shell
rougail -m firefox/ -u yaml -yf config/03/config.yml rougail -m firefox/ -u yaml -yf config/03/config.yml
``` ```
> [!CAUTION] > [!NOTE]
> >
> - proxy_mode > **Caption:**
> - [#EFBF04]:bell: the value "1" is an invalid string, it's not a string, it will be ignored when loading from the YAML file "config/03/config.yml"[/#EFBF04] > - Variable
> - [#C23636]:stop_sign: mandatory variable but has no value[/#C23636] > - <span style="color: #006400">Modified value</span>
*** Variables:
#### Output when invalid user data is an error - :notebook: proxy_mode (Configure Proxy Access to the Internet): <span style="color: #006400">foo</span> ← loaded from the YAML file "config/03/config.yml"
```shell
rougail -m firefox/ -u yaml -yf config/03/config.yml --cli.invalid_user_data_error
```
> [!CAUTION]
>
> - proxy_mode: :stop_sign: <span style="color: #C23636">the value "1" is an invalid string, it's not a string, it has been loading from the YAML file "config/03/config.yml"</span>
*** ***
- [[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)) - [[tutorial v1.1_003] Set a default value](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_003/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_003~1..v1.1_003))

3
config/01/output_ro.html
View file

@ -1,3 +1,4 @@
<pre><span style="font-weight: bold; color: #ff0000">🛑 Caution</span> <pre><span style="font-weight: bold; color: #ff0000">🛑 Caution</span>
<span style="color: #ff0000">┗━━ </span>proxy_mode: <span style="color: #ff0000">🛑 mandatory variable but has no value</span> <span style="color: #ff0000">┗━━ </span>proxy_mode (Configure Proxy Access to the Internet): <span style="color: #ff0000">🛑 mandatory variable </span>
<span style="color: #ff0000"> </span><span style="color: #ff0000">but has no value</span>
</pre> </pre>

2
config/01/output_rw.html
View file

@ -5,5 +5,5 @@
&gt; - &lt;span style="color: #B8860B"&gt;Default value&lt;/span&gt; &gt; - &lt;span style="color: #B8860B"&gt;Default value&lt;/span&gt;
Variables: Variables:
- :notebook: proxy_mode: &lt;span style="color: #B8860B"&gt;null&lt;/span&gt; - :notebook: proxy_mode (Configure Proxy Access to the Internet): &lt;span style="color: #B8860B"&gt;null&lt;/span&gt;
</pre> </pre>

3
config/02/output_ro.html
View file

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

1
config/03/cmd_invalid.txt
View file

@ -1 +0,0 @@
rougail -m firefox/ -u yaml -yf config/03/config.yml --cli.invalid_user_data_error

2
config/03/config.yml
View file

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

4
config/03/output_invalid.html
View file

@ -1,4 +0,0 @@
<pre><span style="font-weight: bold; color: #ff0000">🛑 Caution</span>
<span style="color: #ff0000">┗━━ </span>proxy_mode: <span style="color: #ff0000">🛑 the value "1" is an invalid string, it's not a string, it has</span>
<span style="color: #ff0000"> </span><span style="color: #ff0000">been loading from the YAML file "config/03/config.yml"</span>
</pre>

11
config/03/output_ro.html
View file

@ -1,6 +1,7 @@
<pre><span style="font-weight: bold; color: #ff0000">🛑 Caution</span> <pre>╭──────── Caption ────────╮
<span style="color: #ff0000">┗━━ </span>proxy_mode │ Variable <span style="color: #00aa00">Modified value</span> │
<span style="color: #ff0000"> </span><span style="color: #ff0000">┣━━ </span><span style="color: #ffff00">🔔 the value "1" is an invalid string, it's not a string, it will be </span> ╰─────────────────────────╯
<span style="color: #ff0000"> </span><span style="color: #ff0000">┃ </span><span style="color: #ffff00">ignored when loading from the YAML file "config/03/config.yml"</span> Variables:
<span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span><span style="color: #ff0000">🛑 mandatory variable but has no value</span> <span style="color: #5c5cff">┗━━ </span>📓 proxy_mode (Configure Proxy Access to the Internet): <span style="color: #00aa00">foo</span> ◀ loaded from
<span style="color: #5c5cff"> </span>the YAML file "config/03/config.yml"
</pre> </pre>

6
tree.html
View file

@ -1,5 +1,5 @@
<p> <p>
<a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_001/./">.</a><br/> <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_002/./">.</a><br/>
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_001/./firefox/">firefox</a><br/> └── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_002/./firefox/">firefox</a><br/>
    └── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_001/./firefox/00-proxy.yml">00-proxy.yml</a><br/>     └── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_002/./firefox/00-proxy.yml">00-proxy.yml</a><br/>
<br/><br/></p> <br/><br/></p>