XWiki Enterprise 2.5 Milestone 2

Last modified by Thomas Mortagne on 2023/10/13

Second milestone of the XWiki Enterprise 2.5 version (Roadmap).

The highlights of this release are: support for viewing attached office documents in the wiki, an experimental Extension Manager, experimental CSRF protection, a new User Directory, further improvements to the edit UI, more consistent use of user avatars, support for activating a special accessibility stylesheet, and an experimental xwiki/2.1 wiki syntax.

New and Noteworthy (since XWiki Enterprise 2.4)

Support for viewing attached office documents in the wiki

XWiki now supports viewing attached office documents without saving them on the client side.


We also included a new Macro for the WYSIWYG Editor. It allows to embed a office file into a page.


Experimental Extension Manager

The new Extension Manager will allow you to install new extensions to your XWiki XE. Please note that this is an experimental feature. Use it at your own risk.


New User Directory

Added User Directory section on the Quick Links tab on the left of the page. This will show you the users that the XWiki instance has, along with their avatar image. This page also allows to filter users by username.

Further improvements to the edit UI

After the improvements to the object and class editors introduced in 1.8 and 2.4, the wiki and WYSIWYG editors also see some enhancements in this release, bringing in some of the proposed changes from an older proposal, with some additional improvements. Specifically:

  • A new label for the content area in the wiki editor:


  • A more descriptive label for the version summary field
  • Better positioning of the "minor edit" option
  • Better positioning and display of the "autosave" option


More consistent use of user avatars

As proposed on the design page, avatars come in three default sizes:

  • small avatars, 30px wide, used in secondary actions and where there's very little space available
  • medium avatars, 50px wide, the preferred and most frequent display option for avatars
  • large avatars,120px wide, to be used where a large version of the avatar must be displayed (for example in the user profile)

Accordingly, the wiki dashboard has been changed to use the medium avatars, and as a new feature user avatars are displayed in the comments area.


Four new velocity macros have been added for making it easier to display avatars:

  • #smallUserAvatar('XWiki.username')
  • #mediumUserAvatar('XWiki.username')
  • #largeUserAvatar('XWiki.username')
  • #resizedUserAvatar('XWiki.username', 100) which allows resizing an avatar to a custom size

More image manipulation settings

For a long time it was possible to scale attached images on the server, thus reducing the download time and ensuring consistent scaling of images across browsers. This is achieved by appending width and/or height query string parameters to the URL of the image. This feature has been further enhanced:

  • It is now possible to force the same aspect ratio of the original picture even when both width/height parameters were used (the keepAspectRatio parameter). In case the requested width and height don't match the original aspect ratio, the image is resized to fit inside the rectangle defined by the two parameters, i.e. the resized image will not exceed the requested dimensions.
  • The size of the generated JPGs can be further tweaked by specifying an encoding quality (the configurable default is at 30%, but will be changed to 50% before the final release). This does not affect lossless image formats such as PNG.
  • The WYSIWYG editor also supports the width and height parameters, setting them as needed when manually resizing the image in the editor.

Note that this does not affect images from the filesystem, which are served directly by the servlet conainer and do not pass through XWiki's image handling code. Also note that in case the image processing triggers any errors, the original image will be sent unchanged, so the requested image dimensions are not guaranteed.


{{velocity}}{{html wiki=false}}
<img src="$doc.getAttachmentURL('mw.jpg', 'download', 'width=150&quality=1')"/>
<img src="$doc.getAttachmentURL('mw.jpg', 'download', 'width=150')"/>
<img src="$doc.getAttachmentURL('mw.jpg', 'download', 'width=150&quality=0')"/>
<img src="$doc.getAttachmentURL('mw.jpg', 'download', 'width=150&height=100&quality=0.7')"/>
<img src="$doc.getAttachmentURL('mw.jpg', 'download', 'width=150&height=100&quality=0.7&keepAspectRatio=true')"/>



Better handling of attachment versions when rolling back documents

Rolling back a document will also roll back the correct attachment version, including restoring a deleted attachment from the trash (if not manually deleted from there). Even if an attachment was deleted and re-uploaded several times, the platform will try to find the right version for the attachment, if it still exists in the attachment trash. As an improvement, if the attachment did not change, then a new version is not created.

Preliminary optional accessibility stylesheet

Moving further on the quest for better accessibility in the XWiki platform, we introduced a preliminary stylesheet which makes the skin slightly more accessible to people with visual disabilities: bigger fonts by default, and underlined links to make them more easily distinguished by colorblind people. This stylesheet can either be activated globally in a wiki, or individually from each user's preferences.

