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

[tutorial v1.1_020] Creating a new family (config and doc)

Browse source
This commit is contained in:
egarette@silique.fr 2025-12-02 16:18:24 +01:00
parent 54da5c2fd5
commit 87694dd4c2
17 changed files with 19 additions and 191 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

148
README.md
View file

@ -1,11 +1,11 @@
- [Summary](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/branch/1.1/README.md)
- [[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))
- [[tutorial v1.1_010] A variable with a list of possible values](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 variable with a list of possible values
# [tutorial v1.1_020] Creating a new family
[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_020~1..v1.1_020)
[Read the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/preliminary.html#a-variable-with-a-list-of-possible-values)
[Read the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/proxymode.html#creating-a-new-family)
## Screenshot
@ -31,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_010
git switch --detach v1.1_020
```
## Structure
@ -39,27 +39,22 @@ git switch --detach v1.1_010
<p>
<a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_010/./">.</a><br/>
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_010/./firefox/">firefox</a><br/>
    └── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_010/./firefox/00-proxy.yml">00-proxy.yml</a><br/>
<a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_020/./">.</a><br/>
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_020/./firefox/">firefox</a><br/>
    ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_020/./firefox/00-proxy.yml">00-proxy.yml</a><br/>
    └── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_020/./firefox/10-manual.yml">10-manual.yml</a><br/>
<br/><br/></p>
Contents of the firefox/00-proxy.yml file
Contents of the firefox/10-manual.yml file
```yml
%YAML 1.2
---
version: 1.1
proxy_mode:
description: Configure Proxy Access to the Internet
choices:
- No proxy
- Auto-detect proxy settings for this network
- Use system proxy settings
- Manual proxy configuration
- Automatic proxy configuration URL
default: No proxy
manual:
description: Manual proxy configuration
type: family
...
```
@ -72,121 +67,6 @@ rougail -m firefox/ -o doc
|------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **<a id="proxy_mode" name="proxy_mode">proxy_mode</a>**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Configure Proxy Access to the Internet.<br/>**Choices**: <br/>•&nbsp;No proxy **← (default)**<br/>•&nbsp;Auto-detect proxy settings for this network<br/>•&nbsp;Use system proxy settings<br/>•&nbsp;Manual proxy configuration<br/>•&nbsp;Automatic proxy configuration URL |
### Let's generate the changelog
```shell
rougail -m firefox/ -o doc --doc.contents changelog
```
#### Modified variable
| Variable | Description |
|------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **<a id="proxy_mode" name="proxy_mode">proxy_mode</a>**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Configure Proxy Access to the Internet.<br/>**Choices**: <br/>•&nbsp;No proxy **← (default)**<br/>•&nbsp;<ins>Auto-detect proxy settings for this network</ins><br/>•&nbsp;<ins>Use system proxy settings</ins><br/>•&nbsp;<ins>Manual proxy configuration</ins><br/>•&nbsp;<ins>Automatic proxy configuration URL</ins> |
## User datas
### Example 1
#### config/01/config.yml
```yml
---
```
#### Output
```shell
rougail -m firefox/ -u yaml -yf config/01/config.yml
```
<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">Configure Proxy Access to the Internet</span>: <span style="color: #ffd700">No proxy</span>
</pre>
### Example 2
#### config/02/config.yml
```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> │
│ (⏳ Original default value) │
╰────────────────────────────────────────────────────────────────╯
Variables:
<span style="color: #5c5cff">┗━━ </span>📓 <span style="color: #ff0000">Configure Proxy Access to the Internet</span>: <span style="color: #00aa00">No proxy</span> ◀ loaded from the YAML
<span style="color: #5c5cff"> </span>file "config/02/config.yml" (⏳ No proxy)
</pre>
### Example 3
#### config/03/config.yml
```yml
---
proxy_mode: Manual proxy configuration
```
#### Output
```shell
rougail -m firefox/ -u yaml -yf config/03/config.yml
```
<pre>╭─────────────────────────── Caption ────────────────────────────╮
│ <span style="color: #ff0000">Undocumented but modified variable</span> <span style="color: #00aa00">Modified value</span> │
│ (⏳ Original default value) │
╰────────────────────────────────────────────────────────────────╯
Variables:
<span style="color: #5c5cff">┗━━ </span>📓 <span style="color: #ff0000">Configure Proxy Access to the Internet</span>: <span style="color: #00aa00">Manual proxy configuration</span> ◀
<span style="color: #5c5cff"> </span>loaded from the YAML file "config/03/config.yml" (⏳ No proxy)
</pre>
### Example 4
#### config/04/config.yml
```yml
---
proxy_mode: foo
```
#### Output
```shell
rougail -m firefox/ -u yaml -yf config/04/config.yml
```
<pre><span style="font-weight: bold; color: #ffff00">🔔 WARNINGS</span>
<span style="color: #ffff00">┗━━ </span>the value "foo" is an invalid choice for "proxy_mode" (Configure Proxy
<span style="color: #ffff00"> </span>Access to the Internet), only "Auto-detect proxy settings for this network",
<span style="color: #ffff00"> </span>"Automatic proxy configuration URL", "Manual proxy configuration", "No
<span style="color: #ffff00"> </span>proxy" and "Use system proxy settings" are allowed, it will be ignored when
<span style="color: #ffff00"> </span>loading from the YAML file "config/04/config.yml"
╭──────────────────── 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">Configure Proxy Access to the Internet</span>: <span style="color: #ffd700">No proxy</span>
</pre>
#### Output when invalid user datas is an error
```shell
rougail -m firefox/ -u yaml -yf config/04/config.yml --cli.invalid_user_datas_error
```
<pre><span style="font-weight: bold; color: #ff0000">🛑 ERRORS</span>
<span style="color: #ff0000">┗━━ </span>the value "foo" is an invalid choice for "proxy_mode" (Configure Proxy
<span style="color: #ff0000"> </span>Access to the Internet), only "Auto-detect proxy settings for this network",
<span style="color: #ff0000"> </span>"Automatic proxy configuration URL", "Manual proxy configuration", "No
<span style="color: #ff0000"> </span>proxy" and "Use system proxy settings" are allowed, it will be ignored when
<span style="color: #ff0000"> </span>loading from the YAML file "config/04/config.yml"
</pre>
- [[tutorial v1.1_020] Creating a new family](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_020/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_020~1..v1.1_020))
- [[tutorial v1.1_021] Or a sub family](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_021/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_021~1..v1.1_021))

1
config/01/cmd_ro.txt
View file

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

1
config/01/config.yml
View file

@ -1 +0,0 @@
---

6
config/01/output_ro.html
View file

@ -1,6 +0,0 @@
<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">Configure Proxy Access to the Internet</span>: <span style="color: #ffd700">No proxy</span>
</pre>

1
config/02/cmd_ro.txt
View file

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

2
config/02/config.yml
View file

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

8
config/02/output_ro.html
View file

@ -1,8 +0,0 @@
<pre>╭─────────────────────────── Caption ────────────────────────────╮
│ <span style="color: #ff0000">Undocumented but modified variable</span> <span style="color: #00aa00">Modified value</span> │
│ (⏳ Original default value) │
╰────────────────────────────────────────────────────────────────╯
Variables:
<span style="color: #5c5cff">┗━━ </span>📓 <span style="color: #ff0000">Configure Proxy Access to the Internet</span>: <span style="color: #00aa00">No proxy</span> ◀ loaded from the YAML
<span style="color: #5c5cff"> </span>file "config/02/config.yml" (⏳ No proxy)
</pre>

1
config/03/cmd_ro.txt
View file

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

2
config/03/config.yml
View file

@ -1,2 +0,0 @@
---
proxy_mode: Manual proxy configuration

8
config/03/output_ro.html
View file

@ -1,8 +0,0 @@
<pre>╭─────────────────────────── Caption ────────────────────────────╮
│ <span style="color: #ff0000">Undocumented but modified variable</span> <span style="color: #00aa00">Modified value</span> │
│ (⏳ Original default value) │
╰────────────────────────────────────────────────────────────────╯
Variables:
<span style="color: #5c5cff">┗━━ </span>📓 <span style="color: #ff0000">Configure Proxy Access to the Internet</span>: <span style="color: #00aa00">Manual proxy configuration</span> ◀
<span style="color: #5c5cff"> </span>loaded from the YAML file "config/03/config.yml" (⏳ No proxy)
</pre>

1
config/04/cmd_invalid.txt
View file

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

1
config/04/cmd_ro.txt
View file

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

2
config/04/config.yml
View file

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

7
config/04/output_invalid.html
View file

@ -1,7 +0,0 @@
<pre><span style="font-weight: bold; color: #ff0000">🛑 ERRORS</span>
<span style="color: #ff0000">┗━━ </span>the value "foo" is an invalid choice for "proxy_mode" (Configure Proxy
<span style="color: #ff0000"> </span>Access to the Internet), only "Auto-detect proxy settings for this network",
<span style="color: #ff0000"> </span>"Automatic proxy configuration URL", "Manual proxy configuration", "No
<span style="color: #ff0000"> </span>proxy" and "Use system proxy settings" are allowed, it will be ignored when
<span style="color: #ff0000"> </span>loading from the YAML file "config/04/config.yml"
</pre>

12
config/04/output_ro.html
View file

@ -1,12 +0,0 @@
<pre><span style="font-weight: bold; color: #ffff00">🔔 WARNINGS</span>
<span style="color: #ffff00">┗━━ </span>the value "foo" is an invalid choice for "proxy_mode" (Configure Proxy
<span style="color: #ffff00"> </span>Access to the Internet), only "Auto-detect proxy settings for this network",
<span style="color: #ffff00"> </span>"Automatic proxy configuration URL", "Manual proxy configuration", "No
<span style="color: #ffff00"> </span>proxy" and "Use system proxy settings" are allowed, it will be ignored when
<span style="color: #ffff00"> </span>loading from the YAML file "config/04/config.yml"
╭──────────────────── 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">Configure Proxy Access to the Internet</span>: <span style="color: #ffd700">No proxy</span>
</pre>

BIN
firefox.png
View file

Binary file not shown.
Side by side Swipe Overlay

Before

Width:  |  Height:  |  Size: 119 KiB

After

Width:  |  Height:  |  Size: 117 KiB

9
tree.html
View file

@ -25,12 +25,13 @@
</head>
<body>
<h1>Directory Tree</h1><p>
<a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_010/./">.</a><br>
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_010/./firefox/">firefox</a><br>
&nbsp;&nbsp;&nbsp; └── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_010/./firefox/00-proxy.yml">00-proxy.yml</a><br>
<a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_020/./">.</a><br>
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_020/./firefox/">firefox</a><br>
&nbsp;&nbsp;&nbsp; ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_020/./firefox/00-proxy.yml">00-proxy.yml</a><br>
&nbsp;&nbsp;&nbsp; └── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_020/./firefox/10-manual.yml">10-manual.yml</a><br>
<br><br><p>
2 directories, 1 file
2 directories, 2 files
</p>
<hr>