mn-docs-mcp 0.1.0

package/src/content/docs/reference/global/application.md

@@ -0,0 +1,301 @@
+---
+title: Application
+description: MarginNote 应用主对象，通过单例访问窗口、路径与 UI 能力。
+---
+
+`Application` 代表 MarginNote 应用本身，通过 `Application.sharedInstance()` 获取单例。用于获取当前窗口、学习控制器、路径以及弹窗/ HUD 等 UI。
+
+## 类成员 (Class members)
+
+### `sharedInstance`
+
+获取全局唯一的应用实例。
+
+```javascript
+static sharedInstance(): Application
+```
+
+**Return Value:**
+
+- `Application`: 全局应用实例。
+
+## 实例成员 (Instance members)
+
+### 属性（只读）
+
+| 属性 | 类型 | 说明 |
+| :--- | :--- | :--- |
+| `focusWindow` | `UIWindow` | 当前活动窗口（文档中有时写作 `window`，getter 为 window）。 |
+| `currentTheme` | `string` | 当前主题，如 `"dark"` / `"light"`。 |
+| `dbPath` | `string` | 主数据库文件路径。 |
+| `documentPath` | `string` | 文稿目录路径。 |
+| `cachePath` | `string` | 缓存目录路径。 |
+| `tempPath` | `string` | 临时目录路径。 |
+| `osType` | `number` | 系统类型：0 iPadOS，1 iPhoneOS，2 macOS。 |
+| `appVersion` | `string` | 应用版本号。 |
+| `build` | `string` | 构建号。 |
+| `defaultTintColor` | `UIColor` | 默认强调色。 |
+| `defaultTintColorForDarkBackground` | `UIColor` | 深色背景下的默认强调色。 |
+| `defaultTintColorForSelected` | `UIColor` | 选中态默认强调色。 |
+| `defaultBookPageColor` | `UIColor` | 默认书本页色。 |
+| `defaultNotebookColor` | `UIColor` | 默认笔记本色。 |
+| `defaultTextColor` | `UIColor` | 默认文本色。 |
+| `defaultDisableColor` | `UIColor` | 默认禁用色。 |
+| `defaultHighlightBlendColor` | `UIColor` | 默认高亮混合色。 |
+| `searchManager` | `SearchManager` | 搜索管理器（全文检索/相似搜索等）。 |
+
+### 方法
+
+### `studyController`
+
+获取指定窗口的学习控制器。
+
+```javascript
+studyController(window: UIWindow): StudyController
+```
+
+**Parameters:**
+
+| Name | Type | Description |
+| :--- | :--- | :--- |
+| `window` | `UIWindow` | 目标窗口（通常传 `self.window`）。 |
+
+**Return Value:**
+
+- `StudyController`: 该窗口对应的学习控制器。
+
+### `showHUD`
+
+在指定视图上显示短暂 HUD。
+
+```javascript
+showHUD(message: string, view: UIView, duration: number): void
+```
+
+**Parameters:**
+
+| Name | Type | Description |
+| :--- | :--- | :--- |
+| `message` | `string` | 要显示的消息文本。 |
+| `view` | `UIView` | HUD 的父视图。 |
+| `duration` | `number` | 显示时长（秒）。 |
+
+### `waitHUDOnView`
+
+在指定视图上显示等待态 HUD（转圈）。
+
+```javascript
+waitHUDOnView(message: string, view: UIView): void
+```
+
+**Parameters:**
+
+| Name | Type | Description |
+| :--- | :--- | :--- |
+| `message` | `string` | 提示消息文本。 |
+| `view` | `UIView` | HUD 的父视图。 |
+
+### `stopWaitHUDOnView`
+
+停止并移除指定视图上的等待 HUD。
+
+```javascript
+stopWaitHUDOnView(view: UIView): void
+```
+
+**Parameters:**
+
+| Name | Type | Description |
+| :--- | :--- | :--- |
+| `view` | `UIView` | HUD 所在的父视图。 |
+
+### `alert`
+
+显示系统警告框（阻塞）。
+
+```javascript
+alert(message: string): void
+```
+
+**Parameters:**
+
+| Name | Type | Description |
+| :--- | :--- | :--- |
+| `message` | `string` | 警告框内容。 |
+
+### `openURL`
+
+打开 URL（网页或 App URL Scheme）。
+
+```javascript
+openURL(url: NSURL): void
+```
+
+**Parameters:**
+
+| Name | Type | Description |
+| :--- | :--- | :--- |
+| `url` | `NSURL` | 要打开的地址。 |
+
+### `refreshAfterDBChanged`
+
+数据库变更后刷新指定笔记本的界面。
+
+```javascript
+refreshAfterDBChanged(topicid: string): void
+```
+
+**Parameters:**
+
+| Name | Type | Description |
+| :--- | :--- | :--- |
+| `topicid` | `string` | 笔记本 ID。 |
+
+### `queryCommandWithKeyFlagsInWindow`
+
+查询命令状态。
+
+```javascript
+queryCommandWithKeyFlagsInWindow(command: string, keyFlags: any, window: UIWindow): NSDictionary
+```
+
+这里的command指MarginNote内建命令的字符串标识（可理解为某个菜单动作/操作的ID）。常见command可参考[内建command清单](/reference/global/builtin-commands/)。
+
+该接口用于查询某个内建command在“当前窗口+修饰键(keyFlags)”上下文里是否可用，以及是否处于勾选态。你可以用它来：
+
+- 判断某个command当前是否能执行（例如编辑态/无焦点时可能禁用）。
+- 在调用`processCommandWithKeyFlagsInWindow(...)`之前做保护性判断。
+
+已确认返回值至少包含：
+
+- `disabled:boolean`：是否禁用。
+- `checked:boolean`：是否勾选态。
+
+**Parameters:**
+
+| Name | Type | Description |
+| :--- | :--- | :--- |
+| `command` | `string` | 内建command字符串标识。 |
+| `keyFlags` | `number` | 按键标记。 |
+| `window` | `UIWindow` | 目标窗口。 |
+
+**Return Value:**
+
+- `NSDictionary`: 命令状态信息。
+
+### `processCommandWithKeyFlagsInWindow`
+
+执行命令。
+
+```javascript
+processCommandWithKeyFlagsInWindow(command: string, keyFlags: any, window: UIWindow): void
+```
+
+这里的command同样是MarginNote内建命令的字符串标识（可理解为某个菜单动作/操作的ID）。只要command字符串是系统可识别的命令标识，就可以直接调用执行（例如已确认`ZoomToFit`可执行）。
+
+可用的command列表没有单一集中枚举，建议参考内建command清单页，并在运行时用`queryCommandWithKeyFlagsInWindow`确认`disabled:false`后再执行：
+
+- [内建command清单](/reference/global/builtin-commands/)
+
+**Parameters:**
+
+| Name | Type | Description |
+| :--- | :--- | :--- |
+| `command` | `string` | 内建command字符串标识。 |
+| `keyFlags` | `number` | 按键标记。 |
+| `window` | `UIWindow` | 目标窗口。 |
+
+### `saveFileWithUti`
+
+保存文件。
+
+```javascript
+saveFileWithUti(mfile: string, uti: string): void
+```
+
+**Parameters:**
+
+| Name | Type | Description |
+| :--- | :--- | :--- |
+| `mfile` | `string` | 文件路径。 |
+| `uti` | `string` | 统一类型标识符 (Uniform Type Identifier)。 |
+
+### `checkNotifySenderInWindow`
+
+检查通知发送者对象是否在指定窗口中。
+
+```javascript
+checkNotifySenderInWindow(obj: any, window: UIWindow): boolean
+```
+
+**Parameters:**
+
+| Name | Type | Description |
+| :--- | :--- | :--- |
+| `obj` | `any` | 通知发送者对象。 |
+| `window` | `UIWindow` | 目标窗口。 |
+
+**Return Value:**
+
+- `boolean`: 是否在窗口中。
+
+### `openFileWithUTIs`
+
+按 UTI 打开文件（调用系统文件选择器）。
+
+```javascript
+openFileWithUTIs(types: NSArray, controller: UIViewController, block: JSValue): void
+```
+
+**Parameters:**
+
+| Name | Type | Description |
+| :--- | :--- | :--- |
+| `types` | `NSArray` | 允许的 UTI 类型数组（字符串）。 |
+| `controller` | `UIViewController` | 呈现选择器的父控制器。 |
+| `block` | `JSValue` | 选择后的回调函数。 |
+
+### `regsiterHtmlCommentEditor`
+
+注册 HTML 评论编辑器。
+
+```javascript
+regsiterHtmlCommentEditor(commentEditor: any, htmlEditor: any, htmlRender: any, commentTag: string): void
+```
+
+**Parameters:**
+
+| Name | Type | Description |
+| :--- | :--- | :--- |
+| `commentEditor` | `any` | 评论编辑器配置/对象。 |
+| `htmlEditor` | `any` | HTML 编辑器配置/对象。 |
+| `htmlRender` | `any` | HTML 渲染器配置/对象。 |
+| `commentTag` | `string` | 评论标签标识。 |
+
+### `unregsiterHtmlCommentEditor`
+
+注销 HTML 评论编辑器。
+
+```javascript
+unregsiterHtmlCommentEditor(commentTag: string): void
+```
+
+**Parameters:**
+
+| Name | Type | Description |
+| :--- | :--- | :--- |
+| `commentTag` | `string` | 评论标签标识。 |
+
+### `importDocument`
+
+导入文档（由运行时实现决定入库位置与返回值含义）。
+
+```javascript
+importDocument(fileUrl: string): string
+```
+
+## 相关
+
+- [StudyController](/reference/marginnote/study-controller/) — 由 `studyController(window)` 返回
+- [SearchManager](/reference/global/search-manager/) — `searchManager`
+- [快速开始](/guides/getting-started/) — 使用 `showHUD` 的示例

