wagtail-sharing 2.12.1

设置

使用 pip 安装包

$ pip install wagtail-sharing

将 wagtailsharing 添加到您的 Django 设置中已安装的应用程序

# in settings.py
INSTALLED_APPS = (
    ...
    'wagtailsharing',
    ...
)

wagtail.snippets 也需要，并且必须包含在您的已安装应用程序列表中。

以下代码示例假设您正在使用最新的 Wagtail 版本（3.0+）。

运行迁移以创建所需的数据库表

$ python manage.py migrate wagtailsharing

替换 Wagtail 的通配符 URL 模式

# in urls.py
-from wagtail import urls as wagtail_urls
+from wagtailsharing import urls as wagtailsharing_urls

...

-urlpatterns.append(url(r'', include(wagtail_urls)))
+urlpatterns.append(url(r'', include(wagtailsharing_urls)))

共享站点

Wagtail 管理现在在“设置”下有一个新的部分，称为共享站点，允许用户定义他们想要如何公开最新的页面修订。

默认情况下，没有共享站点。必须为每个 Wagtail 站点手动创建共享站点才能使其最新的修订可共享。每个共享站点由一个唯一的域名和端口号定义。重要：不正确地配置共享站点可能会公开草稿/私密内容。设置时请小心！

创建新的共享站点

在遵循上述设置步骤之后，您应该能够创建一个新的共享站点，在本地 Django 开发服务器上使用此功能。假设您正在默认端口 8000 上运行本地开发服务器，并且那里的页面正在 http://localhost:8000 上提供服务。我们想在 http://sharing.localhost:8000 上创建一个新的共享站点，最新页面修订将在其中公开。

要模拟在不同主机名上访问您的站点，您需要放宽 Django 的默认安全设置，该设置仅允许在 localhost 上访问。编辑您的设置文件（例如 myproject/settings/local.py），添加以下内容

ALLOWED_HOSTS = ['*']

验证您是否可以访问本地服务器 http://sharing.localhost:8000。您应该在那里看到与 http://localhost:8000 上相同的内容，因为您尚未为默认站点启用 wagtail-sharing。

为此，在 Wagtail 管理中，在“设置”下的共享站点中，为默认站点创建一个新的共享站点，主机名为 sharing.localhost，端口号为 8000。

现在，您的最新页面修订（包括草稿）应该在 http://sharing.localhost:8000 上可用。

横幅

在 wagtail-sharing 共享站点上查看的页面将添加一个简单的横幅，以提醒审阅者当前发布的内容可能与他们查看的内容不同。

可以通过设置 settings.WAGTAILSHARING_BANNER = False 来禁用此行为。横幅模板可以通过在 wagtailsharing/banner.html 提供替代模板文件来覆盖，类似于如何支持 wagtailadmin 模板覆盖。

共享链接

可以通过将页面的 Page 实例传递给 wagtailsharing.helpers.get_sharing_url 来获取页面的分享URL。如果未配置共享站点或指定的页面无法路由到共享站点，则此方法返回 None。页面的分享URL基于其最新发布的修订版本的缩略名，如果页面从未发布过，则基于其初始修订版本。

共享页面还将有一个新的下拉菜单选项，该选项链接到Wagtail页面探索器中的此分享URL。

钩子

与正常页面服务一样，共享页面的服务继续遵守Wagtail内置的 before_serve_page 钩子。

本项目还添加了以下附加钩子

from wagtail import hooks

@hooks.register('before_serve_shared_page')
def modify_shared_title(page, request, args, kwargs):
    page.title += ' (Shared)'

from wagtail import hooks

@hooks.register('after_serve_shared_page')
def add_custom_header(page, response):
    response['Wagtail-Is-Shared'] = '1'

混合

ShareableRoutablePageMixin

默认情况下，Wagtail的 RoutablePageMixin 与Wagtail-Sharing不兼容，相反，您需要使用 ShareableRoutablePageMixin 才能在可路由页面上查看共享草稿内容字段。

ShareableRoutablePageMixin 的使用方式与 RoutablePageMixin 完全相同。

from wagtail.fields import RichTextField
from wagtail.models import Page
from wagtail.contrib.routable_page.models import route
from wagtailsharing.models import ShareableRoutablePageMixin


class EventIndexPage(ShareableRoutablePageMixin, Page):
    intro = RichTextField()

    @route(r'^$')
    def current_events(self, request):
        # …

    @route(r'^past/$')
    def past_events(self, request):
        # …

兼容性

本项目已针对以下内容进行了兼容性测试

• Python 3.9+

• Django 3.2+

• Wagtail 5.1+（有关对旧版Wagtail的支持，请参阅过去版本）

它应该与所有中间版本兼容。如果您发现它不兼容，请 提交问题。

测试

运行项目单元测试需要 tox

$ tox

要交互式运行测试应用程序，请运行

$ tox -e interactive

现在您可以在浏览器中访问 http://localhost:8000/admin/ 并使用 admin / changeme 登录。

开源许可信息

1. 条款

2. 许可

3. CFPB源代码政策