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

# python -m venv rougail
# . rougail/bin/activate
# pip install rougail-cli rougail-output-exporter rougail-output-doc rougail-user-data-file

Summary

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

• Getting started
  • Structural file
    • [tutorial 000] A structured file with format version (diff)
    • [tutorial 001] The format version in commandline (diff)
  • Variable: choice the proxy mode
    • [tutorial 010] A first variable with only a name (diff)
    • [tutorial 011] The variable description (diff)
    • [tutorial 012] A default value (diff)
    • [tutorial 013] A variable with type "choice" (diff)
    • [tutorial 014] Choice type is optional (diff)
  • Family: proxy manual
    • [tutorial 020] A family (diff)
    • [tutorial 021] A sub family (diff)
    • [tutorial 022] A variable inside sub family (diff)
    • [tutorial 023] Family type is optional (diff)
• HTTP Manual mode
  • Variable: type and type parameters
    • [tutorial 024] A variable with type "domainname" (diff)
    • [tutorial 025] A variable with type's parameters (diff)
    • [tutorial 026] A variable with type "port" (diff)
  • Property: disabled
    • [tutorial 027] A disabled family (diff)
    • [tutorial 028] A conditional disabled family with a variable (diff)
    • [tutorial 029] Type variable is optional (diff)
• HTTP proxy provides HTTPS proxy
  • [tutorial 030] A variable with type "boolean" (diff)
  • [tutorial 031] Bases type is optional if default value (diff)
• HTTPS Manual mode
  • Property: hidden
    • [tutorial 032] Copy HTTP manual proxy to HTTPS manual proxy (diff)
    • [tutorial 033] An hidden family (diff)
    • [tutorial 034] A conditional hidden family with a variable (diff)
  • Variable: calculated default value
    • [tutorial 035] A calculated default value (diff)
    • [tutorial 036] Variable type and parameters type are copied with default value (diff)
• SOCKS Manual mode
  • Family: dynamic
    • [tutorial 040] Family: a dynamic family (diff)
  • Property: Jinja and identifier condition
    • [tutorial 041] A conditional hidden family with Jinja (diff)
    • [tutorial 042] Jinja with a parameter (diff)
    • [tutorial 043] Jinja with a description (diff)
    • [tutorial 044] A conditional disabled variable with identifier (diff)
• Shorthand mode
  • [tutorial 050] Family: "shorthand" mode (diff)
  • [tutorial 051] Variable: "shorthand" mode (diff)
• Automatic proxy
  • [tutorial 060] A variable with type "web_address" (diff)
  • [tutorial 061] A conditional disabled variable (diff)
• Address for which proxy will be desactivated
  • Variable: multi and non mandatory
    • [tutorial 070] A variable with type "domainname", parameters type and disabled (diff)
    • [tutorial 071] A variable with multiple value (diff)
    • [tutorial 072] A non mandatory variable (diff)
  • Variable: extra description
    • [tutorial 073] Examples (diff)
    • [tutorial 074] Help (diff)
• Prompt for authentication if password is saved
  • [tutorial 075] A variable (diff)
• Use proxy DNS when using SOCKS v5
  • [tutorial 076] A variable (diff)
  • [tutorial 077] Jinja calculation for an hidden variable with a potential inaccessible varible (diff)
  • [tutorial 078] A variable in avanced mode (diff)
• DNS over HTTPS
  • [tutorial 080] A boolean variable (diff)
  • [tutorial 081] A choice variable (diff)
  • [tutorial 082] A web_address variable (diff)
  • [tutorial 083] A variable with custom validation (diff)
• Namespace
  • Relative path
    • [tutorial 090] Variable in same family (diff)
    • [tutorial 091] Variable in parent family (diff)
    • [tutorial 092] Namespace (diff)
    • [tutorial 100] xxx (diff)
    • [tutorial 101] xxx (diff)
    • [tutorial 102] xxx (diff)
    • [tutorial 103] xxx (diff)
    • [tutorial 104] xxx (diff)
    • [tutorial 110] xxx (diff)