wagtail/docs/releases/2.7.rst

==========================================
Wagtail 2.7 release notes - IN DEVELOPMENT
==========================================

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


Wagtail 2.7 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 12 months).


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

* Upgraded Elasticsearch client library dependency to 6.4.0 or above, 7.0.0 or above is still supported.


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

 * Added ``construct_page_listing_buttons`` hook (Michael van Tellingen)
 * Added more detailed documentation and troubleshooting for installing OpenCV for feature detection (Daniele Procida)
 * Move and refactor upgrade notification JS (Jonny Scholes)
 * Remove need for Elasticsearch ``update_all_types`` workaround, upgrade minimum release to 6.4.0 or above (Jonathan Liuti)
 * Add ability to insert internal anchor links/links with fragment identifiers in Draftail (rich text) fields (Iman Syed)
 * Added Table Block caption for accessibility (Rahmi Pruitt)


Bug fixes
~~~~~~~~~

 * Added line breaks to long filenames on multiple image / document uploader (Kevin Howbrook)
 * Added https support for Scribd oEmbed provider (Rodrigo)
 * Changed StreamField group label color so labels are visible (Catherine Farman)
 * Prevented images with a very wide aspect ratio from being displayed distorted in the rich text editor (Iman Syed)
 * Prevent exception when deleting a model with a protected One-to-one relationship (Neal Todd)
 * Added labels to snippet bulk edit checkboxes for screen reader users (Martey Dodoo)
 * Middleware responses during page preview are now properly returned to the user (Matt Westcott)
 * Default text of page links in rich text uses the public page title rather than the admin display title (Andy Chosak)
 * Specific page permission checks are now enforced when viewing a page revision (Andy Chosak)
 * ``pageurl`` and ``slugurl`` tags no longer fail when ``request.site`` is ``None`` (Samir Shah)
 * Output form media on add/edit image forms with custom models (Matt Westcott)


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

``Page.dummy_request`` is deprecated
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The internal ``Page.dummy_request`` method (which generates an HTTP request object simulating a real page request, for use in previews) has been deprecated, as it did not correctly handle errors generated during middleware processing. Any code that calls this method to render page previews should be updated to use the new method ``Page.make_preview_request(original_request=None, preview_mode=None)``, which builds the request and calls ``Page.serve_preview`` as a single operation.
Add 2.7 section to changelog and release notes 2019-07-09 17:51:48 +02:00			`==========================================`
			`Wagtail 2.7 release notes - IN DEVELOPMENT`
			`==========================================`

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


			`Wagtail 2.7 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 12 months).`


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

Upgrade minimum 6.x release for Elasticsearch to 6.4.0 Fix doc and test on ES6 python client compat This commit changes the statement that version < 6.3.1 of the elasticsearch python client should be used to instead state that 6.4.0 is fine. It also update the tests to reflect the statement. Initially the `update_all_types` argument has been used to work around an issue described in: https://github.com/wagtail/wagtail/issues/2968 This argument was removed in elasticsearch-py 6.3.1 and making use of it was raising an error. With 6.4.0 nothing is raising anymore. 2019-08-15 16:29:27 +02:00			`* Upgraded Elasticsearch client library dependency to 6.4.0 or above, 7.0.0 or above is still supported.`
Add 2.7 section to changelog and release notes 2019-07-09 17:51:48 +02:00
Update Changelog 2019-08-15 23:38:37 +02:00
Add 2.7 section to changelog and release notes 2019-07-09 17:51:48 +02:00			`Other features`
			`~~~~~~~~~~~~~~`

Add a `construct_page_listing_buttons` hook This hook mimics the functiolity provided by `construct_page_action_menu` in that it constructs the final list of buttons to be shown in the wagtail admin interface. This means that within this function button's can be removed, added or re-ordered. See #4925 2019-07-08 09:57:30 +02:00			* Added ``construct_page_listing_buttons`` hook (Michael van Tellingen)
Updated feature detection notes 2019-07-04 11:24:05 +02:00			`* Added more detailed documentation and troubleshooting for installing OpenCV for feature detection (Daniele Procida)`
Move and refactor upgrade notification JS 2019-04-24 23:45:14 +02:00			`* Move and refactor upgrade notification JS (Jonny Scholes)`
Upgrade minimum 6.x release for Elasticsearch to 6.4.0 Fix doc and test on ES6 python client compat This commit changes the statement that version < 6.3.1 of the elasticsearch python client should be used to instead state that 6.4.0 is fine. It also update the tests to reflect the statement. Initially the `update_all_types` argument has been used to work around an issue described in: https://github.com/wagtail/wagtail/issues/2968 This argument was removed in elasticsearch-py 6.3.1 and making use of it was raising an error. With 6.4.0 nothing is raising anymore. 2019-08-15 16:29:27 +02:00			* Remove need for Elasticsearch ``update_all_types`` workaround, upgrade minimum release to 6.4.0 or above (Jonathan Liuti)
Add ability to create anchor link tab within rich text link - add tests - Update changelog & release notes 2019-08-13 18:24:00 +02:00			`* Add ability to insert internal anchor links/links with fragment identifiers in Draftail (rich text) fields (Iman Syed)`
Update Changelog 2019-08-15 23:38:37 +02:00			`* Added Table Block caption for accessibility (Rahmi Pruitt)`
Add 2.7 section to changelog and release notes 2019-07-09 17:51:48 +02:00

			`Bug fixes`
			`~~~~~~~~~`

