Release Notes for XWiki 6.4 (XWiki.org)

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

8

9

= New and Noteworthy (since XWiki <version - 1>) =

10

11

[[Full list of issues fixed and Dashboard for <version>>>http://jira.xwiki.org/secure/Dashboard.jspa?selectPageId=<fill id here>]].

12

13

== Menu Application ==

14

15

Taking advantage of the ability to have LESS inside our [[StyleSheetExtensions>>extensions:Extension.Skin Extension Plugin||anchor="HUseLESS"]], we improved the [[Menu Application>>extensions:Extension.Menu Application]], on Flamingo based skins, making it responsive and also adapting its styling according to the active [[Flamingo Theme>>extensions:Extension.Flamingo Theme Application]].

16

Colibri based skins preserve the initial styling.

17

18

19

image:ReleaseNotesXWiki64M2@menu_flamingo_charcoal.png

20

image:ReleaseNotesXWiki64M2@menu_flamingo_united.png

21

image:ReleaseNotesXWiki64M2@menu_flamingo_darkly.png

22

image:ReleaseNotesXWiki64M2@menu_flamingo_simplex.png

23

image:ReleaseNotesXWiki64M2@menu_flamingo_charcoal_responsive.png

== Flamingo Skin ==

We partially restored the behaviour of the top level menu from version 6.2, with some improvements:

29

* For tablet and desktop:

30

** the menu label is a link used for navigation

31

** the toggle (arrow / caret) is used for opening the drop down menu, but should be better separated from the label

32

* On phones the behaviour remains the same: taping on the label opens the menu

33

34

Default: {{image reference="ReleaseNotesXWiki64M2@charcoal-default.png"/}}

35

Hover Link: {{image reference="ReleaseNotesXWiki64M2@charcoal-hover-link.png"/}}

36

Hover Toggle: {{image reference="ReleaseNotesXWiki64M2@charcoal-hover-toggle.png"/}}

37

Open: {{image reference="ReleaseNotesXWiki64M2@charcoal-open.png"/}}

38

39

The history table, under each page, is now responsive to the screen size:(((

40

{{image reference="ReleaseNotesXWiki64M2@responsive-history.png" /}}

41

)))

42

43

Some improvements have been made on the responsive tables (including the livetables) and we have fixed the broken livetables for mobiles on some places:(((

44

{{image reference="ReleaseNotesXWiki64M3@livetable-rights.png" width="30%"/}} {{image reference="ReleaseNotesXWiki64M3@mobile-users.png" width="30%"/}} {{image reference="ReleaseNotesXWiki64M3@mobile-groups.png" width="30%"/}}

45

)))

46

47

== Rating Features ==

48

49

The Contrib ratings project has been moved to platform. Java APIs have been broken by the package renaming but script APIs have been kept retro-compatible and the UI is mostly the same. See [[Ratings Application>>extensions:Extension.Ratings Application]].

50

51

It's now possible to rate extensions in [[Extension Repository>>extensions:Extension.Repository Application]] and any repository handler can expose extension rating that are displayed (read only for now) in [[Extension Manager>>extensions:Extension.Extension Manager Application]].

== Wiki Configuration ==

56

57

A new "Configuration > Wiki" section is added in Administration where you can configure the current wiki, whether it is the main wiki or a subwiki.

58

59

{{image reference="ReleaseNotesXWiki64M3@wikiDescriptorEditingAdministration-cropped.png"/}}

60

61

For more information, see the [[documentation>>extensions:Extension.Wiki Application||anchor="HConfigureWiki"]].

62

63

== New Parameters for Document Tree Macro ==

64

65

We added 3 new parameters to the [[Document Tree Macro>>extensions:Extension.Document Tree Macro]]:

66

67

* **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.

68

* **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.

69

* **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).

== Mail Feature ==

* The mail feature has a new Category in the Admin UI (see the [[Mail Application>>extensions:Extension.Mail Application]] for details).(((

74

75

)))

76

* There's now the possibility to configure default BCC addresses which will be added by default to all emails sent using the [[Mail Sender API>>extensions:Extension.Mail Sender API]].(((

77

78

)))

79

* The [[Mail Sender API>>extensions:Extension.Mail Sender API]] now checks for permission before sending emails, when using it from scripts (i.e. when using the Mail Sender Script Service). There are currently 2 possible strategies that you configure in your ##xwiki.properties## file(((

80

81

#-# [Since 6.4M2]

82

#-# Defines which authorization checks are done when sending mails using the Mail Sender Script Service.

83

