Wagtail可编辑帮助

在Wagtail管理中使帮助文本可编辑

链接

• 文档
• 变更日志
• 贡献
• 讨论
• 安全

支持版本

• Python 3.8 - 3.12
• Django 3.2 - 4.2
• Wagtail 4.1 - 5.2

安装

• 运行 pip install wagtail-editable-help
• 将 "wagtail_editable_help" 添加到 INSTALLED_APPS
• 对于Wagtail 5.1及以下版本：如果尚未存在，将 "wagtail.contrib.modeladmin" 添加到 INSTALLED_APPS
• 运行 ./manage.py migrate
• 可选：将 "wagtail_editable_help.middleware.EditableHelpMiddleware" 添加到 MIDDLEWARE 设置，位于 "django.contrib.auth.middleware.AuthenticationMiddleware" 下方。启用此中间件将在显示帮助文本的位置添加一个“编辑”链接，允许超级用户和其他具有适当权限的用户编辑帮助文本。

用法

对于您希望使其可编辑的任何 help_text 参数

from wagtail_editable_help.models import HelpText

然后将 help_text="Some help text" 替换为 help_text=HelpText("model", "identifier", default="Some help text")。模型和标识符字符串用作帮助文本字符串的唯一标识符，以及组织管理界面中的字符串 - 它们不需要与模型或字段名完全匹配。《HelpText》在支持帮助文本字符串的任何定义中都有效，而不仅仅是模型字段 - 例如表单字段和StreamField块。

例如

class HomePage(Page):
    tagline = models.CharField(max_length=255, help_text="Write something snappy here")

可以重写为

from wagtail_editable_help.models import HelpText

class HomePage(Page):
    tagline = models.CharField(max_length=255, help_text=HelpText("Home page", "tagline", default="Write something snappy here"))

帮助文本字符串将在Wagtail管理后台的设置 -> 帮助文本下，标题“首页标语”中可供编辑。