Consolidate base_page_report.html into base_report.html

The template is no longer used in Wagtail itself, but we
keep it around for now so that custom page reports don't
immediately raise an error.
pull/11987/head
Sage Abdullah 2024-05-22 11:47:54 +01:00
rodzic e3dfcc099c
commit 245baa9065
Nie znaleziono w bazie danych klucza dla tego podpisu
ID klucza GPG: EB1A33CC51CC0217
4 zmienionych plików z 28 dodań i 14 usunięć

Wyświetl plik

@ -46,14 +46,17 @@ class UnpublishedChangesReportView(PageReportView):
(string)
The template used to render your report view.
For ``ReportView``, this defaults to ``"wagtailadmin/reports/base_report.html"``;
for ``PageReportView``, this defaults to ``"wagtailadmin/reports/base_page_report.html"``.
The template used to render your report view, defaults to ``"wagtailadmin/reports/base_report.html"``.
Note that this template only provides the skeleton of the view, not the listing table itself.
The listing table should be implemented in a separate template specified by ``results_template_name`` (see below), to then be rendered via ``{% include %}``.
Unless you want to customize the overall view, you will rarely need to change this template.
To customize the listing, change the ``results_template_name`` instead.
.. versionchanged:: 6.2
The default ``template_name`` attribute for ``PageReportView`` was changed from ``"wagtailadmin/reports/base_page_report.html"`` to ``"wagtailadmin/reports/base_report.html"``.
Additionally, customization of the ``template_name`` should generally be replaced with a ``results_template_name`` customization, unless you intend to completely override the view template and not just the listing table.
.. attribute:: results_template_name
(string)

Wyświetl plik

@ -1,7 +1,2 @@
{% extends 'wagtailadmin/reports/base_report.html' %}
{% load i18n %}
{% block results %}
{# Rename the paginator `page_obj` to `pages` for backwards-compatibility #}
{% include view.results_template_name|default:"wagtailadmin/reports/base_page_report_results.html" with pages=page_obj %}
{% endblock %}
{# Kept for backwards-compatibility only #}

Wyświetl plik

@ -43,7 +43,11 @@ class TestLockedPagesView(WagtailTestUtils, TestCase):
def test_simple(self):
response = self.get()
self.assertEqual(response.status_code, 200)
self.assertTemplateUsed(response, "wagtailadmin/reports/base_page_report.html")
self.assertTemplateNotUsed(
response,
"wagtailadmin/reports/base_page_report.html",
)
self.assertTemplateUsed(response, "wagtailadmin/reports/base_report.html")
self.assertTemplateUsed(
response,
"wagtailadmin/reports/locked_pages_results.html",
@ -83,7 +87,11 @@ class TestLockedPagesView(WagtailTestUtils, TestCase):
# Now the listing should contain our locked page
response = self.get()
self.assertEqual(response.status_code, 200)
self.assertTemplateUsed(response, "wagtailadmin/reports/base_page_report.html")
self.assertTemplateNotUsed(
response,
"wagtailadmin/reports/base_page_report.html",
)
self.assertTemplateUsed(response, "wagtailadmin/reports/base_report.html")
self.assertTemplateUsed(
response,
"wagtailadmin/reports/locked_pages_results.html",
@ -127,7 +135,11 @@ class TestLockedPagesView(WagtailTestUtils, TestCase):
response = self.get()
self.assertEqual(response.status_code, 200)
self.assertTemplateUsed(response, "wagtailadmin/reports/base_page_report.html")
self.assertTemplateNotUsed(
response,
"wagtailadmin/reports/base_page_report.html",
)
self.assertTemplateUsed(response, "wagtailadmin/reports/base_report.html")
self.assertTemplateUsed(
response,
"wagtailadmin/reports/locked_pages_results.html",
@ -550,7 +562,11 @@ class TestAgingPagesView(WagtailTestUtils, TestCase):
def test_simple(self):
response = self.get()
self.assertEqual(response.status_code, 200)
self.assertTemplateUsed(response, "wagtailadmin/reports/base_page_report.html")
self.assertTemplateNotUsed(
response,
"wagtailadmin/reports/base_page_report.html",
)
self.assertTemplateUsed(response, "wagtailadmin/reports/base_report.html")
self.assertTemplateUsed(
response,
"wagtailadmin/reports/aging_pages_results.html",

Wyświetl plik

@ -47,7 +47,6 @@ class ReportView(SpreadsheetExportMixin, BaseListingView):
class PageReportView(ReportView):
template_name = "wagtailadmin/reports/base_page_report.html"
results_template_name = "wagtailadmin/reports/base_page_report_results.html"
export_headings = {
"latest_revision_created_at": _("Updated"),
@ -60,3 +59,4 @@ class PageReportView(ReportView):
"status_string",
"content_type.model_class._meta.verbose_name.title",
]
context_object_name = "pages"