stove/rougail
3
0
Fork 0
Code Issues 11 Pull requests 1 Projects Releases Wiki Activity

links to the tutorial

Browse source
This commit is contained in:
gwen 2024-10-15 09:20:01 +02:00
parent d47011efe4
commit 080bb9c489
1 changed files with 26 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

37
docs/gettingstarted.rst
View file

@ -76,33 +76,48 @@ Here is an empty rougail dictionary YAML file
:download:`source file <https://forge.cloud.silique.fr/stove/rougail-tutorials/raw/tag/v1.1_010/firefox/00-proxy.yml>`
You can see that there is just a `version` specification.
Here is a :term:`dictionary` example:
.. glossary::
.. code-block:: yaml
:linenos:
version
---
version: '1.1'
proxy:
description: Configure Proxy Access to the Internet
type: family
The version is here a Rougail YAML dictionary version format.
It is set in the beginning of a YAML dictionary, or globaly in the Rougail settings
for example from the command line
Line 3, we declare a **variable** named `proxy` with his `description` line 4 and his `type` line 5.
.. note:: You can set the format in the Rougail command line tool like this:
.. code-block:: bash
foo@bar:~$ rougail -v 1.1
The variables
-----------------
Here is a :term:`dictionary` example with a variable into it:
.. extinclude:: https://forge.cloud.silique.fr/stove/rougail-tutorials/raw/commit/v1.1_003/config/03/config.yaml
:linenos:
:language: yaml
:caption: A rougail dictionnary file with a variable named `proxy_mode`. It's the Rougail YAML dictionary format.
:name: RougailDictionaryFirstVariable
:download:`source file <https://forge.cloud.silique.fr/stove/rougail-tutorials/raw/commit/v1.1_003/config/03/config.yaml>`
Here we declare a **variable** named `proxy_mode` with a variable :term:`default value`.
A variable can be defined with no default value at all.
variable
Here is a second definition of a :term:`variable`: it is a declaration unit that represents a business domain metaphor,
A variable is a declaration unit that represents a business domain metaphor,
the most common example is that a variable that represents a configuration option
in a application, but a variable represents something more that a configuration option.
It provides a business domain specific representation unit.
.. note:: Dictionaries can just define a list of variables, but we will see that
we can specify a lot more. We can define variables **and** their relations,
**and** the consistency between them.
**and** the relations between them.
In the next step, we will explain through a tutorial how to construct a list of variables.