rougail-tutorials/README.md

• Summary
• [tutorial v1.1_083] Redefine other parameter in custom type (diff)

[tutorial v1.1_090] A conditional disabled variable with type web_address

Read the tutorial "A conditional disabled variable with type web_address" in 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_090

Structure

.
├── firefox
│   ├── 00-proxy.yml
│   ├── 10-manual.yml
│   ├── 20-manual.yml
│   └── 30-auto.yml
└── types
    └── proxy
        └── 00-type.yml

Contents of the firefox/30-auto.yml file

%YAML 1.2
---
version: 1.1

auto:
  description: Automatic proxy configuration URL
  type: web_address
  disabled:
    variable: _.proxy_mode
    when_not: Automatic proxy configuration URL
...

---

Let's generate the documentation

rougail -m firefox/ --types types/proxy -o doc

View the documentation file

---

Let's generate the changelog

rougail -m firefox/ --types types/proxy -o doc --doc.contents changelog --doc.changelog.previous_json_file previous.yml

View the changelog file

---

User datas

Example 1

config/01/config.yml

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

---

Output

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

Warning

• auto (Automatic proxy configuration URL): 🔔 variable has property disabled, it will be ignored when loading from the YAML file "config/01/config.yml"

Note

Caption:

• Variable
• Default value

Variables:

• 📓 proxy_mode (Configure Proxy Access to the Internet): No proxy

---

Example 2

config/02/config.yml

---
proxy_mode: Automatic proxy configuration URL

---

Output

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

Caution

• auto (Automatic proxy configuration URL): 🛑 mandatory variable but has no value

---

Example 3

config/03/config.yml

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

---

Output

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

Note

Caption:

• Variable
• Modified value
• (⏳ Original default value)

Variables:

• 📓 proxy_mode (Configure Proxy Access to the Internet): Automatic proxy configuration URL ← loaded from the YAML file "config/03/config.yml" (⏳ No proxy)
• 📓 auto (Automatic proxy configuration URL): https://auto.proxy.net/wpad.dat ← loaded from the YAML file "config/03/config.yml"

---

• [tutorial v1.1_100] A conditional disabled variable with type domainname and parameters (diff)