diff --git a/README.md b/README.md index 338ebaa8..30014e19 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_020] Group variables inside 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 v1.1_021] Group variables inside 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 v1.1_021)] Group variables inside a sub family +# [tutorial v1.1_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 @@ -45,22 +45,272 @@ version: 1.1 manual: # Manual proxy configuration - http_proxy: - description: HTTP Proxy - type: family + http_proxy: # HTTP Proxy + + address: # HTTP address ... ``` ### Let's generate the documentation ```console -foo@bar:~$ git switch --detach v1.1_021 +foo@bar:~$ git switch --detach v1.1_022 foo@bar:~$ rougail -m firefox/ -o doc -do github ``` | 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 + +**manual** -- [[tutorial v1.1_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)) + +##### HTTP Proxy + +**manual.http_proxy** + + + +| Variable                                                                                        | Description                                                                                     | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **manual.http_proxy.address**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTP address. | + +### Let's generate the changelog + +```console +foo@bar:~$ git switch --detach v1.1_022 +foo@bar:~$ rougail -m firefox/ -o doc --doc.contents changelog -do github +``` +#### New variable + +| Variable                                                                                        | Description                                                                                     | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **manual.http_proxy.address**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTP address. | + + +## User datas + +### Example 1 + +#### config/01/config.yaml + + +```yml +--- + +``` +#### Output + +```console +foo@bar:~$ git switch --detach v1.1_022 +foo@bar:~$ rougail -m firefox/ -u yaml -ff config/01/config.yaml +``` +
🛑 ERRORS
+┗━━ The following variables are mandatory but have no value:
+    ┗━━ Manual proxy configuration
+        ┗━━ HTTP Proxy
+            ┗━━ HTTP address
+
+#### Output in read write mode + +```console +foo@bar:~$ git switch --detach v1.1_022 +foo@bar:~$ rougail -m firefox/ -u yaml -ff config/01/config.yaml --cli.read_write +``` +
🛑 ERRORS
+┗━━ The following variables are mandatory but have no value:
+    ┗━━ Manual proxy configuration
+        ┗━━ HTTP Proxy
+            ┗━━ HTTP address
+
+### Example 2 + +#### config/02/config.yaml + + +```yml +--- +proxy_mode: Manual proxy configuration + +``` +#### Output + +```console +foo@bar:~$ git switch --detach v1.1_022 +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
+
+#### Output in read write mode + +```console +foo@bar:~$ git switch --detach v1.1_022 +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
+
+### Example 3 + +#### config/03/config.yaml + + +```yml +--- +proxy_mode: Manual proxy configuration +manual: + http_proxy: + address: example.net + +``` +#### Output + +```console +foo@bar:~$ git switch --detach v1.1_022 +foo@bar:~$ rougail -m firefox/ -u yaml -ff config/03/config.yaml +``` +
╭────────────── Caption ───────────────╮
+│ Variable Modified value              │
+│          (⏳ Original default value) │
+╰──────────────────────────────────────╯
+Variables:
+┣━━ 📓 Configure Proxy Access to the Internet: Manual proxy configuration ◀ loaded from the YAML file "config/03/config.yaml" (⏳ No proxy)
+┗━━ 📂 Manual proxy configuration
+    ┗━━ 📂 HTTP Proxy
+        ┗━━ 📓 HTTP address: example.net ◀ loaded from the YAML file "config/03/config.yaml"
+
+#### Output in read write mode + +```console +foo@bar:~$ git switch --detach v1.1_022 +foo@bar:~$ rougail -m firefox/ -u yaml -ff config/03/config.yaml --cli.read_write +``` +
╭────────────── Caption ───────────────╮
+│ Variable Modified value              │
+│          (⏳ Original default value) │
+╰──────────────────────────────────────╯
+Variables:
+┣━━ 📓 Configure Proxy Access to the Internet: Manual proxy configuration ◀ loaded from the YAML file "config/03/config.yaml" (⏳ No proxy)
+┗━━ 📂 Manual proxy configuration
+    ┗━━ 📂 HTTP Proxy
+        ┗━━ 📓 HTTP address: example.net ◀ loaded from the YAML file "config/03/config.yaml"
+
+### Example 4 + +#### config/04/config.yaml + + +```yml +--- +proxy_mode: Manual proxy configuration +manual: + http_proxy: + address: example.net + port: '3128' + +``` +#### Output + +```console +foo@bar:~$ git switch --detach v1.1_022 +foo@bar:~$ rougail -m firefox/ -u yaml -ff config/04/config.yaml +``` +
🔔 WARNINGS
+┗━━ variable or family "manual.http_proxy.port" does not exist, it will be ignored when loading from the YAML file "config/04/config.yaml"
+╭────────────── Caption ───────────────╮
+│ Variable Modified value              │
+│          (⏳ Original default value) │
+╰──────────────────────────────────────╯
+Variables:
+┣━━ 📓 Configure Proxy Access to the Internet: Manual proxy configuration ◀ loaded from the YAML file "config/04/config.yaml" (⏳ No proxy)
+┗━━ 📂 Manual proxy configuration
+    ┗━━ 📂 HTTP Proxy
+        ┗━━ 📓 HTTP address: example.net ◀ loaded from the YAML file "config/04/config.yaml"
+
+#### Output in read write mode + +```console +foo@bar:~$ git switch --detach v1.1_022 +foo@bar:~$ rougail -m firefox/ -u yaml -ff config/04/config.yaml --cli.read_write +``` +
🔔 WARNINGS
+┗━━ variable or family "manual.http_proxy.port" does not exist, it will be ignored when loading from the YAML file "config/04/config.yaml"
+╭────────────── Caption ───────────────╮
+│ Variable Modified value              │
+│          (⏳ Original default value) │
+╰──────────────────────────────────────╯
+Variables:
+┣━━ 📓 Configure Proxy Access to the Internet: Manual proxy configuration ◀ loaded from the YAML file "config/04/config.yaml" (⏳ No proxy)
+┗━━ 📂 Manual proxy configuration
+    ┗━━ 📂 HTTP Proxy
+        ┗━━ 📓 HTTP address: example.net ◀ loaded from the YAML file "config/04/config.yaml"
+
+### 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:~$ git switch --detach v1.1_022 +foo@bar:~$ rougail -m firefox/ -u yaml -ff config/05/config.yaml +``` +
🔔 WARNINGS
+┣━━ variable or family "manual.http_proxy.port" does not exist, it will be ignored when loading from the YAML file "config/05/config.yaml"
+┣━━ variable or family "manual.use_for_https" does not exist, it will be ignored when loading from the YAML file "config/05/config.yaml"
+┗━━ variable or family "manual.https_proxy" does not exist, it will be ignored when loading from the YAML file "config/05/config.yaml"
+╭────────────── Caption ───────────────╮
+│ Variable 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"
+
+#### Output in read write mode + +```console +foo@bar:~$ git switch --detach v1.1_022 +foo@bar:~$ rougail -m firefox/ -u yaml -ff config/05/config.yaml --cli.read_write +``` +
🔔 WARNINGS
+┣━━ variable or family "manual.http_proxy.port" does not exist, it will be ignored when loading from the YAML file "config/05/config.yaml"
+┣━━ variable or family "manual.use_for_https" does not exist, it will be ignored when loading from the YAML file "config/05/config.yaml"
+┗━━ variable or family "manual.https_proxy" does not exist, it will be ignored when loading from the YAML file "config/05/config.yaml"
+╭────────────── Caption ───────────────╮
+│ Variable 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"
+
+ + +- [[tutorial v1.1_023] A variable with type "domainname"](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 00000000..ed97d539 --- /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 00000000..ec666c15 --- /dev/null +++ b/config/01/output_ro.html @@ -0,0 +1,6 @@ +
🛑 ERRORS
+┗━━ The following variables are mandatory but have no value:
+    ┗━━ Manual proxy configuration
+        ┗━━ HTTP Proxy
+            ┗━━ HTTP address
+
diff --git a/config/01/output_rw.html b/config/01/output_rw.html new file mode 100644 index 00000000..ec666c15 --- /dev/null +++ b/config/01/output_rw.html @@ -0,0 +1,6 @@ +
🛑 ERRORS
+┗━━ The following variables are mandatory but have no value:
+    ┗━━ Manual proxy configuration
+        ┗━━ HTTP Proxy
+            ┗━━ HTTP address
+
diff --git a/config/02/config.yaml b/config/02/config.yaml new file mode 100644 index 00000000..74edb225 --- /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 00000000..ec666c15 --- /dev/null +++ b/config/02/output_ro.html @@ -0,0 +1,6 @@ +
🛑 ERRORS
+┗━━ The following variables are mandatory but have no value:
+    ┗━━ Manual proxy configuration
+        ┗━━ HTTP Proxy
+            ┗━━ HTTP address
+
diff --git a/config/02/output_rw.html b/config/02/output_rw.html new file mode 100644 index 00000000..ec666c15 --- /dev/null +++ b/config/02/output_rw.html @@ -0,0 +1,6 @@ +
🛑 ERRORS
+┗━━ The following variables are mandatory but have no value:
+    ┗━━ Manual proxy configuration
+        ┗━━ HTTP Proxy
+            ┗━━ HTTP address
+
diff --git a/config/03/config.yaml b/config/03/config.yaml new file mode 100644 index 00000000..e3db924b --- /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 00000000..a61c7bcd --- /dev/null +++ b/config/03/output_ro.html @@ -0,0 +1,10 @@ +
╭────────────── Caption ───────────────╮
+│ Variable Modified value              │
+│          (⏳ Original default value) │
+╰──────────────────────────────────────╯
+Variables:
+┣━━ 📓 Configure Proxy Access to the Internet: Manual proxy configuration ◀ loaded from the YAML file "config/03/config.yaml" (⏳ No proxy)
+┗━━ 📂 Manual proxy configuration
+    ┗━━ 📂 HTTP Proxy
+        ┗━━ 📓 HTTP address: example.net ◀ loaded from the YAML file "config/03/config.yaml"
+
diff --git a/config/03/output_rw.html b/config/03/output_rw.html new file mode 100644 index 00000000..a61c7bcd --- /dev/null +++ b/config/03/output_rw.html @@ -0,0 +1,10 @@ +
╭────────────── Caption ───────────────╮
+│ Variable Modified value              │
+│          (⏳ Original default value) │
+╰──────────────────────────────────────╯
+Variables:
+┣━━ 📓 Configure Proxy Access to the Internet: Manual proxy configuration ◀ loaded from the YAML file "config/03/config.yaml" (⏳ No proxy)
+┗━━ 📂 Manual proxy configuration
+    ┗━━ 📂 HTTP Proxy
+        ┗━━ 📓 HTTP address: example.net ◀ loaded from the YAML file "config/03/config.yaml"
+
diff --git a/config/04/config.yaml b/config/04/config.yaml new file mode 100644 index 00000000..c8d73af3 --- /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 00000000..c5cb9c06 --- /dev/null +++ b/config/04/output_ro.html @@ -0,0 +1,12 @@ +
🔔 WARNINGS
+┗━━ variable or family "manual.http_proxy.port" does not exist, it will be ignored when loading from the YAML file "config/04/config.yaml"
+╭────────────── Caption ───────────────╮
+│ Variable Modified value              │
+│          (⏳ Original default value) │
+╰──────────────────────────────────────╯
+Variables:
+┣━━ 📓 Configure Proxy Access to the Internet: Manual proxy configuration ◀ loaded from the YAML file "config/04/config.yaml" (⏳ No proxy)
+┗━━ 📂 Manual proxy configuration
+    ┗━━ 📂 HTTP Proxy
+        ┗━━ 📓 HTTP address: example.net ◀ loaded from the YAML file "config/04/config.yaml"
+
diff --git a/config/04/output_rw.html b/config/04/output_rw.html new file mode 100644 index 00000000..c5cb9c06 --- /dev/null +++ b/config/04/output_rw.html @@ -0,0 +1,12 @@ +
🔔 WARNINGS
+┗━━ variable or family "manual.http_proxy.port" does not exist, it will be ignored when loading from the YAML file "config/04/config.yaml"
+╭────────────── Caption ───────────────╮
+│ Variable Modified value              │
+│          (⏳ Original default value) │
+╰──────────────────────────────────────╯
+Variables:
+┣━━ 📓 Configure Proxy Access to the Internet: Manual proxy configuration ◀ loaded from the YAML file "config/04/config.yaml" (⏳ No proxy)
+┗━━ 📂 Manual proxy configuration
+    ┗━━ 📂 HTTP Proxy
+        ┗━━ 📓 HTTP address: example.net ◀ loaded from the YAML file "config/04/config.yaml"
+
diff --git a/config/05/config.yaml b/config/05/config.yaml new file mode 100644 index 00000000..4a1f7890 --- /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 00000000..5c570c92 --- /dev/null +++ b/config/05/output_ro.html @@ -0,0 +1,14 @@ +
🔔 WARNINGS
+┣━━ variable or family "manual.http_proxy.port" does not exist, it will be ignored when loading from the YAML file "config/05/config.yaml"
+┣━━ variable or family "manual.use_for_https" does not exist, it will be ignored when loading from the YAML file "config/05/config.yaml"
+┗━━ variable or family "manual.https_proxy" does not exist, it will be ignored when loading from the YAML file "config/05/config.yaml"
+╭────────────── Caption ───────────────╮
+│ Variable 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"
+
diff --git a/config/05/output_rw.html b/config/05/output_rw.html new file mode 100644 index 00000000..5c570c92 --- /dev/null +++ b/config/05/output_rw.html @@ -0,0 +1,14 @@ +
🔔 WARNINGS
+┣━━ variable or family "manual.http_proxy.port" does not exist, it will be ignored when loading from the YAML file "config/05/config.yaml"
+┣━━ variable or family "manual.use_for_https" does not exist, it will be ignored when loading from the YAML file "config/05/config.yaml"
+┗━━ variable or family "manual.https_proxy" does not exist, it will be ignored when loading from the YAML file "config/05/config.yaml"
+╭────────────── Caption ───────────────╮
+│ Variable 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"
+