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.

<insert description of release here>

New and Noteworthy (since XWiki <version - 1>)

Full list of issues fixed and Dashboard for <full version here even for RC, e.g. 10.5>.

For Users

User Directory Configuration Live Preview


The User Directory configuration has a new setting to show/hide disabled users. Disabled users are hidden by default. The users live table is now updated automatically when the configuration is modified.

Live Table Actions use the Icon Theme


The default Actions column from the Live Table is now using the configured Icon Theme for the action icons. See the Live Table macro documentation for more information.

Allow to edit conflicts independently


We introduced few releases ago a mechanism to detect and handle conflict edition (i.e. when two users save changes on the same page) during page edition.
Starting with this release, the conflict edition window allows one more choice: to fix each conflict individually.
This new choice is marked as advanced since it's not something easy to handle.

When choosing the new option, the UI is updated to display the changes between the latest version saved and the current version the user is trying to save. At each place a conflict occurred, the changes display an orange bar and a blue area is reserved for the conflict resolution.
This blue area displays some text, and a select with several choices. The displayed text in the blue area is what will be used for fixing the conflict, you can see the text changing for each choice.

The conflict choices are the following:

  • current version (default): the conflict is fixed by getting the current changes
  • before your changes: the conflict is fixed by getting what was there before you starting to edit. Both latest version saved and your current changes would be lost for this conflict,
  • latest version saved: the change made on the latest version saved (the one you are conflicting with) are taken to fix the conflict
  • custom version: with this option, a text area is displayed to allow you to enter any new value to fix the conflict. Multiple lines can be entered.

If the choice text displays something in red, it is because no content is actually available for the chosen version to fix the conflict: usually it means the content in conflict will be removed with the choice made.

Create Template Provider from the Class UI


Until now, the place to create a template provider was Administration->Content->Page Templates and most of the time the need was to work together with a template created for a class. It is possible now to create the template provider from the class UI, just as the sheet and template are created. The only condition is to first create the template, in order to use it (otherwise it doesn't make sense to have a template provider for the class).

For Admins

Custom conflict resolution in Extension Manager


We improved the Extension Manager conflict resolution to allow making specific choices for fixing some conflicts.

The conflicts that can be fixed with custom choices are displayed directly in the changes display by an orange bar. A blue area is reserved for the conflict resolution.
This blue area displays some text, and a select with several choices. The displayed text in the blue area is what will be used for fixing the conflict, you can see the text changing for each choice.

The conflict choices are the following:

  • current version (default): the conflict is fixed by getting the current changes
  • before your changes: the conflict is fixed by getting what was there before you starting to edit. Both latest version saved and your current changes would be lost for this conflict,
  • latest version saved: the change made on the latest version saved (the one you are conflicting with) are taken to fix the conflict
  • custom version: with this option, a text area is displayed to allow you to enter any new value to fix the conflict. Multiple lines can be entered.

If the choice text displays something in red, it is because no content is actually available for the chosen version to fix the conflict: usually it means the content in conflict will be removed with the choice made.

Miscellaneous

  • Mail Configuration inherited from main wiki: The Mail Configuration for a subwiki is now inheriting from the configuration from the main wiki. More precisely if the local Mail.MailConfig is empty for the looked up configuration property, it's looked for in the same page in the main wiki, and if not found then it defaults to the value from xwiki.properties.

For Developers

Asynchronous rendering improvements

 

  • Asynchronous support has been added page content execution (include macro, display macro, view, #getRenderedContent, etc.)
  • Asynchronous support has been added to templates, see Template Module
  • Calls to hasAccess and checkAccess are automatically associated to cached elements and invalidated if the right change
  • Force refresh in the browser now also apply to asynchronous rendering cache located on server side
  • Support has been added for the following context elements (see Async)
    • RenderingContext target syntax
    • RenderingContext default syntax
    • RenderingContext restricted
  • UI improvements
    • The spinner is displayed only after 500ms so that it does not get in the way when the asynchronous execution is very fast
    • The AJAX request now retry every 500ms instead of blocking a HTTP input thread forever

Templates improvements

 

  • It's now possible to indicate that a template should be executed only once in the same request.
  • It's now possible to enabled asynchronous rendering and caching for a template.

 See Template Module for more details.

Miscellaneous

  • Hints for Meta Properties: The class editor is now displaying hints for meta properties when they are available. You can check for instance the Size, Editor and Content Type meta properties of a Text Area object property.

  • Computed field values are now available in REST representations: In the REST API, the REST representation of objects containing computed fields now includes the computed values of these fields while previously, they contained an empty value.

  • Possibility to disable the fullscreen behaviour on textarea: Until now a "maximize" link was automatically added to any textarea added to a page when viewing it in an editor. This can be now disabled by using the CSS class not-maximizable on the textarea. 

  • Remove XWikiUser disabled property and introduce email_checked property: We introduced in XWiki 11.6RC1 a new property on XWikiUsers objects called disabled to allow to disable or enable users. This property was however redundant with the previously existing active property, which was until then only used to check if users validated their email account, when the linked registration option was activated. 

    In this release, we remove the disabled property and rely entirely on the active property to know if a user account is enabled or not. We introduced a new email_checked property to verify if a user validated his/her email address if the option was activated. 

  • RightUpdatedEvent: A org.xwiki.security.authorization.event.RightUpdatedEvent event is now sent when a modification may have an impact on the result of a right check (modified XWikiRights object, modified group, etc.).

Moved Modules

<description deprecated, retired and moved projects>

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: 

  • Language
  • Language

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.8RC1

  • The disabled property introduced on XWikiUsers objects in XWiki 11.6RC1 has been removed. The existing property active should be use instead. You can read more about this on this specific note.
  • The value returned by PropertyClass#getFieldFullName() for a meta property has changed: the meta property name is prefixed with the property type, e.g. the value returned for the "editor" meta property of a TextArea object property is "TextArea_editor". The value returned by PropertyClass#getFieldFullName() for a class property has not changed.

API Breakages

The following APIs were modified since <project> <version - 1>:

Credits

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

<code contributors>

Tags:
Created by Vincent Massol on 2019/09/02
   

Get Connected