[tutorial v1.1_082] Redefine default value in custom type variable

Read the tutorial "Redefine default value in custom type variable" 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_082

Structure

.
├── firefox
│   ├── 00-proxy.yml
│   ├── 10-manual.yml
│   └── 20-manual.yml
└── types
    └── proxy
        └── 00-type.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
    type: proxy
    hidden:
      variable: _.use_for_https

  socks_proxy:
    description: SOCKS Proxy
    type: proxy

    version:
      description: SOCKS host version used by proxy
      choices:
        - v4
        - v5
      default: v5
...

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

---
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/ --types types/proxy -u yaml -yf config/01/config.yml

Note

Caption:

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 (Proxy address): http.proxy.net ← loaded from the YAML file "config/01/config.yml"
  - 📓 port (Proxy 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 (Proxy address): https.proxy.net ← loaded from the YAML file "config/01/config.yml" (⏳ http.proxy.net)
  - 📓 port (Proxy port): 3128
- 📂 socks_proxy (SOCKS Proxy)
  - 📓 address (Proxy address): http.proxy.net
  - 📓 port (Proxy port): 3128
  - 📓 version (SOCKS host version used by proxy): v5

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

5.2 KiB Raw Blame History