diff --git a/README.md b/README.md index 42e508d4..d6cffd07 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_041] An hidden family](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_041/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_041~1..v1.1_041)) +- [[tutorial v1.1_042] A conditional hidden family with a variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_042/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_042~1..v1.1_042)) -# [tutorial v1.1_042)] A conditional hidden family with a variable +# [tutorial v1.1_043)] A calculated default value -[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_042~1..v1.1_042) +[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_043~1..v1.1_043) ## Screenshot @@ -86,18 +86,21 @@ manual: type: domainname params: allow_ip: true + default: + variable: __.http_proxy.address port: description: HTTPS Port type: port - default: 8080 + default: + variable: __.http_proxy.port ... ``` ### Let's generate the documentation ```console -foo@bar:~$ git switch --detach v1.1_042 +foo@bar:~$ git switch --detach v1.1_043 foo@bar:~$ rougail -m firefox/ -o doc ``` | Variable                                                                                        | Description                                                                                     | @@ -137,21 +140,21 @@ foo@bar:~$ rougail -m firefox/ -o doc | Variable                                                                                            | Description                                                                                         | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **manual.https_proxy.address**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTPS address.
**Validator**: the domain name can be an IP | -| **manual.https_proxy.port**
[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTPS 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**: 8080 | +| **manual.https_proxy.address**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTPS address.
**Validator**: the domain name can be an IP
**Default**: the value of the variable "manual.http_proxy.address" | +| **manual.https_proxy.port**
[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTPS 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" | ### Let's generate the changelog ```console -foo@bar:~$ git switch --detach v1.1_042 +foo@bar:~$ git switch --detach v1.1_043 foo@bar:~$ rougail -m firefox/ -o doc --doc.contents changelog ``` -#### New variables +#### Modified variables | Variable                                                                                            | Description                                                                                         | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **manual.https_proxy.address**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTPS address.
**Validator**: the domain name can be an IP | -| **manual.https_proxy.port**
[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTPS 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**: 8080 | +| **manual.https_proxy.address**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTPS address.
**Validator**: the domain name can be an IP
**Default**: the value of the variable "manual.http_proxy.address" | +| **manual.https_proxy.port**
[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTPS 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**: ~~8080~~
the value of the variable "manual.http_proxy.port" | ## User datas @@ -168,7 +171,7 @@ foo@bar:~$ rougail -m firefox/ -o doc --doc.contents changelog #### Output ```console -foo@bar:~$ git switch --detach v1.1_042 +foo@bar:~$ git switch --detach v1.1_043 foo@bar:~$ rougail -m firefox/ -u yaml -ff config/01/config.yaml ```
╭─────── Caption ────────╮
@@ -190,7 +193,7 @@ proxy_mode: No proxy
 #### Output
 
 ```console
-foo@bar:~$ git switch --detach v1.1_042
+foo@bar:~$ git switch --detach v1.1_043
 foo@bar:~$ rougail -m firefox/ -u yaml -ff config/02/config.yaml
 ```
 
╭────────────── Caption ───────────────╮
@@ -213,7 +216,7 @@ proxy_mode: Manual proxy configuration
 #### Output
 
 ```console
-foo@bar:~$ git switch --detach v1.1_042
+foo@bar:~$ git switch --detach v1.1_043
 foo@bar:~$ rougail -m firefox/ -u yaml -ff config/03/config.yaml
 ```
 
🛑 ERRORS
@@ -235,7 +238,7 @@ proxy_mode: foo
 #### Output
 
 ```console
-foo@bar:~$ git switch --detach v1.1_042
+foo@bar:~$ git switch --detach v1.1_043
 foo@bar:~$ rougail -m firefox/ -u yaml -ff config/04/config.yaml
 ```
 
🔔 WARNINGS
@@ -260,7 +263,7 @@ proxy_mode: 1
 #### Output
 
 ```console
-foo@bar:~$ git switch --detach v1.1_042
+foo@bar:~$ git switch --detach v1.1_043
 foo@bar:~$ rougail -m firefox/ -u yaml -ff config/05/config.yaml
 ```
 
🔔 WARNINGS
@@ -274,4 +277,4 @@ Variables:
 
-- [[tutorial v1.1_043] A calculated default value](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] Variable type and parameters type are copied with default value](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))