From 97d47e61d58432d26849ad95540e8c0ff3c38666 Mon Sep 17 00:00:00 2001 From: Emmanuel Garette Date: Tue, 4 Nov 2025 19:22:17 +0100 Subject: [PATCH] [tutorial v1.1_032)] An hidden family (config and doc) --- README.md | 52 +++++++++++++++------------------------- config/03/output_ro.html | 6 ++--- 2 files changed, 21 insertions(+), 37 deletions(-) diff --git a/README.md b/README.md index bdb81928..41846ad0 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_030] A variable with type "boolean"](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_030/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_030~1..v1.1_030)) +- [[tutorial v1.1_031] Copy HTTP manual proxy to HTTPS manual proxy](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_031/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_031~1..v1.1_031)) -# [tutorial v1.1_031)] Copy HTTP manual proxy to HTTPS manual proxy +# [tutorial v1.1_032)] An hidden family -[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_031~1..v1.1_031) +[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_032~1..v1.1_032) ## Screenshot @@ -76,7 +76,9 @@ manual: use_for_https: true # Also use this proxy for HTTPS - https_proxy: # HTTPS Proxy + https_proxy: + description: HTTPS Proxy + hidden: true address: description: HTTPS address @@ -94,7 +96,7 @@ manual: ### Let's generate the documentation ```console -foo@bar:~$ git switch --detach v1.1_031 +foo@bar:~$ git switch --detach v1.1_032 foo@bar:~$ rougail -m firefox/ -o doc -do github ``` | Variable                                                                                        | Description                                                                                     | @@ -124,31 +126,17 @@ foo@bar:~$ rougail -m firefox/ -o doc -do github |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **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 - -**manual.https_proxy** - - - -| 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 | -| **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 | - ### Let's generate the changelog ```console -foo@bar:~$ git switch --detach v1.1_031 +foo@bar:~$ git switch --detach v1.1_032 foo@bar:~$ rougail -m firefox/ -o doc --doc.contents changelog -do github ``` -#### New 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 | -| **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 | +#### Deleted variables +- manual.https_proxy.address +- manual.https_proxy.port ## User datas ### Example 1 @@ -163,7 +151,7 @@ foo@bar:~$ rougail -m firefox/ -o doc --doc.contents changelog -do github #### Output ```console -foo@bar:~$ git switch --detach v1.1_031 +foo@bar:~$ git switch --detach v1.1_032 foo@bar:~$ rougail -m firefox/ -u yaml -ff config/01/config.yaml ``` 
╭─────── Caption ────────╮
@@ -185,7 +173,7 @@ proxy_mode: No proxy
 #### Output
 
 ```console
-foo@bar:~$ git switch --detach v1.1_031
+foo@bar:~$ git switch --detach v1.1_032
 foo@bar:~$ rougail -m firefox/ -u yaml -ff config/02/config.yaml
 ```
 
╭────────────── Caption ───────────────╮
@@ -208,16 +196,14 @@ proxy_mode: Manual proxy configuration
 #### Output
 
 ```console
-foo@bar:~$ git switch --detach v1.1_031
+foo@bar:~$ git switch --detach v1.1_032
 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
-        ┗━━ HTTPS Proxy
-            ┗━━ HTTPS address
+        ┗━━ HTTP Proxy
+            ┗━━ HTTP address
 

 ### Example 4
 
@@ -232,7 +218,7 @@ proxy_mode: foo
 #### Output
 
 ```console
-foo@bar:~$ git switch --detach v1.1_031
+foo@bar:~$ git switch --detach v1.1_032
 foo@bar:~$ rougail -m firefox/ -u yaml -ff config/04/config.yaml
 ```
 
🔔 WARNINGS
@@ -257,7 +243,7 @@ proxy_mode: 1
 #### Output
 
 ```console
-foo@bar:~$ git switch --detach v1.1_031
+foo@bar:~$ git switch --detach v1.1_032
 foo@bar:~$ rougail -m firefox/ -u yaml -ff config/05/config.yaml
 ```
 
🔔 WARNINGS
@@ -271,4 +257,4 @@ Variables:
 

 
 
-- [[tutorial v1.1_032] An hidden family](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_032/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_032~1..v1.1_032))
+- [[tutorial v1.1_033] A conditional hidden family with a variable](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))
diff --git a/config/03/output_ro.html b/config/03/output_ro.html
index 45e42766..ec666c15 100644
--- a/config/03/output_ro.html
+++ b/config/03/output_ro.html
@@ -1,8 +1,6 @@
 
🛑 ERRORS
 ┗━━ The following variables are mandatory but have no value:
     ┗━━ Manual proxy configuration
-        ┣━━ HTTP Proxy
-        ┃   ┗━━ HTTP address
-        ┗━━ HTTPS Proxy
-            ┗━━ HTTPS address
+        ┗━━ HTTP Proxy
+            ┗━━ HTTP address