Release Notes for XWiki 5.1

Version 10.1 by Marius Dumitru Florea on 2013/07/03

This is the release notes for XWiki Platform, XWiki Enterprise and XWiki Enterprise Manager. 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 5.0.3)

Full list of issues fixed and Dashboard for 5.1.

Solr is the default search engine

We have redesigned the Solr search page to include faceted search and we improved the display of the advanced search options and the search results.


The Solr search module now automatically indexes all modifications made to the wiki. A synchronization background job is started at each XWiki startup to make sure the solr index and the database are in sync (only updates what needs to be updated). The manual indexing in the administration UI should also be a lot more stable since all the actual reading of wiki documents and their indexing is now done in a safe background thread.


Entities are now indexed with the list of supported locales (among the available locales). This means that if your current locale is "fr_FR" you will find all entities that you would have seen when the current locale is "fr_FR". For example if a document does not have any "fr_FR" explicit version you will still find the version you would have seen when going to that document (generally the default version of the document or the "fr" version of the document if any since the parent locale of "fr_FR" is "fr"). We call it locale inheritance.

See the documentation for the Solr Search Application for more details.

Menu Application

We have rewritten the Navigation Menu Wiki Macro and the Navigation Menu Config Application into a single application that can help you create navigation menus to be displayed either horizontally as a top bar after the page header or vertically in a side panel. See the documentation page of the new Menu Application for details.



  • When an user wants to change his password, he now has to enter his current password for more security. Live validation of his new password validity (length) has also been added.
    ChangeOwnPassword .png
  • The attachment upload input now remains visible after uplading one or more files:


  • The "Send to" input from the Share page dialog displays a scope toggle when you are in a subwiki (or an workspace) that allows you to control whether the suggested users are local or global.


  • We changed the dashboard to display the gadget actions when hovering the gadget.


  • Moved the User Directory feature to an application on its own.
  • Moved the XWiki Syntax Help feature to an application on its own.
  • More documents marked as hidden by default: Blog.News, Blog.Other, Blog.Personal, Main.Activity, Main.MessageSenderMacro, Main.Tags, Sandbox.WebPreferences, XWiki.WebHome, XWiki.XWikiAdminGroup, XWiki.XWikiAllGroup, XWiki.SearchConfig
  • Added support for new Google Analytics "Universal" tracking method.

See the full list of JIRA issues fixed in this release.

Full Issue List

For Developers

<developer feature N>

<description of developer feature N>

Deprecated and Retired projects

<description of deprecated and retired projects>


The following dependencies have been upgraded:

  • <list libraries that have been upgraded>


<other dev stuff to add and link to JIRA for all issues fixed>


The following translations have been updated: 

Tested Browsers & Databases

Here's the list of browsers we support and how they've been tested specifically for this release:

Chrome30.pngGoogle Chrome 27PartiallyJira Tickets Marked as Fixed in the Release Notes, migrations from 5.0.3 and from 5.1RC1
Firefox30.pngMozilla Firefox 22Not Tested
IE30.pngInternet Explorer 8Not Tested
IE30.pngInternet Explorer 9Not Tested

Here's the list of databases we support and how they've been tested specifically for this release:

hypersql.pngHyperSQL 2.2.9PartiallyJira Tickets Marked as Fixed in the Release Notes, migrations from 5.0.3 and from 5.1RC1
mysql.pngMySQL 5.6.10Not Tested
oracle.pngOracle 11.2Not Tested
postgresql.pngPostgreSQL 9.1.3PartiallyMigrations from 5.0.3

Known issues

Backward Compatibility and Migration Notes

General Notes

You may also want to import the default wiki XAR in order to benefit from all the improvements listed above.

Always make sure you compare your xwiki.cfg and files with the newest version since some configuration parameters were 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 <version>

<issues specific to the project>

API Breakages

The following APIs were modified since XWiki 5.0.3:

  • Young API: New method to separate job setup from job start to put real jobs in queue.
    org.xwiki.job.Job: Method 'public void initialize(org.xwiki.job.Request)' has been added to an interface
  • Young API: New method to add a custom Job to the queue.
    org.xwiki.job.JobManager: Method 'public void addJob(org.xwiki.job.Job)' has been added to an interface
  • Needed to fix XWIKI-9251 and the IRC Bot API is still relatively new and not a mainstream API used by lots of people.
    org.xwiki.ircbot.IRCBot: Method 'public java.lang.String getWikiId()' has been added to an interface
  • Young API: The URL module has never been finished and we started working on it again.
    org.xwiki.url.InvalidURLException: Class org.xwiki.url.InvalidURLException removed

Get Connected