From cfe1e0d3bc2fc0a0c3a9016c7a5c968670e46b38 Mon Sep 17 00:00:00 2001 From: Emmanuel Garette Date: Sat, 2 Nov 2024 14:58:23 +0100 Subject: [PATCH] [tutorial 027] A disabled family (config and doc) --- README.md | 117 +++++++++++++++++++-------------------- config/01/output_ro.html | 11 +++- config/01/output_rw.html | 10 +++- config/02/output_ro.html | 10 +++- config/02/output_rw.html | 10 +++- config/03/output_ro.html | 11 ++-- config/03/output_rw.html | 6 +- config/04/output_ro.html | 13 +++-- config/04/output_rw.html | 6 +- config/05/output_ro.html | 10 ++-- config/05/output_rw.html | 6 +- 11 files changed, 106 insertions(+), 104 deletions(-) diff --git a/README.md b/README.md index b93d1de..1df5ac1 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 025] A variable with type's parameters](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_025/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_025~1..v1.1_025)) +- [[tutorial 026] A variable with type "port"](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_026/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_026~1..v1.1_026)) -# [tutorial 026] A variable with type "port" +# [tutorial 027] A disabled family -[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_026~1..v1.1_026) +[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_027~1..v1.1_027) ## Screenshot @@ -38,6 +38,7 @@ proxy_mode: --- manual: description: Manual proxy configuration + disabled: true http_proxy: description: HTTP Proxy @@ -61,18 +62,9 @@ foo@bar:~$ rougail -v 1.1 -m firefox/ -o doc -do github ``` ### Variables -| Variable                                                                                      | Description                                                                                   | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **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 - -##### HTTP Proxy - -| 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.
**Default**: 8080 | +| Variable                                                                                                                                                                                             | Description                                                                                                                                                                                          | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **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 | ## User data @@ -91,18 +83,27 @@ foo@bar:~$ rougail -v 1.1 -m firefox/ -o doc -do github ```console foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/01/config.yaml ``` -
🛑 ERRORS
-┣━━ The following variables are mandatory but have no value:
-┗━━   - manual.http_proxy.address (HTTP address)
+
╭────────────────────────── Caption ──────────────────────────╮
+│ Variable                           Default value            │
+│ Undocumented variable              Modified value           │
+│ Undocumented but modified variable (Original default value) │
+│ Unmodifiable variable                                       │
+╰─────────────────────────────────────────────────────────────╯
+Variables:
+┗━━ 📓 proxy_mode: No proxy
 
#### Output in read write mode ```console foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/01/config.yaml --exporter.read_write ``` -
🛑 ERRORS
-┣━━ The following variables are mandatory but have no value:
-┗━━   - manual.http_proxy.address (HTTP address)
+
╭────────────────────────── Caption ──────────────────────────╮
+│ Variable                           Default value            │
+│ Undocumented variable              Modified value           │
+│ Undocumented but modified variable (Original default value) │
+╰─────────────────────────────────────────────────────────────╯
+Variables:
+┗━━ 📓 proxy_mode: No proxy
 
### Example 2 @@ -120,18 +121,26 @@ proxy_mode: Manual proxy configuration ```console foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/02/config.yaml ``` -
🛑 ERRORS
-┣━━ The following variables are mandatory but have no value:
-┗━━   - manual.http_proxy.address (HTTP address)
+
╭────────────────────────── Caption ──────────────────────────╮
+│ Variable                           Default value            │
+│ Undocumented variable              Modified value           │
+│ Undocumented but modified variable (Original default value) │
+╰─────────────────────────────────────────────────────────────╯
+Variables:
+┗━━ 📓 proxy_mode: Manual proxy configuration (No proxy)
 
#### Output in read write mode ```console foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/02/config.yaml --exporter.read_write ``` -
🛑 ERRORS
-┣━━ The following variables are mandatory but have no value:
-┗━━   - manual.http_proxy.address (HTTP address)
+
╭────────────────────────── Caption ──────────────────────────╮
+│ Variable                           Default value            │
+│ Undocumented variable              Modified value           │
+│ Undocumented but modified variable (Original default value) │
+╰─────────────────────────────────────────────────────────────╯
+Variables:
+┗━━ 📓 proxy_mode: Manual proxy configuration (No proxy)
 
