Release Notes for XWiki 10.1-rc-1

Version 2.1 by Marius Dumitru Florea on 2018/02/01

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

<insert description of release here>

New and Noteworthy (since XWiki 10.0)

Full list of issues fixed and Dashboard for <version>.

For Users

Notifications fully replace the Watchlist

It's finally done! In this version, we have decided to disable the Watchlist in XWiki, by default. Instead, the Notifications Application is now the central feature in XWiki for notifications. 

Don't forget to warn your users about the need to enable email in their notification settings!

Note: you can rollback this change by disabling the Notifications Application and enabling the Watchlist again.

All filters preferences are displayed in the same livetable

The "advanced filtering options" window has disappeared, and all filters are displayed in the same place.

Hiding notifications that are read

Since the introduction of the Notifications Application in XWiki, it was possible to mark some notifications as "read". They were displayed differently, and not counted in the red circle above the bell, but they were still there.

Now, it is possible to decide not to show them anymore thanks to an option in the user's notification settings.


  • Improved Multi-Term Search Relevancy: This is commonly referred to as sloppy phrase matching and allows for more "Googleish" query strings. The implementation allows for partial multi-term matching so that searching for long phrases won’t “hide” documents with a subset of shorter multi-term matches.

    For those interested in the more technical aspects:

    • The query string is split into groups of multi-term contiguous sequences (word shingles), ignoring stopwords where appropriate.
    • The higher the number of terms in close proximity the more relevant the document will appear.
    • While the order of the terms in the query string is important for forming word shingles, the order in which the terms appear in the document doesn’t affect the score.
    • Stemming is still used so that all forms of each word are considered matches even in multi-term relevancy calculations.
    • Exact matches are still returned when terms are encased in quotes.
  • Notification Filter Preferences that concern hidden pages are not listed anymore: Filters that concern hidden pages are not shown in the table, unless you enabled the option to see hidden pages. More informations: Hidden (technical) pages.

For Admins

  • Filesystem store improvements has changed format: Support for case insensitive filesystems has been added in the filesystem store. Among other things it means that most of the existing paths need to be modified (upper case characters are now escaped). There is an automatic migration for it but be careful if you are using some custom tool manipulating directly the store files (since the format has changed).

For Developers

  • Notifications settings are now available as macros: New macros have been created, so you can include your notification settings in many pages (such as the dashboard). These macros are:

    • {{notificationsEmailPreferences /}}
    • {{notificationsApplicationsPreferences /}}
    • {{notificationsFiltersPreferences /}}

Moved Modules

<description deprecated, retired and moved projects>


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

  • <list libraries that have been upgraded>


The following translations have been updated: 

Known issues

Backward Compatibility and Migration Notes

General Notes

When upgrading make sure you compare your xwiki.cfg, and web.xml files with the newest version since some configuration parameters may have been modified or added. Note that you should add 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.1RC1

<issues specific to the project>

API Breakages

The following APIs were modified since XWiki 10.0:


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

<code contributors>


Get Connected