From 49f24bfb78f49219840a985fc757e5d26706ed33 Mon Sep 17 00:00:00 2001 From: Emmanuel Garette Date: Mon, 10 Nov 2025 08:21:38 +0100 Subject: [PATCH] [tutorial v1.1_084)] Help (config and doc) --- README.md | 86 +++++++++++++++++++++++----------------- config/02/config.yml | 8 +--- config/02/output_ro.html | 18 ++------- config/03/cmd_ro.txt | 1 + config/03/config.yml | 6 +++ config/03/output_ro.html | 11 +++++ tree.html | 14 +++---- 7 files changed, 80 insertions(+), 64 deletions(-) create mode 100644 config/03/cmd_ro.txt create mode 100644 config/03/config.yml create mode 100644 config/03/output_ro.html diff --git a/README.md b/README.md index e53f9883..d6a0cf86 100644 --- 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_082] A non mandatory variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_082/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_082~1..v1.1_082)) +- [[tutorial v1.1_083] Examples](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_083/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_083~1..v1.1_083)) -# [tutorial v1.1_083)] Examples +# [tutorial v1.1_084)] Help -[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_083~1..v1.1_083) +[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_084~1..v1.1_084) -[Read the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#examples) +[Read the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#help) ## 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_083 +git switch --detach v1.1_084 ``` ## Structure @@ -39,13 +39,13 @@ git switch --detach v1.1_083

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


Contents of the firefox/40-no_proxy.yml file @@ -57,6 +57,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 @@ -126,7 +127,7 @@ rougail -m firefox/ -o doc | Variable                                                                                                                 | Description                                                                                                              | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **auto**
[`web_address`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` *`disabled`* | Automatic proxy configuration URL.
**Validator**: the domain name in web address can be only a hostname
**Disabled**: when the variable "proxy_mode" hasn't the value "Automatic proxy configuration URL" | -| **no_proxy**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) *`disabled`* `unique` `multiple` | Address for which proxy will be desactivated.
**Validators**:
- 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 "proxy_mode" has the value "No proxy" | +| **no_proxy**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) *`disabled`* `unique` `multiple` | Address for which proxy will be desactivated.
Connections to localhost, 127.0.0.1/8 and ::1 are never proxied.
**Validators**:
- 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 "proxy_mode" has the value "No proxy" | ### Let's generate the changelog @@ -137,7 +138,7 @@ rougail -m firefox/ -o doc --doc.contents changelog | Variable                                                                                                                 | Description                                                                                                              | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **no_proxy**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) *`disabled`* `unique` `multiple` | Address for which proxy will be desactivated.
**Validators**:
- 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 "proxy_mode" has the value "No proxy" | +| **no_proxy**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) *`disabled`* `unique` `multiple` | Address for which proxy will be desactivated.
Connections to localhost, 127.0.0.1/8 and ::1 are never proxied.
**Validators**:
- 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 "proxy_mode" has the value "No proxy" | ## User datas @@ -168,12 +169,8 @@ Variables: ```yml --- -proxy_mode: Manual proxy configuration -manual: - http_proxy: - address: http.proxy.net - port: 3128 - use_for_https: false +proxy_mode: Automatic proxy configuration URL +auto: https://auto.proxy.net/wpad.dat ``` #### Output @@ -181,26 +178,43 @@ manual: rougail -m firefox/ -u yaml -yf config/02/config.yml ``` 
╭────────────── Caption ───────────────╮
-│ Variable Default value               │
-│          Modified value              │
+│ Variable Modified value              │
 │          (⏳ Original default value) │
 ╰──────────────────────────────────────╯
 Variables:
-┣━━ 📓 Configure Proxy Access to the Internet: Manual proxy configuration ◀ loaded from the YAML file "config/02/config.yml" (⏳ No proxy)
-┣━━ 📂 Manual proxy configuration
-┃   ┣━━ 📂 HTTP Proxy
-┃   ┃   ┣━━ 📓 HTTP address: http.proxy.net ◀ loaded from the YAML file "config/02/config.yml"
-┃   ┃   ┗━━ 📓 HTTP Port: 3128 ◀ loaded from the YAML file "config/02/config.yml" (⏳ 8080)
-┃   ┣━━ 📓 Also use this proxy for HTTPS: false ◀ loaded from the YAML file "config/02/config.yml" (⏳ true)
-┃   ┣━━ 📂 HTTPS Proxy
-┃   ┃   ┣━━ 📓 HTTPS address: http.proxy.net
-┃   ┃   ┗━━ 📓 HTTPS port: 3128
-┃   ┗━━ 📂 SOCKS Proxy
-┃       ┣━━ 📓 SOCKS address: http.proxy.net
-┃       ┣━━ 📓 SOCKS port: 3128
-┃       ┗━━ 📓 SOCKS host version used by proxy: v5
+┣━━ 📓 Configure Proxy Access to the Internet: Automatic proxy configuration URL ◀ loaded from the YAML file "config/02/config.yml" (⏳ No proxy)
+┣━━ 📓 Automatic proxy configuration URL: https://auto.proxy.net/wpad.dat ◀ loaded from the YAML file "config/02/config.yml"
 ┗━━ 📓 Address for which proxy will be desactivated:
+### Example 3 + +#### config/03/config.yml + + +```yml +--- +proxy_mode: Automatic proxy configuration URL +auto: https://auto.proxy.net/wpad.dat +no_proxy: + - .example.net + - 192.168.1.0/24 +``` +#### Output + +```shell +rougail -m firefox/ -u yaml -yf config/03/config.yml +``` +
╭────────────── Caption ───────────────╮
+│ Variable Modified value              │
+│          (⏳ Original default value) │
+╰──────────────────────────────────────╯
+Variables:
+┣━━ 📓 Configure Proxy Access to the Internet: Automatic proxy configuration URL ◀ loaded from the YAML file "config/03/config.yml" (⏳ No proxy)
+┣━━ 📓 Automatic proxy configuration URL: https://auto.proxy.net/wpad.dat ◀ loaded from the YAML file "config/03/config.yml"
+┗━━ 📓 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_084] Help](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_084/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_084~1..v1.1_084)) +- [[tutorial v1.1_085] A conditional disabled boolean variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_085/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_085~1..v1.1_085)) diff --git a/config/02/config.yml b/config/02/config.yml index 9b246a4a..307e175b 100644 --- a/config/02/config.yml +++ b/config/02/config.yml @@ -1,7 +1,3 @@ --- -proxy_mode: Manual proxy configuration -manual: - http_proxy: - address: http.proxy.net - port: 3128 - use_for_https: false +proxy_mode: Automatic proxy configuration URL +auto: https://auto.proxy.net/wpad.dat diff --git a/config/02/output_ro.html b/config/02/output_ro.html index 95b62232..cf9920f9 100644 --- a/config/02/output_ro.html +++ b/config/02/output_ro.html @@ -1,21 +1,9 @@ 
╭────────────── Caption ───────────────╮
-│ Variable Default value               │
-│          Modified value              │
+│ Variable Modified value              │
 │          (⏳ Original default value) │
 ╰──────────────────────────────────────╯
 Variables:
