• Summary
• [tutorial 022] A variable inside sub family (diff)

[tutorial 023] Family type is optional

View the diff

Screenshot

Structure

firefox/00-proxy.yml

---
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

---
manual:
  description: Manual proxy configuration

  http_proxy:
    description: HTTP Proxy

    address:
      description: HTTP address

Generated documentation

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

Variables

Variable	Description
proxy_mode choice mandatory	Configure Proxy Access to the Internet. Choices: - No proxy ← (default) - Auto-detect proxy settings for this network - Use system proxy settings - Manual proxy configuration - Automatic proxy configuration URL

Manual proxy configuration

HTTP Proxy

Variable	Description
manual.http_proxy.address string mandatory	HTTP address.

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:
┗━━   - manual.http_proxy.address (HTTP address)

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

🛑 ERRORS
┣━━ The following variables are mandatory but have no value:
┗━━   - manual.http_proxy.address (HTTP address)

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

🛑 ERRORS
┣━━ The following variables are mandatory but have no value:
┗━━   - manual.http_proxy.address (HTTP address)

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

🛑 ERRORS
┣━━ "foo" is an invalid choice for "proxy_mode (Configure Proxy Access to the Internet)", only 
┃   "Auto-detect proxy settings for this network", "Automatic proxy configuration URL", "Manual proxy 
┃   configuration", "No proxy" and "Use system proxy settings" are allowed
┣━━ The following variables are mandatory but have no value:
┗━━   - manual.http_proxy.address (HTTP address)

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 choice for "proxy_mode (Configure Proxy Access to the Internet)", only "Auto-detect
┃   proxy settings for this network", "Automatic proxy configuration URL", "Manual proxy configuration", 
┃   "No proxy" and "Use system proxy settings" are allowed
┣━━ The following variables are mandatory but have no value:
┗━━   - manual.http_proxy.address (HTTP address)

• [tutorial 024] A variable with type "domainname" (diff)