Version 36.1 by Sergiu Dumitriu on 2010/10/04

Show last authors
1 {{box cssClass="floatinginfobox" title="**Contents**"}}
2 {{toc/}}
3 {{/box}}
4
5 Second milestone of the XWiki Enterprise 2.5 version ([[Roadmap>>enterprise:Main.Roadmap]]).
6
7 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.
8
9 = New and Noteworthy (since XWiki Enterprise 2.4) =
10
11 == Support for viewing attached office documents in the wiki ==
12
13 == Experimental Extension Manager ==
14
15 == New User Directory ==
16
17 image:userdir.png
18
19 == Further improvements to the edit UI ==
20
21 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:
22
23 * A new label for the content area in the wiki editor:(((
24 image:edit-header.png
25 )))
26 * A more descriptive label for the version summary field
27 * Better positioning of the "minor edit" option
28 * Better positioning and display of the "autosave" option(((
29 image:edit-footer.png
30 )))
31
32 == More consistent use of user avatars ==
33
34 As proposed on [[the design page>>http://incubator.myxwiki.org/xwiki/bin/Improvements/Avatars]], avatars come in three default sizes:
35
36 * small avatars, 30px wide, used in secondary actions and where there's very little space available
37 * medium avatars, 50px wide, the preferred and most frequent display option for avatars
38 * large avatars,120px wide, to be used where a large version of the avatar must be displayed (for example in the user profile)
39
40 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.
41
42 image:comment-avatars.png
43
44 Four new velocity macros have been added for making it easier to display avatars:
45
46 * ###smallUserAvatar('XWiki.username')##
47 * ###mediumUserAvatar('XWiki.username')##
48 * ###largeUserAvatar('XWiki.username')##
49 * ###resizedUserAvatar('XWiki.username', 100)## which allows resizing an avatar to a custom size
50
51 == More image manipulation settings ==
52
53 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:
54
55 * 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.
56 * 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.
57 * The WYSIWYG editor also supports the width and height parameters, setting them as needed when manually resizing the image in the editor.
58
59 {{code language="none"}}/xwiki/bin/download/Spage/Page/logo.jpg?width=1024&height=768&keepAspectRatio=true&quality=0.8{{/code}}
60
61 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.
62
63 Example:
64
65 {{code language="html"}}
66 {{velocity}}{{html wiki=false}}
67 <img src="$doc.getAttachmentURL('mw.jpg', 'download', 'width=150&quality=1')"/>
68 <img src="$doc.getAttachmentURL('mw.jpg', 'download', 'width=150')"/>
69 <img src="$doc.getAttachmentURL('mw.jpg', 'download', 'width=150&quality=0')"/>
70 <img src="$doc.getAttachmentURL('mw.jpg', 'download', 'width=150&height=100&quality=0.7')"/>
71 <img src="$doc.getAttachmentURL('mw.jpg', 'download', 'width=150&height=100&quality=0.7&keepAspectRatio=true')"/>
72 {{/html}}{{/velocity}}
73 {{/code}}
74
75 Gives:
76
77 image:img.png
78
79 == Better handling of attachment versions when rolling back documents ==
80
81 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.
82
83 == Preliminary optional accessibility stylesheet ==
84
85 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.
86
87 Enabling the special stylesheet:
88
89 image:a11y-enable.png
90
91 Bigger fonts and underlined links:
92
93 image:a11y.png
94
95 == Experimental xwiki/2.1 wiki syntax ==
96
97 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]].
98
99 Basic syntax:
100
101 {{code language="none"}}[[label>>referenceType:referenceData]]{{/code}}
102
103 Special ##queryString## and ##anchor## parameters which will be used as the query string, respectively anchor when forming URLs.
104
105 {{code language="none"}}[[label>>doc:My.Page||queryString="a=b&c=d" anchor="HSection1"]]{{/code}}
106
107 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##.
108
109 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.
110
111 {{code language="none"}}{{velocity}}[[reset the history>>path:$doc.getURL('reset')||queryString="confirm=1"]]{{/velocity}}{{/code}}
112
113 === [[Interwiki links>>http://en.wikipedia.org/wiki/Interwiki_links]] ===
114
115 Basic syntax:
116
117 {{code language="none"}}
118 [[label>>interwiki:wikiAlias:path/data]]
119 [[Interwiki links>>interwiki:wikipedia:Interwiki_links]]
120 {{/code}}
121
122 By default no sister wikis are defined. You can define some in ##xwiki.properties## by adding ##rendering.interWikiDefinitions## values:
123
124 {{code language="none"}}
125 rendering.interWikiDefinitions = wikipedia = http://en.wikipedia.org/wiki/
126 rendering.interWikiDefinitions = udic = http://www.urbandictionary.com/define.php?term=
127 {{/code}}
128
129 == Various Security improvements ==
130
131 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:
132
133 * 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.
134 * To explicitly drop programming rights, a new API method was introduced: ##$xcontext.dropPermissions()##
135 * 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.
136
137 = Backward Compatibility and Migration Notes =
138
139 == General Notes ==
140
141 {{warning}}
142 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,...//.
143 {{/warning}}
144
145 You may also want to [[import the default wiki XAR>>Main.Download]] in order to benefit from the improvements listed above.
146
147 {{warning}}
148 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.
149 {{/warning}}
150
151 {{warning}}
152 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.{{/warning}}
153
154 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:
155
156 {{code language="html"}}<input type="hidden" name="form_token" value="$!{services.csrf.getToken()}" />{{/code}}
157
158 == API Breakages ==
159
160 The following APIs were modified since XWiki Enterprise 2.4:
161
162 {{code language="none"}}
163 [ERROR] org.xwiki.rendering.transformation.MacroTransformationContext: Method 'public org.xwiki.rendering.internal.transformation.MacroTransformation getMacroTransformation()' has been removed
164 [ERROR] org.xwiki.rendering.transformation.MacroTransformationContext: Method 'public void setMacroTransformation(org.xwiki.rendering.internal.transformation.MacroTransformation)' has been removed
165 [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
166 [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
167 {{/code}}

Get Connected