diff --git a/README.md b/README.md index d6cffd07..1b6bd069 100644 --- 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                                                                                        | Description                                                                                     | @@ -143,138 +139,6 @@ foo@bar:~$ rougail -m firefox/ -o doc | **manual.https_proxy.address**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTPS address.
**Validator**: the domain name can be an IP
**Default**: the value of the variable "manual.http_proxy.address" | | **manual.https_proxy.port**
[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTPS Port.
**Validators**:
- well-known ports (1 to 1023) are allowed
- registred ports (1024 to 49151) are allowed
- private ports (greater than 49152) are allowed
**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                                                                                            | Description                                                                                         | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **manual.https_proxy.address**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTPS address.
**Validator**: the domain name can be an IP
**Default**: the value of the variable "manual.http_proxy.address" | -| **manual.https_proxy.port**
[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTPS Port.
**Validators**:
- well-known ports (1 to 1023) are allowed
- registred ports (1024 to 49151) are allowed
- private ports (greater than 49152) are allowed
**Default**: ~~8080~~
the value of the variable "manual.http_proxy.port" | -## User datas - -### 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 -``` -
╭─────── Caption ────────╮
-│ Variable Default value │
-╰────────────────────────╯
-Variables:
-┗━━ 📓 Configure Proxy Access to the Internet: No proxy
-
-### 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 -``` -
╭────────────── Caption ───────────────╮
-│ Variable Modified value              │
-│          (⏳ Original default value) │
-╰──────────────────────────────────────╯
-Variables:
-┗━━ 📓 Configure Proxy Access to the Internet: No proxy ◀ loaded from the YAML file "config/02/config.yaml" (⏳ No proxy)
-
-### 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 -``` -
🛑 ERRORS
-┗━━ The following variables are mandatory but have no value:
-    ┗━━ Manual proxy configuration
-        ┗━━ HTTP Proxy
-            ┗━━ HTTP address
-
-### 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 -``` -
🔔 WARNINGS
-┗━━ 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 
-    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 Default value │
-╰────────────────────────╯
-Variables:
-┗━━ 📓 Configure Proxy Access to the Internet: No proxy
-
-### 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 -``` -
🔔 WARNINGS
-┗━━ 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 
-    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 Default value │
-╰────────────────────────╯
-Variables:
-┗━━ 📓 Configure Proxy Access to the Internet: No proxy
-
- - -- [[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)) +- [[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)) diff --git a/config/01/config.yaml b/config/01/config.yaml deleted file mode 100644 index ed97d539..00000000 --- a/config/01/config.yaml +++ /dev/null @@ -1 +0,0 @@ ---- diff --git a/config/01/output_ro.html b/config/01/output_ro.html deleted file mode 100644 index ea9c2266..00000000 --- a/config/01/output_ro.html +++ /dev/null @@ -1,6 +0,0 @@ -
╭─────── Caption ────────╮
-│ Variable Default value │
-╰────────────────────────╯
-Variables:
-┗━━ 📓 Configure Proxy Access to the Internet: No proxy
-
diff --git a/config/02/config.yaml b/config/02/config.yaml deleted file mode 100644 index d9144882..00000000 --- a/config/02/config.yaml +++ /dev/null @@ -1,2 +0,0 @@ ---- -proxy_mode: No proxy diff --git a/config/02/output_ro.html b/config/02/output_ro.html deleted file mode 100644 index b0153620..00000000 --- a/config/02/output_ro.html +++ /dev/null @@ -1,7 +0,0 @@ -
╭────────────── Caption ───────────────╮
-│ Variable Modified value              │
-│          (⏳ Original default value) │
-╰──────────────────────────────────────╯
-Variables:
-┗━━ 📓 Configure Proxy Access to the Internet: No proxy ◀ loaded from the YAML file "config/02/config.yaml" (⏳ No proxy)
-
diff --git a/config/03/config.yaml b/config/03/config.yaml deleted file mode 100644 index 74edb225..00000000 --- a/config/03/config.yaml +++ /dev/null @@ -1,2 +0,0 @@ ---- -proxy_mode: Manual proxy configuration diff --git a/config/03/output_ro.html b/config/03/output_ro.html deleted file mode 100644 index ec666c15..00000000 --- a/config/03/output_ro.html +++ /dev/null @@ -1,6 +0,0 @@ -
🛑 ERRORS
-┗━━ The following variables are mandatory but have no value:
-    ┗━━ Manual proxy configuration
-        ┗━━ HTTP Proxy
-            ┗━━ HTTP address
-
diff --git a/config/04/config.yaml b/config/04/config.yaml deleted file mode 100644 index e3fa25da..00000000 --- a/config/04/config.yaml +++ /dev/null @@ -1,2 +0,0 @@ ---- -proxy_mode: foo diff --git a/config/04/output_ro.html b/config/04/output_ro.html deleted file mode 100644 index 3b735cce..00000000 --- a/config/04/output_ro.html +++ /dev/null @@ -1,9 +0,0 @@ -
🔔 WARNINGS
-┗━━ 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 
-    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 Default value │
-╰────────────────────────╯
-Variables:
-┗━━ 📓 Configure Proxy Access to the Internet: No proxy
-
diff --git a/config/05/config.yaml b/config/05/config.yaml deleted file mode 100644 index bf6f64ca..00000000 --- a/config/05/config.yaml +++ /dev/null @@ -1,2 +0,0 @@ ---- -proxy_mode: 1 diff --git a/config/05/output_ro.html b/config/05/output_ro.html deleted file mode 100644 index 21c747f4..00000000 --- a/config/05/output_ro.html +++ /dev/null @@ -1,9 +0,0 @@ -
🔔 WARNINGS
-┗━━ 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 
-    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 Default value │
-╰────────────────────────╯
-Variables:
-┗━━ 📓 Configure Proxy Access to the Internet: No proxy
-