Enabling the special stylesheet:


Bigger fonts and underlined links:


Experimental xwiki/2.1 wiki syntax

The xwiki wiki syntax sees further improvements as xwiki/2.1, still in an experimental stage. A new feature is an enhanced syntax for links, which is more generic and allows easier extensions with new link types, demonstrated in this release with support for path and interwiki links.

Basic syntax:


Special queryString and anchor parameters which will be used as the query string, respectively anchor when forming URLs.

[[label>>doc:My.Page||queryString="a=b&c=d" anchor="HSection1"]]

Document references are still the implicit default, with the explicit doc: reference type. The other standard reference types are url, path, mailto, attach, image, interwiki.

Path links allow to link to a relative path on the server, which makes it easier to combine wiki syntax and velocity code, using $doc.getURL, in order to link to non-view actions on documents.

{{velocity}}[[reset the history>>path:$doc.getURL('reset')||queryString="confirm=1"]]{{/velocity}}

Basic syntax:

[[Interwiki links>>interwiki:wikipedia:Interwiki_links]]

By default no sister wikis are defined. You can define some in xwiki.properties by adding rendering.interWikiDefinitions values:

rendering.interWikiDefinitions = wikipedia = http://en.wikipedia.org/wiki/
rendering.interWikiDefinitions = udic = http://www.urbandictionary.com/define.php?term=

Various Security improvements

Continuing a push for better security started this summer, 2.5M2 fixes some of the few remaining cross-site scripting and SQL injections holes, and tightens the scope of programming rights. Of particular concern:

  • With a default skin, programming rights are no longer available after the main content of the page; this means that the panels and the bottom tabs can't use restricted APIs anymore.
  • To explicitly drop programming rights, a new API method was introduced: $xcontext.dropPermissions()
  • An experimental Cross-Site Request Forgery prevention mechanism is included, though not enabled by default. To enable it and test/upgrade your custom applications for compatibility, edit xwiki.properties and flip on the core.csrf.enabled setting.

Backward Compatibility and Migration Notes

General Notes

If you're running in a multiwiki setup you'll also need to define the property xwiki.store.migration.databases=all to your xwiki.cfg file or explicitly name all databases to be migrated as in xwiki.store.migration.databases=db1,db2,....

You may also want to import the default wiki XAR in order to benefit from the improvements listed above.

Always make sure you compare your xwiki.cfg file with the newest version since some configuration parameters were added. Note you should add xwiki.store.migration=1 so that XWiki will attempt to automatically migrate your current database to the new schema. Make sure you backup your Database before doing anything.

Experimental support for CSRF protection is included in this release, although not enabled by default. This mechanism changes the way data is supposed to be saved, a change which will not completely break custom applications in most cases, but which might insert an extra validation step needed for actually saving the data.

It is strongly recommended to set up a testing/development environment, enable this feature and fully test all the code. In most cases things should work with no additional changes. If the default edit mode is not used, or if the default velocity templates are not used, it should be enough to add the following line:

<input type="hidden" name="form_token" value="$!{services.csrf.getToken()}" />

API Breakages

The following APIs were modified since XWiki Enterprise 2.4:

