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

Version 1.1 by Vincent Massol on 2024/11/08
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.16\.10\.0RC1.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.16\.10\.0RC1.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

Improve the registration & Log-in experience

 
Multiple steps of the registration process have been updated and improved in accordance with design research done earlier:

  • The registration and authentification buttons for guest users have been moved from the drawer to the navigation bar for increased visibility
  • The registration form validation has been improved to provide a precise status on every field before trying to submit it.
  • The successful registration landing page is now looking a bit more welcoming.

Improvements for editing the user avatar

 
The button for editing the user profile avatar is now more visible, easier to find and interact than before.

This action is now placed below the picture and features a standard button that spans the length of the sidebar menu 

Miscellaneous

  • The default colors used in the code macro have been altered slightly, in order to fit WCAG-defined contrast values. Those changes in color only apply to some highlighting colors, and are barely noticeable.

For Admins

No changes!

For Developers

Required Rights

 
New APIs have been introduced for required rights, a new mechanism for explicitly marking which rights the content of a document needs. 

This provides two protections:

  • Restricting script executions in documents where scripts haven't explicitly been enabled, 
  • Preventing users without script, admin, or programming right from editing documents that require these rights. 

For now, this is a developer-only change, required rights aren't enforced by default and there is no UI (a UI is planned for a following release). Developers whose extensions depend on XWiki 16.10.0+ are encouraged to start using the new document authorization manager when checking the rights of document authors, e.g., when registering a component based on an XObject. 

Extensions can also start enforcing required rights on their documents, marking which pages need wiki admin or programming right for example and check if their extensions still work when enabling enforcing required rights for these documents. 

The XAR Format Specification has been adapted, accordingly. If not done already, required rights analyzers should be implemented for all XObjects and macros that need rights beyond what's covered by standard fields. This includes for example the interpretation of Velocity code in fields that aren't marked as containing Velocity code, or requiring wiki admin right for certain scope values. Those analyzers are necessary to allow suggesting the user all rights that are required by a page.

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.XWiki.16\.10\.0RC1.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.16\.10\.0RC1.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>

Get Connected