docs: update descriptions in JSON and README for clarity on thesaurus settings

This commit is contained in:
Mara-Li 2025-02-21 10:04:47 +01:00
parent cdbfe6750b
commit 6d360588e6
4 changed files with 15 additions and 15 deletions

View file

@ -42,11 +42,11 @@ Le thésaurus doit être un tableau avec deux colonnes : une pour les termes et
## ⚙️ 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é).
1. <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é).
2. <ins>Séparateur</ins> : Le séparateur utilisé dans le fichier CSV. Les séparateurs pris en charge sont `,`, `;`, `|` et `tabulation`.
3. <ins>Colonne cible</ins> : Le titre de la colonne du fichier CSV contenant les tags :
- **Terme** : Nom de la colonne contenant les **tags à ajouter**.
- **Synonymes** : Nom de la colonne des mots à **rechercher** dans le fichier (contenu et titre).
> [!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.
@ -54,9 +54,9 @@ Le thésaurus doit être un tableau avec deux colonnes : une pour les termes et
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 !
> Vous pouvez inclure tous les fichiers de votre coffre en utilisant `.*` comme chemin ! Cette valeur est utilisés par défaut.
5. <ins>Supprimer les accents</ins> : Si activé, les accents seront supprimés lors de la recherche de synonymes. Permet de faire reconnaître `rôle` par `role` (et vice-versa)
5. <ins>Supprimer les accents</ins> : Si activé, les accents seront supprimés lors de la reconnaissance de synonymes. Permet de faire correspondre `rôle` à `role` (et vice-versa).
## 📝 Utilisation

View file

@ -46,11 +46,11 @@ You can have as many synonyms as you want for a term, but you need to duplicate
## ⚙️ Settings
1. <ins>Separator</ins>: The separator used in the CSV file. Supported separators are `,`, `;`, `|`, `tabulation` and `markdown`. See the note above for the markdown separator.
2. <ins>Column title</ins>: The title of the column in the CSV file that contains the tags:
- **Term**: The column contains the tags that must be set by the plugin.
- **Synonyms**: The column contains the synonyms that must be recognized by the plugin.
3. <ins>Thesaurus</ins>: Path to the file containing the thesaurus. The file must be a CSV file and must be in your vault. You can click on the `save`button to ensure the file is valid (the path is correct, the file exists, and it's well-formed).
1. <ins>Thesaurus</ins>: Path to the file containing the thesaurus. The file must be a CSV file and must be in your vault. You can click on the `save` button to ensure the file is valid (the path is correct, the file exists, and it's well-formed).
2. <ins>Separator</ins>: The separator used in the CSV file. Supported separators are `,`, `;`, `|`, `tabulation` and `markdown`. See the note above for the markdown separator.
3. <ins>Column title</ins>: The title of the column in the CSV file that contains the tags:
- **Term**: Name of the tag column **to be added**
- **Synonyms**: Name of the column of **words to be searched in the file** (contents and file title).
> [!CAUTION]
> If, for some reason, the file is moved, you need to update the path in the settings! It won't be updated automatically.
@ -60,7 +60,7 @@ You can have as many synonyms as you want for a term, but you need to duplicate
> [!TIP]
> You can include all the files in your vault by using `.*` as the path!
5. <ins>Remove accents</ins>: If enabled, accents will be suppressed when searching for synonyms. Allows `role` to be recognized by `role` (and vice versa).
5. <ins>Remove accents</ins>: If enabled, accents will be suppressed when searching for synonyms. Allows `café` to be recognized by `cafe` (and vice versa).
## 📝 Usage

View file

@ -32,7 +32,7 @@
"settings": {
"columns": {
"synonyms": {
"desc": "This value is the name of the column of words to be searched in the thesaurus.",
"desc": "This value is the name of the column of words to be searched in the file (contents and title).",
"title": "Synonym"
},
"term": {

View file

@ -32,7 +32,7 @@
"settings": {
"columns": {
"synonyms": {
"desc": "Cette valeur est le nom de la colonne des mots à chercher dans le thésaurus.",
"desc": "Cette valeur est le nom de la colonne des mots à chercher dans le fichier (contenu et titre).",
"title": "Synonymes"
},
"term": {