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

[tutorial v1.1_030] A variable with type "domainname" (config and doc)

Browse source
This commit is contained in:
egarette@silique.fr 2026-01-08 20:22:12 +01:00
parent 507836bc3c
commit 35ac5ca3d9
12 changed files with 126 additions and 85 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

117
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_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)) - [[tutorial v1.1_022] Putting a variable inside of a family or a sub family](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_022/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_022~1..v1.1_022))
# [tutorial v1.1_022] Putting a variable inside of a family or a sub family # [tutorial v1.1_030] A variable with type "domainname"
[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_022~1..v1.1_022) [View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_030~1..v1.1_030)
[Read the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/proxymode.html#putting-a-variable-inside-of-a-family-or-a-sub-family) [Read the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/disabled.html#a-variable-with-type-"domainname")
## 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_022 git switch --detach v1.1_030
``` ```
## Structure ## Structure
@ -39,10 +39,10 @@ git switch --detach v1.1_022
<p> <p>
<a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_022/./">.</a><br/> <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_030/./">.</a><br/>
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_022/./firefox/">firefox</a><br/> └── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_030/./firefox/">firefox</a><br/>
    ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_022/./firefox/00-proxy.yml">00-proxy.yml</a><br/>     ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_030/./firefox/00-proxy.yml">00-proxy.yml</a><br/>
    └── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_022/./firefox/10-manual.yml">10-manual.yml</a><br/>     └── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_030/./firefox/10-manual.yml">10-manual.yml</a><br/>
<br/><br/></p> <br/><br/></p>
Contents of the firefox/10-manual.yml file Contents of the firefox/10-manual.yml file
@ -56,7 +56,9 @@ manual: # Manual proxy configuration
http_proxy: # HTTP Proxy http_proxy: # HTTP Proxy
address: # HTTP address address:
description: HTTP address
type: domainname
... ...
``` ```
@ -83,9 +85,9 @@ rougail -m firefox/ -o doc
> >
> **Path**: manual.http_proxy > **Path**: manual.http_proxy
| Variable | Description | | Variable | Description |
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| |-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------|
| **<a id="manual.http_proxy.address" name="manual.http_proxy.address">manual.http_proxy.address</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTP address. | | **<a id="manual.http_proxy.address" name="manual.http_proxy.address">manual.http_proxy.address</a>**<br/>[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTP address.<br/>**Validator**: type domainname |
*** ***
@ -94,11 +96,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 | Description | | Variable | Description |
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| |-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------|
| **<a id="manual.http_proxy.address" name="manual.http_proxy.address">manual.http_proxy.address</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTP address. | | **<a id="manual.http_proxy.address" name="manual.http_proxy.address">manual.http_proxy.address</a>**<br/>[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTP address.<br/>**Validator**: <ins>type domainname</ins> |
*** ***
@ -111,6 +113,9 @@ rougail -m firefox/ -o doc --doc.contents changelog
```yml ```yml
--- ---
manual:
http_proxy:
address: example.net
``` ```
*** ***
@ -119,11 +124,18 @@ rougail -m firefox/ -o doc --doc.contents changelog
```shell ```shell
rougail -m firefox/ -u yaml -yf config/01/config.yml rougail -m firefox/ -u yaml -yf config/01/config.yml
``` ```
> [!CAUTION] > [!NOTE]
> >
> - manual (Manual proxy configuration) > **Caption:**
> - http_proxy (HTTP Proxy) > - Variable
> - address (HTTP address): :stop_sign: <span style="color: #C23636">mandatory variable but has no value</span> > - <span style="color: #B8860B">Default value</span>
> - <span style="color: #006400">Modified value</span>
Variables:
- :notebook: proxy_mode (Configure Proxy Access to the Internet): <span style="color: #B8860B">No proxy</span>
- :open_file_folder: manual (Manual proxy configuration)
- :open_file_folder: http_proxy (HTTP Proxy)
- :notebook: address (HTTP address): <span style="color: #006400">example.net</span> ← loaded from the YAML file "config/01/config.yml"
*** ***
### Example 2 ### Example 2
@ -135,7 +147,7 @@ rougail -m firefox/ -u yaml -yf config/01/config.yml
--- ---
manual: manual:
http_proxy: http_proxy:
address: example.net address: 192.168.0.1
``` ```
*** ***
@ -144,18 +156,25 @@ manual:
```shell ```shell
rougail -m firefox/ -u yaml -yf config/02/config.yml rougail -m firefox/ -u yaml -yf config/02/config.yml
``` ```
> [!NOTE] > [!CAUTION]
> >
> **Caption:** > - manual (Manual proxy configuration)
> - Variable > - http_proxy (HTTP Proxy)
> - <span style="color: #B8860B">Default value</span> > - address (HTTP address)
> - <span style="color: #006400">Modified value</span> > - [#EFBF04]:bell: the value "192.168.0.1" is an invalid domain name, must not be an IP, it will be ignored when loading from the YAML file "config/02/config.yml"[/#EFBF04]
> - [#C23636]:stop_sign: mandatory variable but has no value[/#C23636]
Variables: ***
- :notebook: proxy_mode (Configure Proxy Access to the Internet): <span style="color: #B8860B">No proxy</span> #### Output when invalid user data is an error
- :open_file_folder: manual (Manual proxy configuration)
- :open_file_folder: http_proxy (HTTP Proxy) ```shell
- :notebook: address (HTTP address): <span style="color: #006400">example.net</span> ← loaded from the YAML file "config/02/config.yml" rougail -m firefox/ -u yaml -yf config/02/config.yml --cli.invalid_user_data_error
```
> [!CAUTION]
>
> - manual (Manual proxy configuration)
> - http_proxy (HTTP Proxy)
> - address (HTTP address): :stop_sign: <span style="color: #C23636">the value "192.168.0.1" is an invalid domain name, must not be an IP, it has been loading from the YAML file "config/02/config.yml"</span>
*** ***
### Example 3 ### Example 3
@ -167,8 +186,7 @@ Variables:
--- ---
manual: manual:
http_proxy: http_proxy:
address: example.net address: not a valid domain name.com
port: 3128
``` ```
*** ***
@ -177,24 +195,27 @@ manual:
```shell ```shell
rougail -m firefox/ -u yaml -yf config/03/config.yml rougail -m firefox/ -u yaml -yf config/03/config.yml
``` ```
> [!WARNING] > [!CAUTION]
> >
> - variable or family "manual.http_proxy.port" does not exist, it will be ignored when loading from the YAML file "config/03/config.yml" > - manual (Manual proxy configuration)
> - http_proxy (HTTP Proxy)
> - address (HTTP address)
> - [#EFBF04]:bell: the value "not a valid domain name.com" is an invalid domain name, must start with lowercase characters followed by lowercase characters, number, "-" and "." characters are allowed, it will be ignored when loading from the YAML file "config/03/config.yml"[/#EFBF04]
> - [#C23636]:stop_sign: mandatory variable but has no value[/#C23636]
> [!NOTE] ***
#### Output when invalid user data is an error
```shell
rougail -m firefox/ -u yaml -yf config/03/config.yml --cli.invalid_user_data_error
```
> [!CAUTION]
> >
> **Caption:** > - manual (Manual proxy configuration)
> - Variable > - http_proxy (HTTP Proxy)
> - <span style="color: #B8860B">Default value</span> > - address (HTTP address): :stop_sign: <span style="color: #C23636">the value "not a valid domain name.com" is an invalid domain name, must start with lowercase characters followed by lowercase characters, number, "-" and "." characters are allowed, it has been loading from the YAML file "config/03/config.yml"</span>
> - <span style="color: #006400">Modified value</span>
Variables:
- :notebook: proxy_mode (Configure Proxy Access to the Internet): <span style="color: #B8860B">No proxy</span>
- :open_file_folder: manual (Manual proxy configuration)
- :open_file_folder: http_proxy (HTTP Proxy)
- :notebook: address (HTTP address): <span style="color: #006400">example.net</span> ← loaded from the YAML file "config/03/config.yml"
*** ***
- [[tutorial v1.1_030] A variable with type "domainname"](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_030/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_030~1..v1.1_030)) - [[tutorial v1.1_031] A variable with type's parameters](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_031/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_031~1..v1.1_031))

3
config/01/config.yml
View file

@ -1 +1,4 @@
--- ---
manual:
http_proxy:
address: example.net

14
config/01/output_ro.html
View file

@ -1,5 +1,11 @@
<pre><span style="font-weight: bold; color: #ff0000">🛑 Caution</span> <pre>╭──────── Caption ────────╮
<span style="color: #ff0000">┗━━ </span>manual (Manual proxy configuration) │ Variable <span style="color: #ffd700">Default value</span> │
<span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>http_proxy (HTTP Proxy) │ <span style="color: #00aa00">Modified value</span> │
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>address (HTTP address): <span style="color: #ff0000">🛑 mandatory variable but has no value</span> ╰─────────────────────────╯
Variables:
<span style="color: #5c5cff">┣━━ </span>📓 proxy_mode (Configure Proxy Access to the Internet): <span style="color: #ffd700">No proxy</span>
<span style="color: #5c5cff">┗━━ </span>📂 manual (Manual proxy configuration)
<span style="color: #5c5cff"> </span><span style="color: #5c5cff">┗━━ </span>📂 http_proxy (HTTP Proxy)
<span style="color: #5c5cff"> </span><span style="color: #5c5cff"> </span><span style="color: #5c5cff">┗━━ </span>📓 address (HTTP address): <span style="color: #00aa00">example.net</span> ◀ loaded from the YAML file
<span style="color: #5c5cff"> </span><span style="color: #5c5cff"> </span><span style="color: #5c5cff"> </span>"config/01/config.yml"
</pre> </pre>

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

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

2
config/02/config.yml
View file

@ -1,4 +1,4 @@
--- ---
manual: manual:
http_proxy: http_proxy:
address: example.net address: 192.168.0.1

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

@ -0,0 +1,7 @@
<pre><span style="font-weight: bold; color: #ff0000">🛑 Caution</span>
<span style="color: #ff0000">┗━━ </span>manual (Manual proxy configuration)
<span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>http_proxy (HTTP Proxy)
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>address (HTTP address): <span style="color: #ff0000">🛑 the value "192.168.0.1" is an invalid </span>
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">domain name, must not be an IP, it has been loading from the YAML </span>
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">file "config/02/config.yml"</span>
</pre>

18
config/02/output_ro.html
View file

@ -1,11 +1,9 @@
<pre>╭──────── Caption ────────╮ <pre><span style="font-weight: bold; color: #ff0000">🛑 Caution</span>
│ Variable <span style="color: #ffd700">Default value</span> │ <span style="color: #ff0000">┗━━ </span>manual (Manual proxy configuration)
│ <span style="color: #00aa00">Modified value</span> │ <span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>http_proxy (HTTP Proxy)
╰─────────────────────────╯ <span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>address (HTTP address)
Variables: <span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┣━━ </span><span style="color: #ffff00">🔔 the value "192.168.0.1" is an invalid domain name, must not </span>
<span style="color: #5c5cff">┣━━ </span>📓 proxy_mode (Configure Proxy Access to the Internet): <span style="color: #ffd700">No proxy</span> <span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┃ </span><span style="color: #ffff00">be an IP, it will be ignored when loading from the YAML file </span>
<span style="color: #5c5cff">┗━━ </span>📂 manual (Manual proxy configuration) <span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┃ </span><span style="color: #ffff00">"config/02/config.yml"</span>
<span style="color: #5c5cff"> </span><span style="color: #5c5cff">┗━━ </span>📂 http_proxy (HTTP Proxy) <span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><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><span style="color: #5c5cff"> </span><span style="color: #5c5cff">┗━━ </span>📓 address (HTTP address): <span style="color: #00aa00">example.net</span> ◀ loaded from the YAML file
<span style="color: #5c5cff"> </span><span style="color: #5c5cff"> </span><span style="color: #5c5cff"> </span>"config/02/config.yml"
</pre> </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_data_error

3
config/03/config.yml
View file

@ -1,5 +1,4 @@
--- ---
manual: manual:
http_proxy: http_proxy:
address: example.net address: not a valid domain name.com
port: 3128

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

@ -0,0 +1,9 @@
<pre><span style="font-weight: bold; color: #ff0000">🛑 Caution</span>
<span style="color: #ff0000">┗━━ </span>manual (Manual proxy configuration)
<span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>http_proxy (HTTP Proxy)
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>address (HTTP address): <span style="color: #ff0000">🛑 the value "not a valid domain name.com" </span>
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">is an invalid domain name, must start with lowercase characters </span>
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">followed by lowercase characters, number, "-" and "." characters are</span>
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">allowed, it has been loading from the YAML file </span>
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">"config/03/config.yml"</span>
</pre>

24
config/03/output_ro.html
View file

@ -1,15 +1,11 @@
<pre><span style="font-weight: bold; color: #ffff00">🔔 Warning</span> <pre><span style="font-weight: bold; color: #ff0000">🛑 Caution</span>
<span style="color: #ffff00">┗━━ </span>variable or family "manual.http_proxy.port" does not exist, it will be <span style="color: #ff0000">┗━━ </span>manual (Manual proxy configuration)
<span style="color: #ffff00"> </span>ignored when loading from the YAML file "config/03/config.yml" <span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>http_proxy (HTTP Proxy)
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>address (HTTP address)
╭──────── Caption ────────╮ <span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┣━━ </span><span style="color: #ffff00">🔔 the value "not a valid domain name.com" is an invalid domain </span>
│ Variable <span style="color: #ffd700">Default value</span> │ <span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┃ </span><span style="color: #ffff00">name, must start with lowercase characters followed by lowercase</span>
│ <span style="color: #00aa00">Modified value</span> │ <span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┃ </span><span style="color: #ffff00">characters, number, "-" and "." characters are allowed, it will </span>
╰─────────────────────────╯ <span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┃ </span><span style="color: #ffff00">be ignored when loading from the YAML file </span>
Variables: <span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┃ </span><span style="color: #ffff00">"config/03/config.yml"</span>
<span style="color: #5c5cff">┣━━ </span>📓 proxy_mode (Configure Proxy Access to the Internet): <span style="color: #ffd700">No proxy</span> <span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><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>📂 manual (Manual proxy configuration)
<span style="color: #5c5cff"> </span><span style="color: #5c5cff">┗━━ </span>📂 http_proxy (HTTP Proxy)
<span style="color: #5c5cff"> </span><span style="color: #5c5cff"> </span><span style="color: #5c5cff">┗━━ </span>📓 address (HTTP address): <span style="color: #00aa00">example.net</span> ◀ loaded from the YAML file
<span style="color: #5c5cff"> </span><span style="color: #5c5cff"> </span><span style="color: #5c5cff"> </span>"config/03/config.yml"
</pre> </pre>

8
tree.html
View file

@ -1,6 +1,6 @@
<p> <p>
<a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_022/./">.</a><br/> <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_030/./">.</a><br/>
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_022/./firefox/">firefox</a><br/> └── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_030/./firefox/">firefox</a><br/>
    ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_022/./firefox/00-proxy.yml">00-proxy.yml</a><br/>     ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_030/./firefox/00-proxy.yml">00-proxy.yml</a><br/>
    └── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_022/./firefox/10-manual.yml">10-manual.yml</a><br/>     └── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_030/./firefox/10-manual.yml">10-manual.yml</a><br/>
<br/><br/></p> <br/><br/></p>