Made object history list template overridable

Including renaming it to remove the `_` prefix (indicating that it's
internal / not meant for usage by library users), and adding an
`object_history_list_template` field to the admin class.
This rename also changed the order of messages in the translation files.

Also deprecated the template tag `simple_history_admin_list.display_list`,
as it's now entirely unused within the project.

Author: ddabble

CHANGES.rst

@@ -5,6 +5,12 @@ Unreleased
 ----------
 
 - Support custom History ``Manager`` and ``QuerySet`` classes (gh-1280)
+- Renamed the (previously internal) admin template
+  ``simple_history/_object_history_list.html`` to
+  ``simple_history/object_history_list.html``, and added the field
+  ``SimpleHistoryAdmin.object_history_list_template`` for overriding it (gh-1128)
+- Deprecated the undocumented template tag ``simple_history_admin_list.display_list()``;
+  it will be removed in version 3.8 (gh-1128)
 
 3.5.0 (2024-02-19)
 ------------------

docs/admin.rst

@@ -69,6 +69,24 @@ admin class
 
 .. image:: screens/5_history_list_display.png
 
+
+Customizing the History Admin Templates
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+If you'd like to customize the HTML of ``SimpleHistoryAdmin``'s object history pages,
+you can override the following attributes with the names of your own templates:
+
+- ``object_history_template``: The main object history page, which includes (inserts)
+  ``object_history_list_template``.
+- ``object_history_list_template``: The table listing an object's historical records and
+  the changes made between them.
+- ``object_history_form_template``: The form pre-filled with the details of an object's
+  historical record, which also allows you to revert the object to a previous version.
+
+If you'd like to only customize certain parts of the mentioned templates, look for
+``block`` template tags in the source code that you can override.
+
+
 Disabling the option to revert an object
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 

simple_history/admin.py

@@ -20,6 +20,7 @@
 
 class SimpleHistoryAdmin(admin.ModelAdmin):
     object_history_template = "simple_history/object_history.html"
+    object_history_list_template = "simple_history/object_history_list.html"
     object_history_form_template = "simple_history/object_history_form.html"
 
     def get_urls(self):