#-# Example of valid values:

84

#-# - "programmingrights": the current document must have Programming Rights

85

#-# - "alwaysallow": no check is performed. This is useful when running XWiki in a secure environment where we

86

#-# want to allow all users to be able to send emails through the Script Service.

87

#-# The default is:

88

# mail.sender.scriptServiceCheckerHint = programmingrights

89

90

)))

91

* The [[Mail Sender API>>extensions:Extension.Mail Sender API]] has been modified to support sending a large number of mails at once. In addition the [[Mail Admin UI>>extensions:Extension.Mail Application]] has been improved to display the statuses of mails (when they're sent by XWiki features specifying that the mail statuses should be persisted).(((

)))

* You can now specify the delay to wait between each mail being sent, in milliseconds. This is done to support mail throttling and not be considered a spammer by mail servers. For example if you wish to wait 10 seconds (if not specified the default is 8 seconds, which is 450 mails per hour), set the following in your ##xwiki.properties##:(((

97

98

mail.sender.sendWaitTime = 10000

99

100

101

The configuration parameter can also be changed from the [[Mail Admin UI>>extensions:Extension.Mail Application]]:

)))

* We now save both an error summary and a full error description when a mail fails to be sent when using the Database Mail Listener. This allows to see the full stack trace of the problem to more easily debug it.(((

106

107

)))

108

* The Mail Type is now displayed in the [[Mail Sender Status Admin UI>>extensions:Extension.Mail Application]]:(((

109

110

)))

111

* The ##MailResult.isSent()## API has been renamed to ##MailResult.isProcessed()## to avoid thinking that it'll return true if all mails have been sent successfully. What it does is simply return true when all mails have been processed, whether they've been sent successfully or not.

112

* A new scripting API has been added to set the mail type:(((

113

114

$message.setType("Some type")

115

116

)))

117

* In the [[Mail Sender Status Admin UI>>extensions:Extension.Mail Application]] we now only display mails sent by the current wiki unless we're on the main wiki.

118

* The [[Mail Application>>extensions:Extension.Mail Application]] doesn't require Programming Rights for installation anymore.

119

* Account Validation email results are now saved and visible in the [[Mail Application>>extensions:Extension.Mail Application]].

120

* Some new [[Mail Sender Storage script services>>extensions:Extension.Mail Sender Storage]] have been added: ability to delete mail statuses for a single mail and for a whole batch, and ability to load mail statuses with criteria.

121

* When messages are sent with the API they are now persisted locally before they are effectively sent, one by one. This means that even if XWiki crashes when mails are being sent, their statuses will be correctly displayed in the [[Mail Sender Status Admin UI>>extensions:Extension.Mail Application]] and can be resent.

122

* The Java API has been modified to use Strings in all places where it was previously using a UUID, in order to allow for change in unique id generation in the future.

123

* The wiki is not displayed in the [[Mail Sender Status Admin UI>>extensions:Extension.Mail Application]](((

)))

== Wikis ==

A "Wikis" category has been created in the administration, where the configuration have been moved and split in different sections:(((

130

|=Left menu|=Right menu

131

|{{image reference="ReleaseNotesXWiki64RC1@AdminWikis.png"/}}|{{image reference="ReleaseNotesXWiki64RC1@AdminWikis2.png"/}}

132

)))

133

134

== Extension Manager incompatible exceptions ==

135

136

When trying to install an incompatible extension (i.e. you are running XWiki 6.2.4 and want to install FAQ Application 6.3), you are now displayed a proper error instead of having to read through the install log to understand what went wrong, and you are instructed to use the ##Description > Stable Versions## section to manually (for now) find a compatible version of the extension that you want to install.

137

138

{{image reference="ReleaseNotesXWiki64RC1@incompatibleExtensionError.png"/}}

139

140

== Solr server setup package ==

141

142

