From 90d070595405c54dbb9cc2603be9366e4f8c0dcd Mon Sep 17 00:00:00 2001 From: Emmanuel Garette Date: Tue, 5 May 2026 06:54:52 +0200 Subject: [PATCH] [tutorial v1.1_202] Auto save value (config and doc) --- CHANGELOG.md | 6 +-- DOCUMENTATION.md | 12 +++--- README.md | 82 +++++++++++----------------------------- config/02/output_ro.html | 2 +- config/03/cmd_ro.txt | 1 - config/03/config.yml | 4 -- config/03/output_ro.html | 16 -------- tree.html | 30 +++++++-------- 8 files changed, 48 insertions(+), 105 deletions(-) delete mode 100644 config/03/cmd_ro.txt delete mode 100644 config/03/config.yml delete mode 100644 config/03/output_ro.html diff --git a/CHANGELOG.md b/CHANGELOG.md index 9c933973..a54e5609 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,5 @@ # Modified variable -| 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. | +| Variable | Description | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------| +| **foxyproxy.proxies.color**
~~`standard`~~ `basic` [`regexp`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `auto modified` | 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 4164f490..985c7709 100644 --- a/DOCUMENTATION.md +++ b/DOCUMENTATION.md @@ -86,7 +86,7 @@ > > This family is a namespace.\ > **Path**: foxyproxy\ -> `standard` +> `basic` ## Proxy configuration @@ -94,9 +94,9 @@ > > This family contains lists of variable blocks.\ > **Path**: foxyproxy.proxies\ -> `standard` +> `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**
[`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. | +| 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` `auto modified` | 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 c1a8b055..c6249e61 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_200] Regexp type](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)) +- [[Previous 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_202~1..v1.1_202)) -# [tutorial v1.1_201] Calculate a random color +# [tutorial v1.1_202] Auto save value -- [Read the tutorial "Calculate a random color" in the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/whatsnext.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) +- [Read the tutorial "Auto save value" in the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/whatsnext.html#auto-save-value) +- [View the changes in the files](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_202~1..v1.1_202) ## 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_201 +git switch --detach v1.1_202 ``` ## 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 @@ -71,6 +71,7 @@ proxies: jinja: >- #{%- for i in range(6) -%}{{- '0123456789abcdef' | random -}}{%- endfor -%} description: random color value + auto_save: true ... ``` @@ -159,46 +160,9 @@ 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): #e535cb - -*** -### Example 3 - -#### config/03/config.yml - - -```yml ---- -foxyproxy: - proxies: - - title: My company -``` - -*** -#### Output - -```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 -``` -> [!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): #07d7d3 + - :notebook: color (Color): #64ab1e *** -- [[Next tutorial v1.1_202] Auto save value](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_202/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_202~1..v1.1_202)) +- [[Next tutorial v1.1_210] A variable name that conflict with a known the variable's attribute "type"](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/output_ro.html b/config/02/output_ro.html index 41bbda00..1cb82752 100644 --- a/config/02/output_ro.html +++ b/config/02/output_ro.html @@ -12,5 +12,5 @@ Variables: ┗━━ 📂 title (Title or Description) ┣━━ 📓 title (Title or Description): My company ◀ loaded from the ┃ YAML file "config/02/config.yml" - ┗━━ 📓 color (Color): #6b37ef + ┗━━ 📓 color (Color): #64ab1e diff --git a/config/03/cmd_ro.txt b/config/03/cmd_ro.txt deleted file mode 100644 index 70205a54..00000000 --- a/config/03/cmd_ro.txt +++ /dev/null @@ -1 +0,0 @@ -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 \ No newline at end of file diff --git a/config/03/config.yml b/config/03/config.yml deleted file mode 100644 index 40146647..00000000 --- a/config/03/config.yml +++ /dev/null @@ -1,4 +0,0 @@ ---- -foxyproxy: - proxies: - - title: My company diff --git a/config/03/output_ro.html b/config/03/output_ro.html deleted file mode 100644 index 3f388d3f..00000000 --- a/config/03/output_ro.html +++ /dev/null @@ -1,16 +0,0 @@ -
╭──────── 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): #65ef57
-
diff --git a/tree.html b/tree.html index 554381c5..21c199ce 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