Skip to Content

Version 17.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 == Highlight ==
8
9 The highlights of this release are:
10
11 * improvements to action menus
12 * a mechanism for inserting custom links in the header
13 * the introduction of cancelable events
14 * better external search engine indexing support.
15 * support for [[viewing attached office documents>>http://code.xwiki.org/xwiki/bin/view/Macros/OfficeMacro]] in the wiki
16 * an experimental Extension Manager
17 * experimental [[CSRF>>http://en.wikipedia.org/wiki/CSRF]] protection
18 * a new User Directory
19 * further improvements to the edit UI
20 * more consistent [[use of user avatars>>http://incubator.myxwiki.org/xwiki/bin/view/Improvements/Avatars]]
21 * support for activating a special accessibility stylesheet
22 * an experimental ##xwiki/2.1## wiki syntax.
23
24 == Improvements to Action Menus ==
25
26 * New Add menu: Use the "Add" menu to create new spaces, pages, add attachments and comments.(((
27 [[image:AddMenu.png||style="border: 1px solid black;"]]
28 )))
29 * Improved Wiki and Space menus: You may now access the document index straight from the wiki & space menus.(((
30 [[image:WikiMenu.png||style="border: 1px solid black;"]] [[image:SpaceMenu.png||style="border: 1px solid black;"]]
31 )))
32 * New Page menu: Integrates the Watch, Copy, Rename and Delete actions.(((
33 [[image:PageMenu.png||style="border: 1px solid black;"]]
34 )))
35 * The Edit, Export, More actions and Profile menus also benefited from a refresh.
36
37 == Mechanism for inserting custom links in the header ==
38
39 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:
40
41 * custom navigational links (universal edit, paged navigation, index, author...)
42 * custom RSS feed links
43 * custom metadata links (DOAP, FOAF, generic RDF...)
44
45 Usage example:
46
47 {{code}}
48 $xwiki.linkx.use($xwiki.getURL('Blog.BlogRss', 'view', "xpage=plain&blog=${blogDoc.fullName}"),
49 {'rel' : 'alternate', 'type' : 'application/rss+xml', 'title' : $title})
50 {{/code}}
51
52 == Introduced cancelable events ==
53
54 This allows to cancel document saving, better security with script execution and canceling an event that has errors on initialization.
55
56 == Better external search engine indexing support ==
57
58 Google search results now always point to canonical view of pages.
59
60 == Visible content menu when scrolling down ==
61
62 [[image:ActionMenu.png||style="border: 1px solid black;"]]
63
64 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.
65
66 == Introduced [[XWiki Cryptographic Module>>code:Modules.CryptographicModule]] ==
67
68 This module exposes high level api, allowing developers to bolster their security using cryptography for both integrity and confidentiality.
69 You can find more information about the cryptographic module including examples at the code zone page for the [[XWiki Cryptographic Module>>code:Modules.CryptographicModule]].
70
71 == Support for viewing attached office documents in the wiki ==
72
73 XWiki now supports viewing attached office documents without saving them on the client side.
74
75 image:OfficePreview.png
76
77 We also included a new Macro for the WYSIWYG Editor. It allows to embed a office file into a page.
78
79 [[image:MacroOfficeViewer||style="border: 1px solid black;"]]
80
81 == Experimental Extension Manager ==
82
83 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.
84
85 * nicer URL's displayed for extensions
86 * core extensions are also shown
87 * fixed missing translations
88 * provided script access to extensions.
89
90 [[image:ExtensionManager.png||style="border: 1px solid black;"]]
91
92 == New User Directory ==
93
94 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.
95
96 image:../../download/Main/ReleaseNotesXWikiEnterprise25/group%2Davatar.png
97
98 \\
99
100 == Further improvements to the edit UI ==
101
102 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:
103
104 * A new label for the content area in the wiki editor:(((
105 image:edit-header.png
106 )))
107 * A more descriptive label for the version summary field
108 * Better positioning of the "minor edit" option
109 * Better positioning and display of the "autosave" option(((
110 image:edit-footer.png
111 )))
112
113 == More consistent use of user avatars ==
114
115 As proposed on [[the design page>>http://incubator.myxwiki.org/xwiki/bin/Improvements/Avatars]], avatars come in three default sizes:
116
117 * small avatars, 30px wide, used in secondary actions and where there's very little space available
118 * medium avatars, 50px wide, the preferred and most frequent display option for avatars
119 * large avatars,120px wide, to be used where a large version of the avatar must be displayed (for example in the user profile)
120
121 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.
122
123 image:comment-avatars.png
124
125 Four new velocity macros have been added for making it easier to display avatars:
126
127 * ###smallUserAvatar('XWiki.username')##
128 * ###mediumUserAvatar('XWiki.username')##
129 * ###largeUserAvatar('XWiki.username')##
130 * ###resizedUserAvatar('XWiki.username', 100)## which allows resizing an avatar to a custom size
131
132 == More image manipulation settings ==
133
134 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:
135
136 * 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.
137 * 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.
138 * The WYSIWYG editor also supports the width and height parameters, setting them as needed when manually resizing the image in the editor.
139
140 {{code language="none"}}
141 /xwiki/bin/download/Spage/Page/logo.jpg?width=1024&height=768&keepAspectRatio=true&quality=0.8
142 {{/code}}
143
144 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.
145
146 Example:
147
148 {{code language="html"}}
149 {{velocity}}{{html wiki=false}}
150 <img src="$doc.getAttachmentURL('mw.jpg', 'download', 'width=150&quality=1')"/>
151 <img src="$doc.getAttachmentURL('mw.jpg', 'download', 'width=150')"/>
152 <img src="$doc.getAttachmentURL('mw.jpg', 'download', 'width=150&quality=0')"/>
153 <img src="$doc.getAttachmentURL('mw.jpg', 'download', 'width=150&height=100&quality=0.7')"/>
154 <img src="$doc.getAttachmentURL('mw.jpg', 'download', 'width=150&height=100&quality=0.7&keepAspectRatio=true')"/>
155 {{/html}}{{/velocity}}
156 {{/code}}
157
158 Gives:
159
160 image:img.png
161
162 == Better handling of attachment versions when rolling back documents ==
163
164 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.
165
166 == Preliminary optional accessibility stylesheet ==
167
168 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.
169
170 Enabling the special stylesheet:
171
172 image:a11y-enable.png
173
174 Bigger fonts and underlined links:
175
176 image:a11y.png
177
178 == Experimental xwiki/2.1 wiki syntax ==
179
180 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]].
181
182 Basic syntax:
183
184 {{code language="none"}}
185 [[label>>referenceType:referenceData]]
186 {{/code}}
187
188 Special ##queryString## and ##anchor## parameters which will be used as the query string, respectively anchor when forming URLs.
189
190 {{code language="none"}}
191 [[label>>doc:My.Page||queryString="a=b&c=d" anchor="HSection1"]]
192 {{/code}}
193
194 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##.
195
196 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.
197
198 {{code language="none"}}
199 {{velocity}}[[reset the history>>path:$doc.getURL('reset')||queryString="confirm=1"]]{{/velocity}}
200 {{/code}}
201
202 === [[Interwiki links>>http://en.wikipedia.org/wiki/Interwiki_links]] ===
203
204 Basic syntax:
205
206 {{code language="none"}}
207 [[label>>interwiki:wikiAlias:path/data]]
208 [[Interwiki links>>interwiki:wikipedia:Interwiki_links]]
209 {{/code}}
210
211 By default no sister wikis are defined. You can define some in ##xwiki.properties## by adding ##rendering.interWikiDefinitions## values:
212
213 {{code language="none"}}
214 rendering.interWikiDefinitions = wikipedia = http://en.wikipedia.org/wiki/
215 rendering.interWikiDefinitions = udic = http://www.urbandictionary.com/define.php?term=
216 {{/code}}
217
218 == Various Security improvements ==
219
220 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:
221
222 * 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.
223 * To explicitly drop programming rights, a new API method was introduced: ##$xcontext.dropPermissions()##
224 * 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.
225
226 == New macros for the Space List and Tag Cloud ==
227
228
229 == Display user avatars in annotations. ==
230
231 image:annotation-avatars.png
232
233 \\
234
235 == WYSIWYG and Rendering improvements ==
236
237 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.
238
239 == Performance improvements ==
240
241 Fixed a performance issue with the Jump To Page feature.
242
243 == Security improvements ==
244
245 Fixed a few XSS bugs, fixed a broken check on rights from the Rest system, fixed a missing author update when editing classes.
246
247 == Translations ==
248
249 * All the translations have been updated
250
251 = Known issues =
252
253 * [[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]]
254
255 = Backward Compatibility and Migration Notes =
256
257 == General Notes ==
258
259 {{warning}}
260 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,...//.
261 {{/warning}}
262
263 You may also want to [[import the default wiki XAR>>Main.Download]] in order to benefit from the improvements listed above.
264
265 (% class="macro-output" style="display: block;" %)
266 (((
267 (% class="box warningmessage" %)
268 (((
269 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.
270 )))
271 )))
272
273 (% class="macro-output" style="display: block;" %)
274 (((
275 (% class="box warningmessage" %)
276 (((
277 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.
278 )))
279 )))
280
281 == Migration Notes ==
282
283 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.
284
285 === Removed deprecated flickr plugin ===
286
287 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/]].
288
289 === Update your web.xml ===
290
291 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.
292
293 == API Breakages ==
294
295 The following APIs were modified since XWiki Enterprise 2.4:
296
297 {{code language="none"}}
298 [ERROR] org.xwiki.rendering.transformation.MacroTransformationContext: Method 'public org.xwiki.rendering.internal.transformation.MacroTransformation getMacroTransformation()' has been removed
299 [ERROR] org.xwiki.rendering.transformation.MacroTransformationContext: Method 'public void setMacroTransformation(org.xwiki.rendering.internal.transformation.MacroTransformation)' has been removed
300 [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
301 [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
302 {{/code}}
303
304 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:
305
306 {{code language="html"}}
307 <input type="hidden" name="form_token" value="$!{services.csrf.getToken()}" />
308 {{/code}}

About

About

Support

Platform

User Guide

Admin Guide

Developer Guide

Projects

XWiki

Extensions

Other

Contribute

Status

Practices

Under the Hood

Get Involved

Get Connected