Release Notes for XWiki 10.3

Version 18.1 by Thomas Mortagne on 2018/04/23

This is the release notes for XWiki Commons, XWiki Rendering and XWiki Platform. They share the same release notes as they are released together and have the same version.

In this version you will automatically get notification when change are made to pages you worked on. It also introduce the protection against edition of pages coming from extensions to avoid breaking mistakes and ease upgrades.

New and Noteworthy (since XWiki 10.2)

Full list of issues fixed and Dashboard for 10.3.

For Users

Edit protection

 
As with delete and rename operations, if a user tries to modify a page belonging to an Extension, a warning will be displayed to explain that it's very risky and it should be avoided.

10.4 will introduce configuration that helps the user have more control on this behavior (disable edit completely without even a warning, allow a user to hide this warning, etc.).

Auto Notifications on changes

 
Thanks to an improvement to the AutoWatch feature of the notifications, users now get notified on changes done to pages they previously edited.

For Admins

No changes!

For Developers

New document type in XAR extensions

 
It's now possible to indicate a type for each entry in a XAR extension. The type indicates what actions are allowed for a document once it's installed (edit, delete) and how it should be handled during upgrade (merge, skip, overwrite, etc.). See XAR package format for more details about this new property.

Priority between Notification Filters

 
Notifications Filter has now a getPriority() method, to handle advanced use-cases when a filter needs to have priority over some others.

Upgrades

The following runtime dependencies have been upgraded (they have a different release cycle than XWiki Commons, XWiki Rendering and XWiki Platform):

Translations

The following translations have been updated: 

Known issues

Backward Compatibility and Migration Notes

General Notes

When upgrading make sure you compare your xwiki.cfg, xwiki.properties and web.xml files with the newest version since some configuration parameters may have been modified or added. Note that you should add xwiki.store.migration=1 so that XWiki will attempt to automatically migrate your current database to the new schema. Make sure you backup your Database before doing anything.

Issues specific to XWiki 10.3

Filesystem storage by default for attachments and deleted documents

New attachments and deleted documents will now be stored in the filesystem by default. If you really don't want that you can go to xwiki.cfg and set hibernate value for all the properties in the section "Stores with both "hibernate" and "file" support in XWiki Standard.".

Note that existing attachments or deleted documents are not moved to filesystem but keep working since XWiki now support mixed storage for those. So if you don't what to get any attachment on filesystem side make sure to move to hibernate before executing the Distribution Wizard.

Warning when editing a page

10.3 introduce edit protection for standard pages but also allow to indicate which pages is OK to edit. In 10.3 most pages are protected (it's the default). If you get a warning for a page you for which you think it does make sense don't hesitate to report it since we are still tuning this.

API Breakages

The following APIs were modified since XWiki 10.2:

  • Young API
    • Violation type:
      java.method.returnTypeChanged
    • Code:
      ## Old:
      method boolean org.xwiki.notifications.filters.NotificationFilter::filterEvent(org.xwiki.eventstream.Event, org.xwiki.model.reference.DocumentReference, org.xwiki.notifications.NotificationFormat)

      ## New:
      method org.xwiki.notifications.filters.NotificationFilter.FilterPolicy org.xwiki.notifications.filters.NotificationFilter::filterEvent(org.xwiki.eventstream.Event, org.xwiki.model.reference.DocumentReference, org.xwiki.notifications.NotificationFormat)

Credits

The following people have contributed code to this release (sorted alphabetically):

<code contributors>

Tags:
   

Get Connected