Release note for #5431 2019-07-25 11:46:41 +02:00			`* Added line breaks to long filenames on multiple image / document uploader (Kevin Howbrook)`
Add https support for scribd oembed provider (#739) Currently scribd defaults to https for their sharing links - http still works but if you copy&paste quickly you may think it's broken 2019-07-25 08:49:41 +02:00			`* Added https support for Scribd oEmbed provider (Rodrigo)`
Change StreamField group labels color so labels are visible. Fix #5455 (#5462) * use lighter grey for streamfield group label for accessible contrast 2019-07-26 22:39:11 +02:00			`* Changed StreamField group label color so labels are visible (Catherine Farman)`
Make image fallback work for images with big/small aspect ratios. Fix #5472 (#5474) 2019-08-01 12:46:34 +02:00			`* Prevented images with a very wide aspect ratio from being displayed distorted in the rich text editor (Iman Syed)`
Prevent exception when attempting to delete a model with a protected 1-to-1 relation Modeladmin handles notification to the user if a model instance has protected ForeignKey relationships. However, if the protected relation is a OneToOneField it raises an exception: File ".../wagtail/wagtail/contrib/modeladmin/views.py", line 742, in post for obj in qs.all(): AttributeError: 'MyRelatedModel' object has no attribute 'all' because qs in this case is the related instance rather than a queryset of related instances (as is the case for a ForeignKey). This commit handles the OneToOneField case as well. 2019-07-17 20:56:52 +02:00			`* Prevent exception when deleting a model with a protected One-to-one relationship (Neal Todd)`
Add labels to snippet bulk edit checkboxes for screen reader users. Fix #5328 (#5463) 2019-08-05 19:12:08 +02:00			`* Added labels to snippet bulk edit checkboxes for screen reader users (Martey Dodoo)`
Release note for #5427 2019-08-08 13:54:37 +02:00			`* Middleware responses during page preview are now properly returned to the user (Matt Westcott)`
Don't use page admin title when editing rich text (#5491) When editing a rich text field and entering a link to a page whose Page type overrides get_admin_display_title, the custom admin display title is used both when browsing to select the page to link to and also when viewing the rich text editor. The first behavior is consistent with how custom admin display titles are used throughout the admin, but the second behavior is not. The Wagtail user should be able to use the rich text field as a reasonable preview of what the rendered content will look like for the end user. To do this, the "real" page title should be used, not the admin one. This commit alters the data that gets passed to the rich text editor so that its title is the real page title and not the admin one. Fixes issue 5131. 2019-08-07 23:00:02 +02:00			`* Default text of page links in rich text uses the public page title rather than the admin display title (Andy Chosak)`
Properly check permissions when viewing revisions (#5490) Currently any user with any page permission can view any page revision. This commit fixes that, and ensures that the user has publish or edit permission on the page before showing a page revision. If not, the user is presented with a 403. This maintains the current behavior if the user has no page permissions, which is to redirect to the admin home page. New tests have been added to cover these changes. Fixes issue 5426. 2019-08-07 19:44:32 +02:00			`* Specific page permission checks are now enforced when viewing a page revision (Andy Chosak)`
Fix pageurl and slugurl handling of situations where request.site is null (#5501) 2019-08-14 04:53:04 +02:00			* ``pageurl`` and ``slugurl`` tags no longer fail when ``request.site`` is ``None`` (Samir Shah)
Output form media on add/edit/chooser image forms with custom models * Add tests for custom image on multiple image uploader * Output form media on image add/edit views * Output form media for 'add image' form within image chooser modal Note: this won't work reliably if the media is hosted on a CDN, because script tags inserted as part of a jQuery DOM insertion (as modals are) are loaded asynchronously and not guaranteed to complete loading before inline scripts are run. It's better than not having the includes there at all though... 2019-04-26 17:40:58 +02:00			`* Output form media on add/edit image forms with custom models (Matt Westcott)`
Add 2.7 section to changelog and release notes 2019-07-09 17:51:48 +02:00

			`Upgrade considerations`
			`======================`
Deprecation note for dummy_request 2019-07-11 01:47:04 +02:00
			``Page.dummy_request`` is deprecated
			`~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~`

			The internal ``Page.dummy_request`` method (which generates an HTTP request object simulating a real page request, for use in previews) has been deprecated, as it did not correctly handle errors generated during middleware processing. Any code that calls this method to render page previews should be updated to use the new method ``Page.make_preview_request(original_request=None, preview_mode=None)``, which builds the request and calls ``Page.serve_preview`` as a single operation.