Release Notes for XWiki 10.2

Last modified by Guillaume Delhumeau on 2018/08/13
Contents

This is the release notes for XWiki Commons, XWiki Rendering and XWiki Platform. They share the same release notes as they are released together and have the same version.

This release has a fresh look thanks to its new default color theme. A new Figure macro is available for content creators to add illustrations along with optional captions. Renaming and moving standard pages is now discouraged with a warning message that should prevent editors from breaking XWiki.

This release contains a bug that can affect the scalability of the service. Until the proper fix, it is highly recommended to make sure that the "autowatch" feature of the notifications is turned off. Note that starting with XWiki 10.7 (10.7RC1 to be precise), "autowatch" is turned off by default.
 
You can do that by adding in the xwiki.properties file the following lines:

# Disable autowatch until the following issue is fixed:
# https://jira.xwiki.org/browse/XWIKI-15445
xwiki.plugin.watchlist.automaticwatch=none

New and Noteworthy (since XWiki 10.1)

Full list of issues fixed and Dashboard for 10.2.

For Users

New default Color Theme

 
We wanted to refresh the default color theme (Charcoal) for the XWiki Standard 10.x cycle and the community voted for the Iceberg theme, which is our new default theme. We kept a professional / clean look and feel and opted for blue as our main color. The purpose of the default color theme is to cover as many use cases as possible, so if you want to spice up your instance try one of our community contributed color themes. 

Iceberg_XS.png

Minor changes do not generate notifications anymore

 
A new filter has been created, to hide events about minor changes. This filter can be disabled, but is enabled by default.

FilterMinorEvent.png

Rename/Move protection

 
As with the delete action, if you try to rename a page that belongs to an installed extension you will now get a warning suggesting you to uninstall the extension instead and asking you to explicitly select the standard pages you want to rename.

Note that the displayed message text is currently the same one as for delete but that will be fixed in the next version.

renameextension.png

Figure Macro

 
A new Figure Macro was created to be able to add illustrations (images, tables, code, graphs, etc) along with optional captions.

Example:

...
{{figure}}
[[image:macaque.jpg||alt="Macaque in the trees"]]

{{figureCaption}}A cheeky macaque, Lower Kintaganban River, Borneo. Original by [[Richard Clark>>http://www.flickr.com/photos/rclark/]]{{/figureCaption}}
{{/figure}}
...

image-example.png

For Admins

Default Notifications

 
In the global settings, administrators can select which applications and/or event types should be enabled by default for all users. The user can then override the default settings, but if he/she doesn't set anything, the preferences of the wiki where he/she belongs to are applied.

The inheritance is "Main Wiki preferences < Current Wiki preferences < User preferences".

NotificationsAdministration.png

Miscellaneous

  • Distribution Wizard configuration: It's now possible to control from the xwiki.properties file if the Distribution Wizard should be automated or interactive and which Flavor to install/upgrade on main or sub wikis. See DistributionWizard for more details.

For Developers

REST API now supports the use of minor revision for page changes

 
Add ?minorRevision=true to your REST calls and the page will be updated with minor revision. See the whole documentation for the REST API.

Jobs improvements

 

  • A framework has been introduced to make easier to write jobs UI with question/answer support. You can see more details in the Job Module documentation.
  • AbstractJobStatus now implement CancellableJobStatus interface which allow generic code to control jobs that can be canceled
  • it's now possible to get the time left before a job question timeout using newJobStatus#getQuestionTimeLeft method

Translation fallback

 
It's now possible to pass a list of keys to test one by one until one is found. See Scripting for more details.

Miscellaneous

  • FigureBlock & FigureCaptionBlock: New Rendering Blocks were added: FigureBlock and FigureCaptionBlock. For example those blocks are generated by the Figure Macro.

  • Export menu extension point: It's now possible to inject a new button in the export menu. Checkout the documentation for more details.

  • Inject extension features: It's possible to dynamically inject additional features to an extension when downloaded from a repository or a core extension. See Virtual extensions for more details.

Upgrades

The following runtime dependencies have been upgraded (they have a different release cycle than XWiki Commons, XWiki Rendering and XWiki Platform):

Translations

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:

BrowserTest Result
Chrome30.pngGoogle Chrome 65Not Tested
Firefox30.pngMozilla Firefox 59Not Tested
Edge30.pngMicrosoft Edge 16Jira Tickets Marked as Fixed in the Release Notes + New and Noteworthy Features
IE30.pngInternet Explorer 11Not Tested

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

DatabaseTest Result
hypersql.pngHyperSQLNot Tested
mysql.pngMySQL 5.7Not Tested
oracle.pngOracle 11.2Jira Tickets Marked as Fixed in the Release Notes + New and Noteworthy Features
postgresql.pngPostgreSQL 10Not Tested

Known issues

Backward Compatibility and Migration Notes

General Notes

When upgrading make sure you compare your xwiki.cfg, xwiki.properties and web.xml files with the newest version since some configuration parameters may have been modified or added. Note that 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.

Issues specific to XWiki 10.2

API Breakages

The following APIs were modified since XWiki 10.1:

Failed to execute the [groovy] macro. Cause: [startup failed: Script1511.groovy: 9: unable to resolve class XmlSlurper  @ line 9, column 12.      result = new XmlSlurper().parseText(xml)                ^  1 error ]. Click on this message for details.

Credits

The following people have contributed code to this release (sorted alphabetically):

  • Alex Cotiugă
  • Arun Pattni
  • Clément Aubin
  • Ecaterina Moraru (Valica)
  • Eduard Moraru
  • Enigmatrix
  • Guillaume Delhumeau
  • Marius Dumitru Florea
  • Thomas Mortagne
  • Vincent Massol

About

About

Support

Platform

User Guide

Admin Guide

Developer Guide

Projects

XWiki

Extensions

Other

Contribute

Status

Practices

Under the Hood

Get Involved

Get Connected