diff --git a/CHANGELOG.md b/CHANGELOG.md index a54e5609..172b74ae 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,5 @@ -# Modified variable +# New variable -| 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. | +| Variable | Description | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **foxyproxy.proxies.type**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Proxy Type.
**Choices**:
• HTTP
• HTTPS/SSL
• SOCKS4
• SOCKS5
• PAC URL
• WPAD
• System (use system settings)
• Direct (no proxy) **← (default)** | diff --git a/DOCUMENTATION.md b/DOCUMENTATION.md index 8b7926b6..38bc2a97 100644 --- a/DOCUMENTATION.md +++ b/DOCUMENTATION.md @@ -96,7 +96,8 @@ > **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**
[`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. | +| Variable | Description | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **foxyproxy.proxies.title**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` `standard` `unique` | Title or Description. | +| **foxyproxy.proxies.type**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Proxy Type.
**Choices**:
• HTTP
• HTTPS/SSL
• SOCKS4
• SOCKS5
• PAC URL
• WPAD
• System (use system settings)
• Direct (no proxy) **← (default)** | +| **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 30e237cf..39d7300d 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_181] Calculate a random color](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_181/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_182~1..v1.1_182)) +- [[tutorial v1.1_182] Auto save value](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_182/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_190~1..v1.1_190)) -# [tutorial v1.1_182] Auto save value +# [tutorial v1.1_190] A variable name that conflict with a known the variable's attribute "type" -[Read the tutorial "Auto save value" in the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/jinja.html#auto-save-value) +[Read the tutorial "A variable name that conflict with a known the variable's attribute "type"" in the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/jinja.html#a-variable-name-that-conflict-with-a-known-the-variable's-attribute-type) ## 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_182 +git switch --detach v1.1_190 ``` ## 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 @@ -57,12 +57,25 @@ version: 1.1 proxies: description: Proxy configuration - type: leadership + _type: leadership title: description: Title or Description mandatory: false + type: + description: Proxy Type + choices: + - HTTP + - HTTPS/SSL + - SOCKS4 + - SOCKS5 + - PAC URL + - WPAD + - System (use system settings) + - Direct (no proxy) + default: Direct (no proxy) + color: description: Color regexp: ^#(?:[0-9a-f]{3}){1,2}$ @@ -135,6 +148,8 @@ Variables: foxyproxy: proxies: - title: My company + type: HTTP + color: '#66cc66' ``` *** @@ -149,6 +164,7 @@ rougail -m firefox/ -s Firefox -xn FoxyProxy -xd 0 foxyproxy/ --types types/prox > - Variable > - Default value > - Modified value +> - (:hourglass_flowing_sand: Original default value) Variables: - :open_file_folder: firefox (Firefox) @@ -159,9 +175,86 @@ 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): #2f918d + - :notebook: type (Proxy Type): HTTP ← loaded from the YAML file "config/02/config.yml" (:hourglass_flowing_sand: Direct (no proxy)) + - :notebook: color (Color): #66cc66 ← loaded from the YAML file "config/02/config.yml" + +*** +### Example 3 + +#### config/03/config.yml + + +```yml +--- +firefox: + proxy_mode: Manual proxy configuration + manual: + http_proxy: + address: http.proxy.net +foxyproxy: + proxies: + - title: My company + color: '#66cc66' + type: HTTP + - title: An other company + color: '#cc66cc' + type: SOCKS5 + - title: WPAD + color: '#1166cc' + type: WPAD +``` + +*** +#### 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 +> - Unmodifiable variable +> - Default value +> - Modified value +> - (:hourglass_flowing_sand: Original default value) + +Variables: +- :open_file_folder: firefox (Firefox) + - :notebook: proxy_mode (Configure Proxy Access to the Internet): Manual proxy configuration ← loaded from the YAML file "config/03/config.yml" (:hourglass_flowing_sand: No proxy) + - :open_file_folder: manual (Manual proxy configuration) + - :open_file_folder: http_proxy (HTTP Proxy) + - :notebook: address (HTTP proxy address): http.proxy.net ← loaded from the YAML file "config/03/config.yml" + - :notebook: port (HTTP proxy port): 8080 + - :notebook: use_for_https (Also use this proxy for HTTPS): true + - :open_file_folder: https_proxy (HTTPS Proxy) + - :notebook: address (HTTPS proxy address): http.proxy.net + - :notebook: port (HTTPS proxy port): 8080 + - :open_file_folder: socks_proxy (SOCKS Proxy) + - :notebook: address (SOCKS proxy address): http.proxy.net + - :notebook: port (SOCKS proxy port): 8080 + - :notebook: version (SOCKS host version used by proxy): v5 + - :notebook: no_proxy (Address for which proxy will be desactivated): [] + - :notebook: prompt_authentication (Prompt for authentication if password is saved): true + - :notebook: proxy_dns_socks5 (Use proxy DNS when using SOCKS v5): false + - :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: type (Proxy Type): HTTP ← loaded from the YAML file "config/03/config.yml" (:hourglass_flowing_sand: Direct (no proxy)) + - :notebook: color (Color): #66cc66 ← loaded from the YAML file "config/03/config.yml" + - :open_file_folder: title (Title or Description) + - :notebook: title (Title or Description): An other company ← loaded from the YAML file "config/03/config.yml" + - :notebook: type (Proxy Type): SOCKS5 ← loaded from the YAML file "config/03/config.yml" (:hourglass_flowing_sand: Direct (no proxy)) + - :notebook: color (Color): #cc66cc ← loaded from the YAML file "config/03/config.yml" + - :open_file_folder: title (Title or Description) + - :notebook: title (Title or Description): WPAD ← loaded from the YAML file "config/03/config.yml" + - :notebook: type (Proxy Type): WPAD ← loaded from the YAML file "config/03/config.yml" (:hourglass_flowing_sand: Direct (no proxy)) + - :notebook: color (Color): #1166cc ← loaded from the YAML file "config/03/config.yml" *** -- [[tutorial v1.1_190] 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_190/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_190~1..v1.1_190)) +- [[tutorial v1.1_200] Variable calculation with propertyerror](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_200~1..v1.1_200)) diff --git a/config/02/config.yml b/config/02/config.yml index 40146647..0780700f 100644 --- a/config/02/config.yml +++ b/config/02/config.yml @@ -2,3 +2,5 @@ foxyproxy: proxies: - title: My company + type: HTTP + color: '#66cc66' diff --git a/config/02/output_ro.html b/config/02/output_ro.html index 11aebb6b..db9388b0 100644 --- a/config/02/output_ro.html +++ b/config/02/output_ro.html @@ -1,7 +1,8 @@ -
╭──────── Caption ────────╮
-│ Variable Default value  │
-│          Modified value │
-╰─────────────────────────╯
+
╭────────────── Caption ───────────────╮
+│ Variable Default value               │
+│          Modified value              │
+│          (⏳ Original default value) │
+╰──────────────────────────────────────╯
 Variables:
 ┣━━ 📂 firefox (Firefox)
 ┃   ┣━━ 📓 proxy_mode (Configure Proxy Access to the Internet): No proxy
