Release Notes for XWiki 5.2 Release Candidate 1

Last modified by Marius Dumitru Florea on 2013/12/07

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 is mostly a stabilization release leading to XWiki 5.2 final and it brings a new "Home" top level menu (available when there is more than one wiki) and a new Distribution Wizard step to upgrade all wikis. The WikiStream framework has been improved and now can be used to export large wikis in XAR format. Besides this the new release includes 49 bug fixes and 16 small improvements.

New and Noteworthy (since XWiki 5.2 Milestone 2)

Full list of issues fixed and Dashboard for 5.2.

New "Home" menu when there is more than one wiki

Compared to XWiki 5.2-milestone-2, we have removed the XWiki right menu and created a "Home" menu instead.
mainwiki-homemenu.png
workspace-homemenu.png

The "main wiki" (the first you have when you start a new instance) is now called "Home".

Distribution Wizard Step to Upgrade All Wikis

We added a new step to the Distribution Wizard to update the default set of wiki pages on each of the existing wikis. This step is triggered only if you choose to upgrade the entire farm in the "Upgrade Mode" step.

dw-wikisStep.png

Markdown Syntax 1.1

We've added version 1.1 of the Rendering Syntax for Markdown, adding support for:

  • Macros
  • Superscript and subscript
  • (X)HTML improvements

Export large wikis as XARs

It's possible to enable the use of new WikiStream framework in standard export action (use in the standard export UI for example). Among other things it allows exporting a wiki of pretty much any size.

WikiStream is too young to be enabled by default and will require heavy testing. In the meantime you can try it by uncommenting # xwiki.action.export.xar.usewikistream=1 at the end of xwiki.cfg file.

Miscellaneous

  • Improved Active Installs Server side API to be able to pass any query to count installs.
  • Active Installs Client now also send the Distribution id in addition to the Distribution version to identify the "product" sending the ping
  • The checkboxes for the global rights settings are now displayed on the left of their labels.

    RightsAdministration-CheckboxOnTheLeft.png

  • The live search (search suggest) now displays a message when there are no results.

    liveSearch-noResults.png

  • The blog application is now packaged by default in the Home wiki only (not in new wikis).
  • The "Create a new wiki" link has been removed from the wiki index. Now, you can only use the Add > Wiki menu.
  • The Distribution Wizard does not appear anymore just after creating a new wiki based on the default template.

For Developers

WikiStream improvements

Various improvements and bugfixes to fully support the use case of exporting a entire wiki into a XAR package.

Also added a XAR input module for WikiStream, the only thing left before covering XAR import use case in Instance output module.

Upgrades

The following dependencies have been upgraded:

  • Xerces2-Java 2.11.0

Miscellaneous

  • Added DocumentReference and EntityReference property converters which makes possible to:
    • use them in rendering macros parameters beans (see How to write a macro)
    • in Velocity pass a String directly to a method requiring a DocumentReference or EntityReference
  • Added new API to the JODA Time plugin to get an ISO8601 formatter.

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

Translations

The following translations have been updated: 

  • Danish
  • German
  • French
  • Portuguese (Brazil)

Tested Browsers & Databases

Here's the list of browsers we support and how they've been tested specifically for this release:

BrowserTestedDetails
Chrome30.pngGoogle Chrome 29Not Tested
Firefox30.pngMozilla Firefox 24Not Tested
IE30.pngInternet Explorer 8Not Tested
IE30.pngInternet Explorer 9Not Tested

Here's the list of databases we support and how they've been tested specifically for this release:

DatabaseTestedDetails
hypersql.pngHyperSQL 2.3.0Not Tested
mysql.pngMySQL 5.6.10Not Tested
oracle.pngOracle 11.2Not Tested
postgresql.pngPostgreSQL 9.2.4Not Tested

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.

SOLR Search Format Change

If you're upgrading from XWiki 4.5.x to this version you'll need to perform a full re-indexation when using the SOLR Search. This because in XWiki 4.5.x the SOLR search was experimental and we've completely changed the indexing format in XWiki 5.1.

