rougail-tutorials/README.md

- [Summary](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/branch/1.1/README.md)
- [[tutorial v1.1_094] Help](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_094/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_094~1..v1.1_094))

# [tutorial v1.1_095] A conditional disabled boolean variable

[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_095~1..v1.1_095)

[Read the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#a-conditional-disabled-boolean-variable)


## Screenshot


<img src="firefox.png" width=50% height=50% alt="Firefox Proxy setting"/>


## 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_095
```

## Structure



<p>
<a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_095/./">.</a><br/>
	└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_095/./firefox/">firefox</a><br/>
	    ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_095/./firefox/00-proxy.yml">00-proxy.yml</a><br/>
	    ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_095/./firefox/10-manual.yml">10-manual.yml</a><br/>
	    ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_095/./firefox/20-manual.yml">20-manual.yml</a><br/>
	    ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_095/./firefox/30-auto.yml">30-auto.yml</a><br/>
	    ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_095/./firefox/40-no_proxy.yml">40-no_proxy.yml</a><br/>
	    └── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_095/./firefox/50-prompt_authentication.yml">50-prompt_authentication.yml</a><br/>
<br/><br/></p>

Contents of the firefox/50-prompt_authentication.yml file

```yml
%YAML 1.2
---
version: 1.1

prompt_authentication:
  description: Prompt for authentication if password is saved
  default: true
  disabled:
    variable: _.proxy_mode
    when: No proxy
...

```
### Let's generate the documentation

```shell
rougail -m firefox/ -o doc
```
| Variable                                                                                                                                                   | Description                                                                                                                                                                                                                                                                  |
|------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **<a id="proxy_mode" name="proxy_mode">proxy_mode</a>**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Configure Proxy Access to the Internet.<br/>**Choices**: <br/>•&nbsp;No proxy **← (default)**<br/>•&nbsp;Auto-detect proxy settings for this network<br/>•&nbsp;Use system proxy settings<br/>•&nbsp;Manual proxy configuration<br/>•&nbsp;Automatic proxy configuration URL |

#### Manual proxy configuration

> **🛈 Informations**
> 
> **Path**: manual\
> *`disabled`*\
> **Disabled**: when the variable "[Configure Proxy Access to the Internet](#proxy_mode)" hasn't the value "Manual proxy configuration"

##### HTTP Proxy

> **🛈 Informations**
> 
> **Path**: manual.http_proxy

| Variable                                                                                                                                                                                                    | Description                                                                                                                                                                                                                |
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **<a id="manual.http_proxy.address" name="manual.http_proxy.address">manual.http_proxy.address</a>**<br/>[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTP address.<br/>**Validators**: <br/>•&nbsp;type domainname<br/>•&nbsp;the domain name can be an IP                                                                                                                      |
| **<a id="manual.http_proxy.port" name="manual.http_proxy.port">manual.http_proxy.port</a>**<br/>[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory`                | HTTP Port.<br/>**Validators**: <br/>•&nbsp;well-known ports (1 to 1023) are allowed<br/>•&nbsp;registred ports (1024 to 49151) are allowed<br/>•&nbsp;private ports (greater than 49152) are allowed<br/>**Default**: 8080 |

| Variable                                                                                                                                                                                  | Description                                          |
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------|
| **<a id="manual.use_for_https" name="manual.use_for_https">manual.use_for_https</a>**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Also use this proxy for HTTPS.<br/>**Default**: true |

##### *HTTPS* Proxy or *SOCKS* Proxy

> **🛈 Informations**
> 
> This family builds families dynamically.\
> **Path**: 
> - manual.*https*_proxy
> - manual.*socks*_proxy\
> *`hidden`*\
> **Hidden**: in HTTPS case if "[Also use this proxy for HTTPS](#manual.use_for_https)" is set to "true"\
> **Identifiers**: 
> - HTTPS
> - SOCKS

| Variable                                                                                                                                                                                                                                                                             | Description                                                                                                                                                                                                                                                                                          |
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **<a id="manual.:::identifier:::_proxy.address" name="manual.:::identifier:::_proxy.address">manual.*https*_proxy.address</a>**<br/>**manual.*socks*_proxy.address**<br/>[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory`          | *HTTPS* or *SOCKS* address.<br/>**Validators**: <br/>•&nbsp;type domainname<br/>•&nbsp;the domain name can be an IP<br/>**Default**: the value of the variable "[HTTP address](#manual.http_proxy.address)"                                                                                          |
| **<a id="manual.:::identifier:::_proxy.port" name="manual.:::identifier:::_proxy.port">manual.*https*_proxy.port</a>**<br/>**manual.*socks*_proxy.port**<br/>[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory`                            | *HTTPS* or *SOCKS* port.<br/>**Validators**: <br/>•&nbsp;well-known ports (1 to 1023) are allowed<br/>•&nbsp;registred ports (1024 to 49151) are allowed<br/>•&nbsp;private ports (greater than 49152) are allowed<br/>**Default**: the value of the variable "[HTTP Port](#manual.http_proxy.port)" |
| **<a id="manual.:::identifier:::_proxy.version" name="manual.:::identifier:::_proxy.version">manual.*https*_proxy.version</a>**<br/>**manual.*socks*_proxy.version**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` *`disabled`* | SOCKS host version used by proxy.<br/>**Choices**: <br/>•&nbsp;v4<br/>•&nbsp;v5 **← (default)**<br/>**Disabled**: when the identifier is "HTTPS"                                                                                                                                                     |

| Variable                                                                                                                                                                                                  | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **<a id="auto" name="auto">auto</a>**<br/>[`web address`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` *`disabled`*                                                | Automatic proxy configuration URL.<br/>**Validators**: <br/>•&nbsp;well-known ports (1 to 1023) are allowed<br/>•&nbsp;registred ports (1024 to 49151) are allowed<br/>•&nbsp;type domainname<br/>•&nbsp;the domain name can be a hostname<br/>**Disabled**: when the variable "[Configure Proxy Access to the Internet](#proxy_mode)" hasn't the value "Automatic proxy configuration URL"                                                                                                                                                                                  |
| **<a id="no_proxy" name="no_proxy">no_proxy</a>**<br/>[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` *`disabled`* `unique`                             | Address for which proxy will be desactivated.<br/>Connections to localhost, 127.0.0.1/8 and ::1 are never proxied.<br/>**Validators**: <br/>•&nbsp;type domainname<br/>•&nbsp;the domain name can starts by a dot<br/>•&nbsp;the domain name can be a hostname<br/>•&nbsp;the domain name can be an IP<br/>•&nbsp;the domain name can be network in CIDR format<br/>**Examples**: <br/>•&nbsp;.mozilla.org<br/>•&nbsp;.net.nz<br/>•&nbsp;192.168.1.0/24<br/>**Disabled**: when the variable "[Configure Proxy Access to the Internet](#proxy_mode)" has the value "No proxy" |
| **<a id="prompt_authentication" name="prompt_authentication">prompt_authentication</a>**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` *`disabled`* | Prompt for authentication if password is saved.<br/>**Default**: true<br/>**Disabled**: when the variable "[Configure Proxy Access to the Internet](#proxy_mode)" has the value "No proxy"                                                                                                                                                                                                                                                                                                                                                                                   |

### Let's generate the changelog

```shell
rougail -m firefox/ -o doc --doc.contents changelog
```
#### New variable

| Variable                                                                                                                                                                                                  | Description                                                                                                                                                                                |
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **<a id="prompt_authentication" name="prompt_authentication">prompt_authentication</a>**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` *`disabled`* | Prompt for authentication if password is saved.<br/>**Default**: true<br/>**Disabled**: when the variable "[Configure Proxy Access to the Internet](#proxy_mode)" has the value "No proxy" |


## User datas

### Example 1

#### config/01/config.yml


```yml
---
```
#### Output

```shell
rougail -m firefox/ -u yaml -yf config/01/config.yml
```
<pre>╭──────────────────── Caption ─────────────────────╮
│ <span style="color: #ff0000">Undocumented but modified variable</span> <span style="color: #ffd700">Default value</span> │
╰──────────────────────────────────────────────────╯
Variables:
<span style="color: #5c5cff">┗━━ </span>📓 <span style="color: #ff0000">Configure Proxy Access to the Internet</span>: <span style="color: #ffd700">No proxy</span>
</pre>
### Example 2

#### config/02/config.yml


```yml
---
proxy_mode: Manual proxy configuration
manual:
  http_proxy:
    address: http.proxy.net
```
#### Output

```shell
rougail -m firefox/ -u yaml -yf config/02/config.yml
```
<pre>╭─────────────────────────── Caption ────────────────────────────╮
│ Variable                           <span style="color: #ffd700">Default value</span>               │
│ <span style="color: #ff0000">Undocumented but modified variable</span> <span style="color: #00aa00">Modified value</span>              │
│                                    (⏳ Original default value) │
╰────────────────────────────────────────────────────────────────╯
Variables:
<span style="color: #5c5cff">┣━━ </span>📓 <span style="color: #ff0000">Configure Proxy Access to the Internet</span>: <span style="color: #00aa00">Manual proxy configuration</span> ◀ 
<span style="color: #5c5cff">┃   </span>loaded from the YAML file "config/02/config.yml" (⏳ No proxy)
<span style="color: #5c5cff">┣━━ </span>📂 Manual proxy configuration
<span style="color: #5c5cff">┃   </span><span style="color: #5c5cff">┣━━ </span>📂 HTTP Proxy
<span style="color: #5c5cff">┃   </span><span style="color: #5c5cff">┃   </span><span style="color: #5c5cff">┣━━ </span>📓 <span style="color: #ff0000">HTTP address</span>: <span style="color: #00aa00">http.proxy.net</span> ◀ loaded from the YAML file 
<span style="color: #5c5cff">┃   </span><span style="color: #5c5cff">┃   </span><span style="color: #5c5cff">┃   </span>"config/02/config.yml"
<span style="color: #5c5cff">┃   </span><span style="color: #5c5cff">┃   </span><span style="color: #5c5cff">┗━━ </span>📓 <span style="color: #ff0000">HTTP Port</span>: <span style="color: #ffd700">8080</span>
<span style="color: #5c5cff">┃   </span><span style="color: #5c5cff">┣━━ </span>📓 <span style="color: #ff0000">Also use this proxy for HTTPS</span>: <span style="color: #ffd700">true</span>
<span style="color: #5c5cff">┃   </span><span style="color: #5c5cff">┗━━ </span>📂 SOCKS Proxy
<span style="color: #5c5cff">┃   </span><span style="color: #5c5cff">    </span><span style="color: #5c5cff">┣━━ </span>📓 <span style="color: #ff0000">SOCKS address</span>: <span style="color: #ffd700">http.proxy.net</span>
<span style="color: #5c5cff">┃   </span><span style="color: #5c5cff">    </span><span style="color: #5c5cff">┣━━ </span>📓 <span style="color: #ff0000">SOCKS port</span>: <span style="color: #ffd700">8080</span>
<span style="color: #5c5cff">┃   </span><span style="color: #5c5cff">    </span><span style="color: #5c5cff">┗━━ </span>📓 <span style="color: #ff0000">SOCKS host version used by proxy</span>: <span style="color: #ffd700">v5</span>
<span style="color: #5c5cff">┣━━ </span>📓 <span style="color: #ff0000">Address for which proxy will be desactivated</span>: 
<span style="color: #5c5cff">┗━━ </span>📓 <span style="color: #ff0000">Prompt for authentication if password is saved</span>: <span style="color: #ffd700">true</span>
</pre>
### 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/ -u yaml -yf config/03/config.yml
```
<pre><span style="font-weight: bold; color: #ffff00">🔔 WARNINGS</span>
<span style="color: #ffff00">┗━━ </span>variable or family "proxy_dns_socks5" does not exist, it will be ignored 
<span style="color: #ffff00">    </span>when loading from the YAML file "config/03/config.yml"
╭─────────────────────────── Caption ────────────────────────────╮
│ Variable                           <span style="color: #ffd700">Default value</span>               │
│ <span style="color: #ff0000">Undocumented but modified variable</span> <span style="color: #00aa00">Modified value</span>              │
│                                    (⏳ Original default value) │
╰────────────────────────────────────────────────────────────────╯
Variables:
<span style="color: #5c5cff">┣━━ </span>📓 <span style="color: #ff0000">Configure Proxy Access to the Internet</span>: <span style="color: #00aa00">Manual proxy configuration</span> ◀ 
<span style="color: #5c5cff">┃   </span>loaded from the YAML file "config/03/config.yml" (⏳ No proxy)
<span style="color: #5c5cff">┣━━ </span>📂 Manual proxy configuration
<span style="color: #5c5cff">┃   </span><span style="color: #5c5cff">┣━━ </span>📂 HTTP Proxy
<span style="color: #5c5cff">┃   </span><span style="color: #5c5cff">┃   </span><span style="color: #5c5cff">┣━━ </span>📓 <span style="color: #ff0000">HTTP address</span>: <span style="color: #00aa00">http.proxy.net</span> ◀ loaded from the YAML file 
<span style="color: #5c5cff">┃   </span><span style="color: #5c5cff">┃   </span><span style="color: #5c5cff">┃   </span>"config/03/config.yml"
<span style="color: #5c5cff">┃   </span><span style="color: #5c5cff">┃   </span><span style="color: #5c5cff">┗━━ </span>📓 <span style="color: #ff0000">HTTP Port</span>: <span style="color: #ffd700">8080</span>
<span style="color: #5c5cff">┃   </span><span style="color: #5c5cff">┣━━ </span>📓 <span style="color: #ff0000">Also use this proxy for HTTPS</span>: <span style="color: #ffd700">true</span>
<span style="color: #5c5cff">┃   </span><span style="color: #5c5cff">┗━━ </span>📂 SOCKS Proxy
<span style="color: #5c5cff">┃   </span><span style="color: #5c5cff">    </span><span style="color: #5c5cff">┣━━ </span>📓 <span style="color: #ff0000">SOCKS address</span>: <span style="color: #ffd700">http.proxy.net</span>
<span style="color: #5c5cff">┃   </span><span style="color: #5c5cff">    </span><span style="color: #5c5cff">┣━━ </span>📓 <span style="color: #ff0000">SOCKS port</span>: <span style="color: #ffd700">8080</span>
<span style="color: #5c5cff">┃   </span><span style="color: #5c5cff">    </span><span style="color: #5c5cff">┗━━ </span>📓 <span style="color: #ff0000">SOCKS host version used by proxy</span>: <span style="color: #ffd700">v5</span>
<span style="color: #5c5cff">┣━━ </span>📓 <span style="color: #ff0000">Address for which proxy will be desactivated</span>: 
<span style="color: #5c5cff">┗━━ </span>📓 <span style="color: #ff0000">Prompt for authentication if password is saved</span>: <span style="color: #ffd700">true</span>
</pre>
### 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/ -u yaml -yf config/04/config.yml
```
<pre>╭─────────────────────────── Caption ────────────────────────────╮
│ Variable                           <span style="color: #ffd700">Default value</span>               │
│ <span style="color: #ff0000">Undocumented but modified variable</span> <span style="color: #00aa00">Modified value</span>              │
│                                    (⏳ Original default value) │
╰────────────────────────────────────────────────────────────────╯
Variables:
<span style="color: #5c5cff">┣━━ </span>📓 <span style="color: #ff0000">Configure Proxy Access to the Internet</span>: <span style="color: #00aa00">Manual proxy configuration</span> ◀ 
<span style="color: #5c5cff">┃   </span>loaded from the YAML file "config/04/config.yml" (⏳ No proxy)
<span style="color: #5c5cff">┣━━ </span>📂 Manual proxy configuration
<span style="color: #5c5cff">┃   </span><span style="color: #5c5cff">┣━━ </span>📂 HTTP Proxy
<span style="color: #5c5cff">┃   </span><span style="color: #5c5cff">┃   </span><span style="color: #5c5cff">┣━━ </span>📓 <span style="color: #ff0000">HTTP address</span>: <span style="color: #00aa00">http.proxy.net</span> ◀ loaded from the YAML file 
<span style="color: #5c5cff">┃   </span><span style="color: #5c5cff">┃   </span><span style="color: #5c5cff">┃   </span>"config/04/config.yml"
<span style="color: #5c5cff">┃   </span><span style="color: #5c5cff">┃   </span><span style="color: #5c5cff">┗━━ </span>📓 <span style="color: #ff0000">HTTP Port</span>: <span style="color: #ffd700">8080</span>
<span style="color: #5c5cff">┃   </span><span style="color: #5c5cff">┣━━ </span>📓 <span style="color: #ff0000">Also use this proxy for HTTPS</span>: <span style="color: #ffd700">true</span>
<span style="color: #5c5cff">┃   </span><span style="color: #5c5cff">┗━━ </span>📂 SOCKS Proxy
<span style="color: #5c5cff">┃   </span><span style="color: #5c5cff">    </span><span style="color: #5c5cff">┣━━ </span>📓 <span style="color: #ff0000">SOCKS address</span>: <span style="color: #ffd700">http.proxy.net</span>
<span style="color: #5c5cff">┃   </span><span style="color: #5c5cff">    </span><span style="color: #5c5cff">┣━━ </span>📓 <span style="color: #ff0000">SOCKS port</span>: <span style="color: #ffd700">8080</span>
<span style="color: #5c5cff">┃   </span><span style="color: #5c5cff">    </span><span style="color: #5c5cff">┗━━ </span>📓 <span style="color: #ff0000">SOCKS host version used by proxy</span>: <span style="color: #00aa00">v4</span> ◀ loaded from the YAML file 
<span style="color: #5c5cff">┃   </span><span style="color: #5c5cff">    </span><span style="color: #5c5cff">    </span>"config/04/config.yml" (⏳ v5)
<span style="color: #5c5cff">┣━━ </span>📓 <span style="color: #ff0000">Address for which proxy will be desactivated</span>: 
<span style="color: #5c5cff">┗━━ </span>📓 <span style="color: #ff0000">Prompt for authentication if password is saved</span>: <span style="color: #ffd700">true</span>
</pre>


- [[tutorial v1.1_096] A boolean variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_096/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_096~1..v1.1_096))