Приложение flatpages¶

Использование URLconf¶

Существует несколько способов включения плоских страниц в URLconf. Вы можете выделить определенный путь для плоских страниц:

urlpatterns = [
    path("pages/", include("django.contrib.flatpages.urls")),
]

Вы также можете установить его в качестве шаблона «catchall». В этом случае важно поместить шаблон в конец других urlpatterns:

from django.contrib.flatpages import views

# Your other patterns here
urlpatterns += [
    re_path(r"^(?P<url>.*/)$", views.flatpage),
]

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

from django.contrib.flatpages import views

urlpatterns += [
    path("about-us/", views.flatpage, {"url": "/about-us/"}, name="about"),
    path("license/", views.flatpage, {"url": "/license/"}, name="license"),
]

Использование промежуточного программного обеспечения¶

FlatpageFallbackMiddleware может выполнить всю работу.

class FlatpageFallbackMiddleware¶

Каждый раз, когда любое приложение Django выдает ошибку 404, это промежуточное ПО проверяет базу данных flatpages на наличие запрашиваемого URL в качестве последнего средства. В частности, она проверяет наличие плоской страницы с заданным URL с идентификатором сайта, который соответствует настройке SITE_ID.

Если он находит совпадение, то следует этому алгоритму:

• Если у плоской страницы есть пользовательский шаблон, то загружается этот шаблон. В противном случае загружается шаблон flatpages/default.html.
• Он передает этому шаблону единственную контекстную переменную flatpage, которая является объектом flatpage. Он использует RequestContext при рендеринге шаблона.

Промежуточное ПО будет добавлять косую черту и перенаправлять (глядя на параметр APPEND_SLASH), только если полученный URL ссылается на действительную плоскую страницу. Перенаправления являются постоянными (код состояния 301).

Если он не находит совпадения, запрос продолжает обрабатываться как обычно.

Промежуточное ПО активируется только для 404 - не для 500 или ответов с любым другим кодом состояния.

Обратите внимание, что порядок MIDDLEWARE имеет значение. Как правило, FlatpageFallbackMiddleware можно поместить в конец списка. Это означает, что он будет запущен первым при обработке ответа, и гарантирует, что любое другое промежуточное ПО, обрабатывающее ответ, увидит настоящий ответ плоской страницы, а не 404.

Подробнее о промежуточном программном обеспечении читайте в middleware docs.

Через интерфейс администратора¶

Если вы активировали автоматический интерфейс администратора Django, вы должны увидеть раздел «Flatpages» на индексной странице администратора. Редактируйте плоские страницы так же, как вы редактируете любой другой объект в системе.

В модели FlatPage есть поле enable_comments, которое не используется в contrib.flatpages, но может быть полезно для вашего проекта или сторонних приложений. Оно не отображается в интерфейсе администратора, но вы можете добавить его, зарегистрировав пользовательское ModelAdmin для FlatPage:

from django.contrib import admin
from django.contrib.flatpages.admin import FlatPageAdmin
from django.contrib.flatpages.models import FlatPage
from django.utils.translation import gettext_lazy as _


# Define a new FlatPageAdmin
class FlatPageAdmin(FlatPageAdmin):
    fieldsets = [
        (None, {"fields": ["url", "title", "content", "sites"]}),
        (
            _("Advanced options"),
            {
                "classes": ["collapse"],
                "fields": [
                    "enable_comments",
                    "registration_required",
                    "template_name",
                ],
            },
        ),
    ]


# Re-register FlatPageAdmin
admin.site.unregister(FlatPage)
admin.site.register(FlatPage, FlatPageAdmin)

Через API Python¶

class FlatPage¶

Плоские страницы представлены стандартным Django model, который живет в django/contrib/flatpages/models.py. Доступ к объектам flatpage осуществляется через Django database API.

Отображение registration_required плоских страниц¶

По умолчанию тег шаблона get_flatpages будет показывать только те плоские страницы, которые помечены registration_required = False. Если вы хотите отображать защищенные от регистрации плоские страницы, вам необходимо указать авторизованного пользователя с помощью условия for.

Например:

{% get_flatpages for someuser as about_pages %}

Если вы укажете анонимного пользователя, get_flatpages будет вести себя так же, как если бы вы не указали пользователя - то есть, он будет показывать вам только публичные плоские страницы.

Ограничение плоских страниц по базовому URL¶

Дополнительный аргумент starts_with может быть применен для ограничения возвращаемых страниц теми, которые начинаются с определенного базового URL. Этот аргумент может быть передан как строка или как переменная, которая будет определена из контекста.

Например:

{% get_flatpages '/about/' as about_pages %}
{% get_flatpages about_prefix as about_pages %}
{% get_flatpages '/about/' for someuser as about_pages %}

Пример¶

Вот пример URLconf с использованием FlatPageSitemap:

from django.contrib.flatpages.sitemaps import FlatPageSitemap
from django.contrib.sitemaps.views import sitemap
from django.urls import path

urlpatterns = [
    # ...
    # the sitemap
    path(
        "sitemap.xml",
        sitemap,
        {"sitemaps": {"flatpages": FlatPageSitemap}},
        name="django.contrib.sitemaps.views.sitemap",
    ),
]