Release Notes for XWiki 4.2 (XWiki.org)

This is the release notes for XWiki Platform, XWiki Enterprise and XWiki Enterprise Manager. They share the same release notes as they are released together and have the same version.

6

7

This is the thir release of the 4.x cycle ([[Roadmap>>Main.Roadmap]]).

8

9

= New and Noteworthy (since XWiki 4.1) =

== JIRA Macro ==

A [[new JIRA Macro>>extensions:Extension.JIRA Macro]] is now part of the Platform but is not bundled by default (you'll need to install it with the Extension Manager). We previously had a [[Contributed JIRA Macro>>extensions:Extension.Contrib JIRA Macro]] but we decided that the JIRA macro was a good candidate to have in the Platform and thus supported by the XWiki Development Team. Compared to the older Contributed JIRA Macro, the new Macro has the following advantages:

14

15

* No Programming Rights required

16

* Supports issue ordering

17

* Supports ability to register new Styles, new Data Sources and new Field Displayers

18

* Displays closed issues as Striked-out

19

* Written in Java with automated tests

20

21

{{image reference="extensions:Extension.JIRA [email protected]"/}}

22

23

== Extension Manager improvements ==

Main improvements:

* Starting with this version you can downgrade an extension. In other words, you can install an older version of an extension even if a newer version is currently installed. This doesn't apply to core extensions, which cannot be uninstalled, upgraded or downgraded individually. In order to downgrade an extension that is already installed you need to search for an older version. Currently this is possible only using the advanced search.(((

28

29

)))

30

* From the main wiki of a wiki farm you now have the option to trigger extension jobs (install, uninstall, upgrade, downgrade, etc.) that target all the wikis. For instance, as you can see below, you can install an extension on the entire wiki farm:(((

31

32

)))

33

* The log messages have been improved to include links to the affected documents or extensions as indicated in the following image~:(((

34

35

)))

36

* An administrator of a subwiki can now install XAR extension (as long as it does not require a JAR extension).

37

38

== Experimental install/upgrade wizard ==

39

40

Accessing a wiki page in view mode after an upgrade or when the database is empty (new install) will trigger a wizard that will allow you to install or update the default set of wiki pages and to upgrade or downgrade the extensions you may have previously installed.

41

42

The wizard currently has two steps. In the first step you can see which XWiki distribution you are running and what is its recommended default set of wiki pages (the default user interface). You should install, upgrade or downgrade the UI so that it matches the distribution version.

The step has three possible actions:

47

48

* Skip means 'go to the next step and ask me again after a server restart'

49

* Cancel means 'go to the next step and don't ask me again until I change my distribution'

50

* Continue, only after the recommended UI version is installed

51

52

In the second step you can upgrade the installed extensions. We group them in two categories:

53

54

* extensions that don't work with your current distribution but which have new versions available that are compatible with your current distribution. These extension require an upgrade.

55

* extensions that should work fine with your current distribution but which have upgrades available. Upgrading these extensions is optional.

You can refresh the list of extensions by clicking on the Reload button. The Skip and Cancel buttons have the same meaning as in the previous step. The Continue button is available only after the required upgrades are performed.

60

61

At the end you'll be redirected back to the wiki page you have accessed in the first place.

62

63

== Improvements to the Extension Repository Application ==

64

65

