README

Froala 编辑器的实现（许可证不包括在内）适用于 Craft CMS（v3）

在此处查看 Craft CMS v2 版本

安装

您可以从插件商店或使用 Composer 安装此插件。

从插件商店

转到项目的控制面板中的插件商店，搜索“Froala”，然后在它的模态窗口中点击“安装”按钮。

使用 Composer

打开您的终端并运行以下命令

# go to the project directory
cd /path/to/my-project

# tell Composer to load the plugin
composer require froala/craft-froala-wysiwyg

# tell Craft to install the plugin
./craft install/plugin froala-editor

已知问题（需要帮助！）

添加链接到 Craft 条目时，双击条目以链接到它会导致问题。只需单击一次并使用“选择”按钮。

对此不便表示歉意。我们正在解决这些令人烦恼的问题。但由于缺少一些重要功能（如以 Craft 方式保存链接），我们决定发布一个新版本。

配置

Froala 配置

您可以在您的 Froala 字段中创建自定义配置。它们应该作为 JSON 文件创建在您的 config/froalaeditor/ 文件夹中。

例如，如果您创建了一个 config/froalaeditor/Simple.json 文件，其内容如下

{
  "toolbarButtons": [
    "bold", "italic", "underline", "strikeThrough", "formatOL", "formatUL", "insertHR", "|",
    "undo", "redo", "|", "paragraphFormat", "paragraphStyle", "|", "html"
  ],
  "paragraphFormat": {
    "N": "Normal",
    "H1": "Heading 1",
    "H2": "Heading 2",
    "H3": "Heading 3",
    "H4": "Heading 4"
  }
}

…则“Simple”选项将作为配置部分中的选项在您的 Froala 字段的设置中可用。

请参阅 Froala 文档 以获取可用配置选项和按钮的列表。

第三方插件

<!-- Include third party plugins -->
<link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css" rel="stylesheet" type="text/css" />
<script src="../../js/third_party/font_awesome.min.js"></script>
<script src="../../js/third_party/spell_checker.min.js"></script>
<script src="../../js/third_party/embedly.min.js"></script>
<script src="../../js/third_party/image_tui.min.js"></script> 
<link rel="stylesheet" href="../../css/third_party/image_tui.min.css">

HTML Purifier 配置

Froala 字段使用 HTML Purifier 来确保没有恶意代码进入其字段值，以防止 XSS 攻击和其他漏洞。

您可以为您的 Froala 字段创建自定义 HTML Purifier 配置。它们应该作为 JSON 文件创建在您的 config/htmlpurifier/ 文件夹中。

以下是一个起点，这是 Froala 字段在未选择自定义 HTML Purifier 配置时使用的默认配置

{
    "Attr.AllowedFrameTargets": ["_blank"],
    "Attr.EnableID": true,
    "HTML.AllowedComments": ["pagebreak"]
}

(需要 HTML.AllowedComments 选项才能使用 pagebreak 插件。)

请参阅 HTML Purifier 文档 以获取可用配置选项的列表。

贡献

如果您关于编辑器本身有任何问题，请在 主要存储库 上报告您的问题。

如果您在 Craft CMS v3 的集成中发现了问题，您可以在此处提出问题。

如果您自己已经修复了错误，请创建一个 Pull Request (PR) 并将修复方案连同对问题的详细描述一起发送给我们。请在我们的 develop 分支 上创建 PR。

任何帮助都将受到欢迎。非常感谢。

许可证

要正确启用编辑器，您应该在 www.froala.com 上购买许可证。

一旦您有了许可证，您可以为您的域名在插件设置中输入许可证密钥。