diff --git a/README.md b/README.md
index 9687dba1..fea9ab9b 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_080] Proxy custom type](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_080/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_081~1..v1.1_081))
+- [[tutorial v1.1_081] Redefine default value](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_081/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_082~1..v1.1_082))
-# [tutorial v1.1_081] Redefine default value
+# [tutorial v1.1_082] Redefine variable inside type
-[Read the tutorial "Redefine default value" in the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/jinja.html#redefine-default-value)
+[Read the tutorial "Redefine variable inside type" in the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/jinja.html#redefine-variable-inside-type)
## Screenshot
@@ -25,20 +25,20 @@ pip install rougail-cli rougail-output-exporter rougail-output-doc rougail-user-
Then switch to the tutorial page:
```shell
-git switch --detach v1.1_081
+git switch --detach v1.1_082
```
## Structure
-.
- ├── firefox
- │ ├── 00-proxy.yml
- │ ├── 10-manual.yml
- │ └── 20-manual.yml
- └── types
- └── proxy
- └── 00-type.yml
+.
+ ├── firefox
+ │ ├── 00-proxy.yml
+ │ ├── 10-manual.yml
+ │ └── 20-manual.yml
+ └── types
+ └── proxy
+ └── 00-type.yml
Contents of the firefox/20-manual.yml file
@@ -52,29 +52,15 @@ manual:
use_for_https: true # Also use this proxy for HTTPS
- '{{ identifier }}_proxy':
- description: '{{ identifier }} Proxy'
+ https_proxy:
+ description: HTTPS Proxy
+ type: proxy
hidden:
- jinja: |-
- {{ my_identifier == 'HTTPS' and _.use_for_https }}
- return_type: boolean
- description: in HTTPS case if "_.use_for_https" is set to "true"
- params:
- my_identifier:
- type: identifier
- dynamic:
- - HTTPS
- - SOCKS
+ variable: _.use_for_https
- address:
- description: '{{ identifier }} address'
- default:
- variable: __.http_proxy.address
-
- port:
- description: '{{ identifier }} port'
- default:
- variable: __.http_proxy.port
+ socks_proxy:
+ description: SOCKS Proxy
+ type: proxy
version:
description: SOCKS host version used by proxy
@@ -82,9 +68,6 @@ manual:
- v4
- v5
default: v5
- disabled:
- type: identifier
- when: HTTPS
...
```
@@ -122,36 +105,52 @@ rougail -m firefox/ --types types/proxy -o doc
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------|
| **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* or *SOCKS* Proxy
+##### HTTPS Proxy
> [!NOTE]
>
-> This family builds families dynamically.\
-> **Path**:
-> - manual.*https*_proxy
-> - manual.*socks*_proxy\
+> **Path**: manual.https_proxy\
> *`hidden`*\
-> **Hidden**: in HTTPS case if "[Also use this proxy for HTTPS](#manual.use_for_https)" is set to "true".\
-> **Identifiers**:
-> - HTTPS
-> - SOCKS
+> **Hidden**: when the variable "[Also use this proxy for HTTPS](#manual.use_for_https)" has the value "true".
-| Variable | Description |
-|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| **manual.*https*_proxy.address**
**manual.*socks*_proxy.address**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | *HTTPS* or *SOCKS* address.
**Validators**:
• type domainname
• the domain name can be an IP
**Default**: the value of the variable "[Proxy address](#manual.http_proxy.address)". |
-| **manual.*https*_proxy.port**
**manual.*socks*_proxy.port**
[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | *HTTPS* or *SOCKS* 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 "[Proxy port](#manual.http_proxy.port)". |
-| **manual.*socks*_proxy.version**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` *`disabled`* | SOCKS host version used by proxy.
**Choices**:
• v4
• v5 **← (default)**
**Disabled**: when the identifier is "HTTPS". |
+| Variable | Description |
+|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| **manual.https_proxy.address**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Proxy address.
**Validators**:
• type domainname
• the domain name can be an IP
**Default**: the value of the variable "[Proxy address](#manual.http_proxy.address)". |
+| **manual.https_proxy.port**
[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Proxy 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 "[Proxy port](#manual.http_proxy.port)". |
+
+##### SOCKS Proxy
+
+> [!NOTE]
+>
+> **Path**: manual.socks_proxy
+
+| Variable | Description |
+|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| **manual.socks_proxy.address**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Proxy address.
**Validators**:
• type domainname
• the domain name can be an IP
**Default**: the value of the variable "[Proxy address](#manual.http_proxy.address)". |
+| **manual.socks_proxy.port**
[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Proxy 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 "[Proxy port](#manual.http_proxy.port)". |
+| **manual.socks_proxy.version**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | SOCKS host version used by proxy.
**Choices**:
• v4
• v5 **← (default)** |
***
### Let's generate the changelog
```shell
rougail -m firefox/ --types types/proxy -o doc --doc.contents changelog --doc.changelog.previous_json_file previous.yml
```
-#### Modified variable
+#### New variables
-| Variable | Description |
-|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| **manual.http_proxy.port**
[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Proxy 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` | Proxy address.
**Validators**:
• type domainname
• the domain name can be an IP
**Default**: the value of the variable "[Proxy address](#manual.http_proxy.address)". |
+| **manual.https_proxy.port**
[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Proxy 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 "[Proxy port](#manual.http_proxy.port)". |
+| **manual.socks_proxy.address**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Proxy address.
**Validators**:
• type domainname
• the domain name can be an IP
**Default**: the value of the variable "[Proxy address](#manual.http_proxy.address)". |
+| **manual.socks_proxy.port**
[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Proxy 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 "[Proxy port](#manual.http_proxy.port)". |
+| **manual.socks_proxy.version**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | SOCKS host version used by proxy.
**Choices**:
• v4
• v5 **← (default)** |#### Deleted variables
+
+
+- manual.*https*_proxy.address
+- manual.*socks*_proxy.address
+- manual.*https*_proxy.port
+- manual.*socks*_proxy.port
+- manual.*socks*_proxy.version
***
## User datas
@@ -194,14 +193,14 @@ Variables:
- :notebook: port (Proxy 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: address (Proxy address): https.proxy.net ← loaded from the YAML file "config/01/config.yml" (:hourglass_flowing_sand: http.proxy.net)
+ - :notebook: port (Proxy port): 3128
- :open_file_folder: socks_proxy (SOCKS Proxy)
- - :notebook: address (SOCKS address): http.proxy.net
- - :notebook: port (SOCKS port): 3128
+ - :notebook: address (Proxy address): http.proxy.net
+ - :notebook: port (Proxy port): 3128
- :notebook: version (SOCKS host version used by proxy): v5
***
-- [[tutorial v1.1_082] Redefine variable inside type](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_082/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_082~1..v1.1_082))
+- [[tutorial v1.1_083] HTTPS and SOCKS Proxy](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_083/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_083~1..v1.1_083))
diff --git a/config/01/output_ro.html b/config/01/output_ro.html
index 70bc25c3..0c5eaa66 100644
--- a/config/01/output_ro.html
+++ b/config/01/output_ro.html
@@ -16,11 +16,11 @@ Variables:
┣━━ 📓 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
+ ┃ ┣━━ 📓 address (Proxy address): https.proxy.net ◀ loaded from the YAML
┃ ┃ file "config/01/config.yml" (⏳ http.proxy.net)
- ┃ ┗━━ 📓 port (HTTPS port): 3128
+ ┃ ┗━━ 📓 port (Proxy port): 3128
┗━━ 📂 socks_proxy (SOCKS Proxy)
- ┣━━ 📓 address (SOCKS address): http.proxy.net
- ┣━━ 📓 port (SOCKS port): 3128
+ ┣━━ 📓 address (Proxy address): http.proxy.net
+ ┣━━ 📓 port (Proxy port): 3128
┗━━ 📓 version (SOCKS host version used by proxy): v5
diff --git a/tree.html b/tree.html
index d1bd476c..26596cad 100644
--- a/tree.html
+++ b/tree.html
@@ -1,10 +1,10 @@
-.
- ├── firefox
- │ ├── 00-proxy.yml
- │ ├── 10-manual.yml
- │ └── 20-manual.yml
- └── types
- └── proxy
- └── 00-type.yml
+.
+ ├── firefox
+ │ ├── 00-proxy.yml
+ │ ├── 10-manual.yml
+ │ └── 20-manual.yml
+ └── types
+ └── proxy
+ └── 00-type.yml
\ No newline at end of file