diff --git a/docs/structured_data.rst b/docs/structured_data.rst index c4b39bac9..ef18d232c 100644 --- a/docs/structured_data.rst +++ b/docs/structured_data.rst @@ -22,15 +22,21 @@ to generate configuration files. :term:`Families ` and :term:`variables ` can be defined in several structure files. These structure files are then aggregated. +.. _namespace: + Separation of structures into namespaces ---------------------------------------- -A namespace is a way to organize and group related variables under a unique name. +.. glossary:: -It: + namespace -- to avoid naming conflicts -- permet logical grouping: related variables can be grouped together + A namespace is a way to organize and group related variables under a unique name. + +It enables us to: + +- avoid naming conflicts +- permit logical grouping: related variables can be grouped together - scope control: namespaces limit the visibility of variable to the namespace itself By default there is no namespace. @@ -71,7 +77,7 @@ The structure file processing ---------------------------------- The structured files contain information that will be used by the consistency handling system for structure validation. -This is what we call structured data write in Rougail format. +This is what we call :term:`structured data` writen in Rougail format. .. figure:: images/schema.png :alt: The Rougail process diff --git a/docs/structured_data/documentation.rst b/docs/structured_data/documentation.rst index ccd55f2cc..57b76dc42 100644 --- a/docs/structured_data/documentation.rst +++ b/docs/structured_data/documentation.rst @@ -3,9 +3,9 @@ Data documentation Documentation is an integral part of the definition of structured data. -In a sense, we talk about `structured data` and not `schema` in Rougail because the documentation is an integral part of the variable definition. +In a sense, we talk about :term:`structured data` and not `schema` in Rougail because the documentation is an integral part of the variable definition. -More broadly, considering the use of a VaC tool has the advantage of eliminating the need to manage documentation oneself. +More broadly, considering the use of a :term:`VaC` tool has the advantage of eliminating the need to manage documentation oneself. A lot of useful information for the :term:`operator` is naturally present when defining our variables. I'm thinking of its type, the constraints applied, its default value, the mode level, etc. diff --git a/docs/structured_data/index.rst b/docs/structured_data/index.rst index f74a017c5..2e26768d3 100644 --- a/docs/structured_data/index.rst +++ b/docs/structured_data/index.rst @@ -1,8 +1,7 @@ Rougail format =============== -Common informations on structured data - +Common informations about structured data .. toctree:: :titlesonly: