No description

Find a file

Emmanuel Garette f87332920d [tutorial 011] The variable description (config and doc)		2024-10-23 20:01:13 +02:00
config	[tutorial 011] The variable description (config and doc)	2024-10-23 20:01:13 +02:00
firefox	[tutorial 010] A first variable with only a name	2024-10-23 20:01:11 +02:00
firefox.png	[tutorial 000] A structured file with format version (config and doc)	2024-10-23 20:01:09 +02:00
foxyproxy.png	[init] Discover Rougail	2024-10-23 20:01:08 +02:00
README.md	[tutorial 011] The variable description (config and doc)	2024-10-23 20:01:13 +02:00

README.md

[tutorial 011] The variable description

View the diff

Screenshot

Structure

firefox/00-proxy.yml

---
proxy_mode:
  description: Configure Proxy Access to the Internet

Generated documentation

foo@bar:~$ rougail -v 1.1 -m firefox/ -o doc -do github

Variables

Variable	Description
proxy_mode `string` `mandatory`	Configure Proxy Access to the Internet.

User data

Example 1

config/01/config.yaml

---

Output

foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/01/config.yaml

🛑 ERRORS
┣━━ The following variables are mandatory but have no value:
┗━━   - proxy_mode (Configure Proxy Access to the Internet)

Example 2

config/02/config.yaml

---
proxy_mode: No proxy

Output

foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/02/config.yaml

╭────────────────────────── Caption ──────────────────────────╮
│ Variable                           Default value            │
│ Undocumented variable              Modified value           │
│ Undocumented but modified variable (Original default value) │
│ Unmodifiable variable                                       │
╰─────────────────────────────────────────────────────────────╯
Variables:
┗━━ 📓 proxy_mode: No proxy

Example 3

config/03/config.yaml

---
proxy_mode: Manual proxy configuration

Output

foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/03/config.yaml

╭────────────────────────── Caption ──────────────────────────╮
│ Variable                           Default value            │
│ Undocumented variable              Modified value           │
│ Undocumented but modified variable (Original default value) │
│ Unmodifiable variable                                       │
╰─────────────────────────────────────────────────────────────╯
Variables:
┗━━ 📓 proxy_mode: Manual proxy configuration

Example 4

config/04/config.yaml

---
proxy_mode: foo

Output

foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/04/config.yaml

╭────────────────────────── Caption ──────────────────────────╮
│ Variable                           Default value            │
│ Undocumented variable              Modified value           │
│ Undocumented but modified variable (Original default value) │
│ Unmodifiable variable                                       │
╰─────────────────────────────────────────────────────────────╯
Variables:
┗━━ 📓 proxy_mode: foo

Example 5

config/05/config.yaml

---
proxy_mode: 1

Output

foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/05/config.yaml

🛑 ERRORS
┣━━ "1" is an invalid string for "proxy_mode (Configure Proxy Access to the Internet)"
┣━━ The following variables are mandatory but have no value:
┗━━   - proxy_mode (Configure Proxy Access to the Internet)

[tutorial 012] A default value (diff)