Allow use with non-Page models coderedcorp#43

DylannCordel · Jul 16, 2024 · 2007921 · 2007921
1 parent 5327840
commit 2007921
Show file tree

Hide file tree

Showing 10 changed files with 2,083 additions and 37 deletions.
diff --git a/docs/customizing/index.rst b/docs/customizing/index.rst
@@ -5,5 +5,6 @@ Advanced Customization
     :maxdepth: 2
 
     Custom Metadata <customize-meta>
+    Use on Snippet <use-on-snippet>
     Custom Editor Interface <customize-editor>
     Django Settings <django-settings>
diff --git a/docs/customizing/use-on-snippet.rst b/docs/customizing/use-on-snippet.rst
@@ -0,0 +1,80 @@
+Use on Snippet models
+=====================
+
+If you use your own custom models which do not inherit from Page (aka `Snippet`
+in Wagtail), you can inherit from `SeoMixinBase`.
+
+You'll have to override some properties and method to match your own seo
+fields or fallbacks:
+
+.. code-block:: python
+
+    class MySnippet(SeoMixinBase, models.Model):
+        promote_panels = SeoMixinBase.seo_panels
+
+        def __str__(self):
+            return f"my snippet {self.pk or 0}"
+
+        def get_full_url(self) -> str:
+            """
+            Return the full URL (including protocol / domain) to this snippet
+            """
+            path = reverse("my_snippet_detail", kwargs={"pk": self.pk})
+            return f"{self.get_site().root_url}/{path}"
+
+        @property
+        def seo_author(self) -> str:
+            """
+            Gets the name of the author of this page.
+            """
+            return "Tux"
+
+        @property
+        def seo_published_at(self) -> datetime:
+            """
+            Gets the date this snippet was first published.
+            """
+            return datetime(1122, 1, 1)
+
+        @property
+        def seo_modified_at(self) -> datetime:
+            """
+            Gets the date this snippet was first published.
+            """
+            return datetime(1204, 3, 31)
+
+        def get_site(self):
+            """
+            Return the Site object that this snippet belongs to.
+            """
+            return Site.objects.first()
+
+Do not forget to add your instance accessible via a `self` into context data
+of your template:
+
+
+.. code-block:: python
+
+    class MySnippetDetailView(DetailView):
+        model = MySnippet
+        template_name = "my_snippet.html"
+
+        def get_context_data(self, **kwargs):
+            context = super().get_context_data(**kwargs)
+            context["self"] = context["object"]
+            return context
+
+Now, ensure your template includes meta and struct_data into the head and body:
+
+.. code-block:: html
+
+    <!-- my_snippet.html -->
+    <html>
+        <head>
+            {% include "wagtailseo/meta.html" %}
+        </head>
+        <body>
+            {% include "wagtailseo/struct_data.html" %}
+            <h1>My Snippet {{ self.pk }}</h1>
+        </body>
+    </html>
diff --git a/testproject/home/apps.py b/testproject/home/apps.py
@@ -0,0 +1,9 @@
+from django.apps import AppConfig
+from django.utils.translation import gettext_lazy as _
+
+
+class HomeAppConfig(AppConfig):
+    name = "home"
+    label = "home"
+    verbose_name = _("home")
+    default_auto_field = "django.db.models.AutoField"