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-Hans'
  }
};

未提供 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 和移动端均有待验证。