Skip to Content
Version 8.1 by Sorin Burjan on 2010/10/19
Show last authors
1 = XWiki Enterprise 2.5 Release Notes =
2
3 {{box cssClass="floatinginfobox" title="**Contents**"}}
4 {{toc/}}
5 {{/box}}
6
7 First milestone of the XWiki Enterprise 2.5 version ([[Roadmap>>enterprise:Main.Roadmap]]).
8
9 The highlights of this release are: improvements to action menus, a mechanism for inserting custom links in the header, the introduction of cancelable events and better external search engine indexing support.
10
11 = New and Noteworthy (since XWiki Enterprise 2.4) =
12
13 == Improvements to Action Menus ==
14
15 * New Add menu: Use the "Add" menu to create new spaces, pages, add attachments and comments.(((
16 [[image:AddMenu.png||style="border:1px solid black;"]]
17 )))
18 * Improved Wiki and Space menus: You may now access the document index straight from the wiki & space menus.(((
19 [[image:WikiMenu.png||style="border:1px solid black;"]] [[image:SpaceMenu.png||style="border:1px solid black;"]]
20 )))
21 * New Page menu: Integrates the Watch, Copy, Rename and Delete actions.(((
22 [[image:PageMenu.png||style="border:1px solid black;"]]
23 )))
24 * The Edit, Export, More actions and Profile menus also benefited from a refresh.
25
26 == Mechanism for inserting custom links in the header ==
27
28 As a new part of the [[UI extensions>>dev:Design.InterfaceExtensions]] mechanism, similar to [[skin extensions>>code:Plugins.SkinExtensionsPlugin]], applications can now insert custom ##<link>## elements in the HTML header of the page, which allows to insert, for example:
29 * custom navigational links (universal edit, paged navigation, index, author...)
30 * custom RSS feed links
31 * custom metadata links (DOAP, FOAF, generic RDF...)
32
33 Usage example:
34
35 {{code}}$xwiki.linkx.use($xwiki.getURL('Blog.BlogRss', 'view', "xpage=plain&blog=${blogDoc.fullName}"),
36 {'rel' : 'alternate', 'type' : 'application/rss+xml', 'title' : $title}){{/code}}
37
38 == Introduced cancelable events ==
39
40 This allows to cancel document saving, better security with script execution and canceling an event that has errors on initialization.
41
42 == Better external search engine indexing support ==
43
44 Google search results now always point to canonical view of pages.
45
46 == Visible content menu when scrolling down ==
47
48 [[image:ActionMenu.png||style="border:1px solid black;"]]
49
50 When scrolling down on a document, the content menu will follow, so the user will not have to scroll up on top of the page in order to access it.
51
52 == Introduced [[XWiki Cryptographic Module>>code:Modules.CryptographicModule]] ==
53 This module exposes high level api, allowing developers to bolster their security using cryptography for both integrity and confidentiality.
54 You can find more information about the cryptographic module including examples at the code zone page for the [[XWiki Cryptographic Module>>code:Modules.CryptographicModule]].
55
56 = Known issues =
57
58 = Backward Compatibility and Migration Notes =
59
60 == General Notes ==
61
62 {{warning}}
63 If you're running in a multiwiki setup you'll also need to define the property //xwiki.store.migration.databases=all// to your //xwiki.cfg// file or explicitly name all databases to be migrated as in //xwiki.store.migration.databases=db1,db2,...//.
64 {{/warning}}
65
66 You may also want to [[import the default wiki XAR>>Main.Download]] in order to benefit from the improvements listed above.
67
68 {{warning}}
69 Always make sure you compare your //xwiki.cfg// file with the newest version since some configuration parameters were added. Note 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.
70 {{/warning}}
71
72 == Migration Notes ==
73
74 The main entry point for the search UI is now the Main.Search page that will use the configured search engine (Lucene by default). If you want to refer to Lucene or Database search explicitly you can use the ##Main.LuceneSearch## and ##Main.DatabaseSearch## pages. Note that nothing is broken here (##Main.WebSearch## page is still there and internally it includes the ##Main.DatabaseSearch## page), it's just the new clean way of targeting the search page.
75
76 === Removed deprecated flickr plugin ===
77
78 The old flickr plugin was outdated and the API was broken, so, as a consequence, it has been removed. A new plugin will be available in the future. Meanwhile you can still find it in the contrib-retired at this [[link>>http://svn.xwiki.org/svnroot/xwiki/contrib/retired/plugin-flickr/]].
79
80 === Update your web.xml ===
81
82 Some servlet filters (SetCharacterEncodingFilter, used to handle character encoding and SavedRequestRestorerFilter, used to restore requests on login) were refactored and moved to another package. Make sure you update your //WEB-INF/web.xml// to the current version, otherwise XWiki server will fail to start.
83
84 == API Breakages ==
85
86 The following APIs were modified since XWiki Enterprise 2.4:
87
88 {{code language="none"}}
89 [ERROR] org.xwiki.rendering.transformation.MacroTransformationContext: Method 'public org.xwiki.rendering.internal.transformation.MacroTransformation getMacroTransformation()' has been removed
90 [ERROR] org.xwiki.rendering.transformation.MacroTransformationContext: Method 'public void setMacroTransformation(org.xwiki.rendering.internal.transformation.MacroTransformation)' has been removed
91 [ERROR] org.xwiki.rendering.transformation.Transformation: Method 'public void transform(org.xwiki.rendering.block.Block, org.xwiki.rendering.transformation.TransformationContext)' has been added to an interface
92 [ERROR] org.xwiki.rendering.transformation.TransformationManager: Method 'public void performTransformations(org.xwiki.rendering.block.Block, org.xwiki.rendering.transformation.TransformationContext)' has been added to an interface
93 {{/code}}
94
95
96
97
98 M2
99
100 Second milestone of the XWiki Enterprise 2.5 version ([[Roadmap>>enterprise:Main.Roadmap]]).
101
102 The highlights of this release are: support for [[viewing attached office documents>>code:Macros.OfficeMacro]] in the wiki, an experimental Extension Manager, experimental [[CSRF>>http://en.wikipedia.org/wiki/CSRF]] protection, a new User Directory, further improvements to the edit UI, more consistent [[use of user avatars>>http://incubator.myxwiki.org/xwiki/bin/view/Improvements/Avatars]], support for activating a special accessibility stylesheet, and an experimental ##xwiki/2.1## wiki syntax.
103
104 = New and Noteworthy (since XWiki Enterprise 2.4) =
105
106 == Support for viewing attached office documents in the wiki ==
107
108 XWiki now supports viewing attached office documents without saving them on the client side.
109
110 image:OfficePreview.png
111
112 We also included a new Macro for the WYSIWYG Editor. It allows to embed a office file into a page.
113
114 [[image:MacroOfficeViewer||style="border:1px solid black;"]]
115
116 == Experimental Extension Manager ==
117
118 The new Extension Manager will allow you to install new extensions to your XWiki XE. Please note that this is an experimental feature. Use it at your own risk.
119
120 [[image:ExtensionManager.png||style="border:1px solid black;"]]
121
122 == New User Directory ==
123
124 Added User Directory section on the Quick Links tab on the left of the page. This will show you the users that the XWiki instance has, along with their avatar image. This page also allows to filter users by username.
125 image:userdir.png
126
127 == Further improvements to the edit UI ==
128
129 After the improvements to the object and class editors introduced in 1.8 and 2.4, the wiki and WYSIWYG editors also see some enhancements in this release, bringing in some of the proposed changes from [[an older proposal>>http://incubator.myxwiki.org/xwiki/bin/Improvements/ImprovedEdit]], with some additional improvements. Specifically:
130
131 * A new label for the content area in the wiki editor:(((
132 image:edit-header.png
133 )))
134 * A more descriptive label for the version summary field
135 * Better positioning of the "minor edit" option
136 * Better positioning and display of the "autosave" option(((
137 image:edit-footer.png
138 )))
139
140 == More consistent use of user avatars ==
141
142 As proposed on [[the design page>>http://incubator.myxwiki.org/xwiki/bin/Improvements/Avatars]], avatars come in three default sizes:
143
144 * small avatars, 30px wide, used in secondary actions and where there's very little space available
145 * medium avatars, 50px wide, the preferred and most frequent display option for avatars
146 * large avatars,120px wide, to be used where a large version of the avatar must be displayed (for example in the user profile)
147
148 Accordingly, the wiki dashboard has been changed to use the medium avatars, and as a new feature user avatars are displayed in the comments area.
149
150 image:comment-avatars.png
151
152 Four new velocity macros have been added for making it easier to display avatars:
153
154 * ###smallUserAvatar('XWiki.username')##
155 * ###mediumUserAvatar('XWiki.username')##
156 * ###largeUserAvatar('XWiki.username')##
157 * ###resizedUserAvatar('XWiki.username', 100)## which allows resizing an avatar to a custom size
158
159 == More image manipulation settings ==
160
161 For a long time it was possible to scale attached images on the server, thus reducing the download time and ensuring consistent scaling of images across browsers. This is achieved by appending ##width## and/or ##height## query string parameters to the URL of the image. This feature has been further enhanced:
162
163 * It is now possible to force the same aspect ratio of the original picture even when both width/height parameters were used (the ##keepAspectRatio## parameter). In case the requested width and height don't match the original aspect ratio, the image is resized to fit inside the rectangle defined by the two parameters, i.e. the resized image will not exceed the requested dimensions.
164 * The size of the generated JPGs can be further tweaked by specifying an encoding ##quality## (the configurable default is at 30%, but will be changed to 50% before the final release). This does not affect lossless image formats such as PNG.
165 * The WYSIWYG editor also supports the width and height parameters, setting them as needed when manually resizing the image in the editor.
166
167 {{code language="none"}}
168 /xwiki/bin/download/Spage/Page/logo.jpg?width=1024&height=768&keepAspectRatio=true&quality=0.8
169 {{/code}}
170
171 Note that this does not affect images from the filesystem, which are served directly by the servlet conainer and do not pass through XWiki's image handling code. Also note that in case the image processing triggers any errors, the original image will be sent unchanged, so the requested image dimensions are not guaranteed.
172
173 Example:
174
175 {{code language="html"}}
176 {{velocity}}{{html wiki=false}}
177 <img src="$doc.getAttachmentURL('mw.jpg', 'download', 'width=150&quality=1')"/>
178 <img src="$doc.getAttachmentURL('mw.jpg', 'download', 'width=150')"/>
179 <img src="$doc.getAttachmentURL('mw.jpg', 'download', 'width=150&quality=0')"/>
180 <img src="$doc.getAttachmentURL('mw.jpg', 'download', 'width=150&height=100&quality=0.7')"/>
181 <img src="$doc.getAttachmentURL('mw.jpg', 'download', 'width=150&height=100&quality=0.7&keepAspectRatio=true')"/>
182 {{/html}}{{/velocity}}
183 {{/code}}
184
185 Gives:
186
187 image:img.png
188
189 == Better handling of attachment versions when rolling back documents ==
190
191 Rolling back a document will also roll back the correct attachment version, including restoring a deleted attachment from the trash (if not manually deleted from there). Even if an attachment was deleted and re-uploaded several times, the platform will try to find the right version for the attachment, if it still exists in the attachment trash. As an improvement, if the attachment did not change, then a new version is not created.
192
193 == Preliminary optional accessibility stylesheet ==
194
195 Moving further on the quest for better accessibility in the XWiki platform, we introduced a preliminary stylesheet which makes the skin slightly more accessible to people with visual disabilities: bigger fonts by default, and underlined links to make them more easily distinguished by colorblind people. This stylesheet can either be activated globally in a wiki, or individually from each user's preferences.
196
197 Enabling the special stylesheet:
198
199 image:a11y-enable.png
200
201 Bigger fonts and underlined links:
202
203 image:a11y.png
204
205 == Experimental xwiki/2.1 wiki syntax ==
206
207 The xwiki wiki syntax sees further improvements as xwiki/2.1, still in an experimental stage. A new feature is an enhanced syntax for links, which is more generic and allows easier extensions with new link types, demonstrated in this release with support for path and [[interwiki links>>http://en.wikipedia.org/wiki/Interwiki_links]].
208
209 Basic syntax:
210
211 {{code language="none"}}
212 [[label>>referenceType:referenceData]]
213 {{/code}}
214
215 Special ##queryString## and ##anchor## parameters which will be used as the query string, respectively anchor when forming URLs.
216
217 {{code language="none"}}
218 [[label>>doc:My.Page||queryString="a=b&c=d" anchor="HSection1"]]
219 {{/code}}
220
221 Document references are still the implicit default, with the explicit ##doc:## reference type. The other standard reference types are ##url##, ##path##, ##mailto##, ##attach##, ##image##, ##interwiki##.
222
223 Path links allow to link to a relative path on the server, which makes it easier to combine wiki syntax and velocity code, using ##$doc.getURL##, in order to link to non-view actions on documents.
224
225 {{code language="none"}}
226 {{velocity}}[[reset the history>>path:$doc.getURL('reset')||queryString="confirm=1"]]{{/velocity}}
227 {{/code}}
228
229 === [[Interwiki links>>http://en.wikipedia.org/wiki/Interwiki_links]] ===
230
231 Basic syntax:
232
233 {{code language="none"}}
234 [[label>>interwiki:wikiAlias:path/data]]
235 [[Interwiki links>>interwiki:wikipedia:Interwiki_links]]
236 {{/code}}
237
238 By default no sister wikis are defined. You can define some in ##xwiki.properties## by adding ##rendering.interWikiDefinitions## values:
239
240 {{code language="none"}}
241 rendering.interWikiDefinitions = wikipedia = http://en.wikipedia.org/wiki/
242 rendering.interWikiDefinitions = udic = http://www.urbandictionary.com/define.php?term=
243 {{/code}}
244
245 == Various Security improvements ==
246
247 Continuing a push for better security started this summer, 2.5M2 fixes some of the few remaining cross-site scripting and SQL injections holes, and tightens the scope of programming rights. Of particular concern:
248
249 * With a default skin, programming rights are no longer available after the main content of the page; this means that the panels and the bottom tabs can't use restricted APIs anymore.
250 * To explicitly drop programming rights, a new API method was introduced: ##$xcontext.dropPermissions()##
251 * An experimental Cross-Site Request Forgery prevention mechanism is included, though not enabled by default. To enable it and test/upgrade your custom applications for compatibility, edit ##xwiki.properties## and flip on the ##core.csrf.enabled## setting.
252
253 = Backward Compatibility and Migration Notes =
254
255 == General Notes ==
256
257 {{warning}}
258 If you're running in a multiwiki setup you'll also need to define the property //xwiki.store.migration.databases=all// to your //xwiki.cfg// file or explicitly name all databases to be migrated as in //xwiki.store.migration.databases=db1,db2,...//.
259 {{/warning}}
260
261 You may also want to [[import the default wiki XAR>>Main.Download]] in order to benefit from the improvements listed above.
262
263 {{warning}}
264 Always make sure you compare your //xwiki.cfg// file with the newest version since some configuration parameters were added. Note 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.
265 {{/warning}}
266
267 {{warning}}
268 Experimental support for CSRF protection is included in this release, although not enabled by default. This mechanism changes the way data is supposed to be saved, a change which will not completely break custom applications in most cases, but which might insert an extra validation step needed for actually saving the data.
269 {{/warning}}
270
271 It is **strongly recommended** to set up a testing/development environment, enable this feature and fully test all the code. In most cases things should work with no additional changes. If the default edit mode is not used, or if the default velocity templates are not used, it should be enough to add the following line:
272
273 {{code language="html"}}
274 <input type="hidden" name="form_token" value="$!{services.csrf.getToken()}" />
275 {{/code}}
276
277 == API Breakages ==
278
279 The following APIs were modified since XWiki Enterprise 2.4:
280
281 {{code language="none"}}
282 [ERROR] org.xwiki.rendering.transformation.MacroTransformationContext: Method 'public org.xwiki.rendering.internal.transformation.MacroTransformation getMacroTransformation()' has been removed
283 [ERROR] org.xwiki.rendering.transformation.MacroTransformationContext: Method 'public void setMacroTransformation(org.xwiki.rendering.internal.transformation.MacroTransformation)' has been removed
284 [ERROR] org.xwiki.rendering.transformation.Transformation: Method 'public void transform(org.xwiki.rendering.block.Block, org.xwiki.rendering.transformation.TransformationContext)' has been added to an interface
285 [ERROR] org.xwiki.rendering.transformation.TransformationManager: Method 'public void performTransformations(org.xwiki.rendering.block.Block, org.xwiki.rendering.transformation.TransformationContext)' has been added to an interface
286 {{/code}}
287
288
289 RC1
290
291
292 First and hopefully last release candidate of the XWiki Enterprise 2.5 version ([[Roadmap>>enterprise:Main.Roadmap]]).
293
294 This is mostly a bugfixing release before the 2.5 final.
295
296 = New and Noteworthy (since XWiki Enterprise 2.5 Milestone 2) =
297
298 == New features ==
299
300 New macros for the Space List and Tag Cloud; display user avatars in annotations.
301
302 image:annotation-avatars.png
303
304 == Improvements to the Extension Manager ==
305
306 Nicer URLs displayed for extensions, core extensions are also shown, fixed missing translations, provided script access to extensions.
307
308 == Improvements to the User Directory ==
309
310 New avatar for subgroups, better UI, fixed a broken link.
311
312 image:group-avatar.png
313
314 == WYSIWYG and Rendering improvements ==
315
316 Display macro parameter names instead of IDs, generalized the syntax for links, added support for query string for image links, fixed a random error when loading several WYSIWYG instances in parallel.
317
318 == Performance improvements ==
319
320 Fixed a performance issue with the Jump To Page feature.
321
322 == Security improvements ==
323
324 Fixed a few XSS bugs, fixed a broken check on rights from the Rest system, fixed a missing author update when editing classes.
325
326 == Translations ==
327
328 * All the translations have been updated
329
330 = Known issues =
331
332 * [[Bugs we know about>>http://jira.xwiki.org/jira/secure/IssueNavigator.jspa?reset=true&&type=1&pid=10010&resolution=-1&sorter/field=updated&sorter/order=DESC]]
333
334 = Backward Compatibility and Migration Notes =
335
336 == General Notes ==
337
338 {{warning}}
339 If you're running in a multiwiki setup you'll also need to define the property //xwiki.store.migration.databases=all// to your //xwiki.cfg// file or explicitly name all databases to be migrated as in //xwiki.store.migration.databases=db1,db2,...//.
340 {{/warning}}
341
342 You may also want to [[import the default wiki XAR>>Main.Download]] in order to benefit from the improvements listed above.
343
344 {{warning}}
345 Always make sure you compare your //xwiki.cfg// file with the newest version since some configuration parameters were added. Note 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.
346 {{/warning}}
347
348
349
350
351
352
353
354
355
356
357
358
359
360 {{box cssClass="floatinginfobox" title="**Contents**"}}
361 {{toc/}}
362 {{/box}}
363
364 = New and Noteworthy =
365
366 = Known issues =
367
368 * [[Bugs we know about>>http://jira.xwiki.org/jira/secure/IssueNavigator.jspa?reset=true&jqlQuery=category+in+%28%22XWiki.org+Top+Level+Projects%22%2C+%22XWiki+Plugins%2C+Applications+%26+Skins%22%29+AND+issuetype+%3D+Bug+AND+resolution+%3D+Unresolved+ORDER+BY+updated+DESC]]
369
370 = Backward Compatibility and Migration Notes =
371
372 == Important non-compatible changes ==
373
374 == General Notes ==
375
376 {{warning}}
377 Always make sure you compare your ##xwiki.cfg## file with the newest version since some configuration parameters were added. Note 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.
378 {{/warning}}

About

About

Support

Platform

User Guide

Admin Guide

Developer Guide

Projects

XWiki

Extensions

Other

Contribute

Status

Practices

Under the Hood

Get Involved

Get Connected