Hide last authors
Marius Dumitru Florea 1.1 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
Vincent Massol 11.1 7 The 6.4 release is the last major release of the 6.x development Cycle and as such was mainly dedicated to improvements and bugfixes on things introduced during 6.X.
Marius Dumitru Florea 1.1 8
Vincent Massol 11.1 9 This version introduces some developer oriented improvements: allow wiki based skins to overwrite macro.vm template, allow filesystem skins indicating explicitly the skin they are inheriting from, allow any component to be injected with its ComponentDescriptor, Panels and UI extensions are now executed with the right of their author so among other things they can use APIs requiring Programming rights.
Marius Dumitru Florea 1.1 10
Vincent Massol 11.1 11 It also brings UI improvements in the Menu application, a new Mail application (and Mail-related improvements, such as the ability to send massive number of emails) and lots of Flamingo skin improvements (Mobile-friendliness to mention one), while offering developers the ability to write LESS in Skin Extensions, and a cool icon picker.
Marius Dumitru Florea 1.1 12
Vincent Massol 11.1 13 Last but not least, this version provides the ability to rate Extensions inside the Extension Repository and visualise them inside the Extension Manager.
14
Vincent Massol 17.1 15 {{error}}
Vincent Massol 22.1 16 Important problems noticed after the 6.4 release:
17
Thomas Mortagne 28.1 18 * In this release, we're now providing an easy way to install SOLR as an external server. When doing this change, we moved a plugin inside the SOLR index directory. Thus, if you're using XWiki with SOLR in embedded mode (the default), when you upgrade, this plugin will not be present in your SOLR directory and XWiki will fail to start. To work around this problem, you'll need to remove the ##<permanent directory>/solr/## directory (which will trigger a new reindexing when you next start XWiki). This will be [[fixed in XWiki 6.4.1>>https://jira.xwiki.org/browse/XE-1463]].
19 * The main CSS is often badly generated, [[this will be fixed in 6.4.1>>https://jira.xwiki.org/browse/XWIKI-11755]].
20 * [[HTML exports are taking very long>>https://jira.xwiki.org/browse/XWIKI-11731]] (over 1 minute to export a single page). Thus if you're using this feature, we recommend waiting for 6.4.1 and not upgrading to 6.4.
21 * [[The HTML export is broken for flamingo (fixed in 6.4.1)>>https://jira.xwiki.org/browse/XWIKI-11659]].
22 * [[You cannot use a JNDI DataSource with this version>>https://jira.xwiki.org/browse/XWIKI-11706]]. Fixed in XWiki 6.4.2.
Vincent Massol 17.1 23 {{/error}}
24
Vincent Massol 11.1 25 = New and Noteworthy (since XWiki 6.3) =
26
Thomas Mortagne 28.1 27 [[Full list of issues fixed and Dashboard for 6.4>>https://jira.xwiki.org/secure/Dashboard.jspa?selectPageId=12998]].
Vincent Massol 11.1 28
Vincent Massol 9.1 29 == Menu Application ==
Marius Dumitru Florea 1.1 30
Vincent Massol 9.1 31 Taking advantage of the ability to have LESS inside our [[StyleSheetExtensions>>extensions:Extension.Skin Extension Plugin||anchor="HUseLESS"]], we improved the [[Menu Application>>extensions:Extension.Menu Application]], on Flamingo based skins, making it responsive and also adapting its styling according to the active [[Flamingo Theme>>extensions:Extension.Flamingo Theme Application]].
32 Colibri based skins preserve the initial styling.
33
34 {{gallery}}
Vincent Massol 10.1 35 image:ReleaseNotesXWiki64M2@menu_flamingo_charcoal.png
36 image:ReleaseNotesXWiki64M2@menu_flamingo_united.png
37 image:ReleaseNotesXWiki64M2@menu_flamingo_darkly.png
38 image:ReleaseNotesXWiki64M2@menu_flamingo_simplex.png
39 image:ReleaseNotesXWiki64M2@menu_flamingo_charcoal_responsive.png
Vincent Massol 9.1 40 {{/gallery}}
41
42 == Flamingo Skin ==
43
44 We partially restored the behaviour of the top level menu from version 6.2, with some improvements:
Thomas Mortagne 16.1 45
Vincent Massol 10.2 46 * For tablet and desktop:
Vincent Massol 9.1 47 ** the menu label is a link used for navigation
48 ** the toggle (arrow / caret) is used for opening the drop down menu, but should be better separated from the label
Vincent Massol 10.9 49 * On phones the behaviour remains the same: taping on the label opens the menu
Vincent Massol 10.3 50
Vincent Massol 10.9 51 Default: {{image reference="ReleaseNotesXWiki64M2@charcoal-default.png"/}}
52 Hover Link: {{image reference="ReleaseNotesXWiki64M2@charcoal-hover-link.png"/}}
53 Hover Toggle: {{image reference="ReleaseNotesXWiki64M2@charcoal-hover-toggle.png"/}}
54 Open: {{image reference="ReleaseNotesXWiki64M2@charcoal-open.png"/}}
55
Thomas Mortagne 16.1 56 The history table, under each page, is now responsive to the screen size:
57
58 (((
59 {{image reference="ReleaseNotesXWiki64M2@responsive-history.png"/}}
Vincent Massol 10.2 60 )))
Vincent Massol 10.3 61
Thomas Mortagne 16.1 62 Some improvements have been made on the responsive tables (including the livetables) and we have fixed the broken livetables for mobiles on some places:
63
64 (((
Vincent Massol 10.1 65 {{image reference="ReleaseNotesXWiki64M3@livetable-rights.png" width="30%"/}} {{image reference="ReleaseNotesXWiki64M3@mobile-users.png" width="30%"/}} {{image reference="ReleaseNotesXWiki64M3@mobile-groups.png" width="30%"/}}
Vincent Massol 10.2 66 )))
Vincent Massol 10.1 67
Vincent Massol 9.1 68 == Rating Features ==
69
Vincent Massol 10.4 70 The Contrib ratings project has been moved to platform. Java APIs have been broken by the package renaming but script APIs have been kept retro-compatible and the UI is mostly the same. See [[Ratings Application>>extensions:Extension.Ratings Application]].
Vincent Massol 9.1 71
72 It's now possible to rate extensions in [[Extension Repository>>extensions:Extension.Repository Application]] and any repository handler can expose extension rating that are displayed (read only for now) in [[Extension Manager>>extensions:Extension.Extension Manager Application]].
73
Vincent Massol 10.1 74 {{image reference="ReleaseNotesXWiki64M3@ratingem.png"/}} {{image reference="ReleaseNotesXWiki64M3@ratinger.png"/}}
Vincent Massol 9.1 75
76 == Wiki Configuration ==
77
78 A new "Configuration > Wiki" section is added in Administration where you can configure the current wiki, whether it is the main wiki or a subwiki.
79
Vincent Massol 10.1 80 {{image reference="ReleaseNotesXWiki64M3@wikiDescriptorEditingAdministration-cropped.png"/}}
Vincent Massol 9.1 81
82 For more information, see the [[documentation>>extensions:Extension.Wiki Application||anchor="HConfigureWiki"]].
83
84 == New Parameters for Document Tree Macro ==
85
86 We added 3 new parameters to the [[Document Tree Macro>>extensions:Extension.Document Tree Macro]]:
87
88 * **filterByClass**: show only the documents that have an object of the specified type. The value of this parameter is the full name of an XWiki document that holds a class definition. For example, 'Blog.CategoryClass' can be used to show only the documents that represent blog categories.
89 * **openTo**: the id of the node to open the tree to. All the ancestors of the specified node, up to the root of the tree, will be opened also.
90 * **showOnlyViewable**: show only the wiki, space and document nodes for which the current user has view right. If this is set to false then the wiki, space and document nodes that are not viewable by the current user are listed in the tree using their names. The user won't be able to see their content by following their links though (the user will just be aware of their existence).
91
92 == Mail Feature ==
93
94 * The mail feature has a new Category in the Admin UI (see the [[Mail Application>>extensions:Extension.Mail Application]] for details).(((
Vincent Massol 10.1 95 {{image reference="ReleaseNotesXWiki64M2@emailcategory.png"/}}
Vincent Massol 9.1 96 )))
97 * There's now the possibility to configure default BCC addresses which will be added by default to all emails sent using the [[Mail Sender API>>extensions:Extension.Mail Sender API]].(((
Vincent Massol 10.1 98 {{image reference="ReleaseNotesXWiki64M2@emailsend.png"/}}
Vincent Massol 9.1 99 )))
100 * The [[Mail Sender API>>extensions:Extension.Mail Sender API]] now checks for permission before sending emails, when using it from scripts (i.e. when using the Mail Sender Script Service). There are currently 2 possible strategies that you configure in your ##xwiki.properties## file(((
101 {{code language="none"}}
102 #-# [Since 6.4M2]
103 #-# Defines which authorization checks are done when sending mails using the Mail Sender Script Service.
104 #-# Example of valid values:
105 #-# - "programmingrights": the current document must have Programming Rights
106 #-# - "alwaysallow": no check is performed. This is useful when running XWiki in a secure environment where we
107 #-# want to allow all users to be able to send emails through the Script Service.
108 #-# The default is:
109 # mail.sender.scriptServiceCheckerHint = programmingrights
110 {{/code}}
111 )))
112 * The [[Mail Sender API>>extensions:Extension.Mail Sender API]] has been modified to support sending a large number of mails at once. In addition the [[Mail Admin UI>>extensions:Extension.Mail Application]] has been improved to display the statuses of mails (when they're sent by XWiki features specifying that the mail statuses should be persisted).(((
113 {{image reference="ReleaseNotesXWiki64M3@emailcategory.png"/}}
114
115 {{image reference="ReleaseNotesXWiki64M3@emailstatus.png"/}}
116 )))
Vincent Massol 4.1 117 * You can now specify the delay to wait between each mail being sent, in milliseconds. This is done to support mail throttling and not be considered a spammer by mail servers. For example if you wish to wait 10 seconds (if not specified the default is 8 seconds, which is 450 mails per hour), set the following in your ##xwiki.properties##:(((
118 {{code language="none"}}
119 mail.sender.sendWaitTime = 10000
120 {{/code}}
Marius Dumitru Florea 1.1 121
Vincent Massol 4.1 122 The configuration parameter can also be changed from the [[Mail Admin UI>>extensions:Extension.Mail Application]]:
123
Vincent Massol 4.2 124 {{image reference="ReleaseNotesXWiki64RC1@sendmailwait.png"/}}
Vincent Massol 4.1 125 )))
126 * We now save both an error summary and a full error description when a mail fails to be sent when using the Database Mail Listener. This allows to see the full stack trace of the problem to more easily debug it.(((
Vincent Massol 4.2 127 {{image reference="ReleaseNotesXWiki64RC1@sendmailerror.png"/}}
Vincent Massol 4.1 128 )))
129 * The Mail Type is now displayed in the [[Mail Sender Status Admin UI>>extensions:Extension.Mail Application]]:(((
Vincent Massol 4.2 130 {{image reference="ReleaseNotesXWiki64RC1@mailtype.png"/}}
Vincent Massol 4.1 131 )))
132 * The ##MailResult.isSent()## API has been renamed to ##MailResult.isProcessed()## to avoid thinking that it'll return true if all mails have been sent successfully. What it does is simply return true when all mails have been processed, whether they've been sent successfully or not.
133 * A new scripting API has been added to set the mail type:(((
134 {{code language="none"}}
135 $message.setType("Some type")
136 {{/code}}
137 )))
138 * In the [[Mail Sender Status Admin UI>>extensions:Extension.Mail Application]] we now only display mails sent by the current wiki unless we're on the main wiki.
139 * The [[Mail Application>>extensions:Extension.Mail Application]] doesn't require Programming Rights for installation anymore.
140 * Account Validation email results are now saved and visible in the [[Mail Application>>extensions:Extension.Mail Application]].
141 * Some new [[Mail Sender Storage script services>>extensions:Extension.Mail Sender Storage]] have been added: ability to delete mail statuses for a single mail and for a whole batch, and ability to load mail statuses with criteria.
142 * When messages are sent with the API they are now persisted locally before they are effectively sent, one by one. This means that even if XWiki crashes when mails are being sent, their statuses will be correctly displayed in the [[Mail Sender Status Admin UI>>extensions:Extension.Mail Application]] and can be resent.
Vincent Massol 5.1 143 * The Java API has been modified to use Strings in all places where it was previously using a UUID, in order to allow for change in unique id generation in the future.
Vincent Massol 7.1 144 * The wiki is not displayed in the [[Mail Sender Status Admin UI>>extensions:Extension.Mail Application]](((
145 {{image reference="mailwiki.png"/}}
Thomas Mortagne 16.1 146 )))
Manuel Smeria 8.1 147
Vincent Massol 9.1 148 == Wikis ==
149
Thomas Mortagne 16.1 150 A "Wikis" category has been created in the administration, where the configuration have been moved and split in different sections:
151
152 (((
Vincent Massol 9.1 153 |=Left menu|=Right menu
Vincent Massol 10.1 154 |{{image reference="ReleaseNotesXWiki64RC1@AdminWikis.png"/}}|{{image reference="ReleaseNotesXWiki64RC1@AdminWikis2.png"/}}
Vincent Massol 9.1 155 )))
156
157 == Extension Manager incompatible exceptions ==
158
159 When trying to install an incompatible extension (i.e. you are running XWiki 6.2.4 and want to install FAQ Application 6.3), you are now displayed a proper error instead of having to read through the install log to understand what went wrong, and you are instructed to use the ##Description > Stable Versions## section to manually (for now) find a compatible version of the extension that you want to install.
160
161 {{image reference="ReleaseNotesXWiki64RC1@incompatibleExtensionError.png"/}}
162
163 == Solr server setup package ==
164
Thomas Mortagne 27.1 165 Everything needed to setup an XWiki index in a remote Solr server is now packaged in a standalone project (##xwiki-platform-search-solr-server-data##). A Debian package (##xwiki-solr-data##) has also been provided to make easier to keep it up to date. See [[Solr module documentation>>extensions:Extension.Solr Search API]].
Vincent Massol 9.1 166
Marius Dumitru Florea 1.1 167 == Miscellaneous ==
168
Vincent Massol 9.1 169 * It's [[now possible to send Registration emails in HTML>>extensions:Extension.Administration Application||anchor="HRegistration"]] (by default they're sent in plain text). This is achieved by fully supporting any MIME content in the "Validation Email Content" and "Confirmation Email Content" sections of the Registration Administration UI. For example for the "Validation Email Content" field, you could use the following template to send HTML emails:(((
170 {{code language="none"}}
171 #set ($wikiname = $request.serverName)
172 #set ($host = ${request.getRequestURL()})
173 #set ($host = ${host.substring(0, ${host.indexOf('/', ${mathtool.add(${host.indexOf('//')}, 2)})})})
174 Subject: Validate your account on ${wikiname}
175 Content-type: text/html; charset=iso-8859-1
Marius Dumitru Florea 1.1 176
Vincent Massol 9.1 177 <p>Hello <b>${xwiki.getUserName("XWiki.$xwikiname", false)}</b>,</p>
178 <p>This email address was used to register a new account on ${wikiname}. If you did not make the request, please ignore this message.</p>
179 <p>In order to activate your account, please follow this link:
180 ${host}${xwiki.getURL('XWiki.AccountValidation', 'view', "validkey=${validkey}&xwikiname=${xwikiname}")}</p>
181 {{/code}}
182 )))
183 * The selected tree node is now highlighted even when links are enabled:(((
Thomas Mortagne 16.1 184 {{image reference="ReleaseNotesXWiki64M2@highlightSelectedTreeNode.png"/}}
Vincent Massol 9.1 185 )))
186 * A list of icons supported by XWiki have been created, with mapping for Silk and Font Awesome. Which means that we now propose a list of icons that are both present in Silk and Font Awesome.
187 * The list of columns in the UserDirectory customization screen is now sorted alphabetically
188 * The accuracy of the attachment content type detection has been improved. If the file name extension is unknown then we attempt to detect the content type from the first bytes of the file content. You can check this by attaching a text file without the 'txt' file name extension.
189 * Displaying the 'Stable versions' label in an extension's description in Extension Manager before and after the list of versions is retrieved.
190 * A click to the Document Index does not lead to an other space anymore.
191 * [[extensions:Extension.Tag Cloud Macro]] has now a new parameter (spaces) to display a tag cloud from multiple spaces.
192
Thomas Mortagne 28.1 193 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%29+and+status+%3D+Closed+and+resolution+%3D+Fixed+and+fixVersion+%3D+%226.4%22&tempMax=1000]] fixed in this release.
Marius Dumitru Florea 1.1 194
195 = For Developers =
196
Vincent Massol 9.1 197 == Icon Picker ==
Marius Dumitru Florea 1.1 198
Vincent Massol 9.1 199 An [[icon picker>>extensions:Extension.Icon Theme Application||anchor="#HIconPicker"]] has been created to help users selecting an image in the list of supported icons.
Marius Dumitru Florea 1.1 200
Vincent Massol 10.1 201 {{image reference="ReleaseNotesXWiki64M2@icon-picker.png"/}}
Marius Dumitru Florea 1.1 202
Vincent Massol 9.1 203 This picker is already used in [[Application Within Minutes>>extensions:Extension.App Within Minutes Application]] for the application's icon selection.
Marius Dumitru Florea 1.1 204
Vincent Massol 9.1 205 == Skin Extensions ==
206
207 [[Now you can use LESS in your Skin Extensions!>>extensions:Extension.Skin Extension Plugin||anchor="HUseLESS"]]. You just need to set the new property "Content Type" to LESS inside your Skin Extension object:
208
Vincent Massol 10.1 209 {{image reference="ReleaseNotesXWiki64M2@contentTypeLESS.png"/}}.
Vincent Massol 9.1 210
211 == Admin ConfigurableClass ==
212
213 The [[##ConfigurableClass## mechanism>>extensions:Extension.Administration Application||anchor="HMakingyourapplicationconfigurablewithConfigurableClass"]] has been improved to be able to contribute new categories in the Admin UI. For example the "Email" Category in the following screenshot is contributed through a ##ConfigurableClass##:
214
Vincent Massol 10.1 215 {{image reference="ReleaseNotesXWiki64M2@emailcategory.png"/}}
Vincent Massol 9.1 216
217 It was configured using:
218
Vincent Massol 10.1 219 {{image reference="ReleaseNotesXWiki64M2@emailconfigurableclass.png"/}}
Vincent Massol 9.1 220
221 == Velocity changes ==
222
223 === Remove a Velocity Engine from the cache ===
224
225 ##org.xwiki.velocity.VelocityFactory## now provide an API to remove a cached Velocity Engine.
226
227 === Overriding Velocimacros in wiki-based skins ===
228
229 It's now possible to override the ##macros.vm## template in a wiki based skin (object property and attachment). Any modification to this template is also taken into account (the Velocity engine is recreated when the template is modified).
230
231 === Cleanup unprotected namespaces ===
232
233 VelocityEngine automatically get rid of the passed namespace at the end of execution unless it's protected.
234
235 In practice in means that the following:
236
237 {{code language="java"}}
238 engine.evaluate(new VelocityContext(), new StringWriter(), "namespace", "#macro(mymacro)toto#end")
239
240 Writer out = new StringWriter();
241 engine.evaluate(new VelocityContext(), out, "namespace", "#mymacro()")
242
243 System.out.println(out.toString())
244 {{/code}}
245
246 will now print
247
248 {{code language="none"}}
249 #mymacro()
250 {{/code}}
251
252 To get
253
254 {{code language="none"}}
255 toto
256 {{/code}}
257
258 you need the following
259
260 {{code language="java"}}
261 engine.startedUsingMacroNamespace("namespace")
262
263 try {
264 engine.evaluate(new VelocityContext(), new StringWriter(), "namespace", "#macro(mymacro)toto#end")
265
266 Writer out = new StringWriter();
267 engine.evaluate(new VelocityContext(), out, "namespace", "#mymacro()")
268
269 System.out.println(out.toString())
270 } finally {
271 engine.stoppedUsingMacroNamespace("namespace")
272 }
273 {{/code}}
274
275 == Skins system improvements ==
276
277 Support for a new ##skin.properties## configuration file has been introduced in filesystem skins.
278
279 Right now it supports a ##parent## property to indicate another skin to inherit from. If set to an empty value ({{code language="properties"}}parent={{/code}}) the skin will directly inherit from the WAR; if not set at all it will behave as before which means inherit from whatever is configured in ##xwiki.cfg##'s ##xwiki.defaultbaseskin## property.
280
281 == Component Metadata Access ==
282
283 If your Component implementation needs to get access to its component metadata (i.e. its ##ComponentDescriptor##) then it can [[get it injected automatically>>extensions:Extension.Component Module||anchor="HComponentMetadata"]]. For example:
284
285 {{code language="java"}}
286 import org.xwiki.component.descriptor.ComponentDescriptor;
287 ...
288 @Component
289 @Singleton
290 public class MyComponentImpl implements MyComponent
291 {
292 @Inject
293 private ComponentDescriptor<MyComponent> descriptor;
294
295 public void doSomething()
296 {
297 String hint = this.descriptor.getRoleHint();
298 ...
299 }
300 }
301 {{/code}}
302
303 == Panels executed with the rights of their author ==
304
305 It's now possible to write script requiring programming right in panels as long as you have programming right, same as wiki macros.
306
307 == UI extensions executed with the rights of their author ==
308
309 What you can execute in UI extension used to depend on current document author right, it's now based on the own ui extension author.
310
311 == Rendering ==
312
Vincent Massol 10.6 313 XWiki Rendering now provide an HTML5 Renderer.
Vincent Massol 9.1 314
Victor Rachieru 21.1 315 == REST ==
316
317 The REST API for the repository module has been updated to include information about the extension's rating.
318 The information regarding ratings has been included in the AbstractExtension element of the XML Schema, thus it is available in the extension's detailed information and in the search results.
319
320 **More information:**
Manuel Smeria 21.2 321
Victor Rachieru 21.1 322 * [[Repository module documentation>>http://extensions.xwiki.org/xwiki/bin/view/Extension/Repository+Module#HREST]]
323
324 **Example:**
325
326 {{code language="xml"}}
327 <extension>
328 <id>org.xwiki.contrib:application-filemanager-ui</id>
329 <name>File Manager Application</name>
330 <type>xar</type>
331 <!-- start rating info -->
332 <rating>
333 <totalVotes>821</totalVotes>
334 <averageVote>5.0</averageVote>
335 </rating>
336 <!-- end rating info -->
337 <summary>Application to manage a hierarchy of folders and files. It embeds viewers for many known file types, such as office and PDF.</summary>
338 <description>This application lets your organize your files inside XWiki using a tree hierarchy of folders. It supports all standard operations like move, rename, copy, delete on both files and folders. You can use drag & drop to upload new files and to modify the folder hierarchy. A wide range of files types can be viewed or played (in case of audio and video files) directly from the wiki. This includes PDF and office documents [...]</description>
339 <licenses>
340 <name>GNU Lesser General Public License 2.1</name>
341 </licenses>
342 <website>http://extensions.xwiki.org/xwiki/bin/view/Extension/File+Manager+Application</website>
343 <authors>
344 <name>Thomas Delafosse</name>
345 <url>http://www.xwiki.org/xwiki/bin/view/XWiki/tdelafosse</url>
346 </authors>
347 <authors>
348 <name>Ludovic Dubost</name>
349 <url>http://www.xwiki.org/xwiki/bin/view/XWiki/LudovicDubost</url>
350 </authors>
351 <authors>
352 <name>Marius Dumitru Florea</name>
353 <url>http://www.xwiki.org/xwiki/bin/view/XWiki/mflorea</url>
354 </authors>
355 <features>tdelafosse:file-manager-application</features>
356 <features>org.xwiki.contrib:application-filemanager</features>
357 </extension>
358 {{/code}}
359
Marius Dumitru Florea 23.1 360 == Bridging custom XWiki events from Prototype to jQuery ==
361
362 Starting with this version you can catch from jQuery the custom XWiki events that are fired from Prototype.
363
364 {{code language="js"}}
365 require(['jquery', 'xwiki-events-bridge'], function($) {
366 $('.some-element').on('xwiki:moduleName:eventName', function(event, data) {
367 // Here, do something that will be executed at the moment the event is fired.
368 doSomething();
369
370 // The passed data is a reference to the event.memo from Prototype.
371 console.log(data.somethingINeedToKnow);
372 });
373 });
374 {{/code}}
375
376 See the [[JavaScript API documentation>>platform:DevGuide.JavaScriptAPI]] for the list of events that you can listen to.
377
Vincent Massol 9.1 378 == Miscellaneous ==
379
380 * Added new APIs to get all the icon themes present on the wiki, and all icons that these icon themes contain.(((
381 {{code language="velocity"}}
382 $services.icon.getIconSetNames()
383 $services.icon.getIconNames()
384 $services.icon.getIconNames("Font Awesome")
385 {{/code}}
386 )))
387 * A new parameter has been added to the ##get## action and the ##plain## xpage: ##htmlHeaderAndFooter##, which add the HTML headers (##<html>##,##<head>##,##<body>##, etc...) and footers (##</body>##, ##</html>##, etc...). It could be useful to create light popups that display only the document content without any UI.
388 * XWikiAttachment now provide ##setAuthorReference## and ##getAuthorReference## APIs
389 * ##org.xwiki.logging.event.LogEvent## now have a getTimestamp() method returning the number of milliseconds elapsed from 1/1/1970 until logging event was created.
390 * A SOLR-based implementation of the standard REST search resource has been added
391 * The [[Solr Query>>extensions:Extension.Solr Search Query API]] parameter ##xwiki.supportedLocales## has a new default value: the list of supported locales configured for the current wiki (where you execute the search).
392 * The ##{{{@Component}}}## annotation is no longer inheritable. Thus each component implementation class must now define it and not rely on it being present in some Abstract class.
393 * The XWiki build now verifies that all components are correctly listed in ##META-INF/components.txt## files and that the threading model is explicitly defined (i.e. that either ##{{{@Singleton}}}## or ##{{{@InstantiationStrategy(ComponentInstantiationStrategy.PER_LOOKUP)}}}## is used). If not, the build fails. A new ##{{{@Component}}}## annotation parameter has been added for explicitly mentioning that a Component should not be statically registered (these components are usually used in tests). It's used as follows:(((
394 {{code language="java"}}
395 @Component(staticRegistration = false)
396 {{/code}}
397 )))
398 * You can now control in which order the sections added via the [[ConfigurableClass>>extensions:Extension.Administration Application||anchor="HFieldsyoucandefine"]] are displayed in the administration.
399 * New APIs to generate unescaped display user name:
400 ** ##com.xpn.xwiki.XWiki#getPlainUserName(DocumentReference userReference, XWikiContext context)##
401 ** ##com.xpn.xwiki.XWiki#getUserName(DocumentReference userReference, String format, boolean link, boolean escapeXML, XWikiContext context)##
402 ** ##com.xpn.xwiki.api.XWiki#getPlainUserName(DocumentReference userReference)##
403 * New script oriented APIs to get document author/contentAuthor/creator as ##DocumentReference##
Vincent Massol 10.7 404 * It's now possible to provide metadatas to ##MacroContentParser#parse## API
405 * It's now possible to know what namespace a ComponentManager instance is associated with by casting it to ##org.xwiki.component.manager.NamespacedComponentManager##. See [[Component Module documentation>>http://extensions.xwiki.org/xwiki/bin/view/Extension/Component+Module||anchor="HNamespacedComponentManager"]].
406 * Added getCurrentWikiDescriptor() method to the wiki API and script service to be consistent with the existing getCurrentWikiId() method
407 * The ClassLoader automatically set as Thread ClassLoader is now dynamic meaning that any modification of the context wiki will automatically change the actual Thread ClassLoader. It used to be set to whatever was the wiki in the URL at ExecutionContext init.
408 * [[A new CSS class>>platform:DevGuide.SpecialCSSClasses||anchor="HClassesfortheresponsiveness"]] have been added in Flamingo, to handle responsive tables.
409 * The #sheetTitle Velocity macro supports a new use case: displaying the sheet title if the current document doesn't have an object of some type:(((
410 {{code language="none"}}
411 #sheetTitle('The sheet used to display objects of type Space.MyClass', 'Space.MyClass')
412 {{/code}}
413 )))
Vincent Massol 9.1 414
Marius Dumitru Florea 1.1 415 == Upgrades ==
416
417 The following dependencies have been upgraded:
418
Thomas Mortagne 28.1 419 * [[httpclient 4.3.6>>https://jira.xwiki.org/browse/XCOMMONS-681]]
420 * [[commons-codec 1.10>>https://jira.xwiki.org/browse/XCOMMONS-684]]
421 * [[Groovy 2.3.8>>https://jira.xwiki.org/browse/XCOMMONS-704]]
422 * [[JGroups 3.6.1>>https://jira.xwiki.org/browse/XWIKI-11523]]
423 * [[Pygments 2.0.1>>https://jira.xwiki.org/browse/XWIKI-11522]]
424 * [[Joda-Time 2.6>>https://jira.xwiki.org/browse/XWIKI-11516]]
425 * [[Bootstrap 3.3.1>>https://jira.xwiki.org/browse/XWIKI-11381]]
426 * [[Bootswatch 3.3.1+2>>https://jira.xwiki.org/browse/XWIKI-11569]]
427 * [[slf4j 1.7.9>>https://jira.xwiki.org/browse/XCOMMONS-712]]
428 * [[Lucene and SOLR 4.10.3>>https://jira.xwiki.org/browse/XWIKI-11603]]
Marius Dumitru Florea 1.1 429
430 = Translations =
431
432 The following translations have been updated:
433
Vincent Massol 9.1 434 {{language codes="da, de, es, fr, ko, lv, pl, pt_BR, ro, ru, sv, tr"/}}
Marius Dumitru Florea 1.1 435
436 = Tested Browsers & Databases =
437
Manuel Smeria 8.1 438 {{include reference="TestReports.ManualTestReportSummaryXWiki64"/}}
Marius Dumitru Florea 1.1 439
Thomas Mortagne 13.3 440 = Performances tests compared to 5.4.6 =
Marius Dumitru Florea 1.1 441
Thomas Mortagne 14.1 442 Performances improved a bit since 6.3 and we are now generally slightly better than 5.4.6 performances except for the first-loaded page with UI (which incurs the cost of one-time LESS compilation). Lets continue the work in 7.x and improve even more !
Marius Dumitru Florea 1.1 443
Thomas Mortagne 13.3 444 {{display reference="test:Performances.Jetty HSQLDB single wiki 546 to 64" section="HSummary"/}}
Marius Dumitru Florea 1.1 445
Thomas Mortagne 13.3 446 More details on [[performance comparison on single wiki between 6.4 and 5.4.6>>test:Performances.Jetty HSQLDB single wiki 546 to 64]].
447
Marius Dumitru Florea 1.1 448 = Known issues =
449
Thomas Mortagne 28.1 450 * [[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]]
Vincent Massol 15.1 451 * A problem was discovered after the release when trying to start XWiki on Oracle. When you uncomment the Oracle section in the ##hibernate.cfg.xml## file, you'll get a mapping file declared twice, as in:(((
452 {{code language="none"}}
453 <mapping resource="mailsender.hbm.xml"/>
454 <mapping resource="mailsender.oracle.hbm.xml"/>
455 {{/code}}
Marius Dumitru Florea 1.1 456
Vincent Massol 15.1 457 You'll need to remove first to keep only the following:
458
459 {{code language="none"}}
460 <mapping resource="mailsender.oracle.hbm.xml"/>
461 {{/code}}
Thomas Mortagne 16.1 462 )))
Vincent Massol 15.1 463
Marius Dumitru Florea 1.1 464 = Backward Compatibility and Migration Notes =
465
466 == General Notes ==
467
468 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.
469
Vincent Massol 9.1 470 == Issues specific to XWiki 6.4 ==
Marius Dumitru Florea 1.1 471
Vincent Massol 9.1 472 * VelocityEngine automatically get rid of the passed namespace at the end of execution unless it's protected. See [[Velocity section>>||anchor="HVelocitychanges"]].
Thomas Mortagne 28.1 473 * If upgrading the content in the DistributionWizard, and the upgrade is from XWiki 6.2.x or 6.3, you might get a conflict for the document Blog.BlogSheet. Unless you have done modifications to that document, please keep the new version; otherwise please keep the merged, or if not available, keep your version. For details see issue [[XWIKI-11450>>https://jira.xwiki.org/browse/XWIKI-11450]].
Thomas Mortagne 16.1 474 * The way to deal with XWiki SOLR plugin changed and you might have issue starting with an existing embedded SOLR index. The simplest is to delete <permdir>/solr folder and let XWiki reindex the instance.
Marius Dumitru Florea 1.1 475
476 == API Breakages ==
477
Vincent Massol 12.1 478 The following APIs were modified since XWiki 6.3:
Marius Dumitru Florea 1.1 479
Vincent Massol 13.1 480 * Needed to make sure transformations are executed with the right metadata(((
481 {{code language="none"}}
482 org.xwiki.rendering.macro.MacroContentParser: Method 'public org.xwiki.rendering.block.XDOM parse(java.lang.String, org.xwiki.rendering.transformation.MacroTransformationContext, boolean, org.xwiki.rendering.listener.MetaData, boolean)' has been added to an interface
483 {{/code}}
484 )))
485
Vincent Massol 12.1 486 * It's very unlikely that this class is implemented by anything else and it does not make much sense to not have this method, since this is not really a cache behind it but a Map that keep engines forever it may create a memory leak on a big farm running for a long time(((
Marius Dumitru Florea 1.1 487 {{code language="none"}}
Vincent Massol 12.1 488 org.xwiki.velocity.VelocityFactory: Method 'public org.xwiki.velocity.VelocityEngine removeVelocityEngine(java.lang.String)' has been added to an interface
Marius Dumitru Florea 1.1 489 {{/code}}
Vincent Massol 12.1 490 )))
491
492 * This shouldn't be a backward incompatible change since it's a method addition on an Annotation.(((
493 {{code language="none"}}
494 org.xwiki.component.annotation.Component: Method 'public boolean staticRegistration()' has been added to an interface
495 {{/code}}
496 )))
497
498 * Does not make much sense allowing to register a JMX bean and not to unregister it.(((
499 {{code language="none"}}
500 org.xwiki.management.JMXBeanRegistration: Method 'public void unregisterMBean(java.lang.String)' has been added to an interface
501 {{/code}}
502 )))
503
504 * Young API, this method needs to be available for consistency with the getMainWikiDescriptor/Id pair of methods(((
505 {{code language="none"}}
506 org.xwiki.wiki.descriptor.WikiDescriptorManager: Method 'public org.xwiki.wiki.descriptor.WikiDescriptor getCurrentWikiDescriptor()' has been added to an interface
507 {{/code}}
508 )))
509
510 * WYSIWYG's MacroService API was not previously considering a multiwiki environment.(((
511 {{code language="none"}}
512 org.xwiki.gwt.wysiwyg.client.plugin.macro.MacroService: Method 'public org.xwiki.gwt.wysiwyg.client.plugin.macro.MacroDescriptor getMacroDescriptor(java.lang.String, java.lang.String, java.lang.String)' has been added to an interface
513 org.xwiki.gwt.wysiwyg.client.plugin.macro.MacroService: Method 'public java.util.List getMacroDescriptors(java.lang.String, java.lang.String)' has been added to an interface
514 org.xwiki.gwt.wysiwyg.client.plugin.macro.MacroServiceAsync: Method 'public void getMacroDescriptor(java.lang.String, java.lang.String, java.lang.String, com.google.gwt.user.client.rpc.AsyncCallback)' has been added to an interface
515 org.xwiki.gwt.wysiwyg.client.plugin.macro.MacroServiceAsync: Method 'public void getMacroDescriptors(java.lang.String, java.lang.String, com.google.gwt.user.client.rpc.AsyncCallback)' has been added to an interface
516 {{/code}}
517 )))
518
Vincent Massol 13.2 519 * Young API. Add new methods to the Icon Set Module(((
Vincent Massol 12.1 520 {{code language="none"}}
521 org.xwiki.icon.IconManager: Method 'public java.util.List getIconNames()' has been added to an interface
522 org.xwiki.icon.IconManager: Method 'public java.util.List getIconNames(java.lang.String)' has been added to an interface
523 org.xwiki.icon.IconSetManager: Method 'public java.util.List getIconSetNames()' has been added to an interface
524 {{/code}}
525 )))
526
Vincent Massol 13.2 527 * Young API. LESS refactoring.(((
Vincent Massol 12.1 528 {{code language="none"}}
529 org.xwiki.lesscss.LessCompilerScriptService: Method 'public boolean clearCacheFromFileSystemSkin(java.lang.String)' has been removed
530 org.xwiki.lesscss.LessCompilerScriptService: Return type of method 'public org.xwiki.lesscss.ColorTheme getColorThemeFromSkinFile(java.lang.String)' has been changed to org.xwiki.lesscss.colortheme.ColorTheme
531 org.xwiki.lesscss.LessCompilerScriptService: Return type of method 'public org.xwiki.lesscss.ColorTheme getColorThemeFromSkinFile(java.lang.String, java.lang.String)' has been changed to org.xwiki.lesscss.colortheme.ColorTheme
532 org.xwiki.lesscss.ColorTheme: Class org.xwiki.lesscss.ColorTheme removed
533 org.xwiki.lesscss.ColorThemeCache: Class org.xwiki.lesscss.ColorThemeCache removed
534 org.xwiki.lesscss.LESSCache: Class org.xwiki.lesscss.LESSCache removed
535 org.xwiki.lesscss.LESSColorThemeConverter: Class org.xwiki.lesscss.LESSColorThemeConverter removed
536 org.xwiki.lesscss.LESSCompiler: Class org.xwiki.lesscss.LESSCompiler removed
537 org.xwiki.lesscss.LESSCompilerException: Class org.xwiki.lesscss.LESSCompilerException removed
538 org.xwiki.lesscss.LESSSkinFileCache: Class org.xwiki.lesscss.LESSSkinFileCache removed
539 org.xwiki.lesscss.LESSSkinFileCompiler: Class org.xwiki.lesscss.LESSSkinFileCompiler removed
540 {{/code}}
541 )))
542
Vincent Massol 13.2 543 * Young API. Lots of refactoring on the new Mail module(((
Vincent Massol 12.1 544 {{code language="none"}}
545 org.xwiki.mail.MailResultListener: Class org.xwiki.mail.MailResultListener removed
546 org.xwiki.mail.MailSender: Method 'public void send(javax.mail.internet.MimeMessage, javax.mail.Session)' has been removed
547 org.xwiki.mail.MailSender: Parameter 1 of 'public void sendAsynchronously(javax.mail.internet.MimeMessage, javax.mail.Session, org.xwiki.mail.MailResultListener)' has changed its type to java.lang.Iterable
548 org.xwiki.mail.MailSender: Parameter 3 of 'public void sendAsynchronously(javax.mail.internet.MimeMessage, javax.mail.Session, org.xwiki.mail.MailResultListener)' has changed its type to org.xwiki.mail.MailListener
549 org.xwiki.mail.MailSender: Return type of method 'public void sendAsynchronously(javax.mail.internet.MimeMessage, javax.mail.Session, org.xwiki.mail.MailResultListener)' has been changed to org.xwiki.mail.MailResult
550 org.xwiki.mail.MailSender: Method 'public void waitTillSent(long)' has been removed
551 org.xwiki.mail.MailSenderConfiguration: Method 'public java.util.List getBCCAddresses()' has been added to an interface
552 org.xwiki.mail.MailSenderConfiguration: Method 'public java.lang.String getScriptServicePermissionCheckerHint()' has been added to an interface
553 org.xwiki.mail.MailSenderConfiguration: Method 'public long getSendWaitTime()' has been added to an interface
554 org.xwiki.mail.script.MimeMessageWrapper: In method 'public MimeMessageWrapper(org.xwiki.mail.internal.ExtendedMimeMessage, javax.mail.Session, org.xwiki.mail.MailSender, org.xwiki.context.Execution, org.xwiki.component.manager.ComponentManager)' the number of arguments has changed
555 org.xwiki.mail.script.MimeMessageWrapper: Accessibility of method 'public MimeMessageWrapper(org.xwiki.mail.internal.ExtendedMimeMessage, javax.mail.Session, org.xwiki.mail.MailSender, org.xwiki.context.Execution, org.xwiki.component.manager.ComponentManager)' has been decreased from public to package
556 org.xwiki.mail.script.MimeMessageWrapper: Method 'public java.util.concurrent.BlockingQueue getErrors()' has been removed
557 org.xwiki.mail.script.MimeMessageWrapper: Method 'public void send()' has been removed
558 org.xwiki.mail.script.MimeMessageWrapper: Method 'public void sendAsynchronously()' has been removed
559 org.xwiki.mail.script.MimeMessageWrapper: Method 'public void waitTillSent(long)' has been removed
560 {{/code}}
561 )))
562
563 * Switched to the generics-aware commons-collections4.(((
564 {{code language="none"}}
565 com.xpn.xwiki.monitor.api.MonitorPlugin: Return type of method 'public org.apache.commons.collections.buffer.CircularFifoBuffer getLastTimerData()' has been changed to org.apache.commons.collections4.queue.CircularFifoQueue
566 com.xpn.xwiki.monitor.api.MonitorPlugin: Return type of method 'public org.apache.commons.collections.buffer.CircularFifoBuffer getLastUnfinishedTimerData()' has been changed to org.apache.commons.collections4.queue.CircularFifoQueue
567 {{/code}}
568 )))

Get Connected