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.

This version is mostly a stabilization release for the 10.x end of cycle. We've added a way to rapidly empty the wiki's recycle bin, that contains all the deleted pages. We've also polished the asynchronous execution and caching of panels added in the previous version, that makes the panels render faster. Plus we added many other improvements and bugfixes.

New and Noteworthy (since XWiki 10.10)

Full list of issues fixed and Dashboard for 10.11.

All Changes

• XWIKI-15992 The Locale parameter is not taken into account in two of the LocalizationScriptService#render methods
• XWIKI-15980 Setting a main wiki skin or a filesystem skin is much harder with the new picker
• XWIKI-15979 Global Menu is displayed (with error) in subwiki for a local user
• XWIKI-15978 Shutting down an idle XWiki instance takes over 30 seconds
• XWIKI-15976 Asynchronous panels encoding problem
• XWIKI-15965 Possible Nullpointerexception when importing/loading a document containing an attachment without the size information
• XWIKI-15964 The search page goes back to showing the first 10 results if you navigate beyond 1000 results
• XWIKI-15963 Upgrade to CKEditor Integration 1.29
• XWIKI-15962 Asynchronous panels generate external URLs
• XWIKI-15961 A page appears more then once in the "My Recent Modifications" when it has more then one translation
• XWIKI-15959 Upgrade to Rome 1.12.0
• XWIKI-15958 Upgrade to Apache PDFBox 2.0.13
• XWIKI-15956 Suggest Fails To Display Current Value Correctly On Edit
• XWIKI-15955 Empty Stack left in each Thread which executed a Display Macro
• XWIKI-15953 Rating a page containing dots in its name is not possible
• XWIKI-15949 The XAR parser should not use the xclass property element name
• XWIKI-15948 Inconsistency between an xclass name and its tag name
• XWIKI-15943 Panels disappear when clicking on the Reset button
• XWIKI-15942 Script right is tested in the context of the current document
• XWIKI-15938 "Tips" panel can't be drag and dropped anymore
• XWIKI-15936 'Skin' page picker is missing on instances created through Distribution Wizard
• XWIKI-15935 Replace async right with a client id system
• XWIKI-15934 Upgrade to JNR Constants 0.9.12
• XWIKI-15932 Order class properties from most specific to common in panels, ui extensions and wiki macros
• XWIKI-15929 'Tips' Panel is not translated when changing language
• XWIKI-15925 Random async exception with panels MyRecentModifications
• XWIKI-15919 Upgrade to JNR POSIX 3.0.47
• XWIKI-15917 Upgrade to Pygments 2.3.1
• XWIKI-15912 Improper "rename log" string is displayed when user is performing a page copy
• XWIKI-15908 Cerulean theme is selected by default in the Page Administration
• XWIKI-15899 Global users cannot recover their password from a subwiki due to macro errors
• XWIKI-15886 Impossible to change the notification "applications settings" if emails are disabled
• XWIKI-15881 Configured default interval for notification mails is not really taken into account in many cases
• XWIKI-15880 Create a button to delete all from the recycle bin
• XWIKI-15876 Display Skin Pages With Their Real Name
• XWIKI-15870 Warning message when copying a page
• XWIKI-15863 Reverting or deleting the current version breaks attachment links
• XWIKI-15851 Skin drop-down suggestions should display only pages containing XWiki.XWikiSkins objects
• XWIKI-15848 A user cannot programmatically unwatch the main wiki upon creation
• XWIKI-15827 Add support for binding a specific input to a macro parameter type
• XWIKI-15825 Use feature and grouping parameters to the Include macro descriptor
• XWIKI-15788 Duplicate attachments in email notifications
• XWIKI-15713 History tab indicate that the page does not exist when the history is empty
• XWIKI-15707 "Scope" attribute missing for .notifPreferences table headers
• XWIKI-14908 Huge status produced when setting empty input source in Filter Stream Converter application
• XWIKI-14635 Unsupported character exception is warned in console when downloading attachment
• XRENDERING-545 FigureTypeRecognizer not recognizing tables when there's a MetaData block inside Figure blocks
• XRENDERING-543 Figure and FigureCaption macro should not mandate content so that they can be edited online directly
• XRENDERING-542 Expose the feature property in parameter descriptors
• XRENDERING-535 Expose the groups property in parameter descriptors
• XCOMMONS-1538 Don't use java tmp dir for XAR plugin integration tests
• XCOMMONS-1530 Add support for feature parameters in property descriptors
• XCOMMONS-1528 Add support for grouped parameters in property descriptors
• XCOMMONS-1527 Create an HTML Displayer interface

For Users

Delete all from the recycle bin

It is now possible to permanently delete all pages that have been already deleted, in order to clean the recycle bin. See Index Application Documentation.

For Admins

No changes!

For Developers

Use RequestFactory to create a request from the refactoring script service

The refactoring script service has been refactored: you need to access the new RequestFactory in order to create any kind of request.
For example a script using :

should now use: 

All the API related to refactoring operations themselves remains at the same place. See the Refactoring Module Documentation for all information.

Upgrades

The following runtime dependencies have been upgraded (they have a different release cycle than XWiki Commons, XWiki Rendering and XWiki Platform):

• CKEditor Integration 1.29
• Pygments 2.3.1
• JNR POSIX 3.0.47
• Apache PDFBox 2.0.13
• Rome 1.12.0
• JNR Constants 0.9.12

Translations

The following translations have been updated: 

• Catalan
• Czech
• French
• Russian
• Ukrainian

Tested Browsers & Databases

Here is the list of browsers we support and how they have been tested for this release:

	Browser	Tests performed and results
	Google Chrome 71	Smoke tests
	Mozilla Firefox 64	New and Noteworthy Features + Jira Tickets Marked as Fixed in the Release Notes + Smoke tests
	Microsoft Edge 17	Not Tested
	Internet Explorer 11	Not Tested
	Safari 12	Not Tested

Here is the list of databases we support and how they have been tested for this release:

	Database	Tests performed and results
	HyperSQL 2.4.1	Not Tested
	MySQL 5.7	Smoke tests
	Oracle 11.2	New and Noteworthy Features + Jira Tickets Marked as Fixed in the Release Notes + Smoke tests
	PostgreSQL 10	Not Tested

Here is the list of Servlet Containers we support and how they have been tested for this release:

	Servlet Container	Tests performed and results
	Tomcat	Not Tested
	Jetty (XWiki Standalone packaging)	New and Noteworthy Features + Jira Tickets Marked as Fixed in the Release Notes + Smoke tests
	Jetty	Not Tested

Known issues

• Bugs we know about

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.

API Breakages

The following APIs were modified since XWiki 10.10:

• Not a breakage.
  • Violation type:
    java.annotation.attributeValueChanged
  • Code:
    ## Old:
    @interface org.xwiki.stability.Unstable
    
    ## New:
    @interface org.xwiki.stability.Unstable
• Not a breakage: class moved to a legacy module
  • Violation type:
    java.class.removed
  • Code:
    ## Old:
    class org.xwiki.velocity.introspection.AbstractChainableUberspector
• Not a breakage: class moved to a legacy module
  • Violation type:
    java.class.removed
  • Code:
    ## Old:
    interface org.xwiki.velocity.introspection.ChainableUberspector
• Not a breakage: class moved to a legacy module
  • Violation type:
    java.class.removed
  • Code:
    ## Old:
    class org.xwiki.velocity.introspection.ChainingUberspector
• Not a breakage: class moved to a legacy module
  • Violation type:
    java.class.removed
  • Code:
    ## Old:
    class org.xwiki.velocity.introspection.LinkingUberspector
• As RssMacro now inherits from AbstractBoxMacro, its parameter class needs to inherits from BoxMacroParameters. This could only break compatibility if a class inheriting from RssMacroParameters defines a method with same name and parameters than in BoxMacroParameters but different return type. We consider this risk as acceptable since the chances are very low and in case it occurs, the fix for the user would be easy.
  • Violation type:
    java.class.nonFinalClassInheritsFromNewClass
  • Code:
    ## Old:
    class org.xwiki.rendering.macro.rss.RssMacroParameters
    
    ## New:
    class org.xwiki.rendering.macro.rss.RssMacroParameters
• Bad design at fist attempt
  • Violation type:
    java.method.numberOfParametersChanged
  • Code:
    ## Old:
    method void org.xwiki.notifications.filters.NotificationFilterPreferenceManager::deleteFilterPreference(java.lang.String) throws org.xwiki.notifications.NotificationException
    
    ## New:
    method void org.xwiki.notifications.filters.NotificationFilterPreferenceManager::deleteFilterPreference(org.xwiki.model.reference.DocumentReference, java.lang.String) throws org.xwiki.notifications.NotificationException
• Bad design at fist attempt
  • Violation type:
    java.method.numberOfParametersChanged
  • Code:
    ## Old:
    method void org.xwiki.notifications.filters.NotificationFilterPreferenceManager::saveFilterPreferences(java.util.Set<org.xwiki.notifications.filters.NotificationFilterPreference>)
    
    ## New:
    method void org.xwiki.notifications.filters.NotificationFilterPreferenceManager::saveFilterPreferences(org.xwiki.model.reference.DocumentReference, java.util.Set<org.xwiki.notifications.filters.NotificationFilterPreference>)
• Bad design at fist attempt
  • Violation type:
    java.method.numberOfParametersChanged
  • Code:
    ## Old:
    method void org.xwiki.notifications.filters.NotificationFilterPreferenceManager::setFilterPreferenceEnabled(java.lang.String, boolean) throws org.xwiki.notifications.NotificationException
    
    ## New:
    method void org.xwiki.notifications.filters.NotificationFilterPreferenceManager::setFilterPreferenceEnabled(org.xwiki.model.reference.DocumentReference, java.lang.String, boolean) throws org.xwiki.notifications.NotificationException
• Bad design at fist attempt
  • Violation type:
    java.method.numberOfParametersChanged
  • Code:
    ## Old:
    method void org.xwiki.notifications.filters.NotificationFilterPreferenceProvider::deleteFilterPreference(java.lang.String) throws org.xwiki.notifications.NotificationException
    
    ## New:
    method void org.xwiki.notifications.filters.NotificationFilterPreferenceProvider::deleteFilterPreference(org.xwiki.model.reference.DocumentReference, java.lang.String) throws org.xwiki.notifications.NotificationException
• Bad design at fist attempt
  • Violation type:
    java.method.numberOfParametersChanged
  • Code:
    ## Old:
    method void org.xwiki.notifications.filters.NotificationFilterPreferenceProvider::saveFilterPreferences(java.util.Set<org.xwiki.notifications.filters.NotificationFilterPreference>) throws org.xwiki.notifications.NotificationException
    
    ## New:
    method void org.xwiki.notifications.filters.NotificationFilterPreferenceProvider::saveFilterPreferences(org.xwiki.model.reference.DocumentReference, java.util.Set<org.xwiki.notifications.filters.NotificationFilterPreference>) throws org.xwiki.notifications.NotificationException
• Bad design at fist attempt
  • Violation type:
    java.method.numberOfParametersChanged
  • Code:
    ## Old:
    method void org.xwiki.notifications.filters.NotificationFilterPreferenceProvider::setFilterPreferenceEnabled(java.lang.String, boolean) throws org.xwiki.notifications.NotificationException
    
    ## New:
    method void org.xwiki.notifications.filters.NotificationFilterPreferenceProvider::setFilterPreferenceEnabled(org.xwiki.model.reference.DocumentReference, java.lang.String, boolean) throws org.xwiki.notifications.NotificationException
• Handles conflicting macro parameters. This change is backward compatible.
  • Violation type:
    java.annotation.added
  • Code:
    ## Old:
    method org.xwiki.model.EntityType org.xwiki.rendering.macro.include.IncludeMacroParameters::getType()
    
    ## New:
    method org.xwiki.model.EntityType org.xwiki.rendering.macro.include.IncludeMacroParameters::getType()
• Handles conflicting macro parameters. This change is backward compatible.
  • Violation type:
    java.annotation.added
  • Code:
    ## Old:
    method void org.xwiki.rendering.macro.include.IncludeMacroParameters::setPage(java.lang.String)
    
    ## New:
    method void org.xwiki.rendering.macro.include.IncludeMacroParameters::setPage(java.lang.String)
• Handles conflicting macro parameters. This change is backward compatible.
  • Violation type:
    java.annotation.added
  • Code:
    ## Old:
    method void org.xwiki.rendering.macro.include.IncludeMacroParameters::setReference(java.lang.String)
    
    ## New:
    method void org.xwiki.rendering.macro.include.IncludeMacroParameters::setReference(java.lang.String)
• Handles conflicting macro parameters. This change is backward compatible.
  • Violation type:
    java.annotation.added
  • Code:
    ## Old:
    method void org.xwiki.rendering.macro.include.IncludeMacroParameters::setReference(java.lang.String)
    
    ## New:
    method void org.xwiki.rendering.macro.include.IncludeMacroParameters::setReference(java.lang.String)

Credits

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

Adel Atallah
Alex Cotiugă
Alfons Soriano
Ecaterina Moraru (Valica)
Guillaume Delhumeau
Marius Dumitru Florea
m-lw
Rostyslav Fitsyk
Sergiu Dumitriu
Simon Urli
slauriere
Thomas Mortagne
Vincent Massol
xrichard