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 release marks the start of the 11.x cycle and focuses mainly on bugfixes and stabilization, but also features some AWM and CKEditor improvements.

New and Noteworthy (since XWiki 10.11)

Full list of issues fixed and Dashboard for 11.0.

For Users

Easily edit the app title

 
The title of an application created with App Within Minutes can now be edited from the last step of the application wizard. The application title is displayed on the application home page, on the applications panel and live table, on the breadcrumb, etc. See the App Within Minutes documentation for more information.

Macro Parameter Groups

 
The WYSIWYG editor is now able to group macro parameters as indicated in the macro descriptor. Currently only the Include Macro has grouped parameters. There can be two types of macro parameter groups:

• groups of related parameters (e.g. reference and type in the case of the Include Macro)
• groups of alternative parameters (only one parameter in the group should be set); this type of groups are displayed using tabs (e.g. "Resource" and "Page" in the case of the Include Macro)

See the CKEditor Integration documentation for more information.

New tip to autocomplete links

 
New tip about typing the [ character when editing in WYSIWYG to get autocompletion for links.

Miscellaneous

• Deprecated macro parameters are hidden: When inserting a macro from the WYSIWYG editor the deprecated macro parameters are hidden in order to discourage their usage and to simplify the UI. A deprecated macro parameter is shown only if it has a value set (when editing a macro).

• Advanced macro parameters shown last: When inserting a macro from the WYSIWYG editor the advanced macro parameters are shown at the end, most of the time hidden under the "More" link in order to simplify the UI. An advanced macro parameter might be shown at the top if it has a value set (when editing a macro).

For Admins

• Propertly support long paths in filesystem store: The way the filesystem store organizes the data has been completely modified to fix a bug with some languages. There should not be any issue with the size of the path anymore.

For Developers

Macro Parameter Pickers

 
The WYSIWYG editor is now able to load pickers for macro parameters based on their type. The binding between macro parameter types and the associated pickers is done on the server side (check the templates/html_displayer folder inside the XWiki WAR). For instance, if you have a wiki-based rendering macro, you can set the type of a macro parameter to "org.xwiki.model.reference.DocumentReference" in order to get a document picker when inserting or editing your macro from the WYSIWYG editor. Check the CKEditor Integration documentation for more information.

Miscellaneous

• Maven "legacy" profile: The Extension Manager now automatically activates the legacy profile when reading a pom.

• Display Type property annotation: The PropertyDisplayType annotation has been introduced to allow specifying a display type (that can be different from the actual property type) which can be used when rendering properties (i.e. inputs of the WYSIWYG macros).

Upgrades

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

• Byte Buddy 1.9.7
• CKEditor Integration 1.30
• commons-fileupload 1.4
• CSS4J 0.42
• Groovy 2.5.5
• Jackson 2.9.8
• Jakarta Activation 1.2.1
• JAXB 2.3.2
• JNA 5.2.0
• Jodconverter 4.2.2 (from XWiki's JODConverter fork, version 3.1-xwiki)
• JSqlParser 1.4
• Tika 1.20
• XWiki Tour Application 1.2

Translations

The following translations have been updated:

• French
• Norwegian
• Persian
• Polish
• 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 72	Not Tested
	Mozilla Firefox 65	Not Tested
	Microsoft Edge 17	New and Noteworthy Features + Jira Tickets Marked as Fixed in the Release Notes
	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	New and Noteworthy Features + Jira Tickets Marked as Fixed in the Release Notes
	Oracle 11.2	Not Tested
	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
	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.

Issues specific to XWiki 11.0

New filesystem store paths

The paths of the filesystem store have been completely modified and the store itself is now at a different location:

• moved from <permdir>/storage to <permdir>/store/file/ to give room for potential future store implementations based on the filesystem
• moved from complete hierarchy-based encoded URLs to reference hashes (to fix the issue with some languages)

In most cases there is nothing to do since a migration will take care of the upgrade automatically. However if you were directly manipulating the old stored files (something you shoudln't do!) it won't work anymore and you'll need to adjust your script/code.

Legacy profile

Extension Manager now automatically activate the legacy profile when reading a pom.

API Breakages

The following APIs were modified since XWiki 10.11:

• 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
• 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
Alex Cotiugă
Denis Fountaine
Dobromił Peszko
Ecaterina Moraru (Valica)
Eduard Moraru
Guillaume Delhumeau
Hossein Khalaj
Jarle Sandmo
Marius Dumitru Florea
m-lw
Richard Boer
Rostyslav Fitsyk
Simon Urli
Thomas Mortagne
Vincent Massol