rougail-tutorials/README.md

- [Summary](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/branch/1.1/README.md)
- [[tutorial v1.1_161] New "FoxyProxy" namespace](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_161/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_170~1..v1.1_170))

# [tutorial v1.1_170] A leadership family

[Read the tutorial "A leadership family" in the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/jinja.html#a-leadership-family)


## Screenshot
<img src="foxyproxy.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_170
```

## Structure

<p>
<a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_170/./">.</a><br/>
	├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_170/./firefox/">firefox</a><br/>
	│   ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_170/./firefox/00-proxy.yml">00-proxy.yml</a><br/>
	│   ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_170/./firefox/10-manual.yml">10-manual.yml</a><br/>
	│   ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_170/./firefox/20-manual.yml">20-manual.yml</a><br/>
	│   ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_170/./firefox/30-auto.yml">30-auto.yml</a><br/>
	│   ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_170/./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_170/./firefox/50-prompt_authentication.yml">50-prompt_authentication.yml</a><br/>
	│   ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_170/./firefox/55-proxy_dns_socks5.yml">55-proxy_dns_socks5.yml</a><br/>
	│   └── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_170/./firefox/60-dns_over_https.yml">60-dns_over_https.yml</a><br/>
	├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_170/./foxyproxy/">foxyproxy</a><br/>
	│   └── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_170/./foxyproxy/00-foxyproxy.yml">00-foxyproxy.yml</a><br/>
	└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_170/./types/">types</a><br/>
	    └── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_170/./types/proxy/">proxy</a><br/>
	        └── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_170/./types/proxy/00-type.yml">00-type.yml</a><br/>
<br/><br/></p>

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

  color:  # Color
...

```

***
### 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
> - <span style="color: #B8860B">Default value</span>

Variables:
- :open_file_folder: firefox (Firefox)
  - :notebook: proxy_mode (Configure Proxy Access to the Internet): <span style="color: #B8860B">No proxy</span>
  - :open_file_folder: dns_over_https (DNS over HTTPS)
    - :notebook: enable_dns_over_https (Enable DNS over HTTPS): <span style="color: #B8860B">false</span>
- :open_file_folder: foxyproxy (FoxyProxy)
  - :open_file_folder: proxies (Proxy configuration): <span style="color: #B8860B">[]</span>

***
### Example 2

#### config/02/config.yml


```yml
---
foxyproxy:
  proxies:
    - title: My company
      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
> - <span style="color: #B8860B">Default value</span>
> - <span style="color: #006400">Modified value</span>

Variables:
- :open_file_folder: firefox (Firefox)
  - :notebook: proxy_mode (Configure Proxy Access to the Internet): <span style="color: #B8860B">No proxy</span>
  - :open_file_folder: dns_over_https (DNS over HTTPS)
    - :notebook: enable_dns_over_https (Enable DNS over HTTPS): <span style="color: #B8860B">false</span>
- :open_file_folder: foxyproxy (FoxyProxy)
  - :open_file_folder: proxies (Proxy configuration)
    - :open_file_folder: title (Title or Description)
      - :notebook: title (Title or Description): <span style="color: #006400">My company</span> ← loaded from the YAML file "config/02/config.yml"
      - :notebook: color (Color): <span style="color: #006400">#66cc66</span> ← loaded from the YAML file "config/02/config.yml"

***


- [[tutorial v1.1_180] Regexp type](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_180/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_180~1..v1.1_180))