Skip to Content

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

Version 1.1 by Manuel Leduc on 2024/11/25
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.Cristal.0\.12.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.Cristal.0\.12.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

History View

 
It is now possible to see the history of a page in the new "History" tab, at the bottom of the page. Currently, this is only supported by the XWiki and GitHub backends.

1732536778977-969.png

Attachment preview

 
Is it now possible to preview attachments when clicking on an attachment link. A modal window opens with the following elements:

  • file name
  • uploader name
  • upload date
  • size
  • mimetype
  • when available, an attachment preview (e.g., for images and videos)
  • a download button

attachment_preview.png

More details in the attachments tab

 
The attachments tab displays additional metadata: the size, the upload date, and the uploader.

history_cristal.png

For Admins

No changes!

For Developers

Page Revision Managers

 
Page Revision Managers have been introduced to support backend-specific logics to manage history on backends supporting versioning. The new history tab feature relies on them and any future backend with versioning support is expected to implement their own implementation.

File Preview

 
A file preview module was introduced, allowing developers to display the file size from bytes to a human-readable format (e.g., 512 Gb) with the FileSize component.

Additionally, a FilePreview component allows for the display of a file preview UI when the provided file mime type is supported. For now, only images and videos are supported.

User module

 
A user module was introduced. It provides a User Vue component allowing to provide a standardized way to display users in the UI.

Date

 
A date module was introduced, allowing developers to convert dates to localized strings with the DateService component, and a Date Vue component to display localized date in UI elements.

Model

 
A new set of model components was introduced:

  • model-api: provides the types of entities supported by Cristal (e.g., page reference, or attachment reference)
  • model-click-listener: provides the operations to listen to links in the DOM, parse those links to entity references, and to decide of the action to perform based on the link type (e.g., navigate to a new page, or open the file preview modal)
  • model-reference: parsers and serializers for entities
  • model-remote-url: parsers and serializers for backend remote url

Storage.getAttachment

 
The storage API now provides a method to retrieve a single attachment from its name and page reference.

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):

  • <list libraries that have been upgraded>

Translations

The following translations have been updated: 

Security Issues

Security issues are not listed in issue lists or dashboards to avoid disclosing ways to use them, but they will appear automatically in them once they're disclosed. See the XWiki Security Policy for more details.

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.Cristal.0\.12.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.Cristal.0\.12.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