diff --git a/README.md b/README.md index 5af5cd14..c0a52604 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 ... ``` @@ -95,6 +85,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 ```shell @@ -102,9 +96,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 | ## User datas @@ -116,7 +110,6 @@ rougail -m firefox/ -o doc --doc.contents changelog ```yml --- -proxy_mode: Manual proxy configuration manual: http_proxy: address: example.net @@ -126,19 +119,18 @@ manual: ```shell rougail -m firefox/ -u yaml -yf config/01/config.yml ``` -
╭─────────────────────────── Caption ────────────────────────────╮
-│ Variable                           Default value               │
-│ Undocumented but modified variable Modified value              │
-│                                    (⏳ Original default value) │
-╰────────────────────────────────────────────────────────────────╯
+
╭───────────────────── Caption ─────────────────────╮
+│ Variable                           Default value  │
+│ Undocumented but modified variable Modified value │
+╰───────────────────────────────────────────────────╯
 Variables:
-┣━━ 📓 Configure Proxy Access to the Internet: Manual proxy configuration ◀ 
-┃   loaded from the YAML file "config/01/config.yml" (⏳ No proxy)
+┣━━ 📓 Configure Proxy Access to the Internet: No proxy
 ┗━━ 📂 Manual proxy configuration
-    ┗━━ 📂 HTTP Proxy
-        ┣━━ 📓 HTTP address: example.net ◀ loaded from the YAML file 
-        ┃   "config/01/config.yml"
-        ┗━━ 📓 HTTP Port: 8080
+    ┣━━ 📂 HTTP Proxy
+    ┃   ┣━━ 📓 HTTP address: example.net ◀ loaded from the YAML file 
+    ┃   ┃   "config/01/config.yml"
+    ┃   ┗━━ 📓 HTTP Port: 8080
+    ┗━━ 📓 Also use this proxy for HTTPS: true
 

 ### Example 2
 
@@ -147,11 +139,10 @@ Variables:
 
 ```yml
 ---
-proxy_mode: Manual proxy configuration
 manual:
   http_proxy:
     address: example.net
-    port: 3128
+  use_for_https: false
 ```
 #### Output
 
@@ -159,65 +150,20 @@ manual:
 rougail -m firefox/ -u yaml -yf config/02/config.yml
 ```
 
╭─────────────────────────── Caption ────────────────────────────╮
-│ Variable                           Modified value              │
-│ Undocumented but modified variable (⏳ Original default value) │
-╰────────────────────────────────────────────────────────────────╯
-Variables:
-┣━━ 📓 Configure Proxy Access to the Internet: Manual proxy configuration ◀ 
-┃   loaded from the YAML file "config/02/config.yml" (⏳ No proxy)
-┗━━ 📂 Manual proxy configuration
-    ┗━━ 📂 HTTP Proxy
-        ┣━━ 📓 HTTP address: example.net ◀ loaded from the YAML file 
-        ┃   "config/02/config.yml"
-        ┗━━ 📓 HTTP Port: 3128 ◀ loaded from the YAML file 
-            "config/02/config.yml" (⏳ 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
-```
-
🔔 WARNINGS
-┗━━ the value "100000" is an invalid port for "manual.http_proxy.port" (HTTP 
-    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               │
 │ 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/03/config.yml" (⏳ No proxy)
+┣━━ 📓 Configure Proxy Access to the Internet: No proxy
 ┗━━ 📂 Manual proxy configuration
-    ┗━━ 📂 HTTP Proxy
-        ┣━━ 📓 HTTP address: example.net ◀ loaded from the YAML file 
-        ┃   "config/03/config.yml"
-        ┗━━ 📓 HTTP Port: 8080
-

-#### Output when invalid user datas is an error
-
-```shell
-rougail -m firefox/ -u yaml -yf config/03/config.yml --cli.invalid_user_datas_error
-```
-
🛑 ERRORS
-┗━━ the value "100000" is an invalid port for "manual.http_proxy.port" (HTTP 
-    Port), must be between 1 and 65535, it will be ignored when loading from the
-    YAML file "config/03/config.yml"
+    ┣━━ 📂 HTTP Proxy
+    ┃   ┣━━ 📓 HTTP address: example.net ◀ loaded from the YAML file 
+    ┃   ┃   "config/02/config.yml"
+    ┃   ┗━━ 📓 HTTP Port: 8080
+    ┗━━ 📓 Also use this proxy for HTTPS: false ◀ loaded from the YAML file 
+        "config/02/config.yml" (⏳ 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] 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))
diff --git a/config/01/config.yml b/config/01/config.yml
index e3db924b..22422a2f 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 c0fff144..c8e8475f 100644
--- a/config/01/output_ro.html
+++ b/config/01/output_ro.html
@@ -1,14 +1,13 @@
-
╭─────────────────────────── Caption ────────────────────────────╮
-│ Variable                           Default value               │
-│ Undocumented but modified variable Modified value              │
-│                                    (⏳ Original default value) │
-╰────────────────────────────────────────────────────────────────╯
+
╭───────────────────── Caption ─────────────────────╮
+│ Variable                           Default value  │
+│ Undocumented but modified variable Modified value │
+╰───────────────────────────────────────────────────╯
 Variables:
