Description

This tutorial shows to you an example of Rougail use on how to set a proxy in the Mozilla Firefox browser.

More precisely, this tutorial aims at reproducing this Mozilla Firefox settings page:

And the integration of part of the Firefox FoxyProxy plugin.

The idea is to have a namespace specific to FoxyProxy and to find in it part of the settings that we will have made in the main namespace.

This is what the page looks like:

Installation

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

Summary

Each step is a separerate commit. You can navigate to history to discover different aspect to the Rougail format.

• Getting started (doc)
  • [tutorial v1.1_000] Creating a structure file (doc - diff)
  • [tutorial v1.1_001] Let’s add our first variable (doc - diff)
  • [tutorial v1.1_002] Describe the variable (doc - diff)
  • [tutorial v1.1_003] Set a default value (doc - diff)
• A variable with possible values (doc)
  • [tutorial v1.1_010] A variable with a list of possible values (doc - diff)
• Group variables inside families (doc)
  • [tutorial v1.1_020] Creating a new family (doc - diff)
  • [tutorial v1.1_021] Or a sub family (doc - diff)
  • [tutorial v1.1_022] Putting a variable inside of a family or a sub family (doc - diff)
• Some suitable types (doc)
  • [tutorial v1.1_030] A variable with type "domainname" (doc - diff)
  • [tutorial v1.1_031] A variable with type’s parameters (doc - diff)
  • [tutorial v1.1_032] A variable with type "port" (doc - diff)
  • [tutorial v1.1_033] A variable with type "boolean" (doc - diff)
• Calculated default value for a variable (doc)
  • [tutorial v1.1_040] HTTPS family (doc - diff)
  • [tutorial v1.1_041] A default value calculated from another variable (doc - diff)
• Define access to variable or family (doc)
  • [tutorial v1.1_050] A disabled family (doc - diff)
  • [tutorial v1.1_051] A conditional disabled family (doc - diff)
  • [tutorial v1.1_052] A hidden family (doc - diff)
  • [tutorial v1.1_053] A conditional hidden family (doc - diff)
• A dynamically built family (doc)
  • [tutorial v1.1_060] A dynamically built family (doc - diff)
  • [tutorial v1.1_061] A conditional disabled variable with dynamic identifier (doc - diff)
• Playing with Jinja (doc)
  • [tutorial v1.1_070] A conditional hidden family with Jinja (doc - diff)
  • [tutorial v1.1_071] Jinja with a description (doc - diff)
  • [tutorial v1.1_072] Jinja with a parameter (doc - diff)
  • [tutorial v1.1_073] Jinja could returns a boolean (doc - diff)
• Custom type (doc)
  • [tutorial v1.1_080] HTTP Proxy with "proxy" type (doc - diff)
  • [tutorial v1.1_081] HTTPS and SOCKS Proxy (doc - diff)
• A web_address variable (doc)
  • [tutorial v1.1_090] A conditional disabled variable with type web_address (doc - diff)
• A full documented variable with multiple values and not mandatory (doc)
  • [tutorial v1.1_100] A conditional disabled variable with type domainname and parameters (doc - diff)
  • [tutorial v1.1_101] A variable with multiple value (doc - diff)
  • [tutorial v1.1_102] A non mandatory variable (doc - diff)
  • [tutorial v1.1_103] Examples (doc - diff)
  • [tutorial v1.1_104] Help (doc - diff)
• Practice (doc)
  • [tutorial v1.1_110] A conditional disabled boolean variable (doc - diff)
  • [tutorial v1.1_111] A boolean variable (doc - diff)
  • [tutorial v1.1_112] A Jinja conditional disabled boolean variable (doc - diff)
• The Jinja propertyerror filter (doc)
  • [tutorial v1.1_120] Disabled a variable when an other variable are disabled (doc - diff)
• Mode (doc)
  • [tutorial v1.1_130] A variable in avanced mode (doc - diff)
• Practice (doc)
  • [tutorial v1.1_140] A boolean variable (doc - diff)
  • [tutorial v1.1_141] A choice variable (doc - diff)
  • [tutorial v1.1_142] A web_address variable (doc - diff)
• Validators (doc)
  • [tutorial v1.1_150] A variable with custom validation (doc - diff)
• Namespace (doc)
  • [tutorial v1.1_160] Namespace (doc - diff)
  • [tutorial v1.1_161] New "FoxyProxy" namespace (doc - diff)
• A leadership family (doc)
  • [tutorial v1.1_170] A leadership family (doc - diff)
• Regexp type with calculation (doc)
  • [tutorial v1.1_180] Regexp type (doc - diff)
  • [tutorial v1.1_181] Calculate a random color (doc - diff)
  • [tutorial v1.1_182] Auto save value (doc - diff)
• A variable name with a known variable's attribute (doc)
  • [tutorial v1.1_190] A variable name that conflict with a known the variable's attribute "type" (doc - diff)
• Variable calculation with propertyerror (doc)
  • [tutorial v1.1_200] Variable calculation with propertyerror (doc - diff)
• Redefine variable (doc)
  • [tutorial v1.1_210] Username is mandatory if a password is set (doc - diff)
  • [tutorial v1.1_211] redefines the behavior to password mandatory if the user is defined (doc - diff)