rougail-tutorials/README.md

• Summary
• [tutorial v1.1_021] Or a sub family (diff)

[tutorial v1.1_022] Putting a variable inside of a family or a sub family

View the diff

Read the documentation

Screenshot

Clone and install

To test this tutorial, you need to download this repository and install Rougail:

git clone -b 1.1 https://forge.cloud.silique.fr/stove/rougail-tutorials.git
cd rougail-tutorials
python -m venv venv_rougail
. venv_rougail/bin/activate
pip install rougail-cli rougail-output-exporter rougail-output-doc rougail-user-data-yaml

Then switch to the tutorial page:

git switch --detach v1.1_022

Structure

.
└── firefox
    ├── 00-proxy.yml
    └── 10-manual.yml

Contents of the firefox/10-manual.yml file

%YAML 1.2
---
version: 1.1

manual:  # Manual proxy configuration

  http_proxy:  # HTTP Proxy

    address:  # HTTP address
...

---

Let's generate the documentation

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

Note

Path: manual

HTTP Proxy

Note

Path: manual.http_proxy

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

---

Let's generate the changelog

rougail -m firefox/ -o doc --doc.contents changelog

New variable

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

---

User datas

Example 1

config/01/config.yml

---

---

Output

rougail -m firefox/ -u yaml -yf config/01/config.yml

Caution

• manual (Manual proxy configuration)
  • http_proxy (HTTP Proxy)
    • address (HTTP address): 🛑 mandatory variable but has no value

---

Example 2

config/02/config.yml

---
manual:
  http_proxy:
    address: example.net

---

Output

rougail -m firefox/ -u yaml -yf config/02/config.yml

Note

Caption:

• Variable
• Default value
• Modified value

Variables:

• 📓 proxy_mode (Configure Proxy Access to the Internet): No proxy
• 📂 manual (Manual proxy configuration)
  • 📂 http_proxy (HTTP Proxy)
    • 📓 address (HTTP address): example.net ← loaded from the YAML file "config/02/config.yml"

---

Example 3

config/03/config.yml

---
manual:
  http_proxy:
    address: example.net
    port: 3128

---

Output

rougail -m firefox/ -u yaml -yf config/03/config.yml

Warning

• variable or family "manual.http_proxy.port" does not exist, it will be ignored when loading from the YAML file "config/03/config.yml"

Note

Caption:

• Variable
• Default value
• Modified value

Variables:

• 📓 proxy_mode (Configure Proxy Access to the Internet): No proxy
• 📂 manual (Manual proxy configuration)
  • 📂 http_proxy (HTTP Proxy)
    • 📓 address (HTTP address): example.net ← loaded from the YAML file "config/03/config.yml"

---

• [tutorial v1.1_030] A variable with type "domainname" (diff)