diff --git a/README.md b/README.md index 8e8794d..e0632f9 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 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)) -# [tutorial 028] A conditional disabled family with a variable +# [tutorial 029] Type variable is optional -[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_028~1..v1.1_028) +[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_029~1..v1.1_029) ## Screenshot @@ -39,7 +39,6 @@ proxy_mode: manual: description: Manual proxy configuration disabled: - type: variable variable: proxy_mode when_not: 'Manual proxy configuration' @@ -83,226 +82,6 @@ _`disabled`_ | **manual.http_proxy.port**
[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTP Port.
**Default**: 8080 | -## User data - -### Example 1 - -#### config/01/config.yaml -```yml ---- - -``` -#### Output - -```console -foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/01/config.yaml -``` -
╭────────────────────────── 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 -``` -
╭────────────────────────── Caption ──────────────────────────╮
-│ Variable                           Default value            │
-│ Undocumented variable              Modified value           │
-│ Undocumented but modified variable (Original default value) │
-╰─────────────────────────────────────────────────────────────╯
-Variables:
-┗━━ 📓 proxy_mode: No proxy
-

-
-### Example 2 - -#### config/02/config.yaml - - -```yml ---- -proxy_mode: Manual proxy configuration - -``` -#### Output - -```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)
-
-#### 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)
-

-
-### Example 3 - -#### config/03/config.yaml - - -```yml ---- -proxy_mode: Manual proxy configuration -manual: - http_proxy: - address: example.net - -``` -#### Output - -```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)
-┗━━ 📂 manual
-    ┗━━ 📂 http_proxy
-        ┣━━ 📓 address: example.net
-        ┗━━ 📓 port: 8080
-
-#### Output in read write mode - -```console -foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/03/config.yaml --exporter.read_write -``` -
╭────────────────────────── 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
-

-
-### Example 4 - -#### config/04/config.yaml - - -```yml ---- -proxy_mode: Manual proxy configuration -manual: - http_proxy: - address: example.net - port: '3128' - -``` -#### Output - -```console -foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/04/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)
-┗━━ 📂 manual
-    ┗━━ 📂 http_proxy
-        ┣━━ 📓 address: example.net
-        ┗━━ 📓 port: 3128 (8080)
-
-#### Output in read write mode - -```console -foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/04/config.yaml --exporter.read_write -``` -
╭────────────────────────── 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)
-

-
-### Example 5 - -#### config/05/config.yaml - - -```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 - -``` -#### Output - -```console -foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/05/config.yaml -``` -
🛑 ERRORS
-┣━━ unknown option "use_for_https" in optiondescription "manual" (Manual proxy configuration)
-┗━━ unknown option "https_proxy" in optiondescription "manual" (Manual proxy configuration)
-╭────────────────────────── 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: http.proxy.net
-        ┗━━ 📓 port: 3128 (8080)
-
-#### Output in read write mode - -```console -foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/05/config.yaml --exporter.read_write -``` -
╭────────────────────────── 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: http.proxy.net
-        ┗━━ 📓 port: 3128 (8080)
-

-
- - -- [[tutorial 029] Type variable is optional](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_029/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_029~1..v1.1_029)) +- [[tutorial 030] A variable with type "boolean"](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)) diff --git a/config/01/config.yaml b/config/01/config.yaml deleted file mode 100644 index ed97d53..0000000 --- a/config/01/config.yaml +++ /dev/null @@ -1 +0,0 @@ ---- diff --git a/config/01/output_ro.html b/config/01/output_ro.html deleted file mode 100644 index cdecbe8..0000000 --- a/config/01/output_ro.html +++ /dev/null @@ -1,9 +0,0 @@ -
╭────────────────────────── 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 deleted file mode 100644 index f74f3a6..0000000 --- a/config/01/output_rw.html +++ /dev/null @@ -1,8 +0,0 @@ -
╭────────────────────────── 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/config.yaml b/config/02/config.yaml deleted file mode 100644 index 74edb22..0000000 --- a/config/02/config.yaml +++ /dev/null @@ -1,2 +0,0 @@ ---- -proxy_mode: Manual proxy configuration diff --git a/config/02/output_ro.html b/config/02/output_ro.html deleted file mode 100644 index 28450ac..0000000 --- a/config/02/output_ro.html +++ /dev/null @@ -1,4 +0,0 @@ -
🛑 ERRORS
-┣━━ The following variables are mandatory but have no value:
-┗━━   - manual.http_proxy.address (HTTP address)
-
diff --git a/config/02/output_rw.html b/config/02/output_rw.html deleted file mode 100644 index 28450ac..0000000 --- a/config/02/output_rw.html +++ /dev/null @@ -1,4 +0,0 @@ -
🛑 ERRORS
-┣━━ The following variables are mandatory but have no value:
-┗━━   - manual.http_proxy.address (HTTP address)
-
diff --git a/config/03/config.yaml b/config/03/config.yaml deleted file mode 100644 index e3db924..0000000 --- a/config/03/config.yaml +++ /dev/null @@ -1,5 +0,0 @@ ---- -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 deleted file mode 100644 index 9a3ff4f..0000000 --- a/config/03/output_ro.html +++ /dev/null @@ -1,12 +0,0 @@ -
╭────────────────────────── 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
-
diff --git a/config/03/output_rw.html b/config/03/output_rw.html deleted file mode 100644 index 9a3ff4f..0000000 --- a/config/03/output_rw.html +++ /dev/null @@ -1,12 +0,0 @@ -
╭────────────────────────── 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
-
diff --git a/config/04/config.yaml b/config/04/config.yaml deleted file mode 100644 index c8d73af..0000000 --- a/config/04/config.yaml +++ /dev/null @@ -1,6 +0,0 @@ ---- -proxy_mode: Manual proxy configuration -manual: - http_proxy: - address: example.net - port: '3128' diff --git a/config/04/output_ro.html b/config/04/output_ro.html deleted file mode 100644 index 56d3640..0000000 --- a/config/04/output_ro.html +++ /dev/null @@ -1,12 +0,0 @@ -
╭────────────────────────── 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)
-
diff --git a/config/04/output_rw.html b/config/04/output_rw.html deleted file mode 100644 index 56d3640..0000000 --- a/config/04/output_rw.html +++ /dev/null @@ -1,12 +0,0 @@ -
╭────────────────────────── 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)
-
diff --git a/config/05/config.yaml b/config/05/config.yaml deleted file mode 100644 index 4a1f789..0000000 --- a/config/05/config.yaml +++ /dev/null @@ -1,9 +0,0 @@ ---- -proxy_mode: Manual proxy configuration -manual: - http_proxy: - address: http.proxy.net - port: '3128' - use_for_https: false - https_proxy: - address: https.proxy.net diff --git a/config/05/output_ro.html b/config/05/output_ro.html deleted file mode 100644 index 984844a..0000000 --- a/config/05/output_ro.html +++ /dev/null @@ -1,15 +0,0 @@ -
🛑 ERRORS
-┣━━ unknown option "use_for_https" in optiondescription "manual" (Manual proxy configuration)
-┗━━ unknown option "https_proxy" in optiondescription "manual" (Manual proxy configuration)
-╭────────────────────────── 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: http.proxy.net
-        ┗━━ 📓 port: 3128 (8080)
-
diff --git a/config/05/output_rw.html b/config/05/output_rw.html deleted file mode 100644 index ec2ef0c..0000000 --- a/config/05/output_rw.html +++ /dev/null @@ -1,12 +0,0 @@ -
╭────────────────────────── 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: http.proxy.net
-        ┗━━ 📓 port: 3128 (8080)
-