Modèle de page de contenu personnalisé¶
Les projets utilisant Sites conformes sous forme de paquet peuvent remplacer le
modèle ContentPage par leur propre modèle, pour y ajouter des champs, des
panneaux d’administration ou un template spécifique.
C’est la seule solution qui évite de forker le projet.
Le mécanisme est celui des modèles de page de base personnalisés de Wagtail 8
(WAGTAIL_PAGE_MODEL), lui-même basé sur AUTH_USER_MODEL de Django et la
bibliothèque swapper :
le paquet fournit une classe abstraite
AbstractContentPagele réglage
SF_CONTENTPAGE_MODELdésigne le modèle à utiliser.
Avertissement
Le réglage doit être défini avant la première migration du projet. S’il arrivait que des pages soient déjà créées avec le modèle fourni par Sites Conformes, alors celles-ci ne seront pas converties et il faudra effectuer une migration de données pas forcément évidente.
Mise en place¶
Créez une app django ou utilisez une app existante de votre projet.
Déclarez votre modèle hérité de
AbstractContentPage. Le champtagset son modèle intermédiaire sont obligatoires : ils sont utilisés par les pages d’étiquettes de Sites Conformes, et une vérification système (sites_conformes_core.E001) échoue s’ils manquent. Le modèle intermédiaire du paquet (TagContentPage) et sa table ne sont pas créés lorsque le modèle est remplacé. Le champsubtitleest en revanche un exemple de personnalisation.Les nouveaux champs ne sont exposés dans l’API et l’index de recherche que s’ils sont ajoutés à
api_fieldsetsearch_fields.from django.db import models from modelcluster.fields import ParentalKey from modelcluster.tags import ClusterTaggableManager from taggit.models import TaggedItemBase from wagtail.admin.panels import FieldPanel from wagtail.api import APIField from wagtail.search import index from sites_conformes.core.models import AbstractContentPage class CustomContentPage(AbstractContentPage): tags = ClusterTaggableManager(through="TagCustomContentPage", blank=True) subtitle = models.CharField(max_length=255, blank=True, default="") content_panels = AbstractContentPage.content_panels + [ FieldPanel("tags"), FieldPanel("subtitle"), ] api_fields = AbstractContentPage.api_fields + [APIField("tags"), APIField("subtitle")] search_fields = AbstractContentPage.search_fields + [index.SearchField("subtitle")] class TagCustomContentPage(TaggedItemBase): content_object = ParentalKey("CustomContentPage", related_name="tagged_items")
Ajoutez l’app à
INSTALLED_APPSet définissez le réglage, au formatapp_label.ModelName:SF_CONTENTPAGE_MODEL = "my_app.CustomContentPage"
Générez et appliquez les migrations :
python manage.py makemigrations my_app python manage.py migrate
Mettre à jour Sites Conformes¶
Les migrations de schéma du paquet ne s’appliquent pas à un modèle remplacé.
Après chaque mise à jour de Sites Conformes, générez et appliquez les
migrations de votre app pour que les nouveaux champs d’AbstractContentPage
soient ajoutés à votre table :
python manage.py makemigrations my_app
python manage.py migrate
Template¶
Wagtail dérive le nom du template du modèle concret, ici
my_app/custom_content_page.html. S’il n’existe pas, le template du paquet
sites_conformes_core/content_page.html est utilisé. Pour le personnaliser,
créez le template de votre modèle en étendant celui du paquet :
{% extends "sites_conformes_core/content_page.html" %}
À noter que vous pouvez, selon vos besoins, fournir un template sur mesure sans hériter de celui proposé par Sites Conformes. Cependant cela donnera lieu sur le long terme à davantage de maintenance.
Accéder au modèle depuis votre code¶
N’importez pas ContentPage directement : une fois le modèle remplacé, il n’est
plus utilisable. Comme pour la Page de Wagtail 8, passez par swapper :
import swapper
# La classe, une fois les apps chargées (dans une fonction ou une méthode)
ContentPage = swapper.load_model("sites_conformes_core", "ContentPage")
# "my_app.CustomContentPage", utilisable dans les définitions de modèles
# (clés étrangères, subpage_types) et les migrations
swapper.get_model_name("sites_conformes_core", "ContentPage")
# Le modèle choisi, ou False si c’est celui du paquet
swapper.is_swapped("sites_conformes_core", "ContentPage")
Exemple¶
Le projet de démonstration du dépôt (demo/) remplace le modèle par
home.CustomContentPage : voir demo/home/models.py, le réglage dans
demo/demo/settings/base.py et les tests dans demo/home/tests.py, exécutés
en CI.
Il peut être utilisé comme source d’inspiration pour voir une mise en œuvre
complète de cette fonctionnalité.