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

Version 3.1 by Thomas Mortagne on 2023/02/14
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.15\.1RC1.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.15\.1RC1.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

Warning when the dimensions are larger than the selected image

 
A warning message is displayed to the user when the width or height of an image are larger than the dimensions of the selected image.

Miscellaneous

  • PDF Internal Links: The PDF export is now generating internal links as much as possible. By internal links we mean links that make the PDF viewer scroll the target content into view rather than opening it in a web browser. The following types of internal links are supported:

    • links to a fragment from the same page that is included in the PDF export (e.g. #HDescription)
    • links to a fragment from another page that is included in the PDF export (e.g. /xwiki/bin/view/Other/Page#HDescription)
    • links to another page that is included in the PDF export (e.g. /xwiki/bin/view/Other/Page)

    Internal links that use fragment identifiers are updated automatically, before printing the content to PDF, to target the corresponding global fragment identifier that is generated by the shared id generator used when rendering multiple pages for PDF export. In other words, having multiple sections with the same name in the PDF export shouldn't cause any problems because the links that target them are updated properly.

    Checkout the PDF Export Application documentation for more information.

  • Tags are hidden when there are none: When there aren't any tags assigned to a page, the text “Tags:” is no longer displayed at the bottom of the page unless the user has edit rights.

  • The tabulator order in the page creation Location breadcrumb now matches the visuals, going from left to right as expected.

  • Limit parameter in tag cloud: The tag cloud macro supports a new parameter to limit the number of tags to the n most occurring tags.

  • The location picker breadcrumb icons now have a proper text alternative displayed on hover to assist in the understanding of their use.

For Admins

  • The administration right buttons now have a proper text alternative. It can be displayed on hover.

For Developers

New source support for content and context macros

 
The content and context macros now have an alternative way to indicate the content to parse, which allows executing content coming from a script value. See Content Macro for more details.

Miscellaneous

  • What's New API: New experimental API to gather external news related to XWiki.

    Example to get news items from a xwikiblog source, for a given user, filtered by a category:

    @Inject
    @Named("xwikiblog")
    private NewsSourceFactory factory;
    
    @Inject
    @Named("xwikiblog")
    private NewsConfiguration configuration;
    
    ...
    List<NewsSourceDescriptor> descriptors = this.configuration.getNewsSourceDescriptors();
    NewsSourceDescriptor descriptor = descriptors.get(0);
    List<NewsSourceItem> items = this.factory.create(descriptor.getParameters())
      .forUser(...)
      .forCategories(...)
      .build()
    NewsContent content = items.get(0).getDescription().get();
    String itemDescription = content.getContent();
    Syntax itemSyntax = content.getSyntax();
    ...
  • Refactored tips panel extension point: The tips panel extension point has been refactored to be safer and easier to use. See the "Add Tip to Tips Panel" extension point for more details on how to define a tip in 15.1+. Note that any custom tip you may have will continue to work as is, but we encourage you to move the tip definitions from the UIXP parameter to the UIXP content as the old way is now deprecated and will be removed one day (and it's also safer to use the new way).

  • Velocity macro for sanitizing URLs: A new velocity macro has been provided to allow getting sanitized URLs from request parameters to be used in HTML.

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.15\.1RC1.WebHome]. Check the rights of its last author or the parameters if it's rendered from another script.]. Click on this message for details.

Reinitialization of Solr search index during migration

A bug with the Solr search index has been fixed as part of this release, but it needs a reindex of the documents to be properly taken into account. The migration will empty the index so that a full reindex is performed: as a consequence the search feature might take a bit of time to be entirely working after the first restart depending on the number of documents in your wiki.

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.15\.1RC1.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