2024-09-07 19:06:25 +02:00
---
gitea: none
include_toc: true
---
# Summary
2024-09-07 19:06:26 +02:00
- [[tutorial 001] An empty file](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_001/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_001~1..v1.1_001))
2024-09-07 19:06:27 +02:00
- [[tutorial 002] A first variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_002/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_002~1..v1.1_002))
2024-09-07 19:06:28 +02:00
- [[tutorial 003] A first variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_003/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_003~1..v1.1_003))
2024-09-07 19:06:29 +02:00
- [[tutorial 004] The variable description](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_004/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_004~1..v1.1_004))
2024-09-07 19:06:30 +02:00
- [[tutorial 005] A default value](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_005/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_005~1..v1.1_005))
2024-09-07 19:06:25 +02:00
# Description
< img src = "firefox.png" width = 50% height = 50% alt = "Firefox Proxy setting" / >
2024-09-07 19:06:30 +02:00
A default value
2024-09-07 19:06:27 +02:00
2024-09-07 19:06:30 +02:00
Now we can define the default value of this variable.
2024-09-07 19:06:27 +02:00
2024-09-07 19:06:30 +02:00
If the user doesn't touch this variable's value, the value is "No proxy"
2024-09-07 19:06:27 +02:00
2024-09-07 19:06:30 +02:00
As user intervention is no more required, so the variable change it's default mode too (from "basic" to "standard").
2024-09-07 19:06:25 +02:00
# Structure
2024-09-07 19:06:26 +02:00
## firefox/00-proxy.yml
```yml
---
2024-09-07 19:06:28 +02:00
proxy_mode:
2024-09-07 19:06:29 +02:00
description: Configure Proxy Access to the Internet
2024-09-07 19:06:30 +02:00
default: No proxy
2024-09-07 19:06:26 +02:00
```
## Generated documentation
```console
foo@bar:~$ rougail -v 1.1 -m firefox/ -o doc -do github
```
2024-09-07 19:06:28 +02:00
### Variables
2024-09-07 19:06:30 +02:00
| Variable | Description |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **proxy_mode** < br /> [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Configure Proxy Access to the Internet.< br /> **Default**: No proxy |
2024-09-07 19:06:28 +02:00
# User data
## Example 1
### config/01/config.yaml
```yml
---
```
### Description
The user data file is empty. So it's only default value that will be used.
### Output
```console
foo@bar:~$ rougail -v 1.1 -m firefox -u file -ff config/01/config.yaml
```
2024-09-07 19:06:30 +02:00
< pre > ╭────────────────────────── Caption ──────────────────────────╮
│ Variable < span style = "color: #ffd700 " > Default value</ span > │
│ < span style = "color: #5c5cff " > Undocumented variable</ span > Modified value │
│ < span style = "color: #ff0000 " > Undocumented but modified variable</ span > (< span style = "color: #00aa00 " > Original default value</ span > ) │
│ < span style = "color: #ffaf00 " > Unmodifiable variable</ span > │
╰─────────────────────────────────────────────────────────────╯
Variables:
< span style = "color: #5c5cff " > ┗━━ </ span > 📓 proxy_mode: < span style = "color: #ffd700 " > No proxy</ span >
2024-09-07 19:06:28 +02:00
< / pre >
## Example 2
### config/02/config.yaml
```yml
---
proxy_mode: No proxy
```
### Output
```console
foo@bar:~$ rougail -v 1.1 -m firefox -u file -ff config/02/config.yaml
```
< pre > ╭────────────────────────── Caption ──────────────────────────╮
│ Variable < span style = "color: #ffd700 " > Default value</ span > │
│ < span style = "color: #5c5cff " > Undocumented variable</ span > Modified value │
│ < span style = "color: #ff0000 " > Undocumented but modified variable</ span > (< span style = "color: #00aa00 " > Original default value</ span > ) │
│ < span style = "color: #ffaf00 " > Unmodifiable variable</ span > │
╰─────────────────────────────────────────────────────────────╯
Variables:
2024-09-07 19:06:30 +02:00
< span style = "color: #5c5cff " > ┗━━ </ span > 📓 proxy_mode: No proxy (< span style = "color: #00aa00 " > No proxy</ span > )
2024-09-07 19:06:28 +02:00
< / pre >
## Example 3
### config/03/config.yaml
```yml
---
proxy_mode: Manual proxy configuration
```
### Output
```console
foo@bar:~$ rougail -v 1.1 -m firefox -u file -ff config/03/config.yaml
```
< pre > ╭────────────────────────── Caption ──────────────────────────╮
│ Variable < span style = "color: #ffd700 " > Default value</ span > │
│ < span style = "color: #5c5cff " > Undocumented variable</ span > Modified value │
│ < span style = "color: #ff0000 " > Undocumented but modified variable</ span > (< span style = "color: #00aa00 " > Original default value</ span > ) │
│ < span style = "color: #ffaf00 " > Unmodifiable variable</ span > │
╰─────────────────────────────────────────────────────────────╯
Variables:
2024-09-07 19:06:30 +02:00
< span style = "color: #5c5cff " > ┗━━ </ span > 📓 proxy_mode: Manual proxy configuration (< span style = "color: #00aa00 " > No proxy</ span > )
2024-09-07 19:06:28 +02:00
< / pre >
## Example 4
### config/04/config.yaml
```yml
---
proxy_mode: foo
```
### Description
"foo" should be an invalid value for this variable.
### Output
```console
foo@bar:~$ rougail -v 1.1 -m firefox -u file -ff config/04/config.yaml
```
< pre > ╭────────────────────────── Caption ──────────────────────────╮
│ Variable < span style = "color: #ffd700 " > Default value</ span > │
│ < span style = "color: #5c5cff " > Undocumented variable</ span > Modified value │
│ < span style = "color: #ff0000 " > Undocumented but modified variable</ span > (< span style = "color: #00aa00 " > Original default value</ span > ) │
│ < span style = "color: #ffaf00 " > Unmodifiable variable</ span > │
╰─────────────────────────────────────────────────────────────╯
Variables:
2024-09-07 19:06:30 +02:00
< span style = "color: #5c5cff " > ┗━━ </ span > 📓 proxy_mode: foo (< span style = "color: #00aa00 " > No proxy</ span > )
2024-09-07 19:06:28 +02:00
< / pre >
## Example 5
### config/05/config.yaml
```yml
---
proxy_mode: 1
```
### Description
The integer value "1" is invalid.
### Output
```console
foo@bar:~$ rougail -v 1.1 -m firefox -u file -ff config/05/config.yaml
```
< pre > 🛑 ERRORS
2024-09-07 19:06:30 +02:00
< span style = "color: #ff0000 " > ┗━━ </ span > '1' is an invalid string for 'proxy_mode (Configure Proxy Access to the Internet)'
╭────────────────────────── Caption ──────────────────────────╮
│ Variable < span style = "color: #ffd700 " > Default value</ span > │
│ < span style = "color: #5c5cff " > Undocumented variable</ span > Modified value │
│ < span style = "color: #ff0000 " > Undocumented but modified variable</ span > (< span style = "color: #00aa00 " > Original default value</ span > ) │
│ < span style = "color: #ffaf00 " > Unmodifiable variable</ span > │
╰─────────────────────────────────────────────────────────────╯
Variables:
< span style = "color: #5c5cff " > ┗━━ </ span > 📓 proxy_mode: < span style = "color: #ffd700 " > No proxy</ span >
2024-09-07 19:06:28 +02:00
< / pre >