diff --git a/README.md b/README.md index bb75f6c0..86353a73 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 ... ``` @@ -69,6 +69,113 @@ 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 + +> **🛈 Informations** +> +> **Path**: manual + +##### HTTP Proxy + +> **🛈 Informations** +> +> **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. | -- [[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)) +## User datas + +### Example 1 + +#### config/01/config.yml + + +```yml +--- +``` +#### Output + +```shell +rougail -m firefox/ -u yaml -yf config/01/config.yml +``` +
🛑 ERRORS
+┗━━ The following variables are mandatory but have no value:
+    ┗━━ Manual proxy configuration
+        ┗━━ HTTP Proxy
+            ┗━━ HTTP address
+
+### 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 +``` +
╭───────────────────── Caption ─────────────────────╮
+│ Variable                           Default value  │
+│ Undocumented but modified variable Modified value │
+╰───────────────────────────────────────────────────╯
+Variables:
+┣━━ 📓 Configure Proxy Access to the Internet: No proxy
+┗━━ 📂 Manual proxy configuration
+    ┗━━ 📂 HTTP Proxy
+        ┗━━ 📓 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 +``` +
🔔 WARNINGS
+┗━━ 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  │
+│ Undocumented but modified variable Modified value │
+╰───────────────────────────────────────────────────╯
+Variables:
+┣━━ 📓 Configure Proxy Access to the Internet: No proxy
+┗━━ 📂 Manual proxy configuration
+    ┗━━ 📂 HTTP Proxy
+        ┗━━ 📓 HTTP address: example.net ◀ loaded from the YAML file 
+            "config/03/config.yml"
+
+ + +- [[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 00000000..d46f9445 --- /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 00000000..ed97d539 --- /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 00000000..ec666c15 --- /dev/null +++ b/config/01/output_ro.html @@ -0,0 +1,6 @@ +
🛑 ERRORS
+┗━━ The following variables are mandatory but have no value:
+    ┗━━ Manual proxy configuration
+        ┗━━ HTTP Proxy
+            ┗━━ HTTP address
+
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..22422a2f --- /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 00000000..2449b1c8 --- /dev/null +++ b/config/02/output_ro.html @@ -0,0 +1,11 @@ +
╭───────────────────── Caption ─────────────────────╮
+│ Variable                           Default value  │
+│ Undocumented but modified variable Modified value │
+╰───────────────────────────────────────────────────╯
+Variables:
+┣━━ 📓 Configure Proxy Access to the Internet: No proxy
+┗━━ 📂 Manual proxy configuration
+    ┗━━ 📂 HTTP Proxy
+        ┗━━ 📓 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 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..da3353ac --- /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 00000000..10421283 --- /dev/null +++ b/config/03/output_ro.html @@ -0,0 +1,14 @@ +
🔔 WARNINGS
+┗━━ 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  │
+│ Undocumented but modified variable Modified value │
+╰───────────────────────────────────────────────────╯
+Variables:
+┣━━ 📓 Configure Proxy Access to the Internet: No proxy
+┗━━ 📂 Manual proxy configuration
+    ┗━━ 📂 HTTP Proxy
+        ┗━━ 📓 HTTP address: example.net ◀ loaded from the YAML file 
+            "config/03/config.yml"
+
diff --git a/tree.html b/tree.html index ecb6b46e..a040cdf7 100644 --- a/tree.html +++ b/tree.html @@ -25,10 +25,10 @@

Directory Tree

- .
- └── firefox
-     ├── 00-proxy.yml
-     └── 10-manual.yml
+ .
+ └── firefox
+     ├── 00-proxy.yml
+     └── 10-manual.yml


2 directories, 2 files