rougail-tutorials/README.md

Table of Contents

• Summary
• Description
• Structure
• firefox/00-proxy.yml
• Generated documentation
• Variables
• User data
• Example 1
• config/01/config.yaml
• Description
• Output
• Example 2
• config/02/config.yaml
• Output
• Example 3
• config/03/config.yaml
• Output
• Example 4
• config/04/config.yaml
• Description
• Output
• Example 5
• config/05/config.yaml
• Description
• Output

Summary

• [tutorial 001] An empty file (diff)
• [tutorial 002] A first variable (diff)
• [tutorial 003] A first variable (diff)
• [tutorial 004] The variable description (diff)
• [tutorial 005] A default value (diff)

Description

A default value

Now we can define the default value of this variable.

If the user doesn't touch this variable's value, the value is "No proxy"

As user intervention is no more required, so the variable change it's default mode too (from "basic" to "standard").

Structure

firefox/00-proxy.yml

---
proxy_mode:
  description: Configure Proxy Access to the Internet
  default: No proxy

Generated documentation

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

Variables

Variable	Description
proxy_mode string standard mandatory	Configure Proxy Access to the Internet. Default: No proxy

User data

Example 1

config/01/config.yaml

---

Description

The user data file is empty. So it's only default value that will be used.

Output

foo@bar:~$ rougail -v 1.1 -m firefox -u file -ff config/01/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 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 (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 (No proxy)

Example 4

config/04/config.yaml

---
proxy_mode: foo

Description

"foo" should be an invalid value for this variable.

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 (No proxy)

Example 5

config/05/config.yaml

---
proxy_mode: 1

Description

The integer value "1" is invalid.

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)'
╭────────────────────────── Caption ──────────────────────────╮
│ Variable                           Default value            │
│ Undocumented variable              Modified value           │
│ Undocumented but modified variable (Original default value) │
│ Unmodifiable variable                                       │
╰─────────────────────────────────────────────────────────────╯
Variables:
┗━━ 📓 proxy_mode: No proxy