Release Notes for XWiki 5.2
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.
<feature N>
<description of feature N>
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
<description of deprecated and retired projects>
Upgrades
The following dependencies have been upgraded:
- <list libraries that have been upgraded>
Miscellaneous
<other dev stuff to add and link to JIRA for all issues fixed>
Translations
The following translations have been updated:
Tested Browsers & Databases
Known issues
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 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.
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.
Active Installs Tracking
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
- This method should never have existed
- Moved from xwiki-rendering-api to xwiki-rendering-xml
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.
- Not an API. This should be internal.
- Has been moved to xwiki-platform-feed-api since it was the only module using it. We also dropped jTidy in favor of HTMLCleaner.
- Google API plugin has been retired
com.xpn.xwiki.plugin.google.GooglePluginApi: Class com.xpn.xwiki.plugin.google.GooglePluginApi removed
- Return the number of imported documents
- 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 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