wagtail/docs/releases/2.3.rst

===============================
Wagtail 2.3 (LTS) release notes
===============================

*October 23, 2018*

.. contents::
    :local:
    :depth: 1


Wagtail 2.3 is designated a Long Term Support (LTS) release. Long Term Support releases will continue to receive maintenance updates as necessary to address security and data-loss related issues, up until the next LTS release (typically a period of 8 months).

Note that Wagtail 2.3 will be the last release branch to support Django 1.11.


What's new
==========

Added Django 2.1 support
~~~~~~~~~~~~~~~~~~~~~~~~

Wagtail is now compatible with Django 2.1.  Compatibility fixes were contributed by Ryan Verner and Matt Westcott.


Improved colour contrast
~~~~~~~~~~~~~~~~~~~~~~~~

Colour contrast within the admin interface has been improved, and now complies with WCAG 2 level AA. This was completed by Coen van der Kamp and Naomi Morduch Toubman based on earlier work from Edd Baldry, Naa Marteki Reed and Ben Enright.


Other features
~~~~~~~~~~~~~~

* Added 'scale' image filter (Oliver Wilkerson)
* Added meta tag to prevent search engines from indexing admin pages (Karl Hobley)
* EmbedBlock now validates against recognised embed providers on save (Bertrand Bordage)
* Made cache control headers on Wagtail admin consistent with Django admin (Tomasz Knapik)
* Notification emails now include an "Auto-Submitted: auto-generated" header (Dan Braghis)
* Image chooser panels now show alt text as title (Samir Shah)
* Added ``download_url`` field to images in the API (Michael Harrison)
* Dummy requests for preview now preserve the HTTP Authorization header (Ben Dickinson)


Bug fixes
~~~~~~~~~

* Respect next param on login (Loic Teixeira)
* InlinePanel now handles relations that specify a related_query_name (Aram Dulyan)
* before_delete_page / after_delete_page hooks now run within the same database transaction as the page deletion (Tomasz Knapik)
* Seek to the beginning of image files when uploading, to restore compatibility with django-storages Google Cloud and Azure backends (Mikalai Radchuk)
* Snippet chooser modal no longer fails on snippet models with UUID primary keys (Sævar Öfjörð Magnússon)
* Restored localisation in date/time pickers (David Moore, Thibaud Colas)
* Tag input field no longer treats 'б' on Russian keyboards as a comma (Michael Borisov)
* Disabled autocomplete dropdowns on date/time chooser fields (Janneke Janssen)
* Split up ``wagtail.admin.forms`` to make it less prone to circular imports (Matt Westcott)
* Disable linking to root page in rich text, making the page non-functional (Matt Westcott)
* Pages should be editable and save-able even if there are broken page or document links in rich text (Matt Westcott)
* Avoid redundant round-trips of JSON StreamField data on save, improving performance and preventing consistency issues on fixture loading (Andy Chosak, Matt Westcott)
* Users are not logged out when changing their own password through the Users area (Matt Westcott)


Upgrade considerations
======================

``wagtail.admin.forms`` reorganised
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The ``wagtail.admin.forms`` module has been split up into submodules to make it less prone to producing circular imports, particularly when a custom user model is in use. The following (undocumented) definitions have now been moved to new locations:

+----------------------------------------------+---------------------------------------+
| Definition                                   | New location                          |
+==============================================+=======================================+
| LoginForm                                    | wagtail.admin.forms.auth              |
+----------------------------------------------+---------------------------------------+
| PasswordResetForm                            | wagtail.admin.forms.auth              |
+----------------------------------------------+---------------------------------------+
| URLOrAbsolutePathValidator                   | wagtail.admin.forms.choosers          |
+----------------------------------------------+---------------------------------------+
| URLOrAbsolutePathField                       | wagtail.admin.forms.choosers          |
+----------------------------------------------+---------------------------------------+
| ExternalLinkChooserForm                      | wagtail.admin.forms.choosers          |
+----------------------------------------------+---------------------------------------+
| EmailLinkChooserForm                         | wagtail.admin.forms.choosers          |
+----------------------------------------------+---------------------------------------+
| CollectionViewRestrictionForm                | wagtail.admin.forms.collections       |
+----------------------------------------------+---------------------------------------+
| CollectionForm                               | wagtail.admin.forms.collections       |
+----------------------------------------------+---------------------------------------+
| BaseCollectionMemberForm                     | wagtail.admin.forms.collections       |
+----------------------------------------------+---------------------------------------+
| BaseGroupCollectionMemberPermissionFormSet   | wagtail.admin.forms.collections       |
+----------------------------------------------+---------------------------------------+
| collection_member_permission_formset_factory | wagtail.admin.forms.collections       |
+----------------------------------------------+---------------------------------------+
| CopyForm                                     | wagtail.admin.forms.pages             |
+----------------------------------------------+---------------------------------------+
| PageViewRestrictionForm                      | wagtail.admin.forms.pages             |
+----------------------------------------------+---------------------------------------+
| SearchForm                                   | wagtail.admin.forms.search            |
+----------------------------------------------+---------------------------------------+
| BaseViewRestrictionForm                      | wagtail.admin.forms.view_restrictions |
+----------------------------------------------+---------------------------------------+