### Example 3 @@ -152,17 +161,16 @@ manual: ```console foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/03/config.yaml ``` -
╭────────────────────────── Caption ──────────────────────────╮
+
🛑 ERRORS
+┗━━ cannot access to optiondescription "manual" (Manual proxy configuration) because has property 
+    "disabled"
+╭────────────────────────── Caption ──────────────────────────╮
 │ Variable                           Default value            │
 │ Undocumented variable              Modified value           │
 │ Undocumented but modified variable (Original default value) │
 ╰─────────────────────────────────────────────────────────────╯
 Variables:
-┣━━ 📓 proxy_mode: Manual proxy configuration (No proxy)
-┗━━ 📂 manual
-    ┗━━ 📂 http_proxy
-        ┣━━ 📓 address: example.net
-        ┗━━ 📓 port: 8080
+┗━━ 📓 proxy_mode: Manual proxy configuration (No proxy)
 
#### Output in read write mode @@ -175,11 +183,7 @@ foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/03/config.yaml --export │ Undocumented but modified variable (Original default value) │ ╰─────────────────────────────────────────────────────────────╯ Variables: -┣━━ 📓 proxy_mode: Manual proxy configuration (No proxy) -┗━━ 📂 manual - ┗━━ 📂 http_proxy - ┣━━ 📓 address: example.net - ┗━━ 📓 port: 8080 +┗━━ 📓 proxy_mode: Manual proxy configuration (No proxy)
### Example 4 @@ -201,17 +205,18 @@ manual: ```console foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/04/config.yaml ``` -
╭────────────────────────── Caption ──────────────────────────╮
+
🛑 ERRORS
+┣━━ cannot access to optiondescription "manual" (Manual proxy configuration) because has property 
+"disabled"
+┗━━ cannot access to optiondescription "manual" (Manual proxy configuration) because has property 
+    "disabled"
+╭────────────────────────── Caption ──────────────────────────╮
 │ Variable                           Default value            │
 │ Undocumented variable              Modified value           │
 │ Undocumented but modified variable (Original default value) │
 ╰─────────────────────────────────────────────────────────────╯
 Variables:
-┣━━ 📓 proxy_mode: Manual proxy configuration (No proxy)
-┗━━ 📂 manual
-    ┗━━ 📂 http_proxy
-        ┣━━ 📓 address: example.net
-        ┗━━ 📓 port: 3128 (8080)
+┗━━ 📓 proxy_mode: Manual proxy configuration (No proxy)
 
#### Output in read write mode @@ -224,11 +229,7 @@ foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/04/config.yaml --export │ Undocumented but modified variable (Original default value) │ ╰─────────────────────────────────────────────────────────────╯ Variables: -┣━━ 📓 proxy_mode: Manual proxy configuration (No proxy) -┗━━ 📂 manual - ┗━━ 📂 http_proxy - ┣━━ 📓 address: example.net - ┗━━ 📓 port: 3128 (8080) +┗━━ 📓 proxy_mode: Manual proxy configuration (No proxy)
### Example 5 @@ -254,6 +255,10 @@ manual: foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/05/config.yaml ```
🛑 ERRORS
+┣━━ cannot access to optiondescription "manual" (Manual proxy configuration) because has property 
+"disabled"
+┣━━ cannot access to optiondescription "manual" (Manual proxy configuration) because has property 
+"disabled"
 ┣━━ unknown option "use_for_https" in optiondescription "manual" (Manual proxy configuration)
 ┗━━ unknown option "https_proxy" in optiondescription "manual" (Manual proxy configuration)
 ╭────────────────────────── Caption ──────────────────────────╮
@@ -262,11 +267,7 @@ foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/05/config.yaml
 │ Undocumented but modified variable (Original default value) │
 ╰─────────────────────────────────────────────────────────────╯
 Variables:
-┣━━ 📓 proxy_mode: Manual proxy configuration (No proxy)
-┗━━ 📂 manual
-    ┗━━ 📂 http_proxy
-        ┣━━ 📓 address: http.proxy.net
-        ┗━━ 📓 port: 3128 (8080)
+┗━━ 📓 proxy_mode: Manual proxy configuration (No proxy)
 
