From 64e8fb830c3bfa1ba2caa4a32aba283ae6b98f41 Mon Sep 17 00:00:00 2001 From: Emmanuel Garette Date: Mon, 9 Mar 2026 09:12:46 +0100 Subject: [PATCH] [tutorial v1.1_104] Help (config and doc) --- README.md | 61 ++++++++++++++++++++-------------------- config/02/config.yml | 3 -- config/02/output_ro.html | 7 ++--- config/03/config.yml | 3 ++ config/03/output_ro.html | 7 +++-- tree.html | 20 ++++++------- 6 files changed, 51 insertions(+), 50 deletions(-) diff --git a/README.md b/README.md index 8b67cfee..528c7850 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@ - [Summary](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/branch/1.1/README.md) -- [[tutorial v1.1_102] A non mandatory variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_102/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_103~1..v1.1_103)) +- [[tutorial v1.1_103] Examples](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_103/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_104~1..v1.1_104)) -# [tutorial v1.1_103] Examples +# [tutorial v1.1_104] Help -[Read the tutorial "Examples" in the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/jinja.html#examples) +[Read the tutorial "Help" in the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/jinja.html#help) ## Screenshot @@ -29,7 +29,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_103 +git switch --detach v1.1_104 ``` ## Structure @@ -37,16 +37,16 @@ git switch --detach v1.1_103

-.
- ├── firefox
- │   ├── 00-proxy.yml
- │   ├── 10-manual.yml
- │   ├── 20-manual.yml
- │   ├── 30-auto.yml
- │   └── 40-no_proxy.yml
- └── types
-     └── proxy
-         └── 00_type.yml
+.
+ ├── firefox
+ │   ├── 00-proxy.yml
+ │   ├── 10-manual.yml
+ │   ├── 20-manual.yml
+ │   ├── 30-auto.yml
+ │   └── 40-no_proxy.yml
+ └── types
+     └── proxy
+         └── 00_type.yml


