Release Notes for XWiki 11.1

Last modified by Guillaume Delhumeau on 2019/03/11
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 adds support for renaming apps created with App Within Minutes and brings improvements to the WYSIWYG editor: inline editing of the Box Macro title and macro category count displayed by the Macro Selector. Advanced users can now copy the page reference from the Information tab at the bottom of each page.

New and Noteworthy (since XWiki 11.0.3)

Full list of issues fixed and Dashboard for 11.1.

For Users

Rename AWM Application

 
Starting with this version you can rename/move an application created with App Within Minutes by renaming/moving its home page. Be aware though that the application code is going to be regenerated if you rename the application, which means that code customizations will be overwritten as a consequence.

Checkout the App Within Minutes documentation for more information.

Inline editing of title for Box Macro

 
The title of the Box macro is now editable directly in the WYSIWYG editor, as it already was for its content.

inline-edit-box-title.gif

Simplified Page Rename

 
The Rename Page dialog has been simplified:

  • the "Preserve Children" option is visible only if the page to rename has child pages.
  • the "Update Links" option is now visible only to advanced users. For simple users the back-links are always updated.

renamePage-simpleUser.png

Macro Category Count

 
When inserting a macro through the WYSIWYG Editor the macro selector now shows the number of macros available in each category.

ckeditor-macro-select

Display page reference in the information viewer

 
You can now retrieve quickly the page reference of any page by going to the Information tab. The reference is by default displayed to the local wiki, but you can switch it to get a global reference for all wiki in a farm. The right button allow you to quickly copy it to the clipboard.

page_reference.gif

Miscellaneous

  • Job Waiting Information: You might now see a new information box instead of the progress bar if another job is currently performed against the pages you selected. In that case, you have to wait that the other job is finished or cancelled before yours start. The UI would refresh automatically.

For Admins

No changes!

For Developers

Page Count for Data Types

 
The Data Types live table now shows the number of pages that use each data type.

dataTypes-pageCount.png

Default Class Sheet Shows Object Count

 
The default class sheet now shows the number of objects (of the current type) found on each page.

defaultClassSheet-objectCount.png

Inline editing of macro parameters

 
It is now possible to allow inline editing of macro parameters when using the WYSIWYG editor. In order to do that, we reuse the same principle as for allowing inline editing of content in macro: you have to specify the type of the macro parameter by using @PropertyDisplayType on the parameter, and then you have to specify the metadata to put where the macro parameter is used in the UI, by using the AbstractMacro#getNonGeneratedContentMetaData("parameterName") method.

Miscellaneous

  • Copy / Rename Events: The refactoring module introduces dedicated events for document copy and rename operations. Checkout the documentation for more information.

  • XClass Rename: The xobjects of an xclass are now updated automatically when the xclass is renamed if:

    • the xclass is not moved to a different wiki
    • the "Update Links" option is checked (which is the case by default)

    Renaming xclasses is still considered a dangerous operation though, because xclasses are often used in scripts, which are not updated when an xclass is renamed.

  • Ability to inject content in the HTML header: It is now possible to inject content dynamically in the "head" tag of the HTML pages via a dedicated extension point named org.xwiki.platform.head. It is useful typically for adding metadata to the pages. Checkout the extension point documentation for more information and an example.

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:

 BrowserTests performed and results
Chrome30.pngGoogle Chrome 72Not Tested
Firefox30.pngMozilla Firefox 65New and Noteworthy Features + Jira Tickets Marked as Fixed in the Release Notes + Full tests
Edge30.pngMicrosoft Edge 18Full tests
IE30.pngInternet Explorer 11Not Tested
Safari30.pngSafari 12Not Tested

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

 DatabaseTests performed and results
hypersql.pngHyperSQL 2.4.1Not Tested
mysql.pngMySQL 5.7Full tests
oracle.pngOracle 11.2Not Tested
postgresql.pngPostgreSQL 10New and Noteworthy Features + Jira Tickets Marked as Fixed in the Release Notes + Full tests

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

 Servlet ContainerTests performed and results
tomcat-icon.pngTomcatNot Tested
jetty-icon.pngJetty (XWiki Standalone packaging)New and Noteworthy Features + Jira Tickets Marked as Fixed in the Release Notes + Full tests
jetty-icon.pngJettyNot Tested

Known issues

Backward Compatibility and Migration Notes

General Notes

  • When upgrading make sure you compare and merge the following XWiki configuration files since some parameters may have been modified, removed or added:
    • xwiki.cfg
    • xwiki.properties
    • web.xml
    • hibernate.cfg.xml
  • Add xwiki.store.migration=1 in xwiki.cfg so that XWiki will attempt to automatically migrate your current database to any new schema. Make sure you backup your Database before doing anything.

Issues specific to XWiki 11.1

Introduction of the Event Stream Store

The Activity Stream and Watchlist features have been replaced by the Notifications feature back in XWiki 10.9. However, for technical reasons, we were still using the old Activity Stream store. We have now removed it in favor of a new Event Stream Store.

If you're upgrading from an older version of XWiki, you must to modify your hibernate.cfg.xml file.

You need to remove this line:
<mapping resource="activitystream.hbm.xml"/>

And replace it by:
<mapping resource="eventstream.hbm.xml"/>

You must also modify your xwiki.cfg file, and remove this line (for the xwiki.plugins property):
com.xpn.xwiki.plugin.watchlist.WatchListPlugin,\

Local resource access for modification date

We introduced in this version a new mechanism to handle resource caches in the browsers.

By default this mechanism will access the local resource file in order to check their modification date an use it in the URL. If you find some performance issue, especially if XWiki is running on an old system or hard drive, you can disable this mechanism by changing this new property in xwiki.properties:

#-# [Since 11.1RC1]
#-# Whether a the last modified date of the file to be loaded should be checked and put in the URL query parameter.
#-# Disabling this might improve a bit the performance on some old hard drives, or custom filesystem, however
#-# it might imply the need to force-reload some resources in the browser, when migrating.
#-#
#-# The default is:
# url.useResourceLastModificationDate=true

In that case, please leave us a comment on this JIRA issue, or in the forum so we know about it.

API Breakages

The following APIs were modified since XWiki 11.0.3:

Failed to execute the [groovy] macro. Cause: [startup failed: Script2031.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 and translations to this release (sorted alphabetically):

  • Adel Atallah
  • Camelia Andrei
  • Clemens Robbenhaar
  • DenisF
  • Ecaterina Moraru (Valica)
  • Eduard Moraru
  • Guillaume Delhumeau
  • Jarle Sandmo
  • Marius Dumitru Florea
  • Rostyslav Fitsyk
  • Simon Urli
  • Stéphane Lauriere
  • Thomas Mortagne
  • Vincent Massol
  • xrichard

About

About

Support

Platform

User Guide

Admin Guide

Developer Guide

Projects

XWiki

Extensions

Other

Contribute

Status

Practices

Under the Hood

Get Involved

Get Connected