[tutorial 101] xxx (config and doc)

2024-11-02 14:59:01 +01:00 · 2024-11-02 14:59:01 +01:00 · 018faef677
commit 018faef677
parent 340118411f
4 changed files with 77 additions and 30 deletions
--- a/README.md
+++ b/README.md
@ -1,9 +1,9 @@
 - [Summary](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/branch/1.1/README.md)
- [[tutorial 092] Namespace](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_092/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_092~1..v1.1_092))
+- [[tutorial 100] xxx](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_100/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_100~1..v1.1_100))

-# [tutorial 100] xxx
+# [tutorial 101] xxx

-[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_100~1..v1.1_100)
+[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_101~1..v1.1_101)


 ## Screenshot
@ -222,6 +222,16 @@ dns_over_https:  # DNS over HTTPS

 ```yml
 ---
+proxies:
+  description: Proxy configuration
+  type: leadership
+
+  title:
+    description: Title or Description
+    mandatory: false
+
+  color:
+    description: Color

 ```
 ### Generated documentation
@ -288,6 +298,21 @@ This family builds families dynamically.
 | **firefox.dns_over_https.custom_dns_url**<br/>[`web_address`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` _`disabled`_                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           | Custom DNS URL.<br/>**Validator**: must starts with 'https://' only.<br/>**Disabled**: if "dns_over_https.provider" is not "Custom".                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |


+### Variables for "foxyproxy"
+
+#### Proxy configuration
+
+`basic`
+
+
+This family contains lists of variable blocks.
+
+| Variable&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;   | Description&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;   |
+|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| **foxyproxy.proxies.title**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple`                                                                                                                                                                                                                                                                                                                                                                                                                                                    | Title or Description.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
+| **foxyproxy.proxies.color**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory`                                                                                                                                                                                                                                                                                                                                                                                                                                                               | Color.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+
+
 ## User data

 ### Example 1
@ -315,7 +340,8 @@ Variables:
 <span style="color: #5c5cff">┃   </span><span style="color: #5c5cff">┣━━ </span>📓 proxy_mode: <span style="color: #ffd700">No proxy</span>
 <span style="color: #5c5cff">┃   </span><span style="color: #5c5cff">┗━━ </span>📂 dns_over_https
 <span style="color: #5c5cff">┃   </span><span style="color: #5c5cff">    </span><span style="color: #5c5cff">┗━━ </span>📓 enable_dns_over_https: <span style="color: #ffd700">False</span>
-<span style="color: #5c5cff">┗━━ </span>📂 <span style="color: #5c5cff">foxyproxy</span>
+<span style="color: #5c5cff">┗━━ </span>📂 foxyproxy
+<span style="color: #5c5cff">    </span><span style="color: #5c5cff">┗━━ </span>📂 proxies
 </pre>
 ### Example 2

@ -338,10 +364,8 @@ foxyproxy:
 foo@bar:~$ rougail -v 1.1 -m firefox/ -s Firefox -xn FoxyProxy -xd 0 foxyproxy/ --modes_level basic standard advanced -u file -ff config/02/config.yaml
 ```
 <pre>🛑 ERRORS
-<span style="color: #ff0000">┣━━ </span>unknown option "proxies" in optiondescription "foxyproxy" (FoxyProxy)
-<span style="color: #ff0000">┣━━ </span>unknown option "proxies" in optiondescription "foxyproxy" (FoxyProxy)
-<span style="color: #ff0000">┣━━ </span>unknown option "proxies" in optiondescription "foxyproxy" (FoxyProxy)
-<span style="color: #ff0000">┗━━ </span>unknown option "proxies" in optiondescription "foxyproxy" (FoxyProxy)
+<span style="color: #ff0000">┣━━ </span>unknown option "type" in optiondescription "foxyproxy.proxies" (Proxy configuration)
+<span style="color: #ff0000">┗━━ </span>unknown option "address" in optiondescription "foxyproxy.proxies" (Proxy configuration)
 ╭────────────────────────── Caption ──────────────────────────╮
 │ Variable                           <span style="color: #ffd700">Default value</span>            │
 │ <span style="color: #5c5cff">Undocumented variable</span>              Modified value           │
@ -353,7 +377,11 @@ Variables:
 <span style="color: #5c5cff">┃   </span><span style="color: #5c5cff">┣━━ </span>📓 proxy_mode: <span style="color: #ffd700">No proxy</span>
 <span style="color: #5c5cff">┃   </span><span style="color: #5c5cff">┗━━ </span>📂 dns_over_https
 <span style="color: #5c5cff">┃   </span><span style="color: #5c5cff">    </span><span style="color: #5c5cff">┗━━ </span>📓 enable_dns_over_https: <span style="color: #ffd700">False</span>
-<span style="color: #5c5cff">┗━━ </span>📂 <span style="color: #5c5cff">foxyproxy</span>
+<span style="color: #5c5cff">┗━━ </span>📂 foxyproxy
+<span style="color: #5c5cff">    </span><span style="color: #5c5cff">┗━━ </span>📂 proxies
+<span style="color: #5c5cff">    </span><span style="color: #5c5cff">    </span><span style="color: #5c5cff">┗━━ </span>📂 title
+<span style="color: #5c5cff">    </span><span style="color: #5c5cff">    </span><span style="color: #5c5cff">    </span><span style="color: #5c5cff">┣━━ </span>📓 title: My company
+<span style="color: #5c5cff">    </span><span style="color: #5c5cff">    </span><span style="color: #5c5cff">    </span><span style="color: #5c5cff">┗━━ </span>📓 color: #66cc66
 </pre>
 ### Example 3

@ -389,12 +417,10 @@ foxyproxy:
 foo@bar:~$ rougail -v 1.1 -m firefox/ -s Firefox -xn FoxyProxy -xd 0 foxyproxy/ --modes_level basic standard advanced -u file -ff config/03/config.yaml
 ```
 <pre>🛑 ERRORS
-<span style="color: #ff0000">┣━━ </span>unknown option "proxies" in optiondescription "foxyproxy" (FoxyProxy)
-<span style="color: #ff0000">┣━━ </span>unknown option "proxies" in optiondescription "foxyproxy" (FoxyProxy)
-<span style="color: #ff0000">┣━━ </span>unknown option "proxies" in optiondescription "foxyproxy" (FoxyProxy)
-<span style="color: #ff0000">┣━━ </span>unknown option "proxies" in optiondescription "foxyproxy" (FoxyProxy)
-<span style="color: #ff0000">┣━━ </span>unknown option "proxies" in optiondescription "foxyproxy" (FoxyProxy)
-<span style="color: #ff0000">┗━━ </span>unknown option "proxies" in optiondescription "foxyproxy" (FoxyProxy)
+<span style="color: #ff0000">┣━━ </span>unknown option "url" in optiondescription "foxyproxy.proxies" (Proxy configuration)
+<span style="color: #ff0000">┣━━ </span>unknown option "username" in optiondescription "foxyproxy.proxies" (Proxy configuration)
+<span style="color: #ff0000">┣━━ </span>unknown option "type" in optiondescription "foxyproxy.proxies" (Proxy configuration)
+<span style="color: #ff0000">┗━━ </span>unknown option "password" in optiondescription "foxyproxy.proxies" (Proxy configuration)
 ╭────────────────────────── Caption ──────────────────────────╮
 │ Variable                           <span style="color: #ffd700">Default value</span>            │
 │ <span style="color: #5c5cff">Undocumented variable</span>              Modified value           │
@ -421,8 +447,18 @@ Variables:
 <span style="color: #5c5cff">┃   </span><span style="color: #5c5cff">┣━━ </span>📓 <span style="color: #5c5cff">proxy_dns_socks5</span>: <span style="color: #ffd700">False</span>
 <span style="color: #5c5cff">┃   </span><span style="color: #5c5cff">┗━━ </span>📂 dns_over_https
 <span style="color: #5c5cff">┃   </span><span style="color: #5c5cff">    </span><span style="color: #5c5cff">┗━━ </span>📓 enable_dns_over_https: <span style="color: #ffd700">False</span>
-<span style="color: #5c5cff">┗━━ </span>📂 <span style="color: #5c5cff">foxyproxy</span>
+<span style="color: #5c5cff">┗━━ </span>📂 foxyproxy
+<span style="color: #5c5cff">    </span><span style="color: #5c5cff">┗━━ </span>📂 proxies
+<span style="color: #5c5cff">    </span><span style="color: #5c5cff">    </span><span style="color: #5c5cff">┣━━ </span>📂 title
+<span style="color: #5c5cff">    </span><span style="color: #5c5cff">    </span><span style="color: #5c5cff">┃   </span><span style="color: #5c5cff">┣━━ </span>📓 title: My company
+<span style="color: #5c5cff">    </span><span style="color: #5c5cff">    </span><span style="color: #5c5cff">┃   </span><span style="color: #5c5cff">┗━━ </span>📓 color: #66cc66
+<span style="color: #5c5cff">    </span><span style="color: #5c5cff">    </span><span style="color: #5c5cff">┣━━ </span>📂 title
+<span style="color: #5c5cff">    </span><span style="color: #5c5cff">    </span><span style="color: #5c5cff">┃   </span><span style="color: #5c5cff">┣━━ </span>📓 title: An other company
+<span style="color: #5c5cff">    </span><span style="color: #5c5cff">    </span><span style="color: #5c5cff">┃   </span><span style="color: #5c5cff">┗━━ </span>📓 color: #cc66cc
+<span style="color: #5c5cff">    </span><span style="color: #5c5cff">    </span><span style="color: #5c5cff">┗━━ </span>📂 title
+<span style="color: #5c5cff">    </span><span style="color: #5c5cff">    </span><span style="color: #5c5cff">    </span><span style="color: #5c5cff">┣━━ </span>📓 title: WPAD
+<span style="color: #5c5cff">    </span><span style="color: #5c5cff">    </span><span style="color: #5c5cff">    </span><span style="color: #5c5cff">┗━━ </span>📓 color: #1166cc
 </pre>


- [[tutorial 101] xxx](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_101/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_101~1..v1.1_101))
+- [[tutorial 102] xxx](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_102/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_102~1..v1.1_102))
--- a/config/01/output_ro.html
+++ b/config/01/output_ro.html
@ -9,5 +9,6 @@ Variables:
 <span style="color: #5c5cff">┃   </span><span style="color: #5c5cff">┣━━ </span>📓 proxy_mode: <span style="color: #ffd700">No proxy</span>
 <span style="color: #5c5cff">┃   </span><span style="color: #5c5cff">┗━━ </span>📂 dns_over_https
 <span style="color: #5c5cff">┃   </span><span style="color: #5c5cff">    </span><span style="color: #5c5cff">┗━━ </span>📓 enable_dns_over_https: <span style="color: #ffd700">False</span>
-<span style="color: #5c5cff">┗━━ </span>📂 <span style="color: #5c5cff">foxyproxy</span>
+<span style="color: #5c5cff">┗━━ </span>📂 foxyproxy
+<span style="color: #5c5cff">    </span><span style="color: #5c5cff">┗━━ </span>📂 proxies
 </pre>
--- a/config/02/output_ro.html
+++ b/config/02/output_ro.html
@ -1,8 +1,6 @@
 <pre>🛑 ERRORS
-<span style="color: #ff0000">┣━━ </span>unknown option "proxies" in optiondescription "foxyproxy" (FoxyProxy)
-<span style="color: #ff0000">┣━━ </span>unknown option "proxies" in optiondescription "foxyproxy" (FoxyProxy)
-<span style="color: #ff0000">┣━━ </span>unknown option "proxies" in optiondescription "foxyproxy" (FoxyProxy)
-<span style="color: #ff0000">┗━━ </span>unknown option "proxies" in optiondescription "foxyproxy" (FoxyProxy)
+<span style="color: #ff0000">┣━━ </span>unknown option "type" in optiondescription "foxyproxy.proxies" (Proxy configuration)
+<span style="color: #ff0000">┗━━ </span>unknown option "address" in optiondescription "foxyproxy.proxies" (Proxy configuration)
 ╭────────────────────────── Caption ──────────────────────────╮
 │ Variable                           <span style="color: #ffd700">Default value</span>            │
 │ <span style="color: #5c5cff">Undocumented variable</span>              Modified value           │
@ -14,5 +12,9 @@ Variables:
 <span style="color: #5c5cff">┃   </span><span style="color: #5c5cff">┣━━ </span>📓 proxy_mode: <span style="color: #ffd700">No proxy</span>
 <span style="color: #5c5cff">┃   </span><span style="color: #5c5cff">┗━━ </span>📂 dns_over_https
 <span style="color: #5c5cff">┃   </span><span style="color: #5c5cff">    </span><span style="color: #5c5cff">┗━━ </span>📓 enable_dns_over_https: <span style="color: #ffd700">False</span>
-<span style="color: #5c5cff">┗━━ </span>📂 <span style="color: #5c5cff">foxyproxy</span>
+<span style="color: #5c5cff">┗━━ </span>📂 foxyproxy
+<span style="color: #5c5cff">    </span><span style="color: #5c5cff">┗━━ </span>📂 proxies
+<span style="color: #5c5cff">    </span><span style="color: #5c5cff">    </span><span style="color: #5c5cff">┗━━ </span>📂 title
+<span style="color: #5c5cff">    </span><span style="color: #5c5cff">    </span><span style="color: #5c5cff">    </span><span style="color: #5c5cff">┣━━ </span>📓 title: My company
+<span style="color: #5c5cff">    </span><span style="color: #5c5cff">    </span><span style="color: #5c5cff">    </span><span style="color: #5c5cff">┗━━ </span>📓 color: #66cc66
 </pre>
--- a/config/03/output_ro.html
+++ b/config/03/output_ro.html
@ -1,10 +1,8 @@
 <pre>🛑 ERRORS
-<span style="color: #ff0000">┣━━ </span>unknown option "proxies" in optiondescription "foxyproxy" (FoxyProxy)
-<span style="color: #ff0000">┣━━ </span>unknown option "proxies" in optiondescription "foxyproxy" (FoxyProxy)
-<span style="color: #ff0000">┣━━ </span>unknown option "proxies" in optiondescription "foxyproxy" (FoxyProxy)
-<span style="color: #ff0000">┣━━ </span>unknown option "proxies" in optiondescription "foxyproxy" (FoxyProxy)
-<span style="color: #ff0000">┣━━ </span>unknown option "proxies" in optiondescription "foxyproxy" (FoxyProxy)
-<span style="color: #ff0000">┗━━ </span>unknown option "proxies" in optiondescription "foxyproxy" (FoxyProxy)
+<span style="color: #ff0000">┣━━ </span>unknown option "url" in optiondescription "foxyproxy.proxies" (Proxy configuration)
+<span style="color: #ff0000">┣━━ </span>unknown option "username" in optiondescription "foxyproxy.proxies" (Proxy configuration)
+<span style="color: #ff0000">┣━━ </span>unknown option "type" in optiondescription "foxyproxy.proxies" (Proxy configuration)
+<span style="color: #ff0000">┗━━ </span>unknown option "password" in optiondescription "foxyproxy.proxies" (Proxy configuration)
 ╭────────────────────────── Caption ──────────────────────────╮
 │ Variable                           <span style="color: #ffd700">Default value</span>            │
 │ <span style="color: #5c5cff">Undocumented variable</span>              Modified value           │
@ -31,5 +29,15 @@ Variables:
 <span style="color: #5c5cff">┃   </span><span style="color: #5c5cff">┣━━ </span>📓 <span style="color: #5c5cff">proxy_dns_socks5</span>: <span style="color: #ffd700">False</span>
 <span style="color: #5c5cff">┃   </span><span style="color: #5c5cff">┗━━ </span>📂 dns_over_https
 <span style="color: #5c5cff">┃   </span><span style="color: #5c5cff">    </span><span style="color: #5c5cff">┗━━ </span>📓 enable_dns_over_https: <span style="color: #ffd700">False</span>
-<span style="color: #5c5cff">┗━━ </span>📂 <span style="color: #5c5cff">foxyproxy</span>
+<span style="color: #5c5cff">┗━━ </span>📂 foxyproxy
+<span style="color: #5c5cff">    </span><span style="color: #5c5cff">┗━━ </span>📂 proxies
+<span style="color: #5c5cff">    </span><span style="color: #5c5cff">    </span><span style="color: #5c5cff">┣━━ </span>📂 title
+<span style="color: #5c5cff">    </span><span style="color: #5c5cff">    </span><span style="color: #5c5cff">┃   </span><span style="color: #5c5cff">┣━━ </span>📓 title: My company
+<span style="color: #5c5cff">    </span><span style="color: #5c5cff">    </span><span style="color: #5c5cff">┃   </span><span style="color: #5c5cff">┗━━ </span>📓 color: #66cc66
+<span style="color: #5c5cff">    </span><span style="color: #5c5cff">    </span><span style="color: #5c5cff">┣━━ </span>📂 title
+<span style="color: #5c5cff">    </span><span style="color: #5c5cff">    </span><span style="color: #5c5cff">┃   </span><span style="color: #5c5cff">┣━━ </span>📓 title: An other company
+<span style="color: #5c5cff">    </span><span style="color: #5c5cff">    </span><span style="color: #5c5cff">┃   </span><span style="color: #5c5cff">┗━━ </span>📓 color: #cc66cc
+<span style="color: #5c5cff">    </span><span style="color: #5c5cff">    </span><span style="color: #5c5cff">┗━━ </span>📂 title
+<span style="color: #5c5cff">    </span><span style="color: #5c5cff">    </span><span style="color: #5c5cff">    </span><span style="color: #5c5cff">┣━━ </span>📓 title: WPAD
+<span style="color: #5c5cff">    </span><span style="color: #5c5cff">    </span><span style="color: #5c5cff">    </span><span style="color: #5c5cff">┗━━ </span>📓 color: #1166cc
 </pre>