add detailed description for automatically add internal link

Author: Nriver

README.md

@@ -582,29 +582,92 @@ ea.optimize_image_attachments_to_webp('H2q3901uFDCH')
 
 This action can save significant space if you have many clipped pages. Whoever invented `WebP` is a genius.
 
-## (Advanced Usage) Automatically add internal link
+## (Advanced Usage) 🔗 Automatically Add Internal Links
 
-Experimental feature. Backup your database before do anything with this feature. It may completely destroy your notes.
+This feature allows you to automatically create internal links within your notes. Let’s take a look at how it works.
 
-If you find something wrong after using this feature. Please provide me a minimal note sample to test and fix potential
-bugs.
+### Example
 
-Add internal link in note
+Here is a sample note:
 
+![auto-link-1](docs/auto-link-1.webp)
+
+After running a single line of code:
+
+```python
+auto_create_internal_link('put_note_id_here')
 ```
-auto_create_internal_link('HfAnsf8XiarY')
-```
 
-For multiple notes
+The note transforms into this:
+
+![auto-link-2](docs/auto-link-2.webp)
+
+As you can see, some text has been replaced with internal links. The feature follows these rules:
+
+- **Title Match**: Content that matches any other note's title is replaced with an internal link.
+- **Duplicate Titles Ignored**: If multiple notes share the same title, no link is created for that title.
+- **Longer Matches First**: Longer titles take precedence. For example, in the above example, "Nate River" is linked,
+  not just "River."
+- **Existing Links Remain**: Pre-existing links in the text are left untouched.
+
+However, some words like "make" and "work" in the example are part of my "English Words That I Do Not Know" note. Since
+they are common and frequently used, I don’t want them to create excessive internal links.
+
+### Excluding Notes from Internal Linking
+
+To prevent certain notes from being linked:
+
+- Add the tag `#ignoreAutoInternalLink` to a note. This note (and optionally its sub-notes) will be excluded from link
+  creation.
+- You can make it **inheritable**—you can apply it to a parent note and inheritable, then it will be automatically
+  exclude all its sub-notes.
+
+Here’s how it looks after applying the exclusion rule:
+
+![auto-link-3](docs/auto-link-3.webp)
+
+The result is cleaner and more intentional.
+
+### Special Case: Duplicate Titles
+
+When multiple notes share the same title, a specific condition allows for internal links:
 
+- **Direct Sub-Notes Have Priority**: Direct child notes take precedence over other notes with the same title.
+
+For instance:
+
+![auto-link-4](docs/auto-link-4.webp)
+
+In this case, the note `TriliumNext` links "How to compile" to its own child note, not the one from `Trilium`.
+
+### Final Rule: No Self-Linking
+
+A note will never create an internal link to itself.
+
+---
+
+### Code Samples
+
+**Add an internal link to a specific note by its ID:**
+
+```python
+auto_create_internal_link('gLmmsIM8yPqx')
 ```
+
+**Add internal links for multiple notes:**
+
+```python
 auto_create_internal_link(target_notes=['gLmmsIM8yPqx', 'T4Ui3wNByO03'])
 ```
 
-(Dangerous action, backup first) Add internal notes for all text notes
+**(Experimental - Use with Caution)**  
+**Add internal links to all text notes:**
 
-```
-auto_create_internal_link(prcess_all_note=True)
+This is an experimental feature. **Backup your database** before using it, as it may irreversibly modify your notes. If
+issues occur, please provide a minimal note sample to help debug.
+
+```python
+auto_create_internal_link(process_all_notes=True)
 ```
 
 ## 🛠️ Develop

README_CN.md

@@ -509,28 +509,87 @@ ea.optimize_image_attachments_to_webp('H2q3901uFDCH')
 如果你有很多剪辑的页面，这个操作可以节省大量空间。发明 `WebP` 的人真是个天才。
 
 
-## （高级用法）自动添加内部链接
+## （高级用法）🔗 自动添加内部链接
 
-实验性功能。在使用此功能之前，请备份您的数据库。它可能会完全破坏您的笔记。
+此功能可以在笔记中自动创建内部链接。以下是使用示例：
 
-如果在使用此功能后发现任何问题，请提供一个最小化的笔记示例，以便测试和修复潜在的错误。
+### 示例
 
-在笔记中添加内部链接：
+这是一个示例笔记：
 
+![auto-link-1](docs/auto-link-1.webp)
+
+执行以下代码后：
+
+```python
+auto_create_internal_link('put_note_id_here')
 ```
-auto_create_internal_link('HfAnsf8XiarY')
-```
 
-针对多个笔记：
+笔记变成这样：
+
+![auto-link-2](docs/auto-link-2.webp)
+
+可以看到，部分文本已被替换为内部链接。该功能遵循以下规则：
+
+- **标题匹配**：与其他笔记标题匹配的内容会被替换为内部链接。
+- **重复标题忽略**：如果存在多个笔记使用相同标题，则不会为该标题创建链接。
+- **优先匹配较长标题**：较长的标题优先。例如，在上面的示例中，`Nate River` 被链接，而不是 `River`。
+- **现有链接保留**：文本中已有的链接不会被修改。
+
+然而，在示例中，像 "make" 和 "work" 这样的词属于我的笔记《我不认识的英语单词》。由于这些词短且常用，我不希望它们频繁生成内部链接。
+
+### 排除特定笔记的内部链接
+
+如果需要排除某些笔记的链接：
+
+- 给这些笔记添加标签 `#ignoreAutoInternalLink`，这些笔记（及其子笔记）将在创建内部链接时被忽略。
+- 你可以设置为**可继承的**：为父笔记添加这个标签并设置为可继承的，其所有子笔记也会被自动排除。
+
+应用排除规则后，效果如下：
+
+![auto-link-3](docs/auto-link-3.webp)
+
+结果更加简洁美观。
+
+### 特殊情况：重复标题
+
+当多个笔记共享相同标题时，以下情况可以生成内部链接：
 
+- **直接子笔记优先**：直接子笔记的优先级高于其他拥有相同标题的笔记。
+
+例如：
+
+![auto-link-4](docs/auto-link-4.webp)
+
+在此例中，笔记 `TriliumNext` 会将 "How to compile" 链接到自己的子笔记，而不是 `Trilium` 的同名笔记。
+
+### 最后一条规则：避免自引用
+
+笔记不会创建指向自身的内部链接。
+
+---
+
+### 代码示例
+
+**为特定笔记添加内部链接（通过笔记 ID）：**
+
+```python
+auto_create_internal_link('gLmmsIM8yPqx')
 ```
+
+**为多个笔记添加内部链接：**
+
+```python
 auto_create_internal_link(target_notes=['gLmmsIM8yPqx', 'T4Ui3wNByO03'])
 ```
 
-（危险操作，请先备份）为所有文本笔记添加内部链接：
+**（实验性功能 - 谨慎使用）**  
+**为所有文本笔记添加内部链接：**
 
-```
-auto_create_internal_link(process_all_note=True)
+这是一个实验性功能。在使用前请**备份数据库**，因为此操作可能会不可逆地修改您的笔记。如果使用后发现问题，请提供一个最小化的笔记样本以便调试。
+
+```python
+auto_create_internal_link(process_all_notes=True)
 ```