Skip to Content

Release Notes for $doc.getValue('product') $doc.getValue('version')

Version 2.1 by Vincent Massol on 2022/08/24
Warning: For security reasons, the document is displayed in restricted mode as it is not the current version. There may be differences and errors due to this.

Failed to execute the [velocity] macro. Cause: [The execution of the [velocity] script macro is not allowed in [xwiki:ReleaseNotes.Data.XWiki.14\.8RC1.WebHome]. Check the rights of its last author or the parameters if it's rendered from another script.]. Click on this message for details.

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.

<insert description of release here>

New and Noteworthy (since Failed to execute the [velocity] macro. Cause: [The execution of the [velocity] script macro is not allowed in [xwiki:ReleaseNotes.Data.XWiki.14\.8RC1.WebHome]. Check the rights of its last author or the parameters if it's rendered from another script.]. Click on this message for details.
<version - 1>)

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

For Users

Replace the Livetable from the attachments tab with a LiveData

 
The attachments Livetable was updated to use the new LiveData.

attachments.png

Miscellaneous

  • Cross wiki refactoring of links by default: Cross wiki refactoring of links is now much faster (being in a different wiki does not anymore have any specific performance impact when refactoring links) and enabled by default.

For Admins

Indexing User

 
A new section to define a dedicated indexing user has been added in the "Search" category in the wiki administration.

The search index usually runs without a dedicated user. In some cases this creates minor issues when indexing the title of pages, e.g. in case of a closed wiki, where one cannot access as guest user the sheet that computes the user profile pages title as "Profile of «firstname» «lastname»". This is not possible unless the indexer is associated with a user that has access to the corresponding sheet. A new section in the "Search"  category of the wiki administration allows to set an "indexing user", which is used to access the sheets which might be used to compute page titles.

If this setting is left empty, the stored plain title of the page name is shown as title of the search result for affected pages.

Please read the description and especially about the security implications before setting an indexing user.

search-menu-indexer-user.png
search-admin-indexer-user-with-menu-2.png

Miscellaneous

  • Configurable hidden macros categories : The list of categories hidden by default, previously hard-coded to Internal and Deprecated, can now be configured using the rendering.transformation.macro.hiddenCategories property in xwiki.properties.

    #-# [Since 14.8RC1]
#-# Override the default hidden macro categories.
#-# Note: the categories are case sensitive.
#-#
#-# The default value is:
# rendering.transformation.macro.hiddenCategories = Internal,Deprecated
#-#
#-# For instance, to make the "Development" category hidden by default, in addition to the "Internal" and
#-# "Deprecated" categories, you'd use:
# rendering.transformation.macro.hiddenCategories = Development,Internal,Deprecated

For Developers

Async Form Validation

 
A new JavaScript API is available to help implement asynchronous form validation. It can be used like this:

require(['jquery', 'xwiki-form-validation-async'], function($) {
  const titleInput = $('input[name=title]');

  const validateTitle = () => {
    if (!titleInput.val()) {
      return Promise.reject();
    } else {
      return new Promise((resolve, reject) => {
        ...
      });
    }
  };

  titleInput.on('input', () => {
    // Schedule the asynchronous validation after 500ms. The namespace is used to prevent replacing validations added by
    // other modules.
    titleInput.validateAsync(validateTitle, /* delay: */ 500, /* namespace: */ 'myModule');
  });
});

Miscellaneous

  • Provide Raw content filtering mechanism for macros: A new rendering transformation component is now provided for macros to allow perform filtering of RawBlocks. A new API is provided, RawBlockFilter, with a first implementation for HTML raw blocks, used in html macro.

  • DocumentVersionReference is part of the model API: The DocumentVersionReference is now part of the model API: this reference API allows to manipulate a DocumentReference with a specific version attribute, allowing to specifically target a version of the document.

  • Hidden macro categories API: The MacroCategoryManager role gives access to the list of hidden macro categories.

    @Role
public interface MacroCategoryManager
{
    // [...]

    /**
     * @return the set of hidden categories (e.g., "Deprecated, Internal")
     * @since 14.8RC1
     */
    @Unstable
    default Set<String> getHiddenCategories()
    {
        return Set.of();
    }
}

  • New event when livedata entries are displayed: A new javascript event xwiki:livedata:entriesUpdated is now triggered for LiveData when the entries are displayed: this event can be listened to when an extension need to augment the data.

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: 

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 Failed to execute the [velocity] macro. Cause: [The execution of the [velocity] script macro is not allowed in [xwiki:ReleaseNotes.Data.XWiki.14\.8RC1.WebHome]. Check the rights of its last author or the parameters if it's rendered from another script.]. Click on this message for details.

<issues specific to the project>

API Breakages

The following APIs were modified since Failed to execute the [velocity] macro. Cause: [The execution of the [velocity] script macro is not allowed in [xwiki:ReleaseNotes.Data.XWiki.14\.8RC1.WebHome]. Check the rights of its last author or the parameters if it's rendered from another script.]. Click on this message for details.
<version - 1>:

Credits

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

<code and translation contributors>

About

About

Support

Platform

User Guide

Admin Guide

Developer Guide

Projects

XWiki

Extensions

Other

Contribute

Status

Practices

Under the Hood

Get Involved

Get Connected