wagtail/docs/releases/2.1.rst

=========================
Wagtail 2.1 release notes
=========================

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


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

New ``HelpPanel``
~~~~~~~~~~~~~~~~~

A new panel type ``HelpPanel`` allows to easily add HTML within an edit form.
This new feature was developed by Kevin Chung.


Profile picture upload
~~~~~~~~~~~~~~~~~~~~~~

Users can now upload profile pictures directly through the Account Settings menu, rather than using Gravatar. Gravatar is still used as a fallback if no profile picture has been uploaded directly; a new setting :ref:`WAGTAIL_GRAVATAR_PROVIDER_URL <wagtail_gravatar_provider_url>` has been added to specify an alternative provider, or disable the use of external avatars completely. This feature was developed by Daniel Chimeno, Pierre Geier and Matt Westcott.


API lookup by page path
~~~~~~~~~~~~~~~~~~~~~~~

The API now includes an endpoint for finding pages by path; see :ref:`apiv2_finding_pages_by_path`. This feature was developed by Karl Hobley.


User time zone setting
~~~~~~~~~~~~~~~~~~~~~~

Users can now set their current time zone through the Account Settings menu, which will then be reflected in date / time fields throughout the admin (such as go-live / expiry dates). The list of available time zones can be configured via the :ref:`WAGTAIL_USER_TIME_ZONES <WAGTAIL_USER_TIME_ZONES>` setting. This feature was developed by David Moore.


Elasticsearch 6 support
~~~~~~~~~~~~~~~~~~~~~~~

Wagtail now supports Elasticsearch 6. See :ref:`wagtailsearch_backends_elasticsearch` for configuration details. This feature was developed by Karl Hobley.


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

 * Persist tab hash in URL to allow direct navigation to tabs in the admin interface (Ben Weatherman)
 * Animate the chevron icon when opening sub-menus in the admin (Carlo Ascani)
 * Look through the target link and target page slug (in addition to the old slug) when searching for redirects in the admin (Michael Harrison)
 * Remove support for IE6 to IE9 from project template (Samir Shah)
 * Remove outdated X-UA-Compatible meta from admin template  (Thibaud Colas)
 * Add JavaScript source maps in production build for packaged Wagtail (Thibaud Colas)
 * Removed ``assert`` statements from Wagtail API (Kim Chee Leong)
 * Update `jquery-datetimepicker` dependency to make Wagtail more CSP-friendly (`unsafe-eval`) (Pomax)
 * Added error notification when running the ``wagtail`` command on Python <3.4 (Matt Westcott)
 * ``update_index`` management command now accepts a ``--chunk_size`` option to determine the number of items to load at once (Dave Bell)
 * Added hook `register_account_menu_item` to add new account preference items (Michael van Tellingen)
 * Added change email functionality from the account settings (Alejandro Garza, Alexs Mathilda)
 * Add request parameter to edit handlers (Rajeev J Sebastian)
 * ImageChooser now sets a default title based on filename (Coen van der Kamp)
 * Added error handling to the Draftail editor (Thibaud Colas)
 * Add new `wagtail_icon` template tag to facilitate making admin icons accessible (Sander Tuit)
 * Set `ALLOWED_HOSTS` in the project template to allow any host in development (Tom Dyson)
 * Expose reusable client-side code to build Draftail extensions (Thibaud Colas)
 * Added ``WAGTAILFRONTENDCACHE_LANGUAGES`` setting to specify the languages whose URLs are to be purged when using ``i18n_patterns`` (PyMan Claudio Marinozzi)
 * Added ``extra_footer_actions`` template blocks for customising the add/edit page views (Arthur Holzner)

