[tutorial 023] Family type is optional (config and doc)

This commit is contained in:
egarette@silique.fr 2024-11-02 14:58:19 +01:00
parent 641a5c002c
commit aadf0f1a06
13 changed files with 36 additions and 220 deletions

148
README.md
View file

@ -1,9 +1,9 @@
- [Summary](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/branch/1.1/README.md) - [Summary](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/branch/1.1/README.md)
- [[tutorial 021] 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 022] A variable inside 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 022] A variable inside sub family # [tutorial 023] Family type is optional
[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_022~1..v1.1_022) [View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_023~1..v1.1_023)
## Screenshot ## Screenshot
@ -38,11 +38,9 @@ proxy_mode:
--- ---
manual: manual:
description: Manual proxy configuration description: Manual proxy configuration
type: family
http_proxy: http_proxy:
description: HTTP Proxy description: HTTP Proxy
type: family
address: address:
description: HTTP address description: HTTP address
@ -88,16 +86,6 @@ foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/01/config.yaml
<span style="color: #ff0000">┣━━ </span>The following variables are mandatory but have no value: <span style="color: #ff0000">┣━━ </span>The following variables are mandatory but have no value:
<span style="color: #ff0000">┗━━ </span> - manual.http_proxy.address (HTTP address) <span style="color: #ff0000">┗━━ </span> - manual.http_proxy.address (HTTP address)
</pre> </pre>
#### Output in read write mode
```console
foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/01/config.yaml --exporter.read_write
```
<pre><pre>🛑 ERRORS
<span style="color: #ff0000">┣━━ </span>The following variables are mandatory but have no value:
<span style="color: #ff0000">┗━━ </span> - manual.http_proxy.address (HTTP address)
</pre>
</pre>
### Example 2 ### Example 2
#### config/02/config.yaml #### config/02/config.yaml
@ -105,7 +93,7 @@ foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/01/config.yaml --export
```yml ```yml
--- ---
proxy_mode: Manual proxy configuration proxy_mode: No proxy
``` ```
#### Output #### Output
@ -117,16 +105,6 @@ foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/02/config.yaml
<span style="color: #ff0000">┣━━ </span>The following variables are mandatory but have no value: <span style="color: #ff0000">┣━━ </span>The following variables are mandatory but have no value:
<span style="color: #ff0000">┗━━ </span> - manual.http_proxy.address (HTTP address) <span style="color: #ff0000">┗━━ </span> - manual.http_proxy.address (HTTP address)
</pre> </pre>
#### Output in read write mode
```console
foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/02/config.yaml --exporter.read_write
```
<pre><pre>🛑 ERRORS
<span style="color: #ff0000">┣━━ </span>The following variables are mandatory but have no value:
<span style="color: #ff0000">┗━━ </span> - manual.http_proxy.address (HTTP address)
</pre>
</pre>
### Example 3 ### Example 3
#### config/03/config.yaml #### config/03/config.yaml
@ -135,9 +113,6 @@ foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/02/config.yaml --export
```yml ```yml
--- ---
proxy_mode: Manual proxy configuration proxy_mode: Manual proxy configuration
manual:
http_proxy:
address: example.net
``` ```
#### Output #### Output
@ -145,33 +120,9 @@ manual:
```console ```console
foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/03/config.yaml foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/03/config.yaml
``` ```
<pre>╭────────────────────────── Caption ──────────────────────────╮ <pre>🛑 ERRORS
│ Variable <span style="color: #ffd700">Default value</span> <span style="color: #ff0000">┣━━ </span>The following variables are mandatory but have no value:
<span style="color: #5c5cff">Undocumented variable</span> Modified value │ <span style="color: #ff0000">┗━━ </span> - manual.http_proxy.address (HTTP address)
<span style="color: #ff0000">Undocumented but modified variable</span> (<span style="color: #00aa00">Original default value</span>) │
╰─────────────────────────────────────────────────────────────╯
Variables:
<span style="color: #5c5cff">┣━━ </span>📓 proxy_mode: Manual proxy configuration (<span style="color: #00aa00">No proxy</span>)
<span style="color: #5c5cff">┗━━ </span>📂 manual
<span style="color: #5c5cff"> </span><span style="color: #5c5cff">┗━━ </span>📂 http_proxy
<span style="color: #5c5cff"> </span><span style="color: #5c5cff"> </span><span style="color: #5c5cff">┗━━ </span>📓 address: example.net
</pre>
#### Output in read write mode
```console
foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/03/config.yaml --exporter.read_write
```
<pre><pre>╭────────────────────────── Caption ──────────────────────────╮
│ Variable <span style="color: #ffd700">Default value</span>
<span style="color: #5c5cff">Undocumented variable</span> Modified value │
<span style="color: #ff0000">Undocumented but modified variable</span> (<span style="color: #00aa00">Original default value</span>) │
╰─────────────────────────────────────────────────────────────╯
Variables:
<span style="color: #5c5cff">┣━━ </span>📓 proxy_mode: Manual proxy configuration (<span style="color: #00aa00">No proxy</span>)
<span style="color: #5c5cff">┗━━ </span>📂 manual
<span style="color: #5c5cff"> </span><span style="color: #5c5cff">┗━━ </span>📂 http_proxy
<span style="color: #5c5cff"> </span><span style="color: #5c5cff"> </span><span style="color: #5c5cff">┗━━ </span>📓 address: example.net
</pre>
</pre> </pre>
### Example 4 ### Example 4
@ -180,11 +131,7 @@ Variables:
```yml ```yml
--- ---
proxy_mode: Manual proxy configuration proxy_mode: foo
manual:
http_proxy:
address: example.net
port: '3128'
``` ```
#### Output #### Output
@ -193,34 +140,11 @@ manual:
foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/04/config.yaml foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/04/config.yaml
``` ```
<pre>🛑 ERRORS <pre>🛑 ERRORS
<span style="color: #ff0000">┗━━ </span>unknown option "port" in optiondescription "manual.http_proxy" (HTTP Proxy) <span style="color: #ff0000">┣━━ </span>"foo" is an invalid choice for "proxy_mode (Configure Proxy Access to the Internet)", only
╭────────────────────────── Caption ──────────────────────────╮ <span style="color: #ff0000"></span>"Auto-detect proxy settings for this network", "Automatic proxy configuration URL", "Manual proxy
│ Variable <span style="color: #ffd700">Default value</span> <span style="color: #ff0000"></span>configuration", "No proxy" and "Use system proxy settings" are allowed
<span style="color: #5c5cff">Undocumented variable</span> Modified value │ <span style="color: #ff0000">┣━━ </span>The following variables are mandatory but have no value:
<span style="color: #ff0000">Undocumented but modified variable</span> (<span style="color: #00aa00">Original default value</span>) │ <span style="color: #ff0000">┗━━ </span> - manual.http_proxy.address (HTTP address)
╰─────────────────────────────────────────────────────────────╯
Variables:
<span style="color: #5c5cff">┣━━ </span>📓 proxy_mode: Manual proxy configuration (<span style="color: #00aa00">No proxy</span>)
<span style="color: #5c5cff">┗━━ </span>📂 manual
<span style="color: #5c5cff"> </span><span style="color: #5c5cff">┗━━ </span>📂 http_proxy
<span style="color: #5c5cff"> </span><span style="color: #5c5cff"> </span><span style="color: #5c5cff">┗━━ </span>📓 address: example.net
</pre>
#### Output in read write mode
```console
foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/04/config.yaml --exporter.read_write
```
<pre><pre>╭────────────────────────── Caption ──────────────────────────╮
│ Variable <span style="color: #ffd700">Default value</span>
<span style="color: #5c5cff">Undocumented variable</span> Modified value │
<span style="color: #ff0000">Undocumented but modified variable</span> (<span style="color: #00aa00">Original default value</span>) │
╰─────────────────────────────────────────────────────────────╯
Variables:
<span style="color: #5c5cff">┣━━ </span>📓 proxy_mode: Manual proxy configuration (<span style="color: #00aa00">No proxy</span>)
<span style="color: #5c5cff">┗━━ </span>📂 manual
<span style="color: #5c5cff"> </span><span style="color: #5c5cff">┗━━ </span>📂 http_proxy
<span style="color: #5c5cff"> </span><span style="color: #5c5cff"> </span><span style="color: #5c5cff">┗━━ </span>📓 address: example.net
</pre>
</pre> </pre>
### Example 5 ### Example 5
@ -229,14 +153,7 @@ Variables:
```yml ```yml
--- ---
proxy_mode: Manual proxy configuration proxy_mode: 1
manual:
http_proxy:
address: http.proxy.net
port: '3128'
use_for_https: false
https_proxy:
address: https.proxy.net
``` ```
#### Output #### Output
@ -245,37 +162,12 @@ manual:
foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/05/config.yaml foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/05/config.yaml
``` ```
<pre>🛑 ERRORS <pre>🛑 ERRORS
<span style="color: #ff0000">┣━━ </span>unknown option "port" in optiondescription "manual.http_proxy" (HTTP Proxy) <span style="color: #ff0000">┣━━ </span>"1" is an invalid choice for "proxy_mode (Configure Proxy Access to the Internet)", only "Auto-detect
<span style="color: #ff0000">┣━━ </span>unknown option "use_for_https" in optiondescription "manual" (Manual proxy configuration) <span style="color: #ff0000"></span>proxy settings for this network", "Automatic proxy configuration URL", "Manual proxy configuration",
<span style="color: #ff0000">┗━━ </span>unknown option "https_proxy" in optiondescription "manual" (Manual proxy configuration) <span style="color: #ff0000"></span>"No proxy" and "Use system proxy settings" are allowed
╭────────────────────────── Caption ──────────────────────────╮ <span style="color: #ff0000">┣━━ </span>The following variables are mandatory but have no value:
│ Variable <span style="color: #ffd700">Default value</span> <span style="color: #ff0000">┗━━ </span> - manual.http_proxy.address (HTTP address)
<span style="color: #5c5cff">Undocumented variable</span> Modified value │
<span style="color: #ff0000">Undocumented but modified variable</span> (<span style="color: #00aa00">Original default value</span>) │
╰─────────────────────────────────────────────────────────────╯
Variables:
<span style="color: #5c5cff">┣━━ </span>📓 proxy_mode: Manual proxy configuration (<span style="color: #00aa00">No proxy</span>)
<span style="color: #5c5cff">┗━━ </span>📂 manual
<span style="color: #5c5cff"> </span><span style="color: #5c5cff">┗━━ </span>📂 http_proxy
<span style="color: #5c5cff"> </span><span style="color: #5c5cff"> </span><span style="color: #5c5cff">┗━━ </span>📓 address: http.proxy.net
</pre>
#### Output in read write mode
```console
foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/05/config.yaml --exporter.read_write
```
<pre><pre>╭────────────────────────── Caption ──────────────────────────╮
│ Variable <span style="color: #ffd700">Default value</span>
<span style="color: #5c5cff">Undocumented variable</span> Modified value │
<span style="color: #ff0000">Undocumented but modified variable</span> (<span style="color: #00aa00">Original default value</span>) │
╰─────────────────────────────────────────────────────────────╯
Variables:
<span style="color: #5c5cff">┣━━ </span>📓 proxy_mode: Manual proxy configuration (<span style="color: #00aa00">No proxy</span>)
<span style="color: #5c5cff">┗━━ </span>📂 manual
<span style="color: #5c5cff"> </span><span style="color: #5c5cff">┗━━ </span>📂 http_proxy
<span style="color: #5c5cff"> </span><span style="color: #5c5cff"> </span><span style="color: #5c5cff">┗━━ </span>📓 address: http.proxy.net
</pre>
</pre> </pre>
- [[tutorial 023] Family type is optional](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_023/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_023~1..v1.1_023)) - [[tutorial 024] A variable with type "domainname"](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_024/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_024~1..v1.1_024))

