diff --git a/README.md b/README.md index 99523b19..bee13a3c 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@ - [Summary](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/branch/1.1/README.md) -- [[tutorial v1.1_030] A disabled family](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_030/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_030~1..v1.1_030)) +- [[tutorial v1.1_031] A conditional disabled family with a variable](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_031)] A conditional disabled family with a variable +# [tutorial v1.1_041)] An hidden family -[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_031~1..v1.1_031) +[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_041~1..v1.1_041) ## Screenshot @@ -76,7 +76,9 @@ manual: use_for_https: true # Also use this proxy for HTTPS - https_proxy: # HTTPS Proxy + https_proxy: + description: HTTPS Proxy + hidden: true address: description: HTTPS address @@ -94,7 +96,7 @@ manual: ### Let's generate the documentation ```console -foo@bar:~$ git switch --detach v1.1_031 +foo@bar:~$ git switch --detach v1.1_041 foo@bar:~$ rougail -m firefox/ -o doc ``` | Variable                                                                                        | Description                                                                                     | @@ -124,34 +126,17 @@ foo@bar:~$ 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 - -**manual.https_proxy** - - - -| Variable                                                                                            | Description                                                                                         | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **manual.https_proxy.address**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTPS address.
**Validator**: 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 ```console -foo@bar:~$ git switch --detach v1.1_031 +foo@bar:~$ git switch --detach v1.1_041 foo@bar:~$ 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.
**Validator**: 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.
**Validator**: 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 | +#### Deleted variables +- manual.https_proxy.address +- manual.https_proxy.port ## User datas ### Example 1 @@ -166,7 +151,7 @@ foo@bar:~$ rougail -m firefox/ -o doc --doc.contents changelog #### Output ```console -foo@bar:~$ git switch --detach v1.1_031 +foo@bar:~$ git switch --detach v1.1_041 foo@bar:~$ rougail -m firefox/ -u yaml -ff config/01/config.yaml ``` 
╭─────── Caption ────────╮
@@ -175,18 +160,6 @@ foo@bar:~$ rougail -m firefox/ -u yaml -ff config/01/config.yaml
 Variables:
 ┗━━ 📓 Configure Proxy Access to the Internet: No proxy
-#### Output in read write mode - -```console -foo@bar:~$ git switch --detach v1.1_031 -foo@bar:~$ rougail -m firefox/ -u yaml -ff config/01/config.yaml --cli.read_write -``` -
╭─────── Caption ────────╮
-│ Variable Default value │
-╰────────────────────────╯
-Variables:
-┗━━ 📓 Configure Proxy Access to the Internet: No proxy
-
### Example 2 #### config/02/config.yaml @@ -194,36 +167,21 @@ Variables: ```yml --- -proxy_mode: Manual proxy configuration +proxy_mode: No proxy ``` #### Output ```console -foo@bar:~$ git switch --detach v1.1_031 +foo@bar:~$ git switch --detach v1.1_041 foo@bar:~$ rougail -m firefox/ -u yaml -ff config/02/config.yaml ``` -
🛑 ERRORS
-┗━━ The following variables are mandatory but have no value:
-    ┗━━ Manual proxy configuration
-        ┣━━ HTTP Proxy
-        ┃   ┗━━ HTTP address
-        ┗━━ HTTPS Proxy
-            ┗━━ HTTPS address
-
-#### Output in read write mode - -```console -foo@bar:~$ git switch --detach v1.1_031 -foo@bar:~$ rougail -m firefox/ -u yaml -ff config/02/config.yaml --cli.read_write -``` -
🛑 ERRORS
-┗━━ The following variables are mandatory but have no value:
-    ┗━━ Manual proxy configuration
-        ┣━━ HTTP Proxy
-        ┃   ┗━━ HTTP address
-        ┗━━ HTTPS Proxy
-            ┗━━ HTTPS address
+
╭────────────── Caption ───────────────╮
+│ Variable Modified value              │
+│          (⏳ Original default value) │
+╰──────────────────────────────────────╯
+Variables:
+┗━━ 📓 Configure Proxy Access to the Internet: No proxy ◀ loaded from the YAML file "config/02/config.yaml" (⏳ No proxy)
 

 ### Example 3
 
@@ -233,34 +191,19 @@ foo@bar:~$ rougail -m firefox/ -u yaml -ff config/02/config.yaml --cli.read_writ
 ```yml
 ---
 proxy_mode: Manual proxy configuration
