Skip to Content

Version 17.1 by Thomas Mortagne on 2014/11/18
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.3) =
10
11 [[Full list of issues fixed and Dashboard for <version>>>http://jira.xwiki.org/secure/Dashboard.jspa?selectPageId=<fill id here>]].
12
13 == Miscellaneous ==
14
15 <insert misc user stuff and important bug fix descriptions here in a list, when they are too small to warrant a section by themselves - Change the version in the URL below!>
16
17 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.
18
19 = For Developers =
20
21 == Velocity changes ==
22
23 === Remove a Velocity Engine from the cache ===
24
25 ##org.xwiki.velocity.VelocityFactory## now provide an API to remove a cached Velocity Engine.
26
27 === Overriding Velocimacros in wiki-based skins ===
28
29 It's now possible to override the ##macros.vm## template in a wiki based skin (object property and attachment). Any modification to this template is also taken into account (the Velocity engine is recreated when the template is modified).
30
31 === Cleanup unprotected namespaces ===
32
33 VelocityEngine automatically get rid of the passed namespace at the end of execution unless it's protected.
34
35 In practice in means that the following:
36
37 {{code language="java"}}
38 engine.evaluate(new VelocityContext(), new StringWriter(), "namespace", "#macro(mymacro)toto#end")
39
40 Writer out = new StringWriter();
41 engine.evaluate(new VelocityContext(), out, "namespace", "#mymacro()")
42
43 System.out.println(out.toString())
44 {{/code}}
45
46 will now print
47
48 {{code language="none"}}
49 #mymacro()
50 {{/code}}
51
52 To get
53
54 {{code language="none"}}
55 toto
56 {{/code}}
57
58 you need the following
59
60 {{code language="java"}}
61 engine.startedUsingMacroNamespace("namespace")
62
63 try {
64 engine.evaluate(new VelocityContext(), new StringWriter(), "namespace", "#macro(mymacro)toto#end")
65
66 Writer out = new StringWriter();
67 engine.evaluate(new VelocityContext(), out, "namespace", "#mymacro()")
68
69 System.out.println(out.toString())
70 } finally {
71 engine.stoppedUsingMacroNamespace("namespace")
72 }
73 {{/code}}
74
75 == Miscellaneous ==
76
77 * Added new APIs to get all the icon themes present on the wiki, and all icons that these icon themes contain.
78
79 {{code language="velocity"}}
80 $services.icon.getIconSetNames()
81 $services.icon.getIconNames()
82 $services.icon.getIconNames("Font Awesome")
83 {{/code}}
84
85 * A new parameter has been added to the 'get' action and the 'plain' xpage: ##htmlHeaderAndFooter##, which add the HTML headers (##<html>##,##<head>##,##<body>##, etc...) and footers (##</body>##, ##</html>##, etc...). It could be usefull to create lite popups that displays only the document content without any UI.
86 * XWikiAttachment now provide setAuthorReference and getAuthorRefrence APIs
87
88 == Deprecated and Retired projects ==
89
90 <description of deprecated and retired projects>
91
92 == Upgrades ==
93
94 The following dependencies have been upgraded:
95
96 * [[httpclient 4.3.6>>http://jira.xwiki.org/browse/XCOMMONS-681]]
97 * [[commons-codec 1.10>>http://jira.xwiki.org/browse/XCOMMONS-684]]
98
99 = Translations =
100
101 The following translations have been updated:
102
103 {{language codes="none, none"/}}
104
105 = Tested Browsers & Databases =
106
107 {{include reference="TestReports.ManualTestReportTemplateSummary"/}}
108
109 = Performances tests compared to <last super stable version> =
110
111 <a summary of the comparison with latest super stable version>
112
113 More details on <link to the test report>.
114
115 = Known issues =
116
117 * [[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]]
118
119 = Backward Compatibility and Migration Notes =
120
121 == General Notes ==
122
123 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.
124
125 == Issues specific to XWiki 6.4-milestone-1 ==
126
127 * VelocityEngine automatically get rid of the passed namespace at the end of execution unless it's protected. See [[Velocity section>>||anchor="HVelocitychanges"]].
128
129 == API Breakages ==
130
131 The following APIs were modified since <project> <version - 1>:
132
133 {{code language="none"}}
134 <clirr output here>
135 {{/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