Release Notes for XWiki 5.4 Release Candidate 1

Version 34.1 by Thomas Mortagne on 2014/01/27

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 5.4 Milestone 1)

Full list of issues fixed and Dashboard for XWiki 5.4.

Distribution Wizard improvements

No Upgrade Mode anymore

The upgrade mode has been removed, instead both modes are kind of enabled: it's always proposed to upgrade subwikis from main wiki and the Distribution Wizard is also always enabled on sub-wikis and displayed only if there is something to do.

New report step

A new last step has been introduce to display all the changes made to the wiki and give a chance to do some rollbacks.


Activity Stream improvements

  • The name of the wiki where the event has happened is displayed now, if the event concerns an other wiki than the current one.
  • On the main wiki, Activity Stream now display events from every wikis where the current user has view right.


  • Images that are copy-pasted as HTML in the WYSIWYG editor now work fine, thanks to the added support of the Data URI scheme in XWiki Syntax 2.1. The wiki syntax is:
  • The user and group pickers now take into account the User Scope specified when you create a new wiki. If the current wiki supports only global users then the user picker will suggest global users. If the current wiki supports both local and global users then the user picker has a toggle that lets you choose whether to get local or global suggestions. The group picker behaves slightly different because you can have local groups even when only global users are allowed (to be able to setup various rights for the global users). Thus the group picker shows the scope toggle when you are in a subwiki that accepts global users, otherwise it suggests only local groups (from the current wiki, which can be the main wiki).
  • Increased the size of the security cache to improve performances from 500 entries to 10000 entries. This setting could still be overwritten in the infinispan configuration of the cache named This new setting should be sufficient for most usages while the previous default were only valid for small single wiki.
  • Improvement in the wiki descriptor pages. It is now consistent with our vertical forms standard.
    descriptor-improvement1.png descriptor-improvement2.png
  • When the user creates a new wiki, without a template, a message is displayed to explain him the Distribution Wizard will be started to initialize the new created wiki.
  • In the Activity Stream, the name of the wiki where the event has happened is displayed now, if the event concerns an other wiki than the current one.

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

For Developers

New APIs to manipulate XAR files

A new "xar" ScriptService has been introduced with APIs to manipulate XAR files. It does not yet contains a lot of methods and new will be added as needed. See XAR Module extension for more details.

Deprecated and Retired projects

<description of deprecated and retired projects>


The following dependencies have been upgraded:

  • <list libraries that have been upgraded>


  • We added a new parameter to the Live Table Velocity macro named 'selectedTags' which controls the list of tags that are selected initially in the tag cloud. You can still select different tags after the live table loads. With this new parameter you can have a permanent link to a live table that has the rows filtered initially by some tags:
    ## /xwiki/bin/view/Demo/WebHome?tag=news&tag=science
    #set ($options = {
      'className': 'Demo.DemoClass',
      'tagCloud': true,
      'selectedTags': $request.getParameterValues('tag'),
  • The module xwiki-platform-wiki-rest replaces the old module xwiki-platform-wiki-manager-rest in order to move xwiki-platform-wiki-manager in contrib, but the API is unchanged.
  • Verbosity of the job is now configurable right from the org.xwiki.job.Request object
  • Log generator now generates BeginEvent/EndEvent variants based on marker informations
  • The following java.lang.Class methods are now allowed in Velocity by default: name, isArray, isAssignableFrom, isEnum, isInstance, isInterface, isLocalClass, isMemberClass, isPrimitive, isSynthetic
  • Default job status does not provide log tree anymore. Was making the API too complex. It can be created from the log queue very easily in Java and a helper method has been added in logging ScriptService to create one: $services.logging.toLogTree($logs)
  • Various APIs have been added to help translate log. See Logging Module for more details
  • It's now possible to add new Images Types when rendering in XHTML
  • Introduced org.xwiki.observation.AbstractEventListener
  • New model API and script service API to create a tree from a list of entity references. See Model Module for more details
  • New option in the XAR plugin's format mojo to add missing license headers


The following translations have been updated: 

Tested Browsers & Databases

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

Chrome30.pngGoogle Chrome 32Jira Tickets Marked as Fixed in the Release Notes
Firefox30.pngMozilla Firefox 27Not Tested
IE30.pngInternet Explorer 8Not Tested
IE30.pngInternet Explorer 9Not Tested

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

hypersql.pngHyperSQL 2.3.1Jira Tickets Marked as Fixed in the Release Notes
mysql.pngMySQL 5.6.10Not Tested
oracle.pngOracle 11.2Not Tested
postgresql.pngPostgreSQL 9.2.4Not Tested

For the full list of tests see this page.

Known issues

Backward Compatibility and Migration Notes

General 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 5.4RC1

New Velocity uberspector

If you modified = runtime.introspector.uberspect.chainClasses = ... property in xwiki.propertes file you should make sure to replace org.apache.velocity.util.introspection.SecureUberspector with org.xwiki.velocity.introspection.SecureUberspector.

API Breakages

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

<clirr output here>
  • $, $, $ are deprecated now. Please use the corresponding lastError function instead.

Get Connected