diff --git a/README.md b/README.md index 7c05eee1..80164e63 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_003] Set a default value](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_003/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_010~1..v1.1_010)) +- [[tutorial v1.1_010] A variable with a list of possible values](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_010/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_020~1..v1.1_020)) -# [tutorial v1.1_010] A variable with a list of possible values +# [tutorial v1.1_020] Creating a new family -[Read the tutorial "A variable with a list of possible values" in the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/choice.html#a-variable-with-a-list-of-possible-values) +[Read the tutorial "Creating a new family" in the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/family.html#creating-a-new-family) ## Screenshot @@ -29,7 +29,7 @@ pip install rougail-cli rougail-output-exporter rougail-output-doc rougail-user- Then switch to the tutorial page: ```shell -git switch --detach v1.1_010 +git switch --detach v1.1_020 ``` ## Structure @@ -37,27 +37,22 @@ git switch --detach v1.1_010

-.
- └── firefox
-     └── 00-proxy.yml
+.
+ └── firefox
+     ├── 00-proxy.yml
+     └── 10-manual.yml


-Contents of the firefox/00-proxy.yml file +Contents of the firefox/10-manual.yml file ```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 +manual: + description: Manual proxy configuration + type: family ... ``` @@ -74,140 +69,6 @@ rougail -m firefox/ -o doc *** -### Let's generate the changelog - -```shell -rougail -m firefox/ -o doc --doc.contents changelog --doc.changelog.previous_json_file previous.yml -``` -#### Modified variable - -| 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 | -*** -## User datas - -### Example 1 - -#### config/01/config.yml - - -```yml ---- -``` - -*** -#### Output - -```shell -rougail -m firefox/ -u yaml -yf config/01/config.yml -``` -> [!NOTE] -> -> **Caption:** -> - Variable -> - Default value - -Variables: -- :notebook: proxy_mode (Configure Proxy Access to the Internet): No proxy - -*** -### Example 2 - -#### config/02/config.yml - - -```yml ---- -proxy_mode: No proxy -``` - -*** -#### Output - -```shell -rougail -m firefox/ -u yaml -yf config/02/config.yml -``` -> [!NOTE] -> -> **Caption:** -> - Variable -> - Modified value -> - (:hourglass_flowing_sand: Original default value) - -Variables: -- :notebook: proxy_mode (Configure Proxy Access to the Internet): No proxy ← loaded from the YAML file "config/02/config.yml" (:hourglass_flowing_sand: No proxy) - -*** -### Example 3 - -#### config/03/config.yml - - -```yml ---- -proxy_mode: Manual proxy configuration -``` - -*** -#### Output - -```shell -rougail -m firefox/ -u yaml -yf config/03/config.yml -``` -> [!NOTE] -> -> **Caption:** -> - Variable -> - Modified value -> - (:hourglass_flowing_sand: Original default value) - -Variables: -- :notebook: proxy_mode (Configure Proxy Access to the Internet): Manual proxy configuration ← loaded from the YAML file "config/03/config.yml" (:hourglass_flowing_sand: No proxy) - -*** -### Example 4 - -#### config/04/config.yml - - -```yml ---- -proxy_mode: foo -``` - -*** -#### Output - -```shell -rougail -m firefox/ -u yaml -yf config/04/config.yml -``` -> [!WARNING] -> -> - proxy_mode (Configure Proxy Access to the Internet): :bell: the value "foo" is an invalid choice, 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.yml" - -> [!NOTE] -> -> **Caption:** -> - Variable -> - Default value - -Variables: -- :notebook: proxy_mode (Configure Proxy Access to the Internet): No proxy - -*** -#### Output when invalid user data is an error - -```shell -rougail -m firefox/ -u yaml -yf config/04/config.yml --cli.invalid_user_data_error -``` -> [!CAUTION] -> -> - proxy_mode (Configure Proxy Access to the Internet): :stop_sign: the value "foo" is an invalid choice, 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 has been loading from the YAML file "config/04/config.yml" - -*** - - -- [[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)) +- [[tutorial v1.1_021] Or 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/cmd_ro.txt b/config/01/cmd_ro.txt deleted file mode 100644 index d46f9445..00000000 --- a/config/01/cmd_ro.txt +++ /dev/null @@ -1 +0,0 @@ -rougail -m firefox/ -u yaml -yf config/01/config.yml \ No newline at end of file diff --git a/config/01/config.yml b/config/01/config.yml deleted file mode 100644 index ed97d539..00000000 --- a/config/01/config.yml +++ /dev/null @@ -1 +0,0 @@ ---- diff --git a/config/01/output_ro.html b/config/01/output_ro.html deleted file mode 100644 index bb585a60..00000000 --- a/config/01/output_ro.html +++ /dev/null @@ -1,6 +0,0 @@ -
╭─────── Caption ────────╮
-│ Variable Default value │
-╰────────────────────────╯
-Variables:
-┗━━ 📓 proxy_mode (Configure Proxy Access to the Internet): No proxy
-
diff --git a/config/02/cmd_ro.txt b/config/02/cmd_ro.txt deleted file mode 100644 index 772ebbef..00000000 --- a/config/02/cmd_ro.txt +++ /dev/null @@ -1 +0,0 @@ -rougail -m firefox/ -u yaml -yf config/02/config.yml \ No newline at end of file diff --git a/config/02/config.yml b/config/02/config.yml deleted file mode 100644 index d9144882..00000000 --- a/config/02/config.yml +++ /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 c8ed2315..00000000 --- a/config/02/output_ro.html +++ /dev/null @@ -1,8 +0,0 @@ -
╭────────────── Caption ───────────────╮
-│ Variable Modified value              │
-│          (⏳ Original default value) │
-╰──────────────────────────────────────╯
-Variables:
-┗━━ 📓 proxy_mode (Configure Proxy Access to the Internet): No proxy ◀ loaded 
-    from the YAML file "config/02/config.yml" (⏳ No proxy)
-
diff --git a/config/03/cmd_ro.txt b/config/03/cmd_ro.txt deleted file mode 100644 index fc8085eb..00000000 --- a/config/03/cmd_ro.txt +++ /dev/null @@ -1 +0,0 @@ -rougail -m firefox/ -u yaml -yf config/03/config.yml \ No newline at end of file diff --git a/config/03/config.yml b/config/03/config.yml deleted file mode 100644 index 74edb225..00000000 --- a/config/03/config.yml +++ /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 352ec43e..00000000 --- a/config/03/output_ro.html +++ /dev/null @@ -1,9 +0,0 @@ -
╭────────────── Caption ───────────────╮
-│ Variable Modified value              │
-│          (⏳ Original default value) │
-╰──────────────────────────────────────╯
-Variables:
-┗━━ 📓 proxy_mode (Configure Proxy Access to the Internet): Manual proxy 
-    configuration ◀ loaded from the YAML file "config/03/config.yml" (⏳ No 
-    proxy)
-
diff --git a/config/04/cmd_invalid.txt b/config/04/cmd_invalid.txt deleted file mode 100644 index f5faec8b..00000000 --- a/config/04/cmd_invalid.txt +++ /dev/null @@ -1 +0,0 @@ -rougail -m firefox/ -u yaml -yf config/04/config.yml --cli.invalid_user_data_error \ No newline at end of file diff --git a/config/04/cmd_ro.txt b/config/04/cmd_ro.txt deleted file mode 100644 index 4d43eae1..00000000 --- a/config/04/cmd_ro.txt +++ /dev/null @@ -1 +0,0 @@ -rougail -m firefox/ -u yaml -yf config/04/config.yml \ No newline at end of file diff --git a/config/04/config.yml b/config/04/config.yml deleted file mode 100644 index e3fa25da..00000000 --- a/config/04/config.yml +++ /dev/null @@ -1,2 +0,0 @@ ---- -proxy_mode: foo diff --git a/config/04/output_invalid.html b/config/04/output_invalid.html deleted file mode 100644 index 4c586eef..00000000 --- a/config/04/output_invalid.html +++ /dev/null @@ -1,7 +0,0 @@ -
🛑 Caution
-┗━━ proxy_mode (Configure Proxy Access to the Internet): 🛑 the value "foo" is 
-    an invalid choice, 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 has been loading from
-    the YAML file "config/04/config.yml"
-
diff --git a/config/04/output_ro.html b/config/04/output_ro.html deleted file mode 100644 index cb7632b0..00000000 --- a/config/04/output_ro.html +++ /dev/null @@ -1,13 +0,0 @@ -
🔔 Warning
-┗━━ proxy_mode (Configure Proxy Access to the Internet): 🔔 the value "foo" is 
-    an invalid choice, 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.yml"
-
-╭─────── Caption ────────╮
-│ Variable Default value │
-╰────────────────────────╯
-Variables:
-┗━━ 📓 proxy_mode (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 diff --git a/tree.html b/tree.html index ef430486..ca36bb9d 100644 --- a/tree.html +++ b/tree.html @@ -1,5 +1,6 @@

-.
- └── firefox
-     └── 00-proxy.yml
+.
+ └── firefox
+     ├── 00-proxy.yml
+     └── 10-manual.yml


\ No newline at end of file