diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 00000000..67ba96d9 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,6 @@ +# New variables + +| Variable | Description | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------| +| **foxyproxy.proxies.title**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` `standard` `unique` | Title or Description. | +| **foxyproxy.proxies.color**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | Color. | diff --git a/DOCUMENTATION.md b/DOCUMENTATION.md index fef4e51d..d100fe3b 100644 --- a/DOCUMENTATION.md +++ b/DOCUMENTATION.md @@ -79,3 +79,24 @@ | **firefox.dns_over_https.enable_dns_over_https**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Enable DNS over HTTPS.
**Default**: false | | **firefox.dns_over_https.provider**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` *`disabled`* | Use Provider.
**Choices**:
• Cloudflare **← (default)**
• NextDNS
• Custom
**Disabled**: when the variable "[Enable DNS over HTTPS](#firefox.dns_over_https.enable_dns_over_https)" has the value "false". | | **firefox.dns_over_https.custom_dns_url**
[`web address`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` *`disabled`* | Custom DNS URL.
**Validators**:
• well-known ports (1 to 1023) are allowed
• registred ports (1024 to 49151) are allowed
• type domainname
• the domain name can be a hostname
• must starts with 'https://' only
**Disabled**: if "[Use Provider](#firefox.dns_over_https.provider)" is not "Custom". | + +# FoxyProxy + +> [!NOTE] +> +> This family is a namespace.\ +> **Path**: foxyproxy\ +> `basic` + +## Proxy configuration + +> [!NOTE] +> +> This family contains lists of variable blocks.\ +> **Path**: foxyproxy.proxies\ +> `basic` + +| Variable | Description | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------| +| **foxyproxy.proxies.title**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` `standard` `unique` | Title or Description. | +| **foxyproxy.proxies.color**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | Color. | diff --git a/README.md b/README.md index ba0791ed..c23150d7 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_160] Namespace](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_160/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_161~1..v1.1_161)) +- [[tutorial v1.1_161] New "FoxyProxy" namespace](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_161/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_170~1..v1.1_170)) -# [tutorial v1.1_161] New "FoxyProxy" namespace +# [tutorial v1.1_170] A leadership family -[Read the tutorial "New "FoxyProxy" namespace" in the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/jinja.html#new-foxyproxy-namespace) +[Read the tutorial "A leadership family" in the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/jinja.html#a-leadership-family) ## Screenshot @@ -25,27 +25,27 @@ pip install rougail-cli rougail-output-exporter rougail-output-doc rougail-user- Then switch to the tutorial page: ```shell -git switch --detach v1.1_161 +git switch --detach v1.1_170 ``` ## Structure

-.
- ├── firefox
- │   ├── 00-proxy.yml
- │   ├── 10-manual.yml
- │   ├── 20-manual.yml
- │   ├── 30-auto.yml
- │   ├── 40-no_proxy.yml
- │   ├── 50-prompt_authentication.yml
- │   ├── 55-proxy_dns_socks5.yml
- │   └── 60-dns_over_https.yml
- ├── foxyproxy
- │   └── 00-foxyproxy.yml
- └── types
-     └── proxy
-         └── 00-type.yml
+.
+ ├── firefox
+ │   ├── 00-proxy.yml
+ │   ├── 10-manual.yml
+ │   ├── 20-manual.yml
+ │   ├── 30-auto.yml
+ │   ├── 40-no_proxy.yml
+ │   ├── 50-prompt_authentication.yml
+ │   ├── 55-proxy_dns_socks5.yml
+ │   └── 60-dns_over_https.yml
+ ├── foxyproxy
+ │   └── 00-foxyproxy.yml
+ └── types
+     └── proxy
+         └── 00-type.yml


Contents of the foxyproxy/00-foxyproxy.yml file @@ -54,6 +54,16 @@ Contents of the foxyproxy/00-foxyproxy.yml file %YAML 1.2 --- version: 1.1 + +proxies: + description: Proxy configuration + type: leadership + + title: + description: Title or Description + mandatory: false + + color: # Color ... ``` @@ -67,6 +77,14 @@ rougail -m firefox/ -s Firefox -xn FoxyProxy -xd 0 foxyproxy/ --types types/prox [View the documentation file](DOCUMENTATION.md) +*** +### Let's generate the changelog + +```shell +rougail -m firefox/ -s Firefox -xn FoxyProxy -xd 0 foxyproxy/ --types types/proxy --modes_level basic standard advanced -o doc --doc.contents changelog --doc.changelog.previous_json_file previous.yml +``` +[View the changelog file](CHANGELOG.md) + *** ## User datas @@ -96,8 +114,48 @@ Variables: - :notebook: proxy_mode (Configure Proxy Access to the Internet): No proxy - :open_file_folder: dns_over_https (DNS over HTTPS) - :notebook: enable_dns_over_https (Enable DNS over HTTPS): false +- :open_file_folder: foxyproxy (FoxyProxy) + - :open_file_folder: proxies (Proxy configuration): [] + +*** +### Example 2 + +#### config/02/config.yml + + +```yml +--- +foxyproxy: + proxies: + - title: My company + color: '#66cc66' +``` + +*** +#### Output + +```shell +rougail -m firefox/ -s Firefox -xn FoxyProxy -xd 0 foxyproxy/ --types types/proxy --modes_level basic standard advanced -u yaml -yf config/02/config.yml +``` +> [!NOTE] +> +> **Caption:** +> - Variable +> - Default value +> - Modified value + +Variables: +- :open_file_folder: firefox (Firefox) + - :notebook: proxy_mode (Configure Proxy Access to the Internet): No proxy + - :open_file_folder: dns_over_https (DNS over HTTPS) + - :notebook: enable_dns_over_https (Enable DNS over HTTPS): false +- :open_file_folder: foxyproxy (FoxyProxy) + - :open_file_folder: proxies (Proxy configuration) + - :open_file_folder: title (Title or Description) + - :notebook: title (Title or Description): My company ← loaded from the YAML file "config/02/config.yml" + - :notebook: color (Color): #66cc66 ← loaded from the YAML file "config/02/config.yml" *** -- [[tutorial v1.1_170] A leadership family](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_170/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_170~1..v1.1_170)) +- [[tutorial v1.1_180] Regexp type](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_180/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_180~1..v1.1_180)) diff --git a/config/01/output_ro.html b/config/01/output_ro.html index aa0e837f..9ad367b0 100644 --- a/config/01/output_ro.html +++ b/config/01/output_ro.html @@ -2,8 +2,10 @@ │ Variable Default value │ ╰────────────────────────╯ Variables: -┗━━ 📂 firefox (Firefox) - ┣━━ 📓 proxy_mode (Configure Proxy Access to the Internet): No proxy - ┗━━ 📂 dns_over_https (DNS over HTTPS) - ┗━━ 📓 enable_dns_over_https (Enable DNS over HTTPS): false +┣━━ 📂 firefox (Firefox) +┃ ┣━━ 📓 proxy_mode (Configure Proxy Access to the Internet): No proxy +┃ ┗━━ 📂 dns_over_https (DNS over HTTPS) +┃ ┗━━ 📓 enable_dns_over_https (Enable DNS over HTTPS): false +┗━━ 📂 foxyproxy (FoxyProxy) + ┗━━ 📂 proxies (Proxy configuration): [] diff --git a/config/02/cmd_ro.txt b/config/02/cmd_ro.txt new file mode 100644 index 00000000..0841fc15 --- /dev/null +++ b/config/02/cmd_ro.txt @@ -0,0 +1 @@ +rougail -m firefox/ -s Firefox -xn FoxyProxy -xd 0 foxyproxy/ --types types/proxy --modes_level basic standard advanced -u yaml -yf config/02/config.yml \ No newline at end of file diff --git a/config/02/config.yml b/config/02/config.yml new file mode 100644 index 00000000..22d9b3b8 --- /dev/null +++ b/config/02/config.yml @@ -0,0 +1,5 @@ +--- +foxyproxy: + proxies: + - title: My company + color: '#66cc66' diff --git a/config/02/output_ro.html b/config/02/output_ro.html new file mode 100644 index 00000000..dd9ff84a --- /dev/null +++ b/config/02/output_ro.html @@ -0,0 +1,17 @@ +
╭──────── Caption ────────╮
+│ Variable Default value  │
+│          Modified value │
+╰─────────────────────────╯
+Variables:
+┣━━ 📂 firefox (Firefox)
+┃   ┣━━ 📓 proxy_mode (Configure Proxy Access to the Internet): No proxy
+┃   ┗━━ 📂 dns_over_https (DNS over HTTPS)
+┃       ┗━━ 📓 enable_dns_over_https (Enable DNS over HTTPS): false
+┗━━ 📂 foxyproxy (FoxyProxy)
+    ┗━━ 📂 proxies (Proxy configuration)
+        ┗━━ 📂 title (Title or Description)
+            ┣━━ 📓 title (Title or Description): My company ◀ loaded from the 
+            ┃   YAML file "config/02/config.yml"
+            ┗━━ 📓 color (Color): #66cc66 ◀ loaded from the YAML file 
+                "config/02/config.yml"
+
diff --git a/tree.html b/tree.html index 174bb44d..b2b9070b 100644 --- a/tree.html +++ b/tree.html @@ -1,17 +1,17 @@

-.
- ├── firefox
- │   ├── 00-proxy.yml
- │   ├── 10-manual.yml
- │   ├── 20-manual.yml
- │   ├── 30-auto.yml
- │   ├── 40-no_proxy.yml
- │   ├── 50-prompt_authentication.yml
- │   ├── 55-proxy_dns_socks5.yml
- │   └── 60-dns_over_https.yml
- ├── foxyproxy
- │   └── 00-foxyproxy.yml
- └── types
-     └── proxy
-         └── 00-type.yml
+.
+ ├── firefox
+ │   ├── 00-proxy.yml
+ │   ├── 10-manual.yml
+ │   ├── 20-manual.yml
+ │   ├── 30-auto.yml
+ │   ├── 40-no_proxy.yml
+ │   ├── 50-prompt_authentication.yml
+ │   ├── 55-proxy_dns_socks5.yml
+ │   └── 60-dns_over_https.yml
+ ├── foxyproxy
+ │   └── 00-foxyproxy.yml
+ └── types
+     └── proxy
+         └── 00-type.yml


\ No newline at end of file