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

[tutorial v1.1_096] A boolean variable (config and doc)

Browse source
This commit is contained in:
egarette@silique.fr 2025-12-02 16:19:07 +01:00
parent 71d0065215
commit d5287cbb6b
6 changed files with 51 additions and 49 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

63
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_094] Help](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_094/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_094~1..v1.1_094))
- [[tutorial v1.1_095] A conditional disabled boolean variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_095/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_095~1..v1.1_095))
# [tutorial v1.1_095] A conditional disabled boolean variable
# [tutorial v1.1_096] A boolean variable
[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_095~1..v1.1_095)
[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_096~1..v1.1_096)
[Read the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#a-conditional-disabled-boolean-variable)
[Read the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#a-boolean-variable)
## 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_095
git switch --detach v1.1_096
```
## Structure
@ -39,29 +39,25 @@ git switch --detach v1.1_095
<p>
<a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_095/./">.</a><br/>
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_095/./firefox/">firefox</a><br/>
    ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_095/./firefox/00-proxy.yml">00-proxy.yml</a><br/>
    ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_095/./firefox/10-manual.yml">10-manual.yml</a><br/>
    ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_095/./firefox/20-manual.yml">20-manual.yml</a><br/>
    ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_095/./firefox/30-auto.yml">30-auto.yml</a><br/>
    ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_095/./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_095/./firefox/50-prompt_authentication.yml">50-prompt_authentication.yml</a><br/>
<a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_096/./">.</a><br/>
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_096/./firefox/">firefox</a><br/>
    ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_096/./firefox/00-proxy.yml">00-proxy.yml</a><br/>
    ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_096/./firefox/10-manual.yml">10-manual.yml</a><br/>
    ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_096/./firefox/20-manual.yml">20-manual.yml</a><br/>
    ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_096/./firefox/30-auto.yml">30-auto.yml</a><br/>
    ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_096/./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_096/./firefox/50-prompt_authentication.yml">50-prompt_authentication.yml</a><br/>
    └── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_096/./firefox/55-proxy_dns_socks5.yml">55-proxy_dns_socks5.yml</a><br/>
<br/><br/></p>
Contents of the firefox/50-prompt_authentication.yml file
Contents of the firefox/55-proxy_dns_socks5.yml file
```yml
%YAML 1.2
---
version: 1.1
prompt_authentication:
description: Prompt for authentication if password is saved
default: true
disabled:
variable: _.proxy_mode
when: No proxy
proxy_dns_socks5: false # Use proxy DNS when using SOCKS v5
...
```
@ -122,6 +118,7 @@ rougail -m firefox/ -o doc
| **<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) `multiple` *`disabled`* `unique` | Address for which proxy will be desactivated.<br/>Connections to localhost, 127.0.0.1/8 and ::1 are never proxied.<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/>**Examples**: <br/>•&nbsp;.mozilla.org<br/>•&nbsp;.net.nz<br/>•&nbsp;192.168.1.0/24<br/>**Disabled**: when the variable "[Configure Proxy Access to the Internet](#proxy_mode)" has the value "No proxy" |
| **<a id="prompt_authentication" name="prompt_authentication">prompt_authentication</a>**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` *`disabled`* | Prompt for authentication if password is saved.<br/>**Default**: true<br/>**Disabled**: when the variable "[Configure Proxy Access to the Internet](#proxy_mode)" has the value "No proxy" |
| **<a id="proxy_dns_socks5" name="proxy_dns_socks5">proxy_dns_socks5</a>**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Use proxy DNS when using SOCKS v5.<br/>**Default**: false |
### Let's generate the changelog
@ -130,9 +127,9 @@ rougail -m firefox/ -o doc --doc.contents changelog
```
#### New variable
| Variable | Description |
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **<a id="prompt_authentication" name="prompt_authentication">prompt_authentication</a>**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` *`disabled`* | Prompt for authentication if password is saved.<br/>**Default**: true<br/>**Disabled**: when the variable "[Configure Proxy Access to the Internet](#proxy_mode)" has the value "No proxy" |
| Variable | Description |
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------|
| **<a id="proxy_dns_socks5" name="proxy_dns_socks5">proxy_dns_socks5</a>**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Use proxy DNS when using SOCKS v5.<br/>**Default**: false |
## User datas
@ -154,7 +151,8 @@ rougail -m firefox/ -u yaml -yf config/01/config.yml
│ <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>
<span style="color: #5c5cff">┣━━ </span>📓 <span style="color: #ff0000">Configure Proxy Access to the Internet</span>: <span style="color: #ffd700">No proxy</span>
<span style="color: #5c5cff">┗━━ </span>📓 <span style="color: #ff0000">Use proxy DNS when using SOCKS v5</span>: <span style="color: #ffd700">false</span>
</pre>
### Example 2
@ -192,7 +190,8 @@ Variables:
<span style="color: #5c5cff">┃ </span><span style="color: #5c5cff"> </span><span style="color: #5c5cff">┣━━ </span>📓 <span style="color: #ff0000">SOCKS port</span>: <span style="color: #ffd700">8080</span>
<span style="color: #5c5cff">┃ </span><span style="color: #5c5cff"> </span><span style="color: #5c5cff">┗━━ </span>📓 <span style="color: #ff0000">SOCKS host version used by proxy</span>: <span style="color: #ffd700">v5</span>
<span style="color: #5c5cff">┣━━ </span>📓 <span style="color: #ff0000">Address for which proxy will be desactivated</span>:
<span style="color: #5c5cff">┗━━ </span>📓 <span style="color: #ff0000">Prompt for authentication if password is saved</span>: <span style="color: #ffd700">true</span>
<span style="color: #5c5cff">┣━━ </span>📓 <span style="color: #ff0000">Prompt for authentication if password is saved</span>: <span style="color: #ffd700">true</span>
<span style="color: #5c5cff">┗━━ </span>📓 <span style="color: #ff0000">Use proxy DNS when using SOCKS v5</span>: <span style="color: #ffd700">false</span>
</pre>
### Example 3
@ -212,10 +211,7 @@ proxy_dns_socks5: true
```shell
rougail -m firefox/ -u yaml -yf config/03/config.yml
```
<pre><span style="font-weight: bold; color: #ffff00">🔔 WARNINGS</span>
<span style="color: #ffff00">┗━━ </span>variable or family "proxy_dns_socks5" does not exist, it will be ignored
<span style="color: #ffff00"> </span>when loading from the YAML file "config/03/config.yml"
╭─────────────────────────── Caption ────────────────────────────╮
<pre>╭─────────────────────────── Caption ────────────────────────────╮
│ Variable <span style="color: #ffd700">Default value</span> │
│ <span style="color: #ff0000">Undocumented but modified variable</span> <span style="color: #00aa00">Modified value</span> │
│ (⏳ Original default value) │
@ -234,7 +230,9 @@ Variables:
<span style="color: #5c5cff">┃ </span><span style="color: #5c5cff"> </span><span style="color: #5c5cff">┣━━ </span>📓 <span style="color: #ff0000">SOCKS port</span>: <span style="color: #ffd700">8080</span>
<span style="color: #5c5cff">┃ </span><span style="color: #5c5cff"> </span><span style="color: #5c5cff">┗━━ </span>📓 <span style="color: #ff0000">SOCKS host version used by proxy</span>: <span style="color: #ffd700">v5</span>
<span style="color: #5c5cff">┣━━ </span>📓 <span style="color: #ff0000">Address for which proxy will be desactivated</span>:
<span style="color: #5c5cff">┗━━ </span>📓 <span style="color: #ff0000">Prompt for authentication if password is saved</span>: <span style="color: #ffd700">true</span>
<span style="color: #5c5cff">┣━━ </span>📓 <span style="color: #ff0000">Prompt for authentication if password is saved</span>: <span style="color: #ffd700">true</span>
<span style="color: #5c5cff">┗━━ </span>📓 <span style="color: #ff0000">Use proxy DNS when using SOCKS v5</span>: <span style="color: #00aa00">true</span> ◀ loaded from the YAML file
<span style="color: #5c5cff"> </span>"config/03/config.yml" (⏳ false)
</pre>
### Example 4
@ -275,8 +273,9 @@ Variables:
<span style="color: #5c5cff">┃ </span><span style="color: #5c5cff"> </span><span style="color: #5c5cff">┗━━ </span>📓 <span style="color: #ff0000">SOCKS host version used by proxy</span>: <span style="color: #00aa00">v4</span> ◀ loaded from the YAML file
<span style="color: #5c5cff">┃ </span><span style="color: #5c5cff"> </span><span style="color: #5c5cff"> </span>"config/04/config.yml" (⏳ v5)
<span style="color: #5c5cff">┣━━ </span>📓 <span style="color: #ff0000">Address for which proxy will be desactivated</span>:
<span style="color: #5c5cff">┗━━ </span>📓 <span style="color: #ff0000">Prompt for authentication if password is saved</span>: <span style="color: #ffd700">true</span>
<span style="color: #5c5cff">┣━━ </span>📓 <span style="color: #ff0000">Prompt for authentication if password is saved</span>: <span style="color: #ffd700">true</span>
<span style="color: #5c5cff">┗━━ </span>📓 <span style="color: #ff0000">Use proxy DNS when using SOCKS v5</span>: <span style="color: #ffd700">false</span>
</pre>
- [[tutorial v1.1_096] A boolean variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_096/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_096~1..v1.1_096))
- [[tutorial v1.1_097] A Jinja conditional disabled boolean variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_097/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_097~1..v1.1_097))

3
config/01/output_ro.html
View file

@ -2,5 +2,6 @@
│ <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>
<span style="color: #5c5cff">┣━━ </span>📓 <span style="color: #ff0000">Configure Proxy Access to the Internet</span>: <span style="color: #ffd700">No proxy</span>
<span style="color: #5c5cff">┗━━ </span>📓 <span style="color: #ff0000">Use proxy DNS when using SOCKS v5</span>: <span style="color: #ffd700">false</span>
</pre>

3
config/02/output_ro.html
View file

@ -17,5 +17,6 @@ Variables:
<span style="color: #5c5cff">┃ </span><span style="color: #5c5cff"> </span><span style="color: #5c5cff">┣━━ </span>📓 <span style="color: #ff0000">SOCKS port</span>: <span style="color: #ffd700">8080</span>
<span style="color: #5c5cff">┃ </span><span style="color: #5c5cff"> </span><span style="color: #5c5cff">┗━━ </span>📓 <span style="color: #ff0000">SOCKS host version used by proxy</span>: <span style="color: #ffd700">v5</span>
<span style="color: #5c5cff">┣━━ </span>📓 <span style="color: #ff0000">Address for which proxy will be desactivated</span>:
<span style="color: #5c5cff">┗━━ </span>📓 <span style="color: #ff0000">Prompt for authentication if password is saved</span>: <span style="color: #ffd700">true</span>
<span style="color: #5c5cff">┣━━ </span>📓 <span style="color: #ff0000">Prompt for authentication if password is saved</span>: <span style="color: #ffd700">true</span>
<span style="color: #5c5cff">┗━━ </span>📓 <span style="color: #ff0000">Use proxy DNS when using SOCKS v5</span>: <span style="color: #ffd700">false</span>
</pre>