View file

@ -1,4 +0,0 @@
<pre>🛑 ERRORS
<span style="color: #ff0000">┣━━ </span>The following variables are mandatory but have no value:
<span style="color: #ff0000">┗━━ </span> - manual.http_proxy.address (HTTP address)
</pre>

View file

@ -1,2 +1,2 @@
--- ---
proxy_mode: Manual proxy configuration proxy_mode: No proxy

View file

@ -1,4 +0,0 @@
<pre>🛑 ERRORS
<span style="color: #ff0000">┣━━ </span>The following variables are mandatory but have no value:
<span style="color: #ff0000">┗━━ </span> - manual.http_proxy.address (HTTP address)
</pre>

View file

@ -1,5 +1,2 @@
--- ---
proxy_mode: Manual proxy configuration proxy_mode: Manual proxy configuration
manual:
http_proxy:
address: example.net

View file

@ -1,11 +1,4 @@
<pre>╭────────────────────────── Caption ──────────────────────────╮ <pre>🛑 ERRORS
│ Variable <span style="color: #ffd700">Default value</span> <span style="color: #ff0000">┣━━ </span>The following variables are mandatory but have no value:
<span style="color: #5c5cff">Undocumented variable</span> Modified value │ <span style="color: #ff0000">┗━━ </span> - manual.http_proxy.address (HTTP address)
<span style="color: #ff0000">Undocumented but modified variable</span> (<span style="color: #00aa00">Original default value</span>) │
╰─────────────────────────────────────────────────────────────╯
Variables:
<span style="color: #5c5cff">┣━━ </span>📓 proxy_mode: Manual proxy configuration (<span style="color: #00aa00">No proxy</span>)
<span style="color: #5c5cff">┗━━ </span>📂 manual
<span style="color: #5c5cff"> </span><span style="color: #5c5cff">┗━━ </span>📂 http_proxy
<span style="color: #5c5cff"> </span><span style="color: #5c5cff"> </span><span style="color: #5c5cff">┗━━ </span>📓 address: example.net
</pre> </pre>