The following definitions remain in ``wagtail.admin.forms``: ``FORM_FIELD_OVERRIDES``, ``DIRECT_FORM_FIELD_OVERRIDES``, ``formfield_for_dbfield``, ``WagtailAdminModelFormMetaclass``, ``WagtailAdminModelForm`` and ``WagtailAdminPageForm``.
-												feat: add marking for LTS releases (#10550)

Fixes #10508

											
										
										
											2023-06-12 16:38:14 +02:00
+								===============================
 								Wagtail 2.3 (LTS) release notes
 								===============================
-												Version bump to start work on 2.3

											
										
										
											2018-07-31 11:55:04 +02:00
-												Add release dates to release notes (#8692)

Fixes #8691

* Add dates to markdown based release notes
* Add dates to rst based release notes

											
										
										
											2022-06-16 12:26:03 +02:00
+								*October 23, 2018*
-												Version bump to start work on 2.3

											
										
										
											2018-07-31 11:55:04 +02:00
+								.. contents::
 								    :local:
 								    :depth: 1
-												Update documentation to indicate Django 2.1 support

											
										
										
											2018-08-08 17:04:28 +02:00
+								Wagtail 2.3 is designated a Long Term Support (LTS) release. Long Term Support releases will continue to receive maintenance updates as necessary to address security and data-loss related issues, up until the next LTS release (typically a period of 8 months).
-												Add note that 2.3 is the last dj1.11-compatible release

											
										
										
											2018-10-11 15:26:24 +02:00
+								Note that Wagtail 2.3 will be the last release branch to support Django 1.11.
-												Update documentation to indicate Django 2.1 support

											
										
										
											2018-08-08 17:04:28 +02:00
-												Version bump to start work on 2.3

											
										
										
											2018-07-31 11:55:04 +02:00
+								What's new
 								==========
-												Update documentation to indicate Django 2.1 support

											
										
										
											2018-08-08 17:04:28 +02:00
+								Added Django 2.1 support
 								~~~~~~~~~~~~~~~~~~~~~~~~
-												Trivial change to 2.3.rst to see if readthedocs picks it up

											
										
										
											2018-10-11 18:23:27 +02:00
+								Wagtail is now compatible with Django 2.1.  Compatibility fixes were contributed by Ryan Verner and Matt Westcott.
-												Update documentation to indicate Django 2.1 support

											
										
										
											2018-08-08 17:04:28 +02:00
-												Release note for #4788

											
										
										
											2018-10-11 13:46:21 +02:00
+								Improved colour contrast
 								~~~~~~~~~~~~~~~~~~~~~~~~
 								Colour contrast within the admin interface has been improved, and now complies with WCAG 2 level AA. This was completed by Coen van der Kamp and Naomi Morduch Toubman based on earlier work from Edd Baldry, Naa Marteki Reed and Ben Enright.
-												Version bump to start work on 2.3

											
										
										
											2018-07-31 11:55:04 +02:00
+								Other features
 								~~~~~~~~~~~~~~
-												Fix documentation indentation

Fix code block indentation in tutorial.rst

Prevent it from being displayed as a quote.

Fix indentation in pages.rst

Fix indentation in indexing.rst

Fix indentation in searching.rst

Fix indentation in backends.rst

Fix indentation in renditions.rst

Fix indentation in custom_image_model.rst

Fix indentation in feature_detection.rst

Fix indentation in image_serve_view.rst

Fix indentation in custom_document_model.rst

Fix indentation in i18n.rst

Fix indentation in privacy.rst

Fix indentation in page_editing_interface.rst

Fix indentation in rich_text_internals.rst

Fix indentation in extending_hallo.rst

Fix indentation in configuration.rst

Fix indentation in usage.rst

Fix indentation in theory.rst

Fix indentation in model_reference.rst

Fix indentation in queryset_reference.rst

Configure editors to indent .rst files with 2 spaces

In order for the documentation to be styled correctly, the generator
depends on indentation. Too much indentation can result in the content
being wrapped in a quote block, which looks bad.

Fix indentation in sitemaps.rst

Fix indentation in frontendcache.rst

Fix indentation in routablepage.rst

Fix indentation in table_block.rst

Fix routablepage.rst autodocs disppearing

Fix indentation in table_block.rst

Fix indentation in redirects.rst

Fix indentation in table_documentation-modes.rst

Fix indentation in browser_issues.rst

Fix indentation in release_process.rst

Fix indentation of release notes

One more indent fix in the release notes

Fix indentation warnings

Fix warning about undefined label in docs

Error during `make html`:

  wagtail/docs/releases/1.7.rst:25: WARNING: undefined label: jpeg_image_quality

											
										
										
											2021-02-05 12:02:05 +01:00
+								* Added 'scale' image filter (Oliver Wilkerson)
 								* Added meta tag to prevent search engines from indexing admin pages (Karl Hobley)
 								* EmbedBlock now validates against recognised embed providers on save (Bertrand Bordage)
 								* Made cache control headers on Wagtail admin consistent with Django admin (Tomasz Knapik)
 								* Notification emails now include an "Auto-Submitted: auto-generated" header (Dan Braghis)
 								* Image chooser panels now show alt text as title (Samir Shah)
 								* Added ``download_url`` field to images in the API (Michael Harrison)
 								* Dummy requests for preview now preserve the HTTP Authorization header (Ben Dickinson)
-												Added a simple scale filter to image_operations.

											
										
										
											2018-03-23 13:09:22 +01:00
-												Version bump to start work on 2.3

											
										
										
											2018-07-31 11:55:04 +02:00
+								Bug fixes
 								~~~~~~~~~
-												Fix documentation indentation

Fix code block indentation in tutorial.rst

Prevent it from being displayed as a quote.

Fix indentation in pages.rst

Fix indentation in indexing.rst

Fix indentation in searching.rst

Fix indentation in backends.rst

Fix indentation in renditions.rst

Fix indentation in custom_image_model.rst

Fix indentation in feature_detection.rst

Fix indentation in image_serve_view.rst

Fix indentation in custom_document_model.rst

Fix indentation in i18n.rst

Fix indentation in privacy.rst

Fix indentation in page_editing_interface.rst

Fix indentation in rich_text_internals.rst

Fix indentation in extending_hallo.rst

Fix indentation in configuration.rst

Fix indentation in usage.rst

Fix indentation in theory.rst

Fix indentation in model_reference.rst

Fix indentation in queryset_reference.rst

Configure editors to indent .rst files with 2 spaces

In order for the documentation to be styled correctly, the generator
depends on indentation. Too much indentation can result in the content
being wrapped in a quote block, which looks bad.

Fix indentation in sitemaps.rst

Fix indentation in frontendcache.rst

Fix indentation in routablepage.rst

Fix indentation in table_block.rst

Fix routablepage.rst autodocs disppearing

Fix indentation in table_block.rst

Fix indentation in redirects.rst

Fix indentation in table_documentation-modes.rst

Fix indentation in browser_issues.rst

Fix indentation in release_process.rst

Fix indentation of release notes

One more indent fix in the release notes

Fix indentation warnings

Fix warning about undefined label in docs

Error during `make html`:

  wagtail/docs/releases/1.7.rst:25: WARNING: undefined label: jpeg_image_quality

											
										
										
											2021-02-05 12:02:05 +01:00
+								* Respect next param on login (Loic Teixeira)
 								* InlinePanel now handles relations that specify a related_query_name (Aram Dulyan)
 								* before_delete_page / after_delete_page hooks now run within the same database transaction as the page deletion (Tomasz Knapik)
 								* Seek to the beginning of image files when uploading, to restore compatibility with django-storages Google Cloud and Azure backends (Mikalai Radchuk)
 								* Snippet chooser modal no longer fails on snippet models with UUID primary keys (Sævar Öfjörð Magnússon)
 								* Restored localisation in date/time pickers (David Moore, Thibaud Colas)
 								* Tag input field no longer treats 'б' on Russian keyboards as a comma (Michael Borisov)
 								* Disabled autocomplete dropdowns on date/time chooser fields (Janneke Janssen)
 								* Split up ``wagtail.admin.forms`` to make it less prone to circular imports (Matt Westcott)
 								* Disable linking to root page in rich text, making the page non-functional (Matt Westcott)
 								* Pages should be editable and save-able even if there are broken page or document links in rich text (Matt Westcott)
 								* Avoid redundant round-trips of JSON StreamField data on save, improving performance and preventing consistency issues on fixture loading (Andy Chosak, Matt Westcott)
 								* Users are not logged out when changing their own password through the Users area (Matt Westcott)
-												Release note for #4801

											
										
										
											2018-10-10 17:09:59 +02:00
-												Respect redirect parameter after login

											
										
										
											2018-08-06 01:20:07 +02:00
-												Version bump to start work on 2.3

											
										
										
											2018-07-31 11:55:04 +02:00
+								Upgrade considerations
 								======================
-												Release / deprecation notes for #4777

											
										
										
											2018-09-28 23:41:01 +02:00
 								``wagtail.admin.forms`` reorganised
 								~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 								The ``wagtail.admin.forms`` module has been split up into submodules to make it less prone to producing circular imports, particularly when a custom user model is in use. The following (undocumented) definitions have now been moved to new locations:
 								+----------------------------------------------+---------------------------------------+
 								| Definition                                   | New location                          |
 								+==============================================+=======================================+
 								| LoginForm                                    | wagtail.admin.forms.auth              |
 								+----------------------------------------------+---------------------------------------+
 								| PasswordResetForm                            | wagtail.admin.forms.auth              |
 								+----------------------------------------------+---------------------------------------+
 								| URLOrAbsolutePathValidator                   | wagtail.admin.forms.choosers          |
 								+----------------------------------------------+---------------------------------------+
 								| URLOrAbsolutePathField                       | wagtail.admin.forms.choosers          |
 								+----------------------------------------------+---------------------------------------+
 								| ExternalLinkChooserForm                      | wagtail.admin.forms.choosers          |
 								+----------------------------------------------+---------------------------------------+
 								| EmailLinkChooserForm                         | wagtail.admin.forms.choosers          |
 								+----------------------------------------------+---------------------------------------+
 								| CollectionViewRestrictionForm                | wagtail.admin.forms.collections       |
 								+----------------------------------------------+---------------------------------------+
 								| CollectionForm                               | wagtail.admin.forms.collections       |
 								+----------------------------------------------+---------------------------------------+
 								| BaseCollectionMemberForm                     | wagtail.admin.forms.collections       |
 								+----------------------------------------------+---------------------------------------+
 								| BaseGroupCollectionMemberPermissionFormSet   | wagtail.admin.forms.collections       |
 								+----------------------------------------------+---------------------------------------+
 								| collection_member_permission_formset_factory | wagtail.admin.forms.collections       |
 								+----------------------------------------------+---------------------------------------+
 								| CopyForm                                     | wagtail.admin.forms.pages             |
 								+----------------------------------------------+---------------------------------------+
 								| PageViewRestrictionForm                      | wagtail.admin.forms.pages             |
 								+----------------------------------------------+---------------------------------------+
 								| SearchForm                                   | wagtail.admin.forms.search            |
 								+----------------------------------------------+---------------------------------------+
 								| BaseViewRestrictionForm                      | wagtail.admin.forms.view_restrictions |
 								+----------------------------------------------+---------------------------------------+
 								The following definitions remain in ``wagtail.admin.forms``: ``FORM_FIELD_OVERRIDES``, ``DIRECT_FORM_FIELD_OVERRIDES``, ``formfield_for_dbfield``, ``WagtailAdminModelFormMetaclass``, ``WagtailAdminModelForm`` and ``WagtailAdminPageForm``.