Настройка интерфейса редактирования

Настройка вкладок

По умолчанию Wagtail организует панели страниц на три вкладки: «Содержание», «Продвижение» и «Настройки». Для фрагментов Wagtail помещает все панели на одну страницу. В зависимости от требований вашего сайта, вы можете настроить это для определённых типов страниц или фрагментов — например, добавив дополнительную вкладку для содержимого сайдбара. Это можно сделать, указав атрибут edit_handler в модели страницы или фрагмента. Например:

from wagtail.admin.panels import TabbedInterface, ObjectList

class BlogPage(Page):
    # field definitions omitted

    content_panels = [
        FieldPanel('title', classname="title"),
        FieldPanel('date'),
        FieldPanel('body'),
    ]
    sidebar_content_panels = [
        FieldPanel('advert'),
        InlinePanel('related_links', heading="Related links", label="Related link"),
    ]

    edit_handler = TabbedInterface([
        ObjectList(content_panels, heading='Content'),
        ObjectList(sidebar_content_panels, heading='Sidebar content'),
        ObjectList(Page.promote_panels, heading='Promote'),
        ObjectList(Page.settings_panels, heading='Settings'),
    ])

Форматированный текст (HTML)

Wagtail предоставляет универсальный редактор WYSIWYG для создания форматированного текста (HTML) и вставки медиа, таких как изображения, видео и документы. Чтобы включить это в ваши модели, используйте функцию RichTextField при определении поля модели:

from wagtail.fields import RichTextField
from wagtail.admin.panels import FieldPanel


class BookPage(Page):
    body = RichTextField()

    content_panels = Page.content_panels + [
        FieldPanel('body'),
    ]

RichTextField наследуется от базового поля Django TextField, поэтому вы можете передавать любые параметры поля в RichTextField, как если бы вы использовали обычное поле Django. Его max_length проигнорирует любые форматирования форматированного текста. Для этого поля не требуется специальная панель, и его можно определить с помощью FieldPanel.

Однако выходные данные шаблона из RichTextField являются специальными и требуют фильтрации, чтобы сохранить вставленное содержимое. См. Фильтр форматированного текста.

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

# image_formats.py
from wagtail.images.formats import Format, register_image_format

register_image_format(Format('thumbnail', 'Thumbnail', 'richtext-image thumbnail', 'max-120x120'))

Настройка сгенерированных форм

Wagtail автоматически генерирует формы с использованием настроек панелей в модели. По умолчанию эта форма наследуется от WagtailAdminModelForm или WagtailAdminPageForm для страниц. Пользовательский базовый класс формы можно настроить, задав атрибут base_form_class в любой модели. Пользовательские формы для фрагментов должны наследоваться от WagtailAdminModelForm, а пользовательские формы для страниц должны наследоваться от WagtailAdminPageForm.

Это можно использовать для добавления полей, не связанных с моделью, в форму, для автоматического создания содержимого поля или для добавления пользовательской логики валидации для ваших моделей:

from django import forms
from django.db import models
import geocoder  # not in Wagtail, for example only - https://geocoder.readthedocs.io/
from wagtail.admin.panels import FieldPanel
from wagtail.admin.forms import WagtailAdminPageForm
from wagtail.models import Page


class EventPageForm(WagtailAdminPageForm):
    address = forms.CharField()

    def clean(self):
        cleaned_data = super().clean()

        # Make sure that the event starts before it ends
        start_date = cleaned_data['start_date']
        end_date = cleaned_data['end_date']
        if start_date and end_date and start_date > end_date:
            self.add_error('end_date', 'The end date must be after the start date')

        return cleaned_data

    def save(self, commit=True):
        page = super().save(commit=False)

        # Update the duration field from the submitted dates
        page.duration = (page.end_date - page.start_date).days

        # Fetch the location by geocoding the address
        page.location = geocoder.arcgis(self.cleaned_data['address'])

        if commit:
            page.save()
        return page


class EventPage(Page):
    start_date = models.DateField()
    end_date = models.DateField()
    duration = models.IntegerField()
    location = models.CharField(max_length=255)

    content_panels = [
        FieldPanel('title'),
        FieldPanel('start_date'),
        FieldPanel('end_date'),
        FieldPanel('address'),
    ]
    base_form_class = EventPageForm

Wagtail сгенерирует новый подкласс этой формы для модели, добавив все поля, определённые в panels или content_panels. Любые поля, уже определённые в модели, не будут перезаписаны этими автоматически добавленными полями, поэтому поле формы для поля модели можно переопределить, добавив его в пользовательскую форму.