diff --git a/README.md b/README.md index e74390f3..5faf3926 100644 --- a/README.md +++ b/README.md @@ -1,10 +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_000] Creating a structure file +# [tutorial v1.1_001] Let’s add our first variable -[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_000~1..v1.1_000) +[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_001~1..v1.1_001) -[Read the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/preliminary.html#creating-a-structure-file) +[Read the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/preliminary.html#let-s-add-our-first-variable) ## Screenshot @@ -30,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_000 +git switch --detach v1.1_001 ``` ## Structure @@ -38,9 +39,9 @@ git switch --detach v1.1_000

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


Contents of the firefox/00-proxy.yml file @@ -49,9 +50,32 @@ Contents of the firefox/00-proxy.yml file %YAML 1.2 --- version: 1.1 + +proxy_mode: ... ``` +### Let's generate the documentation + +```shell +rougail -m firefox/ -o doc +``` +| Variable | +|------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **proxy_mode**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | + +### Let's generate the changelog + +```shell +rougail -m firefox/ -o doc --doc.contents changelog +``` +#### New variable + +| Variable | +|------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **proxy_mode**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | + + ## User datas ### Example 1 @@ -67,7 +91,71 @@ version: 1.1 ```shell rougail -m firefox/ -u yaml -yf config/01/config.yml ``` -

+
🛑 ERRORS
+┗━━ The following variables are mandatory but have no value:
+    ┗━━ proxy_mode
+
+#### Output in read write mode + +```shell +rougail -m firefox/ -u yaml -yf config/01/config.yml --cli.read_write +``` +
╭──────────────────── Caption ─────────────────────╮
+│ Undocumented but modified variable Default value │
+╰──────────────────────────────────────────────────╯
+Variables:
+┗━━ 📓 proxy_mode: null
+
+### Example 2 + +#### config/02/config.yml -- [[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)) +```yml +--- +proxy_mode: No proxy +``` +#### Output + +```shell +rougail -m firefox/ -u yaml -yf config/02/config.yml +``` +
╭───────────────────── Caption ─────────────────────╮
+│ Undocumented but modified variable Modified value │
+╰───────────────────────────────────────────────────╯
+Variables:
+┗━━ 📓 proxy_mode: No proxy ◀ loaded from the YAML file "config/02/config.yml"
+
+### Example 3 + +#### config/03/config.yml + + +```yml +--- +proxy_mode: 1 +``` +#### Output + +```shell +rougail -m firefox/ -u yaml -yf config/03/config.yml +``` +
🔔 WARNINGS
+┗━━ the value "1" is an invalid string for "proxy_mode", which is not a string, 
+    it will be ignored when loading from the YAML file "config/03/config.yml"
+🛑 ERRORS
+┗━━ The following variables are mandatory but have no value:
+    ┗━━ proxy_mode
+
+#### Output when invalid user datas is an error + +```shell +rougail -m firefox/ -u yaml -yf config/03/config.yml --cli.invalid_user_datas_error +``` +
🛑 ERRORS
+┗━━ the value "1" is an invalid string for "proxy_mode", which is not a string, 
+    it will be ignored when loading 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)) diff --git a/config/01/cmd_rw.txt b/config/01/cmd_rw.txt new file mode 100644 index 00000000..93f7d8e7 --- /dev/null +++ b/config/01/cmd_rw.txt @@ -0,0 +1 @@ +rougail -m firefox/ -u yaml -yf config/01/config.yml --cli.read_write \ No newline at end of file diff --git a/config/01/output_ro.html b/config/01/output_ro.html index 24ce0202..45f12184 100644 --- a/config/01/output_ro.html +++ b/config/01/output_ro.html @@ -1 +1,4 @@ -

+
🛑 ERRORS
+┗━━ The following variables are mandatory but have no value:
+    ┗━━ proxy_mode
+
diff --git a/config/01/output_rw.html b/config/01/output_rw.html new file mode 100644 index 00000000..9446addf --- /dev/null +++ b/config/01/output_rw.html @@ -0,0 +1,6 @@ +
╭──────────────────── Caption ─────────────────────╮
+│ Undocumented but modified variable Default value │
+╰──────────────────────────────────────────────────╯
+Variables:
+┗━━ 📓 proxy_mode: null
+
diff --git a/config/02/cmd_ro.txt b/config/02/cmd_ro.txt new file mode 100644 index 00000000..772ebbef --- /dev/null +++ b/config/02/cmd_ro.txt @@ -0,0 +1 @@ +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 new file mode 100644 index 00000000..d9144882 --- /dev/null +++ b/config/02/config.yml @@ -0,0 +1,2 @@ +--- +proxy_mode: No proxy diff --git a/config/02/output_ro.html b/config/02/output_ro.html new file mode 100644 index 00000000..e479e89e --- /dev/null +++ b/config/02/output_ro.html @@ -0,0 +1,6 @@ +
╭───────────────────── Caption ─────────────────────╮
+│ Undocumented but modified variable Modified value │
+╰───────────────────────────────────────────────────╯
+Variables:
+┗━━ 📓 proxy_mode: 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 new file mode 100644 index 00000000..ffde9149 --- /dev/null +++ b/config/03/cmd_invalid.txt @@ -0,0 +1 @@ +rougail -m firefox/ -u yaml -yf config/03/config.yml --cli.invalid_user_datas_error \ No newline at end of file diff --git a/config/03/cmd_ro.txt b/config/03/cmd_ro.txt new file mode 100644 index 00000000..fc8085eb --- /dev/null +++ b/config/03/cmd_ro.txt @@ -0,0 +1 @@ +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 new file mode 100644 index 00000000..bf6f64ca --- /dev/null +++ b/config/03/config.yml @@ -0,0 +1,2 @@ +--- +proxy_mode: 1 diff --git a/config/03/output_invalid.html b/config/03/output_invalid.html new file mode 100644 index 00000000..a063bf90 --- /dev/null +++ b/config/03/output_invalid.html @@ -0,0 +1,4 @@ +
🛑 ERRORS
+┗━━ the value "1" is an invalid string for "proxy_mode", which is not a string, 
+    it will be ignored when loading from the YAML file "config/03/config.yml"
+
diff --git a/config/03/output_ro.html b/config/03/output_ro.html new file mode 100644 index 00000000..e1b29bf8 --- /dev/null +++ b/config/03/output_ro.html @@ -0,0 +1,7 @@ +
🔔 WARNINGS
+┗━━ the value "1" is an invalid string for "proxy_mode", which is not a string, 
+    it will be ignored when loading from the YAML file "config/03/config.yml"
+🛑 ERRORS
+┗━━ The following variables are mandatory but have no value:
+    ┗━━ proxy_mode
+
diff --git a/firefox.png b/firefox.png index 050f837f..45725ac6 100644 Binary files a/firefox.png and b/firefox.png differ diff --git a/tree.html b/tree.html index 5ca2bf3e..a747e45f 100644 --- a/tree.html +++ b/tree.html @@ -25,9 +25,9 @@

Directory Tree

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


2 directories, 1 file