diff --git a/README.md b/README.md
index b93d1de..c556780 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) +-- [[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 @@ -### 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 ``` -╭────────────────────────── Caption ──────────────────────────╮ +│ Variable Default value │ +│ Undocumented variable Modified value │ +│ Undocumented but modified variable (Original default value) │ +╰─────────────────────────────────────────────────────────────╯ +Variables: +┗━━ 📓 proxy_mode: No proxy🛑 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 ``` -### Example 5 @@ -254,6 +252,8 @@ manual: foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/05/config.yaml ```🛑 ERRORS -┣━━ The following variables are mandatory but have no value: -┗━━ - manual.http_proxy.address (HTTP address) +### Example 4 @@ -201,17 +204,16 @@ manual: ```console foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/04/config.yaml ``` -### Example 3 @@ -152,17 +161,15 @@ manual: ```console foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/03/config.yaml ``` -╭────────────────────────── Caption ──────────────────────────╮ +│ Variable Default value │ +│ Undocumented variable Modified value │ +│ Undocumented but modified variable (Original default value) │ +╰─────────────────────────────────────────────────────────────╯ +Variables: +┗━━ 📓 proxy_mode: Manual proxy configuration (No proxy)╭────────────────────────── 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 +182,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)╭────────────────────────── 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 +226,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)🛑 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 +262,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 +275,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)🛑 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 proxydiff --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 proxydiff --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..98e6cee 100644 --- a/config/03/output_ro.html +++ b/config/03/output_ro.html @@ -1,12 +1,10 @@ -╭────────────────────────── Caption ──────────────────────────╮ +diff --git a/config/04/output_ro.html b/config/04/output_ro.html index 56d3640..57c06eb 100644 --- a/config/04/output_ro.html +++ b/config/04/output_ro.html @@ -1,12 +1,11 @@ -🛑 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)╭────────────────────────── Caption ──────────────────────────╮ +diff --git a/config/05/output_ro.html b/config/05/output_ro.html index 984844a..0a2c978 100644 --- a/config/05/output_ro.html +++ b/config/05/output_ro.html @@ -1,4 +1,6 @@🛑 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)🛑 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 +9,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)