diff --git a/README.md b/README.md
index 36710a4c..aa3d0848 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_095] A conditional disabled boolean variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_095/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_095~1..v1.1_095))
+- [[tutorial v1.1_096] A boolean variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_096/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_096~1..v1.1_096))
-# [tutorial v1.1_096)] A boolean variable
+# [tutorial v1.1_097)] A Jinja conditional disabled boolean variable
-[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_096~1..v1.1_096)
+[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_097~1..v1.1_097)
-[Read the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#a-boolean-variable)
+[Read the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#a-jinja-conditional-disabled-boolean-variable)
## 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_096
+git switch --detach v1.1_097
```
## Structure
@@ -39,15 +39,15 @@ git switch --detach v1.1_096
-.
- └── firefox
- ├── 00-proxy.yml
- ├── 10-manual.yml
- ├── 20-manual.yml
- ├── 30-auto.yml
- ├── 40-no_proxy.yml
- ├── 50-prompt_authentication.yml
- └── 55-proxy_dns_socks5.yml
+.
+ └── firefox
+ ├── 00-proxy.yml
+ ├── 10-manual.yml
+ ├── 20-manual.yml
+ ├── 30-auto.yml
+ ├── 40-no_proxy.yml
+ ├── 50-prompt_authentication.yml
+ └── 55-proxy_dns_socks5.yml
Contents of the firefox/55-proxy_dns_socks5.yml file
@@ -57,7 +57,19 @@ Contents of the firefox/55-proxy_dns_socks5.yml file
---
version: 1.1
-proxy_dns_socks5: false # Use proxy DNS when using SOCKS v5
+proxy_dns_socks5:
+ description: Use proxy DNS when using SOCKS v5
+ default: false
+ disabled:
+ jinja: |-
+ {% if _.manual.socks_proxy.version is propertyerror %}
+ the proxy mode is not manual
+ {% elif _.manual.socks_proxy.version == 'v4' %}
+ socks version is v4
+ {% endif %}
+ description: |-
+ if "firefox.proxy_mode" is not "Manual proxy configuration"
+ or "firefox.manual.socks_proxy.version" is "v4"
...
```
@@ -111,23 +123,25 @@ 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" |
-| **no_proxy**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) *`disabled`* `unique` `multiple` | Address for which proxy will be desactivated.
Connections to localhost, 127.0.0.1/8 and ::1 are never proxied.
**Validators**:
- the domain name can starts by a dot
- the domain name can be a hostname
- the domain name can be an IP
- the domain name can be network in CIDR format
**Examples**:
- .mozilla.org
- .net.nz
- 192.168.1.0/24
**Disabled**: when the variable "proxy_mode" has the value "No proxy" |
-| **prompt_authentication**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` *`disabled`* | Prompt for authentication if password is saved.
**Default**: true
**Disabled**: when the variable "proxy_mode" has the value "No proxy" |
-| **proxy_dns_socks5**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Use proxy DNS when using SOCKS v5.
**Default**: false |
+| 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" |
+| **no_proxy**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) *`disabled`* `unique` `multiple` | Address for which proxy will be desactivated.
Connections to localhost, 127.0.0.1/8 and ::1 are never proxied.
**Validators**:
- the domain name can starts by a dot
- the domain name can be a hostname
- the domain name can be an IP
- the domain name can be network in CIDR format
**Examples**:
- .mozilla.org
- .net.nz
- 192.168.1.0/24
**Disabled**: when the variable "proxy_mode" has the value "No proxy" |
+| **prompt_authentication**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` *`disabled`* | Prompt for authentication if password is saved.
**Default**: true
**Disabled**: when the variable "proxy_mode" has the value "No proxy" |
+| **proxy_dns_socks5**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` *`disabled`* | Use proxy DNS when using SOCKS v5.
**Default**: false
**Disabled**: if "firefox.proxy_mode" is not "Manual proxy configuration"
+or "firefox.manual.socks_proxy.version" is "v4" |
### Let's generate the changelog
```shell
rougail -m firefox/ -o doc --doc.contents changelog
```
-#### New variable
+#### Modified variable
-| Variable | Description |
-|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| **proxy_dns_socks5**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Use proxy DNS when using SOCKS v5.
**Default**: false |
+| Variable | Description |
+|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| **proxy_dns_socks5**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` *`disabled`* | Use proxy DNS when using SOCKS v5.
**Default**: false
**Disabled**: if "firefox.proxy_mode" is not "Manual proxy configuration"
+or "firefox.manual.socks_proxy.version" is "v4" |
## User datas
@@ -149,8 +163,7 @@ rougail -m firefox/ -u yaml -yf config/01/config.yml
│ Variable Default value │
╰────────────────────────╯
Variables:
-┣━━ 📓 Configure Proxy Access to the Internet: No proxy
-┗━━ 📓 Use proxy DNS when using SOCKS v5: false
+┗━━ 📓 Configure Proxy Access to the Internet: No proxy
### Example 2
@@ -263,9 +276,8 @@ Variables:
┃ ┣━━ 📓 SOCKS port: 8080
┃ ┗━━ 📓 SOCKS host version used by proxy: v4 ◀ loaded from the YAML file "config/04/config.yml" (⏳ v5)
┣━━ 📓 Address for which proxy will be desactivated:
-┣━━ 📓 Prompt for authentication if password is saved: true
-┗━━ 📓 Use proxy DNS when using SOCKS v5: false
+┗━━ 📓 Prompt for authentication if password is saved: true
-- [[tutorial v1.1_097] A Jinja conditional disabled boolean variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_097/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_097~1..v1.1_097))
+- [[tutorial v1.1_098] A variable in avanced mode](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_098/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_098~1..v1.1_098))
diff --git a/config/01/output_ro.html b/config/01/output_ro.html
index 450d0a74..ea9c2266 100644
--- a/config/01/output_ro.html
+++ b/config/01/output_ro.html
@@ -2,6 +2,5 @@
│ Variable Default value │
╰────────────────────────╯
Variables:
-┣━━ 📓 Configure Proxy Access to the Internet: No proxy
-┗━━ 📓 Use proxy DNS when using SOCKS v5: false
+┗━━ 📓 Configure Proxy Access to the Internet: No proxy
diff --git a/config/04/output_ro.html b/config/04/output_ro.html
index a4e085c3..ad69d5e7 100644
--- a/config/04/output_ro.html
+++ b/config/04/output_ro.html
@@ -15,6 +15,5 @@ Variables:
┃ ┣━━ 📓 SOCKS port: 8080
┃ ┗━━ 📓 SOCKS host version used by proxy: v4 ◀ loaded from the YAML file "config/04/config.yml" (⏳ v5)
┣━━ 📓 Address for which proxy will be desactivated:
-┣━━ 📓 Prompt for authentication if password is saved: true
-┗━━ 📓 Use proxy DNS when using SOCKS v5: false
+┗━━ 📓 Prompt for authentication if password is saved: true
diff --git a/tree.html b/tree.html
index 9f455ae1..bb1bde9e 100644
--- a/tree.html
+++ b/tree.html
@@ -25,15 +25,15 @@
Directory Tree
- .
- └── firefox
- ├── 00-proxy.yml
- ├── 10-manual.yml
- ├── 20-manual.yml
- ├── 30-auto.yml
- ├── 40-no_proxy.yml
- ├── 50-prompt_authentication.yml
- └── 55-proxy_dns_socks5.yml
+ .
+ └── firefox
+ ├── 00-proxy.yml
+ ├── 10-manual.yml
+ ├── 20-manual.yml
+ ├── 30-auto.yml
+ ├── 40-no_proxy.yml
+ ├── 50-prompt_authentication.yml
+ └── 55-proxy_dns_socks5.yml
2 directories, 7 files