From a837d59b5d9c6e02116761a9a3ca08bb55f53fbc Mon Sep 17 00:00:00 2001 From: Emmanuel Garette Date: Thu, 12 Mar 2026 08:10:40 +0100 Subject: [PATCH] [tutorial v1.1_071] Jinja with a description (config and doc) --- README.md | 107 +++++-------------------------------- config/01/cmd_root.txt | 1 - config/01/output_root.html | 11 ---- config/01/root | 1 - config/02/cmd_ro.txt | 1 - config/02/cmd_root.txt | 1 - config/02/config.yml | 9 ---- config/02/output_ro.html | 33 ------------ config/02/output_root.html | 7 --- config/02/root | 1 - tree.html | 10 ++-- 11 files changed, 17 insertions(+), 165 deletions(-) delete mode 100644 config/01/cmd_root.txt delete mode 100644 config/01/output_root.html delete mode 100644 config/01/root delete mode 100644 config/02/cmd_ro.txt delete mode 100644 config/02/cmd_root.txt delete mode 100644 config/02/config.yml delete mode 100644 config/02/output_ro.html delete mode 100644 config/02/output_root.html delete mode 100644 config/02/root diff --git a/README.md b/README.md index b0c6bc97..ee857746 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_061] A conditional disabled variable with dynamic identifier](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_061/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_070~1..v1.1_070)) +- [[tutorial v1.1_070] A conditional hidden family with Jinja](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_070/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_071~1..v1.1_071)) -# [tutorial v1.1_070] A conditional hidden family with Jinja +# [tutorial v1.1_071] Jinja with a description -[Read the tutorial "A conditional hidden family with Jinja" in the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/jinja.html#a-conditional-hidden-family-with-jinja) +[Read the tutorial "Jinja with a description" in the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/jinja.html#jinja-with-a-description) ## 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_070 +git switch --detach v1.1_071 ``` ## Structure @@ -37,11 +37,11 @@ git switch --detach v1.1_070

