diff --git a/README.md b/README.md index 0a87ae6..48a2e04 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@ - [Summary](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/branch/1.1/README.md) -- [[tutorial v1.1_000] Creating a structure file](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_000/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_000~1..v1.1_000)) +- [[tutorial v1.1_001] Let’s add our first variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_001/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_001~1..v1.1_001)) -# [tutorial v1.1_001] Let’s add our first variable +# [tutorial v1.1_002] Describe the variable -[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_001~1..v1.1_001) +[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_002~1..v1.1_002) -[Read the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/preliminary.html#let-s-add-our-first-variable) +[Read the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/preliminary.html#describe-the-variable) ## Screenshot @@ -31,7 +31,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_001 +git switch --detach v1.1_002 ``` ## Structure @@ -39,9 +39,9 @@ git switch --detach v1.1_001

-.
- └── firefox
-     └── 00-proxy.yml
+.
+ └── firefox
+     └── 00-proxy.yml


Contents of the firefox/00-proxy.yml file @@ -51,7 +51,7 @@ Contents of the firefox/00-proxy.yml file --- version: 1.1 -proxy_mode: +proxy_mode: # Configure Proxy Access to the Internet ... ``` @@ -62,9 +62,9 @@ proxy_mode: ```shell rougail -m firefox/ -o doc ``` -| Variable | -|------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **proxy_mode**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | +| Variable | Description | +|------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------| +| **proxy_mode**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Configure Proxy Access to the Internet. | *** @@ -73,11 +73,11 @@ rougail -m firefox/ -o doc ```shell rougail -m firefox/ -o doc --doc.contents changelog ``` -#### New variable +#### Modified variable -| Variable | -|------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **proxy_mode**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | +| Variable | Description | +|------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------| +| **proxy_mode**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Configure Proxy Access to the Internet. | *** @@ -100,7 +100,7 @@ rougail -m firefox/ -u yaml -yf config/01/config.yml ``` > [!CAUTION] > -> - proxy_mode: :stop_sign: mandatory variable but has no value +> - proxy_mode (Configure Proxy Access to the Internet): :stop_sign: mandatory variable but has no value *** #### Output in read write mode @@ -115,7 +115,7 @@ rougail -m firefox/ -u yaml -yf config/01/config.yml --cli.read_write > - Default value Variables: -- :notebook: proxy_mode: null +- :notebook: proxy_mode (Configure Proxy Access to the Internet): null *** ### Example 2 @@ -141,7 +141,7 @@ rougail -m firefox/ -u yaml -yf config/02/config.yml > - Modified value Variables: -- :notebook: proxy_mode: No proxy ← loaded from the YAML file "config/02/config.yml" +- :notebook: proxy_mode (Configure Proxy Access to the Internet): No proxy ← loaded from the YAML file "config/02/config.yml" *** ### Example 3 @@ -151,7 +151,7 @@ Variables: ```yml --- -proxy_mode: 1 +proxy_mode: foo ``` *** @@ -160,23 +160,16 @@ proxy_mode: 1 ```shell rougail -m firefox/ -u yaml -yf config/03/config.yml ``` -> [!CAUTION] -> -> - proxy_mode -> - [#EFBF04]:bell: the value "1" is an invalid string, it's not a string, it will be ignored when loading from the YAML file "config/03/config.yml"[/#EFBF04] -> - [#C23636]:stop_sign: mandatory variable but has no value[/#C23636] +> [!NOTE] +> +> **Caption:** +> - Variable +> - Modified value -*** -#### Output when invalid user data is an error - -```shell -rougail -m firefox/ -u yaml -yf config/03/config.yml --cli.invalid_user_data_error -``` -> [!CAUTION] -> -> - proxy_mode: :stop_sign: the value "1" is an invalid string, it's not a string, it has been loading from the YAML file "config/03/config.yml" +Variables: +- :notebook: proxy_mode (Configure Proxy Access to the Internet): foo ← loaded from the YAML file "config/03/config.yml" *** -- [[tutorial v1.1_002] Describe the variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_002/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_002~1..v1.1_002)) +- [[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_003~1..v1.1_003)) diff --git a/config/01/output_ro.html b/config/01/output_ro.html index d28fe85..208adf8 100644 --- a/config/01/output_ro.html +++ b/config/01/output_ro.html @@ -1,3 +1,4 @@ 
🛑 Caution
-┗━━ proxy_mode: 🛑 mandatory variable but has no value
+┗━━ proxy_mode (Configure Proxy Access to the Internet): 🛑 mandatory variable 
+    but has no value
diff --git a/config/01/output_rw.html b/config/01/output_rw.html index 68c2795..4202b84 100644 --- a/config/01/output_rw.html +++ b/config/01/output_rw.html @@ -5,5 +5,5 @@ > - <span style="color: #B8860B">Default value</span> Variables: -- :notebook: proxy_mode: <span style="color: #B8860B">null</span> +- :notebook: proxy_mode (Configure Proxy Access to the Internet): <span style="color: #B8860B">null</span> diff --git a/config/02/output_ro.html b/config/02/output_ro.html index fd3af12..74819b2 100644 --- a/config/02/output_ro.html +++ b/config/02/output_ro.html @@ -2,5 +2,6 @@ │ Variable Modified value │ ╰─────────────────────────╯ Variables: -┗━━ 📓 proxy_mode: No proxy ◀ loaded from the YAML file "config/02/config.yml" +┗━━ 📓 proxy_mode (Configure Proxy Access to the Internet): No proxy ◀ loaded + from the YAML file "config/02/config.yml" diff --git a/config/03/cmd_invalid.txt b/config/03/cmd_invalid.txt deleted file mode 100644 index 3fe251f..0000000 --- a/config/03/cmd_invalid.txt +++ /dev/null @@ -1 +0,0 @@ -rougail -m firefox/ -u yaml -yf config/03/config.yml --cli.invalid_user_data_error \ No newline at end of file diff --git a/config/03/config.yml b/config/03/config.yml index bf6f64c..e3fa25d 100644 --- a/config/03/config.yml +++ b/config/03/config.yml @@ -1,2 +1,2 @@ --- -proxy_mode: 1 +proxy_mode: foo diff --git a/config/03/output_invalid.html b/config/03/output_invalid.html deleted file mode 100644 index c1e7b2c..0000000 --- a/config/03/output_invalid.html +++ /dev/null @@ -1,4 +0,0 @@ -
🛑 Caution
-┗━━ proxy_mode: 🛑 the value "1" is an invalid string, it's not a string, it has
-    been loading from the YAML file "config/03/config.yml"
-
diff --git a/config/03/output_ro.html b/config/03/output_ro.html index e298a88..5168726 100644 --- a/config/03/output_ro.html +++ b/config/03/output_ro.html @@ -1,6 +1,7 @@ -
🛑 Caution
-┗━━ proxy_mode
-    ┣━━ 🔔 the value "1" is an invalid string, it's not a string, it will be 
-    ┃   ignored when loading from the YAML file "config/03/config.yml"
-    ┗━━ 🛑 mandatory variable but has no value
+
╭──────── Caption ────────╮
+│ Variable Modified value │
+╰─────────────────────────╯
+Variables:
+┗━━ 📓 proxy_mode (Configure Proxy Access to the Internet): foo ◀ loaded from 
+    the YAML file "config/03/config.yml"
 

diff --git a/tree.html b/tree.html
index f271246..631fdc6 100644
--- a/tree.html
+++ b/tree.html
@@ -1,5 +1,5 @@
 

-.

-	└── firefox

-	    └── 00-proxy.yml

+.

+	└── firefox

+	    └── 00-proxy.yml

 


\ No newline at end of file