stove/rougail-tutorials
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
No description
9 commits 2 branches 42 tags 41 MiB
Find a file
Emmanuel Garette bbd8f9a6fa [tutorial v1.1_003] Set a default value 
Now we can define the default value of this variable.

If the user doesn't touch this variable's value, the value is "No proxy"

As user intervention is no more required, so the variable change it's default mode too (from "basic" to "standard").
2025-11-09 19:31:07 +01:00
config [tutorial v1.1_003)] Set a default value (config and doc) 2025-11-09 19:31:07 +01:00
firefox [tutorial v1.1_003] Set a default value 2025-11-09 19:31:07 +01:00
firefox.png [tutorial v1.1_001)] A first variable with only a name (config and doc) 2025-11-09 19:31:05 +01:00
foxyproxy.png [init] Discover Rougail 2025-11-09 19:31:03 +01:00
install.txt [init] Discover Rougail 2025-11-09 19:31:03 +01:00
README.md [tutorial v1.1_003)] Set a default value (config and doc) 2025-11-09 19:31:07 +01:00
tree.html [tutorial v1.1_003)] Set a default value (config and doc) 2025-11-09 19:31:07 +01:00

README.md

[tutorial v1.1_003)] Set a default value

View the diff

Screenshot

Firefox Proxy setting

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_003

Structure

.
└── firefox
    └── 00-proxy.yml


Contents of the firefox/00-proxy.yml file

%YAML 1.2
---
version: 1.1

proxy_mode: No proxy  # Configure Proxy Access to the Internet
...

Let's generate the documentation

rougail -m firefox/ -o doc
Variable                                                                                        Description                                                                                    
proxy_mode
string mandatory		 Configure Proxy Access to the Internet.
Default: No proxy

Let's generate the changelog

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

Modified variable

Variable                                                                                        Description                                                                                    
proxy_mode
string mandatory		 Configure Proxy Access to the Internet.
Default: No proxy

User datas

Example 1

config/01/config.yml

---

Output

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

╭─────── Caption ────────╮
│ Variable Default value │
╰────────────────────────╯
Variables:
┗━━ 📓 Configure Proxy Access to the Internet: No proxy

Example 2

config/02/config.yml

---
proxy_mode: No proxy

Output

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

╭────────────── Caption ───────────────╮
│ Variable Modified value              │
│          (⏳ Original default value) │
╰──────────────────────────────────────╯
Variables:
┗━━ 📓 Configure Proxy Access to the Internet: No proxy ◀ loaded from the YAML file "config/02/config.yml" (⏳ No proxy)

Example 3

config/03/config.yml

---
proxy_mode: foo

Output

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

╭────────────── Caption ───────────────╮
│ Variable Modified value              │
│          (⏳ Original default value) │
╰──────────────────────────────────────╯
Variables:
┗━━ 📓 Configure Proxy Access to the Internet: foo ◀ loaded from the YAML file "config/03/config.yml" (⏳ No proxy)