rougail/docs/tutorial/index.rst

Tutorial with a real world sample
=====================================

Here's a quite well supplied tutorial, we're gonna start with a use case that comes from the real world.

.. objectives:: Configuring (the setting of) your favorite web browser

    This tutorial will show you an example of Rougail use based on the
    "how to set a proxy" in the `Mozilla Firefox <https://www.mozilla.org/en-US/firefox/new/>`_ browser
    use case.

More precisely, this tutorial aims at reproducing :term:`variable`\ s (in this use case we will call them configuration options) behind this Mozilla Firefox settings page:

.. image:: images/firefox.png

.. note:: We are not coding a firefox plugin here.
          We are just going to handle some of the firefox configuration settings
          with Rougail.

Presentation of the firefox option configuration variables
-----------------------------------------------------------

Let's dive into this configuration validation use case.
The values entered by the user that have to be validated.

At first glance we have a selection of five options configuration values that we need to fill in:

.. image:: images/firefox_01.png


.. toctree::
   :titlesonly:
   :caption: The firefox tutorial steps
   :hidden:

   preliminary
   proxymode
   tutorial