-┣━━ 📓 Configure Proxy Access to the Internet: Manual proxy configuration ◀ 
-┃   loaded from the YAML file "config/01/config.yml" (⏳ No proxy)
+┣━━ 📓 Configure Proxy Access to the Internet: No proxy
 ┗━━ 📂 Manual proxy configuration
-    ┗━━ 📂 HTTP Proxy
-        ┣━━ 📓 HTTP address: example.net ◀ loaded from the YAML file 
-        ┃   "config/01/config.yml"
-        ┗━━ 📓 HTTP Port: 8080
+    ┣━━ 📂 HTTP Proxy
+    ┃   ┣━━ 📓 HTTP address: example.net ◀ loaded from the YAML file 
+    ┃   ┃   "config/01/config.yml"
+    ┃   ┗━━ 📓 HTTP Port: 8080
+    ┗━━ 📓 Also use this proxy for HTTPS: true
 

diff --git a/config/02/config.yml b/config/02/config.yml
index 6e7c9dc6..e4ecc479 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 4a8ef0ff..f69ddd41 100644
--- a/config/02/output_ro.html
+++ b/config/02/output_ro.html
@@ -1,14 +1,15 @@
 
╭─────────────────────────── Caption ────────────────────────────╮
-│ Variable                           Modified value              │
-│ Undocumented but modified variable (⏳ Original default value) │
+│ 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/02/config.yml" (⏳ No proxy)
+┣━━ 📓 Configure Proxy Access to the Internet: No proxy
 ┗━━ 📂 Manual proxy configuration
-    ┗━━ 📂 HTTP Proxy
-        ┣━━ 📓 HTTP address: example.net ◀ loaded from the YAML file 
-        ┃   "config/02/config.yml"
-        ┗━━ 📓 HTTP Port: 3128 ◀ loaded from the YAML file 
-            "config/02/config.yml" (⏳ 8080)
+    ┣━━ 📂 HTTP Proxy
+    ┃   ┣━━ 📓 HTTP address: example.net ◀ loaded from the YAML file 
+    ┃   ┃   "config/02/config.yml"
+    ┃   ┗━━ 📓 HTTP Port: 8080
+    ┗━━ 📓 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 ffde9149..00000000
--- a/config/03/cmd_invalid.txt
+++ /dev/null
@@ -1 +0,0 @@
-rougail -m firefox/ -u yaml -yf config/03/config.yml --cli.invalid_user_datas_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 fc8085eb..00000000
--- 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 d05944fe..00000000
--- 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 3bc8ae7e..00000000
--- a/config/03/output_invalid.html
+++ /dev/null
@@ -1,5 +0,0 @@
-
🛑 ERRORS
-┗━━ the value "100000" is an invalid port for "manual.http_proxy.port" (HTTP 
-    Port), must be between 1 and 65535, it will be ignored when 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 af7a3f9b..00000000
--- a/config/03/output_ro.html
+++ /dev/null
@@ -1,18 +0,0 @@
-
🔔 WARNINGS
-┗━━ the value "100000" is an invalid port for "manual.http_proxy.port" (HTTP 
-    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               │
-│ 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/03/config.yml" (⏳ No proxy)
-┗━━ 📂 Manual proxy configuration
-    ┗━━ 📂 HTTP Proxy
-        ┣━━ 📓 HTTP address: example.net ◀ loaded from the YAML file 
-        ┃   "config/03/config.yml"
-        ┗━━ 📓 HTTP Port: 8080
-

diff --git a/firefox.png b/firefox.png
index e40ce963..b7ca7aa0 100644
Binary files a/firefox.png and b/firefox.png differ
diff --git a/tree.html b/tree.html
index b6437367..997b26ab 100644
--- a/tree.html
+++ b/tree.html
@@ -25,13 +25,14 @@
 
 
 	
Directory Tree

-	.

-	└── firefox

-	    ├── 00-proxy.yml

-	    └── 10-manual.yml

+	.

+	└── firefox

+	    ├── 00-proxy.yml

+	    ├── 10-manual.yml

+	    └── 20-manual.yml

 


 
-2 directories, 2 files
+2 directories, 3 files