rougail-tutorials/firefox/00-proxy.yml

---
proxy_mode:
  description: Configure Proxy Access to the Internet
  type: choice
  choices:
    - No proxy
    - Auto-detect proxy settings for this network
    - Use system proxy settings
    - Manual proxy configuration
    - Automatic proxy configuration URL
  default: No proxy
[tutorial 000] A structured file with format version 2024-10-23 20:01:09 +02:00			`---`
[tutorial 010] A first variable with only a name 2024-10-23 20:01:11 +02:00			`proxy_mode:`
[tutorial 011] The variable description We can add a description to this first variable. This information is useful for: - documentation - error message - help user to known which value to set to this variable (for example with [the user data plugin Questionary](https://forge.cloud.silique.fr/gnunux/rougail-user-data-questionary)). 2024-10-23 20:01:13 +02:00			`description: Configure Proxy Access to the Internet`
[tutorial 013] A variable with type "choice" "Foo" should not be an option to the "proxy_mode" variable. Now the "proxy_mode" type is "choice", that means that there is a list of available values that can be selected. We say that the "proxy_mode" variable is constrained (by choices): this variable accept, in fact, only a list of choices. 2024-10-23 20:01:15 +02:00			`type: choice`
			`choices:`
			`- No proxy`
			`- Auto-detect proxy settings for this network`
			`- Use system proxy settings`
			`- Manual proxy configuration`
			`- Automatic proxy configuration URL`
[tutorial 012] 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"). 2024-10-23 20:01:14 +02:00			`default: No proxy`