Show last authors
1 {{box cssClass="floatinginfobox" title="**Contents**"}}
2 {{toc/}}
3 {{/box}}
4
5 This is the release notes for XWiki Platform, XWiki Enterprise and XWiki Enterprise Manager. They share the same release notes as they are released together and have the same version.
6
7 The first milestone of the 5.2 release brings a lot of bug fixes and a few improvements, notably the ability to toggle email address obfuscation and a better-looking user profile menu.
8
9 = New and Noteworthy (since XWiki 5.1) =
10
11 [[Full list of issues fixed and Dashboard for 5.2>>https://jira.xwiki.org/secure/Dashboard.jspa?selectPageId=11602]].
12
13 == Toggle Email Address Obfuscation ==
14
15 The email configuration section in the [[Administration>>doc:extensions:Extension.Administration Application]] now has an option to enable/disable the obfuscation of the email addresses that are stored in object properties of [[type Email>>ReleaseNotes.ReleaseNotesXWiki42||anchor="HNewfieldtypesforemailandlistofpages"]]. The obfuscation is done by displaying only the first letter of the email account, e.g. //[email protected]//, the rest of the letters being replaced by an ellipsis. Email obfuscation is off by default.
16
17 {{image reference="generalEmailSettings.png"/}}
18
19 == Miscellaneous ==
20
21 * The create new wiki wizard is now using the user and group pickers in the last step ("Initial global members")(((
22 {{image reference="createNewWiki-rights.png"/}}
23 )))
24
25 * {{id name="userVerticalMenu"/}} The user profile menu is now consistent with the administration menu.
26
27 (((
28 {{image reference="userProfile.png"/}}
29 )))
30
31 See the [[full list of JIRA issues>>https://jira.xwiki.org/sr/jira.issueviews:searchrequest-printable/temp/SearchRequest.html?jqlQuery=project+in+%28XCOMMONS%2C+XRENDERING%2C+XWIKI%2C+XE%2C+XEM%29+and+status+%3D+Closed+and+resolution+%3D+Fixed+and+fixVersion+%3D+%225.2-milestone-1%22&tempMax=1000]] fixed in this release.
32
33 = For Developers =
34
35 == New Filter Module ==
36
37 Commons has a new core module for all streaming systems based on filters like Rendering and the upcoming Wiki Stream. See [[Filter Module documentation>>extensions:Extension.Filter Module]].
38
39 == JSON parsing in Velocity ==
40
41 ##$jsontool.parse('["json string"]')## can now be used to parse a serialized JSON into [[json-lib>>http://json-lib.sourceforge.net/]] [[arrays>>http://json-lib.sourceforge.net/apidocs/jdk15/net/sf/json/JSONArray.html]] or [[objects>>http://json-lib.sourceforge.net/apidocs/jdk15/net/sf/json/JSONObject.html]].
42
43 Only valid JSON strings can be parsed. JSONP is not supported. If the argument is not valid JSON, then ##null## is returned, parsing exceptions are caught.
44
45 == Query String escaping ==
46
47 The following method ##$escapetool.url(Map<String, ?>)## has been added to the escapetool module. It allows to create a properly URL-escaped query string from a map of parameters. The key in the map is the parameter name and the value can be an object, an array of objects or a collection of objects. ##String.valueOf(Object)## is used to serialize the objects (values). For example ##$escapetool.url({'alice': ['A&A', 'M&M'], 'bob': [13, 27]})## would return ##alice=A%26A&alice=M%26M&bob=13&bob=27##. See [[XCOMMONS-435>>https://jira.xwiki.org/browse/XCOMMONS-435]].
48
49 == New Eclipse cs extension ==
50
51 [[XCOMMONS-353>>https://jira.xwiki.org/browse/XCOMMONS-353]] made our checkstyle.xml file unusable as it is in Eclipse cs because of the custom rule that could not be found in the Eclipse classpath.
52
53 ##xwiki-commons-tool-verification-resources## module is now also an Eclipse cs extension which mean you can just drop its jar in Eclipse ##plugins/## folder and you will get the XWiki checkstyle configuration listed in the standard configurations.
54
55 == New XWikiDocument API to remove an attachment ==
56
57 ##XWikiDocument#deleteAttachment## methods have been deprecated in favor of the combination of ##XWikiDocument#removeAttachment## and ##XWiki#saveDocument##. This make attachment deletion follow the same behavior as xobject and among other things allow doing all sort of modifications to a XWikiDocument without touching the database until we decide to apply them by saving the document.
58
59 == Deprecated and Retired projects ==
60
61 * 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
62
63 == Upgrades ==
64
65 The following dependencies have been upgraded:
66
67 * Infinispan 5.3
68 * Tika 1.4
69 * JGroups 3.3.4
70 * Maven 3.1.0
71 * Aether 0.9.0.M2 (moved from ##org.sonatype.aether## to ##org.eclipse.aether##)
72 * CSSParser 0.9.9
73
74 == Miscellaneous ==
75
76 * The way to declare the type supported by a ##org.xwiki.properties.converter.Converter## component changed from role hint to generic type. See [[Properties Module documentation>>extensions:Extension.Properties Module||anchor="HConvertercomponent28Recommended29"]] for more details. The old way is still supported for retro-compatibility.
77
78 = Translations =
79
80 The following translations have been updated:
81
82 {{language codes="cs, de, es, fr, it, lv, nl, pt_BR, ru, sv, uk"/}}
83
84 = Tested Browsers & Databases =
85
86 {{include reference="TestReports.ManualTestReportXWiki52M1Summary"/}}
87
88 = Known issues =
89
90 * [[Bugs we know about>>https://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]]
91
92 = Backward Compatibility and Migration Notes =
93
94 == General Notes ==
95
96 == General Notes ==
97
98 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.
99
100 == SOLR Search Format Change ==
101
102 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
103 format in XWiki 5.1.
104
105 == Email Address Obfuscation ==
106
107 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.
108
109 == API Breakages ==
110
111 The following APIs were modified since XWiki 5.1:
112
113 * Moved to ##xwiki-commons-legacy-properties##
114
115 {{code language="none"}}
116 org.xwiki.properties.converter.AbstractCollectionConverter: Class org.xwiki.properties.converter.AbstractCollectionConverter removed
117 {{/code}}
118
119 * This method should never have existed
120
121 {{code language="none"}}
122 org.xwiki.rendering.listener.reference.ResourceType: Method 'public void setScheme(java.lang.String)' has been removed
123 {{/code}}
124
125 * Moved from ##xwiki-rendering-api## to ##xwiki-rendering-xml##
126
127 {{code language="none"}}
128 org.xwiki.rendering.renderer.printer.XHTMLWikiPrinter: Class org.xwiki.rendering.renderer.printer.XHTMLWikiPrinter removed
129 org.xwiki.rendering.renderer.printer.XMLWikiPrinter: Class org.xwiki.rendering.renderer.printer.XMLWikiPrinter removed
130 {{/code}}
131
132 * This field is not meant to be be modified, the final was just forgotten.
133
134 {{code language="none"}}
135 com.xpn.xwiki.XWikiContext: Field TYPE_PROVIDER is now final
136 {{/code}}
137
138 * Has been moved to ##xwiki-platform-feed-api## since it was the only module using it. We also dropped jTidy in favor of HTMLCleaner.
139
140 {{code language="none"}}
141 com.xpn.xwiki.util.TidyMessageLogger: Class com.xpn.xwiki.util.TidyMessageLogger removed
142 {{/code}}
143
144 * Google API plugin has been retired
145
146 {{code language="none"}}
147 com.xpn.xwiki.plugin.google.GooglePlugin: Class com.xpn.xwiki.plugin.google.GooglePlugin removed
148 com.xpn.xwiki.plugin.google.GooglePluginApi: Class com.xpn.xwiki.plugin.google.GooglePluginApi removed
149 {{/code}}
150
151 * Return the number of imported documents
152
153 {{code language="none"}}
154 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
155 {{/code}}

Get Connected