@@ -80,6 +81,7 @@ def history_view(self, request, object_id, extra_context=None):
         )
         context = {
             "title": self.history_view_title(request, obj),
+            "object_history_list_template": self.object_history_list_template,
             "historical_records": historical_records,
             "module_name": capfirst(force_str(opts.verbose_name_plural)),
             "object": obj,

simple_history/locale/ar/LC_MESSAGES/django.po

@@ -60,30 +60,6 @@ msgstr "تغيير"
 msgid "Deleted"
 msgstr "تمت إزالته"
 
-#: simple_history/templates/simple_history/_object_history_list.html:9
-msgid "Object"
-msgstr "عنصر"
-
-#: simple_history/templates/simple_history/_object_history_list.html:13
-msgid "Date/time"
-msgstr "التاريخ/الوقت"
-
-#: simple_history/templates/simple_history/_object_history_list.html:14
-msgid "Comment"
-msgstr "تعليق"
-
-#: simple_history/templates/simple_history/_object_history_list.html:15
-msgid "Changed by"
-msgstr "تغير من قبل"
-
-#: simple_history/templates/simple_history/_object_history_list.html:16
-msgid "Change reason"
-msgstr "سبب التغير"
-
-#: simple_history/templates/simple_history/_object_history_list.html:37
-msgid "None"
-msgstr "فارغ"
-
 #: simple_history/templates/simple_history/object_history.html:11
 msgid ""
 "Choose a date from the list below to revert to a previous version of this "
@@ -121,6 +97,30 @@ msgstr "اضغط على زر 'استرجاع' ادناه للاسترجاع له
 msgid "Press the 'Change History' button below to edit the history."
 msgstr "اضغط على زر 'تعديل سجل التغيرات' ادناه لتعديل التاريخ."
 
+#: simple_history/templates/simple_history/object_history_list.html:9
+msgid "Object"
+msgstr "عنصر"
+
+#: simple_history/templates/simple_history/object_history_list.html:13
+msgid "Date/time"
+msgstr "التاريخ/الوقت"
+
+#: simple_history/templates/simple_history/object_history_list.html:14
+msgid "Comment"
+msgstr "تعليق"
+
+#: simple_history/templates/simple_history/object_history_list.html:15
+msgid "Changed by"
+msgstr "تغير من قبل"
+
+#: simple_history/templates/simple_history/object_history_list.html:16
+msgid "Change reason"
+msgstr "سبب التغير"
+
+#: simple_history/templates/simple_history/object_history_list.html:42
+msgid "None"
+msgstr "فارغ"
+
 #: simple_history/templates/simple_history/submit_line.html:4
 msgid "Revert"
 msgstr "استرجاع"

simple_history/locale/cs_CZ/LC_MESSAGES/django.po

@@ -59,30 +59,6 @@ msgstr "Změněno"
 msgid "Deleted"
 msgstr "Smazáno"
 
-#: simple_history/templates/simple_history/_object_history_list.html:9
-msgid "Object"
-msgstr "Objekt"
-
-#: simple_history/templates/simple_history/_object_history_list.html:13
-msgid "Date/time"
-msgstr "Datum/čas"
-
-#: simple_history/templates/simple_history/_object_history_list.html:14
-msgid "Comment"
-msgstr "Komentář"
-
-#: simple_history/templates/simple_history/_object_history_list.html:15
-msgid "Changed by"
-msgstr "Změnil"
-
-#: simple_history/templates/simple_history/_object_history_list.html:16
-msgid "Change reason"
-msgstr "Důvod změny"
-
-#: simple_history/templates/simple_history/_object_history_list.html:37
-msgid "None"
-msgstr "Žádné"
-
 #: simple_history/templates/simple_history/object_history.html:11
 msgid ""
 "Choose a date from the list below to revert to a previous version of this "
@@ -121,6 +97,30 @@ msgstr "Stisknutím tlačítka 'Vrátit změny' se vrátíte k této verzi objek
 msgid "Press the 'Change History' button below to edit the history."
 msgstr "Chcete-li historii upravit, stiskněte tlačítko 'Změnit historii'"
 
+#: simple_history/templates/simple_history/object_history_list.html:9
+msgid "Object"
+msgstr "Objekt"
+
+#: simple_history/templates/simple_history/object_history_list.html:13
+msgid "Date/time"
+msgstr "Datum/čas"
+
+#: simple_history/templates/simple_history/object_history_list.html:14
+msgid "Comment"
+msgstr "Komentář"
+
+#: simple_history/templates/simple_history/object_history_list.html:15
+msgid "Changed by"
+msgstr "Změnil"
+
+#: simple_history/templates/simple_history/object_history_list.html:16
+msgid "Change reason"
+msgstr "Důvod změny"
+
+#: simple_history/templates/simple_history/object_history_list.html:42
+msgid "None"
+msgstr "Žádné"
+
 #: simple_history/templates/simple_history/submit_line.html:4
 msgid "Revert"
 msgstr "Vrátit změny"

simple_history/locale/de/LC_MESSAGES/django.po

@@ -48,30 +48,6 @@ msgstr "Geändert"
 msgid "Deleted"
 msgstr "Gelöscht"
 
-#: simple_history/templates/simple_history/_object_history_list.html:9
-msgid "Object"
-msgstr "Objekt"
-
-#: simple_history/templates/simple_history/_object_history_list.html:13
-msgid "Date/time"
-msgstr "Datum/Uhrzeit"
-
-#: simple_history/templates/simple_history/_object_history_list.html:14
-msgid "Comment"
-msgstr "Kommentar"
-
-#: simple_history/templates/simple_history/_object_history_list.html:15
-msgid "Changed by"
-msgstr "Geändert von"
-
-#: simple_history/templates/simple_history/_object_history_list.html:16
-msgid "Change reason"
-msgstr "Änderungsgrund"
-
-#: simple_history/templates/simple_history/_object_history_list.html:37
-msgid "None"
-msgstr "Keine/r"
-
 #: simple_history/templates/simple_history/object_history.html:11
 msgid ""
 "Choose a date from the list below to revert to a previous version of this "
@@ -108,6 +84,30 @@ msgstr ""
 msgid "Or press the 'Change History' button to edit the history."
 msgstr "Oder wählen Sie 'Historie ändern', um diese zu bearbeiten."
 
+#: simple_history/templates/simple_history/object_history_list.html:9
+msgid "Object"
+msgstr "Objekt"
+
+#: simple_history/templates/simple_history/object_history_list.html:13
+msgid "Date/time"
+msgstr "Datum/Uhrzeit"
+
+#: simple_history/templates/simple_history/object_history_list.html:14
+msgid "Comment"
+msgstr "Kommentar"
+
+#: simple_history/templates/simple_history/object_history_list.html:15
+msgid "Changed by"
+msgstr "Geändert von"
+
+#: simple_history/templates/simple_history/object_history_list.html:16
+msgid "Change reason"
+msgstr "Änderungsgrund"
+
+#: simple_history/templates/simple_history/object_history_list.html:42
+msgid "None"
+msgstr "Keine/r"
+
 #: simple_history/templates/simple_history/submit_line.html:3
 msgid "Revert"
 msgstr "Wiederherstellen"

simple_history/locale/fr/LC_MESSAGES/django.po

@@ -59,30 +59,6 @@ msgstr "Modifié"
 msgid "Deleted"
 msgstr "Effacé"
 
-#: .\simple_history\templates\simple_history\_object_history_list.html:9
-msgid "Object"
-msgstr "Objet"
-
-#: .\simple_history\templates\simple_history\_object_history_list.html:13
-msgid "Date/time"
-msgstr "Date/heure"
-
-#: .\simple_history\templates\simple_history\_object_history_list.html:14
-msgid "Comment"
-msgstr "Commentaire"
-
-#: .\simple_history\templates\simple_history\_object_history_list.html:15
-msgid "Changed by"
-msgstr "Modifié par"
-
-#: .\simple_history\templates\simple_history\_object_history_list.html:16
-msgid "Change reason"
-msgstr "Raison de la modification"
-
-#: .\simple_history\templates\simple_history\_object_history_list.html:37
-msgid "None"
-msgstr "Aucun"
-
 #: .\simple_history\templates\simple_history\object_history.html:11
 msgid ""
 "Choose a date from the list below to revert to a previous version of this "
@@ -125,6 +101,30 @@ msgid "Press the 'Change History' button below to edit the history."
 msgstr ""
 "Cliquez sur le bouton 'Historique' ci-dessous pour modifier l'historique."
 
+#: .\simple_history\templates\simple_history\object_history_list.html:9
+msgid "Object"
+msgstr "Objet"
+
+#: .\simple_history\templates\simple_history\object_history_list.html:13
+msgid "Date/time"
+msgstr "Date/heure"
+
+#: .\simple_history\templates\simple_history\object_history_list.html:14
+msgid "Comment"
+msgstr "Commentaire"
+
+#: .\simple_history\templates\simple_history\object_history_list.html:15
+msgid "Changed by"
+msgstr "Modifié par"
+
+#: .\simple_history\templates\simple_history\object_history_list.html:16
+msgid "Change reason"
+msgstr "Raison de la modification"
+
+#: .\simple_history\templates\simple_history\object_history_list.html:42
+msgid "None"
+msgstr "Aucun"
+
 #: .\simple_history\templates\simple_history\submit_line.html:4
 msgid "Revert"
 msgstr "Rétablir"

simple_history/locale/id/LC_MESSAGES/django.po

@@ -58,30 +58,6 @@ msgstr "Diubah"
 msgid "Deleted"
 msgstr "Dihapus"
 
-#: .\simple_history\templates\simple_history\_object_history_list.html:9
-msgid "Object"
-msgstr "Objek"
-
-#: .\simple_history\templates\simple_history\_object_history_list.html:13
-msgid "Date/time"
-msgstr "Tanggal/waktu"
-
-#: .\simple_history\templates\simple_history\_object_history_list.html:14
-msgid "Comment"
-msgstr "Komentar"
-
-#: .\simple_history\templates\simple_history\_object_history_list.html:15
-msgid "Changed by"
-msgstr "Diubah oleh"
-
-#: .\simple_history\templates\simple_history\_object_history_list.html:16
-msgid "Change reason"
-msgstr "Alasan perubahan"
-
-#: .\simple_history\templates\simple_history\_object_history_list.html:37
-msgid "None"
-msgstr "Tidak ada"
-
 #: .\simple_history\templates\simple_history\object_history.html:11
 msgid ""
 "Choose a date from the list below to revert to a previous version of this "
@@ -122,6 +98,30 @@ msgstr ""
 msgid "Press the 'Change History' button below to edit the history."
 msgstr "Tekan tombol 'Ubah Riwayat' di bawah ini untuk mengubah riwayat."
 
+#: .\simple_history\templates\simple_history\object_history_list.html:9
+msgid "Object"
+msgstr "Objek"
+
+#: .\simple_history\templates\simple_history\object_history_list.html:13
+msgid "Date/time"
+msgstr "Tanggal/waktu"
+
+#: .\simple_history\templates\simple_history\object_history_list.html:14
+msgid "Comment"
+msgstr "Komentar"
+
+#: .\simple_history\templates\simple_history\object_history_list.html:15
+msgid "Changed by"
+msgstr "Diubah oleh"
+
+#: .\simple_history\templates\simple_history\object_history_list.html:16
+msgid "Change reason"
+msgstr "Alasan perubahan"
+
+#: .\simple_history\templates\simple_history\object_history_list.html:42
+msgid "None"
+msgstr "Tidak ada"
+
 #: .\simple_history\templates\simple_history\submit_line.html:4
 msgid "Revert"
 msgstr "Kembalikan"