diff --git a/README.md b/README.md index d321297c..9a5d3cc4 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_061] A conditional disabled variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_061/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_061~1..v1.1_061)) +- [[tutorial v1.1_062] Jinja with a description](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_062/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_062~1..v1.1_062)) -# [tutorial v1.1_062)] Jinja with a description +# [tutorial v1.1_065)] A variable with type "web_address" -[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_062~1..v1.1_062) +[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_065~1..v1.1_065) ## Screenshot @@ -29,7 +29,7 @@ pip install rougail-cli rougail-output-exporter rougail-output-doc rougail-user- Then switch to the tutorial page: ```shell -git switch --detach v1.1_062 +git switch --detach v1.1_065 ``` ## Structure @@ -37,12 +37,12 @@ git switch --detach v1.1_062

-.
- └── firefox
-     ├── 00-proxy.yml
-     ├── 10-manual.yml
-     ├── 20-manual.yml
-     └── 30-auto.yml
+.
+ └── firefox
+     ├── 00-proxy.yml
+     ├── 10-manual.yml
+     ├── 20-manual.yml
+     └── 30-auto.yml


Contents of the firefox/30-auto.yml file @@ -55,9 +55,6 @@ version: 1.1 auto: description: Automatic proxy configuration URL type: web_address - disabled: - variable: _.proxy_mode - when_not: Automatic proxy configuration URL ... ``` @@ -111,10 +108,87 @@ 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` *`disabled`* | Automatic proxy configuration URL.
**Validator**: the domain name in web address can be only a hostname
**Disabled**: when the variable "proxy_mode" hasn't the value "Automatic proxy configuration URL" | +| 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 + +```shell +rougail -m firefox/ -o doc --doc.contents changelog +``` +#### Modified variable + +| Variable                                                                                                                                                                                                 | Description                                                                                                                                                                                              | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **auto**
~~`disabled`~~ [`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
**Disabled**: ~~{'message': 'when the variable "{0}" hasn\'t the value "Automatic proxy configuration URL"', 'path': {'path': 'proxy_mode'}, 'description': 'Configure Proxy Access to the Internet'}~~ | +## User datas -- [[tutorial v1.1_065] A variable with type "web_address"](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_065/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_065~1..v1.1_065)) +### Example 1 + +#### config/01/config.yml + + +```yml +--- +auto: https://auto.proxy.net/wpad.dat +``` +#### Output + +```shell +rougail -m firefox/ -u yaml -yf config/01/config.yml +``` +
╭──────── 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.yml"
+
+### Example 2 + +#### config/02/config.yml + + +```yml +--- +proxy_mode: Automatic proxy configuration URL +``` +#### Output + +```shell +rougail -m firefox/ -u yaml -yf config/02/config.yml +``` +
🛑 ERRORS
+┗━━ The following variables are mandatory but have no value:
+    ┗━━ Automatic proxy configuration URL
+
+### Example 3 + +#### config/03/config.yml + + +```yml +--- +proxy_mode: Automatic proxy configuration URL +auto: https://auto.proxy.net/wpad.dat +``` +#### Output + +```shell +rougail -m firefox/ -u yaml -yf config/03/config.yml +``` +
╭────────────── 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.yml" (⏳ No proxy)
+┗━━ 📓 Automatic proxy configuration URL: https://auto.proxy.net/wpad.dat ◀ loaded from the YAML file "config/03/config.yml"
+
+ + +- [[tutorial v1.1_070] A variable with type "domainname", parameters type and disabled](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_070/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_070~1..v1.1_070)) diff --git a/config/01/cmd_ro.txt b/config/01/cmd_ro.txt new file mode 100644 index 00000000..d46f9445 --- /dev/null +++ b/config/01/cmd_ro.txt @@ -0,0 +1 @@ +rougail -m firefox/ -u yaml -yf config/01/config.yml \ No newline at end of file diff --git a/config/01/config.yml b/config/01/config.yml new file mode 100644 index 00000000..1edbe913 --- /dev/null +++ b/config/01/config.yml @@ -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..9bf6616e --- /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.yml"
+
diff --git a/config/02/cmd_ro.txt b/config/02/cmd_ro.txt new file mode 100644 index 00000000..772ebbef --- /dev/null +++ b/config/02/cmd_ro.txt @@ -0,0 +1 @@ +rougail -m firefox/ -u yaml -yf config/02/config.yml \ No newline at end of file diff --git a/config/02/config.yml b/config/02/config.yml new file mode 100644 index 00000000..26df1306 --- /dev/null +++ b/config/02/config.yml @@ -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/cmd_ro.txt b/config/03/cmd_ro.txt new file mode 100644 index 00000000..fc8085eb --- /dev/null +++ b/config/03/cmd_ro.txt @@ -0,0 +1 @@ +rougail -m firefox/ -u yaml -yf config/03/config.yml \ No newline at end of file diff --git a/config/03/config.yml b/config/03/config.yml new file mode 100644 index 00000000..307e175b --- /dev/null +++ b/config/03/config.yml @@ -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..ef0a4acd --- /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.yml" (⏳ No proxy)
+┗━━ 📓 Automatic proxy configuration URL: https://auto.proxy.net/wpad.dat ◀ loaded from the YAML file "config/03/config.yml"
+
diff --git a/firefox.png b/firefox.png index b7ca7aa0..20701e22 100644 Binary files a/firefox.png and b/firefox.png differ diff --git a/tree.html b/tree.html index 1d5fd557..570e0f0a 100644 --- a/tree.html +++ b/tree.html @@ -25,12 +25,12 @@

Directory Tree

- .
- └── firefox
-     ├── 00-proxy.yml
-     ├── 10-manual.yml
-     ├── 20-manual.yml
-     └── 30-auto.yml
+ .
+ └── firefox
+     ├── 00-proxy.yml
+     ├── 10-manual.yml
+     ├── 20-manual.yml
+     └── 30-auto.yml


2 directories, 4 files