-┣━━ 📓 Configure Proxy Access to the Internet: Manual proxy configuration ◀ loaded from the YAML file "config/02/config.yml" (⏳ No proxy)
-┣━━ 📂 Manual proxy configuration
-┃   ┣━━ 📂 HTTP Proxy
-┃   ┃   ┣━━ 📓 HTTP address: http.proxy.net ◀ loaded from the YAML file "config/02/config.yml"
-┃   ┃   ┗━━ 📓 HTTP Port: 3128 ◀ loaded from the YAML file "config/02/config.yml" (⏳ 8080)
-┃   ┣━━ 📓 Also use this proxy for HTTPS: false ◀ loaded from the YAML file "config/02/config.yml" (⏳ true)
-┃   ┣━━ 📂 HTTPS Proxy
-┃   ┃   ┣━━ 📓 HTTPS address: http.proxy.net
-┃   ┃   ┗━━ 📓 HTTPS port: 3128
-┃   ┗━━ 📂 SOCKS Proxy
-┃       ┣━━ 📓 SOCKS address: http.proxy.net
-┃       ┣━━ 📓 SOCKS port: 3128
-┃       ┗━━ 📓 SOCKS host version used by proxy: v5
+┣━━ 📓 Configure Proxy Access to the Internet: Automatic proxy configuration URL ◀ loaded from the YAML file "config/02/config.yml" (⏳ No proxy)
+┣━━ 📓 Automatic proxy configuration URL: https://auto.proxy.net/wpad.dat ◀ loaded from the YAML file "config/02/config.yml"
 ┗━━ 📓 Address for which proxy will be desactivated:
diff --git a/config/03/cmd_ro.txt b/config/03/cmd_ro.txt new file mode 100644 index 00000000..fc8085eb --- /dev/null +++ b/config/03/cmd_ro.txt @@ -0,0 +1 @@ +rougail -m firefox/ -u yaml -yf config/03/config.yml \ No newline at end of file diff --git a/config/03/config.yml b/config/03/config.yml new file mode 100644 index 00000000..53198970 --- /dev/null +++ b/config/03/config.yml @@ -0,0 +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 new file mode 100644 index 00000000..85e27e83 --- /dev/null +++ b/config/03/output_ro.html @@ -0,0 +1,11 @@ +
╭────────────── Caption ───────────────╮
+│ Variable Modified value              │
+│          (⏳ Original default value) │
+╰──────────────────────────────────────╯
+Variables:
+┣━━ 📓 Configure Proxy Access to the Internet: Automatic proxy configuration URL ◀ loaded from the YAML file "config/03/config.yml" (⏳ No proxy)
+┣━━ 📓 Automatic proxy configuration URL: https://auto.proxy.net/wpad.dat ◀ loaded from the YAML file "config/03/config.yml"
+┗━━ 📓 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 1a5c9bb6..67df1f0c 100644 --- a/tree.html +++ b/tree.html @@ -25,13 +25,13 @@

Directory Tree

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


2 directories, 5 files