Bug fixes
~~~~~~~~~

 * Status button on 'edit page' now links to the correct URL when live and draft slug differ (LB (Ben Johnston))
 * Image title text in the gallery and in the chooser now wraps for long filenames (LB (Ben Johnston), Luiz Boaretto)
 * Move image editor action buttons to the bottom of the form on mobile (Julian Gallo)
 * StreamField icons are now correctly sorted into groups on the 'append' menu (Tim Heap)
 * Draftail now supports features specified via the ``WAGTAILADMIN_RICH_TEXT_EDITORS`` setting (Todd Dembrey)
 * Password reset form no longer indicates whether the email is recognised, as per standard Django behaviour (Bertrand Bordage)
 * ``UserAttributeSimilarityValidator`` is now correctly enforced on user creation / editing forms (Tim Heap)
 * Focal area removal not working in IE11 and MS Edge (Thibaud Colas)
 * Rewrite password change feedback message to be more user-friendly (Casper Timmers)
 * Correct dropdown arrow styling in Firefox, IE11 (Janneke Janssen, Alexs Mathilda)
 * Password reset no indicates specific validation errors on certain password restrictions (Lucas Moeskops)
 * Confirmation page on page deletion now respects custom ``get_admin_display_title`` methods (Kim Chee Leong)
 * Adding external link with selected text now includes text in link chooser (Tony Yates, Thibaud Colas, Alexs Mathilda)
 * Editing setting object with no site configured no longer crashes (Harm Zeinstra)
 * Creating a new object with inlines while mandatory fields are empty no longer crashes (Bertrand Bordage)
 * Localization of image and apps verbose names
 * Draftail editor no longer crashes after deleting image/embed using DEL key (Thibaud Colas)
 * Breadcrumb navigation now respects custom ``get_admin_display_title`` methods (Arthur Holzner, Wietze Helmantel, Matt Westcott)
 * Inconsistent order of heading features when adding h1, h5 or h6 as default feature for Hallo RichText editor (Loic Teixeira)
 * Add invalid password reset link error message (Coen van der Kamp)
 * Bypass select/prefetch related optimisation on ``update_index`` for ``ParentalManyToManyField`` to fix crash (Tim Kamanin)
 * 'Add user' is now rendered as a button due to the use of quotes within translations (Benoît Vogel)
 * Menu icon no longer overlaps with title in Modeladmin on mobile (Coen van der Kamp)
 * Background color overflow within the Wagtail documentation (Sergey Fedoseev)
 * Page count on homepage summary panel now takes account of user permissions (Andy Chosak)
 * Explorer view now prevents navigating outside of the common ancestor of the user's permissions (Andy Chosak)
 * Generate URL for the current site when multiple sites share the same root page (Codie Roelf)
 * Restored ability to use non-model fields with FieldPanel (Matt Westcott, LB (Ben Johnston))
 * Stop revision comparison view from crashing when non-model FieldPanels are in use (LB (Ben Johnston))
 * Ordering in the page explorer now respects custom ``get_admin_display_title`` methods when sorting <100 pages (Matt Westcott)
 * Use index-specific Elasticsearch endpoints for bulk insertion, for compatibility with providers that lock down the root endpoint (Karl Hobley)
 * Fix usage URL on the document edit page (Jérôme Lebleu)


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

Image format ``image_to_html`` method has been updated
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The internal API for rich text image format objects (see :ref:`rich_text_image_formats`) has been updated; the ``Format.image_to_html`` method now receives the ``extra_attributes`` keyword argument as a dictionary of attributes, rather than a string. If you have defined any custom format objects that override this method, these will need to be updated.
Fill in release date for 2.1 Conflicts: CHANGELOG.txt 2018-05-22 15:33:48 +02:00			`=========================`
			`Wagtail 2.1 release notes`
			`=========================`
Version bump to start work on 2.1 2018-01-30 17:36:19 +01:00
			`.. contents::`
			`:local:`
			`:depth: 1`


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

Fix monospace formatting 2018-04-04 16:00:19 +02:00			New ``HelpPanel``
			`~~~~~~~~~~~~~~~~~`
