diff --git a/README.md b/README.md
index 680ee943..6274c228 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_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))
+- [[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))
-# [tutorial v1.1_051)] A conditional disabled variable
+# [tutorial v1.1_060)] A variable with type "domainname", parameters type and disabled
-[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_051~1..v1.1_051)
+[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_060~1..v1.1_060)
## Screenshot
@@ -129,11 +129,33 @@ auto:
when_not: Automatic proxy configuration URL
...
+```
+### firefox/40-no_proxy.yml
+
+
+```yml
+%YAML 1.2
+---
+version: 1.1
+
+no_proxy:
+ description: Address for which proxy will be desactivated
+ type: domainname
+ params:
+ allow_ip: true
+ allow_cidr_network: true
+ allow_without_dot: true
+ allow_startswith_dot: true
+ disabled:
+ variable: _.proxy_mode
+ when: No proxy
+...
+
```
### Let's generate the documentation
```console
-foo@bar:~$ git switch --detach v1.1_051
+foo@bar:~$ git switch --detach v1.1_060
foo@bar:~$ rougail -m firefox/ -o doc -do github
```
| Variable | Description |
@@ -184,18 +206,19 @@ This family builds families dynamically
| 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) `mandatory` *`disabled`* | Address for which proxy will be desactivated.
**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
**Disabled**: when the variable "proxy_mode" has the value "No proxy" |
### Let's generate the changelog
```console
-foo@bar:~$ git switch --detach v1.1_051
+foo@bar:~$ git switch --detach v1.1_060
foo@bar:~$ rougail -m firefox/ -o doc --doc.contents changelog -do github
```
-#### Modified variable
+#### New variable
-| 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**: {'message': 'when the variable "{0}" hasn\'t the value "Automatic proxy configuration URL"', 'path': {'path': 'proxy_mode'}, 'description': 'Configure Proxy Access to the Internet'} |
+| Variable | Description |
+|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| **no_proxy**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` *`disabled`* | Address for which proxy will be desactivated.
**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
**Disabled**: when the variable "proxy_mode" has the value "No proxy" |
## User datas
@@ -207,18 +230,15 @@ foo@bar:~$ rougail -m firefox/ -o doc --doc.contents changelog -do github
```yml
---
-auto: https://auto.proxy.net/wpad.dat
```
#### Output
```console
-foo@bar:~$ git switch --detach v1.1_051
+foo@bar:~$ git switch --detach v1.1_060
foo@bar:~$ rougail -m firefox/ -u yaml -ff config/01/config.yaml
```
-
🔔 WARNINGS -┗━━ variable "auto" (Automatic proxy configuration URL) is disabled, it will be ignored when loading from the YAML file "config/01/config.yaml" -╭─────── Caption ────────╮ +╭─────── Caption ────────╮ │ Variable Default value │ ╰────────────────────────╯ Variables: @@ -229,46 +249,28 @@ Variables: #### config/02/config.yaml -```yml ---- -proxy_mode: Automatic proxy configuration URL - -``` -#### Output - -```console -foo@bar:~$ git switch --detach v1.1_051 -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 +no_proxy: 192.168.1.0/24 ``` #### Output ```console -foo@bar:~$ git switch --detach v1.1_051 -foo@bar:~$ rougail -m firefox/ -u yaml -ff config/03/config.yaml +foo@bar:~$ git switch --detach v1.1_060 +foo@bar:~$ rougail -m firefox/ -u yaml -ff config/02/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" +┣━━ 📓 Configure Proxy Access to the Internet: Automatic proxy configuration URL ◀ loaded from the YAML file "config/02/config.yaml" (⏳ No proxy) +┣━━ 📓 Automatic proxy configuration URL: https://auto.proxy.net/wpad.dat ◀ loaded from the YAML file "config/02/config.yaml" +┗━━ 📓 Address for which proxy will be desactivated: 192.168.1.0/24 ◀ loaded from the YAML file "config/02/config.yaml"-- [[tutorial v1.1_060] A variable with type "domainname", parameters type and disabled](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_060/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_060~1..v1.1_060)) +- [[tutorial v1.1_061] A variable with multiple value](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)) diff --git a/config/01/config.yaml b/config/01/config.yaml index 1edbe913..ed97d539 100644 --- a/config/01/config.yaml +++ b/config/01/config.yaml @@ -1,2 +1 @@ --- -auto: https://auto.proxy.net/wpad.dat diff --git a/config/01/output_ro.html b/config/01/output_ro.html index e554078e..ea9c2266 100644 --- a/config/01/output_ro.html +++ b/config/01/output_ro.html @@ -1,6 +1,4 @@ -🔔 WARNINGS -┗━━ variable "auto" (Automatic proxy configuration URL) is disabled, it will be ignored when loading from the YAML file "config/01/config.yaml" -╭─────── Caption ────────╮ +╭─────── Caption ────────╮ │ Variable Default value │ ╰────────────────────────╯ Variables: diff --git a/config/02/config.yaml b/config/02/config.yaml index 26df1306..54956ea6 100644 --- a/config/02/config.yaml +++ b/config/02/config.yaml @@ -1,2 +1,4 @@ --- proxy_mode: Automatic proxy configuration URL +auto: https://auto.proxy.net/wpad.dat +no_proxy: 192.168.1.0/24 diff --git a/config/02/output_ro.html b/config/02/output_ro.html index e1ebfb1d..931549af 100644 --- a/config/02/output_ro.html +++ b/config/02/output_ro.html @@ -1,4 +1,9 @@ -🛑 ERRORS -┗━━ The following variables are mandatory but have no value: - ┗━━ Automatic proxy configuration URL +╭────────────── Caption ───────────────╮ +│ Variable Modified value │ +│ (⏳ Original default value) │ +╰──────────────────────────────────────╯ +Variables: +┣━━ 📓 Configure Proxy Access to the Internet: Automatic proxy configuration URL ◀ loaded from the YAML file "config/02/config.yaml" (⏳ No proxy) +┣━━ 📓 Automatic proxy configuration URL: https://auto.proxy.net/wpad.dat ◀ loaded from the YAML file "config/02/config.yaml" +┗━━ 📓 Address for which proxy will be desactivated: 192.168.1.0/24 ◀ loaded from the YAML file "config/02/config.yaml"diff --git a/config/03/config.yaml b/config/03/config.yaml deleted file mode 100644 index 307e175b..00000000 --- a/config/03/config.yaml +++ /dev/null @@ -1,3 +0,0 @@ ---- -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 deleted file mode 100644 index d8cd7f41..00000000 --- a/config/03/output_ro.html +++ /dev/null @@ -1,8 +0,0 @@ -╭────────────── 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 20701e22..16f5931c 100644 Binary files a/firefox.png and b/firefox.png differ