-manual:
-  http_proxy:
-    address: example.net
 
 ```
 #### Output
 
 ```console
-foo@bar:~$ git switch --detach v1.1_031
+foo@bar:~$ git switch --detach v1.1_041
 foo@bar:~$ rougail -m firefox/ -u yaml -ff config/03/config.yaml
 ```
 
🛑 ERRORS
 ┗━━ The following variables are mandatory but have no value:
     ┗━━ Manual proxy configuration
-        ┗━━ HTTPS Proxy
-            ┗━━ HTTPS address
-

-#### Output in read write mode
-
-```console
-foo@bar:~$ git switch --detach v1.1_031
-foo@bar:~$ rougail -m firefox/ -u yaml -ff config/03/config.yaml --cli.read_write
-```
-
🛑 ERRORS
-┗━━ The following variables are mandatory but have no value:
-    ┗━━ Manual proxy configuration
-        ┗━━ HTTPS Proxy
-            ┗━━ HTTPS address
+        ┗━━ HTTP Proxy
+            ┗━━ HTTP address
 

 ### Example 4
 
@@ -269,36 +212,23 @@ foo@bar:~$ rougail -m firefox/ -u yaml -ff config/03/config.yaml --cli.read_writ
 
 ```yml
 ---
-proxy_mode: Manual proxy configuration
-manual:
-  http_proxy:
-    address: example.net
-    port: '3128'
+proxy_mode: foo
 
 ```
 #### Output
 
 ```console
-foo@bar:~$ git switch --detach v1.1_031
+foo@bar:~$ git switch --detach v1.1_041
 foo@bar:~$ rougail -m firefox/ -u yaml -ff config/04/config.yaml
 ```
-
🛑 ERRORS
-┗━━ The following variables are mandatory but have no value:
-    ┗━━ Manual proxy configuration
-        ┗━━ HTTPS Proxy
-            ┗━━ HTTPS address
-

-#### Output in read write mode
-
-```console
-foo@bar:~$ git switch --detach v1.1_031
-foo@bar:~$ rougail -m firefox/ -u yaml -ff config/04/config.yaml --cli.read_write
-```
-
🛑 ERRORS
-┗━━ The following variables are mandatory but have no value:
-    ┗━━ Manual proxy configuration
-        ┗━━ HTTPS Proxy
-            ┗━━ HTTPS address
+
🔔 WARNINGS
+┗━━ the value "foo" is an invalid choice for "proxy_mode" (Configure Proxy Access to the Internet), only "Auto-detect proxy settings for this network", "Automatic proxy configuration URL", "Manual proxy 
+    configuration", "No proxy" and "Use system proxy settings" are allowed, it will be ignored when loading from the YAML file "config/04/config.yaml"
+╭─────── Caption ────────╮
+│ Variable Default value │
+╰────────────────────────╯
+Variables:
+┗━━ 📓 Configure Proxy Access to the Internet: No proxy
 

 ### Example 5
 
@@ -307,60 +237,24 @@ foo@bar:~$ rougail -m firefox/ -u yaml -ff config/04/config.yaml --cli.read_writ
 
 ```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
+proxy_mode: 1
 
 ```
 #### Output
 
 ```console
