diff --git a/CHANGELOG.md b/CHANGELOG.md index 1828d30a..10489761 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,8 +1,10 @@ # Modified variables -| 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**: ~~8080~~
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**: ~~8080~~
the value of the variable "[Proxy port](#manual.http_proxy.port)". | +| Variable | Description | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **manual.http_proxy.address**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | ~~Proxy address.~~
HTTP proxy 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` | ~~Proxy port.~~
HTTP 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 | +| **manual.https_proxy.address**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | ~~Proxy address.~~
HTTPS proxy address.
**Validators**:
• type domainname
• the domain name can be an IP
**Default**: ~~the value of the variable "[Proxy address](#manual.http_proxy.address)".~~
the value of the variable "[HTTP proxy address](#manual.http_proxy.address)". | +| **manual.https_proxy.port**
[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | ~~Proxy port.~~
HTTPS 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)".~~
the value of the variable "[HTTP proxy port](#manual.http_proxy.port)". | +| **manual.socks_proxy.address**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | ~~Proxy address.~~
SOCKS proxy address.
**Validators**:
• type domainname
• the domain name can be an IP
**Default**: ~~the value of the variable "[Proxy address](#manual.http_proxy.address)".~~
the value of the variable "[HTTP proxy address](#manual.http_proxy.address)". | +| **manual.socks_proxy.port**
[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | ~~Proxy port.~~
SOCKS 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)".~~
the value of the variable "[HTTP proxy port](#manual.http_proxy.port)". | diff --git a/README.md b/README.md index 4369ce89..9143a46d 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_081] Add a variable in a family with custom type](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_082] Redefine default value in custom type variable](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_083~1..v1.1_083)) -# [tutorial v1.1_082] Redefine default value in custom type variable +# [tutorial v1.1_083] Redefine other parameter in custom type -[Read the tutorial "Redefine default value in custom type variable" in the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/jinja.html#redefine-default-value-in-custom-type-variable) +[Read the tutorial "Redefine other parameter in custom type" in the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/jinja.html#redefine-other-parameter-in-custom-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_082 +git switch --detach v1.1_083 ``` ## 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 @@ -58,10 +58,26 @@ manual: hidden: variable: _.use_for_https + address: + redefine: true + description: HTTPS proxy address + + port: + redefine: true + description: HTTPS proxy port + socks_proxy: description: SOCKS Proxy type: proxy + address: + redefine: true + description: SOCKS proxy address + + port: + redefine: true + description: SOCKS proxy port + version: description: SOCKS host version used by proxy choices: @@ -96,10 +112,10 @@ rougail -m firefox/ --types types/proxy -o doc > > **Path**: manual.http_proxy -| Variable | Description | -|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **manual.http_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 | -| **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.http_proxy.address**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTP proxy 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 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 | |-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------| @@ -113,10 +129,10 @@ rougail -m firefox/ --types types/proxy -o doc > *`hidden`*\ > **Hidden**: when the variable "[Also use this proxy for HTTPS](#manual.use_for_https)" has the value "true". -| 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)". | +| Variable | Description | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **manual.https_proxy.address**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTPS proxy address.
**Validators**:
• type domainname
• the domain name can be an IP
**Default**: the value of the variable "[HTTP proxy address](#manual.http_proxy.address)". | +| **manual.https_proxy.port**
[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTPS 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 "[HTTP proxy port](#manual.http_proxy.port)". | ##### SOCKS Proxy @@ -124,11 +140,11 @@ rougail -m firefox/ --types types/proxy -o doc > > **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)** | +| Variable | Description | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **manual.socks_proxy.address**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | SOCKS proxy address.
**Validators**:
• type domainname
• the domain name can be an IP
**Default**: the value of the variable "[HTTP proxy address](#manual.http_proxy.address)". | +| **manual.socks_proxy.port**
[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | SOCKS 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 "[HTTP 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 @@ -173,18 +189,18 @@ 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 (Proxy address): http.proxy.net ← loaded from the YAML file "config/01/config.yml" - - :notebook: port (Proxy port): 3128 ← loaded from the YAML file "config/01/config.yml" (:hourglass_flowing_sand: 8080) + - :notebook: address (HTTP proxy address): http.proxy.net ← loaded from the YAML file "config/01/config.yml" + - :notebook: port (HTTP 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 (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 + - :notebook: address (HTTPS proxy address): https.proxy.net ← loaded from the YAML file "config/01/config.yml" (:hourglass_flowing_sand: http.proxy.net) + - :notebook: port (HTTPS proxy port): 3128 - :open_file_folder: socks_proxy (SOCKS Proxy) - - :notebook: address (Proxy address): http.proxy.net - - :notebook: port (Proxy port): 3128 + - :notebook: address (SOCKS proxy address): http.proxy.net + - :notebook: port (SOCKS proxy port): 3128 - :notebook: version (SOCKS host version used by proxy): v5 *** -- [[tutorial v1.1_083] Redefine other parameter in custom type](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)) +- [[tutorial v1.1_090] A conditional disabled variable with type web_address](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_090/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_090~1..v1.1_090)) diff --git a/config/01/output_ro.html b/config/01/output_ro.html index 0c5eaa66..164ac69c 100644 --- a/config/01/output_ro.html +++ b/config/01/output_ro.html @@ -9,18 +9,18 @@ Variables: ┃ proxy) ┗━━ 📂 manual (Manual proxy configuration) ┣━━ 📂 http_proxy (HTTP Proxy) - ┃ ┣━━ 📓 address (Proxy address): http.proxy.net ◀ loaded from the YAML - ┃ ┃ file "config/01/config.yml" - ┃ ┗━━ 📓 port (Proxy port): 3128 ◀ loaded from the YAML file + ┃ ┣━━ 📓 address (HTTP proxy address): http.proxy.net ◀ loaded from the + ┃ ┃ YAML file "config/01/config.yml" + ┃ ┗━━ 📓 port (HTTP proxy 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 (Proxy address): https.proxy.net ◀ loaded from the YAML - ┃ ┃ file "config/01/config.yml" (⏳ http.proxy.net) - ┃ ┗━━ 📓 port (Proxy port): 3128 + ┃ ┣━━ 📓 address (HTTPS proxy address): https.proxy.net ◀ loaded from the + ┃ ┃ YAML file "config/01/config.yml" (⏳ http.proxy.net) + ┃ ┗━━ 📓 port (HTTPS proxy port): 3128 ┗━━ 📂 socks_proxy (SOCKS Proxy) - ┣━━ 📓 address (Proxy address): http.proxy.net - ┣━━ 📓 port (Proxy port): 3128 + ┣━━ 📓 address (SOCKS proxy address): http.proxy.net + ┣━━ 📓 port (SOCKS proxy port): 3128 ┗━━ 📓 version (SOCKS host version used by proxy): v5 diff --git a/tree.html b/tree.html index 26596cad..c3f72367 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