package/src/content/docs/reference/global/builtin-commands.md

@@ -0,0 +1,294 @@
+---
+title: 内建command清单
+description: MarginNote内建command字符串速查表（用于query/processCommand调用）。
+---
+
+本页汇总一些常见内建command字符串。它们通常用于：
+
+- `Application.queryCommandWithKeyFlagsInWindow(command,keyFlags,window)`查询可用性与checked状态。
+- `Application.processCommandWithKeyFlagsInWindow(command,keyFlags,window)`执行内建命令。
+
+注意：该清单可能随版本变化；当某个command在运行时表现为`disabled:true`，可能是当前上下文不可用，也可能是版本差异导致不存在。
+
+## Root（全局分发）
+
+- `EditStopComment`：评论编辑结束
+- `FlashcardFlip`：复习翻卡
+- `Again`：复习评分Again
+- `Hard`：复习评分Hard
+- `Good`：复习评分Good
+- `Easy`：复习评分Easy
+- `EditReference`：引用复制
+- `ToggleTextLink`：文本链接开关
+- `DraftMindMap`：打开草稿图谱
+- `BookMarkAdd`：添加书签
+- `BookTOC`：目录
+- `GoDocument`：切换到文档模式
+- `GoStudy`：切换到学习模式
+- `NotebookOutline`：切换到大纲视图
+- `NotebookOutlineMix`：切换到混合视图
+- `NotebookDoc`：切换到文档视图
+- `BookMarginSwitch`：边栏切换
+- `BookMarginNotes`：显示边栏笔记
+- `FocusNote`：聚焦当前节点
+- `FocusParent`：聚焦父节点
+- `ZoomToFit`：自适应缩放
+- `SnippetMode`：摘录模式
+- `MindmapSnippetMode`：图谱摘录模式
+- `EditSelAll`：全选
+- `EditCut`：剪切
+- `EditCopy`：复制
+- `EditCopyLink`：复制链接
+- `EditPaste`：粘贴
+- `EditDeleteNote`：删除笔记
+- `EditAddTitle`：添加标题
+- `EditAddText`：添加文本
+- `EditAddVoice`：添加语音
+- `BookSearch`：文档搜索
+- `NoteSearch`：笔记搜索
+- `ToggleExpand`：展开/折叠
+- `NewChildNote`：新建子节点
+- `NewSiblingNote`：新建同级节点
+- `ViewExpandAll`：展开全部
+- `ViewCollapseAll`：折叠全部
+- `ViewExpandRows`：展开行
+- `ViewCollapseRows`：折叠行
+- `Research`：研究/检索
+- `SetTitleHighlight`：标题高亮
+- `SetCommentHighlight`：评论高亮
+- `SetAsEmphasis`：设为重点
+- `MergeTo`：合并到
+- `SetEmphasisHighlight`：重点高亮样式
+- `SetEmphasisHighlightOutline`：大纲重点高亮样式
+- `BookPageNumber`：跳页
+- `DoneMultiEdit`：结束多选编辑
+- `InAppPurchase`：内购入口
+- `UIStatusURL`：复制状态URL
+- `GoLibrary`：前往书库
+- `OpenTrash`：打开废纸篓
+- `OpenHistory`：打开历史
+- `OpenExtensions`：打开扩展
+- `OpenLostNotes`：打开丢失笔记
+- `ClearTemp`：清理临时文件
+- `ImportEvernote`：导入Evernote
+- `ImportWeb`：导入网页
+- `ImportFromDropbox`：从Dropbox导入
+- `GoiCloud`：前往iCloud入口
+- `StudyResearch`：学习研究
+- `InlineChat`：内联聊天
+- `AddToChat`：添加到聊天
+
+## Studyboard
+
+- `ToggleMindMap`：切换脑图面板
+- `ToggleDocument`：切换文档面板
+- `ToggleCards`：切换卡片面板
+- `ToggleReview`：切换复习面板
+- `ToggleResearch`：切换研究面板
+- `ManageDocs`：管理文档
+- `ToggleMoreSettings`：更多设置
+- `ToggleFullDoc`：切换全屏文档
+- `ToggleBookLeft`：切换左侧栏
+- `ToggleBookBottom`：切换底部栏
+- `ToggleTabsBar`：切换标签栏
+- `ToggleAddFile`：添加文件入口
+- `TabNextFile`：下一个文档Tab
+- `TabPrevFile`：上一个文档Tab
+- `FullTextSearch`：全文检索
+- `ViewDocCardGroup`：文档卡片分组视图
+- `ViewMapCardGroup`：图谱卡片分组视图
+- `GlobalBranchStyle`：全局分支样式
+- `ExcerptToolSelect`：摘录工具选择
+- `ExcerptToolCustom*`：自定义摘录工具
+- `ExcerptToolSketch`：手绘摘录工具
+- `ExportPKG`：导出PKG
+- `ExportVault`：导出Vault
+- `ExportMapPDF`：导出脑图PDF
+- `ExportDocPDF`：导出文档PDF
+- `ExportOmni`：导出Omni
+- `ExportWord`：导出Word
+- `ExportMind`：导出Mind
+- `ExportAnki`：导出Anki
+- `EditPDFPages`：PDF页面编辑
+- `EditDocLayers`：文档图层编辑
+- `ToggleSplit`：切换分屏
+- `BindSplit`：绑定分屏
+- `ToggleSidebar`：切换侧栏
+- `ToggleTextLink`：文本链接开关
+- `AddToChat`：添加到聊天
+- `DraftMindMap`：草稿图谱
+- `AutoAddMindMap`：自动添加图谱
+- `AutoAddCardDeck`：自动添加卡组
+- `AutoOCR`：自动OCR
+- `AlwaysOCR`：始终OCR
+- `ViewHiddenNotes`：查看隐藏笔记
+- `InsertDocumentTOC`：插入文档TOC
+- `InsertDocumentNode`：插入文档节点
+- `InsertSelectedNode`：插入所选节点
+- `SyncMindMapToBook`：同步图谱到文档
+- `SyncBookToMindMap`：同步文档到图谱
+- `SyncWindowPos`：同步窗口位置
+- `SyncDeletion`：同步删除
+- `ToolSelect`：选择工具
+- `ToolTextExcerpt`：文本摘录工具
+- `ToolRectCut`：矩形裁切工具
+- `PdfCrop`：PDF裁切
+- `FlashcardsCloze`：挖空卡片
+- `Import`：导入
+- `Starred`：星标
+- `Filter*`：筛选
+- `Flip`：翻卡
+- `Play`：播放
+- `Stop`：停止
+- `SetEmphasisHighlight`：重点高亮
+- `EmphasisCloze`：重点挖空
+- `GoDocument`：文档模式
+- `GoStudy`：学习模式
+- `BookSearch`：文档搜索
+- `BookTOC`：目录
+- `ResearchGoogle`：Google研究
+- `Wiki`：Wiki研究
+- `Image`：图片搜索
+- `Translate`：翻译
+- `BookPageNumber`：跳页
+- `BookMarkAdd`：添加书签
+- `BookMarkRemove`：移除书签
+- `BookRecallMode`：书签回忆模式
+- `EditNewHighlight`：新建高亮
+- `NotebookSearch`：笔记本搜索
+- `MiscMode`：杂项模式
+- `HybridMode`：混合模式
+- `StudyShare`：分享
+- `SpeechMode`：语音模式
+- `NotebookEvernote`：笔记本同步到Evernote
+
+## BookShelf
+
+- `ShareLicenses`：导出许可证
+- `SharePackage`：导出安装包
+- `GoNewFeatures`：新功能入口
+- `GoUserGuide`：用户指南入口
+- `GoManual`：手册入口
+- `DBVaults`：资料库入口
+- `GoSettings`：设置入口
+- `BackupDB`：备份数据库
+
+## Detail（阅读详情页）
+
+- `SelectTool`：选择工具
+- `TextHighlightTool`：文本高亮工具
+- `RectHighlightTool`：矩形高亮工具
+- `LassoHighlightTool`：套索高亮工具
+- `ScribbleHighlightTool`：涂鸦高亮工具
+- `SelectWord`：按词选择
+- `SelectChar`：按字符选择
+- `OneBookView`：单书视图
+- `TwoBookView`：双书视图
+- `ThreeBookView`：三书视图
+- `BookPageFlip`：翻页模式
+- `BookPageScroll`：滚动模式
+- `BookSchemeDefault`：默认配色
+- `Sepia`：护眼配色
+- `Night`：夜间配色
+- `BookDisplayTopList`：顶部列表
+- `BookMarginSwitch`：边栏切换
+- `Notes`：边栏笔记
+- `Numbers`：边栏页码
+- `Links`：边栏链接
+- `EmbedNotes`：边栏嵌入笔记
+- `EditMargin`：新建边注
+- `GoBack`：后退
+- `GoForward`：前进
+- `Research`：研究
+- `EditDeleteNote`：删除笔记
+- `EditCloneNote`：克隆笔记
+- `EditTagNote`：标签笔记
+- `EditColorNote`：设置笔记颜色
+- `EditAddTitle`：添加标题
+- `EditAddText`：添加文本
+- `EditAddPicture`：添加图片
+- `EditAddVoice`：添加语音
+- `EditAddEvernote`：添加Evernote
+- `EditColorNoteIndex*`：设置颜色索引
+- `EditFillNoteIndex*`：设置填充索引
+- `EditReviewNote`：加入复习
+- `EditNewBookmark`：新建书签
+- `SetTitleHighlight`：标题高亮
+- `SetCommentHighlight`：评论高亮
+- `SetAsEmphasis`：设为重点
+- `MergeTo`：合并到
+- `EditCopy`：复制
+- `EditCopyLink`：复制链接
+- `EditReference`：引用复制
+- `MindMapZoomIn`：脑图放大
+- `MindMapZoomOut`：脑图缩小
+- `PdfZoomIn`：PDF放大
+- `PdfZoomOut`：PDF缩小
+- `BookTOC`：目录
+- `BookPageList`：页列表
+
+## Reader（BookViewController）
+
+- `HighlightShortcut1`：高亮快捷槽1
+- `HighlightShortcut2`：高亮快捷槽2
+- `HighlightShortcut3`：高亮快捷槽3
+- `HighlightShortcut4`：高亮快捷槽4
+- `AddToTOC`：加入目录
+- `SplitBook`：拆分文档
+- `InsertBlank`：插入空白摘录
+- `Translate`：插入翻译
+- `FoldHighlight`：折叠高亮
+- `SourceHighlight`：定位原文高亮
+- `EditTextBox`：文本框
+- `EditImageBox`：图片框
+- `ContinueExcerpt`：连续摘录
+- `InlineChat`：内联聊天
+
+## MindMap（MindMapScrollView）
+
+- `MindmapSnippetMode`：图谱摘录模式
+- `FocusParent`：聚焦父节点
+- `FocusNote`：聚焦当前节点
+- `ZoomToFit`：图谱自适应
+- `EditDeleteNote`：删除笔记
+- `EditCopy`：复制
+- `EditCopyLink`：复制链接
+- `EditReference`：引用复制
+- `EditCut`：剪切
+- `EditPaste`：粘贴
+- `Research`：研究/检索
+- `EditAppendComment`：追加评论
+- `EditCloneNote`：克隆笔记
+- `EditTagNote`：标签笔记
+- `EditColorNote`：设置笔记颜色
+- `EditAddTitle`：添加标题
+- `EditAddText`：添加文本
+- `EditAddPicture`：添加图片
+- `EditAddVoice`：添加语音
+- `EditAddEvernote`：添加Evernote
+- `EditColorNoteIndex*`：设置颜色索引
+- `EditLinkNotes`：链接笔记
+- `EditUnmergeNote`：取消合并
+- `EditTextMode`：文本模式
+- `EditOCRNote`：OCR笔记
+- `EditReviewNote`：加入复习
+- `EditRectNodeStyle`：矩形节点样式
+- `EditRectAllNodeStyle`：全部矩形节点样式
+- `EditTreeNodeStyle`：树节点样式
+- `EditTreeAllNodeStyle`：全部树节点样式
+- `ToggleExpand`：展开/折叠
+- `NewChildNote`：新建子节点
+- `NewSiblingNote`：新建同级节点
+- `NewParentNote`：新建父节点
+- `EditArrangeNotes`：整理笔记
+- `EditMergeChildren`：合并子节点
+- `EditMergeNotes`：合并笔记
+- `EditGroupNotes`：分组笔记
+- `ViewExpandLevel0..7`：按层级展开
+- `ViewExpandAll`：展开全部
+- `ViewCollapseAll`：折叠全部
+- `ViewExpandRows`：展开行
+- `ViewCollapseRows`：折叠行
+- `MindMapZoomIn`：图谱放大
+- `MindMapZoomOut`：图谱缩小
+- `InlineChat`：内联聊天