Release Notes for XWiki 11.4

Last modified by Vincent Massol on 2019/09/17

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 brings improvements to the management of the conflicts encountered when editing a page. We've also provided better explained error messages for several cases, in order for the users to understand more easily the occurring issues. For developers we've added the ability to write a wiki macro in velocity and make its content inline-editable.

Some important bugs have been found since XWiki 11.4 has been released:

If one or several of these bugs impact you, then you should wait for the next version of XWiki that will be released soon!

New and Noteworthy (since XWiki 11.3)

Full list of issues fixed and Dashboard for 11.4.

For Users

Allow to force save in case of editing conflict

 
Starting with XWiki 11.2RC1 we introduced a mechanism for detecting edit conflict during the edition of a page.

We introduced in this release a new window in case of editing conflict. You now have two main choices:

  • force save the page: in that case you will override saved while you were editing the page; they are not really lost though since they might be retrieved in the previous version of the page.
  • reload the editor: in that case your changes will be lost and the editor will be reloaded with the last version saved.

We display the diff between the version you're trying to save and the last version that has been saved, so you can copy some changes made and reapply them if you like. Note that you can also simply cancel the save and go back to the editor to make changes before trying again to save. You can click on the arrow of each action to have a quick description of what it actually means.

Additional information when a delete operation fails

 
When an error happens while deleting a page, detailed information are displayed to help understand the problem.

Display nice error message in case of path too long

 
In a few cases, an error might happen when creating a page, if its full path is too long. The full path is defined by the title of the page and the title of all parent pages. We now provide an UI for this error to explain what happens: the fix is generally to reduce the size of the title of the page, or to put it under another hierarchy. 

For Admins

  • Filesystem store location: It's now possible to set the location of the filesystem store without modifying the general permanent directory using property store.file.directory of the file xwiki.properties.

For Developers

Inline editing for wiki macros

 
When developing a wiki macro, you can now insert the content of that macro by using a dedicated macro:

{{wikimacrocontent/}}

This new way of inserting the wiki macro content makes it by default editable directly in the WYSIWYG editor. If you want to test it, you can, for example, create the following wiki macro and try it:

{{velocity}}
{{box}}
{{wikimacrocontent/}}
{{/box}}

The content's size is $xcontext.macro.content.length() characters.
{{/velocity}}

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:

 BrowserTests performed and results
Chrome30.pngGoogle Chrome 74Not Tested
Firefox30.pngMozilla Firefox 66Smoke tests
Edge30.pngMicrosoft Edge 18New and Noteworthy Features + Jira Tickets Marked as Fixed in the Release Notes + Smoke 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.7New and Noteworthy Features + Jira Tickets Marked as Fixed in the Release Notes + Smoke tests
oracle.pngOracle 12cNot Tested
postgresql.pngPostgreSQL 11Smoke 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 + Smoke 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.4

  • If you're upgrading XWiki you have to delete the 'solr' folder from the configured permanent directory of your XWiki instance in order for the Solr search to work. We upgraded Apache Solr in this release and this brought changes to the Solr schema and configuration files, which are cached in the 'solr' folder. Unfortunately we don't have support for automatic Solr search index migration at this point. The Solr index will be deleted as a result but it will be recreated automatically and the entire wiki will be re-indexed after a server restart.

API Breakages

The following APIs were modified since XWiki 11.3:

  • Change the predicate to use directly the current object. The IgnoreElementRule class is still an unstable API
    • Violation type:
      java.method.parameterTypeParameterChanged
    • Code:
      ## Old:
      parameter void org.xwiki.rendering.wikimodel.xhtml.impl.IgnoreElementRule::<init>(===java.util.function.Predicate<org.xwiki.rendering.wikimodel.xhtml.impl.TagContext>===, boolean)

      ## New:
      parameter void org.xwiki.rendering.wikimodel.xhtml.impl.IgnoreElementRule::<init>(===java.util.function.Predicate<org.xwiki.rendering.wikimodel.xhtml.impl.IgnoreElementRule>===, boolean)
  • Call the switch method with the info if it is from a begin or an end element. The IgnoreElementRule class is still an Unstable API.
    • Violation type:
      java.method.numberOfParametersChanged
    • Code:
      ## Old:
      method void org.xwiki.rendering.wikimodel.xhtml.impl.IgnoreElementRule::switchRule(org.xwiki.rendering.wikimodel.xhtml.impl.TagContext)

      ## New:
      method void org.xwiki.rendering.wikimodel.xhtml.impl.IgnoreElementRule::switchRule(org.xwiki.rendering.wikimodel.xhtml.impl.TagContext, boolean)

Credits

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

Alex Cotiugă
Clément Aubin
Ecaterina Moraru (Valica)
GinPachi
Guillaume Delhumeau
Marius Dumitru Florea
Paul Libbrecht
Simon Urli
Thomas Mortagne
Vincent Massol
Vyacheslav Sukharnikov
xrichard

Tags:
   

Get Connected