Release Notes for XWiki 5.1 Milestone 1

Version 20.1 by Marius Dumitru Florea on 2013/05/29

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.

This is the first milestone for the 5.1 release.

New and Noteworthy (since XWiki 5.0)

Full list of issues fixed and Dashboard for 5.1.

Solr search UI overhaul



For Developers

  • All REST responses now specify the version of XWiki running on the server in the XWiki-Version HTTP header, and the current user in the XWiki-User header.
  • We added a new special CSS class name, 'useTitleAsTip', that, combined with 'withTip', will allow you to have a tip (place-holder) different than the initial value of the text input.


The following dependencies have been upgraded:

  • logback 1.0.13
  • commons-compress 1.5
  • commons-codec 1.8
  • httpclient 4.2.5
  • diffutils 1.3
  • Doxia 1.4
  • JGroups 3.3
  • HTMLCleaner 2.5


  • A new URL parameter has been added to reference non aggregated JavaScript files: ?minify=false. See the Debugging Guide.
  • Added API to easily create a DocumentReference from a LocalDocumentReference
    DocumentReference documentReference = new DocumentReference(localReference, wikiReference);
  • You can now provide a version summary (comment) when updating a page using REST. You can retrieve the version summary either by getting the page or by getting the page history, in which case you get the summary for each page revision.


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 27PartiallyManual Test Report for XWiki 5.1 Milestone 1
Firefox30.pngMozilla Firefox 21Not 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.9PartiallyManual Test Report for XWiki 5.1 Milestone 1
mysql.pngMySQL 5.6.10Not Tested
oracle.pngOracle 11.2Not Tested
postgresql.pngPostgreSQL 9.1.3Not Tested

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 5.1 Milestone 1

  • The data type of the 'email' property from the user profile has changed from String to Email, a specialized type introduced in 4.2. Unfortunately this change doesn't apply automatically when you upgrade from an older version so you have to do it your self:
    1. edit XWiki.XWikiUsers with the class editor
    2. delete the 'email' property
    3. add a new property of type Email named 'email' with 'e-Mail' as pretty name
    4. save
    The values of both String and Email data types are stored in the same database table so there souldn't be any migration issues for existing users.

API Breakages

The following APIs were modified since <project> <version - 1>:

<clirr output here>

Get Connected