[ERROR] org.xwiki.rendering.macro.script.AbstractJSR223ScriptMacro: Method 'protected boolean canExecuteScript()' has been removed
[ERROR] org.xwiki.rendering.macro.script.AbstractJSR223ScriptMacro: Method 'public java.util.List execute(org.xwiki.rendering.macro.script.JSR223ScriptMacroParameters, java.lang.String, org.xwiki.rendering.transformation.MacroTransformationContext)' has been removed
[ERROR] org.xwiki.rendering.macro.script.AbstractScriptMacro: Method 'protected boolean canHaveJarsParameters()' has been removed
[ERROR] org.xwiki.rendering.macro.script.AbstractScriptMacro: Method 'protected java.lang.ClassLoader getClassLoader(java.lang.String, java.lang.ClassLoader)' has been removed
[ERROR] org.xwiki.rendering.block.PlainTextBlockFilter: Parameter 2 of 'public PlainTextBlockFilter(org.xwiki.rendering.parser.Parser, org.xwiki.rendering.renderer.LinkLabelGenerator)' has changed its type to org.xwiki.rendering.renderer.link.LinkLabelGenerator
[ERROR] org.xwiki.rendering.configuration.RenderingConfiguration: Method 'public java.util.Properties getInterWikiDefinitions()' has been added to an interface
[ERROR] org.xwiki.rendering.listener.Link: Method 'public java.lang.String getAnchor()' has been removed
[ERROR] org.xwiki.rendering.listener.Link: Method 'public java.lang.String getInterWikiAlias()' has been removed
[ERROR] org.xwiki.rendering.listener.Link: Method 'public java.lang.String getQueryString()' has been removed
[ERROR] org.xwiki.rendering.listener.Link: Method 'public boolean isExternalLink()' has been removed
[ERROR] org.xwiki.rendering.listener.Link: Method 'public void setAnchor(java.lang.String)' has been removed
[ERROR] org.xwiki.rendering.listener.Link: Method 'public void setInterWikiAlias(java.lang.String)' has been removed
[ERROR] org.xwiki.rendering.listener.Link: Method 'public void setQueryString(java.lang.String)' has been removed
[ERROR] org.xwiki.rendering.listener.LinkType: Removed java.io.Serializable from the set of implemented interfaces
[ERROR] org.xwiki.rendering.listener.LinkType: Removed java.lang.Comparable from the set of implemented interfaces
[ERROR] org.xwiki.rendering.listener.LinkType: Removed java.lang.Enum from the list of superclasses
[ERROR] org.xwiki.rendering.listener.LinkType: Removed field URI
[ERROR] org.xwiki.rendering.listener.LinkType: Method 'public org.xwiki.rendering.listener.LinkType valueOf(java.lang.String)' has been removed
[ERROR] org.xwiki.rendering.listener.LinkType: Method 'public org.xwiki.rendering.listener.LinkType[] values()' has been removed
[ERROR] org.xwiki.rendering.parser.LinkParser: Field SEPARATOR_INTERWIKI has been removed, but it was previously a constant
[ERROR] org.xwiki.rendering.renderer.LinkLabelGenerator: Class org.xwiki.rendering.renderer.LinkLabelGenerator removed
[ERROR] org.xwiki.rendering.renderer.LinkReferenceSerializer: Class org.xwiki.rendering.renderer.LinkReferenceSerializer removed
[ERROR] org.xwiki.rendering.renderer.URILabelGenerator: Class org.xwiki.rendering.renderer.URILabelGenerator removed
[ERROR] org.xwiki.rendering.renderer.XWikiSyntaxListenerChain: Class org.xwiki.rendering.renderer.XWikiSyntaxListenerChain removed
[ERROR] org.xwiki.rendering.renderer.xhtml.XHTMLImageRenderer: Class org.xwiki.rendering.renderer.xhtml.XHTMLImageRenderer removed
[ERROR] org.xwiki.rendering.renderer.xhtml.XHTMLLinkRenderer: Class org.xwiki.rendering.renderer.xhtml.XHTMLLinkRenderer removed
[ERROR] org.xwiki.rendering.wiki.WikiModel: Method 'public java.lang.String getImageURL(java.lang.String, java.lang.String, java.util.Map)' has been added to an interface
[ERROR] org.xwiki.bridge.DocumentAccessBridge: Method 'public java.lang.String getAttachmentVersion(org.xwiki.model.reference.AttachmentReference)' has been added to an interface
[ERROR] org.xwiki.bridge.DocumentAccessBridge: Method 'public java.lang.String getDocumentURL(org.xwiki.model.reference.DocumentReference, java.lang.String, java.lang.String, java.lang.String, boolean)' has been added to an interface
[ERROR] org.xwiki.annotation.renderer.AbstractAnnotationRenderer: Return type of method 'public org.xwiki.rendering.renderer.LinkLabelGenerator getLinkLabelGenerator()' has been changed to org.xwiki.rendering.renderer.link.LinkLabelGenerator
[ERROR] org.xwiki.annotation.renderer.LinkLabelGeneratorChainingListener: Changed type of field linkLabelGenerator from org.xwiki.rendering.renderer.LinkLabelGenerator to org.xwiki.rendering.renderer.link.LinkLabelGenerator
[ERROR] org.xwiki.annotation.renderer.LinkLabelGeneratorChainingListener: Parameter 1 of 'public LinkLabelGeneratorChainingListener(org.xwiki.rendering.renderer.LinkLabelGenerator, org.xwiki.rendering.parser.StreamParser, org.xwiki.rendering.listener.chaining.ListenerChain)' has changed its type to org.xwiki.rendering.renderer.link.LinkLabelGenerator

Get Connected