diff --git a/README.md b/README.md
index bd7f7e8..c1ad121 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_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_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_041] A default value calculated from another variable
+# [tutorial v1.1_050] A disabled family
-[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_041~1..v1.1_041)
+[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_050~1..v1.1_050)
-[Read the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/disabled.html#a-default-value-calculated-from-another-variable)
+[Read the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/disabled.html#a-disabled-family)
## 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_041
+git switch --detach v1.1_050
```
## Structure
@@ -39,14 +39,14 @@ git switch --detach v1.1_041
-.
- └── 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
+Contents of the firefox/10-manual.yml file
```yml
%YAML 1.2
@@ -54,20 +54,21 @@ Contents of the firefox/20-manual.yml file
version: 1.1
manual:
+ description: Manual proxy configuration
+ disabled: true
- use_for_https: true # Also use this proxy for HTTPS
-
- https_proxy: # HTTPS Proxy
+ http_proxy: # HTTP Proxy
address:
- description: HTTPS address
- default:
- variable: __.http_proxy.address
+ description: HTTP address
+ type: domainname
+ params:
+ allow_ip: true
port:
- description: HTTPS Port
- default:
- variable: __.http_proxy.port
+ description: HTTP Port
+ type: port
+ default: 8080
...
```
@@ -82,38 +83,6 @@ rougail -m firefox/ -o doc
|------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **proxy_mode**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Configure Proxy Access to the Internet.
**Choices**:
• No proxy **← (default)**
• Auto-detect proxy settings for this network
• Use system proxy settings
• Manual proxy configuration
• Automatic proxy configuration URL |
-#### Manual proxy configuration
-
-> [!NOTE]
->
-> **Path**: manual
-
-##### HTTP Proxy
-
-> [!NOTE]
->
-> **Path**: manual.http_proxy
-
-| Variable | Description |
-|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| **manual.http_proxy.address**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTP address.
**Validators**:
• type domainname
• the domain name can be an IP |
-| **manual.http_proxy.port**
[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTP 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.use_for_https**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Also use this proxy for HTTPS.
**Default**: true |
-
-##### HTTPS Proxy
-
-> [!NOTE]
->
-> **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
**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)" |
-
***
### Let's generate the changelog
@@ -121,14 +90,14 @@ rougail -m firefox/ -o doc
```shell
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.
**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)" |
+#### Deleted variables
+- manual.http_proxy.address
+- manual.http_proxy.port
+- manual.use_for_https
+- manual.https_proxy.address
+- manual.https_proxy.port
***
## User datas
@@ -139,14 +108,6 @@ rougail -m firefox/ -o doc --doc.contents changelog
```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
```
***
@@ -160,21 +121,65 @@ rougail -m firefox/ -u yaml -yf config/01/config.yml
> **Caption:**
> - Variable
> - Default value
+
+Variables:
+- :notebook: proxy_mode (Configure Proxy Access to the Internet): No proxy
+
+***
+### Example 2
+
+#### config/02/config.yml
+
+
+```yml
+---
+proxy_mode: Manual proxy configuration
+manual:
+ http_proxy:
+ address: http.proxy.net
+ port: 3128
+ use_for_https: false
+```
+
+***
+#### Output
+
+```shell
+rougail -m firefox/ -u yaml -yf config/02/config.yml
+```
+> [!WARNING]
+>
+> - manual (Manual proxy configuration)
+> - http_proxy (HTTP Proxy)
+> - address (HTTP address): :bell: family "manual" (Manual proxy configuration) has property disabled, so cannot access to "address" (HTTP address), it will be ignored when loading from the YAML file "config/02/config.yml"
+> - port (HTTP Port): :bell: family "manual" (Manual proxy configuration) has property disabled, so cannot access to "port" (HTTP Port), it will be ignored when loading from the YAML file "config/02/config.yml"
+> - use_for_https (Also use this proxy for HTTPS): :bell: family "manual" (Manual proxy configuration) has property disabled, so cannot access to "use_for_https" (Also use this proxy for HTTPS), it will be ignored when loading from the YAML file "config/02/config.yml"
+
+> [!NOTE]
+>
+> **Caption:**
+> - Variable
> - 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
+- :notebook: proxy_mode (Configure Proxy Access to the Internet): Manual proxy configuration ← loaded from the YAML file "config/02/config.yml" (:hourglass_flowing_sand: No proxy)
+
+***
+#### Output when unknown user data is an error
+
+```shell
+rougail -m firefox/ -u yaml -yf config/02/config.yml --cli.unknown_user_data_error
+```
+> [!CAUTION]
+>
+> - manual (Manual proxy configuration)
+> - http_proxy (HTTP Proxy)
+> - address (HTTP address): :stop_sign: family "manual" (Manual proxy configuration) has property disabled, so cannot access to "address" (HTTP address), it has been loading from the YAML file "config/02/config.yml"
+> - port (HTTP Port): :stop_sign: family "manual" (Manual proxy configuration) has property disabled, so cannot access to "port" (HTTP Port), it has been loading from the YAML file "config/02/config.yml"
+> - use_for_https (Also use this proxy for HTTPS): :stop_sign: family "manual" (Manual proxy configuration) has property disabled, so cannot access to "use_for_https" (Also use this proxy for HTTPS), it has been loading from the YAML file "config/02/config.yml"
***
-- [[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))
+- [[tutorial v1.1_051] A conditional disabled family](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_051/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_051~1..v1.1_051))
diff --git a/config/01/config.yml b/config/01/config.yml
index 84547fa..ed97d53 100644
--- a/config/01/config.yml
+++ b/config/01/config.yml
@@ -1,9 +1 @@
---
-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
index 91925d4..bb585a6 100644
--- a/config/01/output_ro.html
+++ b/config/01/output_ro.html
@@ -1,22 +1,6 @@
-╭────────────── Caption ───────────────╮
-│ Variable Default value │
-│ Modified value │
-│ (⏳ Original default value) │
-╰──────────────────────────────────────╯
+╭─────── Caption ────────╮
+│ Variable 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
+┗━━ 📓 proxy_mode (Configure Proxy Access to the Internet): No proxy
diff --git a/config/02/cmd_ro.txt b/config/02/cmd_ro.txt
new file mode 100644
index 0000000..772ebbe
--- /dev/null
+++ b/config/02/cmd_ro.txt
@@ -0,0 +1 @@
+rougail -m firefox/ -u yaml -yf config/02/config.yml
\ No newline at end of file
diff --git a/config/02/cmd_unknown.txt b/config/02/cmd_unknown.txt
new file mode 100644
index 0000000..e3d1320
--- /dev/null
+++ b/config/02/cmd_unknown.txt
@@ -0,0 +1 @@
+rougail -m firefox/ -u yaml -yf config/02/config.yml --cli.unknown_user_data_error
\ No newline at end of file
diff --git a/config/02/config.yml b/config/02/config.yml
new file mode 100644
index 0000000..9b246a4
--- /dev/null
+++ b/config/02/config.yml
@@ -0,0 +1,7 @@
+---
+proxy_mode: Manual proxy configuration
+manual:
+ http_proxy:
+ address: http.proxy.net
+ port: 3128
+ use_for_https: false
diff --git a/config/02/output_ro.html b/config/02/output_ro.html
new file mode 100644
index 0000000..8a5e02b
--- /dev/null
+++ b/config/02/output_ro.html
@@ -0,0 +1,25 @@
+🔔 Warning
+┗━━ manual (Manual proxy configuration)
+ ┣━━ http_proxy (HTTP Proxy)
+ ┃ ┣━━ address (HTTP address): 🔔 family "manual" (Manual proxy
+ ┃ ┃ configuration) has property disabled, so cannot access to "address"
+ ┃ ┃ (HTTP address), it will be ignored when loading from the YAML file
+ ┃ ┃ "config/02/config.yml"
+ ┃ ┗━━ port (HTTP Port): 🔔 family "manual" (Manual proxy configuration)
+ ┃ has property disabled, so cannot access to "port" (HTTP Port), it
+ ┃ will be ignored when loading from the YAML file
+ ┃ "config/02/config.yml"
+ ┗━━ use_for_https (Also use this proxy for HTTPS): 🔔 family "manual"
+ (Manual proxy configuration) has property disabled, so cannot access to
+ "use_for_https" (Also use this proxy for HTTPS), it will be ignored when
+ loading from the YAML file "config/02/config.yml"
+
+╭────────────── Caption ───────────────╮
+│ Variable Modified value │
+│ (⏳ Original default value) │
+╰──────────────────────────────────────╯
+Variables:
+┗━━ 📓 proxy_mode (Configure Proxy Access to the Internet): Manual proxy
+ configuration ◀ loaded from the YAML file "config/02/config.yml" (⏳ No
+ proxy)
+
diff --git a/config/02/output_unknown.html b/config/02/output_unknown.html
new file mode 100644
index 0000000..f66d223
--- /dev/null
+++ b/config/02/output_unknown.html
@@ -0,0 +1,15 @@
+🛑 Caution
+┗━━ manual (Manual proxy configuration)
+ ┣━━ http_proxy (HTTP Proxy)
+ ┃ ┣━━ address (HTTP address): 🛑 family "manual" (Manual proxy
+ ┃ ┃ configuration) has property disabled, so cannot access to "address"
+ ┃ ┃ (HTTP address), it has been loading from the YAML file
+ ┃ ┃ "config/02/config.yml"
+ ┃ ┗━━ port (HTTP Port): 🛑 family "manual" (Manual proxy configuration)
+ ┃ has property disabled, so cannot access to "port" (HTTP Port), it
+ ┃ has been loading from the YAML file "config/02/config.yml"
+ ┗━━ use_for_https (Also use this proxy for HTTPS): 🛑 family "manual"
+ (Manual proxy configuration) has property disabled, so cannot access to
+ "use_for_https" (Also use this proxy for HTTPS), it has been loading
+ from the YAML file "config/02/config.yml"
+
diff --git a/config/02/unknown b/config/02/unknown
new file mode 100644
index 0000000..e69de29
diff --git a/firefox.png b/firefox.png
index b7ca7aa..e40ce96 100644
Binary files a/firefox.png and b/firefox.png differ
diff --git a/tree.html b/tree.html
index 045be44..091ad53 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