[tutorial v1.1_041)] A conditional hidden family with Jinja (config and doc)
This commit is contained in:
parent
025ea8f8cf
commit
c9d21e2244
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)
|
- [Summary](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/branch/1.1/README.md)
|
||||||
- [[tutorial v1.1_035] Variable type and parameters type are copied with default value](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_035/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_035~1..v1.1_035))
|
- [[tutorial v1.1_040] Family: a dynamic family](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_040/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_040~1..v1.1_040))
|
||||||
|
|
||||||
# [tutorial v1.1_040)] Family: a dynamic family
|
# [tutorial v1.1_041)] A conditional hidden family with Jinja
|
||||||
|
|
||||||
[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_040~1..v1.1_040)
|
[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_041~1..v1.1_041)
|
||||||
|
|
||||||
|
|
||||||
## Screenshot
|
## Screenshot
|
||||||
|
|
@ -79,7 +79,10 @@ manual:
|
||||||
'{{ identifier }}_proxy':
|
'{{ identifier }}_proxy':
|
||||||
description: '{{ identifier }} Proxy'
|
description: '{{ identifier }} Proxy'
|
||||||
hidden:
|
hidden:
|
||||||
variable: _.use_for_https
|
jinja: |-
|
||||||
|
{% if manual.use_for_https %}
|
||||||
|
HTTPS is same has HTTP
|
||||||
|
{% endif %}
|
||||||
dynamic:
|
dynamic:
|
||||||
- HTTPS
|
- HTTPS
|
||||||
- SOCKS
|
- SOCKS
|
||||||
|
|
@ -99,7 +102,7 @@ manual:
|
||||||
### Let's generate the documentation
|
### Let's generate the documentation
|
||||||
|
|
||||||
```console
|
```console
|
||||||
foo@bar:~$ git switch --detach v1.1_040
|
foo@bar:~$ git switch --detach v1.1_041
|
||||||
foo@bar:~$ rougail -m firefox/ -o doc -do github
|
foo@bar:~$ rougail -m firefox/ -o doc -do github
|
||||||
```
|
```
|
||||||
| Variable | Description |
|
| Variable | Description |
|
||||||
|
|
@ -137,7 +140,7 @@ This family builds families dynamically
|
||||||
|
|
||||||
*`hidden`*
|
*`hidden`*
|
||||||
|
|
||||||
**Hidden**: when the variable "manual.use_for_https" has the value "true"
|
**Hidden**: depends on a calculation
|
||||||
|
|
||||||
**Identifiers**: <br/>- HTTPS<br/>- SOCKS
|
**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.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" |
|
| **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_040
|
|
||||||
foo@bar:~$ rougail -m firefox/ -o doc --doc.contents changelog -do github
|
|
||||||
```
|
|
||||||
#### 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
|
- [[tutorial v1.1_042] Jinja with a parameter](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))
|
||||||
- manual.https_proxy.port
|
|
||||||
|
|
||||||
|
|
||||||
- [[tutorial v1.1_041] A conditional hidden family with Jinja](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))
|
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue