Skip to Content

Version 34.1 by Marius Dumitru Florea on 2014/12/03
Hide last authors
Thomas Mortagne 1.1 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
Marius Dumitru Florea 34.1 13 == New Parameters for Document Tree Macro ==
14
15 We added 3 new parameters to the [[Document Tree Macro>>extensions:Extension.Document Tree Macro]]:
16 * **filterByClass**: show only the documents that have an object of the specified type. The value of this parameter is the full name of an XWiki document that holds a class definition. For example, 'Blog.CategoryClass' can be used to show only the documents that represent blog categories.
17 * **openTo**: the id of the node to open the tree to. All the ancestors of the specified node, up to the root of the tree, will be opened also.
18 * **showOnlyViewable**: show only the wiki, space and document nodes for which the current user has view right. If this is set to false then the wiki, space and document nodes that are not viewable by the current user are listed in the tree using their names. The user won't be able to see their content by following their links though (the user will just be aware of their existence).
19
Thomas Mortagne 14.1 20 == Miscellaneous ==
21
Vincent Massol 19.1 22 * It's [[now possible to send Registration emails in HTML>>extensions:Extension.Administration Application||anchor="HRegistration"]] (by default they're sent in plain text). This is achieved by fully supporting any MIME content in the "Validation Email Content" and "Confirmation Email Content" sections of the Registration Administration UI. For example for the "Validation Email Content" field, you could use the following template to send HTML emails:(((
23 {{code language="none"}}
24 #set ($wikiname = $request.serverName)
25 #set ($host = ${request.getRequestURL()})
26 #set ($host = ${host.substring(0, ${host.indexOf('/', ${mathtool.add(${host.indexOf('//')}, 2)})})})
27 Subject: Validate your account on ${wikiname}
28 Content-type: text/html; charset=iso-8859-1
Thomas Mortagne 14.1 29
Vincent Massol 19.1 30 <p>Hello <b>${xwiki.getUserName("XWiki.$xwikiname", false)}</b>,</p>
31 <p>This email address was used to register a new account on ${wikiname}. If you did not make the request, please ignore this message.</p>
32 <p>In order to activate your account, please follow this link:
33 ${host}${xwiki.getURL('XWiki.AccountValidation', 'view', "validkey=${validkey}&xwikiname=${xwikiname}")}</p>
34 {{/code}}
35 )))
36
Thomas Mortagne 14.1 37 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.
38
39 = For Developers =
40
Thomas Mortagne 1.1 41 == Velocity changes ==
42
Thomas Mortagne 10.1 43 === Remove a Velocity Engine from the cache ===
44
45 ##org.xwiki.velocity.VelocityFactory## now provide an API to remove a cached Velocity Engine.
46
Vincent Massol 13.1 47 === Overriding Velocimacros in wiki-based skins ===
Thomas Mortagne 11.1 48
Vincent Massol 13.1 49 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).
Thomas Mortagne 11.1 50
Thomas Mortagne 10.1 51 === Cleanup unprotected namespaces ===
52
Thomas Mortagne 1.1 53 VelocityEngine automatically get rid of the passed namespace at the end of execution unless it's protected.
54
55 In practice in means that the following:
56
Thomas Mortagne 2.1 57 {{code language="java"}}
Thomas Mortagne 1.1 58 engine.evaluate(new VelocityContext(), new StringWriter(), "namespace", "#macro(mymacro)toto#end")
59
60 Writer out = new StringWriter();
61 engine.evaluate(new VelocityContext(), out, "namespace", "#mymacro()")
62
63 System.out.println(out.toString())
64 {{/code}}
65
66 will now print
67
68 {{code language="none"}}
69 #mymacro()
70 {{/code}}
71
72 To get
73
74 {{code language="none"}}
75 toto
76 {{/code}}
77
78 you need the following
79
Thomas Mortagne 2.1 80 {{code language="java"}}
Thomas Mortagne 1.1 81 engine.startedUsingMacroNamespace("namespace")
82
83 try {
84 engine.evaluate(new VelocityContext(), new StringWriter(), "namespace", "#macro(mymacro)toto#end")
85
86 Writer out = new StringWriter();
87 engine.evaluate(new VelocityContext(), out, "namespace", "#mymacro()")
88
89 System.out.println(out.toString())
90 } finally {
91 engine.stoppedUsingMacroNamespace("namespace")
92 }
93 {{/code}}
94
Thomas Mortagne 18.1 95 == Skins system improvements ==
96
Vincent Massol 18.2 97 Support for a new ##skin.properties## configuration file has been introduced in filesystem skins.
Thomas Mortagne 18.1 98
Vincent Massol 18.2 99 Right now it supports a ##parent## property to indicate another skin to inherit from. If set to an empty value ({{code language="properties"}}parent={{/code}}) the skin will directly inherit from the WAR; if not set at all it will behave as before which means inherit from whatever is configured in ##xwiki.cfg##'s ##xwiki.defaultbaseskin## property.
Thomas Mortagne 18.1 100
Vincent Massol 20.1 101 == Component Metadata Access ==
102
103 If your Component implementation needs to get access to its component metadata (i.e. its ##ComponentDescriptor##) then it can [[get it injected automatically>>extensions:Extension.Component Module||anchor="HComponentMetadata"]]. For example:
104
105 {{code language="java"}}
106 import org.xwiki.component.descriptor.ComponentDescriptor;
107 ...
108 @Component
109 @Singleton
110 public class MyComponentImpl implements MyComponent
111 {
112 @Inject
113 private ComponentDescriptor<MyComponent> descriptor;
114
115 public void doSomething()
116 {
117 String hint = this.descriptor.getRoleHint();
118 ...
119 }
120 }
121 {{/code}}
122
Thomas Mortagne 21.1 123 == Panels executed with the rights of their author ==
124
125 It's now possible to write script requiring programming right in panels as long as you have programming right, same as wiki macros.
126
Thomas Mortagne 22.1 127 == UI extensions executed with the rights of their author ==
Thomas Mortagne 21.1 128
129 What you can execute in UI extension used to depend on current document author right, it's now based on the own ui extension author.
130
Guillaume Delhumeau 15.1 131 == Miscellaneous ==
132
Vincent Massol 18.2 133 * Added new APIs to get all the icon themes present on the wiki, and all icons that these icon themes contain.(((
Guillaume Delhumeau 15.1 134 {{code language="velocity"}}
135 $services.icon.getIconSetNames()
136 $services.icon.getIconNames()
137 $services.icon.getIconNames("Font Awesome")
138 {{/code}}
Vincent Massol 18.2 139 )))
140 * 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 useful to create light popups that display only the document content without any UI.
141 * XWikiAttachment now provide ##setAuthorReference## and ##getAuthorReference## APIs
Thomas Mortagne 24.1 142 * ##org.xwiki.logging.event.LogEvent## now have a getTimestamp() method returning the number of milliseconds elapsed from 1/1/1970 until logging event was created.
Vincent Massol 25.2 143 * A SOLR-based implementation of the standard REST search resource has been added
Marius Dumitru Florea 30.1 144 * The [[Solr Query>>extensions:Extension.Solr Search Query API]] parameter ##xwiki.supportedLocales## has a new default value: the list of supported locales configured for the current wiki (where you execute the search).
Vincent Massol 27.2 145 * The ##{{{@Component}}}## annotation is no longer inheritable. Thus each component implementation class must now define it and not rely on it being present in some Abstract class.
Vincent Massol 29.1 146 * The XWiki build now verifies that all components are correctly listed in ##META-INF/components.txt## files and that the threading model is explicitly defined (i.e. that either ##{{{@Singleton}}}## or ##{{{@InstantiationStrategy(ComponentInstantiationStrategy.PER_LOOKUP)}}}## is used). If not, the build fails. A new ##{{{@Component}}}## annotation parameter has been added for explicitly mentioning that a Component should not be statically registered (these components are usually used in tests). It's used as follows:(((
Thomas Mortagne 31.1 147 {{code language="java"}}
Vincent Massol 28.1 148 @Component(staticRegistration = false)
149 {{/code}}
150 )))
Guillaume Delhumeau 15.1 151
Thomas Mortagne 1.1 152 == Upgrades ==
153
154 The following dependencies have been upgraded:
155
Thomas Mortagne 8.1 156 * [[httpclient 4.3.6>>http://jira.xwiki.org/browse/XCOMMONS-681]]
Thomas Mortagne 9.1 157 * [[commons-codec 1.10>>http://jira.xwiki.org/browse/XCOMMONS-684]]
Thomas Mortagne 26.1 158 * [[Lucene and SOLR 4.10.2>>http://jira.xwiki.org/browse/XWIKI-10562]]
Thomas Mortagne 27.1 159 * [[Groovy 2.3.8>>http://jira.xwiki.org/browse/XCOMMONS-704]]
Thomas Mortagne 1.1 160
161 = Translations =
162
163 The following translations have been updated:
164
Thomas Mortagne 33.1 165 {{language codes="da, de, es, fr, ko, lv, pt_BR, ro, ru, sv, tr"/}}
Thomas Mortagne 1.1 166
167 = Tested Browsers & Databases =
168
169 {{include reference="TestReports.ManualTestReportTemplateSummary"/}}
170
171 = Known issues =
172
173 * [[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]]
174
175 = Backward Compatibility and Migration Notes =
176
177 == General Notes ==
178
179 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.
180
Thomas Mortagne 3.1 181 == Issues specific to XWiki 6.4-milestone-1 ==
Thomas Mortagne 1.1 182
Thomas Mortagne 6.1 183 * VelocityEngine automatically get rid of the passed namespace at the end of execution unless it's protected. See [[Velocity section>>||anchor="HVelocitychanges"]].
Clemens Robbenhaar 23.1 184 * If upgrading the content in the DistributionWizard, and the upgrade is from XWiki 6.2.x or 6.3, you might get a conflict for the document Blog.BlogSheet. Unless you have done modifications to that document, please keep the new version; otherwise please keep the merged, or if not available, keep your version. For details see issue [[XWIKI-11450>>http://jira.xwiki.org/browse/XWIKI-11450]].
Thomas Mortagne 1.1 185
186 == API Breakages ==
187
188 The following APIs were modified since <project> <version - 1>:
189
190 {{code language="none"}}
191 <clirr output here>
192 {{/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