Wagtail Draftail Anchors

添加在Draftail富文本编辑器中添加和编辑锚的能力，以及自动将(slug-form)锚标识添加到所有标题中。

安装

使用pip安装

pip install wagtail-draftail-anchors

将'wagtail_draftail_anchors'添加到以下INSTALLED_APPS中的wagtail.admin。

将'anchor-identifier'添加到任何已覆盖默认功能列表的富文本字段的特性中。必须在任何标题('h1',...,'h6')特性之前添加功能

body = RichTextField(features=['anchor-identifier', 'h2', 'h3', 'bold', 'italic', 'link'])

配置

锚的渲染表示

默认情况下，anchor-identifier富文本实体将以HTML anchor元素的形式渲染，例如。

<a href="#my-element" id="my-element" data-id="my-element">My element</a>

此软件包提供了一种替代渲染器，该渲染器将anchor-identifier实体渲染为HTML span元素，例如。

<span id="my-element">My element</span>

可以使用DRAFTAIL_ANCHORS_RENDERER设置指定所需的渲染器。要使用span渲染器，请按如下配置您的应用程序。

DRAFTAIL_ANCHORS_RENDERER = "wagtail_draftail_anchors.rich_text.render_span"

可以定义自己的渲染器。它应该是一个可调用的函数，该函数接受一个dict属性，并返回一个包含表示锚目标的HTML元素的打开标记的字符串。对于标识为"my-anchor"的锚，传递给渲染器的dict将如下所示。

{"data-id": "my-anchor", "href": "#my-anchor", "id": "my-anchor", "linktype": "my-anchor"}

如果您定义了自己的渲染器，应将DRAFTAIL_ANCHORS_RENDERER的值设置为您的自定义渲染器的导入路径。

请参阅wagtail_draftail_anchors.rich_text中的render_span和render_a以获取示例。