|
|
|
|
@ -1,9 +1,9 @@
|
|
|
|
|
- [Summary](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/branch/1.1/README.md)
|
|
|
|
|
- [[tutorial v1.1_033] A conditional hidden family with a variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_033/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_033~1..v1.1_033))
|
|
|
|
|
- [[tutorial v1.1_034] A calculated default value](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_034/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_034~1..v1.1_034))
|
|
|
|
|
|
|
|
|
|
# [tutorial v1.1_034)] A calculated default value
|
|
|
|
|
# [tutorial v1.1_035)] Variable type and parameters type are copied with default value
|
|
|
|
|
|
|
|
|
|
[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_034~1..v1.1_034)
|
|
|
|
|
[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_035~1..v1.1_035)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Screenshot
|
|
|
|
|
@ -83,15 +83,11 @@ manual:
|
|
|
|
|
|
|
|
|
|
address:
|
|
|
|
|
description: HTTPS address
|
|
|
|
|
type: domainname
|
|
|
|
|
params:
|
|
|
|
|
allow_ip: true
|
|
|
|
|
default:
|
|
|
|
|
variable: __.http_proxy.address
|
|
|
|
|
|
|
|
|
|
port:
|
|
|
|
|
description: HTTPS Port
|
|
|
|
|
type: port
|
|
|
|
|
default:
|
|
|
|
|
variable: __.http_proxy.port
|
|
|
|
|
...
|
|
|
|
|
@ -100,7 +96,7 @@ manual:
|
|
|
|
|
### Let's generate the documentation
|
|
|
|
|
|
|
|
|
|
```console
|
|
|
|
|
foo@bar:~$ git switch --detach v1.1_034
|
|
|
|
|
foo@bar:~$ git switch --detach v1.1_035
|
|
|
|
|
foo@bar:~$ rougail -m firefox/ -o doc -do github
|
|
|
|
|
```
|
|
|
|
|
| Variable | Description |
|
|
|
|
|
@ -143,138 +139,6 @@ foo@bar:~$ rougail -m firefox/ -o doc -do github
|
|
|
|
|
| **manual.https_proxy.address**<br/>[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTPS 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/>[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTPS 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_034
|
|
|
|
|
foo@bar:~$ rougail -m firefox/ -o doc --doc.contents changelog -do github
|
|
|
|
|
```
|
|
|
|
|
#### Modified variables
|
|
|
|
|
|
|
|
|
|
| Variable | Description |
|
|
|
|
|
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
|
|
|
| **manual.https_proxy.address**<br/>[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTPS address.<br/>**Validator**: the domain name can be an IP<br/>**Default**: <ins>the value of the variable "manual.http_proxy.address"</ins> |
|
|
|
|
|
| **manual.https_proxy.port**<br/>[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTPS 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**: ~~8080~~<br/><ins>the value of the variable "manual.http_proxy.port"</ins> |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## User datas
|
|
|
|
|
|
|
|
|
|
### Example 1
|
|
|
|
|
|
|
|
|
|
#### config/01/config.yaml
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
```yml
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
#### Output
|
|
|
|
|
|
|
|
|
|
```console
|
|
|
|
|
foo@bar:~$ git switch --detach v1.1_034
|
|
|
|
|
foo@bar:~$ rougail -m firefox/ -u yaml -ff config/01/config.yaml
|
|
|
|
|
```
|
|
|
|
|
<pre>╭─────── Caption ────────╮
|
|
|
|
|
│ Variable <span style="color: #ffd700">Default value</span> │
|
|
|
|
|
╰────────────────────────╯
|
|
|
|
|
Variables:
|
|
|
|
|
<span style="color: #5c5cff">┗━━ </span>📓 Configure Proxy Access to the Internet: <span style="color: #ffd700">No proxy</span>
|
|
|
|
|
</pre>
|
|
|
|
|
### Example 2
|
|
|
|
|
|
|
|
|
|
#### config/02/config.yaml
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
```yml
|
|
|
|
|
---
|
|
|
|
|
proxy_mode: No proxy
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
#### Output
|
|
|
|
|
|
|
|
|
|
```console
|
|
|
|
|
foo@bar:~$ git switch --detach v1.1_034
|
|
|
|
|
foo@bar:~$ rougail -m firefox/ -u yaml -ff config/02/config.yaml
|
|
|
|
|
```
|
|
|
|
|
<pre>╭────────────── Caption ───────────────╮
|
|
|
|
|
│ Variable Modified value │
|
|
|
|
|
│ (<span style="color: #00aa00">⏳ Original default value</span>) │
|
|
|
|
|
╰──────────────────────────────────────╯
|
|
|
|
|
Variables:
|
|
|
|
|
<span style="color: #5c5cff">┗━━ </span>📓 Configure Proxy Access to the Internet: No proxy ◀ loaded from the YAML file "config/02/config.yaml" (⏳ <span style="color: #00aa00">No proxy</span>)
|
|
|
|
|
</pre>
|
|
|
|
|
### Example 3
|
|
|
|
|
|
|
|
|
|
#### config/03/config.yaml
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
```yml
|
|
|
|
|
---
|
|
|
|
|
proxy_mode: Manual proxy configuration
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
#### Output
|
|
|
|
|
|
|
|
|
|
```console
|
|
|
|
|
foo@bar:~$ git switch --detach v1.1_034
|
|
|
|
|
foo@bar:~$ rougail -m firefox/ -u yaml -ff config/03/config.yaml
|
|
|
|
|
```
|
|
|
|
|
<pre><span style="font-weight: bold; color: #ff0000">🛑 ERRORS</span>
|
|
|
|
|
<span style="color: #ff0000">┗━━ </span>The following variables are mandatory but have no value:
|
|
|
|
|
<span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>Manual proxy configuration
|
|
|
|
|
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>HTTP Proxy
|
|
|
|
|
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>HTTP address
|
|
|
|
|
</pre>
|
|
|
|
|
### Example 4
|
|
|
|
|
|
|
|
|
|
#### config/04/config.yaml
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
```yml
|
|
|
|
|
---
|
|
|
|
|
proxy_mode: foo
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
#### Output
|
|
|
|
|
|
|
|
|
|
```console
|
|
|
|
|
foo@bar:~$ git switch --detach v1.1_034
|
|
|
|
|
foo@bar:~$ rougail -m firefox/ -u yaml -ff config/04/config.yaml
|
|
|
|
|
```
|
|
|
|
|
<pre><span style="font-weight: bold; color: #ffff00">🔔 WARNINGS</span>
|
|
|
|
|
<span style="color: #ffff00">┗━━ </span>the value "foo" is an invalid choice for "proxy_mode" (Configure Proxy Access to the Internet), only "Auto-detect proxy settings for this network", "Automatic proxy configuration URL", "Manual proxy
|
|
|
|
|
<span style="color: #ffff00"> </span>configuration", "No proxy" and "Use system proxy settings" are allowed, it will be ignored when loading from the YAML file "config/04/config.yaml"
|
|
|
|
|
╭─────── Caption ────────╮
|
|
|
|
|
│ Variable <span style="color: #ffd700">Default value</span> │
|
|
|
|
|
╰────────────────────────╯
|
|
|
|
|
Variables:
|
|
|
|
|
<span style="color: #5c5cff">┗━━ </span>📓 Configure Proxy Access to the Internet: <span style="color: #ffd700">No proxy</span>
|
|
|
|
|
</pre>
|
|
|
|
|
### Example 5
|
|
|
|
|
|
|
|
|
|
#### config/05/config.yaml
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
```yml
|
|
|
|
|
---
|
|
|
|
|
proxy_mode: 1
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
#### Output
|
|
|
|
|
|
|
|
|
|
```console
|
|
|
|
|
foo@bar:~$ git switch --detach v1.1_034
|
|
|
|
|
foo@bar:~$ rougail -m firefox/ -u yaml -ff config/05/config.yaml
|
|
|
|
|
```
|
|
|
|
|
<pre><span style="font-weight: bold; color: #ffff00">🔔 WARNINGS</span>
|
|
|
|
|
<span style="color: #ffff00">┗━━ </span>the value "1" is an invalid choice for "proxy_mode" (Configure Proxy Access to the Internet), only "Auto-detect proxy settings for this network", "Automatic proxy configuration URL", "Manual proxy
|
|
|
|
|
<span style="color: #ffff00"> </span>configuration", "No proxy" and "Use system proxy settings" are allowed, it will be ignored when loading from the YAML file "config/05/config.yaml"
|
|
|
|
|
╭─────── Caption ────────╮
|
|
|
|
|
│ Variable <span style="color: #ffd700">Default value</span> │
|
|
|
|
|
╰────────────────────────╯
|
|
|
|
|
Variables:
|
|
|
|
|
<span style="color: #5c5cff">┗━━ </span>📓 Configure Proxy Access to the Internet: <span style="color: #ffd700">No proxy</span>
|
|
|
|
|
</pre>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
- [[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))
|
|
|
|
|
|