9
config/03/output_ro.html
View file

@ -1,7 +1,4 @@
<pre><span style="font-weight: bold; color: #ffff00">🔔 WARNINGS</span>
<span style="color: #ffff00">┗━━ </span>variable or family "proxy_dns_socks5" does not exist, it will be ignored
<span style="color: #ffff00"> </span>when loading from the YAML file "config/03/config.yml"
╭─────────────────────────── Caption ────────────────────────────╮
<pre>╭─────────────────────────── Caption ────────────────────────────╮
│ Variable <span style="color: #ffd700">Default value</span> │
│ <span style="color: #ff0000">Undocumented but modified variable</span> <span style="color: #00aa00">Modified value</span> │
│ (⏳ Original default value) │
@ -20,5 +17,7 @@ Variables:
<span style="color: #5c5cff">┃ </span><span style="color: #5c5cff"> </span><span style="color: #5c5cff">┣━━ </span>📓 <span style="color: #ff0000">SOCKS port</span>: <span style="color: #ffd700">8080</span>
<span style="color: #5c5cff">┃ </span><span style="color: #5c5cff"> </span><span style="color: #5c5cff">┗━━ </span>📓 <span style="color: #ff0000">SOCKS host version used by proxy</span>: <span style="color: #ffd700">v5</span>
<span style="color: #5c5cff">┣━━ </span>📓 <span style="color: #ff0000">Address for which proxy will be desactivated</span>:
<span style="color: #5c5cff">┗━━ </span>📓 <span style="color: #ff0000">Prompt for authentication if password is saved</span>: <span style="color: #ffd700">true</span>
<span style="color: #5c5cff">┣━━ </span>📓 <span style="color: #ff0000">Prompt for authentication if password is saved</span>: <span style="color: #ffd700">true</span>
<span style="color: #5c5cff">┗━━ </span>📓 <span style="color: #ff0000">Use proxy DNS when using SOCKS v5</span>: <span style="color: #00aa00">true</span> ◀ loaded from the YAML file
<span style="color: #5c5cff"> </span>"config/03/config.yml" (⏳ false)
</pre>