Changelog for #4374. 2018-03-22 02:42:14 +01:00
Fix monospace formatting 2018-04-04 16:00:19 +02:00			A new panel type ``HelpPanel`` allows to easily add HTML within an edit form.
Added "find" API view and ability to find pages by HTML path This implements a new "find" view for all endpoints which can be used for finding an individual object based on the URL parameters passed to it. If an object is found, the view will return a ``302`` redirect to detail page of that object. If not, the view will return a ``404`` response. For the pages endpoint, I've added a ``html_path`` parameter to this view, this allows finding a page by its path on the site. For example a GET request to ``/api/v2/pages/find/?html_path=/`` will always generate a 302 response to the detail view of the homepage. This uses Wagtail's internal routing mechanism so routable pages are supported as well. Fixes #4154 2018-01-12 14:16:46 +01:00			`This new feature was developed by Kevin Chung.`


Release note for #4462 2018-04-23 17:26:32 +02:00			`Profile picture upload`
			`~~~~~~~~~~~~~~~~~~~~~~`

			Users can now upload profile pictures directly through the Account Settings menu, rather than using Gravatar. Gravatar is still used as a fallback if no profile picture has been uploaded directly; a new setting :ref:`WAGTAIL_GRAVATAR_PROVIDER_URL <wagtail_gravatar_provider_url>` has been added to specify an alternative provider, or disable the use of external avatars completely. This feature was developed by Daniel Chimeno, Pierre Geier and Matt Westcott.


Added "find" API view and ability to find pages by HTML path This implements a new "find" view for all endpoints which can be used for finding an individual object based on the URL parameters passed to it. If an object is found, the view will return a ``302`` redirect to detail page of that object. If not, the view will return a ``404`` response. For the pages endpoint, I've added a ``html_path`` parameter to this view, this allows finding a page by its path on the site. For example a GET request to ``/api/v2/pages/find/?html_path=/`` will always generate a 302 response to the detail view of the homepage. This uses Wagtail's internal routing mechanism so routable pages are supported as well. Fixes #4154 2018-01-12 14:16:46 +01:00			`API lookup by page path`
			`~~~~~~~~~~~~~~~~~~~~~~~`

			The API now includes an endpoint for finding pages by path; see :ref:`apiv2_finding_pages_by_path`. This feature was developed by Karl Hobley.
Version bump to start work on 2.1 2018-01-30 17:36:19 +01:00
Add a per-user timezone setting 2018-04-09 08:56:10 +02:00
			`User time zone setting`
			`~~~~~~~~~~~~~~~~~~~~~~`

			Users can now set their current time zone through the Account Settings menu, which will then be reflected in date / time fields throughout the admin (such as go-live / expiry dates). The list of available time zones can be configured via the :ref:`WAGTAIL_USER_TIME_ZONES <WAGTAIL_USER_TIME_ZONES>` setting. This feature was developed by David Moore.


Release note for #4132 2018-05-04 17:19:27 +02:00			`Elasticsearch 6 support`
			`~~~~~~~~~~~~~~~~~~~~~~~`

			Wagtail now supports Elasticsearch 6. See :ref:`wagtailsearch_backends_elasticsearch` for configuration details. This feature was developed by Karl Hobley.


Version bump to start work on 2.1 2018-01-30 17:36:19 +01:00			`Other features`
			`~~~~~~~~~~~~~~`

