[tutorial v1.1_044)] Variable type and parameters type are copied with default value (config and doc)

2025-11-07 06:16:24 +01:00 · 2025-11-07 06:16:24 +01:00 · 63a8286866
commit 63a8286866
parent ad61996eeb
11 changed files with 5 additions and 187 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 v1.1_042] A conditional hidden family with a variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_042/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_042~1..v1.1_042))
+- [[tutorial v1.1_043] A calculated default value](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_043/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_043~1..v1.1_043))
-# [tutorial v1.1_043)] A calculated default value
+# [tutorial v1.1_044)] Variable type and parameters type are copied with default value
-[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_043~1..v1.1_043)
+[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_044~1..v1.1_044)
 ## Screenshot
@ -83,15 +83,11 @@ manual:
    address:
      description: HTTPS address
      type: domainname
      params:
        allow_ip: true
      default:
        variable: __.http_proxy.address
    port:
      description: HTTPS Port
      type: port
      default:
        variable: __.http_proxy.port
 ...
@ -100,7 +96,7 @@ manual:
 ### Let's generate the documentation
 ```console
-foo@bar:~$ git switch --detach v1.1_043
+foo@bar:~$ git switch --detach v1.1_044
 foo@bar:~$ rougail -m firefox/ -o doc
 ```
 | 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;   | 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;   |