-foo@bar:~$ git switch --detach v1.1_031
+foo@bar:~$ git switch --detach v1.1_041
 foo@bar:~$ rougail -m firefox/ -u yaml -ff config/05/config.yaml
 ```
-
╭────────────── Caption ───────────────╮
-│ Variable Default value               │
-│          Modified value              │
-│          (⏳ Original default value) │
-╰──────────────────────────────────────╯
+
🔔 WARNINGS
+┗━━ the value "1" is an invalid choice for "proxy_mode" (Configure Proxy Access to the Internet), only "Auto-detect proxy settings for this network", "Automatic proxy configuration URL", "Manual proxy 
+    configuration", "No proxy" and "Use system proxy settings" are allowed, it will be ignored when loading from the YAML file "config/05/config.yaml"
+╭─────── Caption ────────╮
+│ Variable Default value │
+╰────────────────────────╯
 Variables:
-┣━━ 📓 Configure Proxy Access to the Internet: Manual proxy configuration ◀ loaded from the YAML file "config/05/config.yaml" (⏳ No proxy)
-┗━━ 📂 Manual proxy configuration
-    ┣━━ 📂 HTTP Proxy
-    ┃   ┣━━ 📓 HTTP address: http.proxy.net ◀ loaded from the YAML file "config/05/config.yaml"
-    ┃   ┗━━ 📓 HTTP Port: 3128 ◀ loaded from the YAML file "config/05/config.yaml" (⏳ 8080)
-    ┣━━ 📓 Also use this proxy for HTTPS: false ◀ loaded from the YAML file "config/05/config.yaml" (⏳ true)
-    ┗━━ 📂 HTTPS Proxy
-        ┣━━ 📓 HTTPS address: https.proxy.net ◀ loaded from the YAML file "config/05/config.yaml"
-        ┗━━ 📓 HTTPS Port: 8080
-

-#### Output in read write mode
-
-```console
-foo@bar:~$ git switch --detach v1.1_031
-foo@bar:~$ rougail -m firefox/ -u yaml -ff config/05/config.yaml --cli.read_write
-```
-
╭────────────── Caption ───────────────╮
-│ Variable Default value               │
-│          Modified value              │
-│          (⏳ Original default value) │
-╰──────────────────────────────────────╯
-Variables:
-┣━━ 📓 Configure Proxy Access to the Internet: Manual proxy configuration ◀ loaded from the YAML file "config/05/config.yaml" (⏳ No proxy)
-┗━━ 📂 Manual proxy configuration
-    ┣━━ 📂 HTTP Proxy
-    ┃   ┣━━ 📓 HTTP address: http.proxy.net ◀ loaded from the YAML file "config/05/config.yaml"
-    ┃   ┗━━ 📓 HTTP Port: 3128 ◀ loaded from the YAML file "config/05/config.yaml" (⏳ 8080)
-    ┣━━ 📓 Also use this proxy for HTTPS: false ◀ loaded from the YAML file "config/05/config.yaml" (⏳ true)
-    ┗━━ 📂 HTTPS Proxy
-        ┣━━ 📓 HTTPS address: https.proxy.net ◀ loaded from the YAML file "config/05/config.yaml"
-        ┗━━ 📓 HTTPS Port: 8080
+┗━━ 📓 Configure Proxy Access to the Internet: No proxy
 

 
 
-- [[tutorial v1.1_041] An hidden 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] A conditional hidden family with a variable](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))
diff --git a/config/01/output_rw.html b/config/01/output_rw.html
deleted file mode 100644
index ea9c2266..00000000
--- a/config/01/output_rw.html
+++ /dev/null
@@ -1,6 +0,0 @@
-
╭─────── Caption ────────╮
-│ Variable Default value │
-╰────────────────────────╯
-Variables:
-┗━━ 📓 Configure Proxy Access to the Internet: No proxy
-

diff --git a/config/02/config.yaml b/config/02/config.yaml
index 74edb225..d9144882 100644
--- a/config/02/config.yaml
+++ b/config/02/config.yaml
@@ -1,2 +1,2 @@
 ---
-proxy_mode: Manual proxy configuration
+proxy_mode: No proxy
diff --git a/config/02/output_ro.html b/config/02/output_ro.html
index 45e42766..b0153620 100644
--- a/config/02/output_ro.html
+++ b/config/02/output_ro.html
@@ -1,8 +1,7 @@
-
🛑 ERRORS
-┗━━ The following variables are mandatory but have no value:
-    ┗━━ Manual proxy configuration
-        ┣━━ HTTP Proxy
-        ┃   ┗━━ HTTP address
-        ┗━━ HTTPS Proxy
-            ┗━━ HTTPS address
+
╭────────────── Caption ───────────────╮
+│ Variable Modified value              │
+│          (⏳ Original default value) │
+╰──────────────────────────────────────╯
+Variables:
+┗━━ 📓 Configure Proxy Access to the Internet: No proxy ◀ loaded from the YAML file "config/02/config.yaml" (⏳ No proxy)
 

diff --git a/config/02/output_rw.html b/config/02/output_rw.html
deleted file mode 100644
index 45e42766..00000000
--- a/config/02/output_rw.html
+++ /dev/null
@@ -1,8 +0,0 @@
-
🛑 ERRORS
-┗━━ The following variables are mandatory but have no value:
-    ┗━━ Manual proxy configuration
-        ┣━━ HTTP Proxy
-        ┃   ┗━━ HTTP address
-        ┗━━ HTTPS Proxy
-            ┗━━ HTTPS address
-

diff --git a/config/03/config.yaml b/config/03/config.yaml
index e3db924b..74edb225 100644
--- a/config/03/config.yaml
+++ b/config/03/config.yaml
@@ -1,5 +1,2 @@
 ---
 proxy_mode: Manual proxy configuration
-manual:
-  http_proxy:
-    address: example.net
diff --git a/config/03/output_ro.html b/config/03/output_ro.html
index 29354397..ec666c15 100644
--- a/config/03/output_ro.html
+++ b/config/03/output_ro.html
@@ -1,6 +1,6 @@
 
🛑 ERRORS
 ┗━━ The following variables are mandatory but have no value:
     ┗━━ Manual proxy configuration
-        ┗━━ HTTPS Proxy
-            ┗━━ HTTPS address
+        ┗━━ HTTP Proxy
+            ┗━━ HTTP address
 

diff --git a/config/03/output_rw.html b/config/03/output_rw.html
deleted file mode 100644
index 29354397..00000000
--- a/config/03/output_rw.html
+++ /dev/null
@@ -1,6 +0,0 @@
-
🛑 ERRORS
-┗━━ The following variables are mandatory but have no value:
-    ┗━━ Manual proxy configuration
-        ┗━━ HTTPS Proxy
-            ┗━━ HTTPS address
-

diff --git a/config/04/config.yaml b/config/04/config.yaml
index c8d73af3..e3fa25da 100644
--- a/config/04/config.yaml
+++ b/config/04/config.yaml
@@ -1,6 +1,2 @@
 ---
-proxy_mode: Manual proxy configuration
-manual:
-  http_proxy:
-    address: example.net
-    port: '3128'
+proxy_mode: foo
diff --git a/config/04/output_ro.html b/config/04/output_ro.html
index 29354397..3b735cce 100644
--- a/config/04/output_ro.html
+++ b/config/04/output_ro.html
@@ -1,6 +1,9 @@
-
🛑 ERRORS
-┗━━ The following variables are mandatory but have no value:
-    ┗━━ Manual proxy configuration
-        ┗━━ HTTPS Proxy
-            ┗━━ HTTPS address
+
🔔 WARNINGS
+┗━━ the value "foo" is an invalid choice for "proxy_mode" (Configure Proxy Access to the Internet), only "Auto-detect proxy settings for this network", "Automatic proxy configuration URL", "Manual proxy 
+    configuration", "No proxy" and "Use system proxy settings" are allowed, it will be ignored when loading from the YAML file "config/04/config.yaml"
+╭─────── Caption ────────╮
+│ Variable Default value │
+╰────────────────────────╯
+Variables:
+┗━━ 📓 Configure Proxy Access to the Internet: No proxy
 

diff --git a/config/04/output_rw.html b/config/04/output_rw.html
deleted file mode 100644
index 29354397..00000000
--- a/config/04/output_rw.html
+++ /dev/null
@@ -1,6 +0,0 @@
-
🛑 ERRORS
-┗━━ The following variables are mandatory but have no value:
-    ┗━━ Manual proxy configuration
-        ┗━━ HTTPS Proxy
-            ┗━━ HTTPS address
-

diff --git a/config/05/config.yaml b/config/05/config.yaml
index 4a1f7890..bf6f64ca 100644
--- a/config/05/config.yaml
+++ b/config/05/config.yaml
@@ -1,9 +1,2 @@
 ---
-proxy_mode: Manual proxy configuration
-manual:
-  http_proxy:
-    address: http.proxy.net
-    port: '3128'
-  use_for_https: false
-  https_proxy:
-    address: https.proxy.net
+proxy_mode: 1
diff --git a/config/05/output_ro.html b/config/05/output_ro.html
index 4a9da60a..21c747f4 100644
--- a/config/05/output_ro.html
+++ b/config/05/output_ro.html
@@ -1,16 +1,9 @@
-
╭────────────── Caption ───────────────╮
-│ Variable Default value               │
-│          Modified value              │
-│          (⏳ Original default value) │
-╰──────────────────────────────────────╯
+
🔔 WARNINGS
+┗━━ the value "1" is an invalid choice for "proxy_mode" (Configure Proxy Access to the Internet), only "Auto-detect proxy settings for this network", "Automatic proxy configuration URL", "Manual proxy 
+    configuration", "No proxy" and "Use system proxy settings" are allowed, it will be ignored when loading from the YAML file "config/05/config.yaml"
+╭─────── Caption ────────╮
+│ Variable Default value │
+╰────────────────────────╯
 Variables:
-┣━━ 📓 Configure Proxy Access to the Internet: Manual proxy configuration ◀ loaded from the YAML file "config/05/config.yaml" (⏳ No proxy)
-┗━━ 📂 Manual proxy configuration
-    ┣━━ 📂 HTTP Proxy
-    ┃   ┣━━ 📓 HTTP address: http.proxy.net ◀ loaded from the YAML file "config/05/config.yaml"
-    ┃   ┗━━ 📓 HTTP Port: 3128 ◀ loaded from the YAML file "config/05/config.yaml" (⏳ 8080)
-    ┣━━ 📓 Also use this proxy for HTTPS: false ◀ loaded from the YAML file "config/05/config.yaml" (⏳ true)
-    ┗━━ 📂 HTTPS Proxy
-        ┣━━ 📓 HTTPS address: https.proxy.net ◀ loaded from the YAML file "config/05/config.yaml"
-        ┗━━ 📓 HTTPS Port: 8080
+┗━━ 📓 Configure Proxy Access to the Internet: No proxy
 

diff --git a/config/05/output_rw.html b/config/05/output_rw.html
deleted file mode 100644
index 4a9da60a..00000000
--- a/config/05/output_rw.html
+++ /dev/null
@@ -1,16 +0,0 @@
-
╭────────────── Caption ───────────────╮
-│ Variable Default value               │
-│          Modified value              │
-│          (⏳ Original default value) │
-╰──────────────────────────────────────╯
-Variables:
-┣━━ 📓 Configure Proxy Access to the Internet: Manual proxy configuration ◀ loaded from the YAML file "config/05/config.yaml" (⏳ No proxy)
-┗━━ 📂 Manual proxy configuration
-    ┣━━ 📂 HTTP Proxy
-    ┃   ┣━━ 📓 HTTP address: http.proxy.net ◀ loaded from the YAML file "config/05/config.yaml"
-    ┃   ┗━━ 📓 HTTP Port: 3128 ◀ loaded from the YAML file "config/05/config.yaml" (⏳ 8080)
-    ┣━━ 📓 Also use this proxy for HTTPS: false ◀ loaded from the YAML file "config/05/config.yaml" (⏳ true)
-    ┗━━ 📂 HTTPS Proxy
-        ┣━━ 📓 HTTPS address: https.proxy.net ◀ loaded from the YAML file "config/05/config.yaml"
-        ┗━━ 📓 HTTPS Port: 8080
-