66 lines
4.5 KiB
Markdown
66 lines
4.5 KiB
Markdown
- [Summary](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/branch/1.1/README.md)
|
|
- [[tutorial v1.1_020] Group variables inside a family](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_020/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_020~1..v1.1_020))
|
|
|
|
# [tutorial v1.1_021)] Group variables inside a sub family
|
|
|
|
[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_021~1..v1.1_021)
|
|
|
|
|
|
## Screenshot
|
|
|
|
|
|
<img src="firefox.png" width=50% height=50% alt="Firefox Proxy setting"/>
|
|
|
|
|
|
## Structure
|
|
|
|
|
|
### firefox/00-proxy.yml
|
|
|
|
|
|
```yml
|
|
%YAML 1.2
|
|
---
|
|
version: 1.1
|
|
|
|
proxy_mode:
|
|
description: Configure Proxy Access to the Internet
|
|
choices:
|
|
- No proxy
|
|
- Auto-detect proxy settings for this network
|
|
- Use system proxy settings
|
|
- Manual proxy configuration
|
|
- Automatic proxy configuration URL
|
|
default: No proxy
|
|
...
|
|
|
|
```
|
|
### firefox/10-manual.yml
|
|
|
|
|
|
```yml
|
|
%YAML 1.2
|
|
---
|
|
version: 1.1
|
|
|
|
manual: # Manual proxy configuration
|
|
|
|
http_proxy:
|
|
description: HTTP Proxy
|
|
type: family
|
|
...
|
|
|
|
```
|
|
### Let's generate the documentation
|
|
|
|
```console
|
|
foo@bar:~$ git switch --detach v1.1_021
|
|
foo@bar:~$ rougail -m firefox/ -o doc -do github
|
|
```
|
|
| Variable | Description |
|
|
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
| **proxy_mode**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Configure Proxy Access to the Internet.<br/>**Choices**: <br/>- No proxy **← (default)**<br/>- Auto-detect proxy settings for this network<br/>- Use system proxy settings<br/>- Manual proxy configuration<br/>- Automatic proxy configuration URL |
|
|
|
|
|
|
|
|
- [[tutorial v1.1_022] A variable inside sub family](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_022/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_022~1..v1.1_022))
|