Everything needed to setup an XWiki index in a remote Solr server is now packaged in a standalone project (##xwiki-platform-search-solr-server-data##). A Debian package (##xwiki-solr-data##) has also been provided to make easier to keep it up to date.

== Miscellaneous ==

* 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:(((

147

148

#set ($wikiname = $request.serverName)

149

#set ($host = ${request.getRequestURL()})

150

#set ($host = ${host.substring(0, ${host.indexOf('/', ${mathtool.add(${host.indexOf('//')}, 2)})})})

151

Subject: Validate your account on ${wikiname}

152

Content-type: text/html; charset=iso-8859-1

153

154

Hello ${xwiki.getUserName("XWiki.$xwikiname", false)},

155

This email address was used to register a new account on ${wikiname}. If you did not make the request, please ignore this message.

156

In order to activate your account, please follow this link:

157

${host}${xwiki.getURL('XWiki.AccountValidation', 'view', "validkey=${validkey}&xwikiname=${xwikiname}")}

158

159

)))

160

* The selected tree node is now highlighted even when links are enabled:(((

161

{{image reference="ReleaseNotesXWiki64M2@highlightSelectedTreeNode.png" /}}

162

)))

163

* A list of icons supported by XWiki have been created, with mapping for Silk and Font Awesome. Which means that we now propose a list of icons that are both present in Silk and Font Awesome.

164

* The list of columns in the UserDirectory customization screen is now sorted alphabetically

165

* The accuracy of the attachment content type detection has been improved. If the file name extension is unknown then we attempt to detect the content type from the first bytes of the file content. You can check this by attaching a text file without the 'txt' file name extension.

166

* Displaying the 'Stable versions' label in an extension's description in Extension Manager before and after the list of versions is retrieved.

167

* A click to the Document Index does not lead to an other space anymore.

168

* [[extensions:Extension.Tag Cloud Macro]] has now a new parameter (spaces) to display a tag cloud from multiple spaces.

169

170

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.

= For Developers =

== Icon Picker ==

An [[icon picker>>extensions:Extension.Icon Theme Application||anchor="#HIconPicker"]] has been created to help users selecting an image in the list of supported icons.

This picker is already used in [[Application Within Minutes>>extensions:Extension.App Within Minutes Application]] for the application's icon selection.

181

182

== Skin Extensions ==

183

184

[[Now you can use LESS in your Skin Extensions!>>extensions:Extension.Skin Extension Plugin||anchor="HUseLESS"]]. You just need to set the new property "Content Type" to LESS inside your Skin Extension object:

185

186

{{image reference="ReleaseNotesXWiki64M2@contentTypeLESS.png"/}}.

187

188

== Admin ConfigurableClass ==

189

190

The [[##ConfigurableClass## mechanism>>extensions:Extension.Administration Application||anchor="HMakingyourapplicationconfigurablewithConfigurableClass"]] has been improved to be able to contribute new categories in the Admin UI. For example the "Email" Category in the following screenshot is contributed through a ##ConfigurableClass##:

It was configured using:

195

196

{{image reference="ReleaseNotesXWiki64M2@emailconfigurableclass.png"/}}

197

198

== Velocity changes ==

199

200

=== Remove a Velocity Engine from the cache ===

201

202

##org.xwiki.velocity.VelocityFactory## now provide an API to remove a cached Velocity Engine.

203

204

=== Overriding Velocimacros in wiki-based skins ===

205

206

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).

207

208

=== Cleanup unprotected namespaces ===

209

210

VelocityEngine automatically get rid of the passed namespace at the end of execution unless it's protected.

211

212

In practice in means that the following:

213

214

215

engine.evaluate(new VelocityContext(), new StringWriter(), "namespace", "#macro(mymacro)toto#end")

216

217

Writer out = new StringWriter();

218

engine.evaluate(new VelocityContext(), out, "namespace", "#mymacro()")

219

220

System.out.println(out.toString())

will now print

#mymacro()

To get

toto

you need the following

236

237

238

engine.startedUsingMacroNamespace("namespace")

239

240

try {

241

engine.evaluate(new VelocityContext(), new StringWriter(), "namespace", "#macro(mymacro)toto#end")

242

243

Writer out = new StringWriter();

244

engine.evaluate(new VelocityContext(), out, "namespace", "#mymacro()")

245

246

System.out.println(out.toString())

247

} finally {

248

engine.stoppedUsingMacroNamespace("namespace")

}

== Skins system improvements ==

253

254

Support for a new ##skin.properties## configuration file has been introduced in filesystem skins.

255

256

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.

257

258

== Component Metadata Access ==

259

260

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:

261

262

263

import org.xwiki.component.descriptor.ComponentDescriptor;

...

@Component

@Singleton

public class MyComponentImpl implements MyComponent

268

{

269

@Inject

270

private ComponentDescriptor<MyComponent> descriptor;

271

272

public void doSomething()

273

{

274

String hint = this.descriptor.getRoleHint();

...

}

}

== Panels executed with the rights of their author ==

281

282

It's now possible to write script requiring programming right in panels as long as you have programming right, same as wiki macros.

283

284

== UI extensions executed with the rights of their author ==

285

286

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.

== Rendering ==

XWiki Rendering now provide an HTML5 Renderer.

== Miscellaneous ==

* Added new APIs to get all the icon themes present on the wiki, and all icons that these icon themes contain.(((

295

296

$services.icon.getIconSetNames()

297

$services.icon.getIconNames()

298

$services.icon.getIconNames("Font Awesome")

299

300

)))

301

* 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.

302

* XWikiAttachment now provide ##setAuthorReference## and ##getAuthorReference## APIs

303

* ##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.

304

* A SOLR-based implementation of the standard REST search resource has been added

305

* 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).

306

* 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.

307

* 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:(((

308

309

@Component(staticRegistration = false)

310

311

)))

312

* You can now control in which order the sections added via the [[ConfigurableClass>>extensions:Extension.Administration Application||anchor="HFieldsyoucandefine"]] are displayed in the administration.

313

* New APIs to generate unescaped display user name:

314

** ##com.xpn.xwiki.XWiki#getPlainUserName(DocumentReference userReference, XWikiContext context)##

315

** ##com.xpn.xwiki.XWiki#getUserName(DocumentReference userReference, String format, boolean link, boolean escapeXML, XWikiContext context)##

316

** ##com.xpn.xwiki.api.XWiki#getPlainUserName(DocumentReference userReference)##

317

* New script oriented APIs to get document author/contentAuthor/creator as ##DocumentReference##

318

* It's now possible to provide metadatas to ##MacroContentParser#parse## API

319

* It's now possible to know what namespace a ComponentManager instance is associated with by casting it to ##org.xwiki.component.manager.NamespacedComponentManager##. See [[Component Module documentation>>http://extensions.xwiki.org/xwiki/bin/view/Extension/Component+Module||anchor="HNamespacedComponentManager"]].

320

* Added getCurrentWikiDescriptor() method to the wiki API and script service to be consistent with the existing getCurrentWikiId() method

321

* The ClassLoader automatically set as Thread ClassLoader is now dynamic meaning that any modification of the context wiki will automatically change the actual Thread ClassLoader. It used to be set to whatever was the wiki in the URL at ExecutionContext init.

322

* [[A new CSS class>>platform:DevGuide.SpecialCSSClasses||anchor="HClassesfortheresponsiveness"]] have been added in Flamingo, to handle responsive tables.

323

* The #sheetTitle Velocity macro supports a new use case: displaying the sheet title if the current document doesn't have an object of some type:(((

324

325

#sheetTitle('The sheet used to display objects of type Space.MyClass', 'Space.MyClass')

)))

