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

[tutorial 012] A default value (config and doc)

Browse source
This commit is contained in:
egarette@silique.fr 2024-11-02 14:58:13 +01:00
parent fd8fd30209
commit 01e92c97b8
6 changed files with 46 additions and 23 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

40
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 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 011] The variable description](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 011] The variable description # [tutorial 012] A default value
[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_011~1..v1.1_011) [View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_012~1..v1.1_012)
## Screenshot ## Screenshot
@ -22,6 +22,7 @@
--- ---
proxy_mode: proxy_mode:
description: Configure Proxy Access to the Internet description: Configure Proxy Access to the Internet
default: No proxy
``` ```
### Generated documentation ### Generated documentation
@ -33,7 +34,7 @@ foo@bar:~$ rougail -v 1.1 -m firefox/ -o doc -do github
| Variable                                                                                        | Description                                                                                     | | Variable                                                                                        | Description                                                                                     |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **proxy_mode**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Configure Proxy Access to the Internet. | | **proxy_mode**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Configure Proxy Access to the Internet.<br/>**Default**: No proxy |
## User data ## User data
@ -52,9 +53,14 @@ foo@bar:~$ rougail -v 1.1 -m firefox/ -o doc -do github
```console ```console
foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/01/config.yaml foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/01/config.yaml
``` ```
<pre>🛑 ERRORS <pre>╭────────────────────────── Caption ──────────────────────────╮
<span style="color: #ff0000">┣━━ </span>The following variables are mandatory but have no value: │ Variable <span style="color: #ffd700">Default value</span> │
<span style="color: #ff0000">┗━━ </span> - proxy_mode (Configure Proxy Access to the Internet) │ <span style="color: #5c5cff">Undocumented variable</span> Modified value │
│ <span style="color: #ff0000">Undocumented but modified variable</span> (<span style="color: #00aa00">Original default value</span>) │
│ <span style="color: #ffaf00">Unmodifiable variable</span> │
╰─────────────────────────────────────────────────────────────╯
Variables:
<span style="color: #5c5cff">┗━━ </span>📓 proxy_mode: <span style="color: #ffd700">No proxy</span>
</pre> </pre>
### Example 2 ### Example 2
@ -78,7 +84,7 @@ foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/02/config.yaml
│ <span style="color: #ffaf00">Unmodifiable variable</span> │ │ <span style="color: #ffaf00">Unmodifiable variable</span> │
╰─────────────────────────────────────────────────────────────╯ ╰─────────────────────────────────────────────────────────────╯
Variables: Variables:
<span style="color: #5c5cff">┗━━ </span>📓 proxy_mode: No proxy <span style="color: #5c5cff">┗━━ </span>📓 proxy_mode: No proxy (<span style="color: #00aa00">No proxy</span>)
</pre> </pre>
### Example 3 ### Example 3
@ -102,7 +108,7 @@ foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/03/config.yaml
│ <span style="color: #ffaf00">Unmodifiable variable</span> │ │ <span style="color: #ffaf00">Unmodifiable variable</span> │
╰─────────────────────────────────────────────────────────────╯ ╰─────────────────────────────────────────────────────────────╯
Variables: Variables:
<span style="color: #5c5cff">┗━━ </span>📓 proxy_mode: Manual proxy configuration <span style="color: #5c5cff">┗━━ </span>📓 proxy_mode: Manual proxy configuration (<span style="color: #00aa00">No proxy</span>)
</pre> </pre>
### Example 4 ### Example 4
@ -126,7 +132,7 @@ foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/04/config.yaml
│ <span style="color: #ffaf00">Unmodifiable variable</span> │ │ <span style="color: #ffaf00">Unmodifiable variable</span> │
╰─────────────────────────────────────────────────────────────╯ ╰─────────────────────────────────────────────────────────────╯
Variables: Variables:
<span style="color: #5c5cff">┗━━ </span>📓 proxy_mode: foo <span style="color: #5c5cff">┗━━ </span>📓 proxy_mode: foo (<span style="color: #00aa00">No proxy</span>)
</pre> </pre>
### Example 5 ### Example 5
@ -144,10 +150,16 @@ proxy_mode: 1
foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/05/config.yaml foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/05/config.yaml
``` ```
<pre>🛑 ERRORS <pre>🛑 ERRORS
<span style="color: #ff0000">┣━━ </span>"1" is an invalid string for "proxy_mode (Configure Proxy Access to the Internet)" <span style="color: #ff0000">┗━━ </span>"1" is an invalid string for "proxy_mode (Configure Proxy Access to the Internet)"
<span style="color: #ff0000">┣━━ </span>The following variables are mandatory but have no value: ╭────────────────────────── Caption ──────────────────────────╮
<span style="color: #ff0000">┗━━ </span> - proxy_mode (Configure Proxy Access to the Internet) │ Variable <span style="color: #ffd700">Default value</span> │
│ <span style="color: #5c5cff">Undocumented variable</span> Modified value │
│ <span style="color: #ff0000">Undocumented but modified variable</span> (<span style="color: #00aa00">Original default value</span>) │
│ <span style="color: #ffaf00">Unmodifiable variable</span> │
╰─────────────────────────────────────────────────────────────╯
Variables:
<span style="color: #5c5cff">┗━━ </span>📓 proxy_mode: <span style="color: #ffd700">No proxy</span>
</pre> </pre>
- [[tutorial 012] 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)) - [[tutorial 013] A variable with type "choice"](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_013/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_013~1..v1.1_013))