Contents of the firefox/40-no_proxy.yml file @@ -58,6 +58,7 @@ version: 1.1 no_proxy: description: Address for which proxy will be desactivated + help: Connections to localhost, 127.0.0.1/8 and ::1 are never proxied examples: - .mozilla.org - .net.nz @@ -135,10 +136,10 @@ rougail -m firefox/ --types types/proxy -o doc | **manual.socks_proxy.port**
[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Proxy port.
**Validators**:
• well-known ports (1 to 1023) are allowed
• registred ports (1024 to 49151) are allowed
• private ports (greater than 49152) are allowed
**Default**: 8080 | | **manual.socks_proxy.version**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | SOCKS host version used by proxy.
**Choices**:
• v4
• v5 **← (default)** | -| Variable | Description | -|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **auto**
[`web address`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` *`disabled`* | Automatic proxy configuration URL.
**Validators**:
• well-known ports (1 to 1023) are allowed
• registred ports (1024 to 49151) are allowed
• type domainname
• the domain name can be a hostname
**Disabled**: when the variable "[Configure Proxy Access to the Internet](#proxy_mode)" hasn't the value "Automatic proxy configuration URL" | -| **no_proxy**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` *`disabled`* `unique` | Address for which proxy will be desactivated.
**Validators**:
• type domainname
• the domain name can starts by a dot
• the domain name can be a hostname
• the domain name can be an IP
• the domain name can be network in CIDR format
**Examples**:
• .mozilla.org
• .net.nz
• 192.168.1.0/24
**Disabled**: when the variable "[Configure Proxy Access to the Internet](#proxy_mode)" has the value "No proxy" | +| Variable | Description | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **auto**
[`web address`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` *`disabled`* | Automatic proxy configuration URL.
**Validators**:
• well-known ports (1 to 1023) are allowed
• registred ports (1024 to 49151) are allowed
• type domainname
• the domain name can be a hostname
**Disabled**: when the variable "[Configure Proxy Access to the Internet](#proxy_mode)" hasn't the value "Automatic proxy configuration URL" | +| **no_proxy**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` *`disabled`* `unique` | Address for which proxy will be desactivated.
Connections to localhost, 127.0.0.1/8 and ::1 are never proxied.
**Validators**:
• type domainname
• the domain name can starts by a dot
• the domain name can be a hostname
• the domain name can be an IP
• the domain name can be network in CIDR format
**Examples**:
• .mozilla.org
• .net.nz
• 192.168.1.0/24
**Disabled**: when the variable "[Configure Proxy Access to the Internet](#proxy_mode)" has the value "No proxy" | *** @@ -149,9 +150,9 @@ rougail -m firefox/ --types types/proxy -o doc --doc.contents changelog --doc.ch ``` #### Modified variable -| Variable | Description | -|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **no_proxy**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` *`disabled`* `unique` | Address for which proxy will be desactivated.
**Validators**:
• type domainname
• the domain name can starts by a dot
• the domain name can be a hostname
• the domain name can be an IP
• the domain name can be network in CIDR format
**Examples**:
• .mozilla.org
• .net.nz
• 192.168.1.0/24
**Disabled**: when the variable "[Configure Proxy Access to the Internet](#proxy_mode)" has the value "No proxy" | +| Variable | Description | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **no_proxy**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` *`disabled`* `unique` | Address for which proxy will be desactivated.
Connections to localhost, 127.0.0.1/8 and ::1 are never proxied.
**Validators**:
• type domainname
• the domain name can starts by a dot
• the domain name can be a hostname
• the domain name can be an IP
• the domain name can be network in CIDR format
**Examples**:
• .mozilla.org
• .net.nz
• 192.168.1.0/24
**Disabled**: when the variable "[Configure Proxy Access to the Internet](#proxy_mode)" has the value "No proxy" | *** @@ -191,9 +192,6 @@ Variables: --- proxy_mode: Automatic proxy configuration URL auto: https://auto.proxy.net/wpad.dat -no_proxy: - - example.net - - 192.168.1.0/24 ``` *** @@ -206,15 +204,14 @@ rougail -m firefox/ --types types/proxy -u yaml -yf config/02/config.yml > > **Caption:** > - Variable +> - Default value > - Modified value > - (:hourglass_flowing_sand: Original default value) Variables: - :notebook: proxy_mode (Configure Proxy Access to the Internet): Automatic proxy configuration URL ← loaded from the YAML file "config/02/config.yml" (:hourglass_flowing_sand: No proxy) - :notebook: auto (Automatic proxy configuration URL): https://auto.proxy.net/wpad.dat ← loaded from the YAML file "config/02/config.yml" -- :notebook: no_proxy (Address for which proxy will be desactivated): - - example.net ← loaded from the YAML file "config/02/config.yml" - - 192.168.1.0/24 ← loaded from the YAML file "config/02/config.yml" +- :notebook: no_proxy (Address for which proxy will be desactivated): [] *** ### Example 3 @@ -226,6 +223,9 @@ Variables: --- proxy_mode: Automatic proxy configuration URL auto: https://auto.proxy.net/wpad.dat +no_proxy: + - .example.net + - 192.168.1.0/24 ``` *** @@ -238,16 +238,17 @@ rougail -m firefox/ --types types/proxy -u yaml -yf config/03/config.yml > > **Caption:** > - Variable -> - Default value > - Modified value > - (:hourglass_flowing_sand: Original default value) Variables: - :notebook: proxy_mode (Configure Proxy Access to the Internet): Automatic proxy configuration URL ← loaded from the YAML file "config/03/config.yml" (:hourglass_flowing_sand: No proxy) - :notebook: auto (Automatic proxy configuration URL): https://auto.proxy.net/wpad.dat ← loaded from the YAML file "config/03/config.yml" -- :notebook: no_proxy (Address for which proxy will be desactivated): [] +- :notebook: no_proxy (Address for which proxy will be desactivated): + - .example.net ← loaded from the YAML file "config/03/config.yml" + - 192.168.1.0/24 ← loaded from the YAML file "config/03/config.yml" *** -- [[tutorial v1.1_104] Help](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_104/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_104~1..v1.1_104)) +- [[tutorial v1.1_110] A conditional disabled boolean variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_110/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_110~1..v1.1_110)) diff --git a/config/02/config.yml b/config/02/config.yml index ccba4c0f..307e175b 100644 --- a/config/02/config.yml +++ b/config/02/config.yml @@ -1,6 +1,3 @@ --- proxy_mode: Automatic proxy configuration URL auto: https://auto.proxy.net/wpad.dat -no_proxy: - - example.net - - 192.168.1.0/24 diff --git a/config/02/output_ro.html b/config/02/output_ro.html index 4b911fab..661ecbb3 100644 --- a/config/02/output_ro.html +++ b/config/02/output_ro.html @@ -1,5 +1,6 @@ 
╭────────────── Caption ───────────────╮
-│ Variable Modified value              │
+│ Variable Default value               │
+│          Modified value              │
 │          (⏳ Original default value) │
 ╰──────────────────────────────────────╯
 Variables:
@@ -8,7 +9,5 @@ Variables:
 ┃   proxy)
 ┣━━ 📓 auto (Automatic proxy configuration URL): https://auto.proxy.net/wpad.dat
 ┃   ◀ loaded from the YAML file "config/02/config.yml"
-┗━━ 📓 no_proxy (Address for which proxy will be desactivated):
-    ┣━━ example.net ◀ loaded from the YAML file "config/02/config.yml"
-    ┗━━ 192.168.1.0/24 ◀ loaded from the YAML file "config/02/config.yml"
+┗━━ 📓 no_proxy (Address for which proxy will be desactivated): []
diff --git a/config/03/config.yml b/config/03/config.yml index 307e175b..53198970 100644 --- a/config/03/config.yml +++ b/config/03/config.yml @@ -1,3 +1,6 @@ --- proxy_mode: Automatic proxy configuration URL auto: https://auto.proxy.net/wpad.dat +no_proxy: + - .example.net + - 192.168.1.0/24 diff --git a/config/03/output_ro.html b/config/03/output_ro.html index 2733e947..f35b2ad7 100644 --- a/config/03/output_ro.html +++ b/config/03/output_ro.html @@ -1,6 +1,5 @@ 
╭────────────── Caption ───────────────╮
-│ Variable Default value               │
-│          Modified value              │
+│ Variable Modified value              │
 │          (⏳ Original default value) │
 ╰──────────────────────────────────────╯
 Variables:
@@ -9,5 +8,7 @@ Variables:
 ┃   proxy)
 ┣━━ 📓 auto (Automatic proxy configuration URL): https://auto.proxy.net/wpad.dat
 ┃   ◀ loaded from the YAML file "config/03/config.yml"
-┗━━ 📓 no_proxy (Address for which proxy will be desactivated): []
+┗━━ 📓 no_proxy (Address for which proxy will be desactivated):
+    ┣━━ .example.net ◀ loaded from the YAML file "config/03/config.yml"
+    ┗━━ 192.168.1.0/24 ◀ loaded from the YAML file "config/03/config.yml"
diff --git a/tree.html b/tree.html index 3cecc0f7..1743f63f 100644 --- a/tree.html +++ b/tree.html @@ -1,12 +1,12 @@

-.
- ├── firefox
- │   ├── 00-proxy.yml
- │   ├── 10-manual.yml
- │   ├── 20-manual.yml
- │   ├── 30-auto.yml
- │   └── 40-no_proxy.yml
- └── types
-     └── proxy
-         └── 00_type.yml
+.
+ ├── firefox
+ │   ├── 00-proxy.yml
+ │   ├── 10-manual.yml
+ │   ├── 20-manual.yml
+ │   ├── 30-auto.yml
+ │   └── 40-no_proxy.yml
+ └── types
+     └── proxy
+         └── 00_type.yml


\ No newline at end of file