3
config/04/output_ro.html
View file

@ -18,5 +18,6 @@ Variables:
<span style="color: #5c5cff">┃ </span><span style="color: #5c5cff"> </span><span style="color: #5c5cff">┗━━ </span>📓 <span style="color: #ff0000">SOCKS host version used by proxy</span>: <span style="color: #00aa00">v4</span> ◀ loaded from the YAML file
<span style="color: #5c5cff">┃ </span><span style="color: #5c5cff"> </span><span style="color: #5c5cff"> </span>"config/04/config.yml" (⏳ v5)
<span style="color: #5c5cff">┣━━ </span>📓 <span style="color: #ff0000">Address for which proxy will be desactivated</span>:
<span style="color: #5c5cff">┗━━ </span>📓 <span style="color: #ff0000">Prompt for authentication if password is saved</span>: <span style="color: #ffd700">true</span>
<span style="color: #5c5cff">┣━━ </span>📓 <span style="color: #ff0000">Prompt for authentication if password is saved</span>: <span style="color: #ffd700">true</span>
<span style="color: #5c5cff">┗━━ </span>📓 <span style="color: #ff0000">Use proxy DNS when using SOCKS v5</span>: <span style="color: #ffd700">false</span>
</pre>

19
tree.html
View file

@ -25,17 +25,18 @@
</head>
<body>
<h1>Directory Tree</h1><p>
<a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_095/./">.</a><br>
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_095/./firefox/">firefox</a><br>
&nbsp;&nbsp;&nbsp; ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_095/./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_095/./firefox/10-manual.yml">10-manual.yml</a><br>
&nbsp;&nbsp;&nbsp; ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_095/./firefox/20-manual.yml">20-manual.yml</a><br>
&nbsp;&nbsp;&nbsp; ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_095/./firefox/30-auto.yml">30-auto.yml</a><br>
&nbsp;&nbsp;&nbsp; ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_095/./firefox/40-no_proxy.yml">40-no_proxy.yml</a><br>
&nbsp;&nbsp;&nbsp; └── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_095/./firefox/50-prompt_authentication.yml">50-prompt_authentication.yml</a><br>
<a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_096/./">.</a><br>
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_096/./firefox/">firefox</a><br>
&nbsp;&nbsp;&nbsp; ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_096/./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_096/./firefox/10-manual.yml">10-manual.yml</a><br>
&nbsp;&nbsp;&nbsp; ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_096/./firefox/20-manual.yml">20-manual.yml</a><br>
&nbsp;&nbsp;&nbsp; ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_096/./firefox/30-auto.yml">30-auto.yml</a><br>
&nbsp;&nbsp;&nbsp; ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_096/./firefox/40-no_proxy.yml">40-no_proxy.yml</a><br>
&nbsp;&nbsp;&nbsp; ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_096/./firefox/50-prompt_authentication.yml">50-prompt_authentication.yml</a><br>
&nbsp;&nbsp;&nbsp; └── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_096/./firefox/55-proxy_dns_socks5.yml">55-proxy_dns_socks5.yml</a><br>
<br><br><p>
2 directories, 6 files
2 directories, 7 files
</p>
<hr>