@ -143,138 +139,6 @@ foo@bar:~$ rougail -m firefox/ -o doc
 | **manual.https_proxy.address**<br/>[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory`                                                                                                                                                                                                                                                                                                                                                                                                                                        | HTTPS address.<br/>**Validator**: the domain name can be an IP<br/>**Default**: the value of the variable "manual.http_proxy.address"                                                                                                                                                                                                                                                                                                                                                                                                                         |
 | **manual.https_proxy.port**<br/>[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory`                                                                                                                                                                                                                                                                                                                                                                                                                                                 | HTTPS Port.<br/>**Validators**: <br/>- well-known ports (1 to 1023) are allowed<br/>- registred ports (1024 to 49151) are allowed<br/>- private ports (greater than 49152) are allowed<br/>**Default**: the value of the variable "manual.http_proxy.port"                                                                                                                                                                                                                                                                                                    |
 ### Let's generate the changelog
 ```console
 foo@bar:~$ git switch --detach v1.1_043
 foo@bar:~$ rougail -m firefox/ -o doc --doc.contents changelog
 ```
 #### Modified variables
 | 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;   | 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;   |
 |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
 | **manual.https_proxy.address**<br/>[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory`                                                                                                                                                                                                                                                                                                                                                                                                                                        | HTTPS address.<br/>**Validator**: the domain name can be an IP<br/>**Default**: <ins>the value of the variable "manual.http_proxy.address"</ins>                                                                                                                                                                                                                                                                                                                                                                                                              |
 | **manual.https_proxy.port**<br/>[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory`                                                                                                                                                                                                                                                                                                                                                                                                                                                 | HTTPS Port.<br/>**Validators**: <br/>- well-known ports (1 to 1023) are allowed<br/>- registred ports (1024 to 49151) are allowed<br/>- private ports (greater than 49152) are allowed<br/>**Default**: ~~8080~~<br/><ins>the value of the variable "manual.http_proxy.port"</ins>                                                                                                                                                                                                                                                                            |
-## User datas
+- [[tutorial v1.1_050] Family: a dynamic family](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_050/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_050~1..v1.1_050))
 ### Example 1
 #### config/01/config.yaml
 ```yml
 ---
 ```
 #### Output
 ```console
 foo@bar:~$ git switch --detach v1.1_043
 foo@bar:~$ rougail -m firefox/ -u yaml -ff config/01/config.yaml
 ```
 <pre>╭─────── Caption ────────╮
 │ Variable <span style="color: #ffd700">Default value</span> │
 ╰────────────────────────╯
 Variables:
 <span style="color: #5c5cff">┗━━ </span>📓 Configure Proxy Access to the Internet: <span style="color: #ffd700">No proxy</span>
 </pre>
 ### Example 2
 #### config/02/config.yaml
 ```yml
 ---
 proxy_mode: No proxy
 ```
 #### Output
 ```console
 foo@bar:~$ git switch --detach v1.1_043
 foo@bar:~$ rougail -m firefox/ -u yaml -ff config/02/config.yaml
 ```
 <pre>╭────────────── Caption ───────────────╮
 │ Variable Modified value              │
 │          (<span style="color: #00aa00">⏳ Original default value</span>) │
 ╰──────────────────────────────────────╯
 Variables:
 <span style="color: #5c5cff">┗━━ </span>📓 Configure Proxy Access to the Internet: No proxy ◀ loaded from the YAML file "config/02/config.yaml" (⏳ <span style="color: #00aa00">No proxy</span>)
 </pre>
 ### Example 3
 #### config/03/config.yaml
 ```yml
 ---
 proxy_mode: Manual proxy configuration
 ```
 #### Output
 ```console
 foo@bar:~$ git switch --detach v1.1_043
 foo@bar:~$ rougail -m firefox/ -u yaml -ff config/03/config.yaml
 ```
 <pre><span style="font-weight: bold; color: #ff0000">🛑 ERRORS</span>
 <span style="color: #ff0000">┗━━ </span>The following variables are mandatory but have no value:
 <span style="color: #ff0000">    </span><span style="color: #ff0000">┗━━ </span>Manual proxy configuration
 <span style="color: #ff0000">    </span><span style="color: #ff0000">    </span><span style="color: #ff0000">┗━━ </span>HTTP Proxy
 <span style="color: #ff0000">    </span><span style="color: #ff0000">    </span><span style="color: #ff0000">    </span><span style="color: #ff0000">┗━━ </span>HTTP address
 </pre>
 ### Example 4
 #### config/04/config.yaml
 ```yml
 ---
 proxy_mode: foo
 ```
 #### Output
 ```console
 foo@bar:~$ git switch --detach v1.1_043
 foo@bar:~$ rougail -m firefox/ -u yaml -ff config/04/config.yaml
 ```
 <pre><span style="font-weight: bold; color: #ffff00">🔔 WARNINGS</span>
 <span style="color: #ffff00">┗━━ </span>the value "foo" is an invalid choice for "proxy_mode" (Configure Proxy Access to the Internet), only "Auto-detect proxy settings for this network", "Automatic proxy configuration URL", "Manual proxy 
 <span style="color: #ffff00">    </span>configuration", "No proxy" and "Use system proxy settings" are allowed, it will be ignored when loading from the YAML file "config/04/config.yaml"
 ╭─────── Caption ────────╮
 │ Variable <span style="color: #ffd700">Default value</span> │
 ╰────────────────────────╯
 Variables:
 <span style="color: #5c5cff">┗━━ </span>📓 Configure Proxy Access to the Internet: <span style="color: #ffd700">No proxy</span>
 </pre>
 ### Example 5
 #### config/05/config.yaml
 ```yml
 ---
 proxy_mode: 1
 ```
 #### Output
 ```console
 foo@bar:~$ git switch --detach v1.1_043
 foo@bar:~$ rougail -m firefox/ -u yaml -ff config/05/config.yaml
 ```
 <pre><span style="font-weight: bold; color: #ffff00">🔔 WARNINGS</span>
 <span style="color: #ffff00">┗━━ </span>the value "1" is an invalid choice for "proxy_mode" (Configure Proxy Access to the Internet), only "Auto-detect proxy settings for this network", "Automatic proxy configuration URL", "Manual proxy 
 <span style="color: #ffff00">    </span>configuration", "No proxy" and "Use system proxy settings" are allowed, it will be ignored when loading from the YAML file "config/05/config.yaml"
 ╭─────── Caption ────────╮
 │ Variable <span style="color: #ffd700">Default value</span> │
 ╰────────────────────────╯
 Variables:
 <span style="color: #5c5cff">┗━━ </span>📓 Configure Proxy Access to the Internet: <span style="color: #ffd700">No proxy</span>
 </pre>
 - [[tutorial v1.1_044] Variable type and parameters type are copied with default value](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_044/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_044~1..v1.1_044))
--- a/config/01/config.yaml
+++ b/config/01/config.yaml
@ -1 +0,0 @@
 ---