View file

@ -1,11 +0,0 @@
<pre>╭────────────────────────── Caption ──────────────────────────╮
│ Variable <span style="color: #ffd700">Default value</span>
<span style="color: #5c5cff">Undocumented variable</span> Modified value │
<span style="color: #ff0000">Undocumented but modified variable</span> (<span style="color: #00aa00">Original default value</span>) │
╰─────────────────────────────────────────────────────────────╯
Variables:
<span style="color: #5c5cff">┣━━ </span>📓 proxy_mode: Manual proxy configuration (<span style="color: #00aa00">No proxy</span>)
<span style="color: #5c5cff">┗━━ </span>📂 manual
<span style="color: #5c5cff"> </span><span style="color: #5c5cff">┗━━ </span>📂 http_proxy
<span style="color: #5c5cff"> </span><span style="color: #5c5cff"> </span><span style="color: #5c5cff">┗━━ </span>📓 address: example.net
</pre>

View file

@ -1,6 +1,2 @@
--- ---
proxy_mode: Manual proxy configuration proxy_mode: foo
manual:
http_proxy:
address: example.net
port: '3128'

View file

@ -1,13 +1,7 @@
<pre>🛑 ERRORS <pre>🛑 ERRORS
<span style="color: #ff0000">┗━━ </span>unknown option "port" in optiondescription "manual.http_proxy" (HTTP Proxy) <span style="color: #ff0000">┣━━ </span>"foo" is an invalid choice for "proxy_mode (Configure Proxy Access to the Internet)", only
╭────────────────────────── Caption ──────────────────────────╮ <span style="color: #ff0000"></span>"Auto-detect proxy settings for this network", "Automatic proxy configuration URL", "Manual proxy
│ Variable <span style="color: #ffd700">Default value</span> <span style="color: #ff0000"></span>configuration", "No proxy" and "Use system proxy settings" are allowed
<span style="color: #5c5cff">Undocumented variable</span> Modified value │ <span style="color: #ff0000">┣━━ </span>The following variables are mandatory but have no value:
<span style="color: #ff0000">Undocumented but modified variable</span> (<span style="color: #00aa00">Original default value</span>) │ <span style="color: #ff0000">┗━━ </span> - manual.http_proxy.address (HTTP address)
╰─────────────────────────────────────────────────────────────╯
Variables:
<span style="color: #5c5cff">┣━━ </span>📓 proxy_mode: Manual proxy configuration (<span style="color: #00aa00">No proxy</span>)
<span style="color: #5c5cff">┗━━ </span>📂 manual
<span style="color: #5c5cff"> </span><span style="color: #5c5cff">┗━━ </span>📂 http_proxy
<span style="color: #5c5cff"> </span><span style="color: #5c5cff"> </span><span style="color: #5c5cff">┗━━ </span>📓 address: example.net
</pre> </pre>

