rougail-tutorials/README.md

- [List of all the tutorial steps](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/branch/1.1/README.md)
- [[Previous tutorial v1.1_085] Redefine other parameter in custom type for HTTPS and SOCKS](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_085/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_090~1..v1.1_090))

# [tutorial v1.1_090] Variable with the value "null"

- [Read the tutorial "Variable with the value "null"" in the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/whatsnext.html#variable-with-the-value-null)
- [View the changes in the files](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_090~1..v1.1_090)


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

## Structure

<p>
<a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_090/./">.</a><br/>
	├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_090/./firefox/">firefox</a><br/>
	│   ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_090/./firefox/00-proxy.yml">00-proxy.yml</a><br/>
	│   ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_090/./firefox/10-manual.yml">10-manual.yml</a><br/>
	│   └── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_090/./firefox/20-manual.yml">20-manual.yml</a><br/>
	└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_090/./types/">types</a><br/>
	    └── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_090/./types/proxy/">proxy</a><br/>
	        └── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_090/./types/proxy/00-type.yml">00-type.yml</a><br/>
<br/><br/></p>

Contents of the firefox/20-manual.yml file

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

manual:

  use_for_https: true  # Also use this proxy for HTTPS

  https_proxy:
    description: HTTPS Proxy
    type: proxy
    hidden:
      variable: _.use_for_https

    address:
      redefine: true
      description: HTTPS proxy address

    port:
      redefine: true
      description: HTTPS proxy port

  socks_proxy:
    description: SOCKS Proxy
    type: proxy

    address:
      redefine: true
      description: SOCKS proxy address
      default: null
      mandatory: false

    port:
      redefine: true
      description: SOCKS proxy port
      default: 1080

    version:
      description: SOCKS host version used by proxy
      choices:
        - v4
        - v5
      default: v5
...

```

***
### 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
---
proxy_mode: Manual proxy configuration
manual:
  http_proxy:
    address: http.proxy.net
```

***
#### Output

```shell
rougail -m firefox/ --types types/proxy -u yaml -yf config/01/config.yml
```
> [!NOTE]
>
> **Caption:**
> - Variable
> - <span style="color: #A52A2A">Unmodifiable variable</span>
> - <span style="color: #B8860B">Default value</span>
> - <span style="color: #006400">Modified value</span>
> - (:hourglass_flowing_sand: Original default value)

Variables:
- :notebook: proxy_mode (Configure Proxy Access to the Internet): <span style="color: #006400">Manual proxy configuration</span> ← loaded from the YAML file "config/01/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): <span style="color: #006400">http.proxy.net</span> ← loaded from the YAML file "config/01/config.yml"
    - :notebook: port (HTTP proxy port): <span style="color: #B8860B">8080</span>
  - :notebook: use_for_https (Also use this proxy for HTTPS): <span style="color: #B8860B">true</span>
  - :open_file_folder: <span style="color: #A52A2A">https_proxy (HTTPS Proxy)</span>
    - :notebook: <span style="color: #A52A2A">address (HTTPS proxy address)</span>: <span style="color: #B8860B">http.proxy.net</span>
    - :notebook: <span style="color: #A52A2A">port (HTTPS proxy port)</span>: <span style="color: #B8860B">8080</span>
  - :open_file_folder: socks_proxy (SOCKS Proxy)
    - :notebook: address (SOCKS proxy address): <span style="color: #B8860B">null</span>
    - :notebook: port (SOCKS proxy port): <span style="color: #B8860B">1080</span>
    - :notebook: version (SOCKS host version used by proxy): <span style="color: #B8860B">v5</span>

***


- [[Next tutorial v1.1_091] Variables disabled when condition is null](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_091/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_091~1..v1.1_091))