diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 00000000..dca1b1fa --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,8 @@ +# Modified variables + +| Variable | Description | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **manual.http_proxy.address**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | ~~HTTP address.~~
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 Port.~~
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**
**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 "[HTTP address](#manual.http_proxy.address)".~~
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 "[HTTP Port](#manual.http_proxy.port)".~~
the value of the variable "[Proxy port](#manual.http_proxy.port)". | diff --git a/DOCUMENTATION.md b/DOCUMENTATION.md index d6c35dae..0c2a6fa9 100644 --- a/DOCUMENTATION.md +++ b/DOCUMENTATION.md @@ -16,10 +16,10 @@ > > **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.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 | |-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------| @@ -37,8 +37,8 @@ > **Identifiers**: > - HTTPS > - SOCKS -| 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 "[HTTP 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 "[HTTP 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**
**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". | diff --git a/README.md b/README.md index 83c09225..85fd159e 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_072] Jinja with a parameter](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_072/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_073~1..v1.1_073)) +- [[tutorial v1.1_073] Jinja could returns a boolean](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_073/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_080~1..v1.1_080)) -# [tutorial v1.1_073] Jinja could returns a boolean +# [tutorial v1.1_080] Proxy custom type -[Read the tutorial "Jinja could returns a boolean" in the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/jinja.html#jinja-could-returns-a-boolean) +[Read the tutorial "Proxy custom type" in the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/jinja.html#proxy-custom-type) ## Screenshot @@ -25,17 +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_073 +git switch --detach v1.1_080 ``` ## Structure

-.
- └── firefox
-     ├── 00-proxy.yml
-     ├── 10-manual.yml
-     └── 20-manual.yml
+.
+ ├── firefox
+ │   ├── 00-proxy.yml
+ │   ├── 10-manual.yml
+ │   └── 20-manual.yml
+ └── types
+     └── proxy
+         └── 00-type.yml


Contents of the firefox/20-manual.yml file @@ -90,11 +93,19 @@ manual: ### Let's generate the documentation ```shell -rougail -m firefox/ -o doc +rougail -m firefox/ --types types/proxy -o doc ``` [View the documentation file](DOCUMENTATION.md) +*** +### Let's generate the changelog + +```shell +rougail -m firefox/ --types types/proxy -o doc --doc.contents changelog --doc.changelog.previous_json_file previous.yml +``` +[View the changelog file](CHANGELOG.md) + *** ## User datas @@ -119,7 +130,7 @@ manual: #### Output ```shell -rougail -m firefox/ -u yaml -yf config/01/config.yml +rougail -m firefox/ --types types/proxy -u yaml -yf config/01/config.yml ``` > [!NOTE] > @@ -133,8 +144,8 @@ 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: 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: 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) @@ -147,4 +158,4 @@ Variables: *** -- [[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_080~1..v1.1_080)) +- [[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_081~1..v1.1_081)) diff --git a/config/01/cmd_ro.txt b/config/01/cmd_ro.txt index d46f9445..d102ed75 100644 --- a/config/01/cmd_ro.txt +++ b/config/01/cmd_ro.txt @@ -1 +1 @@ -rougail -m firefox/ -u yaml -yf config/01/config.yml \ No newline at end of file +rougail -m firefox/ --types types/proxy -u yaml -yf config/01/config.yml \ No newline at end of file diff --git a/config/01/output_ro.html b/config/01/output_ro.html index 1dcf1c82..70bc25c3 100644 --- a/config/01/output_ro.html +++ b/config/01/output_ro.html @@ -9,9 +9,9 @@ Variables: ┃ proxy) ┗━━ 📂 manual (Manual proxy configuration) ┣━━ 📂 http_proxy (HTTP Proxy) - ┃ ┣━━ 📓 address (HTTP address): http.proxy.net ◀ loaded from the YAML + ┃ ┣━━ 📓 address (Proxy address): http.proxy.net ◀ loaded from the YAML ┃ ┃ file "config/01/config.yml" - ┃ ┗━━ 📓 port (HTTP Port): 3128 ◀ loaded from the YAML file + ┃ ┗━━ 📓 port (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) diff --git a/tree.html b/tree.html index c3fc914e..74185fe8 100644 --- a/tree.html +++ b/tree.html @@ -1,7 +1,10 @@

-.
- └── firefox
-     ├── 00-proxy.yml
-     ├── 10-manual.yml
-     └── 20-manual.yml
+.
+ ├── firefox
+ │   ├── 00-proxy.yml
+ │   ├── 10-manual.yml
+ │   └── 20-manual.yml
+ └── types
+     └── proxy
+         └── 00-type.yml


\ No newline at end of file