diff --git a/README.md b/README.md index 0a51b4a7..1b0739ec 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_041] A conditional disabled family](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_041/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_041~1..v1.1_041)) +- [[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_042] Copy HTTP manual proxy to HTTPS manual proxy +# [tutorial v1.1_043] A conditional hidden family -[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_042~1..v1.1_042) +[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_043~1..v1.1_043) -[Read the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/disabled.html#copy-http-manual-proxy-to-https-manual-proxy) +[Read the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/disabled.html#a-conditional-hidden-family) ## 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_042 +git switch --detach v1.1_043 ``` ## Structure @@ -39,11 +39,11 @@ git switch --detach v1.1_042

-.
- └── 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 @@ -57,7 +57,10 @@ manual: use_for_https: true # Also use this proxy for HTTPS - https_proxy: # HTTPS Proxy + https_proxy: + description: HTTPS Proxy + hidden: + variable: _.use_for_https address: description: HTTPS address @@ -108,26 +111,82 @@ rougail -m firefox/ -o doc > **🛈 Informations** > -> **Path**: manual.https_proxy +> **Path**: manual.https_proxy\ +> *`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 | -### Let's generate the changelog +## User datas + +### Example 1 + +#### config/01/config.yml + + +```yml +--- +proxy_mode: Manual proxy configuration +manual: + http_proxy: + address: http.proxy.net + port: 3128 + use_for_https: false + https_proxy: + address: https.proxy.net +``` +#### Output ```shell -rougail -m firefox/ -o doc --doc.contents changelog +rougail -m firefox/ -u yaml -yf config/01/config.yml ``` -#### New variables +
╭─────────────────────────── Caption ────────────────────────────╮
+│ Variable                           Default value               │
+│ Undocumented but modified variable Modified value              │
+│                                    (⏳ Original default value) │
+╰────────────────────────────────────────────────────────────────╯
+Variables:
+┣━━ 📓 Configure Proxy Access to the Internet: Manual proxy configuration ◀ 
+┃   loaded from the YAML file "config/01/config.yml" (⏳ No proxy)
+┗━━ 📂 Manual proxy configuration
+    ┣━━ 📂 HTTP Proxy
+    ┃   ┣━━ 📓 HTTP address: http.proxy.net ◀ loaded from the YAML file 
+    ┃   ┃   "config/01/config.yml"
+    ┃   ┗━━ 📓 HTTP Port: 3128 ◀ loaded from the YAML file 
+    ┃       "config/01/config.yml" (⏳ 8080)
+    ┣━━ 📓 Also use this proxy for HTTPS: false ◀ loaded from the YAML file 
+    ┃   "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 -| 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 | +#### 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)
+
-- [[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_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)) diff --git a/config/01/cmd_ro.txt b/config/01/cmd_ro.txt new file mode 100644 index 00000000..d46f9445 --- /dev/null +++ b/config/01/cmd_ro.txt @@ -0,0 +1 @@ +rougail -m firefox/ -u yaml -yf config/01/config.yml \ No newline at end of file diff --git a/config/01/config.yml b/config/01/config.yml new file mode 100644 index 00000000..84547faa --- /dev/null +++ b/config/01/config.yml @@ -0,0 +1,9 @@ +--- +proxy_mode: Manual proxy configuration +manual: + http_proxy: + address: http.proxy.net + port: 3128 + use_for_https: false + https_proxy: + address: https.proxy.net diff --git a/config/01/output_ro.html b/config/01/output_ro.html new file mode 100644 index 00000000..6f40f528 --- /dev/null +++ b/config/01/output_ro.html @@ -0,0 +1,21 @@ +
╭─────────────────────────── Caption ────────────────────────────╮
+│ Variable                           Default value               │
+│ Undocumented but modified variable Modified value              │
+│                                    (⏳ Original default value) │
+╰────────────────────────────────────────────────────────────────╯
+Variables:
+┣━━ 📓 Configure Proxy Access to the Internet: Manual proxy configuration ◀ 
+┃   loaded from the YAML file "config/01/config.yml" (⏳ No proxy)
+┗━━ 📂 Manual proxy configuration
+    ┣━━ 📂 HTTP Proxy
+    ┃   ┣━━ 📓 HTTP address: http.proxy.net ◀ loaded from the YAML file 
+    ┃   ┃   "config/01/config.yml"
+    ┃   ┗━━ 📓 HTTP Port: 3128 ◀ loaded from the YAML file 
+    ┃       "config/01/config.yml" (⏳ 8080)
+    ┣━━ 📓 Also use this proxy for HTTPS: false ◀ loaded from the YAML file 
+    ┃   "config/01/config.yml" (⏳ true)
+    ┗━━ 📂 HTTPS Proxy
+        ┣━━ 📓 HTTPS address: https.proxy.net ◀ loaded from the YAML file 
+        ┃   "config/01/config.yml"
+        ┗━━ 📓 HTTPS Port: 8080
+
diff --git a/config/02/cmd_ro.txt b/config/02/cmd_ro.txt new file mode 100644 index 00000000..772ebbef --- /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/config.yml b/config/02/config.yml new file mode 100644 index 00000000..74552172 --- /dev/null +++ b/config/02/config.yml @@ -0,0 +1,7 @@ +--- +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 new file mode 100644 index 00000000..60755000 --- /dev/null +++ b/config/02/output_ro.html @@ -0,0 +1,4 @@ +
🛑 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 dc0c44ee..73e97be7 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