--- a/config/01/output_ro.html
+++ b/config/01/output_ro.html
@ -1,6 +0,0 @@
 <pre>╭─────── Caption ────────╮
 │ Variable <span style="color: #ffd700">Default value</span> │
 ╰────────────────────────╯
 Variables:
 <span style="color: #5c5cff">┗━━ </span>📓 Configure Proxy Access to the Internet: <span style="color: #ffd700">No proxy</span>
 </pre>
--- a/config/02/config.yaml
+++ b/config/02/config.yaml
@ -1,2 +0,0 @@
 ---
 proxy_mode: No proxy
--- a/config/02/output_ro.html
+++ b/config/02/output_ro.html
@ -1,7 +0,0 @@
 <pre>╭────────────── Caption ───────────────╮
 │ Variable Modified value              │
 │          (<span style="color: #00aa00">⏳ Original default value</span>) │
 ╰──────────────────────────────────────╯
 Variables:
 <span style="color: #5c5cff">┗━━ </span>📓 Configure Proxy Access to the Internet: No proxy ◀ loaded from the YAML file "config/02/config.yaml" (⏳ <span style="color: #00aa00">No proxy</span>)
 </pre>
--- a/config/03/config.yaml
+++ b/config/03/config.yaml
@ -1,2 +0,0 @@
 ---
 proxy_mode: Manual proxy configuration
--- a/config/03/output_ro.html
+++ b/config/03/output_ro.html
@ -1,6 +0,0 @@
 <pre><span style="font-weight: bold; color: #ff0000">🛑 ERRORS</span>
 <span style="color: #ff0000">┗━━ </span>The following variables are mandatory but have no value:
 <span style="color: #ff0000">    </span><span style="color: #ff0000">┗━━ </span>Manual proxy configuration
 <span style="color: #ff0000">    </span><span style="color: #ff0000">    </span><span style="color: #ff0000">┗━━ </span>HTTP Proxy
 <span style="color: #ff0000">    </span><span style="color: #ff0000">    </span><span style="color: #ff0000">    </span><span style="color: #ff0000">┗━━ </span>HTTP address
 </pre>
--- a/config/04/config.yaml
+++ b/config/04/config.yaml
@ -1,2 +0,0 @@
 ---
 proxy_mode: foo
--- a/config/04/output_ro.html
+++ b/config/04/output_ro.html
@ -1,9 +0,0 @@
 <pre><span style="font-weight: bold; color: #ffff00">🔔 WARNINGS</span>
 <span style="color: #ffff00">┗━━ </span>the value "foo" is an invalid choice for "proxy_mode" (Configure Proxy Access to the Internet), only "Auto-detect proxy settings for this network", "Automatic proxy configuration URL", "Manual proxy 
 <span style="color: #ffff00">    </span>configuration", "No proxy" and "Use system proxy settings" are allowed, it will be ignored when loading from the YAML file "config/04/config.yaml"
 ╭─────── Caption ────────╮
 │ Variable <span style="color: #ffd700">Default value</span> │
 ╰────────────────────────╯
 Variables:
 <span style="color: #5c5cff">┗━━ </span>📓 Configure Proxy Access to the Internet: <span style="color: #ffd700">No proxy</span>
 </pre>
--- a/config/05/config.yaml
+++ b/config/05/config.yaml
@ -1,2 +0,0 @@
 ---
 proxy_mode: 1
--- a/config/05/output_ro.html
+++ b/config/05/output_ro.html
@ -1,9 +0,0 @@
 <pre><span style="font-weight: bold; color: #ffff00">🔔 WARNINGS</span>
 <span style="color: #ffff00">┗━━ </span>the value "1" is an invalid choice for "proxy_mode" (Configure Proxy Access to the Internet), only "Auto-detect proxy settings for this network", "Automatic proxy configuration URL", "Manual proxy 
 <span style="color: #ffff00">    </span>configuration", "No proxy" and "Use system proxy settings" are allowed, it will be ignored when loading from the YAML file "config/05/config.yaml"
 ╭─────── Caption ────────╮
 │ Variable <span style="color: #ffd700">Default value</span> │
 ╰────────────────────────╯
 Variables:
 <span style="color: #5c5cff">┗━━ </span>📓 Configure Proxy Access to the Internet: <span style="color: #ffd700">No proxy</span>
 </pre>
		`@ -1,2 +0,0 @@`
			`---`
			`proxy_mode: Manual proxy configuration`