Release Notes for XWiki 8.2-rc-1

Version 32.1 by Marius Dumitru Florea on 2016/07/12

This is the release notes for XWiki Commons, XWiki Rendering, XWiki Platform and XWiki Enterprise. They share the same release notes as they are released together and have the same version.

This release brings the addition of a tour on the home page which describe the XWiki user interface to newcomers.

New and Noteworthy (since XWiki 8.1)

Full list of issues fixed and Dashboard for 8.2.

Tour for Homepage

A tour has been created to present the existing UI elements from the home page. Every user will be guided through this tour in order to become familiar with XWiki.

step4.png

CKEditor Becomes the Default WYSIWYG Editor

Starting with this version we have a new WYSIWYG editor: the CKEditor. The integration with CKEditor was already available as an extension and now this extension is bundled with the standard XWiki distribution. The old WYSIWYG editor is still available and if you want to switch back to it you can do it from the "Edit Mode Settings" section in the wiki administration.

defaultWysiwygEditorConfig.png

Miscellaneous

  • Removed Main.Welcome page from the Dashboard since we now have a new Homepage that contains the welcome messages
  • In the TemplateProviderClass, 2 new properties have been added: description and icon, in order to display additional information in template providers list.
  • events produced during Filter conversion job are now folded by default. This essentially means that they won't appear in Activity Stream anymore.

See the full list of JIRA issues fixed in this release.

For Developers

Instance Filter improvements

  • Instance Output Filter now support missing begin/end event on document locale and revision so input filter for which those two concept don't make sense don't have to send them anymore.
  • Instance Output Filter now use the context locale as default locale (used to be empty locale).

Deprecated and Retired projects

MediaWiki parser

xwiki-rendering-syntax-mediawiki has been deprecated and moved to https://github.com/xwiki-contrib/syntax-mediawiki-1.0.

It's now recommended to use MediaWiki Syntax extension instead.

Upgrades

The following dependencies have been upgraded:

Miscellaneous

  • new org.xwiki.rendering.listener.SectionGeneratorListener to generate section events from headers events
  • Instance Output filter now indicate the target syntax for Input filters producing rendering events
  • The same relative file path supported for source filter properties parameter is now supported for any InputSource filter properties parameter in the Filter test framework
  • $regextool Velocity Tool has a new method to quote the replacement string in String#replaceAll(). Here's how you can use it:
    #set ($out = $out.replaceAll(" (id|for)=('|"")$regextool.quote($oldId)",
      " ${escapetool.d}1=${escapetool.d}2$regextool.quoteReplacement($newId)"))

Translations

The following translations have been updated: 

Tested Browsers & Databases

The QA Tests are executed after the release has been done. Thus, they are being prepared now and will be published soon.

Performances tests compared to <last super stable version>

<a summary of the comparison with latest super stable version>

More details on <link to the test report>.

Known issues

Backward Compatibility and Migration Notes

General Notes

When upgrading make sure you compare your xwiki.cfg, xwiki.properties and web.xml files with the newest version since some configuration parameters may have been modified or added. Note that you should add xwiki.store.migration=1 so that XWiki will attempt to automatically migrate your current database to the 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>:

Tags:
   

Get Connected