Formulix 文件← 返回網站
安裝 / Formulix 0.1.0

CKEditor 5

使用編輯器模型與元件的外掛。

安裝

執行 npm run build:integrations,將 dist/integrations/ckeditor5/ 複製到應用程式。附原始碼及授權的交付使用 npm run package:integrations。建立編輯器前載入 formulix-ui.min.js,以 ESM 匯入 index.js。使用應用程式內同一份 ckeditor5,不要加入第二份編輯器。已測試及宣告為 peer dependency 的版本是 CKEditor 49。

整合至既有設定

import Formulix from './formulix/index.js';
const config = {
  plugins: [ /* ... */ Formulix ],
  toolbar: ['formulixFormula', 'formulixConta', 'formulixGrafico', 'formulixQuimica'],
  formulix: {
    servidor: 'https://api.formulix.example',
    chave: 'YOUR_PUBLIC_KEY',
    idioma: 'zh-Hant'
  }
};

未提供 upload 回呼時使用 FileRepository 及既有上傳轉接器。自訂方式可在 formulix 傳入 upload: async blob => { /* ... */ },上傳 PNG 後回傳 URL。這只是回呼契約,須實作身分驗證並在伺服器驗證 PNG 與大小。

API / 公開金鑰

設定營運方提供的 HTTPS API 網址及帳戶公開金鑰,在控制台登記編輯器網域;子網域亦受涵蓋。https://api.formulix.example 與 YOUR_PUBLIC_KEY 都是佔位範例,並非實際服務網址或金鑰。

預覽及插入內容會傳送至 API。瀏覽器只能放綁定網域的公開金鑰,切勿放入管理端、SMTP 或 Mercado Pago 憑證。

API · 隱私說明 — 翻譯草稿

儲存與限制

使用四個按鈕並按兩下項目重新編輯。儲存 editor.getData();伺服器清理器須保留 data-formulix 包裝層、MathML、表格及 data-*。變更與歷程使用模型交易。已在 CKEditor 49 驗證四類內容、儲存/重新載入、重編輯、復原、清理及唯讀。主編輯器的授權須另行檢查;轉接器採 GPL-3.0-or-later。

Word 的 OMML/RTF 剪貼簿處理仍是 TinyMCE 專用。Alpha 轉接器的同等貼上能力、多語言同時使用、Firefox/WebKit 與行動裝置均待驗證。