diff --git a/README.md b/README.md
index f8ac1eec..fb4e3d87 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_011] Describe the variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_011/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_011~1..v1.1_011))
+- [[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_012)] Set a default value
+# [tutorial v1.1_013)] The variable is a "choice" variable
-[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_012~1..v1.1_012)
+[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_013~1..v1.1_013)
## Screenshot
@@ -23,31 +23,39 @@
---
version: 1.1
-proxy_mode: No proxy # Configure Proxy Access to the Internet
+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_012
+foo@bar:~$ git switch --detach v1.1_013
foo@bar:~$ rougail -m firefox/ -o doc -do github
```
| Variable | Description |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| **proxy_mode**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Configure Proxy Access to the Internet.
**Default**: No proxy |
+| **proxy_mode**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Configure Proxy Access to the Internet.
**Choices**:
- No proxy **← (default)**
- Auto-detect proxy settings for this network
- Use system proxy settings
- Manual proxy configuration
- Automatic proxy configuration URL |
### Let's generate the changelog
```console
-foo@bar:~$ git switch --detach v1.1_012
+foo@bar:~$ git switch --detach v1.1_013
foo@bar:~$ rougail -m firefox/ -o doc --doc.contents changelog -do github
```
#### Modified variable
-| Variable | Description |
-|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| **proxy_mode**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Configure Proxy Access to the Internet.
**Default**: No proxy |
+| Variable | Description |
+|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| **proxy_mode**
~~`string`~~ [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Configure Proxy Access to the Internet.
**Choices**:
- No proxy **← (default)**
- Auto-detect proxy settings for this network
- Use system proxy settings
- Manual proxy configuration
- Automatic proxy configuration URL |
## User datas
@@ -64,7 +72,7 @@ foo@bar:~$ rougail -m firefox/ -o doc --doc.contents changelog -do github
#### Output
```console
-foo@bar:~$ git switch --detach v1.1_012
+foo@bar:~$ git switch --detach v1.1_013
foo@bar:~$ rougail -m firefox/ -u yaml -ff config/01/config.yaml
```
╭─────── Caption ────────╮ @@ -86,7 +94,7 @@ proxy_mode: No proxy #### Output ```console -foo@bar:~$ git switch --detach v1.1_012 +foo@bar:~$ git switch --detach v1.1_013 foo@bar:~$ rougail -m firefox/ -u yaml -ff config/02/config.yaml ```╭────────────── Caption ───────────────╮ @@ -109,7 +117,7 @@ proxy_mode: Manual proxy configuration #### Output ```console -foo@bar:~$ git switch --detach v1.1_012 +foo@bar:~$ git switch --detach v1.1_013 foo@bar:~$ rougail -m firefox/ -u yaml -ff config/03/config.yaml ```╭────────────── Caption ───────────────╮ @@ -132,15 +140,17 @@ proxy_mode: foo #### Output ```console -foo@bar:~$ git switch --detach v1.1_012 +foo@bar:~$ git switch --detach v1.1_013 foo@bar:~$ rougail -m firefox/ -u yaml -ff config/04/config.yaml ``` -╭────────────── Caption ───────────────╮ -│ Variable Modified value │ -│ (⏳ Original default value) │ -╰──────────────────────────────────────╯ +🔔 WARNINGS +┗━━ 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 + 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 Default value │ +╰────────────────────────╯ Variables: -┗━━ 📓 Configure Proxy Access to the Internet: foo ◀ loaded from the YAML file "config/04/config.yaml" (⏳ No proxy) +┗━━ 📓 Configure Proxy Access to the Internet: No proxy### Example 5 @@ -155,11 +165,12 @@ proxy_mode: 1 #### Output ```console -foo@bar:~$ git switch --detach v1.1_012 +foo@bar:~$ git switch --detach v1.1_013 foo@bar:~$ rougail -m firefox/ -u yaml -ff config/05/config.yaml ```🔔 WARNINGS -┗━━ the value "1" is an invalid string for "proxy_mode" (Configure Proxy Access to the Internet), which is not a string, it will be ignored when loading from the YAML file "config/05/config.yaml" +┗━━ 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 + 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 Default value │ ╰────────────────────────╯ @@ -168,4 +179,4 @@ Variables:-- [[tutorial v1.1_013] The variable is a "choice" variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_013/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_013~1..v1.1_013)) +- [[tutorial v1.1_020] Group variables inside a 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)) diff --git a/config/04/output_ro.html b/config/04/output_ro.html index 257dbe7e..3b735cce 100644 --- a/config/04/output_ro.html +++ b/config/04/output_ro.html @@ -1,7 +1,9 @@ -╭────────────── Caption ───────────────╮ -│ Variable Modified value │ -│ (⏳ Original default value) │ -╰──────────────────────────────────────╯ +🔔 WARNINGS +┗━━ 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 + 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 Default value │ +╰────────────────────────╯ Variables: -┗━━ 📓 Configure Proxy Access to the Internet: foo ◀ loaded from the YAML file "config/04/config.yaml" (⏳ No proxy) +┗━━ 📓 Configure Proxy Access to the Internet: No proxydiff --git a/config/05/output_ro.html b/config/05/output_ro.html index 8ab79d7c..21c747f4 100644 --- a/config/05/output_ro.html +++ b/config/05/output_ro.html @@ -1,5 +1,6 @@🔔 WARNINGS -┗━━ the value "1" is an invalid string for "proxy_mode" (Configure Proxy Access to the Internet), which is not a string, it will be ignored when loading from the YAML file "config/05/config.yaml" +┗━━ 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 + 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 Default value │ ╰────────────────────────╯