@@ -12,5 +13,8 @@ Variables:
         ┗━━ 📂 title (Title or Description)
             ┣━━ 📓 title (Title or Description): My company ◀ loaded from the 
             ┃   YAML file "config/02/config.yml"
-            ┗━━ 📓 color (Color): #2f918d
+            ┣━━ 📓 type (Proxy Type): HTTP ◀ loaded from the YAML file 
+            ┃   "config/02/config.yml" (⏳ Direct (no proxy))
+            ┗━━ 📓 color (Color): #66cc66 ◀ loaded from the YAML file 
+                "config/02/config.yml"
 

diff --git a/config/03/cmd_ro.txt b/config/03/cmd_ro.txt
new file mode 100644
index 00000000..70205a54
--- /dev/null
+++ b/config/03/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/03/config.yml
\ No newline at end of file
diff --git a/config/03/config.yml b/config/03/config.yml
new file mode 100644
index 00000000..68cc8676
--- /dev/null
+++ b/config/03/config.yml
@@ -0,0 +1,17 @@
+---
+firefox:
+  proxy_mode: Manual proxy configuration
+  manual:
+    http_proxy:
+      address: http.proxy.net
+foxyproxy:
+  proxies:
+    - title: My company
+      color: '#66cc66'
+      type: HTTP
+    - title: An other company
+      color: '#cc66cc'
+      type: SOCKS5
+    - title: WPAD
+      color: '#1166cc'
+      type: WPAD
diff --git a/config/03/output_ro.html b/config/03/output_ro.html
new file mode 100644
index 00000000..57f39aa4
--- /dev/null
+++ b/config/03/output_ro.html
@@ -0,0 +1,53 @@
+
╭───────────────────── Caption ─────────────────────╮
+│ Variable              Default value               │
+│ Unmodifiable variable Modified value              │
+│                       (⏳ Original default value) │
+╰───────────────────────────────────────────────────╯
+Variables:
+┣━━ 📂 firefox (Firefox)
+┃   ┣━━ 📓 proxy_mode (Configure Proxy Access to the Internet): Manual proxy 
+┃   ┃   configuration ◀ loaded from the YAML file "config/03/config.yml" (⏳ No 
+┃   ┃   proxy)
+┃   ┣━━ 📂 manual (Manual proxy configuration)
+┃   ┃   ┣━━ 📂 http_proxy (HTTP Proxy)
+┃   ┃   ┃   ┣━━ 📓 address (HTTP proxy address): http.proxy.net ◀ loaded from 
+┃   ┃   ┃   ┃   the YAML file "config/03/config.yml"
+┃   ┃   ┃   ┗━━ 📓 port (HTTP proxy port): 8080
+┃   ┃   ┣━━ 📓 use_for_https (Also use this proxy for HTTPS): true
+┃   ┃   ┣━━ 📂 https_proxy (HTTPS Proxy)
+┃   ┃   ┃   ┣━━ 📓 address (HTTPS proxy address): http.proxy.net
+┃   ┃   ┃   ┗━━ 📓 port (HTTPS proxy port): 8080
+┃   ┃   ┗━━ 📂 socks_proxy (SOCKS Proxy)
+┃   ┃       ┣━━ 📓 address (SOCKS proxy address): http.proxy.net
+┃   ┃       ┣━━ 📓 port (SOCKS proxy port): 8080
+┃   ┃       ┗━━ 📓 version (SOCKS host version used by proxy): v5
+┃   ┣━━ 📓 no_proxy (Address for which proxy will be desactivated): []
+┃   ┣━━ 📓 prompt_authentication (Prompt for authentication if password is 
+┃   ┃   saved): true
+┃   ┣━━ 📓 proxy_dns_socks5 (Use proxy DNS when using SOCKS v5): false
+┃   ┗━━ 📂 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"
+        ┃   ┣━━ 📓 type (Proxy Type): HTTP ◀ loaded from the YAML file 
+        ┃   ┃   "config/03/config.yml" (⏳ Direct (no proxy))
+        ┃   ┗━━ 📓 color (Color): #66cc66 ◀ loaded from the YAML file 
+        ┃       "config/03/config.yml"
+        ┣━━ 📂 title (Title or Description)
+        ┃   ┣━━ 📓 title (Title or Description): An other company ◀ loaded from 
+        ┃   ┃   the YAML file "config/03/config.yml"
+        ┃   ┣━━ 📓 type (Proxy Type): SOCKS5 ◀ loaded from the YAML file 
+        ┃   ┃   "config/03/config.yml" (⏳ Direct (no proxy))
+        ┃   ┗━━ 📓 color (Color): #cc66cc ◀ loaded from the YAML file 
+        ┃       "config/03/config.yml"
+        ┗━━ 📂 title (Title or Description)
+            ┣━━ 📓 title (Title or Description): WPAD ◀ loaded from the YAML 
+            ┃   file "config/03/config.yml"
+            ┣━━ 📓 type (Proxy Type): WPAD ◀ loaded from the YAML file 
+            ┃   "config/03/config.yml" (⏳ Direct (no proxy))
+            ┗━━ 📓 color (Color): #1166cc ◀ loaded from the YAML file 
+                "config/03/config.yml"
+

diff --git a/tree.html b/tree.html
index b0b1769a..f30aec83 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