diff --git a/README.md b/README.md index 6afc579..5df0ccf 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_050] A disabled family](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_051] A conditional disabled family](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_051/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_051~1..v1.1_051)) -# [tutorial v1.1_051] A conditional disabled family +# [tutorial v1.1_052] A hidden family -[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_051~1..v1.1_051) +[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_052~1..v1.1_052) -[Read the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/disabled.html#a-conditional-disabled-family) +[Read the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/disabled.html#a-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_051 +git switch --detach v1.1_052 ``` ## Structure @@ -39,14 +39,14 @@ git switch --detach v1.1_051

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


-Contents of the firefox/10-manual.yml file +Contents of the firefox/20-manual.yml file ```yml %YAML 1.2 @@ -54,23 +54,22 @@ Contents of the firefox/10-manual.yml file version: 1.1 manual: - description: Manual proxy configuration - disabled: - variable: _.proxy_mode - when_not: Manual proxy configuration - http_proxy: # HTTP Proxy + use_for_https: true # Also use this proxy for HTTPS + + https_proxy: + description: HTTPS Proxy + hidden: true address: - description: HTTP address - type: domainname - params: - allow_ip: true + description: HTTPS address + default: + variable: __.http_proxy.address port: - description: HTTP Port - type: port - default: 8080 + description: HTTPS Port + default: + variable: __.http_proxy.port ... ``` @@ -108,17 +107,6 @@ rougail -m firefox/ -o doc |-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------| | **manual.use_for_https**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Also use this proxy for HTTPS.
**Default**: true | -##### HTTPS Proxy - -> [!NOTE] -> -> **Path**: manual.https_proxy - -| 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 @@ -126,17 +114,11 @@ rougail -m firefox/ -o doc ```shell rougail -m firefox/ -o doc --doc.contents changelog ``` -#### New variables - -| Variable | Description | -|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **manual.http_proxy.address**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTP address.
**Validators**:
• type domainname
• the domain name can be an IP | -| **manual.http_proxy.port**
[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTP 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 | -| **manual.use_for_https**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Also use this proxy for HTTPS.
**Default**: true | -| **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)" | +#### Deleted variables +- manual.https_proxy.address +- manual.https_proxy.port *** ## User datas @@ -147,6 +129,14 @@ rougail -m firefox/ -o doc --doc.contents changelog ```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 ``` *** @@ -155,14 +145,26 @@ rougail -m firefox/ -o doc --doc.contents changelog ```shell rougail -m firefox/ -u yaml -yf config/01/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/01/config.yml" + > [!NOTE] > > **Caption:** > - Variable -> - Default value +> - Modified value +> - (:hourglass_flowing_sand: Original default value) Variables: -- :notebook: proxy_mode (Configure Proxy Access to the Internet): No proxy +- :notebook: proxy_mode (Configure Proxy Access to the Internet): Manual proxy configuration ← loaded from the YAML file "config/01/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/01/config.yml" + - :notebook: port (HTTP Port): 3128 ← loaded from the YAML file "config/01/config.yml" (:hourglass_flowing_sand: 8080) + - :notebook: use_for_https (Also use this proxy for HTTPS): false ← loaded from the YAML file "config/01/config.yml" (:hourglass_flowing_sand: true) *** ### Example 2 @@ -177,7 +179,7 @@ manual: http_proxy: address: http.proxy.net port: 3128 - use_for_https: false + use_for_https: true ``` *** @@ -190,7 +192,6 @@ rougail -m firefox/ -u yaml -yf config/02/config.yml > > **Caption:** > - Variable -> - Default value > - Modified value > - (:hourglass_flowing_sand: Original default value) @@ -200,12 +201,9 @@ Variables: - :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): false ← 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 + - :notebook: use_for_https (Also use this proxy for HTTPS): true ← loaded from the YAML file "config/02/config.yml" (:hourglass_flowing_sand: true) *** -- [[tutorial v1.1_052] A hidden family](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_052/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_052~1..v1.1_052)) +- [[tutorial v1.1_053] A conditional hidden family](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_053/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_053~1..v1.1_053)) diff --git a/config/01/config.yml b/config/01/config.yml index ed97d53..84547fa 100644 --- a/config/01/config.yml +++ b/config/01/config.yml @@ -1 +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 index bb585a6..7c523a7 100644 --- a/config/01/output_ro.html +++ b/config/01/output_ro.html @@ -1,6 +1,25 @@ -
╭─────── Caption ────────╮
-│ Variable Default value │
-╰────────────────────────╯
+
🔔 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/01/config.yml"
+
+╭────────────── Caption ───────────────╮
+│ Variable Modified value              │
+│          (⏳ Original default value) │
+╰──────────────────────────────────────╯
 Variables:
-┗━━ 📓 proxy_mode (Configure Proxy Access to the Internet): No proxy
+┣━━ 📓 proxy_mode (Configure Proxy Access to the Internet): Manual proxy 
+┃   configuration ◀ loaded from the YAML file "config/01/config.yml" (⏳ No 
+┃   proxy)
+┗━━ 📂 manual (Manual proxy configuration)
+    ┣━━ 📂 http_proxy (HTTP Proxy)
+    ┃   ┣━━ 📓 address (HTTP address): http.proxy.net ◀ loaded from the YAML 
+    ┃   ┃   file "config/01/config.yml"
+    ┃   ┗━━ 📓 port (HTTP Port): 3128 ◀ loaded from the YAML file 
+    ┃       "config/01/config.yml" (⏳ 8080)
+    ┗━━ 📓 use_for_https (Also use this proxy for HTTPS): false ◀ loaded from 
+        the YAML file "config/01/config.yml" (⏳ true)
 

diff --git a/config/02/config.yml b/config/02/config.yml
index 9b246a4..7455217 100644
--- a/config/02/config.yml
+++ b/config/02/config.yml
@@ -4,4 +4,4 @@ manual:
   http_proxy:
     address: http.proxy.net
     port: 3128
-  use_for_https: false
+  use_for_https: true
diff --git a/config/02/output_ro.html b/config/02/output_ro.html
index 21f864f..965c388 100644
--- a/config/02/output_ro.html
+++ b/config/02/output_ro.html
@@ -1,6 +1,5 @@
 
╭────────────── Caption ───────────────╮
-│ Variable Default value               │
-│          Modified value              │
+│ Variable Modified value              │
 │          (⏳ Original default value) │
 ╰──────────────────────────────────────╯
 Variables:
@@ -13,9 +12,6 @@ Variables:
     ┃   ┃   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): false ◀ loaded from 
-    ┃   the YAML file "config/02/config.yml" (⏳ true)
-    ┗━━ 📂 https_proxy (HTTPS Proxy)
-        ┣━━ 📓 address (HTTPS address): http.proxy.net
-        ┗━━ 📓 port (HTTPS Port): 3128
+    ┗━━ 📓 use_for_https (Also use this proxy for HTTPS): true ◀ loaded from the
+        YAML file "config/02/config.yml" (⏳ true)
 

diff --git a/firefox.png b/firefox.png
index e40ce96..b7ca7aa 100644
Binary files a/firefox.png and b/firefox.png differ
diff --git a/tree.html b/tree.html
index ca90cc9..debd01e 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