View file

@ -1,11 +0,0 @@
<pre>╭────────────────────────── Caption ──────────────────────────╮
│ Variable <span style="color: #ffd700">Default value</span>
<span style="color: #5c5cff">Undocumented variable</span> Modified value │
<span style="color: #ff0000">Undocumented but modified variable</span> (<span style="color: #00aa00">Original default value</span>) │
╰─────────────────────────────────────────────────────────────╯
Variables:
<span style="color: #5c5cff">┣━━ </span>📓 proxy_mode: Manual proxy configuration (<span style="color: #00aa00">No proxy</span>)
<span style="color: #5c5cff">┗━━ </span>📂 manual
<span style="color: #5c5cff"> </span><span style="color: #5c5cff">┗━━ </span>📂 http_proxy
<span style="color: #5c5cff"> </span><span style="color: #5c5cff"> </span><span style="color: #5c5cff">┗━━ </span>📓 address: example.net
</pre>

View file

@ -1,9 +1,2 @@
--- ---
proxy_mode: Manual proxy configuration proxy_mode: 1
manual:
http_proxy:
address: http.proxy.net
port: '3128'
use_for_https: false
https_proxy:
address: https.proxy.net

View file

@ -1,15 +1,7 @@
<pre>🛑 ERRORS <pre>🛑 ERRORS
<span style="color: #ff0000">┣━━ </span>unknown option "port" in optiondescription "manual.http_proxy" (HTTP Proxy) <span style="color: #ff0000">┣━━ </span>"1" is an invalid choice for "proxy_mode (Configure Proxy Access to the Internet)", only "Auto-detect
<span style="color: #ff0000">┣━━ </span>unknown option "use_for_https" in optiondescription "manual" (Manual proxy configuration) <span style="color: #ff0000"></span>proxy settings for this network", "Automatic proxy configuration URL", "Manual proxy configuration",
<span style="color: #ff0000">┗━━ </span>unknown option "https_proxy" in optiondescription "manual" (Manual proxy configuration) <span style="color: #ff0000"></span>"No proxy" and "Use system proxy settings" are allowed
╭────────────────────────── Caption ──────────────────────────╮ <span style="color: #ff0000">┣━━ </span>The following variables are mandatory but have no value:
│ Variable <span style="color: #ffd700">Default value</span> <span style="color: #ff0000">┗━━ </span> - manual.http_proxy.address (HTTP address)
<span style="color: #5c5cff">Undocumented variable</span> Modified value │
<span style="color: #ff0000">Undocumented but modified variable</span> (<span style="color: #00aa00">Original default value</span>) │
╰─────────────────────────────────────────────────────────────╯
Variables:
<span style="color: #5c5cff">┣━━ </span>📓 proxy_mode: Manual proxy configuration (<span style="color: #00aa00">No proxy</span>)
<span style="color: #5c5cff">┗━━ </span>📂 manual
<span style="color: #5c5cff"> </span><span style="color: #5c5cff">┗━━ </span>📂 http_proxy
<span style="color: #5c5cff"> </span><span style="color: #5c5cff"> </span><span style="color: #5c5cff">┗━━ </span>📓 address: http.proxy.net
</pre> </pre>

View file

@ -1,11 +0,0 @@
<pre>╭────────────────────────── Caption ──────────────────────────╮
│ Variable <span style="color: #ffd700">Default value</span>
<span style="color: #5c5cff">Undocumented variable</span> Modified value │
<span style="color: #ff0000">Undocumented but modified variable</span> (<span style="color: #00aa00">Original default value</span>) │
╰─────────────────────────────────────────────────────────────╯
Variables:
<span style="color: #5c5cff">┣━━ </span>📓 proxy_mode: Manual proxy configuration (<span style="color: #00aa00">No proxy</span>)
<span style="color: #5c5cff">┗━━ </span>📂 manual
<span style="color: #5c5cff"> </span><span style="color: #5c5cff">┗━━ </span>📂 http_proxy
<span style="color: #5c5cff"> </span><span style="color: #5c5cff"> </span><span style="color: #5c5cff">┗━━ </span>📓 address: http.proxy.net
</pre>