From beba7389d706651fff22b70ead8ff12b778f3d7d Mon Sep 17 00:00:00 2001 From: Emmanuel Garette Date: Tue, 2 Dec 2025 16:18:42 +0100 Subject: [PATCH] [tutorial v1.1_050] A calculated default value (config and doc) --- README.md | 79 +++++++++++++++++----------------------- config/01/output_ro.html | 4 +- config/02/cmd_ro.txt | 1 - config/02/config.yml | 7 ---- config/02/output_ro.html | 4 -- tree.html | 10 ++--- 6 files changed, 41 insertions(+), 64 deletions(-) delete mode 100644 config/02/cmd_ro.txt delete mode 100644 config/02/config.yml delete mode 100644 config/02/output_ro.html diff --git a/README.md b/README.md index 1b0739ec..55ada830 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_042] Copy HTTP manual proxy to HTTPS manual proxy](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_042/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_042~1..v1.1_042)) +- [[tutorial v1.1_043] A conditional hidden family](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_043/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_043~1..v1.1_043)) -# [tutorial v1.1_043] A conditional hidden family +# [tutorial v1.1_050] A calculated default value -[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_043~1..v1.1_043) +[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_050~1..v1.1_050) -[Read the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/disabled.html#a-conditional-hidden-family) +[Read the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/disabled.html#a-calculated-default-value) ## 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_043 +git switch --detach v1.1_050 ``` ## Structure @@ -39,11 +39,11 @@ git switch --detach v1.1_043

-.
- └── firefox
-     ├── 00-proxy.yml
-     ├── 10-manual.yml
-     └── 20-manual.yml
+.
+ └── firefox
+     ├── 00-proxy.yml
+     ├── 10-manual.yml
+     └── 20-manual.yml


Contents of the firefox/20-manual.yml file @@ -64,14 +64,13 @@ manual: address: description: HTTPS address - type: domainname - params: - allow_ip: true + default: + variable: __.http_proxy.address port: description: HTTPS Port - type: port - default: 8080 + default: + variable: __.http_proxy.port ... ``` @@ -115,10 +114,23 @@ rougail -m firefox/ -o doc > *`hidden`*\ > **Hidden**: when the variable "[Also use this proxy for HTTPS](#manual.use_for_https)" has the value "true" -| Variable | Description | -|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **manual.https_proxy.address**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTPS address.
**Validators**:
• type domainname
• the domain name can be an IP | -| **manual.https_proxy.port**
[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTPS 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 | +| Variable | Description | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **manual.https_proxy.address**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTPS address.
**Validators**:
• type domainname
• the domain name can be an IP
**Default**: the value of the variable "[HTTP address](#manual.http_proxy.address)" | +| **manual.https_proxy.port**
[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTPS 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**: the value of the variable "[HTTP Port](#manual.http_proxy.port)" | + +### Let's generate the changelog + +```shell +rougail -m firefox/ -o doc --doc.contents changelog +``` +#### Modified variables + +| Variable | Description | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **manual.https_proxy.address**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTPS address.
**Validators**:
• type domainname
• the domain name can be an IP
**Default**: the value of the variable "[HTTP address](#manual.http_proxy.address)" | +| **manual.https_proxy.port**
[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTPS 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~~
the value of the variable "[HTTP Port](#manual.http_proxy.port)" | + ## User datas @@ -161,32 +173,9 @@ Variables: ┃ "config/01/config.yml" (⏳ true) ┗━━ 📂 HTTPS Proxy ┣━━ 📓 HTTPS address: https.proxy.net ◀ loaded from the YAML file - ┃ "config/01/config.yml" - ┗━━ 📓 HTTPS Port: 8080 - -### Example 2 - -#### config/02/config.yml - - -```yml ---- -proxy_mode: Manual proxy configuration -manual: - http_proxy: - address: http.proxy.net - port: 3128 - use_for_https: true -``` -#### Output - -```shell -rougail -m firefox/ -u yaml -yf config/02/config.yml -``` -
🛑 ERRORS
-┗━━ The following variables are inaccessible but are empty and mandatory:
-    ┗━━ manual.https_proxy.address (HTTPS address)
+        ┃   "config/01/config.yml" (⏳ http.proxy.net)
+        ┗━━ 📓 HTTPS Port: 3128
-- [[tutorial v1.1_050] A calculated default value](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_050/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_050~1..v1.1_050)) +- [[tutorial v1.1_060] Family: a dynamic family](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_060/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_060~1..v1.1_060)) diff --git a/config/01/output_ro.html b/config/01/output_ro.html index 6f40f528..9da9307a 100644 --- a/config/01/output_ro.html +++ b/config/01/output_ro.html @@ -16,6 +16,6 @@ Variables: ┃ "config/01/config.yml" (⏳ true) ┗━━ 📂 HTTPS Proxy ┣━━ 📓 HTTPS address: https.proxy.net ◀ loaded from the YAML file - ┃ "config/01/config.yml" - ┗━━ 📓 HTTPS Port: 8080 + ┃ "config/01/config.yml" (⏳ http.proxy.net) + ┗━━ 📓 HTTPS Port: 3128 diff --git a/config/02/cmd_ro.txt b/config/02/cmd_ro.txt deleted file mode 100644 index 772ebbef..00000000 --- a/config/02/cmd_ro.txt +++ /dev/null @@ -1 +0,0 @@ -rougail -m firefox/ -u yaml -yf config/02/config.yml \ No newline at end of file diff --git a/config/02/config.yml b/config/02/config.yml deleted file mode 100644 index 74552172..00000000 --- a/config/02/config.yml +++ /dev/null @@ -1,7 +0,0 @@ ---- -proxy_mode: Manual proxy configuration -manual: - http_proxy: - address: http.proxy.net - port: 3128 - use_for_https: true diff --git a/config/02/output_ro.html b/config/02/output_ro.html deleted file mode 100644 index 60755000..00000000 --- a/config/02/output_ro.html +++ /dev/null @@ -1,4 +0,0 @@ -
🛑 ERRORS
-┗━━ The following variables are inaccessible but are empty and mandatory:
-    ┗━━ manual.https_proxy.address (HTTPS address)
-
diff --git a/tree.html b/tree.html index 73e97be7..2ee7c272 100644 --- a/tree.html +++ b/tree.html @@ -25,11 +25,11 @@

Directory Tree

- .
- └── firefox
-     ├── 00-proxy.yml
-     ├── 10-manual.yml
-     └── 20-manual.yml
+ .
+ └── firefox
+     ├── 00-proxy.yml
+     ├── 10-manual.yml
+     └── 20-manual.yml


2 directories, 3 files