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

2026-01-06 16:53:48 +01:00 · 2026-01-06 16:53:48 +01:00 · 677bc76f38
commit 677bc76f38
parent 081f338987
6 changed files with 47 additions and 48 deletions
--- a/README.md
+++ b/README.md
@ -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
@ -158,6 +155,7 @@ rougail -m firefox/ -u yaml -yf config/01/config.yml

 Variables:
 - :notebook: proxy_mode (Configure Proxy Access to the Internet): <span style="color: #B8860B">No proxy</span>
+- :notebook: proxy_dns_socks5 (Use proxy DNS when using SOCKS v5): <span style="color: #B8860B">false</span>
 ### Example 2

 #### config/02/config.yml
@ -196,6 +194,7 @@ Variables:
    - :notebook: version (SOCKS host version used by proxy): <span style="color: #B8860B">v5</span>
 - :notebook: no_proxy (Address for which proxy will be desactivated): <span style="color: #B8860B">[]</span>
 - :notebook: prompt_authentication (Prompt for authentication if password is saved): <span style="color: #B8860B">true</span>
+- :notebook: proxy_dns_socks5 (Use proxy DNS when using SOCKS v5): <span style="color: #B8860B">false</span>
 ### Example 3

 #### config/03/config.yml
@ -214,10 +213,6 @@ proxy_dns_socks5: true
 ```shell
 rougail -m firefox/ -u yaml -yf config/03/config.yml
 ```
-> [!WARNING]
-> 
-> - variable or family "proxy_dns_socks5" does not exist, it will be ignored when loading from the YAML file "config/03/config.yml"
-
 > [!NOTE]
 >
 > **Caption:**
@ -239,6 +234,7 @@ Variables:
    - :notebook: version (SOCKS host version used by proxy): <span style="color: #B8860B">v5</span>
 - :notebook: no_proxy (Address for which proxy will be desactivated): <span style="color: #B8860B">[]</span>
 - :notebook: prompt_authentication (Prompt for authentication if password is saved): <span style="color: #B8860B">true</span>
+- :notebook: proxy_dns_socks5 (Use proxy DNS when using SOCKS v5): <span style="color: #006400">true</span> ← loaded from the YAML file "config/03/config.yml" (:hourglass_flowing_sand: false)
 ### Example 4

 #### config/04/config.yml
@ -279,6 +275,7 @@ Variables:
    - :notebook: version (SOCKS host version used by proxy): <span style="color: #006400">v4</span> ← loaded from the YAML file "config/04/config.yml" (:hourglass_flowing_sand: v5)
 - :notebook: no_proxy (Address for which proxy will be desactivated): <span style="color: #B8860B">[]</span>
 - :notebook: prompt_authentication (Prompt for authentication if password is saved): <span style="color: #B8860B">true</span>
+- :notebook: proxy_dns_socks5 (Use proxy DNS when using SOCKS v5): <span style="color: #B8860B">false</span>


- [[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))
--- a/config/01/output_ro.html
+++ b/config/01/output_ro.html
@ -2,5 +2,6 @@
 │ Variable <span style="color: #ffd700">Default 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>📓 proxy_mode (Configure Proxy Access to the Internet): <span style="color: #ffd700">No proxy</span>
+<span style="color: #5c5cff">┗━━ </span>📓 proxy_dns_socks5 (Use proxy DNS when using SOCKS v5): <span style="color: #ffd700">false</span>
 </pre>
--- a/config/02/output_ro.html
+++ b/config/02/output_ro.html
@ -18,6 +18,7 @@ Variables:
 <span style="color: #5c5cff">┃   </span><span style="color: #5c5cff">    </span><span style="color: #5c5cff">┣━━ </span>📓 port (SOCKS port): <span style="color: #ffd700">8080</span>
 <span style="color: #5c5cff">┃   </span><span style="color: #5c5cff">    </span><span style="color: #5c5cff">┗━━ </span>📓 version (SOCKS host version used by proxy): <span style="color: #ffd700">v5</span>
 <span style="color: #5c5cff">┣━━ </span>📓 no_proxy (Address for which proxy will be desactivated): <span style="color: #ffd700">[]</span>