API Breakages

The following APIs were modified since XWiki 5.1:

  • Moved to xwiki-commons-legacy-properties
org.xwiki.properties.converter.AbstractCollectionConverter: Class org.xwiki.properties.converter.AbstractCollectionConverter removed
  • This method should never have existed
org.xwiki.rendering.listener.reference.ResourceType: Method 'public void setScheme(java.lang.String)' has been removed
  • Moved from xwiki-rendering-api to xwiki-rendering-xml
org.xwiki.rendering.renderer.printer.XHTMLWikiPrinter: Class org.xwiki.rendering.renderer.printer.XHTMLWikiPrinter removed
org.xwiki.rendering.renderer.printer.XMLWikiPrinter: Class org.xwiki.rendering.renderer.printer.XMLWikiPrinter removed
  • This field is not meant to be be modified, the final was just forgotten.
com.xpn.xwiki.XWikiContext: Field TYPE_PROVIDER is now final
  • Not an API. This should be internal.
com.xpn.xwiki.store.XWikiHibernateBaseStore: Method 'protected java.lang.String[] addHibernateSequenceIfRequired(java.lang.String[], java.lang.String, org.hibernate.Session)' has been removed
  • Has been moved to xwiki-platform-feed-api since it was the only module using it. We also dropped jTidy in favor of HTMLCleaner.
com.xpn.xwiki.util.TidyMessageLogger: Class com.xpn.xwiki.util.TidyMessageLogger removed
  • Google API plugin has been retired
com.xpn.xwiki.plugin.google.GooglePlugin: Class com.xpn.xwiki.plugin.google.GooglePlugin removed
com.xpn.xwiki.plugin.google.GooglePluginApi: Class com.xpn.xwiki.plugin.google.GooglePluginApi removed
  • Return the number of imported documents
com.xpn.xwiki.tool.backup.Importer: Return type of method 'public void importXAR(java.io.File, java.lang.String, com.xpn.xwiki.XWikiContext)' has been changed to int
  • The JPQLParser generates source code (that should be internal but it is not) and the grammar has changed a bit.
org.xwiki.query.jpql.analysis.Analysis: Method 'public void caseAFuncnumComparableItem(org.xwiki.query.jpql.node.AFuncnumComparableItem)' has been added to an interface
org.xwiki.query.jpql.analysis.Analysis: Method 'public void caseAFuncstrComparableItem(org.xwiki.query.jpql.node.AFuncstrComparableItem)' has been added to an interface
org.xwiki.query.jpql.analysis.Analysis: Method 'public void caseAFunctimeComparableItem(org.xwiki.query.jpql.node.AFunctimeComparableItem)' has been added to an interface
org.xwiki.query.jpql.analysis.Analysis: Method 'public void caseAPathComparableItem(org.xwiki.query.jpql.node.APathComparableItem)' has been added to an interface
org.xwiki.query.jpql.node.AGroupbyItem: Parameter 1 of 'public AGroupbyItem(org.xwiki.query.jpql.node.PPath)' has changed its type to org.xwiki.query.jpql.node.PComparableItem
org.xwiki.query.jpql.node.AGroupbyItem: Method 'public org.xwiki.query.jpql.node.PPath getPath()' has been removed
org.xwiki.query.jpql.node.AGroupbyItem: Method 'public void setPath(org.xwiki.query.jpql.node.PPath)' has been removed
org.xwiki.query.jpql.node.AOrderbyItem: Parameter 1 of 'public AOrderbyItem(org.xwiki.query.jpql.node.PPath, org.xwiki.query.jpql.node.TOrderbySpec)' has changed its type to org.xwiki.query.jpql.node.PComparableItem
org.xwiki.query.jpql.node.AOrderbyItem: Method 'public org.xwiki.query.jpql.node.PPath getPath()' has been removed
org.xwiki.query.jpql.node.AOrderbyItem: Method 'public void setPath(org.xwiki.query.jpql.node.PPath)' has been removed
Tags:
Created by Thomas Mortagne on 2013/09/13

Get Connected