diff --git a/README.md b/README.md index c061e42..da0dd0c 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_032] A variable with type "port"](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_032/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_032~1..v1.1_032)) +- [[tutorial v1.1_033] A variable with type "boolean"](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_033/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_033~1..v1.1_033)) -# [tutorial v1.1_033] A variable with type "boolean" +# [tutorial v1.1_040] A disabled family -[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_033~1..v1.1_033) +[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_040~1..v1.1_040) -[Read the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/disabled.html#a-variable-with-type-"boolean") +[Read the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/disabled.html#a-disabled-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_033 +git switch --detach v1.1_040 ``` ## Structure @@ -39,14 +39,14 @@ git switch --detach v1.1_033

-.
- └── 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 +Contents of the firefox/10-manual.yml file ```yml %YAML 1.2 @@ -54,8 +54,21 @@ Contents of the firefox/20-manual.yml file version: 1.1 manual: + description: Manual proxy configuration + disabled: true - use_for_https: true # Also use this proxy for HTTPS + http_proxy: # HTTP Proxy + + address: + description: HTTP address + type: domainname + params: + allow_ip: true + + port: + description: HTTP Port + type: port + default: 8080 ... ``` @@ -68,39 +81,17 @@ rougail -m firefox/ -o doc |------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **proxy_mode**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Configure Proxy Access to the Internet.
**Choices**:
• No proxy **← (default)**
• Auto-detect proxy settings for this network
• Use system proxy settings
• Manual proxy configuration
• Automatic proxy configuration URL | -#### Manual proxy configuration - -> [!NOTE] -> -> **Path**: manual - -##### HTTP Proxy - -> [!NOTE] -> -> **Path**: manual.http_proxy - -| 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 | - -| Variable | Description | -|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------| -| **manual.use_for_https**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Also use this proxy for HTTPS.
**Default**: true | - ### Let's generate the changelog ```shell rougail -m firefox/ -o doc --doc.contents changelog ``` -#### New variable - -| Variable | Description | -|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------| -| **manual.use_for_https**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Also use this proxy for HTTPS.
**Default**: true | +#### Deleted variables +- manual.http_proxy.address +- manual.http_proxy.port +- manual.use_for_https ## User datas ### Example 1 @@ -110,9 +101,6 @@ rougail -m firefox/ -o doc --doc.contents changelog ```yml --- -manual: - http_proxy: - address: example.net ``` #### Output @@ -124,15 +112,9 @@ rougail -m firefox/ -u yaml -yf config/01/config.yml > **Caption:** > - Variable > - Default value -> - Modified value Variables: - :notebook: proxy_mode (Configure Proxy Access to the Internet): No proxy -- :open_file_folder: manual (Manual proxy configuration) - - :open_file_folder: http_proxy (HTTP Proxy) - - :notebook: address (HTTP address): example.net ← loaded from the YAML file "config/01/config.yml" - - :notebook: port (HTTP Port): 8080 - - :notebook: use_for_https (Also use this proxy for HTTPS): true ### Example 2 #### config/02/config.yml @@ -140,9 +122,11 @@ Variables: ```yml --- +proxy_mode: Manual proxy configuration manual: http_proxy: - address: example.net + address: http.proxy.net + port: 3128 use_for_https: false ``` #### Output @@ -150,21 +134,23 @@ manual: ```shell rougail -m firefox/ -u yaml -yf config/02/config.yml ``` +> [!WARNING] +> +> - manual (Manual proxy configuration) +> - http_proxy (HTTP Proxy) +> - address (HTTP address): :bell: family "manual" (Manual proxy configuration) has property disabled, so cannot access to "address" (HTTP address), it will be ignored when loading from the YAML file "config/02/config.yml" +> - port (HTTP Port): :bell: family "manual" (Manual proxy configuration) has property disabled, so cannot access to "port" (HTTP Port), it will be ignored when loading from the YAML file "config/02/config.yml" +> - use_for_https (Also use this proxy for HTTPS): :bell: family "manual" (Manual proxy configuration) has property disabled, so cannot access to "use_for_https" (Also use this proxy for HTTPS), it will be ignored when loading from the YAML file "config/02/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 -- :open_file_folder: manual (Manual proxy configuration) - - :open_file_folder: http_proxy (HTTP Proxy) - - :notebook: address (HTTP address): example.net ← loaded from the YAML file "config/02/config.yml" - - :notebook: port (HTTP Port): 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) +- :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) -- [[tutorial v1.1_040] A disabled family](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_040/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_040~1..v1.1_040)) +- [[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)) diff --git a/config/01/config.yml b/config/01/config.yml index 22422a2..ed97d53 100644 --- a/config/01/config.yml +++ b/config/01/config.yml @@ -1,4 +1 @@ --- -manual: - http_proxy: - address: example.net diff --git a/config/01/output_ro.html b/config/01/output_ro.html index c6148c1..bb585a6 100644 --- a/config/01/output_ro.html +++ b/config/01/output_ro.html @@ -1,13 +1,6 @@ -
╭──────── Caption ────────╮
-│ Variable Default value  │
-│          Modified value │
-╰─────────────────────────╯
+
╭─────── Caption ────────╮
+│ Variable Default value │
+╰────────────────────────╯
 Variables:
-┣━━ 📓 proxy_mode (Configure Proxy Access to the Internet): No proxy
-┗━━ 📂 manual (Manual proxy configuration)
-    ┣━━ 📂 http_proxy (HTTP Proxy)
-    ┃   ┣━━ 📓 address (HTTP address): example.net ◀ loaded from the YAML file 
-    ┃   ┃   "config/01/config.yml"
-    ┃   ┗━━ 📓 port (HTTP Port): 8080
-    ┗━━ 📓 use_for_https (Also use this proxy for HTTPS): true
+┗━━ 📓 proxy_mode (Configure Proxy Access to the Internet): No proxy
 

diff --git a/config/02/config.yml b/config/02/config.yml
index e4ecc47..9b246a4 100644
--- a/config/02/config.yml
+++ b/config/02/config.yml
@@ -1,5 +1,7 @@
 ---
+proxy_mode: Manual proxy configuration
 manual:
   http_proxy:
-    address: example.net
+    address: http.proxy.net
+    port: 3128
   use_for_https: false
diff --git a/config/02/output_ro.html b/config/02/output_ro.html
index b0521dd..8a5e02b 100644
--- a/config/02/output_ro.html
+++ b/config/02/output_ro.html
@@ -1,15 +1,25 @@
-
╭────────────── Caption ───────────────╮
-│ Variable Default value               │
-│          Modified value              │
+
🔔 Warning
+┗━━ manual (Manual proxy configuration)
+    ┣━━ http_proxy (HTTP Proxy)
+    ┃   ┣━━ address (HTTP address): 🔔 family "manual" (Manual proxy 
+    ┃   ┃   configuration) has property disabled, so cannot access to "address" 
+    ┃   ┃   (HTTP address), it will be ignored when loading from the YAML file 
+    ┃   ┃   "config/02/config.yml"
+    ┃   ┗━━ port (HTTP Port): 🔔 family "manual" (Manual proxy configuration) 
+    ┃       has property disabled, so cannot access to "port" (HTTP Port), it 
+    ┃       will be ignored when loading from the YAML file 
+    ┃       "config/02/config.yml"
+    ┗━━ use_for_https (Also use this proxy for HTTPS): 🔔 family "manual" 
+        (Manual proxy configuration) has property disabled, so cannot access to 
+        "use_for_https" (Also use this proxy for HTTPS), it will be ignored when
+        loading from the YAML file "config/02/config.yml"
+
+╭────────────── Caption ───────────────╮
+│ Variable Modified value              │
 │          (⏳ Original default value) │
 ╰──────────────────────────────────────╯
 Variables:
-┣━━ 📓 proxy_mode (Configure Proxy Access to the Internet): No proxy
-┗━━ 📂 manual (Manual proxy configuration)
-    ┣━━ 📂 http_proxy (HTTP Proxy)
-    ┃   ┣━━ 📓 address (HTTP address): example.net ◀ loaded from the YAML file 
-    ┃   ┃   "config/02/config.yml"
-    ┃   ┗━━ 📓 port (HTTP Port): 8080
-    ┗━━ 📓 use_for_https (Also use this proxy for HTTPS): false ◀ loaded from 
-        the YAML file "config/02/config.yml" (⏳ true)
+┗━━ 📓 proxy_mode (Configure Proxy Access to the Internet): Manual proxy 
+    configuration ◀ loaded from the YAML file "config/02/config.yml" (⏳ No 
+    proxy)
 

diff --git a/tree.html b/tree.html
index dac3ccc..c80855e 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