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

[tutorial v1.1_001] Let’s add our first variable (config and doc)

Browse source
This commit is contained in:
egarette@silique.fr 2025-12-02 16:18:18 +01:00
parent 6a922afed4
commit 5c5f47e9bc
14 changed files with 135 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

106
README.md
View file

@ -1,10 +1,11 @@
- [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_000] Creating a structure file
# [tutorial v1.1_001] Let’s add our first variable
[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)
[Read the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/preliminary.html#creating-a-structure-file)
[Read the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/preliminary.html#let-s-add-our-first-variable)
## Screenshot
@ -30,7 +31,7 @@ pip install rougail-cli rougail-output-exporter rougail-output-doc rougail-user-
Then switch to the tutorial page:
```shell
git switch --detach v1.1_000
git switch --detach v1.1_001
```
## Structure
@ -38,9 +39,9 @@ git switch --detach v1.1_000
<p>
<a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_000/./">.</a><br/>
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_000/./firefox/">firefox</a><br/>
    └── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_000/./firefox/00-proxy.yml">00-proxy.yml</a><br/>
<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_001/./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/>
<br/><br/></p>
Contents of the firefox/00-proxy.yml file
@ -49,9 +50,32 @@ Contents of the firefox/00-proxy.yml file
%YAML 1.2
---
version: 1.1
proxy_mode:
...
```
### Let's generate the documentation
```shell
rougail -m firefox/ -o doc
```
| Variable |
|------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **<a id="proxy_mode" name="proxy_mode">proxy_mode</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` |
### Let's generate the changelog
```shell
rougail -m firefox/ -o doc --doc.contents changelog
```
#### New variable
| Variable |
|------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **<a id="proxy_mode" name="proxy_mode">proxy_mode</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` |
## User datas
### Example 1
@ -67,7 +91,71 @@ version: 1.1
```shell
rougail -m firefox/ -u yaml -yf config/01/config.yml
```
<pre></pre>
<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>
#### Output in read write mode
```shell
rougail -m firefox/ -u yaml -yf config/01/config.yml --cli.read_write
```
<pre>╭──────────────────── Caption ─────────────────────╮
│ <span style="color: #ff0000">Undocumented but modified variable</span> <span style="color: #ffd700">Default value</span> │
╰──────────────────────────────────────────────────╯
Variables:
<span style="color: #5c5cff">┗━━ </span>📓 <span style="color: #ff0000">proxy_mode</span>: <span style="color: #ffd700">null</span>
</pre>
### Example 2
#### config/02/config.yml
- [[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))
```yml
---
proxy_mode: No proxy
```
#### Output
```shell
rougail -m firefox/ -u yaml -yf config/02/config.yml
```
<pre>╭───────────────────── Caption ─────────────────────╮
│ <span style="color: #ff0000">Undocumented but modified variable</span> <span style="color: #00aa00">Modified value</span> │
╰───────────────────────────────────────────────────╯
Variables:
<span style="color: #5c5cff">┗━━ </span>📓 <span style="color: #ff0000">proxy_mode</span>: <span style="color: #00aa00">No proxy</span> ◀ loaded from the YAML file "config/02/config.yml"
</pre>
### Example 3
#### config/03/config.yml
```yml
---
proxy_mode: 1
```
#### Output
```shell
rougail -m firefox/ -u yaml -yf config/03/config.yml
```
<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,
<span style="color: #ffff00"> </span>it will be ignored when loading from the YAML file "config/03/config.yml"
<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>
#### Output when invalid user datas is an error
```shell
rougail -m firefox/ -u yaml -yf config/03/config.yml --cli.invalid_user_datas_error
```
<pre><span style="font-weight: bold; color: #ff0000">🛑 ERRORS</span>
<span style="color: #ff0000">┗━━ </span>the value "1" is an invalid string for "proxy_mode", which is not a string,
<span style="color: #ff0000"> </span>it will be ignored when loading from the YAML file "config/03/config.yml"
</pre>
- [[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))

1
config/01/cmd_rw.txt Normal file
View file

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

5
config/01/output_ro.html
View file

@ -1 +1,4 @@
<pre></pre>
<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>

6
config/01/output_rw.html Normal file
View file

@ -0,0 +1,6 @@
<pre>╭──────────────────── Caption ─────────────────────╮
│ <span style="color: #ff0000">Undocumented but modified variable</span> <span style="color: #ffd700">Default value</span> │
╰──────────────────────────────────────────────────╯
Variables:
<span style="color: #5c5cff">┗━━ </span>📓 <span style="color: #ff0000">proxy_mode</span>: <span style="color: #ffd700">null</span>
</pre>

1
config/02/cmd_ro.txt Normal file
View file

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

2
config/02/config.yml Normal file
View file

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

6
config/02/output_ro.html Normal file
View file

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

1
config/03/cmd_invalid.txt Normal file
View file

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

1
config/03/cmd_ro.txt Normal file
View file

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

2
config/03/config.yml Normal file
View file

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

4
config/03/output_invalid.html Normal file
View file

@ -0,0 +1,4 @@
<pre><span style="font-weight: bold; color: #ff0000">🛑 ERRORS</span>
<span style="color: #ff0000">┗━━ </span>the value "1" is an invalid string for "proxy_mode", which is not a string,
<span style="color: #ff0000"> </span>it will be ignored when loading from the YAML file "config/03/config.yml"
</pre>

7
config/03/output_ro.html Normal file
View file

@ -0,0 +1,7 @@
<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,
<span style="color: #ffff00"> </span>it will be ignored when loading from the YAML file "config/03/config.yml"
<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>

BIN
firefox.png
View file

Binary file not shown.
Side by side Swipe Overlay

Before

Width:  |  Height:  |  Size: 123 KiB

After

Width:  |  Height:  |  Size: 119 KiB

6
tree.html
View file

@ -25,9 +25,9 @@
</head>
<body>
<h1>Directory Tree</h1><p>
<a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_000/./">.</a><br>
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_000/./firefox/">firefox</a><br>
&nbsp;&nbsp;&nbsp; └── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_000/./firefox/00-proxy.yml">00-proxy.yml</a><br>
<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_001/./firefox/">firefox</a><br>
&nbsp;&nbsp;&nbsp; └── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_001/./firefox/00-proxy.yml">00-proxy.yml</a><br>
<br><br><p>
2 directories, 1 file