From 8ee33dcdae7e5f928a6645cc19d34664b9843217 Mon Sep 17 00:00:00 2001 From: Mara Date: Sat, 8 Feb 2025 10:46:27 +0100 Subject: [PATCH] docs: add french translation --- README.fr.md | 54 ++++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 2 ++ 2 files changed, 56 insertions(+) create mode 100644 README.fr.md diff --git a/README.fr.md b/README.fr.md new file mode 100644 index 0000000..11cf4e2 --- /dev/null +++ b/README.fr.md @@ -0,0 +1,54 @@ +# My Thesaurus + +Ajoute automatiquement des tags en fonction d’un thésaurus au format CSV. + +## ⚙️ Paramètres + +1. Séparateur : Le séparateur utilisé dans le fichier CSV. Les séparateurs pris en charge sont `,`, `;`, `|` et `tabulation`. +2. Colonne cible : 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. Thésaurus : 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. Chemins inclus : 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. My Thesaurus: Analyser tous les fichiers : 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 d’erreur 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. My Thesaurus: Analyser le fichier actuel : 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 d’Obsidian, 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 from "./locales/.json";` + - Ajoutez ` : {translation: }` dans la section `ressource`. diff --git a/README.md b/README.md index 8e95c2e..bcbd0cd 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,8 @@ Automagically adds tags based on a thesaurus CSV. +-> [French version](./README.fr.md) + ## ⚙️ Settings 1. Separator: The separator used in the CSV file. Supported separators are `,`, `;`, `|`, and `tabulation`.