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 is a bugfix release that covers important issues that we have discovered since 10.11.1 has been released.

New and Noteworthy (since XWiki 10.11.1)

Full list of issues fixed and Dashboard for 10.11.2.

All Changes

Translations

The following translations have been updated:

• Catalan
• Czech
• Danish
• German
• Spanish
• Persian
• French
• Croatian
• Italian
• Latvian
• Dutch
• Norwegian
• Polish
• Portuguese (Brazil)
• Russian
• Slovak
• Swedish
• Turkish
• Ukrainian

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.11.1:

• 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)
• Not a breackage in this context
  • Violation type:
    java.annotation.removed
  • Code:
    ## Old:
    method void org.xwiki.rendering.macro.display.DisplayMacroParameters::setReference(java.lang.String)
    
    ## New:
    method void org.xwiki.rendering.macro.display.DisplayMacroParameters::setReference(java.lang.String)

Credits

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

• Adel Atallah
• Eduard Moraru
• Guillaume Delhumeau
• Marius Dumitru Florea
• Simon Urli
• Thomas Mortagne