Release Notes for XWiki 6.3-milestone-1

Version 31.1 by Vincent Massol on 2014/09/30

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 6.2)

Full list of issues fixed and Dashboard for <version>.

Extension Manager and Repository improvements

  • <scm> element from Maven pom.xml is now supported and has been added to the standard in the API
  • <issueManagement> element from Maven pom.xml is now supported and has been added to the standard in the API


  • The "Add" button has now a default action to create a new page. You can still create other kind of contents (Wiki, Space) by using the arrow, just like we do with the different "edit" actions.


  • The Flamingo Theme Application now uses a new Color Picker.



  • In the administration, clicking the "Customize" button for customizing a Skin or a Color Theme now opens the page it leads to in edit mode.
  • Improved L&F when a template fails to render:


  • We have created dedicated groups for Colibri and Flamingo Themes inside the Administration. Every themes can be used with both skins but they looks better when they are used with the corresponding theme.


  • The start/stop shell scripts provided with the Standalone Distribution have been improved to display usage information when an invalid parameter is passed or when the -h or --help parameters are passed. Also note that the start script doesn't stop anymore a running XWiki instance if the -k or --kill parameter is passed (this parameter has been removed).
  • It's possible to get DEBUG information only for shutdown operations by editing logback.xml and setting:
    <logger name="org.xwiki.shutdown" level="debug"/>
  • It's now possible to configure the maximum number of search results to be returned from a search operation using xwiki.authentication.ldap.maxresults property in xwiki.cfg file. See LDAP documentation.
  • The "Empty is today" option on Date fields of classes created with Application Within Minutes is now working as expected. See XWIKI-10296

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

For Developers

Velocity macros to display users and groups

We extracted the code that displays in view mode a property of type 'List of Users' and 'List of Groups' from the corresponding custom displayers (found in displayer_users.vm and displayer_groups.vm) into two Velocity macros that can be used to display arbitrary users and groups, even when you don't have an object. Here's how you can use them:

{{html wiki="true"}}
= Users =
== Just one ==

== List of users ==
#displayUser(['Admin', 'XWiki.mflorea'])

== A reference of a user ==

== A list of references of users ==
#displayUser([$xcontext.userReference, $otherUserReference])

= Groups =
== Just one ==

== List of groups ==

== A reference of a group ==
#set($adminGroupRef = $services.model.resolveDocument('XWiki.XWikiAdminGroup'))
#set($allGroupRef = $services.model.resolveDocument('XWiki.XWikiAllGroup'))

== A list of references of groups ==
#displayGroup([$adminGroupRef, $allGroupRef])


New Velocity Tools

  • New URL Tool $urltool: A new tool has been added with one method to parse query string from the URL $urltool.parseQuery(String). The value returned by this is method is a Map<String, List<String>> which maps parameter names to (possibly multiple) values, and can be passed e.g. directly into $escapetool.url(Map<String, ?>) to convert it back to a string. This is useful e.g. in cases where one want to pass a complete query string around between requests, as it happend for the PDF export; the $urltool allows for a sane deserialization of the value passed around.
  • New Exception Tool $exceptiontool: A new tool to manipulate Java Exceptions (get root cause, convert into String, etc).

Ability to catch Exceptions from Velocity

A new Velocity Directive has been added to catch Exceptions from Velocity. In addition a new #displayUnexpectedException() velocity macro has also been added to nicely display an exception to the user.

For example:

 #set($outputSyntax = $xwiki.getAvailableRendererSyntax($request.outputSyntax, $request.outputSyntaxVersion))
 #if ($outputSyntax)
   ## If the passed syntax is not an HTML-compatible syntax we need to HTML-escape it so that it can be
   ## displayed fine in HTML (since at the point this vm file is called we're already inside an HTML page with
   ## panels on the side, header, etc).
   #set($syntaxType = $outputSyntax.type.toIdString())
   #if (($syntaxType == "xhtml") || ($syntaxType == "html"))
     #set ($renderedContent = $tdoc.getRenderedContent($outputSyntax))
     ## Make sure to print correctly the result when it's not HTML
     #set ($renderedContent = "<pre>$escapetool.html($tdoc.getRenderedContent($outputSyntax))</pre>")
   #set ($renderedContent = $tdoc.getRenderedContent())
<div id="xwikicontent">
 #if ("$!exception" != '')

This generates the following in case of error rendering the page:


New #displayException macro

Displays an error message with a title that can be clicked and expands to display an exception.

Example from a wiki page:

#set ($message = $services.mailsender.createMessage())

#displayException("hello world", $services.mailsender.lastError)

Component Disposal

The order used by the ComponentManager to dispose its components is computed based on declared dependencies. However there might be cases when you wish a Component's dispose() method to be called before or after all other components. In this case you can use the DisposePriority annotation. The default priority is 1000. A higher value will mean disposing before all other components not having this annotation. For example:

public class DefaultHibernateSessionFactory implements HibernateSessionFactory, Disposable
   public void dispose() throws ComponentLifecycleException
      ... called after other components in order to shut down the database late...

See the Component Reference documentation for other details.

Deprecated and Retired projects

<description of deprecated and retired projects>


The following dependencies have been upgraded:


  • The wiki provisioning job has now the current user set in the context.
  • 10 new icons have been mapped into Font Awesome Icon Theme.


The following translations have been updated: 

Tested Browsers & Databases

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

<issues specific to the project>

API Breakages

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

<clirr output here>

Get Connected