Release Notes for XWiki 5.1 Milestone 2

Version 14.1 by Vincent Massol on 2013/06/13

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 second milestone for the 5.1 release. It brings automatic Solr indexing and a few bug fixes.

New and Noteworthy (since XWiki 5.1 Milestone 1)

Full list of issues fixed and Dashboard for 5.1.

Solr indexing improvements

Automatic indexing

The Solr search module now automatically indexes all modifications made to the wiki. 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.

What is still missing is some synchronization at startup to make sure that the SOLR index automatically has the whole wiki in its index. This should be taken care of in XWiki 5.1 RC1.

Locales inheritance

Entities are now index 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 with locale "fr_FR", "fr" and the entities without any locale (generally technical/script documents).

There is still one thing missing: when adding a new available locale in the preferences the already registered enities are not updated. This should be taken care of in XWiki 5.1 RC1.


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

For Developers


The following dependencies have been upgraded:

  • jQuery 1.10.1
  • Require.js 2.1.6


  • A new Velocity macro is available to display the title of a sheet. Most of the times when you have a sheet you want to display some text when the user visits the sheet page and something different when the user visits a page where the sheet is applied. Up until now the solution was to write an if in the sheet title to check if the current document is the sheet. E.g.:

    #if ($doc.fullName == 'AppWithinMinutes.LiveTableViewSheet')LiveTable View Sheet#{else}#evaluate($doc.title)#end
    This can now be written as:
    #sheetTitle('LiveTable View Sheet' $doc.fullName.equals('AppWithinMinutes.LiveTableViewSheet'))
    or, if the sheet has an object of type XWiki.SheetDescriptorClass:
    #sheetTitle('LiveTable View Sheet')

  • A new 'jQueryNoConflict' module is available. All it does is calling jQuery.noConflict(false) to prevent conflicts with Prototype.js (with respect to $ global variable):
    require(['jQueryNoConflict'], function($) {
     // Your code here.
  • Add render method in Localization module taking syntax without parameters:
    $services.localization.render('some.key', 'xhtml/1.0')


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 and most of these tests
Firefox30.pngMozilla Firefox 21PartiallyOffice Server Tests from this page
IE30.pngInternet Explorer 8Not Tested
IE30.pngInternet Explorer 9PartiallyThese tests and some of these tests

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 and most of these tests
mysql.pngMySQL 5.6.10Not Tested
oracle.pngOracle 11.2PartiallyThese tests and some of these tests
postgresql.pngPostgreSQL 9.1.3PartiallyOffice Server Tests from this page

For the full list of tests see this page.

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.

GIF Silk icon set no longer available

The Silk icon set has always been officially provided in PNG format. However, since they use Alpha transparency, a feature not supported by Internet Explorer 6, we provided our own GIF version of the icon set, with simple transparency. Once we dropped support for IE6, we also included the official PNG version, with the goal of transitioning from the jagged GIF version to the nicer looking PNGs. The time has come to deprecate the GIF icons, so they are no longer available in the non-legacy builds of XWiki Enterprise. However, the official releases will still have the icons included for a while, so it's unlikely that this deprecation will break custom applications.

However, an update of the documents that still use the GIF icons is recommended. Since the base icon name is the same, all that's required is to change the extension from .gif to .jpg to use the right icons.

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: 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