diff --git a/README.md b/README.md
index ef7f42d..bd7f7e8 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_033] A variable with type "boolean"](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_033/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_033~1..v1.1_033))
+- [[tutorial v1.1_040] HTTPS family](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_040/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_040~1..v1.1_040))
-# [tutorial v1.1_040] HTTPS family
+# [tutorial v1.1_041] A default value calculated from another variable
-[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_040~1..v1.1_040)
+[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_041~1..v1.1_041)
-[Read the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/disabled.html#https-family)
+[Read the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/disabled.html#a-default-value-calculated-from-another-variable)
## 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_040
+git switch --detach v1.1_041
```
## Structure
@@ -39,11 +39,11 @@ git switch --detach v1.1_040
-.
- └── firefox
- ├── 00-proxy.yml
- ├── 10-manual.yml
- └── 20-manual.yml
+.
+ └── firefox
+ ├── 00-proxy.yml
+ ├── 10-manual.yml
+ └── 20-manual.yml
Contents of the firefox/20-manual.yml file
@@ -61,14 +61,13 @@ manual:
address:
description: HTTPS address
- type: domainname
- params:
- allow_ip: true
+ default:
+ variable: __.http_proxy.address
port:
description: HTTPS Port
- type: port
- default: 8080
+ default:
+ variable: __.http_proxy.port
...
```
@@ -110,10 +109,10 @@ rougail -m firefox/ -o doc
>
> **Path**: manual.https_proxy
-| Variable | Description |
-|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| **manual.https_proxy.address**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTPS address.
**Validators**:
• type domainname
• the domain name can be an IP |
-| **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 |
+| Variable | Description |
+|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| **manual.https_proxy.address**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTPS address.
**Validators**:
• type domainname
• the domain name can be an IP
**Default**: the value of the variable "[HTTP address](#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 "[HTTP Port](#manual.http_proxy.port)" |
***
@@ -122,15 +121,60 @@ rougail -m firefox/ -o doc
```shell
rougail -m firefox/ -o doc --doc.contents changelog
```
-#### New variables
+#### Modified variables
-| Variable | Description |
-|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| **manual.https_proxy.address**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTPS address.
**Validators**:
• type domainname
• the domain name can be an IP |
-| **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 |
+| Variable | Description |
+|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| **manual.https_proxy.address**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTPS address.
**Validators**:
• type domainname
• the domain name can be an IP
**Default**: the value of the variable "[HTTP address](#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 "[HTTP Port](#manual.http_proxy.port)" |
+***
+## User datas
+
+### Example 1
+
+#### config/01/config.yml
+
+
+```yml
+---
+proxy_mode: Manual proxy configuration
+manual:
+ http_proxy:
+ address: http.proxy.net
+ port: 3128
+ use_for_https: false
+ https_proxy:
+ address: https.proxy.net
+```
+
+***
+#### Output
+
+```shell
+rougail -m firefox/ -u yaml -yf config/01/config.yml
+```
+> [!NOTE]
+>
+> **Caption:**
+> - Variable
+> - Default value
+> - Modified value
+> - (:hourglass_flowing_sand: Original default value)
+
+Variables:
+- :notebook: proxy_mode (Configure Proxy Access to the Internet): Manual proxy configuration ← loaded from the YAML file "config/01/config.yml" (:hourglass_flowing_sand: No proxy)
+- :open_file_folder: manual (Manual proxy configuration)
+ - :open_file_folder: http_proxy (HTTP Proxy)
+ - :notebook: address (HTTP address): http.proxy.net ← loaded from the YAML file "config/01/config.yml"
+ - :notebook: port (HTTP Port): 3128 ← loaded from the YAML file "config/01/config.yml" (:hourglass_flowing_sand: 8080)
+ - :notebook: use_for_https (Also use this proxy for HTTPS): false ← loaded from the YAML file "config/01/config.yml" (:hourglass_flowing_sand: true)
+ - :open_file_folder: https_proxy (HTTPS Proxy)
+ - :notebook: address (HTTPS address): https.proxy.net ← loaded from the YAML file "config/01/config.yml" (:hourglass_flowing_sand: http.proxy.net)
+ - :notebook: port (HTTPS Port): 3128
+
***
-- [[tutorial v1.1_041] A default value calculated from another variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_041/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_041~1..v1.1_041))
+- [[tutorial v1.1_050] A disabled 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/cmd_ro.txt b/config/01/cmd_ro.txt
new file mode 100644
index 0000000..d46f944
--- /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 0000000..84547fa
--- /dev/null
+++ b/config/01/config.yml
@@ -0,0 +1,9 @@
+---
+proxy_mode: Manual proxy configuration
+manual:
+ http_proxy:
+ address: http.proxy.net
+ port: 3128
+ use_for_https: false
+ https_proxy:
+ address: https.proxy.net
diff --git a/config/01/output_ro.html b/config/01/output_ro.html
new file mode 100644
index 0000000..91925d4
--- /dev/null
+++ b/config/01/output_ro.html
@@ -0,0 +1,22 @@
+╭────────────── Caption ───────────────╮
+│ Variable Default value │
+│ Modified value │
+│ (⏳ Original default value) │
+╰──────────────────────────────────────╯
+Variables:
+┣━━ 📓 proxy_mode (Configure Proxy Access to the Internet): Manual proxy
+┃ configuration ◀ loaded from the YAML file "config/01/config.yml" (⏳ No
+┃ proxy)
+┗━━ 📂 manual (Manual proxy configuration)
+ ┣━━ 📂 http_proxy (HTTP Proxy)
+ ┃ ┣━━ 📓 address (HTTP address): http.proxy.net ◀ loaded from the YAML
+ ┃ ┃ file "config/01/config.yml"
+ ┃ ┗━━ 📓 port (HTTP Port): 3128 ◀ loaded from the YAML file
+ ┃ "config/01/config.yml" (⏳ 8080)
+ ┣━━ 📓 use_for_https (Also use this proxy for HTTPS): false ◀ loaded from
+ ┃ the YAML file "config/01/config.yml" (⏳ true)
+ ┗━━ 📂 https_proxy (HTTPS Proxy)
+ ┣━━ 📓 address (HTTPS address): https.proxy.net ◀ loaded from the YAML
+ ┃ file "config/01/config.yml" (⏳ http.proxy.net)
+ ┗━━ 📓 port (HTTPS Port): 3128
+
diff --git a/tree.html b/tree.html
index c80855e..045be44 100644
--- a/tree.html
+++ b/tree.html
@@ -1,7 +1,7 @@
-.
- └── firefox
- ├── 00-proxy.yml
- ├── 10-manual.yml
- └── 20-manual.yml
+.
+ └── firefox
+ ├── 00-proxy.yml
+ ├── 10-manual.yml
+ └── 20-manual.yml
\ No newline at end of file