From d5d61d0e76bdc36b786614aeb79a74b21a6bd08f Mon Sep 17 00:00:00 2001 From: Emmanuel Garette Date: Wed, 23 Oct 2024 20:01:19 +0200 Subject: [PATCH] [tutorial 022] A variable inside sub family (config and doc) --- README.md | 233 +++++++++++++++++++++++++++++++++++++-- config/01/config.yaml | 1 + config/01/output_ro.html | 4 + config/01/output_rw.html | 4 + config/02/config.yaml | 2 + config/02/output_ro.html | 4 + config/02/output_rw.html | 4 + config/03/config.yaml | 5 + config/03/output_ro.html | 11 ++ config/03/output_rw.html | 11 ++ config/04/config.yaml | 6 + config/04/output_ro.html | 13 +++ config/04/output_rw.html | 11 ++ config/05/config.yaml | 9 ++ config/05/output_ro.html | 15 +++ config/05/output_rw.html | 11 ++ 16 files changed, 337 insertions(+), 7 deletions(-) create mode 100644 config/01/config.yaml create mode 100644 config/01/output_ro.html create mode 100644 config/01/output_rw.html create mode 100644 config/02/config.yaml create mode 100644 config/02/output_ro.html create mode 100644 config/02/output_rw.html create mode 100644 config/03/config.yaml create mode 100644 config/03/output_ro.html create mode 100644 config/03/output_rw.html create mode 100644 config/04/config.yaml create mode 100644 config/04/output_ro.html create mode 100644 config/04/output_rw.html create mode 100644 config/05/config.yaml create mode 100644 config/05/output_ro.html create mode 100644 config/05/output_rw.html diff --git a/README.md b/README.md index ea0f097..e2f0108 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 020] A family](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_020/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_020~1..v1.1_020)) +- [[tutorial 021] A sub family](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_021/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_021~1..v1.1_021)) -# [tutorial 021] A sub family +# [tutorial 022] A variable inside sub family -[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_021~1..v1.1_021) +[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_022~1..v1.1_022) ## Screenshot @@ -44,6 +44,9 @@ manual: description: HTTP Proxy type: family + address: + description: HTTP address + ``` ### Generated documentation @@ -52,11 +55,227 @@ 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 | +| 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**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTP address. | +## User data + +### Example 1 + +#### config/01/config.yaml -- [[tutorial 022] A variable inside sub family](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_022/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_022~1..v1.1_022)) +```yml +--- + +``` +#### Output + +```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)
+
+#### 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)
+

+
+### 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
+
+#### 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
+

+
+### 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 +``` +
🛑 ERRORS
+┗━━ unknown option "port" in optiondescription "manual.http_proxy" (HTTP Proxy)
+╭────────────────────────── 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
+
+#### 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
+

+
+### 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 "port" in optiondescription "manual.http_proxy" (HTTP Proxy)
+┣━━ 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
+
+#### 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
+

+
+ + +- [[tutorial 023] Family type is optional](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_023/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_023~1..v1.1_023)) diff --git a/config/01/config.yaml b/config/01/config.yaml new file mode 100644 index 0000000..ed97d53 --- /dev/null +++ b/config/01/config.yaml @@ -0,0 +1 @@ +--- diff --git a/config/01/output_ro.html b/config/01/output_ro.html new file mode 100644 index 0000000..28450ac --- /dev/null +++ b/config/01/output_ro.html @@ -0,0 +1,4 @@ +
🛑 ERRORS
+┣━━ The following variables are mandatory but have no value:
+┗━━   - manual.http_proxy.address (HTTP address)
+
diff --git a/config/01/output_rw.html b/config/01/output_rw.html new file mode 100644 index 0000000..28450ac --- /dev/null +++ b/config/01/output_rw.html @@ -0,0 +1,4 @@ +
🛑 ERRORS
+┣━━ The following variables are mandatory but have no value:
+┗━━   - manual.http_proxy.address (HTTP address)
+
diff --git a/config/02/config.yaml b/config/02/config.yaml new file mode 100644 index 0000000..74edb22 --- /dev/null +++ b/config/02/config.yaml @@ -0,0 +1,2 @@ +--- +proxy_mode: Manual proxy configuration diff --git a/config/02/output_ro.html b/config/02/output_ro.html new file mode 100644 index 0000000..28450ac --- /dev/null +++ b/config/02/output_ro.html @@ -0,0 +1,4 @@ +
🛑 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 new file mode 100644 index 0000000..28450ac --- /dev/null +++ b/config/02/output_rw.html @@ -0,0 +1,4 @@ +
🛑 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 new file mode 100644 index 0000000..e3db924 --- /dev/null +++ b/config/03/config.yaml @@ -0,0 +1,5 @@ +--- +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 new file mode 100644 index 0000000..9ea732e --- /dev/null +++ b/config/03/output_ro.html @@ -0,0 +1,11 @@ +
╭────────────────────────── 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
+
diff --git a/config/03/output_rw.html b/config/03/output_rw.html new file mode 100644 index 0000000..9ea732e --- /dev/null +++ b/config/03/output_rw.html @@ -0,0 +1,11 @@ +
╭────────────────────────── 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
+
diff --git a/config/04/config.yaml b/config/04/config.yaml new file mode 100644 index 0000000..c8d73af --- /dev/null +++ b/config/04/config.yaml @@ -0,0 +1,6 @@ +--- +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 new file mode 100644 index 0000000..b07fec9 --- /dev/null +++ b/config/04/output_ro.html @@ -0,0 +1,13 @@ +
🛑 ERRORS
+┗━━ unknown option "port" in optiondescription "manual.http_proxy" (HTTP Proxy)
+╭────────────────────────── 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
+
diff --git a/config/04/output_rw.html b/config/04/output_rw.html new file mode 100644 index 0000000..9ea732e --- /dev/null +++ b/config/04/output_rw.html @@ -0,0 +1,11 @@ +
╭────────────────────────── 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
+
diff --git a/config/05/config.yaml b/config/05/config.yaml new file mode 100644 index 0000000..4a1f789 --- /dev/null +++ b/config/05/config.yaml @@ -0,0 +1,9 @@ +--- +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 new file mode 100644 index 0000000..4f8e0ee --- /dev/null +++ b/config/05/output_ro.html @@ -0,0 +1,15 @@ +
🛑 ERRORS
+┣━━ unknown option "port" in optiondescription "manual.http_proxy" (HTTP Proxy)
+┣━━ 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
+
diff --git a/config/05/output_rw.html b/config/05/output_rw.html new file mode 100644 index 0000000..f810fdc --- /dev/null +++ b/config/05/output_rw.html @@ -0,0 +1,11 @@ +
╭────────────────────────── 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
+