rougail-tutorials/README.md

• Summary
• [tutorial v1.1_054] A conditional disabled variable with identifier (diff)

[tutorial v1.1_060)] A variable with type "web_address"

View the diff

Screenshot

Structure

firefox/00-proxy.yml

%YAML 1.2
---
version: 1.1

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

%YAML 1.2
---
version: 1.1

manual:
  description: Manual proxy configuration
  disabled:
    variable: _.proxy_mode
    when_not: Manual proxy configuration

  http_proxy:  # HTTP Proxy

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

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

firefox/20-manual.yml

%YAML 1.2
---
version: 1.1

manual:

  use_for_https: true  # Also use this proxy for HTTPS

  '{{ identifier }}_proxy':
    description: '{{ identifier }} Proxy'
    hidden:
      jinja: |-
        {% if my_identifier == 'HTTPS' and _.use_for_https %}
          HTTPS is same has HTTP
        {% endif %}        
      description: in HTTPS case if "_.use_for_https" is set to True
      params:
        my_identifier:
          type: identifier
    dynamic:
      - HTTPS
      - SOCKS

    address:
      description: '{{ identifier }} address'
      default:
        variable: __.http_proxy.address

    port:
      description: '{{ identifier }} port'
      default:
        variable: __.http_proxy.port

    version:
      description: SOCKS host version used by proxy
      choices:
        - v4
        - v5
      default: v5
      disabled:
        type: identifier
        when: HTTPS
...

firefox/30-auto.yml

%YAML 1.2
---
version: 1.1

auto:
  description: Automatic proxy configuration URL
  type: web_address
...

Let's generate the documentation

foo@bar:~$ git switch --detach v1.1_060
foo@bar:~$ rougail -m firefox/ -o doc

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

manual

disabled

Disabled: when the variable "proxy_mode" hasn't the value "Manual proxy configuration"

HTTP Proxy

manual.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. Validators: - well-known ports (1 to 1023) are allowed - registred ports (1024 to 49151) are allowed - private ports (greater than 49152) are allowed Default: 8080

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

HTTPS Proxy or SOCKS Proxy

This family builds families dynamically

manual.https_proxy
manual.socks_proxy

hidden

Hidden: in HTTPS case if "_.use_for_https" is set to True

Identifiers:
- HTTPS
- SOCKS

Variable	Description
manual.https_proxy.address manual.socks_proxy.address domainname mandatory	HTTPS or SOCKS address. Validator: the domain name can be an IP Default: the value of the variable "manual.http_proxy.address"
manual.https_proxy.port manual.socks_proxy.port port mandatory	HTTPS or SOCKS port. Validators: - well-known ports (1 to 1023) are allowed - registred ports (1024 to 49151) are allowed - private ports (greater than 49152) are allowed Default: the value of the variable "manual.http_proxy.port"
manual.https_proxy.version manual.socks_proxy.version choice mandatory disabled	SOCKS host version used by proxy. Choices: - v4 - v5 ← (default) Disabled: when the identifier is "HTTPS"

Variable	Description
auto web_address mandatory	Automatic proxy configuration URL. Validator: the domain name in web address can be only a hostname

Let's generate the changelog

foo@bar:~$ git switch --detach v1.1_060
foo@bar:~$ rougail -m firefox/ -o doc --doc.contents changelog

New variable

Variable	Description
auto web_address mandatory	Automatic proxy configuration URL. Validator: the domain name in web address can be only a hostname

User datas

Example 1

config/01/config.yaml

---
auto: https://auto.proxy.net/wpad.dat

Output

foo@bar:~$ git switch --detach v1.1_060
foo@bar:~$ rougail -m firefox/ -u yaml -ff config/01/config.yaml

╭──────── Caption ────────╮
│ Variable Default value  │
│          Modified value │
╰─────────────────────────╯
Variables:
┣━━ 📓 Configure Proxy Access to the Internet: No proxy
┗━━ 📓 Automatic proxy configuration URL: https://auto.proxy.net/wpad.dat ◀ loaded from the YAML file "config/01/config.yaml"

Example 2

config/02/config.yaml

---
proxy_mode: Automatic proxy configuration URL

Output

foo@bar:~$ git switch --detach v1.1_060
foo@bar:~$ rougail -m firefox/ -u yaml -ff config/02/config.yaml

🛑 ERRORS
┗━━ The following variables are mandatory but have no value:
    ┗━━ Automatic proxy configuration URL

Example 3

config/03/config.yaml

---
proxy_mode: Automatic proxy configuration URL
auto: https://auto.proxy.net/wpad.dat

Output

foo@bar:~$ git switch --detach v1.1_060
foo@bar:~$ rougail -m firefox/ -u yaml -ff config/03/config.yaml

╭────────────── Caption ───────────────╮
│ Variable Modified value              │
│          (⏳ Original default value) │
╰──────────────────────────────────────╯
Variables:
┣━━ 📓 Configure Proxy Access to the Internet: Automatic proxy configuration URL ◀ loaded from the YAML file "config/03/config.yaml" (⏳ No proxy)
┗━━ 📓 Automatic proxy configuration URL: https://auto.proxy.net/wpad.dat ◀ loaded from the YAML file "config/03/config.yaml"

• [tutorial v1.1_061] A conditional disabled variable (diff)