-<span style="color: #5c5cff">┗━━ </span>📓 prompt_authentication (Prompt for authentication if password is saved): 
-<span style="color: #5c5cff">    </span><span style="color: #ffd700">true</span>
+<span style="color: #5c5cff">┣━━ </span>📓 prompt_authentication (Prompt for authentication if password is saved): 
+<span style="color: #5c5cff">┃   </span><span style="color: #ffd700">true</span>
+<span style="color: #5c5cff">┗━━ </span>📓 proxy_dns_socks5 (Use proxy DNS when using SOCKS v5): <span style="color: #ffd700">false</span>
 </pre>
--- a/config/03/output_ro.html
+++ b/config/03/output_ro.html
@ -1,8 +1,4 @@
-<pre><span style="font-weight: bold; color: #ffff00">🔔 Warning</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: #00aa00">Modified value</span>              │
 │          (⏳ Original default value) │
@ -22,6 +18,8 @@ Variables:
 <span style="color: #5c5cff">┃   </span><span style="color: #5c5cff">    </span><span style="color: #5c5cff">┣━━ </span>📓 port (SOCKS port): <span style="color: #ffd700">8080</span>
 <span style="color: #5c5cff">┃   </span><span style="color: #5c5cff">    </span><span style="color: #5c5cff">┗━━ </span>📓 version (SOCKS host version used by proxy): <span style="color: #ffd700">v5</span>
 <span style="color: #5c5cff">┣━━ </span>📓 no_proxy (Address for which proxy will be desactivated): <span style="color: #ffd700">[]</span>
-<span style="color: #5c5cff">┗━━ </span>📓 prompt_authentication (Prompt for authentication if password is saved): 
-<span style="color: #5c5cff">    </span><span style="color: #ffd700">true</span>
+<span style="color: #5c5cff">┣━━ </span>📓 prompt_authentication (Prompt for authentication if password is saved): 
+<span style="color: #5c5cff">┃   </span><span style="color: #ffd700">true</span>
+<span style="color: #5c5cff">┗━━ </span>📓 proxy_dns_socks5 (Use proxy DNS when using SOCKS v5): <span style="color: #00aa00">true</span> ◀ loaded from 
+<span style="color: #5c5cff">    </span>the YAML file "config/03/config.yml" (⏳ false)
 </pre>
--- a/config/04/output_ro.html
+++ b/config/04/output_ro.html
@ -19,6 +19,7 @@ Variables:
 <span style="color: #5c5cff">┃   </span><span style="color: #5c5cff">    </span><span style="color: #5c5cff">┗━━ </span>📓 version (SOCKS host version used by proxy): <span style="color: #00aa00">v4</span> ◀ loaded from the 
 <span style="color: #5c5cff">┃   </span><span style="color: #5c5cff">    </span><span style="color: #5c5cff">    </span>YAML file "config/04/config.yml" (⏳ v5)
 <span style="color: #5c5cff">┣━━ </span>📓 no_proxy (Address for which proxy will be desactivated): <span style="color: #ffd700">[]</span>
-<span style="color: #5c5cff">┗━━ </span>📓 prompt_authentication (Prompt for authentication if password is saved): 
-<span style="color: #5c5cff">    </span><span style="color: #ffd700">true</span>
+<span style="color: #5c5cff">┣━━ </span>📓 prompt_authentication (Prompt for authentication if password is saved): 
+<span style="color: #5c5cff">┃   </span><span style="color: #ffd700">true</span>
+<span style="color: #5c5cff">┗━━ </span>📓 proxy_dns_socks5 (Use proxy DNS when using SOCKS v5): <span style="color: #ffd700">false</span>
 </pre>
--- a/tree.html
+++ b/tree.html
@ -1,10 +1,11 @@
 <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>