diff --git a/README.md b/README.md index c4dbfd6..f3cb653 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 013] A variable with type "choice"](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 014] Choice type is optional](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_014/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_014~1..v1.1_014)) -# [tutorial 014] Choice type is optional +# [tutorial 020] A family -[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_014~1..v1.1_014) +[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_020~1..v1.1_020) ## Screenshot @@ -30,6 +30,16 @@ proxy_mode: - Automatic proxy configuration URL default: No proxy +``` +### firefox/10-manual.yml + + +```yml +--- +manual: + description: Manual proxy configuration + type: family + ``` ### Generated documentation @@ -43,135 +53,6 @@ foo@bar:~$ rougail -v 1.1 -m firefox/ -o doc -do github | **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 | -## User data - -### Example 1 - -#### config/01/config.yaml -```yml ---- - -``` -#### Output - -```console -foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/01/config.yaml -``` -
╭────────────────────────── Caption ──────────────────────────╮
-│ Variable                           Default value            │
-│ Undocumented variable              Modified value           │
-│ Undocumented but modified variable (Original default value) │
-│ Unmodifiable variable                                       │
-╰─────────────────────────────────────────────────────────────╯
-Variables:
-┗━━ 📓 proxy_mode: No proxy
-
-### Example 2 - -#### config/02/config.yaml - - -```yml ---- -proxy_mode: No proxy - -``` -#### Output - -```console -foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/02/config.yaml -``` -
╭────────────────────────── Caption ──────────────────────────╮
-│ Variable                           Default value            │
-│ Undocumented variable              Modified value           │
-│ Undocumented but modified variable (Original default value) │
-│ Unmodifiable variable                                       │
-╰─────────────────────────────────────────────────────────────╯
-Variables:
-┗━━ 📓 proxy_mode: No proxy (No proxy)
-
-### Example 3 - -#### config/03/config.yaml - - -```yml ---- -proxy_mode: Manual proxy configuration - -``` -#### Output - -```console -foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/03/config.yaml -``` -
╭────────────────────────── Caption ──────────────────────────╮
-│ Variable                           Default value            │
-│ Undocumented variable              Modified value           │
-│ Undocumented but modified variable (Original default value) │
-│ Unmodifiable variable                                       │
-╰─────────────────────────────────────────────────────────────╯
-Variables:
-┗━━ 📓 proxy_mode: Manual proxy configuration (No proxy)
-
-### Example 4 - -#### config/04/config.yaml - - -```yml ---- -proxy_mode: foo - -``` -#### Output - -```console -foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/04/config.yaml -``` -
🛑 ERRORS
-┗━━ "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
-╭────────────────────────── Caption ──────────────────────────╮
-│ Variable                           Default value            │
-│ Undocumented variable              Modified value           │
-│ Undocumented but modified variable (Original default value) │
-│ Unmodifiable variable                                       │
-╰─────────────────────────────────────────────────────────────╯
-Variables:
-┗━━ 📓 proxy_mode: No proxy
-
-### Example 5 - -#### config/05/config.yaml - - -```yml ---- -proxy_mode: 1 - -``` -#### Output - -```console -foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/05/config.yaml -``` -
🛑 ERRORS
-┗━━ "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
-╭────────────────────────── Caption ──────────────────────────╮
-│ Variable                           Default value            │
-│ Undocumented variable              Modified value           │
-│ Undocumented but modified variable (Original default value) │
-│ Unmodifiable variable                                       │
-╰─────────────────────────────────────────────────────────────╯
-Variables:
-┗━━ 📓 proxy_mode: No proxy
-
- - -- [[tutorial 020] 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 021] 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 ed97d53..0000000 --- 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 cdecbe8..0000000 --- a/config/01/output_ro.html +++ /dev/null @@ -1,9 +0,0 @@ -
╭────────────────────────── Caption ──────────────────────────╮
-│ Variable                           Default value            │
-│ Undocumented variable              Modified value           │
-│ Undocumented but modified variable (Original default value) │
-│ Unmodifiable variable                                       │
-╰─────────────────────────────────────────────────────────────╯
-Variables:
-┗━━ 📓 proxy_mode: No proxy
-
diff --git a/config/02/config.yaml b/config/02/config.yaml deleted file mode 100644 index d914488..0000000 --- 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 38b2d86..0000000 --- a/config/02/output_ro.html +++ /dev/null @@ -1,9 +0,0 @@ -
╭────────────────────────── Caption ──────────────────────────╮
-│ Variable                           Default value            │
-│ Undocumented variable              Modified value           │
-│ Undocumented but modified variable (Original default value) │
-│ Unmodifiable variable                                       │
-╰─────────────────────────────────────────────────────────────╯
-Variables:
-┗━━ 📓 proxy_mode: No proxy (No proxy)
-
diff --git a/config/03/config.yaml b/config/03/config.yaml deleted file mode 100644 index 74edb22..0000000 --- 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 675192d..0000000 --- a/config/03/output_ro.html +++ /dev/null @@ -1,9 +0,0 @@ -
╭────────────────────────── Caption ──────────────────────────╮
-│ Variable                           Default value            │
-│ Undocumented variable              Modified value           │
-│ Undocumented but modified variable (Original default value) │
-│ Unmodifiable variable                                       │
-╰─────────────────────────────────────────────────────────────╯
-Variables:
-┗━━ 📓 proxy_mode: Manual proxy configuration (No proxy)
-
diff --git a/config/04/config.yaml b/config/04/config.yaml deleted file mode 100644 index e3fa25d..0000000 --- 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 5fe2e0d..0000000 --- a/config/04/output_ro.html +++ /dev/null @@ -1,13 +0,0 @@ -
🛑 ERRORS
-┗━━ "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
-╭────────────────────────── Caption ──────────────────────────╮
-│ Variable                           Default value            │
-│ Undocumented variable              Modified value           │
-│ Undocumented but modified variable (Original default value) │
-│ Unmodifiable variable                                       │
-╰─────────────────────────────────────────────────────────────╯
-Variables:
-┗━━ 📓 proxy_mode: No proxy
-
diff --git a/config/05/config.yaml b/config/05/config.yaml deleted file mode 100644 index bf6f64c..0000000 --- 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 071b4d5..0000000 --- a/config/05/output_ro.html +++ /dev/null @@ -1,13 +0,0 @@ -
🛑 ERRORS
-┗━━ "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
-╭────────────────────────── Caption ──────────────────────────╮
-│ Variable                           Default value            │
-│ Undocumented variable              Modified value           │
-│ Undocumented but modified variable (Original default value) │
-│ Unmodifiable variable                                       │
-╰─────────────────────────────────────────────────────────────╯
-Variables:
-┗━━ 📓 proxy_mode: No proxy
-
diff --git a/firefox.png b/firefox.png index 45725ac..e40ce96 100644 Binary files a/firefox.png and b/firefox.png differ