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

[tutorial v1.1_100] A conditional disabled variable with type domainname and parameters (config and doc)

Browse source
This commit is contained in:
egarette@silique.fr 2026-03-09 09:12:40 +01:00
parent 9047918df0
commit 831d29c716
10 changed files with 62 additions and 87 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

85
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 v1.1_081] HTTPS and SOCKS Proxy](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_081/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_090~1..v1.1_090)) - [[tutorial v1.1_090] A conditional disabled variable with type web_address](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_090/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_100~1..v1.1_100))
# [tutorial v1.1_090] A conditional disabled variable with type web_address # [tutorial v1.1_100] A conditional disabled variable with type domainname and parameters
[Read the tutorial "A conditional disabled variable with type web_address" in the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/jinja.html#a-conditional-disabled-variable-with-type-web_address) [Read the tutorial "A conditional disabled variable with type domainname and parameters" in the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/jinja.html#a-conditional-disabled-variable-with-type-domainname-and-parameters)
## Screenshot ## Screenshot
@ -29,7 +29,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_090 git switch --detach v1.1_100
``` ```
## Structure ## Structure
@ -37,30 +37,36 @@ git switch --detach v1.1_090
<p> <p>
<a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_090/./">.</a><br/> <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_100/./">.</a><br/>
├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_090/./firefox/">firefox</a><br/> ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_100/./firefox/">firefox</a><br/>
│   ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_090/./firefox/00-proxy.yml">00-proxy.yml</a><br/> │   ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_100/./firefox/00-proxy.yml">00-proxy.yml</a><br/>
│   ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_090/./firefox/10-manual.yml">10-manual.yml</a><br/> │   ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_100/./firefox/10-manual.yml">10-manual.yml</a><br/>
│   ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_090/./firefox/20-manual.yml">20-manual.yml</a><br/> │   ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_100/./firefox/20-manual.yml">20-manual.yml</a><br/>
│   └── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_090/./firefox/30-auto.yml">30-auto.yml</a><br/> │   ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_100/./firefox/30-auto.yml">30-auto.yml</a><br/>
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_090/./types/">types</a><br/> │   └── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_100/./firefox/40-no_proxy.yml">40-no_proxy.yml</a><br/>
    └── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_090/./types/proxy/">proxy</a><br/> └── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_100/./types/">types</a><br/>
        └── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_090/./types/proxy/00_type.yml">00_type.yml</a><br/>     └── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_100/./types/proxy/">proxy</a><br/>
        └── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_100/./types/proxy/00_type.yml">00_type.yml</a><br/>
<br/><br/></p> <br/><br/></p>
Contents of the firefox/30-auto.yml file Contents of the firefox/40-no_proxy.yml file
```yml ```yml
%YAML 1.2 %YAML 1.2
--- ---
version: 1.1 version: 1.1
auto: no_proxy:
description: Automatic proxy configuration URL description: Address for which proxy will be desactivated
type: web_address type: domainname
params:
allow_ip: true
allow_cidr_network: true
allow_without_dot: true
allow_startswith_dot: true
disabled: disabled:
variable: _.proxy_mode variable: _.proxy_mode
when_not: Automatic proxy configuration URL when: No proxy
... ...
``` ```
@ -124,8 +130,9 @@ rougail -m firefox/ --types types/proxy -o doc
| **<a id="manual.socks_proxy.version" name="manual.socks_proxy.version">manual.socks_proxy.version</a>**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | SOCKS host version used by proxy.<br/>**Choices**: <br/>•&nbsp;v4<br/>•&nbsp;v5 **← (default)** | | **<a id="manual.socks_proxy.version" name="manual.socks_proxy.version">manual.socks_proxy.version</a>**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | SOCKS host version used by proxy.<br/>**Choices**: <br/>•&nbsp;v4<br/>•&nbsp;v5 **← (default)** |
| Variable | Description | | Variable | Description |
|------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **<a id="auto" name="auto">auto</a>**<br/>[`web address`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` *`disabled`* | Automatic proxy configuration URL.<br/>**Validators**: <br/>•&nbsp;well-known ports (1 to 1023) are allowed<br/>•&nbsp;registred ports (1024 to 49151) are allowed<br/>•&nbsp;type domainname<br/>•&nbsp;the domain name can be a hostname<br/>**Disabled**: when the variable "[Configure Proxy Access to the Internet](#proxy_mode)" hasn't the value "Automatic proxy configuration URL" | | **<a id="auto" name="auto">auto</a>**<br/>[`web address`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` *`disabled`* | Automatic proxy configuration URL.<br/>**Validators**: <br/>•&nbsp;well-known ports (1 to 1023) are allowed<br/>•&nbsp;registred ports (1024 to 49151) are allowed<br/>•&nbsp;type domainname<br/>•&nbsp;the domain name can be a hostname<br/>**Disabled**: when the variable "[Configure Proxy Access to the Internet](#proxy_mode)" hasn't the value "Automatic proxy configuration URL" |
| **<a id="no_proxy" name="no_proxy">no_proxy</a>**<br/>[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` *`disabled`* | Address for which proxy will be desactivated.<br/>**Validators**: <br/>•&nbsp;type domainname<br/>•&nbsp;the domain name can starts by a dot<br/>•&nbsp;the domain name can be a hostname<br/>•&nbsp;the domain name can be an IP<br/>•&nbsp;the domain name can be network in CIDR format<br/>**Disabled**: when the variable "[Configure Proxy Access to the Internet](#proxy_mode)" has the value "No proxy" |
*** ***
@ -137,8 +144,8 @@ rougail -m firefox/ --types types/proxy -o doc --doc.contents changelog --doc.ch
#### New variable #### New variable
| Variable | Description | | Variable | Description |
|------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **<a id="auto" name="auto">auto</a>**<br/>[`web address`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` *`disabled`* | Automatic proxy configuration URL.<br/>**Validators**: <br/>•&nbsp;well-known ports (1 to 1023) are allowed<br/>•&nbsp;registred ports (1024 to 49151) are allowed<br/>•&nbsp;type domainname<br/>•&nbsp;the domain name can be a hostname<br/>**Disabled**: when the variable "[Configure Proxy Access to the Internet](#proxy_mode)" hasn't the value "Automatic proxy configuration URL" | | **<a id="no_proxy" name="no_proxy">no_proxy</a>**<br/>[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` *`disabled`* | Address for which proxy will be desactivated.<br/>**Validators**: <br/>•&nbsp;type domainname<br/>•&nbsp;the domain name can starts by a dot<br/>•&nbsp;the domain name can be a hostname<br/>•&nbsp;the domain name can be an IP<br/>•&nbsp;the domain name can be network in CIDR format<br/>**Disabled**: when the variable "[Configure Proxy Access to the Internet](#proxy_mode)" has the value "No proxy" |
*** ***
@ -151,7 +158,6 @@ rougail -m firefox/ --types types/proxy -o doc --doc.contents changelog --doc.ch
```yml ```yml
--- ---
auto: https://auto.proxy.net/wpad.dat
``` ```
*** ***
@ -160,10 +166,6 @@ auto: https://auto.proxy.net/wpad.dat
```shell ```shell
rougail -m firefox/ --types types/proxy -u yaml -yf config/01/config.yml rougail -m firefox/ --types types/proxy -u yaml -yf config/01/config.yml
``` ```
> [!WARNING]
>
> - auto (Automatic proxy configuration URL): :bell: <span style="color: #EFBF04">variable has property disabled, it will be ignored when loading from the YAML file "config/01/config.yml"</span>
> [!NOTE] > [!NOTE]
> >
> **Caption:** > **Caption:**
@ -182,6 +184,8 @@ Variables:
```yml ```yml
--- ---
proxy_mode: Automatic proxy configuration URL proxy_mode: Automatic proxy configuration URL
auto: https://auto.proxy.net/wpad.dat
no_proxy: 192.168.1.0/24
``` ```
*** ***
@ -190,28 +194,6 @@ proxy_mode: Automatic proxy configuration URL
```shell ```shell
rougail -m firefox/ --types types/proxy -u yaml -yf config/02/config.yml rougail -m firefox/ --types types/proxy -u yaml -yf config/02/config.yml
``` ```
> [!CAUTION]
>
> - auto (Automatic proxy configuration URL): :stop_sign: <span style="color: #C23636">mandatory variable but has no value</span>
***
### Example 3
#### config/03/config.yml
```yml
---
proxy_mode: Automatic proxy configuration URL
auto: https://auto.proxy.net/wpad.dat
```
***
#### Output
```shell
rougail -m firefox/ --types types/proxy -u yaml -yf config/03/config.yml
```
> [!NOTE] > [!NOTE]
> >
> **Caption:** > **Caption:**
@ -220,10 +202,11 @@ rougail -m firefox/ --types types/proxy -u yaml -yf config/03/config.yml
> - (:hourglass_flowing_sand: Original default value) > - (:hourglass_flowing_sand: Original default value)
Variables: Variables:
- :notebook: proxy_mode (Configure Proxy Access to the Internet): <span style="color: #006400">Automatic proxy configuration URL</span> ← loaded from the YAML file "config/03/config.yml" (:hourglass_flowing_sand: No proxy) - :notebook: proxy_mode (Configure Proxy Access to the Internet): <span style="color: #006400">Automatic proxy configuration URL</span> ← loaded from the YAML file "config/02/config.yml" (:hourglass_flowing_sand: No proxy)
- :notebook: auto (Automatic proxy configuration URL): <span style="color: #006400">https://auto.proxy.net/wpad.dat</span> ← loaded from the YAML file "config/03/config.yml" - :notebook: auto (Automatic proxy configuration URL): <span style="color: #006400">https://auto.proxy.net/wpad.dat</span> ← loaded from the YAML file "config/02/config.yml"
- :notebook: no_proxy (Address for which proxy will be desactivated): <span style="color: #006400">192.168.1.0/24</span> ← loaded from the YAML file "config/02/config.yml"
*** ***
- [[tutorial v1.1_100] A conditional disabled variable with type domainname and parameters](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_100/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_100~1..v1.1_100)) - [[tutorial v1.1_101] A variable with multiple value](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_101/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_101~1..v1.1_101))

1
config/01/config.yml
View file

@ -1,2 +1 @@
--- ---
auto: https://auto.proxy.net/wpad.dat

6
config/01/output_ro.html
View file

@ -1,8 +1,4 @@
<pre><span style="font-weight: bold; color: #ffff00">🔔 Warning</span> <pre>╭─────── Caption ────────╮
<span style="color: #ffff00">┗━━ </span>auto (Automatic proxy configuration URL): <span style="color: #ffff00">🔔 variable has property disabled,</span>
<span style="color: #ffff00"> </span><span style="color: #ffff00">it will be ignored when loading from the YAML file "config/01/config.yml"</span>
╭─────── Caption ────────╮
│ Variable <span style="color: #ffd700">Default value</span> │ │ Variable <span style="color: #ffd700">Default value</span> │
╰────────────────────────╯ ╰────────────────────────╯
Variables: Variables:

2
config/02/config.yml
View file

@ -1,2 +1,4 @@
--- ---
proxy_mode: Automatic proxy configuration URL proxy_mode: Automatic proxy configuration URL
auto: https://auto.proxy.net/wpad.dat
no_proxy: 192.168.1.0/24

15
config/02/output_ro.html
View file

@ -1,4 +1,13 @@
<pre><span style="font-weight: bold; color: #ff0000">🛑 Caution</span> <pre>╭────────────── Caption ───────────────╮
<span style="color: #ff0000">┗━━ </span>auto (Automatic proxy configuration URL): <span style="color: #ff0000">🛑 mandatory variable but has no </span> │ Variable <span style="color: #00aa00">Modified value</span> │
<span style="color: #ff0000"> </span><span style="color: #ff0000">value</span> │ (⏳ Original default value) │
╰──────────────────────────────────────╯
Variables:
<span style="color: #5c5cff">┣━━ </span>📓 proxy_mode (Configure Proxy Access to the Internet): <span style="color: #00aa00">Automatic proxy </span>
<span style="color: #5c5cff">┃ </span><span style="color: #00aa00">configuration URL</span> ◀ loaded from the YAML file "config/02/config.yml" (⏳ No
<span style="color: #5c5cff">┃ </span>proxy)
<span style="color: #5c5cff">┣━━ </span>📓 auto (Automatic proxy configuration URL): <span style="color: #00aa00">https://auto.proxy.net/wpad.dat</span>
<span style="color: #5c5cff">┃ </span>◀ loaded from the YAML file "config/02/config.yml"
<span style="color: #5c5cff">┗━━ </span>📓 no_proxy (Address for which proxy will be desactivated): <span style="color: #00aa00">192.168.1.0/24</span> ◀
<span style="color: #5c5cff"> </span>loaded from the YAML file "config/02/config.yml"
</pre> </pre>

1
config/03/cmd_ro.txt
View file

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

3
config/03/config.yml
View file

@ -1,3 +0,0 @@
---
proxy_mode: Automatic proxy configuration URL
auto: https://auto.proxy.net/wpad.dat

11
config/03/output_ro.html
View file

@ -1,11 +0,0 @@
<pre>╭────────────── Caption ───────────────╮
│ Variable <span style="color: #00aa00">Modified value</span> │
│ (⏳ Original default value) │
╰──────────────────────────────────────╯
Variables:
<span style="color: #5c5cff">┣━━ </span>📓 proxy_mode (Configure Proxy Access to the Internet): <span style="color: #00aa00">Automatic proxy </span>
<span style="color: #5c5cff">┃ </span><span style="color: #00aa00">configuration URL</span> ◀ loaded from the YAML file "config/03/config.yml" (⏳ No
<span style="color: #5c5cff">┃ </span>proxy)
<span style="color: #5c5cff">┗━━ </span>📓 auto (Automatic proxy configuration URL): <span style="color: #00aa00">https://auto.proxy.net/wpad.dat</span>
<span style="color: #5c5cff"> </span>◀ loaded from the YAML file "config/03/config.yml"
</pre>

BIN
firefox.png
View file

Binary file not shown.
Side by side Swipe Overlay

Before

Width:  |  Height:  |  Size: 113 KiB

After

Width:  |  Height:  |  Size: 118 KiB

19
tree.html
View file

@ -1,11 +1,12 @@
<p> <p>
<a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_090/./">.</a><br/> <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_100/./">.</a><br/>
├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_090/./firefox/">firefox</a><br/> ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_100/./firefox/">firefox</a><br/>
│   ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_090/./firefox/00-proxy.yml">00-proxy.yml</a><br/> │   ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_100/./firefox/00-proxy.yml">00-proxy.yml</a><br/>
│   ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_090/./firefox/10-manual.yml">10-manual.yml</a><br/> │   ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_100/./firefox/10-manual.yml">10-manual.yml</a><br/>
│   ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_090/./firefox/20-manual.yml">20-manual.yml</a><br/> │   ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_100/./firefox/20-manual.yml">20-manual.yml</a><br/>
│   └── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_090/./firefox/30-auto.yml">30-auto.yml</a><br/> │   ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_100/./firefox/30-auto.yml">30-auto.yml</a><br/>
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_090/./types/">types</a><br/> │   └── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_100/./firefox/40-no_proxy.yml">40-no_proxy.yml</a><br/>
    └── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_090/./types/proxy/">proxy</a><br/> └── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_100/./types/">types</a><br/>
        └── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_090/./types/proxy/00_type.yml">00_type.yml</a><br/>     └── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_100/./types/proxy/">proxy</a><br/>
        └── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_100/./types/proxy/00_type.yml">00_type.yml</a><br/>
<br/><br/></p> <br/><br/></p>