Skip to Content

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