diff --git a/README.md b/README.md index 5fdfddf7..6b5495cb 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_043] Jinja with a description](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_043/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_043~1..v1.1_043)) +- [[tutorial v1.1_044] A conditional disabled variable with identifier](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_044/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_044~1..v1.1_044)) -# [tutorial v1.1_044)] A conditional disabled variable with identifier +# [tutorial v1.1_050)] A variable with type "web_address" -[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_044~1..v1.1_044) +[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_050~1..v1.1_050) ## Screenshot @@ -112,11 +112,25 @@ manual: when: HTTPS ... +``` +### firefox/30-auto.yml + + +```yml +%YAML 1.2 +--- +version: 1.1 + +auto: + description: Automatic proxy configuration URL + type: web_address +... + ``` ### Let's generate the documentation ```console -foo@bar:~$ git switch --detach v1.1_044 +foo@bar:~$ git switch --detach v1.1_050 foo@bar:~$ rougail -m firefox/ -o doc -do github ``` | Variable                                                                                        | Description                                                                                     | @@ -164,19 +178,94 @@ This family builds families dynamically | **manual.*https*_proxy.port**
**manual.*socks*_proxy.port**
[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | *HTTPS* or *SOCKS* port.
**Validators**:
- well-known ports (1 to 1023) are allowed
- registred ports (1024 to 49151) are allowed
- private ports (greater than 49152) are allowed
**Default**: the value of the variable "manual.http_proxy.port" | | **manual.*https*_proxy.version**
**manual.*socks*_proxy.version**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` *`disabled`* | SOCKS host version used by proxy.
**Choices**:
- v4
- v5 **← (default)**
**Disabled**: when the identifier is "HTTPS" | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **auto**
[`web_address`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Automatic proxy configuration URL.
**Validator**: the domain name in web address can be only a hostname | + ### Let's generate the changelog ```console -foo@bar:~$ git switch --detach v1.1_044 +foo@bar:~$ git switch --detach v1.1_050 foo@bar:~$ rougail -m firefox/ -o doc --doc.contents changelog -do github ``` #### New variable -| Variable                                                                                                     | Description                                                                                                  | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **manual.*https*_proxy.version**
**manual.*socks*_proxy.version**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` *`disabled`* | SOCKS host version used by proxy.
**Choices**:
- v4
- v5 **← (default)**
**Disabled**: when the identifier is "HTTPS" | +| Variable                                                                                             | Description                                                                                          | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **auto**
[`web_address`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Automatic proxy configuration URL.
**Validator**: the domain name in web address can be only a hostname | +## User datas + +### Example 1 + +#### config/01/config.yaml -- [[tutorial v1.1_050] A variable with type "web_address"](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_050/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_050~1..v1.1_050)) +```yml +--- +auto: https://auto.proxy.net/wpad.dat + +``` +#### Output + +```console +foo@bar:~$ git switch --detach v1.1_050 +foo@bar:~$ rougail -m firefox/ -u yaml -ff config/01/config.yaml +``` +
╭──────── Caption ────────╮
+│ Variable Default value  │
+│          Modified value │
+╰─────────────────────────╯
+Variables:
+┣━━ 📓 Configure Proxy Access to the Internet: No proxy
+┗━━ 📓 Automatic proxy configuration URL: https://auto.proxy.net/wpad.dat ◀ loaded from the YAML file "config/01/config.yaml"
+
+### Example 2 + +#### config/02/config.yaml + + +```yml +--- +proxy_mode: Automatic proxy configuration URL + +``` +#### Output + +```console +foo@bar:~$ git switch --detach v1.1_050 +foo@bar:~$ rougail -m firefox/ -u yaml -ff config/02/config.yaml +``` +
🛑 ERRORS
+┗━━ The following variables are mandatory but have no value:
+    ┗━━ Automatic proxy configuration URL
+
+### Example 3 + +#### config/03/config.yaml + + +```yml +--- +proxy_mode: Automatic proxy configuration URL +auto: https://auto.proxy.net/wpad.dat + +``` +#### Output + +```console +foo@bar:~$ git switch --detach v1.1_050 +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: Automatic proxy configuration URL ◀ loaded from the YAML file "config/03/config.yaml" (⏳ No proxy)
+┗━━ 📓 Automatic proxy configuration URL: https://auto.proxy.net/wpad.dat ◀ loaded from the YAML file "config/03/config.yaml"
+
+ + +- [[tutorial v1.1_051] A conditional disabled variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_051/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_051~1..v1.1_051)) diff --git a/config/01/config.yaml b/config/01/config.yaml new file mode 100644 index 00000000..1edbe913 --- /dev/null +++ b/config/01/config.yaml @@ -0,0 +1,2 @@ +--- +auto: https://auto.proxy.net/wpad.dat diff --git a/config/01/output_ro.html b/config/01/output_ro.html new file mode 100644 index 00000000..30f4da7b --- /dev/null +++ b/config/01/output_ro.html @@ -0,0 +1,8 @@ +
╭──────── Caption ────────╮
+│ Variable Default value  │
+│          Modified value │
+╰─────────────────────────╯
+Variables:
+┣━━ 📓 Configure Proxy Access to the Internet: No proxy
+┗━━ 📓 Automatic proxy configuration URL: https://auto.proxy.net/wpad.dat ◀ loaded from the YAML file "config/01/config.yaml"
+
diff --git a/config/02/config.yaml b/config/02/config.yaml new file mode 100644 index 00000000..26df1306 --- /dev/null +++ b/config/02/config.yaml @@ -0,0 +1,2 @@ +--- +proxy_mode: Automatic proxy configuration URL diff --git a/config/02/output_ro.html b/config/02/output_ro.html new file mode 100644 index 00000000..e1ebfb1d --- /dev/null +++ b/config/02/output_ro.html @@ -0,0 +1,4 @@ +
🛑 ERRORS
+┗━━ The following variables are mandatory but have no value:
+    ┗━━ Automatic proxy configuration URL
+
diff --git a/config/03/config.yaml b/config/03/config.yaml new file mode 100644 index 00000000..307e175b --- /dev/null +++ b/config/03/config.yaml @@ -0,0 +1,3 @@ +--- +proxy_mode: Automatic proxy configuration URL +auto: https://auto.proxy.net/wpad.dat diff --git a/config/03/output_ro.html b/config/03/output_ro.html new file mode 100644 index 00000000..d8cd7f41 --- /dev/null +++ b/config/03/output_ro.html @@ -0,0 +1,8 @@ +
╭────────────── Caption ───────────────╮
+│ Variable Modified value              │
+│          (⏳ Original default value) │
+╰──────────────────────────────────────╯
+Variables:
+┣━━ 📓 Configure Proxy Access to the Internet: Automatic proxy configuration URL ◀ loaded from the YAML file "config/03/config.yaml" (⏳ No proxy)
+┗━━ 📓 Automatic proxy configuration URL: https://auto.proxy.net/wpad.dat ◀ loaded from the YAML file "config/03/config.yaml"
+
diff --git a/firefox.png b/firefox.png index b7ca7aa0..20701e22 100644 Binary files a/firefox.png and b/firefox.png differ