diff --git a/README.md b/README.md
index e919111..96c280a 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_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))
-# [tutorial v1.1_021] Or a sub family
+# [tutorial v1.1_022] Putting a variable inside of a family or a sub family
-[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_021~1..v1.1_021)
+[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_022~1..v1.1_022)
-[Read the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/proxymode.html#or-a-sub-family)
+[Read the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/proxymode.html#putting-a-variable-inside-of-a-family-or-a-sub-family)
## 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_021
+git switch --detach v1.1_022
```
## Structure
@@ -39,10 +39,10 @@ git switch --detach v1.1_021
-.
- └── firefox
- ├── 00-proxy.yml
- └── 10-manual.yml
+.
+ └── firefox
+ ├── 00-proxy.yml
+ └── 10-manual.yml
Contents of the firefox/10-manual.yml file
@@ -54,9 +54,9 @@ version: 1.1
manual: # Manual proxy configuration
- http_proxy:
- description: HTTP Proxy
- type: family
+ http_proxy: # HTTP Proxy
+
+ address: # HTTP address
...
```
@@ -71,8 +71,130 @@ rougail -m firefox/ -o doc
|------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **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 |
+#### Manual proxy configuration
+
+> [!NOTE]
+>
+> **Path**: manual
+
+##### HTTP Proxy
+
+> [!NOTE]
+>
+> **Path**: manual.http_proxy
+
+| Variable | Description |
+|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------|
+| **manual.http_proxy.address**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTP address. |
+
+
+***
+### Let's generate the changelog
+
+```shell
+rougail -m firefox/ -o doc --doc.contents changelog
+```
+#### New variable
+
+| Variable | Description |
+|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------|
+| **manual.http_proxy.address**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTP address. |
+
+
+***
+## User datas
+
+### Example 1
+
+#### config/01/config.yml
+
+
+```yml
+---
+```
+
+***
+#### Output
+
+```shell
+rougail -m firefox/ -u yaml -yf config/01/config.yml
+```
+> [!CAUTION]
+>
+> - manual (Manual proxy configuration)
+> - http_proxy (HTTP Proxy)
+> - address (HTTP address): :stop_sign: mandatory variable but has no value
+
+***
+### Example 2
+
+#### config/02/config.yml
+
+
+```yml
+---
+manual:
+ http_proxy:
+ address: example.net
+```
+
+***
+#### Output
+
+```shell
+rougail -m firefox/ -u yaml -yf config/02/config.yml
+```
+> [!NOTE]
+>
+> **Caption:**
+> - Variable
+> - Default value
+> - Modified value
+
+Variables:
+- :notebook: proxy_mode (Configure Proxy Access to the Internet): No proxy
+- :open_file_folder: manual (Manual proxy configuration)
+ - :open_file_folder: http_proxy (HTTP Proxy)
+ - :notebook: address (HTTP address): example.net ← loaded from the YAML file "config/02/config.yml"
+
+***
+### Example 3
+
+#### config/03/config.yml
+
+
+```yml
+---
+manual:
+ http_proxy:
+ address: example.net
+ port: 3128
+```
+
+***
+#### Output
+
+```shell
+rougail -m firefox/ -u yaml -yf config/03/config.yml
+```
+> [!WARNING]
+>
+> - variable or family "manual.http_proxy.port" does not exist, it will be ignored when loading from the YAML file "config/03/config.yml"
+
+> [!NOTE]
+>
+> **Caption:**
+> - Variable
+> - Default value
+> - Modified value
+
+Variables:
+- :notebook: proxy_mode (Configure Proxy Access to the Internet): No proxy
+- :open_file_folder: manual (Manual proxy configuration)
+ - :open_file_folder: http_proxy (HTTP Proxy)
+ - :notebook: address (HTTP address): example.net ← loaded from the YAML file "config/03/config.yml"
***
-- [[tutorial v1.1_022] Putting a variable inside of a family or a sub family](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_022/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_022~1..v1.1_022))
+- [[tutorial v1.1_030] A variable with type "domainname"](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_030/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_030~1..v1.1_030))
diff --git a/config/01/cmd_ro.txt b/config/01/cmd_ro.txt
new file mode 100644
index 0000000..d46f944
--- /dev/null
+++ b/config/01/cmd_ro.txt
@@ -0,0 +1 @@
+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
new file mode 100644
index 0000000..ed97d53
--- /dev/null
+++ b/config/01/config.yml
@@ -0,0 +1 @@
+---
diff --git a/config/01/output_ro.html b/config/01/output_ro.html
new file mode 100644
index 0000000..cafcfd3
--- /dev/null
+++ b/config/01/output_ro.html
@@ -0,0 +1,5 @@
+🛑 Caution
+┗━━ manual (Manual proxy configuration)
+ ┗━━ http_proxy (HTTP Proxy)
+ ┗━━ address (HTTP address): 🛑 mandatory variable but has no value
+
diff --git a/config/02/cmd_ro.txt b/config/02/cmd_ro.txt
new file mode 100644
index 0000000..772ebbe
--- /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 0000000..22422a2
--- /dev/null
+++ b/config/02/config.yml
@@ -0,0 +1,4 @@
+---
+manual:
+ http_proxy:
+ address: example.net
diff --git a/config/02/output_ro.html b/config/02/output_ro.html
new file mode 100644
index 0000000..f22f0f2
--- /dev/null
+++ b/config/02/output_ro.html
@@ -0,0 +1,11 @@
+╭──────── Caption ────────╮
+│ Variable Default value │
+│ Modified value │
+╰─────────────────────────╯
+Variables:
+┣━━ 📓 proxy_mode (Configure Proxy Access to the Internet): No proxy
+┗━━ 📂 manual (Manual proxy configuration)
+ ┗━━ 📂 http_proxy (HTTP Proxy)
+ ┗━━ 📓 address (HTTP address): example.net ◀ loaded from the YAML file
+ "config/02/config.yml"
+
diff --git a/config/03/cmd_ro.txt b/config/03/cmd_ro.txt
new file mode 100644
index 0000000..fc8085e
--- /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 0000000..da3353a
--- /dev/null
+++ b/config/03/config.yml
@@ -0,0 +1,5 @@
+---
+manual:
+ http_proxy:
+ address: example.net
+ port: 3128
diff --git a/config/03/output_ro.html b/config/03/output_ro.html
new file mode 100644
index 0000000..4b02f87
--- /dev/null
+++ b/config/03/output_ro.html
@@ -0,0 +1,15 @@
+🔔 Warning
+┗━━ variable or family "manual.http_proxy.port" does not exist, it will be
+ ignored when loading from the YAML file "config/03/config.yml"
+
+╭──────── Caption ────────╮
+│ Variable Default value │
+│ Modified value │
+╰─────────────────────────╯
+Variables:
+┣━━ 📓 proxy_mode (Configure Proxy Access to the Internet): No proxy
+┗━━ 📂 manual (Manual proxy configuration)
+ ┗━━ 📂 http_proxy (HTTP Proxy)
+ ┗━━ 📓 address (HTTP address): example.net ◀ loaded from the YAML file
+ "config/03/config.yml"
+
diff --git a/tree.html b/tree.html
index 0afc2d3..35f3a78 100644
--- a/tree.html
+++ b/tree.html
@@ -1,6 +1,6 @@
-.
- └── firefox
- ├── 00-proxy.yml
- └── 10-manual.yml
+.
+ └── firefox
+ ├── 00-proxy.yml
+ └── 10-manual.yml
\ No newline at end of file