- [Summary](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/branch/1.1/README.md)
- [[tutorial v1.1_111] A boolean variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_111/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_112~1..v1.1_112))
# [tutorial v1.1_112] A Jinja conditional disabled boolean variable
[Read the tutorial "A Jinja conditional disabled boolean variable" in the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/jinja.html#a-jinja-conditional-disabled-boolean-variable)
## 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_112
```
## 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
└── types
└── proxy
└── 00-type.yml
Contents of the firefox/55-proxy_dns_socks5.yml file
```yml
%YAML 1.2
---
version: 1.1
proxy_dns_socks5:
description: Use proxy DNS when using SOCKS v5
default: false
disabled:
jinja: |-
{{ _.proxy_mode != "Manual proxy configuration" or _.manual.socks_proxy.version == 'v4' }}
return_type: boolean
description: |-
if "_.proxy_mode" is not "Manual proxy configuration"
or "_.manual.socks_proxy.version" is "v4"
...
```
***
### Let's generate the documentation
```shell
rougail -m firefox/ --types types/proxy -o doc
```
[View the documentation file](DOCUMENTATION.md)
***
### Let's generate the changelog
```shell
rougail -m firefox/ --types types/proxy -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/ --types types/proxy -u yaml -yf config/01/config.yml
```
> [!NOTE]
>
> **Caption:**
> - Variable
> - Default value
Variables:
- :notebook: proxy_mode (Configure Proxy Access to the Internet): No proxy
***
### Example 2
#### config/02/config.yml
```yml
---
proxy_mode: Manual proxy configuration
manual:
http_proxy:
address: http.proxy.net
```
***
#### Output
```shell
rougail -m firefox/ --types types/proxy -u yaml -yf config/02/config.yml
```
> [!NOTE]
>
> **Caption:**
> - Variable
> - Unmodifiable variable
> - Default value
> - Modified value
> - (:hourglass_flowing_sand: Original default value)
Variables:
- :notebook: proxy_mode (Configure Proxy Access to the Internet): Manual proxy configuration ← loaded from the YAML file "config/02/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/02/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
***
### Example 3
#### config/03/config.yml
```yml
---
proxy_mode: Manual proxy configuration
manual:
http_proxy:
address: http.proxy.net
proxy_dns_socks5: true
```
***
#### Output
```shell
rougail -m firefox/ --types types/proxy -u yaml -yf config/03/config.yml
```
> [!NOTE]
>
> **Caption:**
> - Variable
> - Unmodifiable variable
> - Default value
> - Modified value
> - (:hourglass_flowing_sand: Original default value)
Variables:
- :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): true ← loaded from the YAML file "config/03/config.yml" (:hourglass_flowing_sand: false)
***
### Example 4
#### config/04/config.yml
```yml
---
proxy_mode: Manual proxy configuration
manual:
http_proxy:
address: http.proxy.net
socks_proxy:
version: v4
```
***
#### Output
```shell
rougail -m firefox/ --types types/proxy -u yaml -yf config/04/config.yml
```
> [!NOTE]
>
> **Caption:**
> - Variable
> - Unmodifiable variable
> - Default value
> - Modified value
> - (:hourglass_flowing_sand: Original default value)
Variables:
- :notebook: proxy_mode (Configure Proxy Access to the Internet): Manual proxy configuration ← loaded from the YAML file "config/04/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/04/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): v4 ← loaded from the YAML file "config/04/config.yml" (:hourglass_flowing_sand: v5)
- :notebook: no_proxy (Address for which proxy will be desactivated): []
- :notebook: prompt_authentication (Prompt for authentication if password is saved): true
***
- [[tutorial v1.1_120] Disabled a variable when an other variable are disabled](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_120/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_120~1..v1.1_120))