diff --git a/README.md b/README.md index 3e562624..de16d73b 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 ... ``` @@ -60,9 +60,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 | ### Let's generate the changelog @@ -71,9 +71,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 | ## User datas @@ -91,20 +91,11 @@ rougail -m firefox/ -o doc --doc.contents changelog ```shell rougail -m firefox/ -u yaml -yf config/01/config.yml ``` -
🛑 ERRORS
-┗━━ The following variables are mandatory but have no value:
-    ┗━━ Configure Proxy Access to the Internet
-
-#### 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:
-┗━━ 📓 Configure Proxy Access to the Internet: null
+┗━━ 📓 Configure Proxy Access to the Internet: No proxy
### Example 2 @@ -120,12 +111,13 @@ proxy_mode: No proxy ```shell rougail -m firefox/ -u yaml -yf config/02/config.yml ``` -
╭───────────────────── Caption ─────────────────────╮
-│ Undocumented but modified variable Modified value │
-╰───────────────────────────────────────────────────╯
+
╭─────────────────────────── Caption ────────────────────────────╮
+│ Undocumented but modified variable Modified value              │
+│                                    (⏳ Original default value) │
+╰────────────────────────────────────────────────────────────────╯
 Variables:
 ┗━━ 📓 Configure Proxy Access to the Internet: No proxy ◀ loaded from the YAML 
-    file "config/02/config.yml"
+    file "config/02/config.yml" (⏳ No proxy)
 

 ### Example 3
 
@@ -141,13 +133,14 @@ proxy_mode: foo
 ```shell
 rougail -m firefox/ -u yaml -yf config/03/config.yml
 ```
-
╭───────────────────── Caption ─────────────────────╮
-│ Undocumented but modified variable Modified value │
-╰───────────────────────────────────────────────────╯
+
╭─────────────────────────── Caption ────────────────────────────╮
+│ Undocumented but modified variable Modified value              │
+│                                    (⏳ Original default value) │
+╰────────────────────────────────────────────────────────────────╯
 Variables:
 ┗━━ 📓 Configure Proxy Access to the Internet: foo ◀ loaded from the YAML file 
-    "config/03/config.yml"
+    "config/03/config.yml" (⏳ 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 93f7d8e7..00000000
--- 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 7ef594fb..14a4529d 100644
--- a/config/01/output_ro.html
+++ b/config/01/output_ro.html
@@ -1,4 +1,6 @@
-
🛑 ERRORS
-┗━━ The following variables are mandatory but have no value:
-    ┗━━ Configure Proxy Access to the Internet
+
╭──────────────────── Caption ─────────────────────╮
+│ Undocumented but modified variable Default value │
+╰──────────────────────────────────────────────────╯
+Variables:
+┗━━ 📓 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 4722b898..00000000
--- a/config/01/output_rw.html
+++ /dev/null
@@ -1,6 +0,0 @@
-
╭──────────────────── Caption ─────────────────────╮
-│ Undocumented but modified variable Default value │
-╰──────────────────────────────────────────────────╯
-Variables:
-┗━━ 📓 Configure Proxy Access to the Internet: null
-

diff --git a/config/02/output_ro.html b/config/02/output_ro.html
index df8b15cf..d7c9ed74 100644
--- a/config/02/output_ro.html
+++ b/config/02/output_ro.html
@@ -1,7 +1,8 @@
-
╭───────────────────── Caption ─────────────────────╮
-│ Undocumented but modified variable Modified value │
-╰───────────────────────────────────────────────────╯
+
╭─────────────────────────── Caption ────────────────────────────╮
+│ Undocumented but modified variable Modified value              │
+│                                    (⏳ Original default value) │
+╰────────────────────────────────────────────────────────────────╯
 Variables:
 ┗━━ 📓 Configure Proxy Access to the Internet: No proxy ◀ loaded from the YAML 
-    file "config/02/config.yml"
+    file "config/02/config.yml" (⏳ No proxy)
 

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

diff --git a/tree.html b/tree.html
index d3d96ddc..bb866399 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