docs: add french translation

This commit is contained in:
Mara 2025-02-08 10:46:27 +01:00
parent c73c9dd5b9
commit 8ee33dcdae
2 changed files with 56 additions and 0 deletions

54
README.fr.md Normal file
View file

@ -0,0 +1,54 @@
# My Thesaurus
Ajoute automatiquement des tags en fonction dun thésaurus au format CSV.
## ⚙️ Paramètres
1. <ins>Séparateur</ins> : Le séparateur utilisé dans le fichier CSV. Les séparateurs pris en charge sont `,`, `;`, `|` et `tabulation`.
2. <ins>Colonne cible</ins> : Le titre de la colonne du fichier CSV contenant les tags :
- **Terme** : La colonne contient les tags qui doivent être ajoutés par le plugin.
- **Synonymes** : La colonne contient les synonymes qui doivent être reconnus par le plugin.
3. <ins>Thésaurus</ins> : Chemin du fichier contenant le thésaurus. Ce fichier doit être un CSV et être stocké dans votre coffre (vault). Vous pouvez cliquer sur le bouton `save` pour vérifier que le fichier est valide (chemin correct, fichier existant et bien formé).
> [!WARNING]
> Si, pour une raison quelconque, le fichier est déplacé, vous devrez mettre à jour son chemin dans les paramètres ! Il ne sera pas mis à jour automatiquement.
4. <ins>Chemins inclus</ins> : Les fichiers situés dans ces dossiers seront pris en compte lors de l'exécution de la commande `My Thesaurus: Analyser tous les fichiers`. Vous pouvez séparer les chemins par une virgule, un point-virgule ou un saut de ligne. De plus, les expressions régulières (regex) sont prises en charge.
> [!TIP]
> Vous pouvez inclure tous les fichiers de votre coffre en utilisant `.*` comme chemin !
## 📝 Utilisation
Le plugin propose deux commandes :
1. <ins>My Thesaurus: Analyser tous les fichiers</ins> : Cette commande analysera tous les fichiers situés dans les chemins inclus et ajoutera les tags en fonction du thésaurus. À la fin, un message affichera les résultats, notamment :
- **Erreurs** : Les fichiers ayant rencontré une erreur, ainsi que le message derreur correspondant.
- **Fichiers ignorés** : Les fichiers qui ont été ignorés car aucun synonyme n'a été trouvé.
- **Succès** : Les fichiers analysés avec succès, accompagnés des tags qui ont été ajoutés.
2. <ins>My Thesaurus: Analyser le fichier actuel</ins> : Cette commande analysera uniquement le fichier en cours et ajoutera les tags en fonction du thésaurus.
## 📥 Installation
- [ ] Depuis les plugins communautaires d'Obsidian
- [x] Avec BRAT via `https://github.com/Mara-Li/`
- [x] Depuis la page des versions :
- Téléchargez la dernière version
- Décompressez `my-thesaurus.zip` dans le dossier `.obsidian/plugins/`
- Dans les paramètres dObsidian, rechargez les plugins
- Activez le plugin
### 🎼 Langues
- [x] Anglais
- [x] Français
Pour ajouter une traduction :
1. Forkez le dépôt
2. Ajoutez la traduction dans le dossier `src/i18n/locales` sous le nom de la langue (ex : `fr.json`).
- Vous pouvez récupérer le code de votre langue depuis Obsidian en utilisant [obsidian translation](https://github.com/obsidianmd/obsidian-translations) ou via une commande (par exemple dans Templater) : `<% tp.obsidian.moment.locale() %>`
- Copiez le contenu du fichier [`en.json`](./src/i18n/locales/en.json) dans le nouveau fichier
- Traduisez le contenu
3. Modifiez `i18n/i18next.ts` :
- Ajoutez `import * as <lang> from "./locales/<lang>.json";`
- Ajoutez `<lang> : {translation: <lang>}` dans la section `ressource`.

View file

@ -2,6 +2,8 @@
Automagically adds tags based on a thesaurus CSV.
-> [French version](./README.fr.md)
## ⚙️ Settings
1. <ins>Separator</ins>: The separator used in the CSV file. Supported separators are `,`, `;`, `|`, and `tabulation`.