- [Summary](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/branch/1.1/README.md)
- [[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_190] A variable name that conflict with a known the variable's attribute "type"
[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
## Clone and install
To test this tutorial, you need to download this repository and install Rougail:
```shell
git clone -b 1.1 https://forge.cloud.silique.fr/stove/rougail-tutorials.git
cd rougail-tutorials
python -m venv venv_rougail
. venv_rougail/bin/activate
pip install rougail-cli rougail-output-exporter rougail-output-doc rougail-user-data-yaml
```
Then switch to the tutorial page:
```shell
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
Contents of the foxyproxy/00-foxyproxy.yml file
```yml
%YAML 1.2
---
version: 1.1
proxies:
description: Proxy configuration
_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}$
default:
jinja: >-
#{%- for i in range(6) -%}{{- '0123456789abcdef' | random -}}{%- endfor -%}
description: random color value
auto_save: true
...
```
***
### Let's generate the documentation
```shell
rougail -m firefox/ -s Firefox -xn FoxyProxy -xd 0 foxyproxy/ --types types/proxy --modes_level basic standard advanced -o doc
```
[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
### Example 1
#### config/01/config.yml
```yml
---
```
***
#### Output
```shell
rougail -m firefox/ -s Firefox -xn FoxyProxy -xd 0 foxyproxy/ --types types/proxy --modes_level basic standard advanced -u yaml -yf config/01/config.yml
```
> [!NOTE]
>
> **Caption:**
> - Variable
> - Default 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): []
***
### Example 2
#### config/02/config.yml
```yml
---
foxyproxy:
proxies:
- title: My company
type: HTTP
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
> - (:hourglass_flowing_sand: Original default 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: 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_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))