diff --git a/README.md b/README.md index 48a2e04..623bca0 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_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_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_002] Describe the variable +# [tutorial v1.1_003] Set a default value -[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_002~1..v1.1_002) +[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_003~1..v1.1_003) -[Read the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/preliminary.html#describe-the-variable) +[Read the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/preliminary.html#set-a-default-value) ## 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_002 +git switch --detach v1.1_003 ``` ## Structure @@ -39,9 +39,9 @@ git switch --detach v1.1_002

-.
- └── 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: # Configure Proxy Access to the Internet +proxy_mode: No proxy # Configure Proxy Access to the Internet ... ``` @@ -62,9 +62,9 @@ proxy_mode: # Configure Proxy Access to the Internet ```shell rougail -m firefox/ -o doc ``` -| Variable | Description | -|------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------| -| **proxy_mode**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Configure Proxy Access to the Internet. | +| Variable | Description | +|------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------| +| **proxy_mode**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Configure Proxy Access to the Internet.
**Default**: No proxy | *** @@ -75,9 +75,9 @@ rougail -m firefox/ -o doc --doc.contents changelog ``` #### Modified variable -| Variable | Description | -|------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------| -| **proxy_mode**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Configure Proxy Access to the Internet. | +| Variable | Description | +|------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------| +| **proxy_mode**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Configure Proxy Access to the Internet.
**Default**: No proxy | *** @@ -98,16 +98,6 @@ rougail -m firefox/ -o doc --doc.contents changelog ```shell rougail -m firefox/ -u yaml -yf config/01/config.yml ``` -> [!CAUTION] -> -> - proxy_mode (Configure Proxy Access to the Internet): :stop_sign: mandatory variable but has no value - -*** -#### Output in read write mode - -```shell -rougail -m firefox/ -u yaml -yf config/01/config.yml --cli.read_write -``` > [!NOTE] > > **Caption:** @@ -115,7 +105,7 @@ rougail -m firefox/ -u yaml -yf config/01/config.yml --cli.read_write > - Default value Variables: -- :notebook: proxy_mode (Configure Proxy Access to the Internet): null +- :notebook: proxy_mode (Configure Proxy Access to the Internet): No proxy *** ### Example 2 @@ -139,9 +129,10 @@ rougail -m firefox/ -u yaml -yf config/02/config.yml > **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" +- :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 @@ -165,11 +156,12 @@ rougail -m firefox/ -u yaml -yf config/03/config.yml > **Caption:** > - Variable > - Modified value +> - (:hourglass_flowing_sand: Original default value) Variables: -- :notebook: proxy_mode (Configure Proxy Access to the Internet): foo ← loaded from the YAML file "config/03/config.yml" +- :notebook: proxy_mode (Configure Proxy Access to the Internet): foo ← loaded from the YAML file "config/03/config.yml" (:hourglass_flowing_sand: No proxy) *** -- [[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)) +- [[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_010~1..v1.1_010)) diff --git a/config/01/cmd_rw.txt b/config/01/cmd_rw.txt deleted file mode 100644 index 93f7d8e..0000000 --- a/config/01/cmd_rw.txt +++ /dev/null @@ -1 +0,0 @@ -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 208adf8..bb585a6 100644 --- a/config/01/output_ro.html +++ b/config/01/output_ro.html @@ -1,4 +1,6 @@ -
🛑 Caution
-┗━━ proxy_mode (Configure Proxy Access to the Internet): 🛑 mandatory variable 
-    but has no value
+
╭─────── Caption ────────╮
+│ Variable Default value │
+╰────────────────────────╯
+Variables:
+┗━━ 📓 proxy_mode (Configure Proxy Access to the Internet): No proxy
 

diff --git a/config/01/output_rw.html b/config/01/output_rw.html
deleted file mode 100644
index 4202b84..0000000
--- a/config/01/output_rw.html
+++ /dev/null
@@ -1,9 +0,0 @@
-
> [!NOTE]
->
-> **Caption:**
-> - Variable
-> - <span style="color: #B8860B">Default value</span>
-
-Variables:
-- :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 74819b2..c8ed231 100644
--- a/config/02/output_ro.html
+++ b/config/02/output_ro.html
@@ -1,7 +1,8 @@
-
╭──────── Caption ────────╮
-│ Variable Modified value │
-╰─────────────────────────╯
+
╭────────────── 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"
+    from the YAML file "config/02/config.yml" (⏳ No proxy)
 

diff --git a/config/03/output_ro.html b/config/03/output_ro.html
index 5168726..5d88bf4 100644
--- a/config/03/output_ro.html
+++ b/config/03/output_ro.html
@@ -1,7 +1,8 @@
-
╭──────── Caption ────────╮
-│ Variable Modified value │
-╰─────────────────────────╯
+
╭────────────── Caption ───────────────╮
+│ Variable Modified value              │
+│          (⏳ Original default value) │
+╰──────────────────────────────────────╯
 Variables:
 ┗━━ 📓 proxy_mode (Configure Proxy Access to the Internet): foo ◀ loaded from 
-    the YAML file "config/03/config.yml"
+    the YAML file "config/03/config.yml" (⏳ No proxy)
 

diff --git a/tree.html b/tree.html
index 631fdc6..0fcfeac 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