11
config/01/output_ro.html
View file

@ -1,4 +1,9 @@
<pre>🛑 ERRORS <pre>╭────────────────────────── Caption ──────────────────────────╮
<span style="color: #ff0000">┣━━ </span>The following variables are mandatory but have no value: │ Variable <span style="color: #ffd700">Default value</span> │
<span style="color: #ff0000">┗━━ </span> - proxy_mode (Configure Proxy Access to the Internet) │ <span style="color: #5c5cff">Undocumented variable</span> Modified value │
│ <span style="color: #ff0000">Undocumented but modified variable</span> (<span style="color: #00aa00">Original default value</span>) │
│ <span style="color: #ffaf00">Unmodifiable variable</span> │
╰─────────────────────────────────────────────────────────────╯
Variables:
<span style="color: #5c5cff">┗━━ </span>📓 proxy_mode: <span style="color: #ffd700">No proxy</span>
</pre> </pre>

2
config/02/output_ro.html
View file

@ -5,5 +5,5 @@
│ <span style="color: #ffaf00">Unmodifiable variable</span> │ │ <span style="color: #ffaf00">Unmodifiable variable</span> │
╰─────────────────────────────────────────────────────────────╯ ╰─────────────────────────────────────────────────────────────╯
Variables: Variables:
<span style="color: #5c5cff">┗━━ </span>📓 proxy_mode: No proxy <span style="color: #5c5cff">┗━━ </span>📓 proxy_mode: No proxy (<span style="color: #00aa00">No proxy</span>)
</pre> </pre>

2
config/03/output_ro.html
View file

@ -5,5 +5,5 @@
│ <span style="color: #ffaf00">Unmodifiable variable</span> │ │ <span style="color: #ffaf00">Unmodifiable variable</span> │
╰─────────────────────────────────────────────────────────────╯ ╰─────────────────────────────────────────────────────────────╯
Variables: Variables:
<span style="color: #5c5cff">┗━━ </span>📓 proxy_mode: Manual proxy configuration <span style="color: #5c5cff">┗━━ </span>📓 proxy_mode: Manual proxy configuration (<span style="color: #00aa00">No proxy</span>)
</pre> </pre>

2
config/04/output_ro.html
View file

@ -5,5 +5,5 @@
│ <span style="color: #ffaf00">Unmodifiable variable</span> │ │ <span style="color: #ffaf00">Unmodifiable variable</span> │
╰─────────────────────────────────────────────────────────────╯ ╰─────────────────────────────────────────────────────────────╯
Variables: Variables:
<span style="color: #5c5cff">┗━━ </span>📓 proxy_mode: foo <span style="color: #5c5cff">┗━━ </span>📓 proxy_mode: foo (<span style="color: #00aa00">No proxy</span>)
</pre> </pre>

12
config/05/output_ro.html
View file

@ -1,5 +1,11 @@
<pre>🛑 ERRORS <pre>🛑 ERRORS
<span style="color: #ff0000">┣━━ </span>"1" is an invalid string for "proxy_mode (Configure Proxy Access to the Internet)" <span style="color: #ff0000">┗━━ </span>"1" is an invalid string for "proxy_mode (Configure Proxy Access to the Internet)"
<span style="color: #ff0000">┣━━ </span>The following variables are mandatory but have no value: ╭────────────────────────── Caption ──────────────────────────╮
<span style="color: #ff0000">┗━━ </span> - proxy_mode (Configure Proxy Access to the Internet) │ Variable <span style="color: #ffd700">Default value</span> │
│ <span style="color: #5c5cff">Undocumented variable</span> Modified value │
│ <span style="color: #ff0000">Undocumented but modified variable</span> (<span style="color: #00aa00">Original default value</span>) │
│ <span style="color: #ffaf00">Unmodifiable variable</span> │
╰─────────────────────────────────────────────────────────────╯
Variables:
<span style="color: #5c5cff">┗━━ </span>📓 proxy_mode: <span style="color: #ffd700">No proxy</span>
</pre> </pre>