From 50c83aa3f42e26ff2500b16805a02c820b358f60 Mon Sep 17 00:00:00 2001 From: Emmanuel Garette Date: Mon, 29 Dec 2025 20:54:41 +0100 Subject: [PATCH] fix: update doc --- README.fr.md | 27 ++++----- README.md | 1 + locale/fr/LC_MESSAGES/rougail_cli.po | 54 +++++++++--------- locale/rougail_cli.pot | 36 ++++++------ src/rougail/cli/config.py | 1 + .../cli/locale/fr/LC_MESSAGES/rougail_cli.mo | Bin 2602 -> 3743 bytes 6 files changed, 63 insertions(+), 56 deletions(-) diff --git a/README.fr.md b/README.fr.md index 8283fb8..d3fc4ff 100644 --- a/README.fr.md +++ b/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 | -|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------|------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------| -| **cli.config_file**
**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
• type de fichier autorisé: "fichier" et "répertoire". | -| **cli.debug**
**Ligne de commande** :
• --cli.debug
• --cli.no-debug
**Variable d'environnement** : CLI.DEBUG | Afficher les informations de debug. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | | | -| **cli.warnings**
**Ligne de commande** :
• --cli.warnings
• --cli.no-warnings
**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` | | | -| **cli.versions**
**Ligne de commande** :
• --cli.versions
• --cli.no-versions
**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` | | | -| **cli.invalid_user_data_error**
**Ligne de commande** :
• --cli.invalid_user_data_error
• --cli.no-invalid_user_data_error
**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` | | | -| **cli.unknown_user_data_error**
**Ligne de commande** :
• --cli.unknown_user_data_error
• --cli.no-unknown_user_data_error
**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` | | | -| **cli.layers**
**Ligne de commande** :
• --cli.layers
• --cli.no-layers
**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`*
**Cachée** : si seulement un type de données utilisateur est renseigné dans "[Sélection pour données utilisateur](#step.user_data)" | | -| **cli.read_write**
**Ligne de commande** :
• --cli.read_write
• --cli.no-read_write
**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` | | | -| **cli.description_type**
**Ligne de commande** :
--cli.description_type
**Variable d'environnement** : CLI.DESCRIPTION_TYPE | Type de description des variables.
To identify different variables, we use the variable description. There are four types of description:
- 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** :
• path_and_description
• name_and_description
• path
• name
• description | -| **cli.inaccessible_read_write_modes**
**Ligne de commande** :
--cli.inaccessible_read_write_modes
**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é`*
**Désactivé** : si aucun mode n'est défini dans "[Tous les niveaux de modes valides](#modes_level)" | `unique`
Un mode doit exister dans "[Tous les niveaux de modes valides](#modes_level)". | -| **cli.inaccessible_modes**
**Ligne de commande** :
--cli.inaccessible_modes
**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é`*
**Désactivé** : si aucun mode n'est défini dans "[Tous les niveaux de modes valides](#modes_level)" | `unique`
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 | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------|------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------| +| **cli.config_file**
**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
• type de fichier autorisé: "fichier" et "répertoire". | +| **cli.debug**
**Ligne de commande** :
• --cli.debug
• --cli.no-debug
**Variable d'environnement** : CLI.DEBUG | Afficher les informations de debug. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | | | +| **cli.warnings**
**Ligne de commande** :
• --cli.warnings
• --cli.no-warnings
**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` | | | +| **cli.versions**
**Ligne de commande** :
• --cli.versions
• --cli.no-versions
**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` | | | +| **cli.invalid_user_data_error**
**Ligne de commande** :
• --cli.invalid_user_data_error
• --cli.no-invalid_user_data_error
**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` | | | +| **cli.unknown_user_data_error**
**Ligne de commande** :
• --cli.unknown_user_data_error
• --cli.no-unknown_user_data_error
**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` | | | +| **cli.layers**
**Ligne de commande** :
• --cli.layers
• --cli.no-layers
**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`*
**Cachée** : si seulement un type de données utilisateur est renseigné dans "[Sélection pour données utilisateur](#step.user_data)" | | +| **cli.read_write**
**Ligne de commande** :
• --cli.read_write
• --cli.no-read_write
**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` | | | +| **cli.description_type**
**Ligne de commande** :
--cli.description_type
**Variable d'environnement** : CLI.DESCRIPTION_TYPE | Type de description des variables.
Pour identifier les différentes variables, on utilise la description de la variable. Il y a quatre type de descriptions:
- 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** :
• path_and_description
• name_and_description
• path
• name
• description | +| **cli.inaccessible_read_write_modes**
**Ligne de commande** :
--cli.inaccessible_read_write_modes
**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é`*
**Désactivé** : si aucun mode n'est défini dans "[Tous les niveaux de modes valides](#modes_level)" | `unique`
Un mode doit exister dans "[Tous les niveaux de modes valides](#modes_level)". | +| **cli.inaccessible_modes**
**Ligne de commande** :
--cli.inaccessible_modes
**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é`*
**Désactivé** : si aucun mode n'est défini dans "[Tous les niveaux de modes valides](#modes_level)" | `unique`
Un mode doit exister dans "[Tous les niveaux de modes valides](#modes_level)". | diff --git a/README.md b/README.md index 1754311..b2dd538 100644 --- a/README.md +++ b/README.md @@ -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 | diff --git a/locale/fr/LC_MESSAGES/rougail_cli.po b/locale/fr/LC_MESSAGES/rougail_cli.po index 38a746a..0eb42a9 100644 --- a/locale/fr/LC_MESSAGES/rougail_cli.po +++ b/locale/fr/LC_MESSAGES/rougail_cli.po @@ -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" diff --git a/locale/rougail_cli.pot b/locale/rougail_cli.pot index 9faaf02..ce75828 100644 --- a/locale/rougail_cli.pot +++ b/locale/rougail_cli.pot @@ -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 \n" "Language-Team: LANGUAGE \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 "" diff --git a/src/rougail/cli/config.py b/src/rougail/cli/config.py index e7f3c65..ad29df9 100644 --- a/src/rougail/cli/config.py +++ b/src/rougail/cli/config.py @@ -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')} diff --git a/src/rougail/cli/locale/fr/LC_MESSAGES/rougail_cli.mo b/src/rougail/cli/locale/fr/LC_MESSAGES/rougail_cli.mo index 4c42d959238b3df8dd826988706ccf2a6e4f0e56..57cb2be4105a594189ffb5aa459fa6e4a70cb940 100644 GIT binary patch delta 1645 zcmaizNoW*76o%g(Do% zzeV4Ke!GAlv>)Ig_!Arj7xfVB1;;@d8*l^o80-gMg1f*vI17Hy$9H>)wqg7NJP3XQ zcM_#Euz=_u#K%D~e!Y-r82k!u2L~4sje+B!2>AKSKt}Mf$zbs;O0J}W$>rt_;VHy&V%p3N8mB=I<~U|dfy15&W|4LON5UksB;WjuCFq)XPTvKxgy+p^|Td%Ygv%VjL~)eRl9v8+{G6$MATCeSQ4 zr7&>KWD-Fci@i`e+7X9{9c2|O#+>#Fnd9gfrVfXRtt572=55cjG-TuGz#6xTid4m)v~<#RCG#_saO*RQYY51LU+R?Vq2}C;?V7!RP68PtnJ~7vgK>2 z{#ve)ib#>C%cfM89a&|9INMOmO_o60^TKJ=K2gPS#GUFb?LhguQ+s~tK&8IaJ-@aT zQS7Q~2v>`TUGCj8SPE*r?>MxMX{&L{Q0jO&cdK`{&~sq_-1>#1J?UwWb!^)qa)uIX zJR`T<9VG3`#pwX)n?yjIR-6!}e?;)UUPF*f#M-ul6tSyH#%oC7_Su>F*f)5%R94Ys zy(Vdp+c7+qAaAOvA;&C!coK(^H5y3D%Gi2sWaiA`Z|MceMV>N)!ZT%LtzMI`!KQiD zFo0CP!OWo@wA`UNHQQ7bA)iW=l}`Y%lPMhs8RxM}nfGK@@pm@3h}9-bosq-CHyYqm zY;2`z#BpM78hIFF$L)Gr_nO7CD2q#F?VILNG}rg@)jax=23Y>rrKQ&4AalDc|Eg?m IY{{>}AFzD8@&Et; delta 499 zcmX}oJxjw-6vpuoH#Gzdj zoU%GNI0;hy0wNAV2NwmMME^Gl9ys~kb8pDGIT!AgQ+>`vPeeH6AbCT&)4{pQ;X7OtW!{qj-k}Y-0}HXi%4M zjrstG@fLsZ6^HO8CM}~nqy<>Pbv(imY+({Vu#CT0qQA;