Skip to Content

Version 23.1 by Vincent Massol on 2014/09/24
Show last authors
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
7 <insert description of release here>
8
9 = New and Noteworthy (since XWiki 6.2) =
10
11 [[Full list of issues fixed and Dashboard for <version>>>http://jira.xwiki.org/secure/Dashboard.jspa?selectPageId=<fill id here>]].
12
13 == Extension Manager and Repository improvements ==
14
15 * ##<scm>## element from Maven ##pom.xml## is now supported and has been added to the standard in the API
16 * ##<issueManagement>## element from Maven ##pom.xml## is now supported and has been added to the standard in the API
17
18 == Flamingo ==
19
20 * The "Add" button has now a default action to create a new page. You can still create other kind of contents (Wiki, Space) by using the arrow, just like we do with the different "edit" actions.(((
21 {{image reference="flamingo-add.png"/}}
22 )))
23
24 == Miscellaneous ==
25
26 * Improved L&F when a template fails to render:(((
27 {{image reference="templateerror.png" width="650px"/}}
28 )))
29 * We have created dedicated groups for Colibri and Flamingo Themes inside the Administration. Every themes can be used with both skins but they looks better when they are used with the corresponding theme.(((
30 {{image reference="ColorThemeDisplayer.png"/}}
31 )))
32 * The start/stop shell scripts provided with the Standalone Distribution have been improved to display usage information when an invalid parameter is passed or when the ##-h## or ##-~-help## parameters are passed. Also note that the start script doesn't stop anymore a running XWiki instance if the ##-k## or ##-~-kill## parameter is passed (this parameter has been removed).
33
34 See the [[full list of JIRA issues>>http://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+%22<version>%22&tempMax=1000]] fixed in this release.
35
36 = For Developers =
37
38 == Velocity macros to display users and groups ==
39
40 We extracted the code that displays in view mode a property of type 'List of Users' and 'List of Groups' from the corresponding custom displayers (found in ##displayer_users.vm## and ##displayer_groups.vm##) into two Velocity macros that can be used to display arbitrary users and groups, even when you don't have an object. Here's how you can use them:
41
42 {{code language="none"}}
43 {{velocity}}
44 {{html wiki="true"}}
45 = Users =
46 == Just one ==
47 #displayUser('XWiki.Admin')
48
49 == List of users ==
50 #displayUser(['Admin', 'XWiki.mflorea'])
51
52 == A reference of a user ==
53 #displayUser($xcontext.userReference)
54
55 == A list of references of users ==
56 #displayUser([$xcontext.userReference, $otherUserReference])
57
58 = Groups =
59 == Just one ==
60 #displayGroup('XWiki.XWikiAdminGroup')
61
62 == List of groups ==
63 #displayGroup(['XWikiAdminGroup','XWiki.HRGroup'])
64
65 == A reference of a group ==
66 #set($adminGroupRef = $services.model.resolveDocument('XWiki.XWikiAdminGroup'))
67 #set($allGroupRef = $services.model.resolveDocument('XWiki.XWikiAllGroup'))
68 #displayGroup($adminGroupRef)
69
70 == A list of references of groups ==
71 #displayGroup([$adminGroupRef, $allGroupRef])
72
73 {{/html}}
74 {{/velocity}}
75 {{/code}}
76
77 == New Velocity Tools ==
78
79 * New URL Tool ##$urltool##: A [[new tool>>extensions:Extension.Velocity Module||anchor="HVelocityTools"]] has been added with one method to parse query string from the URL ##$urltool.parseQuery(String)##. The value returned by this is method is a ##Map<String, List<String>>## which maps parameter names to (possibly multiple) values, and can be passed e.g. directly into ##$escapetool.url(Map<String, ?>)## to convert it back to a string. This is useful e.g. in cases where one want to pass a complete query string around between requests, as it happend for the PDF export; the ##$urltool## allows for a sane deserialization of the value passed around.
80 * New Exception Tool ##$exceptiontool##: A [[new tool>>extensions:Extension.Velocity Module||anchor="HVelocityTools"]] to manipulate Java Exceptions (get root cause, convert into String, etc).
81
82 == Ability to catch Exceptions from Velocity ==
83
84 A new Velocity Directive has been added to catch Exceptions from Velocity. In addition a new ###displayException()## velocity macro has also been added to nicely display an exception to the user.
85
86 For example:
87
88 {{code language="velocity"}}
89 #try()
90 #set($outputSyntax = $xwiki.getAvailableRendererSyntax($request.outputSyntax, $request.outputSyntaxVersion))
91 #if ($outputSyntax)
92 ## If the passed syntax is not an HTML-compatible syntax we need to HTML-escape it so that it can be
93 ## displayed fine in HTML (since at the point this vm file is called we're already inside an HTML page with
94 ## panels on the side, header, etc).
95 #set($syntaxType = $outputSyntax.type.toIdString())
96 #if (($syntaxType == "xhtml") || ($syntaxType == "html"))
97 #set ($renderedContent = $tdoc.getRenderedContent($outputSyntax))
98 #else
99 ## Make sure to print correctly the result when it's not HTML
100 #set ($renderedContent = "<pre>$escapetool.html($tdoc.getRenderedContent($outputSyntax))</pre>")
101 #end
102 #else
103 #set ($renderedContent = $tdoc.getRenderedContent())
104 #end
105 #end
106 ...
107 <div id="xwikicontent">
108 #if ("$!exception" != '')
109 #displayException($exception)
110 #else
111 $renderedContent
112 #end
113 </div>
114 ...
115 {{/code}}
116
117 This generates the following in case of error rendering the page:
118
119 {{image reference="renderingerror.png"/}}
120
121 == Component Disposal ==
122
123 The order used by the ComponentManager to dispose its components is computed based on declared dependencies. However there might be cases when you wish a Component's ##dispose()## method to be called before or after all other components. In this case you can use the ##DisposePriority## annotation. The default priority is 1000. A higher value will mean disposing before all other components not having this annotation. For example:
124
125 {{code language="java"}}
126 @Component
127 @Singleton
128 @DisposePriority(10000)
129 public class DefaultHibernateSessionFactory implements HibernateSessionFactory, Disposable
130 {
131 ...
132 @Override
133 public void dispose() throws ComponentLifecycleException
134 {
135 ... called after other components in order to shut down the database late...
136 }
137 ...
138 }
139 {{/code}}
140
141 See the [[Component Reference documentation>>extensions:Extension.Component Module]] for other details.
142
143 == Deprecated and Retired projects ==
144
145 <description of deprecated and retired projects>
146
147 == Upgrades ==
148
149 The following dependencies have been upgraded:
150
151 * [[JGroups 3.5.0>>http://jira.xwiki.org/browse/XWIKI-10987]]
152 * [[Tika 1.6>>http://jira.xwiki.org/browse/XWIKI-10956]]
153
154 == Miscellaneous ==
155
156 * The wiki provisioning job has now the current user setted in the context.
157
158 = Translations =
159
160 The following translations have been updated:
161
162 {{language codes="none, none"/}}
163
164 = Tested Browsers & Databases =
165
166 {{include reference="TestReports.ManualTestReportTemplateSummary"/}}
167
168 = Known issues =
169
170 * [[Bugs we know about>>http://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]]
171
172 = Backward Compatibility and Migration Notes =
173
174 == General Notes ==
175
176 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.
177
178 == Issues specific to XWiki <version> ==
179
180 <issues specific to the project>
181
182 == API Breakages ==
183
184 The following APIs were modified since <project> <version - 1>:
185
186 {{code language="none"}}
187 <clirr output here>
188 {{/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