== Upgrades ==

The following dependencies have been upgraded:

332

333

* [[httpclient 4.3.6>>http://jira.xwiki.org/browse/XCOMMONS-681]]

334

* [[commons-codec 1.10>>http://jira.xwiki.org/browse/XCOMMONS-684]]

335

* [[Groovy 2.3.8>>http://jira.xwiki.org/browse/XCOMMONS-704]]

336

* [[JGroups 3.6.1>>http://jira.xwiki.org/browse/XWIKI-11523]]

337

* [[Pygments 2.0.1>>http://jira.xwiki.org/browse/XWIKI-11522]]

338

* [[Joda-Time 2.6>>http://jira.xwiki.org/browse/XWIKI-11516]]

339

* [[Bootstrap 3.3.1>>http://jira.xwiki.org/browse/XWIKI-11381]]

340

* [[Bootswatch 3.3.1+2>>http://jira.xwiki.org/browse/XWIKI-11569]]

341

* [[slf4j 1.7.9>>http://jira.xwiki.org/browse/XCOMMONS-712]]

342

* [[Lucene and SOLR 4.10.3>>http://jira.xwiki.org/browse/XWIKI-11603]]

= Translations =

The following translations have been updated:

347

348

{{language codes="da, de, es, fr, ko, lv, pl, pt_BR, ro, ru, sv, tr"/}}

349

350

= Tested Browsers & Databases =

351

352

{{include reference="TestReports.ManualTestReportSummaryXWiki64"/}}

353

354

= Performances tests compared to <last super stable version> =

More details on <link to the test report>.

= Known issues =

* [[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]]

363

364

= Backward Compatibility and Migration Notes =

== General Notes ==

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.

369

370

== Issues specific to XWiki 6.4 ==

371

372

* VelocityEngine automatically get rid of the passed namespace at the end of execution unless it's protected. See [[Velocity section>>||anchor="HVelocitychanges"]].

373

* 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]].

== API Breakages ==

The following APIs were modified since <project> <version - 1>: