Fixed document Markdown rendering, closes #7

cary-rowen · Nov 18, 2024 · fa998aa · fa998aa
1 parent 0dcea38
commit fa998aa
Show file tree

Hide file tree

Showing 2 changed files with 90 additions and 86 deletions.
diff --git a/addon/doc/zh_CN/readme.md b/addon/doc/zh_CN/readme.md
@@ -2,88 +2,90 @@
 
 **这是一个用于监视导航对象属性变化的 NVDA 插件。**
 
-* 作者： Cary-rowen (<[email protected]>)，hwf1324 (<[email protected]>)  
-* 兼容性： NVDA 2023.1 或更高版本  
+* 作者： Cary-rowen (<[email protected]>)，hwf1324 (<[email protected]>)
+* 兼容性： NVDA 2023.1 或更高版本
 
 ## 可能的用例
 
-1. **字幕与歌词监视：**  
-   监视某些播放器的字幕或歌词对象，内容刷新时可以自动读出。  
-
+1. **字幕与歌词监视：**
+   监视某些播放器的字幕或歌词对象，内容刷新时可以自动读出。
 2. **聊天活动监视：**  
    监视 Unigram 或微信的会话列表中感兴趣的会话。有新消息时可自动读出，支持后台朗读。  
-
 3. **测试与调试：**  
    监视记事本的状态栏，以在内容插入/删除过程中自动读出行/列变化。
 
 ## 按键与手势
 
-### 监视层命令  
-按 `NVDA+Alt+W` 打开对象监视命令层，在该层可以执行监视相关操作：  
-- **数字键 (0–9):** 将当前导航对象添加到特定位置，或读出该位置当前已监视对象的信息。  
-- **Delete 键:** 按一次删除最后选中的对象；按两次删除所有被监视的对象。  
-- **T 键:** 开关监视当前窗口标题。  
-- **P 键:** 切换暂停/继续监视。  
-- **Escape 键:** 退出监视层。  
+### 监视层命令
+
+按 `NVDA+Alt+W` 打开对象监视命令层，在该层可以执行监视相关操作：
 
-进入监视层时，插件会读出当前状态：  
-- *"尚未启动监视，请添加希望被监视的对象。"*  
-- *"正在监视，{n} 个对象。"*  
-- *"已暂停，{n} 个对象待监视。"*  
+- **数字键 (0–9):** 将当前导航对象添加到特定位置，或读出该位置当前已监视对象的信息。
+- **Delete 键:** 按一次删除最后选中的对象；按两次删除所有被监视的对象。
+- **T 键:** 开关监视当前窗口标题。
+- **P 键:** 切换暂停/继续监视。
+- **Escape 键:** 退出监视层。
+
+进入监视层时，插件会读出当前状态：
+
+- *"尚未启动监视，请添加希望被监视的对象。"*
+- *"正在监视，{n} 个对象。"*
+- *"已暂停，{n} 个对象待监视。"*
 
 ### 其他手势
 
 以下操作默认没有分配快捷键。用户可以通过“按键与手势”对话框自行分配快捷键：
 
-- **将当前导航对象添加到监视列表。**  
-  **注意：** 此操作仅可分配给主键为数字键 (0–9) 且带修饰键的快捷键，例如 `NVDA+Alt+0–9`。  
-- **开关监视当前窗口标题。**  
-- **切换暂停/继续监视。**  
-- **按一次删除最后选中的对象；按两次删除所有被监视的对象。**  
+- **将当前导航对象添加到监视列表。**
+  - **注意：** 此操作仅可分配给主键为数字键 (0–9) 且带修饰键的快捷键，例如 `NVDA+Alt+0–9`。
+- **开关监视当前窗口标题。**
+- **切换暂停/继续监视。**
+- **按一次删除最后选中的对象；按两次删除所有被监视的对象。**
 
 ## 设置
 
-通过 NVDA 的“选项”菜单进入设置面板，可以配置以下选项：  
-- **监视对象周期：** 以毫秒为单位设置监视间隔（默认值为 100 毫秒）。  
+通过 NVDA 的“选项”菜单进入设置面板，可以配置以下选项：
+
+- **监视对象周期：** 以毫秒为单位设置监视间隔（默认值为 100 毫秒）。
 
 ## 贡献者
 
 - **作者：**  
-  - Cary-rowen: 核心开发者  
-  - hwf1324: 代码贡献者  
-  - Ibrahim Hamadeh: 代码贡献者  
+  - Cary-rowen: 核心开发者
+  - hwf1324: 代码贡献者
+  - Ibrahim Hamadeh: 代码贡献者
 
 - **本地化贡献者：**  
-  - Ibrahim Hamadeh: 阿拉伯语翻译  
-  - VovaMobile: 乌克兰语翻译  
+  - Ibrahim Hamadeh: 阿拉伯语翻译
+  - VovaMobile: 乌克兰语翻译
 
 **欢迎通过任何方式告知我其他本地化贡献者的姓名。**
 
 ## 贡献
 
-1. 欢迎通过 [GitHub][GitHub] 提交新功能或本地化翻译的 Pull Requests (PR)。  
-2. 任何反馈也可以通过 [GitHub Issue][GitHubIssue] 提交。  
+1. 欢迎通过 [GitHub][GitHub] 提交新功能或本地化翻译的 Pull Requests (PR)。
+2. 任何反馈也可以通过 [GitHub Issue][GitHubIssue] 提交。
 
 ## 升级日志
 ### 版本 1.0.1
 - 修复添加重复对象的问题。
 - 其他的一些小改进。
 
 ### 版本 1.0.0
-- 增加了监视层命令 (`NVDA+Alt+W`)。  
-- 支持对多个对象进行监视。  
-- 增加了对前台窗口的快速监视功能。  
-- 支持暂停和恢复监视。  
+- 增加了监视层命令 (`NVDA+Alt+W`)。
+- 支持对多个对象进行监视。
+- 增加了对前台窗口的快速监视功能。
+- 支持暂停和恢复监视。
 
 ### 版本 0.4.5
-- 本地化更新。  
+- 本地化更新。
 
 ### 版本 0.4.4
-- 支持 NVDA 2024.1 的“手动朗读”模式。  
-- 本地化更新。  
+- 支持 NVDA 2024.1 的“手动朗读”模式。
+- 本地化更新。
 
 ### 版本 0.4.0
-- 增加了可配置的监视计时器间隔功能。  
+- 增加了可配置的监视计时器间隔功能。
 
-[GitHub]: https://github.com/cary-rowen/objWatcher  
-[GitHubIssue]: https://github.com/cary-rowen/objWatcher/issues  
+[GitHub]: https://github.com/cary-rowen/objWatcher
+[GitHubIssue]: https://github.com/cary-rowen/objWatcher/issues
diff --git a/readme.md b/readme.md
@@ -2,88 +2,90 @@
 
 **This NVDA add-on watches changes to attributes of navigation objects.**
 
-* Authors: Cary-rowen (<[email protected]>), hwf1324 (<[email protected]>)  
-* Compatibility: NVDA 2023.1 or later  
+* Authors: Cary-rowen (<[email protected]>), hwf1324 (<[email protected]>)
+* Compatibility: NVDA 2023.1 or later
 
 ## Possible Use Cases
 
-1. **Subtitles and Lyrics Watching:**  
-   Watch subtitle or lyric objects of certain players, enabling automatic reporting when they refresh.  
-
-2. **Chat Activity Watching:**  
-   Watch items of interest within group chat lists in messaging apps such as Unigram or WeChat. Automatically report new messages, even when working in the background.  
-
-3. **Testing and Debugging:**  
+1. **Subtitles and Lyrics Watching:**
+   Watch subtitle or lyric objects of certain players, enabling automatic reporting when they refresh.
+2. **Chat Activity Watching:**
+   Watch items of interest within group chat lists in messaging apps such as Unigram or WeChat. Automatically report new messages, even when working in the background.
+3. **Testing and Debugging:**
    Watch the status bar of applications like Notepad to automatically report changes in rows and columns during editing.
 
 ## Gestures
 
-### Watcher Layer Commands  
-Press `NVDA+Alt+W` to activate the watcher layer, where you can perform watching actions:  
-- **Numeric Keys (0–9):** Add the current navigator object to a specific position or report the status of an object already being watched at that position.  
-- **Delete:** Press once to remove the last watched object; press twice to remove all watched objects.  
-- **T:** Toggle the watch status of the current foreground window.  
-- **P:** Pause or resume all watching activities.  
-- **Escape:** Exit the watcher layer.  
+### Watcher Layer Commands
+
+Press `NVDA+Alt+W` to activate the watcher layer, where you can perform watching actions:
 
-When entering the watcher layer, the add-on announces the current status:  
-- *"No items are being watched. Please add items to watch."*  
-- *"Watching in progress. {n} items are being tracked."*  
-- *"Watching paused. {n} items in the watch list."*  
+- **Numeric Keys (0–9):** Add the current navigator object to a specific position or report the status of an object already being watched at that position.
+- **Delete:** Press once to remove the last watched object; press twice to remove all watched objects.
+- **T:** Toggle the watch status of the current foreground window.
+- **P:** Pause or resume all watching activities.
+- **Escape:** Exit the watcher layer.
+
+When entering the watcher layer, the add-on announces the current status:
+
+- *"No items are being watched. Please add items to watch."*
+- *"Watching in progress. {n} items are being tracked."*
+- *"Watching paused. {n} items in the watch list."*
 
 ### Other Gestures
 
 The following actions are supported but have no default gestures assigned. Users can assign gestures to these actions via the Input Gestures dialog:
 
-- **Add current navigator object to watchlist.**  
-  **Note:** This action can only be assigned to gestures where the main key is a numeric key (0–9) with a modifier, such as `NVDA+Alt+0–9`.  
-- **Toggle the watch status of the current window.**  
-- **Toggle pause/resume watching.**  
-- **Press once to delete the last watched object; press twice to delete all watched objects.**  
+- **Add current navigator object to watchlist.**
+  - **Note:** This action can only be assigned to gestures where the main key is a numeric key (0–9) with a modifier, such as `NVDA+Alt+0–9`.
+- **Toggle the watch status of the current window.**
+- **Toggle pause/resume watching.**
+- **Press once to delete the last watched object; press twice to delete all watched objects.**
 
 ## Settings
 
-Access the settings panel from NVDA’s Preferences menu to configure the following options:  
-- **Watcher Timer Interval:** Set the watching interval in milliseconds (default is 100ms).  
+Access the settings panel from NVDA’s Preferences menu to configure the following options:
+
+- **Watcher Timer Interval:** Set the watching interval in milliseconds (default is 100ms)
 
 ## Contributors
 
-- **Authors:**  
-  - Cary-rowen: Core developer  
-  - hwf1324: Code contributor  
-  - Ibrahim Hamadeh: Code contributor  
+- **Authors:**
+  - Cary-rowen: Core developer
+  - hwf1324: Code contributor
+  - Ibrahim Hamadeh: Code contributor
 
 - **Localization Contributors:**  
-  - Ibrahim Hamadeh: Arabic Translation  
-  - VovaMobile: Ukrainian Translation  
+  - Ibrahim Hamadeh: Arabic Translation
+  - VovaMobile: Ukrainian Translation
 
 **Feel free to let me know the names of other localization contributors in any way you like.**
 
 ## Contribution
 
-1. Submit Pull Requests (PRs) for new features or localized translations via [GitHub][GitHub].  
-2. Report bugs or provide feedback through the [GitHub Issues page][GitHubIssue].  
+1. Submit Pull Requests (PRs) for new features or localized translations via [GitHub][GitHub].
+2. Report bugs or provide feedback through the [GitHub Issues page][GitHubIssue].
 
 ## Release Notes
 ### Version 1.0.1
 - Fixed duplicate objects being added
 - Other improvements
 
 ### Version 1.0.0
-- Added watcher layer commands (`NVDA+Alt+W`).  
-- Introduced watching feature for multiple objects.  
-- Introduced quick watching of the foreground window.  
-- Support pause/resume watching.  
+- Added watcher layer commands (`NVDA+Alt+W`).
+- Introduced watching feature for multiple objects.
+- Introduced quick watching of the foreground window.
+- Support pause/resume watching.
 
 ### Version 0.4.5
-- Localization updates.  
+- Localization updates.
 
 ### Version 0.4.4
-- Supported "speak on demand" mode for NVDA 2024.1.  
-- Localization updates.  
+- Supported "speak on demand" mode for NVDA 2024.1.
+- Localization updates.
 
 ### Version 0.4.0
-- Introduced a configurable timer interval for watching objects.  
+- Introduced a configurable timer interval for watching objects.
 
-[GitHub]: https://github.com/cary-rowen/objWatcher  
-[GitHubIssue]: https://github.com/cary-rowen/objWatcher/issues  
+[GitHub]: https://github.com/cary-rowen/objWatcher
+[GitHubIssue]: https://github.com/cary-rowen/objWatcher/issues