-.
- └── 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 @@ -62,6 +62,7 @@ manual: {% if _.use_for_https %} HTTPS is same has HTTP {% endif %} + description: in HTTPS case if "_.use_for_https" is set to "true" dynamic: - HTTPS - SOCKS @@ -131,7 +132,7 @@ rougail -m firefox/ -o doc > - manual.*https*_proxy > - manual.*socks*_proxy\ > *`hidden`*\ -> **Hidden**: depends on a calculation\ +> **Hidden**: in HTTPS case if "[Also use this proxy for HTTPS](#manual.use_for_https)" is set to "true"\ > **Identifiers**: > - HTTPS > - SOCKS @@ -193,90 +194,6 @@ Variables: - :notebook: version (SOCKS host version used by proxy): v5 *** -#### Output for "manual.https_proxy" - -```shell -rougail -m firefox/ -u yaml -yf config/01/config.yml --cli.root manual.https_proxy -``` -> [!NOTE] -> -> **Caption:** -> - Variable -> - Default value -> - Modified value -> - (:hourglass_flowing_sand: Original default value) - -Variables: -- :notebook: address (HTTPS address): https.proxy.net ← loaded from the YAML file "config/01/config.yml" (:hourglass_flowing_sand: https.proxy.net ← loaded from the YAML file "config/01/config.yml" :hourglass_flowing_sand: http.proxy.net) -- :notebook: port (HTTPS port): 3128 - -*** -### 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 - https_proxy: - address: https.proxy.net -``` - -*** -#### Output - -```shell -rougail -m firefox/ -u yaml -yf config/02/config.yml -``` -> [!WARNING] -> -> - manual (Manual proxy configuration) -> - https_proxy (HTTPS Proxy) -> - address (HTTPS address): :bell: family "https_proxy" (HTTPS Proxy) has property hidden, so cannot access to "address" (HTTPS address), it will be ignored when loading from the YAML file "config/02/config.yml" - -> [!NOTE] -> -> **Caption:** -> - Variable -> - Unmodifiable variable -> - Default value -> - Modified value -> - (:hourglass_flowing_sand: Original default value) - -Variables: -- :notebook: proxy_mode (Configure Proxy Access to the Internet): Manual proxy configuration ← loaded from the YAML file "config/02/config.yml" (:hourglass_flowing_sand: No proxy) -- :open_file_folder: manual (Manual proxy configuration) - - :open_file_folder: http_proxy (HTTP Proxy) - - :notebook: address (HTTP address): http.proxy.net ← loaded from the YAML file "config/02/config.yml" - - :notebook: port (HTTP Port): 3128 ← loaded from the YAML file "config/02/config.yml" (:hourglass_flowing_sand: 8080) - - :notebook: use_for_https (Also use this proxy for HTTPS): true ← loaded from the YAML file "config/02/config.yml" (:hourglass_flowing_sand: true) - - :open_file_folder: https_proxy (HTTPS Proxy) - - :notebook: address (HTTPS address): http.proxy.net - - :notebook: port (HTTPS port): 3128 - - :open_file_folder: socks_proxy (SOCKS Proxy) - - :notebook: address (SOCKS address): http.proxy.net - - :notebook: port (SOCKS port): 3128 - - :notebook: version (SOCKS host version used by proxy): v5 - -*** -#### Output for "manual.https_proxy" - -```shell -rougail -m firefox/ -u yaml -yf config/02/config.yml --cli.root manual.https_proxy -``` -> [!CAUTION] -> -> - manual (Manual proxy configuration) -> - https_proxy (HTTPS Proxy) -> - address (HTTPS address): :stop_sign: family "https_proxy" (HTTPS Proxy) has property hidden, so cannot access to "address" (HTTPS address), it has been loading from the YAML file "config/02/config.yml" - -*** - - -- [[tutorial v1.1_071] Jinja with a description](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_071/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_071~1..v1.1_071)) +- [[tutorial v1.1_072] Jinja with a parameter](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_072/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_072~1..v1.1_072)) diff --git a/config/01/cmd_root.txt b/config/01/cmd_root.txt deleted file mode 100644 index 8b7ce7b1..00000000 --- a/config/01/cmd_root.txt +++ /dev/null @@ -1 +0,0 @@ -rougail -m firefox/ -u yaml -yf config/01/config.yml --cli.root manual.https_proxy \ No newline at end of file diff --git a/config/01/output_root.html b/config/01/output_root.html deleted file mode 100644 index 25bd1193..00000000 --- a/config/01/output_root.html +++ /dev/null @@ -1,11 +0,0 @@ -
╭────────────── Caption ───────────────╮
-│ Variable Default value               │
-│          Modified value              │
-│          (⏳ Original default value) │
-╰──────────────────────────────────────╯
-Variables:
-┣━━ 📓 address (HTTPS address): https.proxy.net ◀ loaded from the YAML file 
-┃   "config/01/config.yml" (⏳ https.proxy.net ◀ loaded from the YAML file 
-┃   "config/01/config.yml" ⏳ http.proxy.net)
-┗━━ 📓 port (HTTPS port): 3128
-
diff --git a/config/01/root b/config/01/root deleted file mode 100644 index 0735f079..00000000 --- a/config/01/root +++ /dev/null @@ -1 +0,0 @@ -manual.https_proxy 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/cmd_root.txt b/config/02/cmd_root.txt deleted file mode 100644 index 2ac338cb..00000000 --- a/config/02/cmd_root.txt +++ /dev/null @@ -1 +0,0 @@ -rougail -m firefox/ -u yaml -yf config/02/config.yml --cli.root manual.https_proxy \ No newline at end of file diff --git a/config/02/config.yml b/config/02/config.yml deleted file mode 100644 index e2599e56..00000000 --- a/config/02/config.yml +++ /dev/null @@ -1,9 +0,0 @@ ---- -proxy_mode: Manual proxy configuration -manual: - http_proxy: - address: http.proxy.net - port: 3128 - use_for_https: true - https_proxy: - address: https.proxy.net diff --git a/config/02/output_ro.html b/config/02/output_ro.html deleted file mode 100644 index 83036114..00000000 --- a/config/02/output_ro.html +++ /dev/null @@ -1,33 +0,0 @@ -
🔔 Warning
-┗━━ manual (Manual proxy configuration)
-    ┗━━ https_proxy (HTTPS Proxy)
-        ┗━━ address (HTTPS address): 🔔 family "https_proxy" (HTTPS Proxy) has 
-            property hidden, so cannot access to "address" (HTTPS address), it 
-            will be ignored when loading from the YAML file 
-            "config/02/config.yml"
-
-╭───────────────────── Caption ─────────────────────╮
-│ Variable              Default value               │
-│ Unmodifiable variable Modified value              │
-│                       (⏳ Original default value) │
-╰───────────────────────────────────────────────────╯
-Variables:
-┣━━ 📓 proxy_mode (Configure Proxy Access to the Internet): Manual proxy 
-┃   configuration ◀ loaded from the YAML file "config/02/config.yml" (⏳ No 
-┃   proxy)
-┗━━ 📂 manual (Manual proxy configuration)
-    ┣━━ 📂 http_proxy (HTTP Proxy)
-    ┃   ┣━━ 📓 address (HTTP address): http.proxy.net ◀ loaded from the YAML 
-    ┃   ┃   file "config/02/config.yml"
-    ┃   ┗━━ 📓 port (HTTP Port): 3128 ◀ loaded from the YAML file 
-    ┃       "config/02/config.yml" (⏳ 8080)
-    ┣━━ 📓 use_for_https (Also use this proxy for HTTPS): true ◀ loaded from the
-    ┃   YAML file "config/02/config.yml" (⏳ true)
-    ┣━━ 📂 https_proxy (HTTPS Proxy)
-    ┃   ┣━━ 📓 address (HTTPS address): http.proxy.net
-    ┃   ┗━━ 📓 port (HTTPS port): 3128
-    ┗━━ 📂 socks_proxy (SOCKS Proxy)
-        ┣━━ 📓 address (SOCKS address): http.proxy.net
-        ┣━━ 📓 port (SOCKS port): 3128
-        ┗━━ 📓 version (SOCKS host version used by proxy): v5
-
diff --git a/config/02/output_root.html b/config/02/output_root.html deleted file mode 100644 index 2ea20f8e..00000000 --- a/config/02/output_root.html +++ /dev/null @@ -1,7 +0,0 @@ -
🛑 Caution
-┗━━ manual (Manual proxy configuration)
-    ┗━━ https_proxy (HTTPS Proxy)
-        ┗━━ address (HTTPS address): 🛑 family "https_proxy" (HTTPS Proxy) has 
-            property hidden, so cannot access to "address" (HTTPS address), it 
-            has been loading from the YAML file "config/02/config.yml"
-
diff --git a/config/02/root b/config/02/root deleted file mode 100644 index 0735f079..00000000 --- a/config/02/root +++ /dev/null @@ -1 +0,0 @@ -manual.https_proxy diff --git a/tree.html b/tree.html index 0d22fccb..5531fba0 100644 --- a/tree.html +++ b/tree.html @@ -1,7 +1,7 @@

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


\ No newline at end of file