fix: update doc
This commit is contained in:
parent
5aae19de63
commit
50c83aa3f4
6 changed files with 63 additions and 56 deletions
27
README.fr.md
27
README.fr.md
|
|
@ -8,20 +8,21 @@ include_toc: true
|
|||
|
||||
> [!NOTE]
|
||||
>
|
||||
> Il est possible d'utiliser Rougail directement en ligne de commande. Il est possible de définir et configurer facilement les données utilisateur chargées, ainsi que la définition de la sortie souhaité.\
|
||||
> **Chemin** : cli
|
||||
|
||||
| Variable | Description | Valeur par défaut | Type | Contrôle des accès | Validateur |
|
||||
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------|------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| **<a id="cli.config_file" name="cli.config_file">cli.config_file</a>**<br/>**Variable d'environnement** : CLI.CONFIG_FILE | Charger les paramètres de la ligne de commande depuis un fichier. | • .rougailcli.yml | [`UNIX filename`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` | | • le nom de fichier peut être une chemin relatif<br/>• type de fichier autorisé: "fichier" et "répertoire". |
|
||||
| **<a id="cli.debug" name="cli.debug">cli.debug</a>**<br/>**Ligne de commande** : <br/>• --cli.debug<br/>• --cli.no-debug<br/>**Variable d'environnement** : CLI.DEBUG | Afficher les informations de debug. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | | |
|
||||
| **<a id="cli.warnings" name="cli.warnings">cli.warnings</a>**<br/>**Ligne de commande** : <br/>• --cli.warnings<br/>• --cli.no-warnings<br/>**Variable d'environnement** : CLI.WARNINGS | Afficher les avertissements de chargement des options de la ligne de commande. | true | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | | |
|
||||
| **<a id="cli.versions" name="cli.versions">cli.versions</a>**<br/>**Ligne de commande** : <br/>• --cli.versions<br/>• --cli.no-versions<br/>**Variable d'environnement** : CLI.VERSIONS | Afficher la version de Rougail et de tous ces composants. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | | |
|
||||
| **<a id="cli.invalid_user_data_error" name="cli.invalid_user_data_error">cli.invalid_user_data_error</a>**<br/>**Ligne de commande** : <br/>• --cli.invalid_user_data_error<br/>• --cli.no-invalid_user_data_error<br/>**Variable d'environnement** : CLI.INVALID_USER_DATA_ERROR | Les valeurs invalides dans les données utilisateur ne sont pas autorisées. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | | |
|
||||
| **<a id="cli.unknown_user_data_error" name="cli.unknown_user_data_error">cli.unknown_user_data_error</a>**<br/>**Ligne de commande** : <br/>• --cli.unknown_user_data_error<br/>• --cli.no-unknown_user_data_error<br/>**Variable d'environnement** : CLI.UNKNOWN_USER_DATA_ERROR | Les variables inconnues dans les données utilisateur ne sont pas autorisées. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | | |
|
||||
| **<a id="cli.layers" name="cli.layers">cli.layers</a>**<br/>**Ligne de commande** : <br/>• --cli.layers<br/>• --cli.no-layers<br/>**Variable d'environnement** : CLI.LAYERS | Charger chaque données utilisateurs dans des couches séparées. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | *`cachée`*<br/>**Cachée** : si seulement un type de données utilisateur est renseigné dans "[Sélection pour données utilisateur](#step.user_data)" | |
|
||||
| **<a id="cli.read_write" name="cli.read_write">cli.read_write</a>**<br/>**Ligne de commande** : <br/>• --cli.read_write<br/>• --cli.no-read_write<br/>**Variable d'environnement** : CLI.READ_WRITE | La configuration dans l'état de sortie est dans mode lecture-écriture. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | | |
|
||||
| **<a id="cli.description_type" name="cli.description_type">cli.description_type</a>**<br/>**Ligne de commande** : <br/>--cli.description_type<br/>**Variable d'environnement** : CLI.DESCRIPTION_TYPE | Type de description des variables.<br/>To identify different variables, we use the variable description. There are four types of description:<br/>- path_and_description: which contains the variable path followed by its description - name_and_description: which contains the variable name followed by its description - path: the variable's path - name: the variable name - description: the variable's description. | description | [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | | **Choix** : <br/>• path_and_description<br/>• name_and_description<br/>• path<br/>• name<br/>• description |
|
||||
| **<a id="cli.inaccessible_read_write_modes" name="cli.inaccessible_read_write_modes">cli.inaccessible_read_write_modes</a>**<br/>**Ligne de commande** : <br/>--cli.inaccessible_read_write_modes<br/>**Variable d'environnement** : CLI.INACCESSIBLE_READ_WRITE_MODES | Modes quoi doivent être inaccessible en mode lecture-écriture. | | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` | *`désactivé`*<br/>**Désactivé** : si aucun mode n'est défini dans "[Tous les niveaux de modes valides](#modes_level)" | `unique`<br/>Un mode doit exister dans "[Tous les niveaux de modes valides](#modes_level)". |
|
||||
| **<a id="cli.inaccessible_modes" name="cli.inaccessible_modes">cli.inaccessible_modes</a>**<br/>**Ligne de commande** : <br/>--cli.inaccessible_modes<br/>**Variable d'environnement** : CLI.INACCESSIBLE_MODES | Modes quoi doivent être inaccessible. | | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` | *`désactivé`*<br/>**Désactivé** : si aucun mode n'est défini dans "[Tous les niveaux de modes valides](#modes_level)" | `unique`<br/>Un mode doit exister dans "[Tous les niveaux de modes valides](#modes_level)". |
|
||||
| Variable | Description | Valeur par défaut | Type | Contrôle des accès | Validateur |
|
||||
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------|------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| **<a id="cli.config_file" name="cli.config_file">cli.config_file</a>**<br/>**Variable d'environnement** : CLI.CONFIG_FILE | Charger les paramètres de la ligne de commande depuis un fichier. | • .rougailcli.yml | [`UNIX filename`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` | | • le nom de fichier peut être une chemin relatif<br/>• type de fichier autorisé: "fichier" et "répertoire". |
|
||||
| **<a id="cli.debug" name="cli.debug">cli.debug</a>**<br/>**Ligne de commande** : <br/>• --cli.debug<br/>• --cli.no-debug<br/>**Variable d'environnement** : CLI.DEBUG | Afficher les informations de debug. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | | |
|
||||
| **<a id="cli.warnings" name="cli.warnings">cli.warnings</a>**<br/>**Ligne de commande** : <br/>• --cli.warnings<br/>• --cli.no-warnings<br/>**Variable d'environnement** : CLI.WARNINGS | Afficher les avertissements de chargement des options de la ligne de commande. | true | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | | |
|
||||
| **<a id="cli.versions" name="cli.versions">cli.versions</a>**<br/>**Ligne de commande** : <br/>• --cli.versions<br/>• --cli.no-versions<br/>**Variable d'environnement** : CLI.VERSIONS | Afficher la version de Rougail et de tous ces composants. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | | |
|
||||
| **<a id="cli.invalid_user_data_error" name="cli.invalid_user_data_error">cli.invalid_user_data_error</a>**<br/>**Ligne de commande** : <br/>• --cli.invalid_user_data_error<br/>• --cli.no-invalid_user_data_error<br/>**Variable d'environnement** : CLI.INVALID_USER_DATA_ERROR | Les valeurs invalides dans les données utilisateur ne sont pas autorisées. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | | |
|
||||
| **<a id="cli.unknown_user_data_error" name="cli.unknown_user_data_error">cli.unknown_user_data_error</a>**<br/>**Ligne de commande** : <br/>• --cli.unknown_user_data_error<br/>• --cli.no-unknown_user_data_error<br/>**Variable d'environnement** : CLI.UNKNOWN_USER_DATA_ERROR | Les variables inconnues dans les données utilisateur ne sont pas autorisées. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | | |
|
||||
| **<a id="cli.layers" name="cli.layers">cli.layers</a>**<br/>**Ligne de commande** : <br/>• --cli.layers<br/>• --cli.no-layers<br/>**Variable d'environnement** : CLI.LAYERS | Charger chaque données utilisateurs dans des couches séparées. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | *`cachée`*<br/>**Cachée** : si seulement un type de données utilisateur est renseigné dans "[Sélection pour données utilisateur](#step.user_data)" | |
|
||||
| **<a id="cli.read_write" name="cli.read_write">cli.read_write</a>**<br/>**Ligne de commande** : <br/>• --cli.read_write<br/>• --cli.no-read_write<br/>**Variable d'environnement** : CLI.READ_WRITE | La configuration dans l'état de sortie est dans mode lecture-écriture. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | | |
|
||||
| **<a id="cli.description_type" name="cli.description_type">cli.description_type</a>**<br/>**Ligne de commande** : <br/>--cli.description_type<br/>**Variable d'environnement** : CLI.DESCRIPTION_TYPE | Type de description des variables.<br/>Pour identifier les différentes variables, on utilise la description de la variable. Il y a quatre type de descriptions:<br/>- name_and_description : qui contient le nom de la variable suivi de sa description - path : le chemin de la variable - name : le nom de la variable - description : la description de la variable. | description | [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | | **Choix** : <br/>• path_and_description<br/>• name_and_description<br/>• path<br/>• name<br/>• description |
|
||||
| **<a id="cli.inaccessible_read_write_modes" name="cli.inaccessible_read_write_modes">cli.inaccessible_read_write_modes</a>**<br/>**Ligne de commande** : <br/>--cli.inaccessible_read_write_modes<br/>**Variable d'environnement** : CLI.INACCESSIBLE_READ_WRITE_MODES | Modes quoi doivent être inaccessible en mode lecture-écriture. | | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` | *`désactivé`*<br/>**Désactivé** : si aucun mode n'est défini dans "[Tous les niveaux de modes valides](#modes_level)" | `unique`<br/>Un mode doit exister dans "[Tous les niveaux de modes valides](#modes_level)". |
|
||||
| **<a id="cli.inaccessible_modes" name="cli.inaccessible_modes">cli.inaccessible_modes</a>**<br/>**Ligne de commande** : <br/>--cli.inaccessible_modes<br/>**Variable d'environnement** : CLI.INACCESSIBLE_MODES | Modes quoi doivent être inaccessible. | | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` | *`désactivé`*<br/>**Désactivé** : si aucun mode n'est défini dans "[Tous les niveaux de modes valides](#modes_level)" | `unique`<br/>Un mode doit exister dans "[Tous les niveaux de modes valides](#modes_level)". |
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -8,6 +8,7 @@ include_toc: true
|
|||
|
||||
> [!NOTE]
|
||||
>
|
||||
> It is possible to use Rougail directly from the command line. This makes it easy to define and configure the loaded user data and to define the desired output.\
|
||||
> **Path**: cli
|
||||
|
||||
| Variable | Description | Default value | Type | Access control | Validator |
|
||||
|
|
|
|||
|
|
@ -5,8 +5,8 @@
|
|||
msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: \n"
|
||||
"POT-Creation-Date: 2025-12-29 20:38+0100\n"
|
||||
"PO-Revision-Date: 2025-12-29 20:39+0100\n"
|
||||
"POT-Creation-Date: 2025-12-29 20:52+0100\n"
|
||||
"PO-Revision-Date: 2025-12-29 20:54+0100\n"
|
||||
"Last-Translator: \n"
|
||||
"Language-Team: \n"
|
||||
"Language: fr\n"
|
||||
|
|
@ -40,62 +40,62 @@ msgstr "ERREUR : {0}"
|
|||
msgid "Command line options"
|
||||
msgstr "Options de la ligne de commande"
|
||||
|
||||
#: src/rougail/cli/config.py:31
|
||||
#: src/rougail/cli/config.py:29
|
||||
msgid ""
|
||||
"It is possible to use Rougail directly from the command line. This makes it "
|
||||
"easy to define and configure the loaded user data and to define the desired "
|
||||
"output."
|
||||
msgstr ""
|
||||
"Il est possible d'utiliser Rougail directement en ligne de commande. Il est "
|
||||
"possible de définir et configurer facilement les données utilisateur "
|
||||
"chargées, ainsi que la définition de la sortie souhaité."
|
||||
|
||||
#: src/rougail/cli/config.py:32
|
||||
msgid "Loads command line parameters from a file"
|
||||
msgstr "Charger les paramètres de la ligne de commande depuis un fichier"
|
||||
|
||||
#: src/rougail/cli/config.py:39
|
||||
#: src/rougail/cli/config.py:40
|
||||
msgid "Displays debug informations"
|
||||
msgstr "Afficher les informations de debug"
|
||||
|
||||
#: src/rougail/cli/config.py:41
|
||||
#: src/rougail/cli/config.py:42
|
||||
msgid "Displays command line option warnings informations"
|
||||
msgstr ""
|
||||
"Afficher les avertissements de chargement des options de la ligne de commande"
|
||||
|
||||
#: src/rougail/cli/config.py:43
|
||||
#: src/rougail/cli/config.py:44
|
||||
msgid "Displays Rougail version and all its components"
|
||||
msgstr "Afficher la version de Rougail et de tous ces composants"
|
||||
|
||||
#: src/rougail/cli/config.py:45
|
||||
#: src/rougail/cli/config.py:46
|
||||
msgid "Invalid value in user data is not allowed"
|
||||
msgstr ""
|
||||
"Les valeurs invalides dans les données utilisateur ne sont pas autorisées"
|
||||
|
||||
#: src/rougail/cli/config.py:47
|
||||
#: src/rougail/cli/config.py:48
|
||||
msgid "Unknown variable in user data is not allowed"
|
||||
msgstr ""
|
||||
"Les variables inconnues dans les données utilisateur ne sont pas autorisées"
|
||||
|
||||
#: src/rougail/cli/config.py:50
|
||||
#: src/rougail/cli/config.py:51
|
||||
msgid "Open each user data in separate layers"
|
||||
msgstr "Charger chaque données utilisateurs dans des couches séparées"
|
||||
|
||||
#: src/rougail/cli/config.py:56
|
||||
#: src/rougail/cli/config.py:57
|
||||
msgid "if only one user data is set in \"__.step.user_data\""
|
||||
msgstr ""
|
||||
"si seulement un type de données utilisateur est renseigné dans "
|
||||
"\"__.step.user_data\""
|
||||
|
||||
#: src/rougail/cli/config.py:62
|
||||
#: src/rougail/cli/config.py:63
|
||||
msgid "Configuration in output step is in read_write mode"
|
||||
msgstr "La configuration dans l'état de sortie est dans mode lecture-écriture"
|
||||
|
||||
#: src/rougail/cli/config.py:65
|
||||
#: src/rougail/cli/config.py:66
|
||||
msgid "Type of variables description"
|
||||
msgstr "Type de description des variables"
|
||||
|
||||
#: src/rougail/cli/config.py:67
|
||||
#, fuzzy
|
||||
#| msgid ""
|
||||
#| "To identify different variables, we use the variable description. There "
|
||||
#| "are four types of description:\n"
|
||||
#| "\n"
|
||||
#| " - name_and_description: which contains the variable name followed "
|
||||
#| "by its description\n"
|
||||
#| " - path: the variable's path\n"
|
||||
#| " - name: the variable name\n"
|
||||
#| " - description: the variable's description"
|
||||
#: src/rougail/cli/config.py:68
|
||||
msgid ""
|
||||
"To identify different variables, we use the variable description. There are "
|
||||
"four types of description:\n"
|
||||
|
|
@ -117,19 +117,19 @@ msgstr ""
|
|||
" - name : le nom de la variable\n"
|
||||
" - description : la description de la variable"
|
||||
|
||||
#: src/rougail/cli/config.py:83
|
||||
#: src/rougail/cli/config.py:84
|
||||
msgid "Modes that should not be accessible in read_write mode"
|
||||
msgstr "Modes quoi doivent être inaccessible en mode lecture-écriture"
|
||||
|
||||
#: src/rougail/cli/config.py:90 src/rougail/cli/config.py:107
|
||||
#: src/rougail/cli/config.py:91 src/rougail/cli/config.py:108
|
||||
msgid "if any mode is set in \"modes_level\""
|
||||
msgstr "si aucun mode n'est défini dans \"modes_level\""
|
||||
|
||||
#: src/rougail/cli/config.py:97 src/rougail/cli/config.py:114
|
||||
#: src/rougail/cli/config.py:98 src/rougail/cli/config.py:115
|
||||
msgid "mode must exists in \"modes_level\""
|
||||
msgstr "un mode doit exister dans \"modes_level\""
|
||||
|
||||
#: src/rougail/cli/config.py:100
|
||||
#: src/rougail/cli/config.py:101
|
||||
msgid "Modes that should not be accessible"
|
||||
msgstr "Modes quoi doivent être inaccessible"
|
||||
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@
|
|||
msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: PACKAGE VERSION\n"
|
||||
"POT-Creation-Date: 2025-12-29 20:39+0100\n"
|
||||
"POT-Creation-Date: 2025-12-29 20:54+0100\n"
|
||||
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
|
||||
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
|
||||
"Language-Team: LANGUAGE <LL@li.org>\n"
|
||||
|
|
@ -35,47 +35,51 @@ msgstr ""
|
|||
msgid "Command line options"
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/cli/config.py:31
|
||||
#: src/rougail/cli/config.py:29
|
||||
msgid "It is possible to use Rougail directly from the command line. This makes it easy to define and configure the loaded user data and to define the desired output."
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/cli/config.py:32
|
||||
msgid "Loads command line parameters from a file"
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/cli/config.py:39
|
||||
#: src/rougail/cli/config.py:40
|
||||
msgid "Displays debug informations"
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/cli/config.py:41
|
||||
#: src/rougail/cli/config.py:42
|
||||
msgid "Displays command line option warnings informations"
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/cli/config.py:43
|
||||
#: src/rougail/cli/config.py:44
|
||||
msgid "Displays Rougail version and all its components"
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/cli/config.py:45
|
||||
#: src/rougail/cli/config.py:46
|
||||
msgid "Invalid value in user data is not allowed"
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/cli/config.py:47
|
||||
#: src/rougail/cli/config.py:48
|
||||
msgid "Unknown variable in user data is not allowed"
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/cli/config.py:50
|
||||
#: src/rougail/cli/config.py:51
|
||||
msgid "Open each user data in separate layers"
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/cli/config.py:56
|
||||
#: src/rougail/cli/config.py:57
|
||||
msgid "if only one user data is set in \"__.step.user_data\""
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/cli/config.py:62
|
||||
#: src/rougail/cli/config.py:63
|
||||
msgid "Configuration in output step is in read_write mode"
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/cli/config.py:65
|
||||
#: src/rougail/cli/config.py:66
|
||||
msgid "Type of variables description"
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/cli/config.py:67
|
||||
#: src/rougail/cli/config.py:68
|
||||
msgid ""
|
||||
"To identify different variables, we use the variable description. There are four types of description:\n"
|
||||
"\n"
|
||||
|
|
@ -86,19 +90,19 @@ msgid ""
|
|||
" - description: the variable's description"
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/cli/config.py:83
|
||||
#: src/rougail/cli/config.py:84
|
||||
msgid "Modes that should not be accessible in read_write mode"
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/cli/config.py:90 src/rougail/cli/config.py:107
|
||||
#: src/rougail/cli/config.py:91 src/rougail/cli/config.py:108
|
||||
msgid "if any mode is set in \"modes_level\""
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/cli/config.py:97 src/rougail/cli/config.py:114
|
||||
#: src/rougail/cli/config.py:98 src/rougail/cli/config.py:115
|
||||
msgid "mode must exists in \"modes_level\""
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/cli/config.py:100
|
||||
#: src/rougail/cli/config.py:101
|
||||
msgid "Modes that should not be accessible"
|
||||
msgstr ""
|
||||
|
||||
|
|
|
|||
|
|
@ -26,6 +26,7 @@ def get_rougail_config(
|
|||
options = f"""
|
||||
cli:
|
||||
description: {_('Command line options')}
|
||||
help: {_('It is possible to use Rougail directly from the command line. This makes it easy to define and configure the loaded user data and to define the desired output.')}
|
||||
|
||||
config_file:
|
||||
description: {_('Loads command line parameters from a file')}
|
||||
|
|
|
|||
Binary file not shown.
Loading…
Reference in a new issue