• List of all the tutorial steps
• [Previous tutorial v1.1_051] A conditional disabled family (diff)

[tutorial v1.1_052] A hidden family

• Read the tutorial "A hidden family" in the documentation
• View the changes in the files

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_052

Structure

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

Contents of the firefox/20-manual.yml file

%YAML 1.2
---
version: 1.1

manual:

  use_for_https: true  # Also use this proxy for HTTPS

  https_proxy:
    description: HTTPS Proxy
    hidden: true

    address:
      description: HTTPS address
      default:
        variable: __.http_proxy.address

    port:
      description: HTTPS Port
      default:
        variable: __.http_proxy.port
...

---

Let's generate the documentation

rougail -m firefox/ -o doc

View the documentation file

---

Let's generate the changelog

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

View the changelog file

---

User datas

Example 1

config/01/config.yml

---
proxy_mode: Manual proxy configuration
manual:
  http_proxy:
    address: http.proxy.net
    port: 3128
  use_for_https: false
  https_proxy:
    address: https.proxy.net

---

Output

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

Warning

• manual (Manual proxy configuration)
  • https_proxy (HTTPS Proxy)
    • address (HTTPS address): 🔔 family "https_proxy" (HTTPS Proxy) has property hidden, so cannot access to "address" (HTTPS address), it will be ignored when loading from the YAML file "config/01/config.yml"

Note

Caption:

• Variable
• Unmodifiable variable
• Default value
• Modified value
• (⏳ Original default value)

Variables:

• 📓 proxy_mode (Configure Proxy Access to the Internet): Manual proxy configuration ← loaded from the YAML file "config/01/config.yml" (⏳ No proxy)
• 📂 manual (Manual proxy configuration)
  • 📂 http_proxy (HTTP Proxy)
    • 📓 address (HTTP address): http.proxy.net ← loaded from the YAML file "config/01/config.yml"
    • 📓 port (HTTP Port): 3128 ← loaded from the YAML file "config/01/config.yml" (⏳ 8080)
  • 📓 use_for_https (Also use this proxy for HTTPS): false ← loaded from the YAML file "config/01/config.yml" (⏳ true)
  • 📂 https_proxy (HTTPS Proxy)
    • 📓 address (HTTPS address): http.proxy.net
    • 📓 port (HTTPS Port): 3128

---

Output in read write mode

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

Warning

• manual (Manual proxy configuration)
  • https_proxy (HTTPS Proxy)
    • address (HTTPS address): 🔔 family "https_proxy" (HTTPS Proxy) has property hidden, so cannot access to "address" (HTTPS address), it will be ignored when loading from the YAML file "config/01/config.yml"

Note

Caption:

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

Variables:

• 📓 proxy_mode (Configure Proxy Access to the Internet): Manual proxy configuration ← loaded from the YAML file "config/01/config.yml" (⏳ No proxy)
• 📂 manual (Manual proxy configuration)
  • 📂 http_proxy (HTTP Proxy)
    • 📓 address (HTTP address): http.proxy.net ← loaded from the YAML file "config/01/config.yml"
    • 📓 port (HTTP Port): 3128 ← loaded from the YAML file "config/01/config.yml" (⏳ 8080)
  • 📓 use_for_https (Also use this proxy for HTTPS): false ← loaded from the YAML file "config/01/config.yml" (⏳ true)

---

Example 2

config/02/config.yml

---
proxy_mode: Manual proxy configuration
manual:
  http_proxy:
    address: http.proxy.net
    port: 3128
  use_for_https: true

---

Output

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

Note

Caption:

• Variable
• Unmodifiable variable
• Default value
• Modified value
• (⏳ Original default value)

Variables:

• 📓 proxy_mode (Configure Proxy Access to the Internet): Manual proxy configuration ← loaded from the YAML file "config/02/config.yml" (⏳ No proxy)
• 📂 manual (Manual proxy configuration)
  • 📂 http_proxy (HTTP Proxy)
    • 📓 address (HTTP address): http.proxy.net ← loaded from the YAML file "config/02/config.yml"
    • 📓 port (HTTP Port): 3128 ← loaded from the YAML file "config/02/config.yml" (⏳ 8080)
  • 📓 use_for_https (Also use this proxy for HTTPS): true ← loaded from the YAML file "config/02/config.yml" (⏳ true)
  • 📂 https_proxy (HTTPS Proxy)
    • 📓 address (HTTPS address): http.proxy.net
    • 📓 port (HTTPS Port): 3128

---

• [Next tutorial v1.1_053] A conditional hidden family (diff)