No description

Find a file

Emmanuel Garette 536c6e18cd [tutorial 012] 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-07 06:16:08 +01:00
config	[tutorial v1.1_012)] Set a default value (config and doc)	2025-11-07 06:16:08 +01:00
firefox	[tutorial 012] Set a default value	2025-11-07 06:16:08 +01:00
firefox.png	[tutorial v1.1_010)] A first variable with only a name (config and doc)	2025-11-07 06:16:06 +01:00
foxyproxy.png	[init] Discover Rougail	2025-11-07 06:16:04 +01:00
README.md	[tutorial v1.1_012)] Set a default value (config and doc)	2025-11-07 06:16:08 +01:00

README.md

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

View the diff

Screenshot

Structure

firefox/00-proxy.yml

%YAML 1.2
---
version: 1.1

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

Let's generate the documentation

foo@bar:~$ git switch --detach v1.1_012
foo@bar:~$ 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

foo@bar:~$ git switch --detach v1.1_012
foo@bar:~$ 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.yaml

---

Output

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

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

Example 2

config/02/config.yaml

---
proxy_mode: No proxy

Output

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

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

Example 3

config/03/config.yaml

---
proxy_mode: Manual proxy configuration

Output

foo@bar:~$ git switch --detach v1.1_012
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: Manual proxy configuration ◀ loaded from the YAML file "config/03/config.yaml" (⏳ No proxy)

Example 4

config/04/config.yaml

---
proxy_mode: foo

Output

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

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

Example 5

config/05/config.yaml

---
proxy_mode: 1

Output

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

🔔 WARNINGS
┗━━ the value "1" is an invalid string for "proxy_mode" (Configure Proxy Access to the Internet), which is not a string, it will be ignored when loading from the YAML file "config/05/config.yaml"
╭─────── Caption ────────╮
│ Variable Default value │
╰────────────────────────╯
Variables:
┗━━ 📓 Configure Proxy Access to the Internet: No proxy

[tutorial v1.1_013] Limits the possible values for the variable (diff)