Wagtail Guide

这是什么？

Wagtail Guide应用为编辑和出版商添加了创建和编辑指南的功能，以帮助他们创建优质内容。

安装

Wagtailguide有一个pypi包，可以使用以下命令安装：

pip install wagtail-guide

安装后，将其添加到您的设置文件中，与 wagtail.contrib.settings 一起，设置包含应放在您的其他 wagtail.contrib 库中。

INSTALLED_APPS = [
    ...
    'wagtail_guide',
    'wagtail.contrib.settings',
]

设置和配置

Wagtail guide有一些自定义选项...

WAGTAIL_GUIDE_MENU_LABEL 使用此设置定义查看指南的自己的菜单标签。

ADD_WAGTAIL_GUIDE_TO_HELP_MENU 此设置将指南放置在“帮助”菜单中。

HIDE_WAGTAIL_CORE_EDITOR_GUIDE 您可以使用此设置关闭Wagtail核心编辑指南链接

通过设置进行自定义的示例

这里是一个自定义菜单标签的示例（用橙色突出显示），以及在帮助菜单中放置编辑指南链接

WAGTAIL_GUIDE_SETTINGS = {
    "ADD_WAGTAIL_GUIDE_TO_HELP_MENU": True,
    "WAGTAIL_GUIDE_MENU_LABEL": "CMS Publishing Guide",
    "HIDE_WAGTAIL_CORE_EDITOR_GUIDE": False,
}

这里是一个隐藏核心编辑指南链接并仅使用我们的示例

WAGTAIL_GUIDE_SETTINGS = {
    "ADD_WAGTAIL_GUIDE_TO_HELP_MENU": True,
    "WAGTAIL_GUIDE_MENU_LABEL": "CMS Publishing Guide",
    "HIDE_WAGTAIL_CORE_EDITOR_GUIDE": True,
}

您可以在项目设置文件中这样定义它们

WAGTAIL_GUIDE_SETTINGS = {
    "ADD_WAGTAIL_GUIDE_TO_HELP_MENU": False,
    "WAGTAIL_GUIDE_MENU_LABEL": "WG guide menu label",
    "HIDE_WAGTAIL_CORE_EDITOR_GUIDE": True,
}

用法

要编辑指南，用户必须是管理员，或者在其用户组权限中勾选了“管理编辑指南”的“更改”值。

编辑指南

要编辑指南，从左侧菜单打开设置>然后单击“管理编辑指南”。编辑您的内容，然后保存。

指南导航菜单

如果将多个“标题”块添加到内容中，则在指南顶部的“内容”标题下将自动显示一个菜单

查看指南

登录后，左侧菜单底部将出现一个新的菜单图标，标签为“编辑指南”

依赖关系

Wagtail指南需要wagtail>=5.2

贡献

我们欢迎对这个项目的贡献，有关详细信息，请参阅CONTRIBUTING.md。