Wiki source code of Release Notes for XWiki 5.2
Version 5.1 by Marius Dumitru Florea on 2013/10/02
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | {{box cssClass="floatinginfobox" title="**Contents**"}} | ||
| 2 | {{toc/}} | ||
| 3 | {{/box}} | ||
| 4 | |||
| 5 | This is the release notes for [[XWiki Commons>>http://commons.xwiki.org]], [[XWiki Rendering>>http://rendering.xwiki.org]], [[XWiki Platform>>http://platform.xwiki.org]] and [[XWiki Enterprise>>http://enterprise.xwiki.org]]. They share the same release notes as they are released together and have the same version. | ||
| 6 | |||
| 7 | <insert description of release here> | ||
| 8 | |||
| 9 | = New and Noteworthy (since XWiki 5.1) = | ||
| 10 | |||
| 11 | [[Full list of issues fixed and Dashboard for 5.2>>http://jira.xwiki.org/secure/Dashboard.jspa?selectPageId=11602]]. | ||
| 12 | |||
| 13 | == <feature N> == | ||
| 14 | |||
| 15 | <description of feature N> | ||
| 16 | |||
| 17 | == Miscellaneous == | ||
| 18 | |||
| 19 | <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!> | ||
| 20 | |||
| 21 | See the [[full list of JIRA issues>>http://jira.xwiki.org/sr/jira.issueviews:searchrequest-printable/temp/SearchRequest.html?jqlQuery=project+in+%28XCOMMONS%2C+XRENDERING%2C+XWIKI%2C+XE%29+and+status+%3D+Closed+and+resolution+%3D+Fixed+and+fixVersion+in+%28%225.2-milestone-1%22%2C+%225.2-milestone-2%22%2C+%225.2-rc-1%22%2C+%225.2%22%29&tempMax=1000]] fixed in this release. | ||
| 22 | |||
| 23 | = For Developers = | ||
| 24 | |||
| 25 | == <developer feature N> == | ||
| 26 | |||
| 27 | <description of developer feature N> | ||
| 28 | |||
| 29 | == Deprecated and Retired projects == | ||
| 30 | |||
| 31 | <description of deprecated and retired projects> | ||
| 32 | |||
| 33 | == Upgrades == | ||
| 34 | |||
| 35 | The following dependencies have been upgraded: | ||
| 36 | |||
| 37 | * <list libraries that have been upgraded> | ||
| 38 | |||
| 39 | == Miscellaneous == | ||
| 40 | |||
| 41 | <other dev stuff to add and link to JIRA for all issues fixed> | ||
| 42 | |||
| 43 | = Translations = | ||
| 44 | |||
| 45 | The following translations have been updated: | ||
| 46 | |||
| 47 | {{language codes="none, none"/}} | ||
| 48 | |||
| 49 | = Tested Browsers & Databases = | ||
| 50 | |||
| 51 | {{include reference="TestReports.ManualTestReportTemplateSummary"/}} | ||
| 52 | |||
| 53 | = Known issues = | ||
| 54 | |||
| 55 | * [[Bugs we know about>>http://jira.xwiki.org/secure/IssueNavigator.jspa?reset=true&jqlQuery=category+%3D+%22Top+Level+Projects%22+AND+issuetype+%3D+Bug+AND+resolution+%3D+Unresolved+ORDER+BY+updated+DESC]] | ||
| 56 | |||
| 57 | = Backward Compatibility and Migration Notes = | ||
| 58 | |||
| 59 | == General Notes == | ||
| 60 | |||
| 61 | You may also want to [[import the default wiki XAR>>Main.Download]] in order to benefit from all the improvements listed above. | ||
| 62 | |||
| 63 | {{warning}} | ||
| 64 | Always make sure you compare your ##xwiki.cfg## and ##xwiki.properties## files with the newest version since some configuration parameters were 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. | ||
| 65 | {{/warning}} | ||
| 66 | |||
| 67 | == Solr Index Format Change == | ||
| 68 | |||
| 69 | 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. | ||
| 70 | |||
| 71 | == Email Address Obfuscation == | ||
| 72 | |||
| 73 | In [[4.2>>ReleaseNotes.ReleaseNotesXWiki42||anchor="HNewfieldtypesforemailandlistofpages"]] we introduced a new object property type called Email that can be used to store email addresses. In [[5.1>>ReleaseNotes.ReleaseNotesXWiki51||anchor="HUseremail"]] 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. | ||
| 74 | |||
| 75 | == Instance Identifier == | ||
| 76 | |||
| 77 | 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: | ||
| 78 | |||
| 79 | ((( | ||
| 80 | {{code}} | ||
| 81 | ... | ||
| 82 | <mapping resource="instance.hbm.xml"/> | ||
| 83 | ... | ||
| 84 | {{/code}} | ||
| 85 | ))) | ||
| 86 | |||
| 87 | == API Breakages == | ||
| 88 | |||
| 89 | The following APIs were modified since XWiki 5.1: | ||
| 90 | |||
| 91 | * Moved to ##xwiki-commons-legacy-properties## | ||
| 92 | |||
| 93 | {{code language="none"}} | ||
| 94 | org.xwiki.properties.converter.AbstractCollectionConverter: Class org.xwiki.properties.converter.AbstractCollectionConverter removed | ||
| 95 | {{/code}} | ||
| 96 | |||
| 97 | * This method should never have existed | ||
| 98 | |||
| 99 | {{code language="none"}} | ||
| 100 | org.xwiki.rendering.listener.reference.ResourceType: Method 'public void setScheme(java.lang.String)' has been removed | ||
| 101 | {{/code}} | ||
| 102 | |||
| 103 | * Moved from ##xwiki-rendering-api## to ##xwiki-rendering-xml## | ||
| 104 | |||
| 105 | {{code language="none"}} | ||
| 106 | org.xwiki.rendering.renderer.printer.XHTMLWikiPrinter: Class org.xwiki.rendering.renderer.printer.XHTMLWikiPrinter removed | ||
| 107 | org.xwiki.rendering.renderer.printer.XMLWikiPrinter: Class org.xwiki.rendering.renderer.printer.XMLWikiPrinter removed | ||
| 108 | {{/code}} | ||
| 109 | |||
| 110 | * This field is not meant to be be modified, the final was just forgotten. | ||
| 111 | |||
| 112 | {{code language="none"}} | ||
| 113 | com.xpn.xwiki.XWikiContext: Field TYPE_PROVIDER is now final | ||
| 114 | {{/code}} | ||
| 115 | |||
| 116 | * Not an API. This should be internal. | ||
| 117 | |||
| 118 | {{code language="none"}} | ||
| 119 | com.xpn.xwiki.store.XWikiHibernateBaseStore: Method 'protected java.lang.String[] addHibernateSequenceIfRequired(java.lang.String[], java.lang.String, org.hibernate.Session)' has been removed | ||
| 120 | {{/code}} | ||
| 121 | |||
| 122 | * Has been moved to ##xwiki-platform-feed-api## since it was the only module using it. We also dropped jTidy in favor of HTMLCleaner. | ||
| 123 | |||
| 124 | {{code language="none"}} | ||
| 125 | com.xpn.xwiki.util.TidyMessageLogger: Class com.xpn.xwiki.util.TidyMessageLogger removed | ||
| 126 | {{/code}} | ||
| 127 | |||
| 128 | * Google API plugin has been retired | ||
| 129 | |||
| 130 | {{code language="none"}} | ||
| 131 | com.xpn.xwiki.plugin.google.GooglePlugin: Class com.xpn.xwiki.plugin.google.GooglePlugin removed | ||
| 132 | com.xpn.xwiki.plugin.google.GooglePluginApi: Class com.xpn.xwiki.plugin.google.GooglePluginApi removed | ||
| 133 | {{/code}} | ||
| 134 | |||
| 135 | * Return the number of imported documents | ||
| 136 | |||
| 137 | {{code language="none"}} | ||
| 138 | 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 | ||
| 139 | {{/code}} | ||
| 140 | |||
| 141 | * The JPQLParser generates source code (that should be internal but it is not) and the grammar has changed a bit. | ||
| 142 | |||
| 143 | {{code language="none"}} | ||
| 144 | org.xwiki.query.jpql.analysis.Analysis: Method 'public void caseAFuncnumComparableItem(org.xwiki.query.jpql.node.AFuncnumComparableItem)' has been added to an interface | ||
| 145 | org.xwiki.query.jpql.analysis.Analysis: Method 'public void caseAFuncstrComparableItem(org.xwiki.query.jpql.node.AFuncstrComparableItem)' has been added to an interface | ||
| 146 | org.xwiki.query.jpql.analysis.Analysis: Method 'public void caseAFunctimeComparableItem(org.xwiki.query.jpql.node.AFunctimeComparableItem)' has been added to an interface | ||
| 147 | org.xwiki.query.jpql.analysis.Analysis: Method 'public void caseAPathComparableItem(org.xwiki.query.jpql.node.APathComparableItem)' has been added to an interface | ||
| 148 | 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 | ||
| 149 | org.xwiki.query.jpql.node.AGroupbyItem: Method 'public org.xwiki.query.jpql.node.PPath getPath()' has been removed | ||
| 150 | org.xwiki.query.jpql.node.AGroupbyItem: Method 'public void setPath(org.xwiki.query.jpql.node.PPath)' has been removed | ||
| 151 | 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 | ||
| 152 | org.xwiki.query.jpql.node.AOrderbyItem: Method 'public org.xwiki.query.jpql.node.PPath getPath()' has been removed | ||
| 153 | org.xwiki.query.jpql.node.AOrderbyItem: Method 'public void setPath(org.xwiki.query.jpql.node.PPath)' has been removed | ||
| 154 | {{/code}} |
