Wiki source code of Release Notes for XWiki 5.2

Version 21.1 by Vincent Massol on 2013/10/29

Show last authors
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 {{warning}}
8 **The support of XWiki Enterprise Manager is stopped**. XWiki Enterprise now comes with the ability to create (sub)wikis by default, see below.
9 {{/warning}}
10
11 {{error}}
12 We've discovered several regressions in this version after it was released:
13 * [[a RSS feed regression>>http://jira.xwiki.org/browse/XWIKI-9576]]: Makes some RSS readers show duplicate entries (for readers who use a Feed entry's URL as its unique id).
14 * [[a Watchlist regression>>http://jira.xwiki.org/browse/XWIKI-9601]]: Links in the HTML email sent by the Watchlist do not work anymore.
15 * Any Scheduler job that computes external URLs will have the generated URL be empty.
16
17 They are fixed in XWiki 5.2.1 and 5.3 Milestone 1 and can also be patched in your instance (see the issue for details).
18 {{/error}}
19
20 This release comes with multiwiki support enabled by default: users are able to create new wikis without the need to install additional extensions. This is possible because the Workspace Application has been integrated in XWiki Enterprise. We stopped the support for XWiki Enterprise Manager as a consequence. Apart from this, the new release brings a Solr-based live search (to replace the one based on Lucene) and the ability to track active XWiki installs. The Distribution Wizard has a new step to upgrade all wikis. Developers will be interested by the new Wiki Stream framework which can already be used to export large wikis in XAR format. A lot of bug fixes (135) and many improvements (50) complete this release and make it worth trying.
21
22 = New and Noteworthy (since XWiki 5.1) =
23
24 [[Full list of issues fixed and Dashboard for 5.2>>http://jira.xwiki.org/secure/Dashboard.jspa?selectPageId=11602]].
25
26 == Multi-wiki Support ==
27
28 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>>extensions:Extension.Workspace Application]] in the default XWiki distribution.
29
30 {{image reference="ReleaseNotesXWiki52M2@add-wiki.png"/}}
31
32 This new menu entry appears only if a wiki template is created first, see below.
33
34 === Wiki Creation Right ===
35
36 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.
37
38 === Wikis Administration Section ===
39
40 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.
41
42 {{image reference="ReleaseNotesXWiki52M2@admin-wikis.png"/}}
43
44 === Wiki Creation Wizard ===
45
46 A new wizard for the creation of a new wiki is now available from the "Add" menu.
47
48 {{image reference="ReleaseNotesXWiki52M2@createwiki1.png"/}}
49
50 {{image reference="ReleaseNotesXWiki52M2@createwiki2.png"/}}
51
52 === Home Menu ===
53
54 A new top level menu is available when there is more than one wiki.
55
56 {{image reference="ReleaseNotesXWiki52RC1@mainwiki-homemenu.png"/}}
57
58 {{image reference="ReleaseNotesXWiki52RC1@workspace-homemenu.png"/}}
59
60 The "main wiki" (the first you have when you start a new instance) is now called "**Home**".
61
62 == Solr-based Search Suggest ==
63
64 Starting with this version the [[search suggest>>doc:extensions:Extension.Search Application||anchor="HSearchSuggest"]] feature takes into account the configured search engine. To achieve this we added a new property to ##SearchSuggestSourceClass## that specifies the search engine used by the source. We also created a search suggest service based on Solr and we added search suggest sources that mimic the behaviour of the existing Lucene-based sources. As a result, the search suggest feature is now using Solr by default (as Solr is the default search engine starting with 5.1).
65
66 We also improved the search suggest administration section
67
68 {{image reference="ReleaseNotesXWiki52M2@searchSuggestAdminSection.png"/}}
69
70 and we simplified the source creation form.
71
72 {{image reference="ReleaseNotesXWiki52M2@searchSuggestSourceForm.png"/}}
73
74 The live search now displays a message when there are no results.
75
76 {{image reference="ReleaseNotesXWiki52RC1@liveSearch-noResults.png"/}}
77
78 == Distribution Wizard Step to Upgrade All Wikis ==
79
80 We added a new step to the [[Distribution Wizard>>doc:platform:Features.DistributionWizard]] 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.
81
82 {{image reference="ReleaseNotesXWiki52RC1@dw-wikisStep.png" width="600px"/}}
83
84 == Active Installs Tracking ==
85
86 It' very important for the open source committers to understand how well or how badly they're faring when developing the XWiki open source project. So far we didn't know if the number of people using XWiki was increasing, decreasing or staying stable. This module allows us to know who's using XWiki.
87
88 It does the following:
89
90 * A client side JAR is bundled with XWiki and it sends a ping with data once per day
91 * A server side Application is installed on xwiki.org, allowing us to query the data sent and to display a counter of Active Installs of XWiki (i.e. installs for which we've received a ping in the last N days, for example at least one ping in the past month).
92
93 The data sent is anonymous and consists of the following:
94
95 * A unique id (UUID) representing the XWiki instance. Note that not even the IP is kept and there's no way to find who's having a give UUID (it's generated using Java's UUID implementation)
96 * The date of the ping
97 * The XWiki distribution id (e.g. ##org.xwiki.enterprise:xwiki-enterprise-web##)
98 * The version of your XWiki distribution (e.g. ##5.2##)
99 * The technical ids and versions of extensions you have installed.
100
101 This will allow us to present the following data:
102
103 * Number of total installs of XWiki
104 * Number of Active Installs
105 * Most used extensions across versions of XWiki
106 * How frequently the XWiki user base upgrades to newer versions of XWiki
107
108 {{image reference="ReleaseNotesXWiki52M2@stats.png"/}}
109
110 {{info}}
111 In the near future we'll offer a UI feature to opt-out (in the Administration pages) but at the moment if you wish to opt-out (please don't, we need your help, knowing who's using us and that it's growing is what keeps us motivated to continue developing XWiki!), then simply remove the ##WEB-INF/lib/xwiki-platform-activeinstalls*## JAR and restart.
112 {{/info}}
113
114 Reference documentation:
115
116 * [[Client side module>>extensions:Extension.Active Installs Client API]].
117 * [[Server side module>>extensions:Extension.Active Installs Server Application]].
118
119 == Toggle Email Address Obfuscation ==
120
121 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. //a...@domain.org//, the rest of the letters being replaced by an ellipsis. Email obfuscation is off by default.
122
123 {{image reference="ReleaseNotesXWiki52M1@generalEmailSettings.png"/}}
124
125 == Markdown Syntax 1.1 ==
126
127 We've added [[version 1.1 of the Rendering Syntax for Markdown>>rendering:Main.Markdown11]], adding support for:
128
129 * Macros
130 * Superscript and subscript
131 * (X)HTML improvements
132
133 == Export Large Wikis as XARs ==
134
135 It's possible to enable the use of new [[WikiStream>>doc:extensions:Extension.Wiki Stream Module]] 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.
136
137 [[WikiStream>>doc:extensions:Extension.Wiki Stream Module]] is too young to be enabled by default and will require heavy testing. In the meantime you can try it by uncommenting {{code}}# xwiki.action.export.xar.usewikistream=1{{/code}} at the end of xwiki.cfg file.
138
139 == Miscellaneous ==
140
141 * The blog application is now packaged by default in the Home wiki only (not in new wikis).
142
143 {{error}}
144 In the case you are using the blog application in your subwiki, **the upgrade will remove it**. You will have to **install the blog application again** through the [[extension manager>>extensions:Extension.Extension Manager Application]], but **you should take care if you have customized it**.
145 {{/error}}
146
147 * {{id name="userVerticalMenu"/}}The user profile menu is now consistent with the administration menu.(((
148 {{image reference="ReleaseNotesXWiki52M1@userProfile.png"/}}
149 )))
150 * The ##line## [[chart>>doc:extensions:Extension.Chart Macro]] type has two parameters, ##hideShapes## and ##hideLines##, to hide the shapes used to display the data points or to hide the interpolation lines that connect the data points.(((
151 {{image reference="ReleaseNotesXWiki52M2@lineWithoutShapes.png"/}}
152 )))
153 * When creating or editing a [[template provider>>doc:extensions:Extension.Administration Application||anchor="HCreatethetemplateprovider"]] the template name field is now mandatory.(((
154 {{image reference="ReleaseNotesXWiki52M2@templateNameMandatory.png"/}}
155 )))
156 * The checkboxes for the global rights settings are now displayed on the left of their labels.(((
157 {{image reference="ReleaseNotesXWiki52RC1@RightsAdministration-CheckboxOnTheLeft.png"/}}
158 )))
159 * The "Create a new wiki" link has been removed from the wiki index. Now, you can only use the //Add > Wiki// menu.
160 * The Distribution Wizard does not appear anymore just after creating a new wiki based on the default template.
161
162 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.
163
164 = For Developers =
165
166 == JSON Parsing in Velocity ==
167
168 ##$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]].
169
170 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.
171
172 == Query String Escaping ==
173
174 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>>http://jira.xwiki.org/browse/XCOMMONS-435]].
175
176 == New XWikiDocument API to Remove an Attachment ==
177
178 ##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.
179
180 == Choosing which types of attachments can be displayed inline (Security) ==
181
182 In order to prevent XSS via FileUpload, a new feature has been added : you can now specify in xwiki.properties which types of attachment can be displayed inline.
183 In the "Attachment" section of xwiki.properties, you can either precise a whitelist of mimetypes that can be displayed inline, or precise a blacklist of mimetypes that shouldn't be displayed inline (if you use this configuration, it is strongly advised to blacklist at least "text/html" and "text/javascript" mimetypes for security reasons).
184 Note that attachments provided by users having Programming Rights won't be affected by these restrictions.
185
186 == Forcing IE Compatibility Mode ==
187
188 Now, we force the Compatibility mode for Internet Explorer (IE) browsers to use the latest rendering mode.
189 Before, the IE browser displayed all intranet sites in compatibility mode by default. This means that even if the user was using IE9, he saw the content rendered with IE7 standards. Since we don't [[support>>dev:Community.BrowserSupportStrategy]] IE6/7 anymore this lead in displaying broken layout, scrollbars, etc. See [[XWIKI-8907>>http://jira.xwiki.org/browse/XWIKI-8907]].
190
191 == New Filter Module ==
192
193 Commons has a new core module for all streaming systems based on filters like Rendering and the [[Wiki Stream>>doc:extensions:Extension.Wiki Stream Module]]. See [[Filter Module documentation>>extensions:Extension.Filter Module]].
194
195 == New Wiki Stream Framework ==
196
197 Wiki Stream goal is to provide generic API to make easier for different representations of a wiki instance to communicate with each other.
198
199 It's still in a very early stage and the API might change during 5.x but it's already pretty complete and usable.
200
201 The the following streams modules are provided in 5.2:
202
203 * XWiki instance input (send WikiStream events from various data of the XWiki instance like the documents in the database etc.)
204 * XWiki instance output (generate and save various data of the XWiki instance like the documents from WikiStream events)
205 * XAR instance output (write a XAR package from WikiStream events)
206 * XAR instance input (generate WikiStream events from a XAR package)
207
208 == New Eclipse CS Extension ==
209
210 [[XCOMMONS-353>>http://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.
211
212 ##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.
213
214 == Deprecated and Retired projects ==
215
216 * 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
217
218 == Upgrades ==
219
220 The following dependencies have been upgraded:
221
222 * Aether 0.9.0.M2 (moved from org.sonatype.aether to org.eclipse.aether)
223 * CSSParser 0.9.9
224 * [[Groovy 2.1.7>>http://jira.xwiki.org/browse/XCOMMONS-445]]
225 * [[HSQLDB 2.3.0>>http://jira.xwiki.org/browse/XE-1323]]
226 * Infinispan 5.3
227 * JGroups 3.3.4
228 * Maven 3.1.0
229 * Tika 1.4
230 * Xerces2-Java 2.11.0
231
232 == Miscellaneous ==
233
234 * Added support for custom facets in Solr search API
235 * New [[Instance Module>>extensions:Extension.Instance Module]] used to compute a unique id for each XWiki instance (used by the [[Active Installs Client API>>extensions:Extension.Active Installs Client API]]
236 * 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.
237 * Added DocumentReference and EntityReference property converters which makes possible to:
238 ** use them in rendering macros parameters beans (see [[How to write a macro>>rendering:Main.ExtendingMacro||anchor="HMacroCode"]])
239 ** in Velocity pass a String directly to a method requiring a DocumentReference or EntityReference
240 * Added new API to the JODA Time plugin to get an ISO8601 formatter.
241
242 = Translations =
243
244 The following translations have been updated:
245
246 {{language codes="ca, cs, da, de, es, fr, gl, it, ko, lv, nl, pl, pt, pt_BR, ro, ru, sk, sv, uk, vi, zh, zh_TW"/}}
247
248 = Tested Browsers & Databases =
249
250 {{include reference="TestReports.ManualTestReportXWiki52Summary"/}}
251
252 = Known issues =
253
254 * [[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]]
255
256 = Backward Compatibility and Migration Notes =
257
258 == General Notes ==
259
260 You may also want to [[import the default wiki XAR>>Main.Download]] in order to benefit from all the improvements listed above.
261
262 {{warning}}
263 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.
264 {{/warning}}
265
266 == Solr Index Format Change ==
267
268 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.
269
270 == Email Address Obfuscation ==
271
272 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.
273
274 == Instance Identifier ==
275
276 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:
277
278 (((
279 {{code}}
280 ...
281 <mapping resource="instance.hbm.xml"/>
282 ...
283 {{/code}}
284 )))
285
286 == API Breakages ==
287
288 The following APIs were modified since XWiki 5.1:
289
290 * Moved to ##xwiki-commons-legacy-properties##
291
292 {{code language="none"}}
293 org.xwiki.properties.converter.AbstractCollectionConverter: Class org.xwiki.properties.converter.AbstractCollectionConverter removed
294 {{/code}}
295
296 * This method should never have existed
297
298 {{code language="none"}}
299 org.xwiki.rendering.listener.reference.ResourceType: Method 'public void setScheme(java.lang.String)' has been removed
300 {{/code}}
301
302 * Moved from ##xwiki-rendering-api## to ##xwiki-rendering-xml##
303
304 {{code language="none"}}
305 org.xwiki.rendering.renderer.printer.XHTMLWikiPrinter: Class org.xwiki.rendering.renderer.printer.XHTMLWikiPrinter removed
306 org.xwiki.rendering.renderer.printer.XMLWikiPrinter: Class org.xwiki.rendering.renderer.printer.XMLWikiPrinter removed
307 {{/code}}
308
309 * This field is not meant to be be modified, the final was just forgotten.
310
311 {{code language="none"}}
312 com.xpn.xwiki.XWikiContext: Field TYPE_PROVIDER is now final
313 {{/code}}
314
315 * Not an API. This should be internal.
316
317 {{code language="none"}}
318 com.xpn.xwiki.store.XWikiHibernateBaseStore: Method 'protected java.lang.String[] addHibernateSequenceIfRequired(java.lang.String[], java.lang.String, org.hibernate.Session)' has been removed
319 {{/code}}
320
321 * Has been moved to ##xwiki-platform-feed-api## since it was the only module using it. We also dropped jTidy in favor of HTMLCleaner.
322
323 {{code language="none"}}
324 com.xpn.xwiki.util.TidyMessageLogger: Class com.xpn.xwiki.util.TidyMessageLogger removed
325 {{/code}}
326
327 * Google API plugin has been retired
328
329 {{code language="none"}}
330 com.xpn.xwiki.plugin.google.GooglePlugin: Class com.xpn.xwiki.plugin.google.GooglePlugin removed
331 com.xpn.xwiki.plugin.google.GooglePluginApi: Class com.xpn.xwiki.plugin.google.GooglePluginApi removed
332 {{/code}}
333
334 * Return the number of imported documents
335
336 {{code language="none"}}
337 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
338 {{/code}}
339
340 * The JPQLParser generates source code (that should be internal but it is not) and the grammar has changed a bit.
341
342 {{code language="none"}}
343 org.xwiki.query.jpql.analysis.Analysis: Method 'public void caseAFuncnumComparableItem(org.xwiki.query.jpql.node.AFuncnumComparableItem)' has been added to an interface
344 org.xwiki.query.jpql.analysis.Analysis: Method 'public void caseAFuncstrComparableItem(org.xwiki.query.jpql.node.AFuncstrComparableItem)' has been added to an interface
345 org.xwiki.query.jpql.analysis.Analysis: Method 'public void caseAFunctimeComparableItem(org.xwiki.query.jpql.node.AFunctimeComparableItem)' has been added to an interface
346 org.xwiki.query.jpql.analysis.Analysis: Method 'public void caseAPathComparableItem(org.xwiki.query.jpql.node.APathComparableItem)' has been added to an interface
347 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
348 org.xwiki.query.jpql.node.AGroupbyItem: Method 'public org.xwiki.query.jpql.node.PPath getPath()' has been removed
349 org.xwiki.query.jpql.node.AGroupbyItem: Method 'public void setPath(org.xwiki.query.jpql.node.PPath)' has been removed
350 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
351 org.xwiki.query.jpql.node.AOrderbyItem: Method 'public org.xwiki.query.jpql.node.PPath getPath()' has been removed
352 org.xwiki.query.jpql.node.AOrderbyItem: Method 'public void setPath(org.xwiki.query.jpql.node.PPath)' has been removed
353 {{/code}}

Get Connected