Release Notes for XWiki 9.10

Version 10.1 by Thomas Mortagne on 2017/11/29
Warning: For security reasons, the document is displayed in restricted mode as it is not the current version. There may be differences and errors due to this.
Contents

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

This is mostly a release focusing on improving the new Notifications feature, in order to make it as polished and usable as possible before the end of the year (i.e. before the end of the Cycle and before we elect a new LTS release). It also contains several bug fixes.

The following important issues were found after the release:

  • There is several situations not well supported by the migrator of filesystem-based deleted attachments. It's fixed in 9.10.1.
  • XWiki does not start if you use xwiki.store.attachment.recyclebin.hint=file in xwiki.cfg
  • XWiki does not start in the Docker image (the the previous reason)

New and Noteworthy (since XWiki 9.9)

Full list of issues fixed and Dashboard for 9.10.

For Users

Improved Notifications email layout

 
The email layout for notifications has been totally redesigned.

NotificationsEmail.png

Improved Notifications UI

 
The notifications menu is more clear now, and a link to see what has changed is available in the details of each event, when you click on the date.

Notifications.png
CompositeNotification.png
CompositeNotification2.png
CompositeNotificationDiffLink.png

Filter users in notifications

 
You now have the ability to black list some users in the notifications you receive (by default you follow everyone).

watchUser01.png
watchUser02.png
watchUser03.png
watchUser04.png

Miscellaneous

  • WYSIWYG Editor Paste Filter: The WYSIWYG content editor has a more strict paste filter that removes non-semantic styles (e.g. font size, text color). This means that the content you paste into the editing area will inherit the styles of your wiki, leading to a more consistent look & feel. The PDF export also benefits from this change because some of the filtered styles were causing problems.

For Admins

  • Filesystem attachment improvements: A few of the long standing issues in the filesystem attachments storage have been fixed:

    • Deleted attachments are now available on the "Deleted Attachments" tab of the Page Index
    • The attachment porter script is not needed anymore (XWiki supports mixed attachment storage which means database attachment will stay in the database and keep working after changing the default store)
    • Various other bugfixes

For Developers

No changes!

Upgrades

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

Translations

The following translations have been updated: 

Tested Browsers & Databases

Failed to execute the [velocity] macro. Cause: [The execution of the [velocity] script macro is not allowed in [xwiki:TestReports.ManualTestReportSummaryXWiki910.WebHome]. Check the rights of its last author or the parameters if it's rendered from another script.]. Click on this message for details.

Here is the list of browsers we support and how they have been tested for this release:

BrowserTest Result
Chrome30.pngGoogle Chrome 62Not Tested
Firefox30.pngMozilla Firefox 57Not Tested
Edge30.pngMicrosoft Edge 16Jira Tickets Marked as Fixed in the Release Notes + New and Noteworthy Features
IE30.pngInternet Explorer 11Not Tested

Here is the list of databases we support and how they have been tested for this release:

DatabaseTest Result
hypersql.pngHyperSQLNot Tested
mysql.pngMySQL 5.7Jira Tickets Marked as Fixed in the Release Notes + New and Noteworthy Features
oracle.pngOracle 11.2Not Tested
postgresql.pngPostgreSQL 10Not Tested

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 9.10

  • XWiki#getURLContent() and XWiki#getURLContentAsBytes() now require Programming Rights. If you had wiki pages using those API, make sure that they are saved with a user having Programming Rights.
  • The way to configure deleted attachment storage has changed: in xwiki.cfg file, xwiki.store.attachment.recyclebin.hint=file is now deprecated and should be commented while using xwiki.store.attachment.recyclebin.content.hint=file instead. 

API Breakages

The following APIs were modified since XWiki 9.9:

  • Young API
    • Violation type:
      java.method.numberOfParametersChanged
    • Code:
      ## Old:
      method org.xwiki.notifications.filters.expression.ExpressionNode org.xwiki.notifications.filters.NotificationFilter::filterExpression(org.xwiki.model.reference.DocumentReference, org.xwiki.notifications.filters.NotificationFilterType)

      ## New:
      method org.xwiki.notifications.filters.expression.ExpressionNode org.xwiki.notifications.filters.NotificationFilter::filterExpression(org.xwiki.model.reference.DocumentReference, org.xwiki.notifications.filters.NotificationFilterType, org.xwiki.notifications.NotificationFormat)
  • Young API
    • Violation type:
      java.method.numberOfParametersChanged
    • Code:
      ## Old:
      method void org.xwiki.notifications.filters.watch.WatchedUserReference::<init>(java.lang.String)

      ## New:
      method void org.xwiki.notifications.filters.watch.WatchedUserReference::<init>(java.lang.String, org.xwiki.notifications.filters.internal.user.EventUserFilterPreferencesGetter)
  • Young API
    • Violation type:
      java.method.addedToInterface
    • Code:
      ## Old:
      null

      ## New:
      method org.xwiki.eventstream.RecordableEventDescriptor org.xwiki.eventstream.RecordableEventDescriptorManager::getDescriptorForEventType(java.lang.String, boolean) throws org.xwiki.eventstream.EventStreamException
  • Young API
    • Violation type:
      java.method.numberOfParametersChanged
    • Code:
      ## Old:
      method java.lang.String org.xwiki.notifications.notifiers.email.NotificationEmailRenderer::generateEmailSubject(org.xwiki.notifications.CompositeEvent) throws org.xwiki.notifications.NotificationException

      ## New:
      method java.lang.String org.xwiki.notifications.notifiers.email.NotificationEmailRenderer::generateEmailSubject(org.xwiki.notifications.CompositeEvent, java.lang.String) throws org.xwiki.notifications.NotificationException
  • Young API
    • Violation type:
      java.method.numberOfParametersChanged
    • Code:
      ## Old:
      method java.lang.String org.xwiki.notifications.notifiers.email.NotificationEmailRenderer::renderHTML(org.xwiki.notifications.CompositeEvent) throws org.xwiki.notifications.NotificationException

      ## New:
      method java.lang.String org.xwiki.notifications.notifiers.email.NotificationEmailRenderer::renderHTML(org.xwiki.notifications.CompositeEvent, java.lang.String) throws org.xwiki.notifications.NotificationException
  • Young API
    • Violation type:
      java.method.numberOfParametersChanged
    • Code:
      ## Old:
      method java.lang.String org.xwiki.notifications.notifiers.email.NotificationEmailRenderer::renderPlainText(org.xwiki.notifications.CompositeEvent) throws org.xwiki.notifications.NotificationException

      ## New:
      method java.lang.String org.xwiki.notifications.notifiers.email.NotificationEmailRenderer::renderPlainText(org.xwiki.notifications.CompositeEvent, java.lang.String) throws org.xwiki.notifications.NotificationException

Credits

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

Alex Cotiugă
Clément Aubin
Ecaterina Moraru (Valica)
Eduard Moraru
Guillaume Delhumeau
Marius Dumitru Florea
Thomas Mortagne
Vincent Massol

Tags:
   

About

About

Support

Platform

User Guide

Admin Guide

Developer Guide

Projects

XWiki

Extensions

Other

Contribute

Status

Practices

Under the Hood

Get Involved

Get Connected