rougail/docs/structured_data/mode.rst

18 lines
844 B
ReStructuredText
Raw Normal View History

2026-06-10 07:58:21 +02:00
Mode
====
.. index:: mode
2026-06-20 10:32:36 +02:00
By default, the :term:`mode` is not configured. It is an optional feature.
2026-06-10 07:58:21 +02:00
2026-06-20 10:32:36 +02:00
Let's start by defining what we want to do with the :term:`modes <mode>`.
2026-06-10 07:58:21 +02:00
2026-06-20 10:32:36 +02:00
We'll present a common example, but you'll need to define your own :term:`modes <mode>` according to your needs.
2026-06-10 07:58:21 +02:00
2026-06-20 10:32:36 +02:00
Here is our classic use case of :term:`mode` definition. We'll use three :term:`modes <mode>`:
2026-06-10 07:58:21 +02:00
- `basic`: automatically sets mandatory variables without default values (in this case, the actor adapting the configuration will have to enter values) and manually sets variables that the actor defining the variables deems necessary.
- `standard`: automatically sets all other variables
- `advanced`: sets variables that the actor defining the variables decides to include. These variables are intended for a knowledgeable audience who know what to do.