diff --git a/CHANGELOG.md b/CHANGELOG.md index 275b3bb..9c93397 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,5 @@ # Modified variable -| Variable | Description | -|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------| -| **foxyproxy.proxies.color**
~~`string`~~ [`regexp`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | Color.
**Validator**: text based with regular expressions "^#(?:[0-9a-f]{3}){1,2}$" | +| Variable | Description | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------| +| **foxyproxy.proxies.color**
~~`basic`~~ `standard` [`regexp`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Color.
**Validator**: text based with regular expressions "^#(?:[0-9a-f]{3}){1,2}$"
**Default**: random color value. | diff --git a/DOCUMENTATION.md b/DOCUMENTATION.md index 2a5da2f..2c45667 100644 --- a/DOCUMENTATION.md +++ b/DOCUMENTATION.md @@ -86,7 +86,7 @@ > > This family is a namespace.\ > **Path**: foxyproxy\ -> `basic` +> `standard` ## Proxy configuration @@ -94,9 +94,9 @@ > > This family contains lists of variable blocks.\ > **Path**: foxyproxy.proxies\ -> `basic` +> `standard` -| 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**
[`regexp`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | Color.
**Validator**: text based with regular expressions "^#(?:[0-9a-f]{3}){1,2}$" | +| 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**
[`regexp`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Color.
**Validator**: text based with regular expressions "^#(?:[0-9a-f]{3}){1,2}$"
**Default**: random color value. | diff --git a/README.md b/README.md index c0b6b95..93313bf 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ - [List of all the tutorial steps](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/branch/1.1/README.md) -- [[Previous tutorial v1.1_190] A family with sequence type](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_190/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_200~1..v1.1_200)) +- [[Previous tutorial v1.1_200] A regexp variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_200/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_201~1..v1.1_201)) -# [tutorial v1.1_200] A regexp variable +# [tutorial v1.1_201] Calculate a random color -- [Read the tutorial "A regexp variable" in the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/regexp.html#a-regexp-variable) -- [View the changes in the files](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_200~1..v1.1_200) +- [Read the tutorial "Calculate a random color" in the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/regexp.html#calculate-a-random-color) +- [View the changes in the files](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_201~1..v1.1_201) ## Screenshot @@ -26,27 +26,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_200 +git switch --detach v1.1_201 ``` ## 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 @@ -67,6 +67,10 @@ proxies: color: description: Color regexp: ^#(?:[0-9a-f]{3}){1,2}$ + default: + jinja: >- + #{%- for i in range(6) -%}{{- '0123456789abcdef' | random -}}{%- endfor -%} + description: random color value ... ``` @@ -131,7 +135,6 @@ Variables: foxyproxy: proxies: - title: My company - color: '#66cc66' ``` *** @@ -156,7 +159,7 @@ Variables: - :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" + - :notebook: color (Color): #367571 *** ### Example 3 @@ -169,7 +172,6 @@ Variables: foxyproxy: proxies: - title: My company - color: not a color ``` *** @@ -178,15 +180,25 @@ foxyproxy: ```shell rougail -m firefox/ -s Firefox -xn FoxyProxy -xd 0 foxyproxy/ --types types/proxy --modes_level basic standard advanced -u yaml -yf config/03/config.yml ``` -> [!CAUTION] -> -> - foxyproxy (FoxyProxy) -> - proxies (Proxy configuration) -> - color (Color) -> - :bell: the value "not a color" is an invalid string, invalid value, it will be ignored when loading from the YAML file "config/03/config.yml" -> - :stop_sign: mandatory variable at index "0" but has no value +> [!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/03/config.yml" + - :notebook: color (Color): #0d2dba *** -- [[Next tutorial v1.1_201] Calculate a random color](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_201/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_201~1..v1.1_201)) +- [[Next tutorial v1.1_210] Auto save value](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_210/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_210~1..v1.1_210)) diff --git a/config/02/config.yml b/config/02/config.yml index 22d9b3b..4014664 100644 --- a/config/02/config.yml +++ b/config/02/config.yml @@ -2,4 +2,3 @@ foxyproxy: proxies: - title: My company - color: '#66cc66' diff --git a/config/02/output_ro.html b/config/02/output_ro.html index b29c312..47fcc0d 100644 --- a/config/02/output_ro.html +++ b/config/02/output_ro.html @@ -12,6 +12,5 @@ Variables: ┗━━ 📂 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" + ┗━━ 📓 color (Color): #fc5031 diff --git a/config/03/config.yml b/config/03/config.yml index 330d26b..4014664 100644 --- a/config/03/config.yml +++ b/config/03/config.yml @@ -2,4 +2,3 @@ foxyproxy: proxies: - title: My company - color: not a color diff --git a/config/03/output_ro.html b/config/03/output_ro.html index 35fbc5c..54a6444 100644 --- a/config/03/output_ro.html +++ b/config/03/output_ro.html @@ -1,9 +1,16 @@ -
🛑 Caution
-┗━━ foxyproxy (FoxyProxy)
-    ┗━━ proxies (Proxy configuration)
-        ┗━━ color (Color)
-            ┣━━ 🔔 the value "not a color" is an invalid string, invalid value, 
-            ┃   it will be ignored when loading from the YAML file 
-            ┃   "config/03/config.yml"
-            ┗━━ 🛑 mandatory variable at index "0" but has no value
+
╭──────── 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/03/config.yml"
+            ┗━━ 📓 color (Color): #348004
 

diff --git a/tree.html b/tree.html
index 2d3f269..554381c 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