Release Notes for XWiki 8.1 Milestone 2

Version 29.1 by Vincent Massol on 2016/04/27
Warning: For security reasons, the document is displayed in restricted mode as it is not the current version. There may be differences and errors due to this.

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.

This milestone release brings a new parameter to the Document Macro, the synchronization of the avatars coming from LDAP and the support of feeds delivered over HTTPS in the RSS Macro.

New and Noteworthy (since XWiki 8.1 Milestone 1)

Full list of issues fixed and Dashboard for 8.1.

Documents Macro Improvement

The Documents Macro now supports a location parameter to display all documents having their full reference matching the location value. 

For example:

{{documents location="Sand"/}}



RSS Macro Improvements

The RSS Macro now supports feeds delivered over HTTPS. Additionally, it now uses its own user-agent string, XWiki/VERSION, where VERSION is the version of XWiki in use.

Synchronization of user avatar from LDAP

Binary photos stored in LDAP can be synchronized now to XWiki user avatar. New options are added to control this feature:


Please note that user avatar will not be updated from LDAP if user set custom avatar with filename other than specified in XWiki preferences.


  • The Document Tree Macro has a new parameter to limit the number of child nodes displayed when a parent node is expanded for the first time.
  • The Gadget's title has now a default value which is internationalized.

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

For Developers

Standard java.lang.Package properties

The following properties are now automatically added to all Maven jar modules MANIFEST files:

Specification-Title: ${}
Specification-Version: ${project.version}
Specification-Vendor: ${}
Implementation-Title: ${}
Implementation-Version: ${project.version}
Implementation-Vendor-Id: ${project.groupId}
Implementation-Vendor: ${}
Implementation-URL: ${project.url}

And can be accessed using java.lang.Package from any class. For example:

String myVersion = this.getClass().getPackage().getImplementationVersion();


The following dependencies have been upgraded:


  • The default LiveTable results page (XWiki.LiveTableResults, the page that generates the JSON displayed by the LiveTable) now supports a location extra parameter.
  • Modified WebJars URL format and added some new Script Service methods:
    public String url(String webjarId, String namespace, String path, Map<String, ?> params)
    public String url(String webjarId, String namespace, String path)


The following translations have been updated: 

Tested Browsers & Databases

The QA Tests are executed after the release has been done. Thus, they are being prepared now and will be published soon.

Performances tests compared to <last super stable version>

<a summary of the comparison with latest super stable version>

More details on <link to the test report>.

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 XWiki 8.1 Milestone 2

  • The WebJars URL format has been modified to support relative WebJars URL in subwikis. The new format is /webjars/<namespace>/<path/to/resource>?.... Reminder: you should not use this format directly and instead you should use the Script Service to generate a valid WebJars URL; this isolate you from any URL change. Example from Velocity: $services.webjars.url(...).

API Breakages

The following APIs were modified since XWiki 8.0:

Failed to execute the [groovy] macro. Cause: [Text must not be null or empty]. Click on this message for details.

Get Connected