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

-.
- └── firefox
-     ├── 00-proxy.yml
-     └── 10-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 --- version: 1.1 -manual: # Manual proxy configuration +manual: - http_proxy: # HTTP Proxy - - address: - description: HTTP address - type: domainname - params: - allow_ip: true - - port: - description: HTTP Port - type: port - default: 8080 + use_for_https: true # Also use this proxy for HTTPS ... ``` @@ -97,6 +87,10 @@ rougail -m firefox/ -o doc | **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 @@ -106,9 +100,9 @@ rougail -m firefox/ -o doc --doc.contents changelog ``` #### New variable -| Variable | Description | -|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **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 | *** @@ -121,7 +115,6 @@ rougail -m firefox/ -o doc --doc.contents changelog ```yml --- -proxy_mode: Manual proxy configuration manual: http_proxy: address: example.net @@ -139,14 +132,14 @@ rougail -m firefox/ -u yaml -yf config/01/config.yml > - 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/01/config.yml" (:hourglass_flowing_sand: No proxy) +- :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 @@ -156,11 +149,10 @@ Variables: ```yml --- -proxy_mode: Manual proxy configuration manual: http_proxy: address: example.net - port: 3128 + use_for_https: false ``` *** @@ -169,47 +161,6 @@ manual: ```shell rougail -m firefox/ -u yaml -yf config/02/config.yml ``` -> [!NOTE] -> -> **Caption:** -> - Variable -> - 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): example.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) - -*** -### Example 3 - -#### config/03/config.yml - - -```yml ---- -proxy_mode: Manual proxy configuration -manual: - http_proxy: - address: example.net - port: 100000 -``` - -*** -#### Output - -```shell -rougail -m firefox/ -u yaml -yf config/03/config.yml -``` -> [!WARNING] -> -> - manual (Manual proxy configuration) -> - http_proxy (HTTP Proxy) -> - port (HTTP Port): :bell: the value "100000" is an invalid port, must be between 1 and 65535, it will be ignored when loading from the YAML file "config/03/config.yml" - > [!NOTE] > > **Caption:** @@ -219,25 +170,14 @@ rougail -m firefox/ -u yaml -yf config/03/config.yml > - (: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/03/config.yml" (:hourglass_flowing_sand: No proxy) +- :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/03/config.yml" + - :notebook: address (HTTP address): example.net ← loaded from the YAML file "config/02/config.yml" - :notebook: port (HTTP Port): 8080 - -*** -#### Output when invalid user data is an error - -```shell -rougail -m firefox/ -u yaml -yf config/03/config.yml --cli.invalid_user_data_error -``` -> [!CAUTION] -> -> - manual (Manual proxy configuration) -> - http_proxy (HTTP Proxy) -> - port (HTTP Port): :stop_sign: the value "100000" is an invalid port, must be between 1 and 65535, it has been loading from the YAML file "config/03/config.yml" + - :notebook: use_for_https (Also use this proxy for HTTPS): false ← loaded from the YAML file "config/02/config.yml" (:hourglass_flowing_sand: true) *** -- [[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_040] HTTPS 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)) diff --git a/config/01/config.yml b/config/01/config.yml index e3db924..22422a2 100644 --- a/config/01/config.yml +++ b/config/01/config.yml @@ -1,5 +1,4 @@ --- -proxy_mode: Manual proxy configuration manual: http_proxy: address: example.net diff --git a/config/01/output_ro.html b/config/01/output_ro.html index 765fa89..c6148c1 100644 --- a/config/01/output_ro.html +++ b/config/01/output_ro.html @@ -1,15 +1,13 @@ -
╭────────────── Caption ───────────────╮
-│ Variable Default value               │
-│          Modified value              │
-│          (⏳ Original default value) │
-╰──────────────────────────────────────╯
+
╭──────── Caption ────────╮
+│ Variable Default value  │
+│          Modified value │
+╰─────────────────────────╯
 Variables:
-┣━━ 📓 proxy_mode (Configure Proxy Access to the Internet): Manual proxy 
-┃   configuration ◀ loaded from the YAML file "config/01/config.yml" (⏳ No 
-┃   proxy)
+┣━━ 📓 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
+    ┣━━ 📂 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
 