#### Output in read write mode @@ -279,13 +280,9 @@ foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/05/config.yaml --export │ Undocumented but modified variable (Original default value) │ ╰─────────────────────────────────────────────────────────────╯ Variables: -┣━━ 📓 proxy_mode: Manual proxy configuration (No proxy) -┗━━ 📂 manual - ┗━━ 📂 http_proxy - ┣━━ 📓 address: http.proxy.net - ┗━━ 📓 port: 3128 (8080) +┗━━ 📓 proxy_mode: Manual proxy configuration (No proxy)
-- [[tutorial 027] A disabled family](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_027/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_027~1..v1.1_027)) +- [[tutorial 028] A conditional disabled family with a variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_028/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_028~1..v1.1_028)) diff --git a/config/01/output_ro.html b/config/01/output_ro.html index 28450ac..cdecbe8 100644 --- a/config/01/output_ro.html +++ b/config/01/output_ro.html @@ -1,4 +1,9 @@ -
🛑 ERRORS
-┣━━ The following variables are mandatory but have no value:
-┗━━   - manual.http_proxy.address (HTTP address)
+
╭────────────────────────── Caption ──────────────────────────╮
+│ Variable                           Default value            │
+│ Undocumented variable              Modified value           │
+│ Undocumented but modified variable (Original default value) │
+│ Unmodifiable variable                                       │
+╰─────────────────────────────────────────────────────────────╯
+Variables:
+┗━━ 📓 proxy_mode: No proxy
 
diff --git a/config/01/output_rw.html b/config/01/output_rw.html index 28450ac..f74f3a6 100644 --- a/config/01/output_rw.html +++ b/config/01/output_rw.html @@ -1,4 +1,8 @@ -
🛑 ERRORS
-┣━━ The following variables are mandatory but have no value:
-┗━━   - manual.http_proxy.address (HTTP address)
+
╭────────────────────────── Caption ──────────────────────────╮
+│ Variable                           Default value            │
+│ Undocumented variable              Modified value           │
+│ Undocumented but modified variable (Original default value) │
+╰─────────────────────────────────────────────────────────────╯
+Variables:
+┗━━ 📓 proxy_mode: No proxy
 
diff --git a/config/02/output_ro.html b/config/02/output_ro.html index 28450ac..4c097ea 100644 --- a/config/02/output_ro.html +++ b/config/02/output_ro.html @@ -1,4 +1,8 @@ -
🛑 ERRORS
-┣━━ The following variables are mandatory but have no value:
-┗━━   - manual.http_proxy.address (HTTP address)
+
╭────────────────────────── Caption ──────────────────────────╮
+│ Variable                           Default value            │
+│ Undocumented variable              Modified value           │
+│ Undocumented but modified variable (Original default value) │
+╰─────────────────────────────────────────────────────────────╯
+Variables:
+┗━━ 📓 proxy_mode: Manual proxy configuration (No proxy)
 
diff --git a/config/02/output_rw.html b/config/02/output_rw.html index 28450ac..4c097ea 100644 --- a/config/02/output_rw.html +++ b/config/02/output_rw.html @@ -1,4 +1,8 @@ -
🛑 ERRORS
-┣━━ The following variables are mandatory but have no value:
-┗━━   - manual.http_proxy.address (HTTP address)
+
╭────────────────────────── Caption ──────────────────────────╮
+│ Variable                           Default value            │
+│ Undocumented variable              Modified value           │
+│ Undocumented but modified variable (Original default value) │
+╰─────────────────────────────────────────────────────────────╯
+Variables:
+┗━━ 📓 proxy_mode: Manual proxy configuration (No proxy)
 
diff --git a/config/03/output_ro.html b/config/03/output_ro.html index 9a3ff4f..2300b82 100644 --- a/config/03/output_ro.html +++ b/config/03/output_ro.html @@ -1,12 +1,11 @@ -
╭────────────────────────── Caption ──────────────────────────╮
+
🛑 ERRORS
+┗━━ cannot access to optiondescription "manual" (Manual proxy configuration) because has property 
+    "disabled"
+╭────────────────────────── Caption ──────────────────────────╮
 │ Variable                           Default value            │
 │ Undocumented variable              Modified value           │
 │ Undocumented but modified variable (Original default value) │
 ╰─────────────────────────────────────────────────────────────╯
 Variables:
-┣━━ 📓 proxy_mode: Manual proxy configuration (No proxy)
-┗━━ 📂 manual
-    ┗━━ 📂 http_proxy
-        ┣━━ 📓 address: example.net
-        ┗━━ 📓 port: 8080
+┗━━ 📓 proxy_mode: Manual proxy configuration (No proxy)
 
