使用说明不够清晰 - Improve documentation and instructions

[jkjoker]

能理解这个工具想要实现什么功能，很感兴趣，但根据目前的说明文档，看不懂到底如何使用。

[dominiclet]

I will try to implement a more intuitive way of defining words, but at the moment, to understand how it works, you can create a folder with the name 'definitions' at the root of your vault. Then add a file within the folder with the following content:

# Definition

This is a test definition

---

# Definition2

This is a second definition

Now when you type these two words anywhere in your notes, you will be able to see them marked and when hovering over them, you should also be able to see the definition popovers. Do let me know if you have any other questions.

[jkjoker]

I will try to implement a more intuitive way of defining words, but at the moment, to understand how it works, you can create a folder with the name 'definitions' at the root of your vault. Then add a file within the folder with the following content:

# Definition

This is a test definition

---

# Definition2

This is a second definition

Now when you type these two words anywhere in your notes, you will be able to see them marked and when hovering over them, you should also be able to see the definition popovers. Do let me know if you have any other questions.

谢谢，根据你的提示，现在成功地用上了。

我来补充一下先前的描述为什么不太容易理解：

1、”the root of your vault “，根目录。

虽然这个说法是准确的，但不太容易理解。

以及，在obsidian中，复制一个文件夹或文件的路径非常不方便，尤其是涉及斜杠或者反斜杠，相对路径或绝对路径，容易让人混淆。

考虑到这句话包括下面的意思：在自己的笔记库中建立一个文件夹；该文件夹需要是第一层级，不能是某个文件夹的子文件夹。

也许更直接的做法是：

• 初次使用时，不需要用户建立definitions文件夹，而是在启动插件时就自动建立该文件夹。
• 如果有需要的话，后续用户可以修改definitions文件夹。
• 用户在修改definition时，支持直接选择某个已存在的文件夹，而不必输入路径。

2、add a file within the folder，文件夹中的文件

也就是说，新建的文档，可以是一个普通文档，对文件名没有任何要求。

也许更直接的说法是：

• 新建一文档，在其中按照示例的格式存放内容即可。
• 新建的文档，是一个普通文档，对文件名没有任何要求。

我非常喜欢这个插件，很早以前有尝试通过obsidian的内部链接功能来自定义词库，但操作还是过于复杂了，现在这个方式很直接，谢谢！

[dominiclet]

Thanks for the great suggestions! I think creating a definitions folder by default is a good idea, I'll add that, probably along with an example definition file. I agree that allowing the user to choose a folder path instead of an input box is better too, I will look into implementing that as well. Appreciate the ideas!