diff --git a/README.md b/README.md index 402e964e..ad7fe34d 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@ - [Summary](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/branch/1.1/README.md) -- [[tutorial v1.1_071] Jinja with a description](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_071/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_071~1..v1.1_071)) +- [[tutorial v1.1_072] Jinja with a parameter](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_072/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_072~1..v1.1_072)) -# [tutorial v1.1_072] Jinja with a parameter +# [tutorial v1.1_080] A conditional disabled variable with type web_address -[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_072~1..v1.1_072) +[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_080~1..v1.1_080) -[Read the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#jinja-with-a-parameter) +[Read the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#a-conditional-disabled-variable-with-type-web_address) ## Screenshot @@ -31,7 +31,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_072 +git switch --detach v1.1_080 ``` ## Structure @@ -39,58 +39,27 @@ git switch --detach v1.1_072

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


-Contents of the firefox/20-manual.yml file +Contents of the firefox/30-auto.yml file ```yml %YAML 1.2 --- version: 1.1 -manual: - - use_for_https: true # Also use this proxy for HTTPS - - '{{ identifier }}_proxy': - description: '{{ identifier }} Proxy' - hidden: - jinja: |- - {% if my_identifier == 'HTTPS' and _.use_for_https %} - HTTPS is same has HTTP - {% endif %} - description: in HTTPS case if "_.use_for_https" is set to "true" - params: - my_identifier: - type: identifier - dynamic: - - HTTPS - - SOCKS - - address: - description: '{{ identifier }} address' - default: - variable: __.http_proxy.address - - port: - description: '{{ identifier }} port' - default: - variable: __.http_proxy.port - - version: - description: SOCKS host version used by proxy - choices: - - v4 - - v5 - default: v5 - disabled: - type: identifier - when: HTTPS +auto: + description: Automatic proxy configuration URL + type: web_address + disabled: + variable: _.proxy_mode + when_not: Automatic proxy configuration URL ... ``` @@ -146,6 +115,22 @@ rougail -m firefox/ -o doc | **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 "[HTTP Port](#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.
**Validators**:
• well-known ports (1 to 1023) are allowed
• registred ports (1024 to 49151) are allowed
• type domainname
• the domain name can be a hostname
**Disabled**: when the variable "[Configure Proxy Access to the Internet](#proxy_mode)" hasn't the value "Automatic proxy configuration URL" | + +### Let's generate the changelog + +```shell +rougail -m firefox/ -o doc --doc.contents changelog +``` +#### New variable + +| Variable | Description | +|------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **auto**
[`web address`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` *`disabled`* | Automatic proxy configuration URL.
**Validators**:
• well-known ports (1 to 1023) are allowed
• registred ports (1024 to 49151) are allowed
• type domainname
• the domain name can be a hostname
**Disabled**: when the variable "[Configure Proxy Access to the Internet](#proxy_mode)" hasn't the value "Automatic proxy configuration URL" | + + ## User datas ### Example 1 @@ -155,45 +140,65 @@ rougail -m firefox/ -o doc ```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 +auto: https://auto.proxy.net/wpad.dat ``` #### Output ```shell rougail -m firefox/ -u yaml -yf config/01/config.yml ``` +
🔔 WARNINGS
+┗━━ variable "auto" (Automatic proxy configuration URL) is disabled, it will be 
+    ignored when loading from the YAML file "config/01/config.yml"
+╭──────────────────── Caption ─────────────────────╮
+│ Undocumented but modified variable Default value │
+╰──────────────────────────────────────────────────╯
+Variables:
+┗━━ 📓 Configure Proxy Access to the Internet: No proxy
+
+### 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                           Default value               │
 │ Undocumented but modified variable Modified value              │
 │                                    (⏳ Original default value) │
 ╰────────────────────────────────────────────────────────────────╯
 Variables:
-┣━━ 📓 Configure Proxy Access to the Internet: Manual proxy configuration ◀ 
-┃   loaded from the YAML file "config/01/config.yml" (⏳ No proxy)
-┗━━ 📂 Manual proxy configuration
-    ┣━━ 📂 HTTP Proxy
-    ┃   ┣━━ 📓 HTTP address: http.proxy.net ◀ loaded from the YAML file 
-    ┃   ┃   "config/01/config.yml"
-    ┃   ┗━━ 📓 HTTP Port: 3128 ◀ loaded from the YAML file 
-    ┃       "config/01/config.yml" (⏳ 8080)
-    ┣━━ 📓 Also use this proxy for HTTPS: false ◀ loaded from the YAML file 
-    ┃   "config/01/config.yml" (⏳ true)
-    ┣━━ 📂 HTTPS Proxy
-    ┃   ┣━━ 📓 HTTPS address: https.proxy.net ◀ loaded from the YAML file 
-    ┃   ┃   "config/01/config.yml" (⏳ http.proxy.net)
-    ┃   ┗━━ 📓 HTTPS port: 3128
-    ┗━━ 📂 SOCKS Proxy
-        ┣━━ 📓 SOCKS address: http.proxy.net
-        ┣━━ 📓 SOCKS port: 3128
-        ┗━━ 📓 SOCKS host version used by proxy: v5
+┣━━ 📓 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_080] A conditional disabled variable with type web_address](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_080/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_080~1..v1.1_080)) +- [[tutorial v1.1_090] A conditional disabled variable with type domainname and parameters](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_090/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_090~1..v1.1_090)) diff --git a/config/01/config.yml b/config/01/config.yml index 84547faa..1edbe913 100644 --- a/config/01/config.yml +++ b/config/01/config.yml @@ -1,9 +1,2 @@ --- -proxy_mode: Manual proxy configuration -manual: - http_proxy: - address: http.proxy.net - port: 3128 - use_for_https: false - https_proxy: - address: https.proxy.net +auto: https://auto.proxy.net/wpad.dat diff --git a/config/01/output_ro.html b/config/01/output_ro.html index ef0f3545..f79845c8 100644 --- a/config/01/output_ro.html +++ b/config/01/output_ro.html @@ -1,25 +1,9 @@ -
╭─────────────────────────── Caption ────────────────────────────╮
-│ Variable                           Default value               │
-│ Undocumented but modified variable Modified value              │
-│                                    (⏳ Original default value) │
-╰────────────────────────────────────────────────────────────────╯
+
🔔 WARNINGS
+┗━━ variable "auto" (Automatic proxy configuration URL) is disabled, it will be 
+    ignored when loading from the YAML file "config/01/config.yml"
+╭──────────────────── Caption ─────────────────────╮
+│ Undocumented but modified variable Default value │
+╰──────────────────────────────────────────────────╯
 Variables:
-┣━━ 📓 Configure Proxy Access to the Internet: Manual proxy configuration ◀ 
-┃   loaded from the YAML file "config/01/config.yml" (⏳ No proxy)
-┗━━ 📂 Manual proxy configuration
-    ┣━━ 📂 HTTP Proxy
-    ┃   ┣━━ 📓 HTTP address: http.proxy.net ◀ loaded from the YAML file 
-    ┃   ┃   "config/01/config.yml"
-    ┃   ┗━━ 📓 HTTP Port: 3128 ◀ loaded from the YAML file 
-    ┃       "config/01/config.yml" (⏳ 8080)
-    ┣━━ 📓 Also use this proxy for HTTPS: false ◀ loaded from the YAML file 
-    ┃   "config/01/config.yml" (⏳ true)
-    ┣━━ 📂 HTTPS Proxy
-    ┃   ┣━━ 📓 HTTPS address: https.proxy.net ◀ loaded from the YAML file 
-    ┃   ┃   "config/01/config.yml" (⏳ http.proxy.net)
-    ┃   ┗━━ 📓 HTTPS port: 3128
-    ┗━━ 📂 SOCKS Proxy
-        ┣━━ 📓 SOCKS address: http.proxy.net
-        ┣━━ 📓 SOCKS port: 3128
-        ┗━━ 📓 SOCKS host version used by proxy: v5
+┗━━ 📓 Configure Proxy Access to the Internet: No proxy
 

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..fa75a416
--- /dev/null
+++ b/config/03/output_ro.html
@@ -0,0 +1,10 @@
+
╭─────────────────────────── Caption ────────────────────────────╮
+│ Undocumented but modified 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/tree.html b/tree.html
index b0f7d164..854733ac 100644
--- a/tree.html
+++ b/tree.html
@@ -25,14 +25,15 @@
 
 
 	
Directory Tree

-	.

-	└── firefox

-	    ├── 00-proxy.yml

-	    ├── 10-manual.yml

-	    └── 20-manual.yml

+	.

+	└── firefox

+	    ├── 00-proxy.yml

+	    ├── 10-manual.yml

+	    ├── 20-manual.yml

+	    └── 30-auto.yml

 


 
-2 directories, 3 files
+2 directories, 4 files