rougail/docs/tutorial/index.rst
2024-10-21 15:52:28 +02:00

37 lines
1.1 KiB
ReStructuredText

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.
.. demo:: 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 this Mozilla Firefox settings page:
.. 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 configuration variables
-----------------------------------------------------------
Let's dive into the configuration validation use case,
that is 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