diff --git a/config/03/output_rw.html b/config/03/output_rw.html index 9a3ff4f..4c097ea 100644 --- a/config/03/output_rw.html +++ b/config/03/output_rw.html @@ -4,9 +4,5 @@ │ Undocumented but modified variable (Original default value) │ ╰─────────────────────────────────────────────────────────────╯ Variables: -┣━━ 📓 proxy_mode: Manual proxy configuration (No proxy) -┗━━ 📂 manual - ┗━━ 📂 http_proxy - ┣━━ 📓 address: example.net - ┗━━ 📓 port: 8080 +┗━━ 📓 proxy_mode: Manual proxy configuration (No proxy)
diff --git a/config/04/output_ro.html b/config/04/output_ro.html index 56d3640..fedc3f2 100644 --- a/config/04/output_ro.html +++ b/config/04/output_ro.html @@ -1,12 +1,13 @@ -
╭────────────────────────── Caption ──────────────────────────╮
+
🛑 ERRORS
+┣━━ cannot access to optiondescription "manual" (Manual proxy configuration) because has property 
+"disabled"
+┗━━ cannot access to optiondescription "manual" (Manual proxy configuration) because has property 
+    "disabled"
+╭────────────────────────── Caption ──────────────────────────╮
 │ Variable                           Default value            │
 │ Undocumented variable              Modified value           │
 │ Undocumented but modified variable (Original default value) │
 ╰─────────────────────────────────────────────────────────────╯
 Variables:
-┣━━ 📓 proxy_mode: Manual proxy configuration (No proxy)
-┗━━ 📂 manual
-    ┗━━ 📂 http_proxy
-        ┣━━ 📓 address: example.net
-        ┗━━ 📓 port: 3128 (8080)
+┗━━ 📓 proxy_mode: Manual proxy configuration (No proxy)
 
diff --git a/config/04/output_rw.html b/config/04/output_rw.html index 56d3640..4c097ea 100644 --- a/config/04/output_rw.html +++ b/config/04/output_rw.html @@ -4,9 +4,5 @@ │ Undocumented but modified variable (Original default value) │ ╰─────────────────────────────────────────────────────────────╯ Variables: -┣━━ 📓 proxy_mode: Manual proxy configuration (No proxy) -┗━━ 📂 manual - ┗━━ 📂 http_proxy - ┣━━ 📓 address: example.net - ┗━━ 📓 port: 3128 (8080) +┗━━ 📓 proxy_mode: Manual proxy configuration (No proxy)
diff --git a/config/05/output_ro.html b/config/05/output_ro.html index 984844a..8d7332e 100644 --- a/config/05/output_ro.html +++ b/config/05/output_ro.html @@ -1,4 +1,8 @@
🛑 ERRORS
+┣━━ cannot access to optiondescription "manual" (Manual proxy configuration) because has property 
+"disabled"
+┣━━ cannot access to optiondescription "manual" (Manual proxy configuration) because has property 
+"disabled"
 ┣━━ unknown option "use_for_https" in optiondescription "manual" (Manual proxy configuration)
 ┗━━ unknown option "https_proxy" in optiondescription "manual" (Manual proxy configuration)
 ╭────────────────────────── Caption ──────────────────────────╮
@@ -7,9 +11,5 @@
 │ Undocumented but modified variable (Original default value) │
 ╰─────────────────────────────────────────────────────────────╯
 Variables:
-┣━━ 📓 proxy_mode: Manual proxy configuration (No proxy)
-┗━━ 📂 manual
-    ┗━━ 📂 http_proxy
-        ┣━━ 📓 address: http.proxy.net
-        ┗━━ 📓 port: 3128 (8080)
+┗━━ 📓 proxy_mode: Manual proxy configuration (No proxy)
 
diff --git a/config/05/output_rw.html b/config/05/output_rw.html index ec2ef0c..4c097ea 100644 --- a/config/05/output_rw.html +++ b/config/05/output_rw.html @@ -4,9 +4,5 @@ │ Undocumented but modified variable (Original default value) │ ╰─────────────────────────────────────────────────────────────╯ Variables: -┣━━ 📓 proxy_mode: Manual proxy configuration (No proxy) -┗━━ 📂 manual - ┗━━ 📂 http_proxy - ┣━━ 📓 address: http.proxy.net - ┗━━ 📓 port: 3128 (8080) +┗━━ 📓 proxy_mode: Manual proxy configuration (No proxy)