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 XWiki <version - 1>)

Full list of issues fixed and Dashboard for <full version here even for RC, e.g. 10.5>.

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 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).

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: 

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 XWiki <version>

<issues specific to the project>

API Breakages

The following APIs were modified since <project> <version - 1>:

Credits

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

<code contributors>

Tags:
   

Get Connected