diff --git a/README.md b/README.md index fb4e3d87..f95d5c1e 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_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] 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_013)] The variable is a "choice" variable +# [tutorial v1.1_020)] Group variables inside a family -[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_013~1..v1.1_013) +[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_020~1..v1.1_020) ## Screenshot @@ -34,149 +34,31 @@ proxy_mode: default: No proxy ... +``` +### firefox/10-manual.yml + + +```yml +%YAML 1.2 +--- +version: 1.1 + +manual: + description: Manual proxy configuration + type: family +... + ``` ### Let's generate the documentation ```console -foo@bar:~$ git switch --detach v1.1_013 +foo@bar:~$ git switch --detach v1.1_020 foo@bar:~$ rougail -m firefox/ -o doc -do github ``` | Variable                                                                                        | Description                                                                                     | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **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_013 -foo@bar:~$ rougail -m firefox/ -o doc --doc.contents changelog -do github -``` -#### Modified variable - -| 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 - -### 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 -``` -
╭─────── Caption ────────╮
-│ Variable Default value │
-╰────────────────────────╯
-Variables:
-┗━━ 📓 Configure Proxy Access to the Internet: No proxy
-
-### 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 -``` -
╭────────────── Caption ───────────────╮
-│ Variable Modified value              │
-│          (⏳ Original default value) │
-╰──────────────────────────────────────╯
-Variables:
-┗━━ 📓 Configure Proxy Access to the Internet: No proxy ◀ loaded from the YAML file "config/02/config.yaml" (⏳ No proxy)
-
-### 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 -``` -
╭────────────── Caption ───────────────╮
-│ Variable Modified value              │
-│          (⏳ Original default value) │
-╰──────────────────────────────────────╯
-Variables:
-┗━━ 📓 Configure Proxy Access to the Internet: Manual proxy configuration ◀ loaded from the YAML file "config/03/config.yaml" (⏳ No proxy)
-
-### 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 -``` -
🔔 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: No proxy
-
-### 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 -``` -
🔔 WARNINGS
-┗━━ 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 │
-╰────────────────────────╯
-Variables:
-┗━━ 📓 Configure Proxy Access to the Internet: No proxy
-
- - -- [[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)) +- [[tutorial v1.1_021] Group variables inside a sub family](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_021/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_021~1..v1.1_021)) diff --git a/config/01/config.yaml b/config/01/config.yaml deleted file mode 100644 index ed97d539..00000000 --- a/config/01/config.yaml +++ /dev/null @@ -1 +0,0 @@ ---- diff --git a/config/01/output_ro.html b/config/01/output_ro.html deleted file mode 100644 index ea9c2266..00000000 --- a/config/01/output_ro.html +++ /dev/null @@ -1,6 +0,0 @@ -
╭─────── Caption ────────╮
-│ Variable Default value │
-╰────────────────────────╯
-Variables:
-┗━━ 📓 Configure Proxy Access to the Internet: No proxy
-
diff --git a/config/02/config.yaml b/config/02/config.yaml deleted file mode 100644 index d9144882..00000000 --- a/config/02/config.yaml +++ /dev/null @@ -1,2 +0,0 @@ ---- -proxy_mode: No proxy diff --git a/config/02/output_ro.html b/config/02/output_ro.html deleted file mode 100644 index b0153620..00000000 --- a/config/02/output_ro.html +++ /dev/null @@ -1,7 +0,0 @@ -
╭────────────── Caption ───────────────╮
-│ Variable Modified value              │
-│          (⏳ Original default value) │
-╰──────────────────────────────────────╯
-Variables:
-┗━━ 📓 Configure Proxy Access to the Internet: No proxy ◀ loaded from the YAML file "config/02/config.yaml" (⏳ No proxy)
-
diff --git a/config/03/config.yaml b/config/03/config.yaml deleted file mode 100644 index 74edb225..00000000 --- a/config/03/config.yaml +++ /dev/null @@ -1,2 +0,0 @@ ---- -proxy_mode: Manual proxy configuration diff --git a/config/03/output_ro.html b/config/03/output_ro.html deleted file mode 100644 index 6ffb1f47..00000000 --- a/config/03/output_ro.html +++ /dev/null @@ -1,7 +0,0 @@ -
╭────────────── Caption ───────────────╮
-│ Variable Modified value              │
-│          (⏳ Original default value) │
-╰──────────────────────────────────────╯
-Variables:
-┗━━ 📓 Configure Proxy Access to the Internet: Manual proxy configuration ◀ loaded from the YAML file "config/03/config.yaml" (⏳ No proxy)
-
diff --git a/config/04/config.yaml b/config/04/config.yaml deleted file mode 100644 index e3fa25da..00000000 --- a/config/04/config.yaml +++ /dev/null @@ -1,2 +0,0 @@ ---- -proxy_mode: foo diff --git a/config/04/output_ro.html b/config/04/output_ro.html deleted file mode 100644 index 3b735cce..00000000 --- a/config/04/output_ro.html +++ /dev/null @@ -1,9 +0,0 @@ -
🔔 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: No proxy
-
diff --git a/config/05/config.yaml b/config/05/config.yaml deleted file mode 100644 index bf6f64ca..00000000 --- a/config/05/config.yaml +++ /dev/null @@ -1,2 +0,0 @@ ---- -proxy_mode: 1 diff --git a/config/05/output_ro.html b/config/05/output_ro.html deleted file mode 100644 index 21c747f4..00000000 --- a/config/05/output_ro.html +++ /dev/null @@ -1,9 +0,0 @@ -
🔔 WARNINGS
-┗━━ 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 │
-╰────────────────────────╯
-Variables:
-┗━━ 📓 Configure Proxy Access to the Internet: No proxy
-
diff --git a/firefox.png b/firefox.png index 45725ac6..e40ce963 100644 Binary files a/firefox.png and b/firefox.png differ