182 lines
13 KiB
Markdown
182 lines
13 KiB
Markdown
- [Summary](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/branch/1.1/README.md)
|
|
- [[tutorial v1.1_012] Set a default value](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_012/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_012~1..v1.1_012))
|
|
|
|
# [tutorial v1.1_013)] Limits the possible values for the variable
|
|
|
|
[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_013~1..v1.1_013)
|
|
|
|
|
|
## Screenshot
|
|
|
|
|
|
<img src="firefox.png" width=50% height=50% alt="Firefox Proxy setting"/>
|
|
|
|
|
|
## Structure
|
|
|
|
|
|
### firefox/00-proxy.yml
|
|
|
|
|
|
```yml
|
|
%YAML 1.2
|
|
---
|
|
version: 1.1
|
|
|
|
proxy_mode:
|
|
description: Configure Proxy Access to the Internet
|
|
choices:
|
|
- No proxy
|
|
- Auto-detect proxy settings for this network
|
|
- Use system proxy settings
|
|
- Manual proxy configuration
|
|
- Automatic proxy configuration URL
|
|
default: No proxy
|
|
...
|
|
|
|
```
|
|
### Let's generate the documentation
|
|
|
|
```console
|
|
foo@bar:~$ git switch --detach v1.1_013
|
|
foo@bar:~$ rougail -m firefox/ -o doc
|
|
```
|
|
| Variable | Description |
|
|
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
| **proxy_mode**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Configure Proxy Access to the Internet.<br/>**Choices**: <br/>- No proxy **← (default)**<br/>- Auto-detect proxy settings for this network<br/>- Use system proxy settings<br/>- Manual proxy configuration<br/>- Automatic proxy configuration URL |
|
|
|
|
### Let's generate the changelog
|
|
|
|
```console
|
|
foo@bar:~$ git switch --detach v1.1_013
|
|
foo@bar:~$ rougail -m firefox/ -o doc --doc.contents changelog
|
|
```
|
|
#### Modified variable
|
|
|
|
| Variable | Description |
|
|
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
| **proxy_mode**<br/>~~`string`~~ [<ins>`choice`</ins>](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Configure Proxy Access to the Internet.<br/>**Choices**: <br/>- No proxy **← (default)**<br/>- <ins>Auto-detect proxy settings for this network</ins><br/>- <ins>Use system proxy settings</ins><br/>- <ins>Manual proxy configuration</ins><br/>- <ins>Automatic proxy configuration URL</ins> |
|
|
|
|
|
|
## User datas
|
|
|
|
### Example 1
|
|
|
|
#### config/01/config.yaml
|
|
|
|
|
|
```yml
|
|
---
|
|
|
|
```
|
|
#### Output
|
|
|
|
```console
|
|
foo@bar:~$ git switch --detach v1.1_013
|
|
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_013
|
|
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_013
|
|
foo@bar:~$ rougail -m firefox/ -u yaml -ff config/03/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: Manual proxy configuration ◀ loaded from the YAML file "config/03/config.yaml" (⏳ <span style="color: #00aa00">No proxy</span>)
|
|
</pre>
|
|
### Example 4
|
|
|
|
#### config/04/config.yaml
|
|
|
|
|
|
```yml
|
|
---
|
|
proxy_mode: foo
|
|
|
|
```
|
|
#### Output
|
|
|
|
```console
|
|
foo@bar:~$ git switch --detach v1.1_013
|
|
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_013
|
|
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_020] Creating a new family](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_020/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_020~1..v1.1_020))
|