Release Notes for XWiki Enterprise 3.1 Milestone 1

Last modified by Thomas Mortagne on 2017/03/24

First milestone of the XWiki Enterprise 3.1 version (Roadmap).

New and Noteworthy (since XWiki Enterprise 3.0)

The 3.1 cycle was a cycle full of major foundational reinforcement, what it lacked in eye candy it made up for in building new and better core structure.

Fork us on GitHub!

XWiki Enterprise 3.1M1 is the first version to be released from our new repository on github. We decided that git was sufficiently advanced over svn, our old version control system, that it warranted the effort spent to convert. If you are a developer who uses git then you already know what this means to you, you can participate in the XWiki development process by forking (git speak for copying) the source repository rather than being forced to provide patches to the benevolent committers who will accept or reject your patches at their pleasure. If you want to make something great but there's a part of the XWiki core which is holding you up, you can go right ahead and fork it into your own repository where you can fix it and share the results. We are excited to learn what you will create!

As a consequence, the structure of the repositories, the version numbers of the applications, plugins and build tools, as well as the structure of the projects on the issue tracker have changed. We moved all the plugins and applications inside the platform core, releasing them all together. This is also reflected in the issue tracker, where all the individual projects for each extension disappeared, since applications are now jira components inside the XWiki Platform project. This means that the version number confusion will stop, since everything has the same release version.

PDF Export Options


If you export a wiki page to PDF using the Export menu you'll get a panel where you can configure some PDF export options. These options are defined in the PDF velocity templates and were previously available only as query string parameters to the PDF export URL.

Office Document Export


If you configure your wiki to work with an office server (LibreOffice or OpenOffice) as described in the Office Importer Application you'll notice a new entry in the export menu (as long as you are connected to the office server). By default only the ODT (OpenDocument Text format) export is exposed but you can tweak the export URL to export to other office formats supported by your office server. For instance /xwiki/bin/export/Sandbox/WebHome?format=doc exports Sandbox.WebHome page to Microsoft Word's proprietary DOC format.

Unfortunately there is a known limitation that we hope to fix in the next milestone: images are not embedded in the exported office document. See XWIKI-6583 if you want to follow the progress.


  • New Success Macro. For example: tick Success macro, you can access this by writing {{success}}text here{{/success}}
  • Added edit menu for inline editing mode.
  • Make the attachment mimetype labels translatable
  • Lots of bug fixes, see a full list of issues closed in the 3.1M1 frame

For developers

  • XCOMMONS-4: Implement support for JSR 330 Annotations
  • XWIKI-6103: Introduce APIs using References for context user
  • XWIKI-6213: Add custom properties to extensions
  • XWIKI-6563: Provide statistic information about clustered nodes
  • Various upgrades:
    • yuicompressor-2.4.2
    • Pygments-1.4
    • JRuby-1.6
    • GWT-2.2
    • GWT-Maven-Plugin-2.2
    • SmartGWT-2.4
    • commons-codec-1.5
    • Groovy-1.7.10

Code Maintenance


  • The following translations have been updated: de fr sv

Known issues

Test Report

You can check the manual test report to learn about what was tested and the results on various browsers.

Backward Compatibility and Migration Notes

Removed Plugins

These plugins are very old and were almost never used.
Unless your xwiki.cfg file contains one of:

  • com.xpn.xwiki.plugin.TablePlugin
  • com.xpn.xwiki.plugin.PatternPlugin
  • com.xpn.xwiki.plugin.test.TestPlugin

You are verifiable unaffected by this change.
These plugins are still available in the retired source code repository.

XWikiPreferences class preferences

If you have an existing wiki and you are upgrading to 3.1M1, you will not experience any changes. If you are installing a new wiki, the following preferences will not be available to the XWikiPreferences or WebPreferences objects. If you are a developer of an XWiki based application which depended on one of these settings, you will need to upgrade your application to make it compatible with new 3.1M1 XWiki installations.

  • convertmail
  • editbox_height
  • editbox_width
  • macros_groovy
  • macros_languages
  • macros_mapping
  • macros_velocity
  • macros_wiki
  • macros_wiki2
  • menu
  • notification_pages
  • pageWidth
  • renderXWikiGroovyRenderer
  • renderXWikiRadeoxRenderer
  • renderXWikiVelocityRenderer
  • webbgcolor

General Notes

If you're running in a multiwiki setup you'll also need to define the property to your xwiki.cfg file or explicitly name all databases to be migrated as in,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 so that XWiki will attempt to automatically migrate your current database to the new schema. Make sure you backup your Database before doing anything.

API Breakages

No APIs were modified since XWiki Enterprise 3.0.

Get Connected