外掛系統
ReadAware 外掛整合了桌面主程式所暴露的能力。它們可以處理書籍、閱讀狀態、註記、對話與記憶;新增動作與提供者;並使用受限的主程式服務。
本參考文件依循開發原始碼。在建立或發布前,請比對能力需求與您安裝的應用程式版本。
選擇能力家族
| 家族 | 用途 | 範例 |
|---|---|---|
| 領域(Domains) | ReadAware 所擁有的資料與行為 | 書庫、閱讀、註記、對話、設定、記憶 |
| 貢獻(Contributions) | 新的動作、選項或提供者實作 | 指令、情境動作、語音、內容來源、助理工具、主題 |
| 服務(Services) | 主程式作業與外掛專屬設施 | 資源、網路、推論、儲存、排程、工作、交易 |
| 結構描述(Schemas) | 主程式呈現或解讀的資料 | 檢視、設定表單、主題 |
使用能力探索器搜尋實際方法、了解邊界,並建立資訊清單。API 參考文件說明家族如何組合。
從使用者的任務出發
- 尋找與導覽: 使用書庫來源搜尋與範圍讀取,再搭配目前工作階段保護機制進行閱讀導覽。
- 收集與檢視註記: 查詢或觀察註記;條件式變更可保留較新的編輯。
- 處理閱讀記憶: 使用記憶查詢與授權指令處理記憶、分類、設定檔、實體、圖譜與情境套件。
- 輔助對話: 讀取授權的對話紀錄與摘要,提出回合內容供主程式核准,或註冊助理工具。
- 自動化工作流程: 結合排程、限定範圍的變更游標、支援的持久化工作與本機交易。
- 引入外部內容: 使用以來源為範圍的網路存取、內容提供者與密封資源,而非檔案系統或瀏覽器的逃逸管道。
權限、版本與物件授權
以下是分開的檢查:
requires宣告相容的能力版本。permissions、settingsAccess與networkAccess宣告授權範圍。- 使用者的書籍授權將執行者限制為全部書籍、目前書籍或指定書籍。
- 生命週期與目前執行環境條件決定特定操作目前是否可用。
無權限的服務仍可能因特定方法而需要另一個領域授權。成功的可用性查詢僅是提示,並非繞過執行檢查的許可。
主程式呈現的介面
外掛回傳結構化檢視與回呼。ReadAware 負責呈現、焦點、導覽、載入與錯誤狀態、主題與清理。檢視可包含清單、表單、詳細版面與受限區塊,並透過公開檢視契約提供即時更新。
外掛不得掛載 React、任意 HTML、CSS、iframe 或 DOM。如需新的 UI 行為,請使用受支援的貢獻點。
隔離與生命週期
每個外掛在模組 Worker 中執行。它不會直接取得 Tauri、SQLite、檔案系統、程序或 DOM 的存取權。網路與儲存使用由主程式中介的環境。
啟動階段會註冊項目並允許受支援的讀取;商業寫入與外部副作用從啟用的處理器開始。私有資料遷移僅以儲存權限執行。候選版本取代目前執行環境之前,失敗的啟動或遷移會先復原。
安裝仍是軟體信任的決策。請審查套件原始碼、請求的授權範圍、網路目的地與資料處理方式。
從第一方外掛學習
原始碼樹包含可運作的範例,例如 Jumper、Dictionary 與 Sentence Reader,以及隨附的外掛。原始碼範例不保證每個套件都會隨每個版本發布。