[tutorial v1.1_051)] A conditional hidden family with Jinja (config and doc)
This commit is contained in:
parent
1a8782a1d0
commit
91a98f2712
1 changed files with 10 additions and 25 deletions
35
README.md
35
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] Variable type and parameters type are copied with default value](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_050] Family: a dynamic family](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_050)] Family: a dynamic family
|
||||
# [tutorial v1.1_051)] A conditional hidden family with Jinja
|
||||
|
||||
[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_050~1..v1.1_050)
|
||||
[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_051~1..v1.1_051)
|
||||
|
||||
|
||||
## Screenshot
|
||||
|
|
@ -79,7 +79,10 @@ manual:
|
|||
'{{ identifier }}_proxy':
|
||||
description: '{{ identifier }} Proxy'
|
||||
hidden:
|
||||
variable: _.use_for_https
|
||||
jinja: |-
|
||||
{% if _.use_for_https %}
|
||||
HTTPS is same has HTTP
|
||||
{% endif %}
|
||||
dynamic:
|
||||
- HTTPS
|
||||
- SOCKS
|
||||
|
|
@ -99,7 +102,7 @@ manual:
|
|||
### Let's generate the documentation
|
||||
|
||||
```console
|
||||
foo@bar:~$ git switch --detach v1.1_050
|
||||
foo@bar:~$ git switch --detach v1.1_051
|
||||
foo@bar:~$ rougail -m firefox/ -o doc
|
||||
```
|
||||
| Variable | Description |
|
||||
|
|
@ -137,7 +140,7 @@ This family builds families dynamically
|
|||
|
||||
*`hidden`*
|
||||
|
||||
**Hidden**: when the variable "manual.use_for_https" has the value "true"
|
||||
**Hidden**: depends on a calculation
|
||||
|
||||
**Identifiers**: <br/>- HTTPS<br/>- SOCKS
|
||||
|
||||
|
|
@ -146,24 +149,6 @@ This family builds families dynamically
|
|||
| **manual.*https*_proxy.address**<br/>**manual.*socks*_proxy.address**<br/>[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | *HTTPS* or *SOCKS* address.<br/>**Validator**: the domain name can be an IP<br/>**Default**: the value of the variable "manual.http_proxy.address" |
|
||||
| **manual.*https*_proxy.port**<br/>**manual.*socks*_proxy.port**<br/>[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | *HTTPS* or *SOCKS* port.<br/>**Validators**: <br/>- well-known ports (1 to 1023) are allowed<br/>- registred ports (1024 to 49151) are allowed<br/>- private ports (greater than 49152) are allowed<br/>**Default**: the value of the variable "manual.http_proxy.port" |
|
||||
|
||||
### Let's generate the changelog
|
||||
|
||||
```console
|
||||
foo@bar:~$ git switch --detach v1.1_050
|
||||
foo@bar:~$ rougail -m firefox/ -o doc --doc.contents changelog
|
||||
```
|
||||
#### New variables
|
||||
|
||||
| Variable | Description |
|
||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| **manual.*https*_proxy.address**<br/>**manual.*socks*_proxy.address**<br/>[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | *HTTPS* or *SOCKS* address.<br/>**Validator**: the domain name can be an IP<br/>**Default**: the value of the variable "manual.http_proxy.address" |
|
||||
| **manual.*https*_proxy.port**<br/>**manual.*socks*_proxy.port**<br/>[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | *HTTPS* or *SOCKS* port.<br/>**Validators**: <br/>- well-known ports (1 to 1023) are allowed<br/>- registred ports (1024 to 49151) are allowed<br/>- private ports (greater than 49152) are allowed<br/>**Default**: the value of the variable "manual.http_proxy.port" |
|
||||
|
||||
#### Deleted variables
|
||||
|
||||
|
||||
- manual.https_proxy.address
|
||||
- manual.https_proxy.port
|
||||
|
||||
|
||||
- [[tutorial v1.1_051] A conditional hidden family with Jinja](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_052] Jinja with a parameter](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_052/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_052~1..v1.1_052))
|
||||
|
|
|
|||
Loading…
Reference in a new issue