Flatpages-appenLink to this heading#

Använda URLconfLink to this heading#

There are several ways to include the flatpages in your URLconf. You can dedicate a particular path to flatpages:

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

Du kan också använda det som ett ”catchall”-mönster. I det här fallet är det viktigt att placera mönstret i slutet av de andra urlmönstren:

from django.contrib.flatpages import views

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

Another common setup is to use flatpages for a limited set of known pages and to hardcode their URLs in the URLconf:

from django.contrib.flatpages import views

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

Argumentet kwargs anger det url-värde som används för modelluppslagningen FlatPage i flatpage-vyn.

Argumentet name gör att URL:en kan vändas i mallar, t.ex. med hjälp av malltaggen url.

Använda mellanprogramLink to this heading#

Klassen:~django.contrib.flatpages.middleware.FlatpageFallbackMiddleware kan göra allt arbete.

class FlatpageFallbackMiddlewareLink to this definition#

Varje gång en Django-applikation ger upphov till ett 404-fel kontrollerar detta middleware flatpages-databasen för den begärda webbadressen som en sista utväg. Specifikt kontrolleras om det finns en flatpage med den angivna URL:en med ett webbplats-ID som motsvarar inställningen SITE_ID.

Om den hittar en matchning följer den den här algoritmen:

• Om sidan har en egen mall laddas den mallen. Annars laddas mallen flatpages/default.html.

• Den skickar den mallen en enda kontextvariabel, flatpage, som är flatpage-objektet. Den använder RequestContext vid rendering av mallen.

Mellanvaran lägger bara till ett efterföljande snedstreck och omdirigerar (genom att titta på inställningen APPEND_SLASH) om den resulterande URL:en hänvisar till en giltig flatpage. Omdirigeringar är permanenta (301 statuskod).

Om den inte hittar någon matchning fortsätter begäran att behandlas som vanligt.

Middleware aktiveras endast för 404:or - inte för 500:or eller svar med någon annan statuskod.

Observera att ordningen på MIDDLEWARE spelar roll. I allmänhet kan du sätta FlatpageFallbackMiddleware i slutet av listan. Detta innebär att det kommer att köras först när svaret bearbetas och säkerställer att alla andra svarsbearbetande mellanprogram ser det riktiga flatpage-svaret snarare än 404.

Mer information om middleware finns i middleware docs.

Via administratörsgränssnittetLink to this heading#

Om du har aktiverat det automatiska Django-administratörsgränssnittet bör du se ett ”Flatpages”-avsnitt på adminindexsidan. Redigera flatpages som du redigerar alla andra objekt i systemet.

Modellen FlatPage har ett fält enable_comments som inte används av contrib.flatpages, men som kan vara användbart för ditt projekt eller tredjepartsappar. Det visas inte i admin-gränssnittet, men du kan lägga till det genom att registrera en anpassad ModelAdmin för 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)

Via Python APILink to this heading#

Flatpages representeras av en standard Django model, FlatPage. Du kan komma åt flatpage-objekt via Django database API.

FältLink to this heading#

FlatPage-objekt har följande fält:

class models.FlatPage

urlLink to this definition#

Krävs. 100 tecken eller färre. Indexerad för snabbare sökningar.

titleLink to this definition#

Krävs. 200 tecken eller färre.

contentLink to this definition#

Valfritt (blank=True). TextField som vanligtvis innehåller HTML-innehållet på sidan.

enable_commentsLink to this definition#

Boolesk. Detta fält används inte av flatpages som standard och visas inte i admin-gränssnittet. Se flatpages admin interface section för en detaljerad förklaring.

template_nameLink to this definition#

Valfritt (blank=True). 70 tecken eller färre. Anger den mall som används för att rendera sidan. Standardvärdet är flatpages/default.html om den inte anges.

sitesLink to this definition#

Många-till-många-relation till Site, som bestämmer sites som den platta sidan är tillgänglig på.

MetoderLink to this heading#

class models.FlatPage

get_absolute_url()Link to this definition#

Returnerar den relativa URL-sökvägen för sidan baserat på attributet url.

Visning av registration_required flatpagesLink to this heading#

Som standard visar malltaggen get_flatpages endast flatpages som är markerade med registration_required = False. Om du vill visa registreringsskyddade flatpages måste du ange en autentiserad användare med hjälp av en for-klausul.

Till exempel:

{% get_flatpages for someuser as about_pages %}

Om du anger en anonym användare kommer get_flatpages att bete sig på samma sätt som om du inte hade angett någon användare - dvs. den kommer bara att visa dig offentliga flatpages.

Begränsa flatpages genom bas-URLLink to this heading#

Ett valfritt argument, starts_with, kan användas för att begränsa de returnerade sidorna till dem som börjar med en viss bas-URL. Detta argument kan skickas som en sträng eller som en variabel som ska lösas upp från kontexten.

Till exempel:

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

ExempelLink to this heading#

Här är ett exempel på en URLconf som använder 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",
    ),
]