diff --git a/config/02/config.yml b/config/02/config.yml
index 6e7c9dc..e4ecc47 100644
--- a/config/02/config.yml
+++ b/config/02/config.yml
@@ -1,6 +1,5 @@
 ---
-proxy_mode: Manual proxy configuration
 manual:
   http_proxy:
     address: example.net
-    port: 3128
+  use_for_https: false
diff --git a/config/02/output_ro.html b/config/02/output_ro.html
index 9a681f1..b0521dd 100644
--- a/config/02/output_ro.html
+++ b/config/02/output_ro.html
@@ -1,15 +1,15 @@
 
╭────────────── Caption ───────────────╮
-│ Variable Modified value              │
+│ Variable Default value               │
+│          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)
+┣━━ 📓 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): 3128 ◀ loaded from the YAML file 
-            "config/02/config.yml" (⏳ 8080)
+    ┣━━ 📂 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)
 

diff --git a/config/03/cmd_invalid.txt b/config/03/cmd_invalid.txt
deleted file mode 100644
index 3fe251f..0000000
--- a/config/03/cmd_invalid.txt
+++ /dev/null
@@ -1 +0,0 @@
-rougail -m firefox/ -u yaml -yf config/03/config.yml --cli.invalid_user_data_error
\ No newline at end of file
diff --git a/config/03/cmd_ro.txt b/config/03/cmd_ro.txt
deleted file mode 100644
index fc8085e..0000000
--- a/config/03/cmd_ro.txt
+++ /dev/null
@@ -1 +0,0 @@
-rougail -m firefox/ -u yaml -yf config/03/config.yml
\ No newline at end of file
diff --git a/config/03/config.yml b/config/03/config.yml
deleted file mode 100644
index d05944f..0000000
--- a/config/03/config.yml
+++ /dev/null
@@ -1,6 +0,0 @@
----
-proxy_mode: Manual proxy configuration
-manual:
-  http_proxy:
-    address: example.net
-    port: 100000
diff --git a/config/03/output_invalid.html b/config/03/output_invalid.html
deleted file mode 100644
index ad30308..0000000
--- a/config/03/output_invalid.html
+++ /dev/null
@@ -1,7 +0,0 @@
-
🛑 Caution
-┗━━ manual (Manual proxy configuration)
-    ┗━━ http_proxy (HTTP Proxy)
-        ┗━━ port (HTTP Port): 🛑 the value "100000" is an invalid port, must be 
-            between 1 and 65535, it has been loading from the YAML file 
-            "config/03/config.yml"
-

diff --git a/config/03/output_ro.html b/config/03/output_ro.html
deleted file mode 100644
index fed19a5..0000000
--- a/config/03/output_ro.html
+++ /dev/null
@@ -1,22 +0,0 @@
-
🔔 Warning
-┗━━ manual (Manual proxy configuration)
-    ┗━━ http_proxy (HTTP Proxy)
-        ┗━━ port (HTTP Port): 🔔 the value "100000" is an invalid port, must be 
-            between 1 and 65535, it will be ignored when loading from the YAML 
-            file "config/03/config.yml"
-
-╭────────────── Caption ───────────────╮
-│ Variable Default value               │
-│          Modified value              │
-│          (⏳ Original default value) │
-╰──────────────────────────────────────╯
-Variables:
-┣━━ 📓 proxy_mode (Configure Proxy Access to the Internet): Manual proxy 
-┃   configuration ◀ loaded from the YAML file "config/03/config.yml" (⏳ No 
-┃   proxy)
-┗━━ 📂 manual (Manual proxy configuration)
-    ┗━━ 📂 http_proxy (HTTP Proxy)
-        ┣━━ 📓 address (HTTP address): example.net ◀ loaded from the YAML file 
-        ┃   "config/03/config.yml"
-        ┗━━ 📓 port (HTTP Port): 8080
-

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 b890f2e..dac3ccc 100644
--- a/tree.html
+++ b/tree.html
@@ -1,6 +1,7 @@
 

-.

-	└── firefox

-	    ├── 00-proxy.yml

-	    └── 10-manual.yml

+.

+	└── firefox

+	    ├── 00-proxy.yml

+	    ├── 10-manual.yml

+	    └── 20-manual.yml

 


\ No newline at end of file