diff --git a/README.md b/README.md index 9dbd7432..e80294d5 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] A disabled 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] A disabled family +# [tutorial v1.1_041] A conditional disabled family -[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#a-disabled-family) +[Read the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/disabled.html#a-conditional-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_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/10-manual.yml file @@ -55,7 +55,9 @@ version: 1.1 manual: description: Manual proxy configuration - disabled: true + disabled: + variable: _.proxy_mode + when_not: Manual proxy configuration http_proxy: # HTTP Proxy @@ -81,17 +83,43 @@ 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 + +> **🛈 Informations** +> +> **Path**: manual\ +> *`disabled`*\ +> **Disabled**: when the variable "[Configure Proxy Access to the Internet](#proxy_mode)" hasn't the value "Manual proxy configuration" + +##### HTTP Proxy + +> **🛈 Informations** +> +> **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 | + ### Let's generate the changelog ```shell rougail -m firefox/ -o doc --doc.contents changelog ``` -#### Deleted variables +#### New variables + +| 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 | +| **manual.use_for_https**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Also use this proxy for HTTPS.
**Default**: true | -- manual.http_proxy.address -- manual.http_proxy.port -- manual.use_for_https ## User datas ### Example 1 @@ -132,24 +160,22 @@ manual: ```shell rougail -m firefox/ -u yaml -yf config/02/config.yml ``` -
🔔 WARNINGS
-┣━━ family "manual" (Manual proxy configuration) is disabled, 
-┃   "manual.http_proxy.address" (HTTP address) will be ignored when loading from
-┃   the YAML file "config/02/config.yml"
-┣━━ family "manual" (Manual proxy configuration) is disabled, 
-┃   "manual.http_proxy.port" (HTTP Port) will be ignored when loading from the 
-┃   YAML file "config/02/config.yml"
-┗━━ family "manual" (Manual proxy configuration) is disabled, 
-    "manual.use_for_https" (Also use this proxy for HTTPS) will be ignored when 
-    loading from the YAML file "config/02/config.yml"
-╭─────────────────────────── Caption ────────────────────────────╮
-│ Undocumented but modified variable Modified value              │
-│                                    (⏳ Original default value) │
+
╭─────────────────────────── Caption ────────────────────────────╮
+│ Variable                           Modified value              │
+│ Undocumented but modified variable (⏳ Original default value) │
 ╰────────────────────────────────────────────────────────────────╯
 Variables:
-┗━━ 📓 Configure Proxy Access to the Internet: Manual proxy configuration ◀ 
-    loaded from the YAML file "config/02/config.yml" (⏳ No proxy)
+┣━━ 📓 Configure Proxy Access to the Internet: Manual proxy configuration ◀ 
+┃   loaded from the YAML file "config/02/config.yml" (⏳ No proxy)
+┗━━ 📂 Manual proxy configuration
+    ┣━━ 📂 HTTP Proxy
+    ┃   ┣━━ 📓 HTTP address: http.proxy.net ◀ loaded from the YAML file 
+    ┃   ┃   "config/02/config.yml"
+    ┃   ┗━━ 📓 HTTP Port: 3128 ◀ loaded from the YAML file 
+    ┃       "config/02/config.yml" (⏳ 8080)
+    ┗━━ 📓 Also use this proxy for HTTPS: false ◀ loaded from the YAML file 
+        "config/02/config.yml" (⏳ true)
 

 
 
-- [[tutorial v1.1_041] A conditional disabled family](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_042] Copy HTTP manual proxy to HTTPS manual proxy](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))
diff --git a/config/02/output_ro.html b/config/02/output_ro.html
index 978bb27c..d269aa13 100644
--- a/config/02/output_ro.html
+++ b/config/02/output_ro.html
@@ -1,18 +1,16 @@
-
🔔 WARNINGS
-┣━━ family "manual" (Manual proxy configuration) is disabled, 
-┃   "manual.http_proxy.address" (HTTP address) will be ignored when loading from
-┃   the YAML file "config/02/config.yml"
-┣━━ family "manual" (Manual proxy configuration) is disabled, 
-┃   "manual.http_proxy.port" (HTTP Port) will be ignored when loading from the 
-┃   YAML file "config/02/config.yml"
-┗━━ family "manual" (Manual proxy configuration) is disabled, 
-    "manual.use_for_https" (Also use this proxy for HTTPS) will be ignored when 
-    loading from the YAML file "config/02/config.yml"
-╭─────────────────────────── Caption ────────────────────────────╮
-│ Undocumented but modified variable Modified value              │
-│                                    (⏳ Original default value) │
+
╭─────────────────────────── Caption ────────────────────────────╮
+│ Variable                           Modified value              │
+│ Undocumented but modified variable (⏳ Original default value) │
 ╰────────────────────────────────────────────────────────────────╯
 Variables:
-┗━━ 📓 Configure Proxy Access to the Internet: Manual proxy configuration ◀ 
-    loaded from the YAML file "config/02/config.yml" (⏳ No proxy)
+┣━━ 📓 Configure Proxy Access to the Internet: Manual proxy configuration ◀ 
+┃   loaded from the YAML file "config/02/config.yml" (⏳ No proxy)
+┗━━ 📂 Manual proxy configuration
+    ┣━━ 📂 HTTP Proxy
+    ┃   ┣━━ 📓 HTTP address: http.proxy.net ◀ loaded from the YAML file 
+    ┃   ┃   "config/02/config.yml"
+    ┃   ┗━━ 📓 HTTP Port: 3128 ◀ loaded from the YAML file 
+    ┃       "config/02/config.yml" (⏳ 8080)
+    ┗━━ 📓 Also use this proxy for HTTPS: false ◀ loaded from the YAML file 
+        "config/02/config.yml" (⏳ true)
 

diff --git a/tree.html b/tree.html
index 3a16126d..1debbe68 100644
--- a/tree.html
+++ b/tree.html
@@ -25,11 +25,11 @@
 
 
 	
Directory Tree

-	.

-	└── firefox

-	    ├── 00-proxy.yml

-	    ├── 10-manual.yml

-	    └── 20-manual.yml

+	.

+	└── firefox

+	    ├── 00-proxy.yml

+	    ├── 10-manual.yml

+	    └── 20-manual.yml

 


 
 2 directories, 3 files