We modified the extension sheet to display the release notes for all the available versions of an extension. Check for instance the release notes for the [[Extended TODO Application>>extensions:Extension.Extended Todo Application#HReleaseNotes]]:

== New field types for email and list of pages ==

70

71

Two new types of class properties have been added:

72

73

* The //Email// type extends the normal //String// type, adding by default a validation regular expression that should accept only a valid email address

74

* The //Page// type extends the normal //DBList// type, and allows to select one or more documents from the current wiki

75

76

These two new properties are still in development, and further improvements will be implemented in the next milestone.

77

78

== Computed class fields ==

79

80

Another new type of class fields adds support for //virtual values// computed live from other class values, data from the database, data obtained from an external service, or practically any other source of data. These fields are non-editable and aren't stored in the database, since they only provide some wiki content that will be rendered each time such a property is displayed.

81

82

Traditionally, this kind of computation would have been written directly in the sheet used to display instances of that class, but putting it in a class field allows easier reuse of the code, since the property will be //displayed// in livetables, when indexing the document in Lucene, when displaying documents in an index page, and so on.

83

84

== Improved upload UI ==

85

86

The new HTML5 FileUploader has been integrated in a few places:

87

88

* The standard attachment upload form

89

* The Import section of the Administration

90

91

See [[below>>||anchor="HNewHTML5FileUploadwidget"]] for more details about this feature.

92

93

== New logging administration UI ==

94

95

It's now possible to review and modify the log level for all registered loggers.

96

97

{{image reference="extensions:Extension.Logging [email protected]"/}}

98

99

== New Applications Panel ==

100

101

There's now a new "Applications" panel by default in XWiki Enterprise. This panel displays the applications present in your wiki.

Administrators will get a couple of additional links, allowing them to install applications through the [[Extension Manager>>extensions:Extension.Extension Manager Application]], or to create new applications thanks to the [[App Within Minutes feature>>extensions:Extension.App Within Minutes Application]].

Note for application developers: your applications can provide their own entries in this menu by [[declaring a UI Extension>>extensions:Extension.UIExtension Module]].

111

112

113

== Chart Macro Improvements ==

114

115

* The [[Chart macro>>extensions:Extension.Chart Macro]] will now automatically default to the ##inline## Data Source type when not specified and the Chart Macro has some content.

116

* [[Two new Chart types have been added: XY Line 3D and XY Step>>extensions:Extension.Chart Macro]]. Examples:(((

)))

== New Content Macro ==

123

124

The [[new Content macro>>extensions:Extension.Content Macro]] allows to enter content in any of the supported Syntaxes and thus allows to have content written in various syntaxes. For example, in a page in XWiki Syntax 2.0:

This is in **bold**

This is *bold* too!

== Documents Macro improvements ==

135

136

The ##~{~{documents}}## macro [[now supports specifying the list of columns to display>>extensions:Extension.Documents Macro]]. For example:

137

138

139

{{documents count="5" actions="false" space="Main" parent="Main.WebHome" columns="doc.title"/}}

would display:

== Search improvements ==

147

148

The Lucene index also stores the MIME type of the indexed attachments, allowing to customize the search to only include or exclude attachments of a certain type. The new field is named [[##mimetype##>>doc:extensions:Extension.Search Application Query Syntax||anchor="Hmimetype"]] and it contains a valid MIME type string, as returned by the container in which XWiki is running. For example, add ##-mimetype:image/*## to a query to exclude all image attachments from the results, or add ##mimetype:application/pdf## to only search inside PDF attachments.

149

150

Remember that in case of an upgrade, you have to rebuild the entire index to have this new field for existing documents.

= For Developers =

== New Git Module ==

A new, optional (i.e. not installed by default), [[Git Module has been added>>extensions:Extension.Git Module]]. It allows to easily perform Git operations from within wiki pages. For example to count all commits for the past year and list all committers who's committed code during this period, you could write in a wiki page:

import org.apache.commons.io.*

161

import org.eclipse.jgit.api.*

162

import org.eclipse.jgit.lib.*

163

import org.eclipse.jgit.revwalk.*

164

import org.eclipse.jgit.storage.file.*

165

import org.gitective.core.*

166

import org.gitective.core.filter.commit.*

167

168

def service = services.get("git")

169

def commonsRepository = service.getRepository("git://github.com/xwiki/xwiki-commons.git", "xwiki-commons")

170

// Do a Git pull to get latest commits

171

new Git(commonsRepository).pull().call()

172

def finder = new CommitFinder(commonsRepository)

173

174

def dateFilter = new CommitterDateFilter(System.currentTimeMillis() - 365*24*60*60*1000L)

175

def countFilter = new CommitCountFilter()

176

def authorFilter = new AuthorSetFilter()

177

def filters = new AndCommitFilter()

178

filters.add(countFilter, authorFilter)

179

finder.setFilter(dateFilter)

180

finder.setMatcher(filters)

181

finder.find()

182

183

println "There have been ${countFilter.count} commits in the past year!"

184

println ""

185

186

println "The following committers have participated in those commits:"

187

authorFilter.getPersons().each() {

188

println "* ${it.name} (${it.emailAddress})"

}

== Default custom displayers for Easier customization of the way object fields are displayed ==

194

195

While XWiki allowed to specify a custom display for a given field, it was impossible to change the way field types, such as //DateProperty// or //IntegerProperty//, are displayed in general. Now it is possible to define custom displayers at the farm or wiki level, which gives the administrators more power to change the look and feel of the wiki. For example, this allows to use HTML5 input types for dates and numbers, to use custom suggestions for //list of users// fields, or to always add a validation input for all the //password// field types.

196

197

To use this feature, first you need to compute a //type// name for your property type. This is obtained from the java class simple name, removing the ##Class## suffix, and lowercasing. For example, for numbers the java class used is ##com.xpn.xwiki.objects.classes.NumberClass##, with the simple name ##NumberClass##, which gives ##number## as the type name. For a database list, we get ##dblist## from ##DBListClass##.

198

199

Next, there are three places where a default custom displayer can be defined.

200

201

1. If a document whose name is the //type// capitalized and suffixed with ##Displayer## exists in the ##XWiki## space in the current wiki, then its content is used as the default custom displayer for that type of property. For example, ##localwiki:XWiki.NumberDisplayer## and ##localwiki:XWiki.DblistDisplayer##.

202

1. If a document whose name is the //type// capitalized and suffixed with ##Displayer## exists in the ##XWiki## space in the main wiki, then its content is used as the default custom displayer for that type of property. For example, ##xwiki:XWiki.NumberDisplayer## and ##xwiki:XWiki.DblistDisplayer##.

203

1. If a velocity template whose name is the //type// suffixed with ##.vm## exists in the current skin, then it is evaluated as the default custom displayer for that type of property. A skin file can be defined in many places, such as an attachment of a skin document, a file in a named skin on the filesystem, or a file in the ##templates/## directory.

204

205

If a specific class property provides custom display code in the XClass, then that code takes priority over an eventual default custom displayer for that property.

206

207

As with property custom displayers, when evaluating the display code several objects are placed in the context:

208

209

* ##name## is the name of the property being displayed

210

* ##prefix## is the HTML name prefix to append to an eventual input field name, and contains the XClass name, an underscore, the object number, and another underscore, for example ##XWiki.XWikiUsers_0_##

211

* ##object## is the object owning the displayed property, an instance of the public ##com.xpn.xwiki.api.Object## class

212

* ##type## is the target display type, one of ##view##, ##edit##, ##hidden## or ##search##

213

214

== New API to manipulate log level ==

215

216

Several method as been added to ##org.xwiki.logging.LoggerManager## to manipulate the log level of registered loggers.

/**

* Associate the passed logger to the passed log level.

221

*

222

* @param loggerName the logger

223

* @param level the level of the logger

224

*/

225

void setLoggerLevel(String loggerName, LogLevel level);

226

227

/**

228

* @param loggerName the logger

229

* @return the log level associated to the logger

230

*/

231

LogLevel getLoggerLevel(String loggerName);

232

233

/**

234

* @return all the registered loggers

235

*/

236

Collection<Logger> getLoggers();

== New HTML5 File Upload widget ==

241

242

The [[File Upload widget>>doc:platform:DevGuide.HTML5Upload]] can enhance HTML input elements of type file to provide an interactive upload UI. It can submit files either automatically when the user selects local files, or after the user presses the container form's submit button.

243

244

To use this widget, it is enough to create a new instance of ##XWiki.FileUploader## passing the target ##input## element as the first parameter, and an optional configuration object as the second parameter.

245

246

247

new XWiki.FileUploader(targetInput, {

248

autoUpload: true,

249

progressAutohide: true

});

[[image:platform:[email protected]||class="screenshot"]]

== JSRX and SSRX ==

It's now possible by default to add [[skin extensions>>extensions:Extension.Skin Extension Plugin]] located in JAR files. Example usage:

258

259

260

$xwiki.jsrx("/lib/codemirror.js")

261

$xwiki.ssrx("/lib/codemirror.css")

262

263

264

== Attachment Picker improvements ==

265

266

It is now possible to specify a different document for the source (and target in case of uploads) of attachments, using the new ##targetdocname## macro parameter.

267

268

== Extension Manager improvements ==

269

270

* the custom Maven property <xwiki.extension.features> now accept any number of new lines and white spaces between elements(((

271

272

<xwiki.extension.features>

273

org.xwiki.platform:xwiki-platform-oldcore,

274

com.xpn.xwiki.platform:xwiki-core

275

</xwiki.extension.features>

276

277

)))

278

* new custom properties added to overwrite standard Maven properties:

279

** ##xwiki.extension.name## to overwrite ##<name>##

280

** ##xwiki.extension.summary## to overwrite ##<description>##

281

** ##xwiki.extension.website## to overwrite ##<url>##

282

283

== XAR format improvement ==

284

285

It's now possible to indicate the extension identifier right in the XAR package descriptor (package.xml). Among other things this allow standard import UI to find what it currently importing and register it automatically as installed extension if it can be found in the registered repositories during import process.

286

287

The XAR Maven plugin automatically take care of adding this information to the generated package.xml for Maven project. If for some reason you need to indicate it by hand you can use the property <extensionId> under the the <infos> element in the package.xml file.

<infos>

<name>XWiki Platform - Extension - UI</name>

293

<description>XWiki Extension Manager, an application for managing extensions in a wiki.</description>

294

295

<author>XWiki.Admin</author>

296

<extensionId>org.xwiki.platform:xwiki-platform-extension-ui</extensionId>

297

<version>4.2-SNAPSHOT</version>

</infos>

<files>

[...]

</files>

</package>

== New UI Extension mechanism (experimental) ==

307

308

We're in the process of allowing applications to insert custom content in pre-defined places in the user interface. A first Extension Point has been defined in the new "Applications" panel, you can read more about this in the [[UI Extension module documentation>>extensions:Extension.UIExtension Module]].

== Miscellaneous ==

* The transformation context have a "restricted" flag to indicate that macros and other transformations should not perform modifications to the database, expensive computations or other potentially harmful operations. Developers of macros and other rendering extensions should pay attention to this flag.

313

* The messageSender macro now accepts 3 parameters that allow you to customize it by overriding the default displayed visibility levels for a message (that a user can choose from), the default selected visibility level and the default value (in case of user or group visibility). More details on {{jira style="enum" url="http://jira.xwiki.org"}}XWIKI-7974{{/jira}}.

314

* The [[new experimental Security API that was first released in XWiki 4.0>>xwiki:ReleaseNotes.ReleaseNotesXWikiEnterprise40||anchor="HNewRightsImplementation28Experimental29"]] is now bundled by default in XWiki Enterprise.

315

* It's now possible to access root ComponentManager using "root" role hint:(((

@Inject

@Named("root")

private ComponentManager rootComponentManager;

320

321

)))

322

* A Provider has been added to easily access the context ComponentManager (a proxy which choose the right ComponentManager depending on context information like the current user and the current wiki)(((

@Inject

@Named("context")

private Provider<ComponentManager> contextComponentManager;

327

328

)))

329

* The ##AbstractMockingComponentTestCase## testing framework class has been modified. Read the [[Testing page>>dev:Community.Testing]] for more details on how to use it.

330

331

== Deprecated and Retired projects ==

== Upgrades ==

The following dependencies have been upgraded:

* Infinispan 5.1.5

* JDeb 0.11

* JGroups 3.1.0

* Tika 1.2

* GWT 2.5 RC1

* Selenium 2.25

* Prototype.js 1.7.1

* Jython 2.5.3

* Pegdown 1.1.0 (used by the XWiki Markdown Parser)

* Xalan 2.7.1

== Miscellaneous ==

* the progress tab is selected by default when you view the extension details if there is a job running (e.g. install in progress) for that extension

353

* when there is a merge conflict, the 'Show changes' button updates the changes asynchronously without reloading the entire page

354

* attachments of pages installed with the extension manager now have the right author set: the current user instead of the author from the XAR as it used to be

355

* the file size of attachments installed with the extension manager is now properly set

356

* the installation process is now more robust with respect to the exceptions that can occur while installing a JAR extension with components

357

* Document attachments so far have been displayed in the order in which they are returned by the database, which most of the time happened to be the upload date. Starting with this version attachments are displayed ordered by their filename, which makes it easier to find an attachment, but support for selecting a different order (date, size, author...) will be added soon.

358

* Uploading attachments with '+' character in their file names using the WebDAV interface shouldn't pose any more problems.

359

* It's now possible to use Velocity scripts in the Copyright field in the Administration.

360

* The XWiki Installer now fully works on Windows 7. The XWiki Data is now put in the ##%APPDATA%\XWiki Enterprise <version>\data## directory, while the binaries are installed in ##Program Files##.

361

* It is no longer allowed to use scripts in comments. This reduces the security risk from users that only have comment rights.

362

* Macro parameters may now contain macro syntax. Example: {{{ {{box title="{{info}}Hello!{{/info}}" }}Lorem ipsum ...{{/box}} }}}

363

* Improve OOB support for JBoss AS7:

364

** Removed Struts Taglibs completely since we don't use them and some were defined but not made available, causing errors in deployments on JBoss AS7 ({{jira style="enum" url="http://jira.xwiki.org"}}XWIKI-7986{{/jira}})

365

** Fixed Logging conflict between JBoss AS and XWiki ({{jira style="enum" url="http://jira.xwiki.org"}}XWIKI-7987{{/jira}})

366

* The [[IRC Bot Application>>extensions:Extension.IRC Bot Application]] now recognizes XAR import events and when receiving one, it doesn't send subsequent IRC notifications for modified or created documents to avoid spamming the IRC channel.

367

* Display the request URL in the IRC channel when the Link Checker bot listener is active and a broken link is found, thus making it easier to reproduce and debug the broken link

== Translations ==

The following translations have been updated:

= Tested Browsers =

Here's the list of browsers tested with this version (i.e. browsers that we've tested as working - Check the list of [[supported browsers>>dev:Community.BrowserSupportStrategy]]):

378

379

380

## name = iexplorer, firefox, chrome, safari, opera

= 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]]

= Test Report =

You can check the [[manual test report>>TestReports.WebHome#<anchor to test report>]] to learn about what was tested and the results on various browsers.

392

393

= Backward Compatibility and Migration Notes =

== General Notes ==

You may also want to [[import the default wiki XAR>>Main.Download]] in order to benefit from all the improvements listed above.

398

399

400

Always make sure you compare your ##xwiki.cfg## and ##xwiki.properties## files with the newest version since some configuration parameters were 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.

401

402

403

== Issues specific to XWiki <version> ==

== API Breakages ==

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