• Summary
• [tutorial 035] A calculated default value (diff)

[tutorial 036] Variable type and parameters type are copied with default value

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
  disabled:
    variable: proxy_mode
    when_not: 'Manual proxy configuration'

  http_proxy:
    description: HTTP Proxy

    address:
      description: HTTP address
      type: domainname
      params:
        allow_ip: true

    port:
      description: HTTP Port
      type: port
      default: 8080

firefox/20-manual.yml

---
manual:

  use_for_https:
    description: Also use this proxy for HTTPS
    default: true

  https_proxy:
    description: HTTPS Proxy
    hidden:
      variable: manual.use_for_https

    address:
      description: HTTPS address
      default:
        variable: manual.http_proxy.address

    port:
      description: HTTPS Port
      default:
        variable: manual.http_proxy.port

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

disabled

Disabled: proxy_mode.

HTTP Proxy

Variable	Description
manual.http_proxy.address domainname mandatory	HTTP address. Validator: the domain name can be an IP
manual.http_proxy.port port mandatory	HTTP Port. Default: 8080

Variable	Description
manual.use_for_https boolean mandatory	Also use this proxy for HTTPS. Default: True

HTTPS Proxy

hidden

Hidden: manual.use_for_https.

Variable	Description
manual.https_proxy.address domainname mandatory	HTTPS address. Validator: the domain name can be an IP Default: the value of the variable "manual.http_proxy.address".
manual.https_proxy.port port mandatory	HTTPS Port. Default: the value of the variable "manual.http_proxy.port".

• [tutorial 040] Family: a dynamic family (diff)