dictionary removed, replaced by structure file

This commit is contained in:
gwen 2025-02-09 10:47:48 +01:00
parent 038cd9429a
commit 0f0d955e9f
2 changed files with 15 additions and 17 deletions

View file

@ -27,7 +27,7 @@ What is a consistency handling system ?
Here is the :xref:`tiramisu library`. Here is the :xref:`tiramisu library`.
In the Rougail scope, we call it :term:`variable`\ s and :term:`families`. In the Rougail scope, we call it :term:`variable`\ s and :term:`families`.
In Rougail, the families and variables are located in the :term:`structure files <dictionaries>` (the term "dictionary" is also used as a synonym). In Rougail, the families and variables are located in the :term:`structure files <dictionaries>`.
The structure files The structure files
--------------------- ---------------------
@ -35,12 +35,10 @@ The structure files
.. glossary:: .. glossary::
structure file structure file
dictionary
dictionaries
A dictionary or a a structure file in the Rougail meaning is a YAML file that describes variables A structure file in the Rougail meaning is a YAML file that describes variables
and their dependencies / consistencies. and their dependencies / consistencies.
There can be a lot of dictionary files located in many different folders. There can be a lot of structure files located in many different folders.
Rougail reads all the dictionaries and loads them into a single object Rougail reads all the dictionaries and loads them into a single object
that handles the variables consistency. that handles the variables consistency.
@ -60,7 +58,7 @@ The YAML structure files format
We need to learn first the specifics of the YAML dictionaries file format in Rougail, as well as some templating concepts. We need to learn first the specifics of the YAML dictionaries file format in Rougail, as well as some templating concepts.
Here is an empty Rougail dictionary YAML file Here is an empty Rougail structure YAML file
.. extinclude:: https://forge.cloud.silique.fr/stove/rougail-tutorials/raw/tag/v1.1_000/firefox/00-proxy.yml .. extinclude:: https://forge.cloud.silique.fr/stove/rougail-tutorials/raw/tag/v1.1_000/firefox/00-proxy.yml
:linenos: :linenos:
@ -81,8 +79,8 @@ You can see that there is just a `version` specification.
version version
The version is here a Rougail YAML dictionary version format. The version is here a Rougail YAML structure file version format.
It is set in the beginning of a YAML dictionary, or globaly in the Rougail settings It is set in the beginning of a YAML structure file, or globaly in the Rougail settings
for example from the command line for example from the command line
.. note:: You can set the format in the Rougail command line tool like this: .. note:: You can set the format in the Rougail command line tool like this:
@ -98,7 +96,7 @@ Here is a :term:`structure file <dictionary>` example with a variable into it:
.. extinclude:: https://forge.cloud.silique.fr/stove/rougail-tutorials/raw/tag/v1.1_010/firefox/00-proxy.yml .. extinclude:: https://forge.cloud.silique.fr/stove/rougail-tutorials/raw/tag/v1.1_010/firefox/00-proxy.yml
:language: yaml :language: yaml
:caption: A Rougail dictionnary file with a variable named `proxy_mode`. It's the Rougail YAML dictionary format. :caption: A Rougail dictionnary file with a variable named `proxy_mode`. It's the Rougail YAML structure file format.
:name: RougailDictionaryFirstVariable :name: RougailDictionaryFirstVariable
.. ..

View file

@ -13,7 +13,7 @@ Preliminaries
We assume that Rougail's library is :ref:`already installed <installation>` on your computer (or in a virtual environment). We assume that Rougail's library is :ref:`already installed <installation>` on your computer (or in a virtual environment).
.. type-along:: an empty dictionary .. type-along:: an empty structure file
An empty structure description file An empty structure description file
@ -23,14 +23,14 @@ Preliminaries
workplace workplace
├── firefox ├── firefox
   │   └── dictionary.yml    │   └── struct.yml
- Let's make a :file:`workplace` directory, with a :file:`firefox` subfolder. - Let's make a :file:`workplace` directory, with a :file:`firefox` subfolder.
- First, we wil make a :term:`dictionary`, so let's create a :file:`dictionary.yml` file - First, we wil make a :term:`structure file <dictionary>`, so let's create a :file:`struct.yml` file
located in the :file:`firefox` subfolder. located in the :file:`firefox` subfolder.
The dictionary The structure file
---------------- --------------------
This is an empty Rougail dictionnary This is an empty Rougail dictionnary
@ -165,14 +165,14 @@ Values are mandatory
------------------------- -------------------------
It is the operator's responsibility to set configuration options values. It is the operator's responsibility to set configuration options values.
He does not work with the dictionary (the structure file), He does not work with the structure file,
he is responsible for other files, called the configuration files. he is responsible for other files, called the configuration files.
.. glossary:: .. glossary::
configuration file configuration file
A configuration file is a file where only the values of the configuration options are assigned. The structure, the consistency of the variables between them is not the responsibility of these files (but of the dictionary files). A configuration file is a file where only the values of the configuration options are assigned. The structure, the consistency of the variables between them is not the responsibility of these files (but of the structure files).
.. exercise:: Folder structure update .. exercise:: Folder structure update
@ -180,7 +180,7 @@ he is responsible for other files, called the configuration files.
workplace workplace
├── firefox ├── firefox
   │   ├── dictionary.yml    │   ├── struct.yml
└── config └── config
└── config.yml └── config.yml