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

[tutorial v1.1_010] A variable with a list of possible values (config and doc)

Browse source
This commit is contained in:
egarette@silique.fr 2025-12-02 16:18:23 +01:00
parent 4c754617f1
commit f3e54d00a3
9 changed files with 94 additions and 25 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

84
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_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))
# [tutorial v1.1_003] Set a default value # [tutorial v1.1_010] A variable with a list of possible values
[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_003~1..v1.1_003) [View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_010~1..v1.1_010)
[Read the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/preliminary.html#set-a-default-value) [Read the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/preliminary.html#a-variable-with-a-list-of-possible-values)
## 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_003 git switch --detach v1.1_010
``` ```
## Structure ## Structure
@ -39,9 +39,9 @@ git switch --detach v1.1_003
<p> <p>
<a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_003/./">.</a><br/> <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_003/./firefox/">firefox</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_003/./firefox/00-proxy.yml">00-proxy.yml</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/>
<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,15 @@ Contents of the firefox/00-proxy.yml file
--- ---
version: 1.1 version: 1.1
proxy_mode: No proxy # Configure Proxy Access to the Internet 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
... ...
``` ```
@ -60,9 +68,9 @@ proxy_mode: No proxy # Configure Proxy Access to the Internet
```shell ```shell
rougail -m firefox/ -o doc rougail -m firefox/ -o doc
``` ```
| Variable | Description | | 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` | Configure Proxy Access to the Internet.<br/>**Default**: No proxy | | **<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 ### Let's generate the changelog
@ -71,9 +79,9 @@ rougail -m firefox/ -o doc --doc.contents changelog
``` ```
#### Modified variable #### Modified variable
| Variable | Description | | 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` | Configure Proxy Access to the Internet.<br/>**Default**: <ins>No proxy</ins> | | **<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 ## User datas
@ -126,7 +134,7 @@ Variables:
```yml ```yml
--- ---
proxy_mode: foo proxy_mode: Manual proxy configuration
``` ```
#### Output #### Output
@ -138,9 +146,47 @@ rougail -m firefox/ -u yaml -yf config/03/config.yml
│ (⏳ Original default value) │ │ (⏳ Original default value) │
╰────────────────────────────────────────────────────────────────╯ ╰────────────────────────────────────────────────────────────────╯
Variables: Variables:
<span style="color: #5c5cff">┗━━ </span>📓 <span style="color: #ff0000">Configure Proxy Access to the Internet</span>: <span style="color: #00aa00">foo</span> ◀ loaded from the YAML file <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>"config/03/config.yml" (⏳ No proxy) <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> </pre>
- [[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_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))

2
config/03/config.yml
View file

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

4
config/03/output_ro.html
View file

@ -3,6 +3,6 @@
│ (⏳ Original default value) │ │ (⏳ Original default value) │
╰────────────────────────────────────────────────────────────────╯ ╰────────────────────────────────────────────────────────────────╯
Variables: Variables:
<span style="color: #5c5cff">┗━━ </span>📓 <span style="color: #ff0000">Configure Proxy Access to the Internet</span>: <span style="color: #00aa00">foo</span> ◀ loaded from the YAML file <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>"config/03/config.yml" (⏳ No proxy) <span style="color: #5c5cff"> </span>loaded from the YAML file "config/03/config.yml" (⏳ No proxy)
</pre> </pre>

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

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

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

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

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

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

7
config/04/output_invalid.html Normal file
View file

@ -0,0 +1,7 @@
<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 Normal file
View file

@ -0,0 +1,12 @@
<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>

6
tree.html
View file

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