Fix indentation on 2.1 release notes (technically we should standardise on no leading space, because the leading space creates a blockquote element - however, it's not really noticeable in the end result, and this way we can easily copy and paste from the changelog...) 2018-03-23 13:32:40 +01:00			`* Persist tab hash in URL to allow direct navigation to tabs in the admin interface (Ben Weatherman)`
			`* Animate the chevron icon when opening sub-menus in the admin (Carlo Ascani)`
			`* Look through the target link and target page slug (in addition to the old slug) when searching for redirects in the admin (Michael Harrison)`
			`* Remove support for IE6 to IE9 from project template (Samir Shah)`
			`* Remove outdated X-UA-Compatible meta from admin template (Thibaud Colas)`
			`* Add JavaScript source maps in production build for packaged Wagtail (Thibaud Colas)`
			* Removed ``assert`` statements from Wagtail API (Kim Chee Leong)
replace my name with my name I do not write code under my passport name, if I have to be in a changelog, please use "Pomax" =) 2018-07-09 20:36:35 +02:00			* Update `jquery-datetimepicker` dependency to make Wagtail more CSP-friendly (`unsafe-eval`) (Pomax)
Fix indentation on 2.1 release notes (technically we should standardise on no leading space, because the leading space creates a blockquote element - however, it's not really noticeable in the end result, and this way we can easily copy and paste from the changelog...) 2018-03-23 13:32:40 +01:00			* Added error notification when running the ``wagtail`` command on Python <3.4 (Matt Westcott)
allow chunk_size to be set in update_index 2018-03-12 19:39:27 +01:00			* ``update_index`` management command now accepts a ``--chunk_size`` option to determine the number of items to load at once (Dave Bell)
Changelog for #4421. 2018-03-29 21:01:47 +02:00			* Added hook `register_account_menu_item` to add new account preference items (Michael van Tellingen)
Added change email functionality from the account settings. Fix #4325 (#4375) 2018-04-02 14:42:46 +02:00			`* Added change email functionality from the account settings (Alejandro Garza, Alexs Mathilda)`
Add request parameter to edit handlers (#4382) 2018-04-02 15:51:14 +02:00			`* Add request parameter to edit handlers (Rajeev J Sebastian)`
ImageChooser now sets a default title based on filename. Fix #2844 (#4385) 2018-04-02 16:11:49 +02:00			`* ImageChooser now sets a default title based on filename (Coen van der Kamp)`
Release note for #4138 in 2.1 2018-04-04 12:42:18 +02:00			`* Added error handling to the Draftail editor (Thibaud Colas)`
Add icon template tag with accessibility options (PoC) (#4381) 2018-04-08 22:41:24 +02:00			* Add new `wagtail_icon` template tag to facilitate making admin icons accessible (Sander Tuit)
Allow any host in development 2018-01-11 16:46:20 +01:00			* Set `ALLOWED_HOSTS` in the project template to allow any host in development (Tom Dyson)
Expose reusable client-side code to build Draftail extensions (#4467) * Expose Draftail package as global variable for reuse * Expose Wagtail React components for reuse * Expose Draftail-related React components for reuse 2018-04-17 23:27:07 +02:00			`* Expose reusable client-side code to build Draftail extensions (Thibaud Colas)`
Improved 'purge_page_from_cache' to purge the url for any managed language 2017-10-25 18:34:48 +02:00			* Added ``WAGTAILFRONTENDCACHE_LANGUAGES`` setting to specify the languages whose URLs are to be purged when using ``i18n_patterns`` (PyMan Claudio Marinozzi)
Add `extra_footer_actions` template blocks 2018-04-02 16:26:41 +02:00			* Added ``extra_footer_actions`` template blocks for customising the add/edit page views (Arthur Holzner)
Version bump to start work on 2.1 2018-01-30 17:36:19 +01:00
			`Bug fixes`
			`~~~~~~~~~`

Release note for #3988 2018-01-30 20:03:34 +01:00			`* Status button on 'edit page' now links to the correct URL when live and draft slug differ (LB (Ben Johnston))`
Add wrapping for image titles in listing. Fix #4233 (#4243) 2018-02-10 00:56:30 +01:00			`* Image title text in the gallery and in the chooser now wraps for long filenames (LB (Ben Johnston), Luiz Boaretto)`
Use correctly sorted StreamBlock children in both prepend and append menus Previously blocks were only correctly sorted and grouped in the prepend menu, while they appeared in definition order in the append menu. 2018-02-19 09:14:36 +01:00			`* Move image editor action buttons to the bottom of the form on mobile (Julian Gallo)`
			`* StreamField icons are now correctly sorted into groups on the 'append' menu (Tim Heap)`
Release note for #4314 in 2.1 2018-03-08 17:22:54 +01:00			* Draftail now supports features specified via the ``WAGTAILADMIN_RICH_TEXT_EDITORS`` setting (Todd Dembrey)
			`* Password reset form no longer indicates whether the email is recognised, as per standard Django behaviour (Bertrand Bordage)`
Release note for #4312 in 2.1 2018-03-08 17:59:59 +01:00			* ``UserAttributeSimilarityValidator`` is now correctly enforced on user creation / editing forms (Tim Heap)
Fix focal area removal not working in IE11 and MS Edge. Fix #4284 2018-02-14 16:14:18 +01:00			`* Focal area removal not working in IE11 and MS Edge (Thibaud Colas)`
Changelog cleanup Documentation typo fixes aren't covered in the changelog (they happen frequently enough that covering them all would create too much noise) 2018-03-20 15:41:00 +01:00			`* Rewrite password change feedback message to be more user-friendly (Casper Timmers)`
Correct dropdown arrow styling in Firefox, IE11. Fix #4336 (#4373) 2018-03-15 12:36:51 +01:00			`* Correct dropdown arrow styling in Firefox, IE11 (Janneke Janssen, Alexs Mathilda)`
Added if statement around error box html for both fields 2018-03-15 13:35:12 +01:00			`* Password reset no indicates specific validation errors on certain password restrictions (Lucas Moeskops)`
Call 'specific' attribute when fetching page Get the specific implementation of a page, this shows the correct get_admin_display_title on the delete confirmation page. 2018-03-14 16:07:55 +01:00			* Confirmation page on page deletion now respects custom ``get_admin_display_title`` methods (Kim Chee Leong)
Adding external link with selected text now includes text in link chooser. Fix #4328 (#4366) 2018-03-20 23:35:41 +01:00			`* Adding external link with selected text now includes text in link chooser (Tony Yates, Thibaud Colas, Alexs Mathilda)`
Changelog for #4362 for 2.1. 2018-03-22 02:54:19 +01:00			`* Editing setting object with no site configured no longer crashes (Harm Zeinstra)`
Changelog for #4402 in 2.1. 2018-03-22 02:59:47 +01:00			`* Creating a new object with inlines while mandatory fields are empty no longer crashes (Bertrand Bordage)`
Changelog for #4397. 2018-03-22 03:03:19 +01:00			`* Localization of image and apps verbose names`
Changelog for #4426 in 2.1. 2018-03-27 22:38:16 +02:00			`* Draftail editor no longer crashes after deleting image/embed using DEL key (Thibaud Colas)`
Ensure breadcrumb respects custom get_admin_display_title methods. Fixes #4353 2018-03-22 14:08:49 +01:00			* Breadcrumb navigation now respects custom ``get_admin_display_title`` methods (Arthur Holzner, Wietze Helmantel, Matt Westcott)
Ensure order of headings features is consistent for HalloJS 2018-04-04 05:35:11 +02:00			`* Inconsistent order of heading features when adding h1, h5 or h6 as default feature for Hallo RichText editor (Loic Teixeira)`
Release notes for #4398 2018-04-06 19:10:05 +02:00			`* Add invalid password reset link error message (Coen van der Kamp)`
Changelog/release note for #4458 2018-04-11 11:04:27 +02:00			* Bypass select/prefetch related optimisation on ``update_index`` for ``ParentalManyToManyField`` to fix crash (Tim Kamanin)
Fix Add user button label (input->button) 2018-04-08 04:31:57 +02:00			`* 'Add user' is now rendered as a button due to the use of quotes within translations (Benoît Vogel)`
4412 Position modeladmin title 2018-03-23 23:30:06 +01:00			`* Menu icon no longer overlaps with title in Modeladmin on mobile (Coen van der Kamp)`
Fixed #4423 -- Fixed background color in docs css. 2018-03-27 11:34:50 +02:00			`* Background color overflow within the Wagtail documentation (Sergey Fedoseev)`
make site summary panel respect user privileges This change modifies how the Wagtail home site summary panel displays the number of pages on the site, and where that number links to. Instead of showing the total number of pages on the site, the panel should show the number of pages under the user's explorable root page (inclusive). If the user has access to the full tree, the Wagtail root is not counted in this total. Previously, the site summary page link would go to the Wagtail root if there were multiple sites in an installation, and to the site root page for a single site. This change modifies this logic so that the link always goes to the user's explorable root page (which may be their explorable root page). The unit tests for the site summary panel have been pulled out into a new module at `wagtail.admin.tests.test_site_summary`, and augmented to test how things work for users with different permissions. 2018-01-18 20:26:27 +01:00			`* Page count on homepage summary panel now takes account of user permissions (Andy Chosak)`
prevent users from navigating privileged pages This change prevents non-admins from navigating around the Wagtail page tree for pages that lie outside of their explorable root. Currently, non-admins can hit any page in the tree using a URL like /admin/pages/123/ even if they don't have any permissions over that page or its part of the page tree. This change adds a (temporary) redirect to requests like this, so that users may not navigate to parts of the tree that lie outside outside of their explorable site root, as determined by the page privileges they have. If they try to hit a URL like the one above, they get redirected to their explorable site root navigation page instead. Relevant unit tests have been modified to incorporate this change. 2018-01-18 21:10:53 +01:00			`* Explorer view now prevents navigating outside of the common ancestor of the user's permissions (Andy Chosak)`
Changelog for #4390. 2018-04-16 15:16:59 +02:00			`* Generate URL for the current site when multiple sites share the same root page (Codie Roelf)`
Release note for #4469 2018-04-17 13:15:17 +02:00			`* Restored ability to use non-model fields with FieldPanel (Matt Westcott, LB (Ben Johnston))`
Release note for #4470 2018-04-17 13:23:24 +02:00			`* Stop revision comparison view from crashing when non-model FieldPanels are in use (LB (Ben Johnston))`
more tests for ordering pages with custom titles 2018-04-20 04:29:38 +02:00			* Ordering in the page explorer now respects custom ``get_admin_display_title`` methods when sorting <100 pages (Matt Westcott)
Pass index name in URL to Bulk API We currently index all items in Elasticsearch using the root bulk api (at ``/_bulk``). This API is to allow multiple indices to be inserted into at once. However, Wagtail inserts into one index at a time so this is not needed. If we pass the index name as a parameter in the call to ``bulk()``, the index-specific bulk API will be used instead (at ``/<index name>/_bulk``. The advantage of this change is it makes it possible to implement access control by checking the URL an application is using. This is required in order for the Bulk API to work on certain hosts (such as Divio). 2018-02-28 15:04:46 +01:00			`* Use index-specific Elasticsearch endpoints for bulk insertion, for compatibility with providers that lock down the root endpoint (Karl Hobley)`
Release note for #4531 in 2.1 2018-05-16 00:23:53 +02:00			`* Fix usage URL on the document edit page (Jérôme Lebleu)`
Release note for #4314 in 2.1 2018-03-08 17:22:54 +01:00
Version bump to start work on 2.1 2018-01-30 17:36:19 +01:00
			`Upgrade considerations`
			`======================`
Use Rendition in image_to_html 2018-02-02 12:34:12 +01:00
			Image format ``image_to_html`` method has been updated
			`~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~`

			The internal API for rich text image format objects (see :ref:`rich_text_image_formats`) has been updated; the ``Format.image_to_html`` method now receives the ``extra_attributes`` keyword argument as a dictionary of attributes, rather than a string. If you have defined any custom format objects that override this method, these will need to be updated.