wagtail/docs/releases/2.1.rst

==========================================
Wagtail 2.1 release notes - IN DEVELOPMENT
==========================================

.. 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 Keving Chung.

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`) (Mike Kamermans)
 * 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)

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)


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.
Version bump to start work on 2.1 2018-01-30 17:36:19 +01:00			`==========================================`
			`Wagtail 2.1 release notes - IN DEVELOPMENT`
			`==========================================`

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


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

Changelog for #4374. 2018-03-22 02:42:14 +01:00			New `HelpPanel`
			`~~~~~~~~~~~~~~~`

			A new panel type `HelpPanel` allows to easily add HTML within an edit form.
			`This new feature was developed by Keving Chung.`
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)
			* Update `jquery-datetimepicker` dependency to make Wagtail more CSP-friendly (`unsafe-eval`) (Mike Kamermans)
			* 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)`
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)
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.