61 lines
2.5 KiB
Markdown
61 lines
2.5 KiB
Markdown
|
---
|
||
|
|
name: erplibre-doc-i18n
|
||
|
|
description: Documentation bilingue ERPLibre (mmg, fichiers .base.md) et internationalisation du CLI TODO (todo_i18n.py, clés TRANSLATIONS). À charger pour rédiger ou régénérer de la documentation, ou pour ajouter une chaîne traduisible au CLI.
|
||
|
|
---
|
||
|
|
|
||
|
|
# Documentation multilingue
|
||
|
|
|
||
|
|
La documentation est bilingue (anglais/français) via **mmg** (Multilingual
|
||
|
|
Markdown Generator).
|
||
|
|
|
||
|
|
## Fonctionnement
|
||
|
|
- Les fichiers sources sont les `.base.md` (contiennent les deux langues)
|
||
|
|
- `mmg` génère : `FICHIER.md` (anglais) et `FICHIER.fr.md` (français)
|
||
|
|
- Marqueurs : `<!-- [en] -->`, `<!-- [fr] -->`, `<!-- [common] -->` (blocs de code partagés)
|
||
|
|
|
||
|
|
## Commandes
|
||
|
|
```bash
|
||
|
|
make doc_markdown # Regénérer toute la doc multilingue
|
||
|
|
```
|
||
|
|
|
||
|
|
## Convention
|
||
|
|
- Toujours modifier le fichier `.base.md` correspondant, puis exécuter `make doc_markdown`
|
||
|
|
- Les blocs de code vont dans `<!-- [common] -->`, le texte dans `<!-- [en] -->` et `<!-- [fr] -->`
|
||
|
|
- En-tête obligatoire dans chaque `.base.md` :
|
||
|
|
```
|
||
|
|
<!---------------------------->
|
||
|
|
<!-- multilingual suffix: en, fr -->
|
||
|
|
<!-- no suffix: en -->
|
||
|
|
<!---------------------------->
|
||
|
|
```
|
||
|
|
|
||
|
|
> Les fichiers concernés se listent par `find . -name '*.base.md'`.
|
||
|
|
|
||
|
|
## Internationalisation du CLI TODO (i18n)
|
||
|
|
|
||
|
|
Le CLI interactif `script/todo/todo.py` supporte le français et l'anglais.
|
||
|
|
|
||
|
|
### Architecture
|
||
|
|
- **`script/todo/todo_i18n.py`** — Module de traduction (dictionnaire `TRANSLATIONS`, fonctions `t()`, `get_lang()`, `set_lang()`)
|
||
|
|
- Les chaînes traduisibles utilisent `t("clé")` au lieu de texte en dur
|
||
|
|
- Les entrées de `todo.json` peuvent avoir un champ `prompt_description_key` résolu via `t()` (fallback sur `prompt_description`)
|
||
|
|
|
||
|
|
### Résolution de la langue (priorité)
|
||
|
|
1. `EL_LANG` dans `env_var.sh` (lu en premier, défaut `"fr"`)
|
||
|
|
2. Variable d'environnement `EL_LANG`
|
||
|
|
3. Défaut : `"fr"`
|
||
|
|
|
||
|
|
### Comportement
|
||
|
|
- Première exécution : prompt bilingue demande à l'utilisateur de choisir sa langue
|
||
|
|
- Le choix est persisté dans `env_var.sh`
|
||
|
|
- Changement de langue possible via TODO > Configuration > Langue
|
||
|
|
|
||
|
|
### Ajouter une traduction
|
||
|
|
1. Ajouter la clé dans `TRANSLATIONS` de `todo_i18n.py` avec les valeurs `"fr"` et `"en"`
|
||
|
|
2. Remplacer la chaîne en dur par `t("ma_clé")` dans `todo.py`
|
||
|
|
3. Pour les entrées JSON : ajouter `"prompt_description_key": "ma_clé"` dans `todo.json`
|
||
|
|
|
||
|
|
> La clé EST la chaîne anglaise. Vérifier l'absence de doublon dans
|
||
|
|
> `TRANSLATIONS` avant d'ajouter : une clé en double écrase silencieusement
|
||
|
|
> la précédente.
|