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.

<insert description of release here>

New and Noteworthy (since XWiki 5.1)

Full list of issues fixed and Dashboard for 5.2.

Multi-wiki Support

XWiki Enterprise comes now with the ability for users to create their own wikis (a.k.a subwikis) without the need to install additional extensions. This supersedes the notion of "workspace" and consists in the integration of the Workspace Application in the default XWiki distribution.

This new menu entry appears only if a wiki template is created first, see below.

Wiki Creation Right

The wiki creation is now possible for users who have the "createwiki" right. This right is only available for the main wiki users, exactly like the Programming Right.

Wikis Administration Section

A new section is available in the administration of the main wiki. In this section, you can enable the wiki creation feature by creating a wiki template. It also manages who has the right to create new wikis.

Wiki Creation Wizard

A new wizard for the creation of a new wiki is now available from the "Add" menu.

Home Menu

A new top level menu is available when there is more than one wiki.

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

Toggle Email Address Obfuscation

The email configuration section in the Administration now has an option to enable/disable the obfuscation of the email addresses that are stored in object properties of type Email. The obfuscation is done by displaying only the first letter of the email account, e.g. a...@domain.org, the rest of the letters being replaced by an ellipsis. Email obfuscation is off by default.

Miscellaneous

<insert misc user stuff and important bug fix descriptions here in a list, when they are too small to warrant a section by themselves - Change the version in the URL below!>

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

For Developers

<developer feature N>

<description of developer feature N>

Deprecated and Retired projects

• Google plugin (com.xpn.xwiki.plugin.google.GooglePlugin) has been retired, you can find it on https://github.com/xwiki-contrib/retired/tree/master/xwiki-platform-google-plugin

Upgrades

The following dependencies have been upgraded:

• Aether 0.9.0.M2 (moved from org.sonatype.aether to org.eclipse.aether)
• CSSParser 0.9.9
• Groovy 2.1.7
• HSQLDB 2.3.0
• Infinispan 5.3
• JGroups 3.3.4
• Maven 3.1.0
• Tika 1.4
• Xerces2-Java 2.11.0

Miscellaneous

<other dev stuff to add and link to JIRA for all issues fixed>

Translations

The following translations have been updated: 

• Catalan
• Czech
• Danish
• German
• Spanish
• French
• Galician
• Italian
• Korean
• Latvian
• Dutch
• Polish
• Portuguese
• Portuguese (Brazil)
• Romanian
• Russian
• Slovak
• Swedish
• Ukrainian
• Vietnamese
• Simplified Chinese
• Traditional Chinese

Tested Browsers & Databases

Known issues

• Bugs we know about

Backward Compatibility and Migration Notes

General Notes

You may also want to import the default wiki XAR in order to benefit from all the improvements listed above.

Solr Index 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.

Email Address Obfuscation

In 4.2 we introduced a new object property type called Email that can be used to store email addresses. In 5.1 we decided to use this new property type in the user profile to store the user email address. With this change we also introuced a defaut custom displayer for the Email property type that obfuscates the email address in view mode. As a consequence the user profile email address became obfuscated by default. Starting with 5.2 we allow you to toggle the email address obfuscation from the administration. What is important to know is that the email address obfuscation is off by default. So if you upgrade from 5.1 and you want to preserve the obfuscation then you need to enable it from the administration.

Instance Identifier

XWiki now creates a unique identifier in the database (this is used by the new Active Installs module and will be used in the future by the Extension Manager to identify your instance for example). You need to verify that your hibernate.cfg.xml file has the following mapping definition next to the existing mapping definitions:

...
<mapping resource="instance.hbm.xml"/>
...

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