diff --git a/README.md b/README.md
index 8236253..b9ddc43 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_060] A dynamically built 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))
+- [[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_061~1..v1.1_061))
-# [tutorial v1.1_061] A conditional disabled variable with dynamic identifier
+# [tutorial v1.1_070] A conditional hidden family with Jinja
-[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_061~1..v1.1_061)
+[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_070~1..v1.1_070)
-[Read the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/dynfam.html#a-conditional-disabled-variable-with-dynamic-identifier)
+[Read the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/jinja.html#a-conditional-hidden-family-with-jinja)
## 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_061
+git switch --detach v1.1_070
```
## Structure
@@ -39,11 +39,11 @@ git switch --detach v1.1_061
-.
- └── 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
@@ -60,7 +60,10 @@ manual:
'{{ identifier }}_proxy':
description: '{{ identifier }} Proxy'
hidden:
- variable: _.use_for_https
+ jinja: |-
+ {% if _.use_for_https %}
+ HTTPS is same has HTTP
+ {% endif %}
dynamic:
- HTTPS
- SOCKS
@@ -130,7 +133,7 @@ rougail -m firefox/ -o doc
> - manual.*https*_proxy
> - manual.*socks*_proxy\
> *`hidden`*\
-> **Hidden**: when the variable "[Also use this proxy for HTTPS](#manual.use_for_https)" has the value "true"\
+> **Hidden**: depends on a calculation\
> **Identifiers**:
> - HTTPS
> - SOCKS
@@ -142,19 +145,6 @@ rougail -m firefox/ -o doc
| **manual.*https*_proxy.version**
**manual.*socks*_proxy.version**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` *`disabled`* | SOCKS host version used by proxy.
**Choices**:
• v4
• v5 **← (default)**
**Disabled**: when the identifier is "HTTPS" |
-***
-### Let's generate the changelog
-
-```shell
-rougail -m firefox/ -o doc --doc.contents changelog
-```
-#### New variable
-
-| Variable | Description |
-|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------|
-| **manual.*https*_proxy.version**
**manual.*socks*_proxy.version**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` *`disabled`* | SOCKS host version used by proxy.
**Choices**:
• v4
• v5 **← (default)**
**Disabled**: when the identifier is "HTTPS" |
-
-
***
## User datas
@@ -205,6 +195,90 @@ 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
-- [[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_070~1..v1.1_070))
+```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))
diff --git a/config/01/cmd_root.txt b/config/01/cmd_root.txt
new file mode 100644
index 0000000..8b7ce7b
--- /dev/null
+++ b/config/01/cmd_root.txt
@@ -0,0 +1 @@
+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
new file mode 100644
index 0000000..25bd119
--- /dev/null
+++ b/config/01/output_root.html
@@ -0,0 +1,11 @@
+╭────────────── 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
new file mode 100644
index 0000000..0735f07
--- /dev/null
+++ b/config/01/root
@@ -0,0 +1 @@
+manual.https_proxy
diff --git a/config/02/cmd_ro.txt b/config/02/cmd_ro.txt
new file mode 100644
index 0000000..772ebbe
--- /dev/null
+++ b/config/02/cmd_ro.txt
@@ -0,0 +1 @@
+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
new file mode 100644
index 0000000..2ac338c
--- /dev/null
+++ b/config/02/cmd_root.txt
@@ -0,0 +1 @@
+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
new file mode 100644
index 0000000..e2599e5
--- /dev/null
+++ b/config/02/config.yml
@@ -0,0 +1,9 @@
+---
+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
new file mode 100644
index 0000000..8303611
--- /dev/null
+++ b/config/02/output_ro.html
@@ -0,0 +1,33 @@
+🔔 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
new file mode 100644
index 0000000..2ea20f8
--- /dev/null
+++ b/config/02/output_root.html
@@ -0,0 +1,7 @@
+🛑 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
new file mode 100644
index 0000000..0735f07
--- /dev/null
+++ b/config/02/root
@@ -0,0 +1 @@
+manual.https_proxy
diff --git a/tree.html b/tree.html
index a9b8953..0d22fcc 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