Release Notes for XWiki 7.3 (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

This is a stabilisation release focusing on the Nested Pages feature which was introduced in XWiki 7.2. Lots of polishing has been done for the Nested Pages feature integration and its consequences on the UI redesign (modified menus for example). The release includes a couple of bug fixes, a few dependency upgrades and new UI extension points available for extension developers.

8

9

= New and Noteworthy (since XWiki 7.2) =

10

11

[[Full list of issues fixed and Dashboard for 7.3>>http://jira.xwiki.org/secure/Dashboard.jspa?selectPageId=13500]].

== Flamingo ==

=== Navigation bar ===

16

17

The user's avatar is now displayed between the search icon and the drawer icon:(((

)))

Also the search bar on the top of the screen have been improved a bit. When the user clicks on the search button, the search bar is opened and gets the focus. Then, when the users clicks in other place, the search bar is closed, slowly.

* Closed:(((

)))

* Open:(((

)))

=== Menus ===

The "More Options" menu has been split and a new "Page Administration" menu has been introduced:

33

34

35

image:ReleaseNotesXWiki73M2@content_menus.png

36

image:ReleaseNotesXWiki73M2@page-admin-menus.png

37

image:ReleaseNotesXWiki73M2@more-options-menu.png

=== Delete ===

* The delele UI now uses the 'title' and 'location' columns to list the children that may be affected by the delete action:(((

43

{{image reference="ReleaseNotesXWiki73RC1@deleteUI.png" width="33%"/}}

)))

=== Drawer ===

* In the Drawer (top right menu), the pages for which the user doesn't have permissions to access are not displayed anymore.

== Breadcrumb ==

When the hierarchy of a Nested Pages is long, we do not display it entirely any more. Instead, we display a limited version, that the user can expand by clicking on the "ellipsis" character ('...'):

53

54

* limited:(((

55

{{image reference="ReleaseNotesXWiki73M2@breadcrumb-limited.png"/}}

)))

* full:(((

)))

Note that this behavior have also been added to all hierarchy breadcrumbs, including location of search results, etc...

62

63

(((

64

{{image reference="ReleaseNotesXWiki73M2@breadcrumb-search-results.png"/}}

65

)))

66

67

The breadcrumb has now support for tree navigation. Each breadcrumb element has a drop down tree that shows the siblings and the children, helping you navigate easily around the wiki.

68

69

{{image reference="ReleaseNotesXWiki73M2@breadcrumbsTreeNavigation.png"/}}

70

71

* The breadcrumb tree navigation doesn't show the document translations any more when multilingual is disabled, because navigating to a document translation when multilingual is off doesn't have any effect: the default translation is displayed instead. You can still see the translations in the [[Page Index Tree>>extensions:Extension.Index Application||anchor="HAllDocumentsinatreeview"]] though.

72

73

== Flamingo Theme Editor ==

74

75

The [[extensions:Extension.Flamingo Theme Application]] now handles the ##@lessCode## field. It means that you can add any code, written with LESS, to your theme and see the result live!

76

77

{{image reference="ReleaseNotesXWiki73M1@LESSCode.png" width="40%"/}}

== Page Index ==

Since we have introduced the concept of Nested Spaces we needed to replace the Space column in the LiveTable with a more generic solution. Thus, the [[extensions:Extension.Index Application]] has now merged the previous Page + Space columns into a single ##Location## column and we've introduced new ##Title## column but which now displays the title of pages, as can be seen on the following screenshot:

82

83

{{image reference="ReleaseNotesXWiki73M2@livetable-location.png" width="50%"/}}

84

85

The same strategy is implemented for the ##children## and the ##siblings## viewers.

86

87

Note that you can filter at several path levels in the Location column. For example:

88

89

{{image reference="ReleaseNotesXWiki73M2@location-filter.png" width="50%"/}}

90

91

92

XWiki currently doesn't support filtering on Page titles which is why the new ##Title## column doesn't allow filtering. However since the ##Location## column includes the full path, users can still search on Page names.

93

94

At a technical level the displaying of page titles was needed because all non-terminal pages names are called ##WebHome## and displaying that would not be user-friendly.

== New Panels ==

* A [[Children Panel>>extensions:Extension.Panels Application||anchor="HChildrenPanel"]] has been added to display the list of Children pages of the current Page.(((

100

101

)))

102

* A [[Siblings Panel>>extensions:Extension.Panels Application||anchor="HSiblingsPanel"]] has been added to display the list of Sibling pages of the current Page.(((

103

104

)))

105

* The [[SpaceDocs Panel>>extensions:Extension.Panels Application||anchor="HSpaceDocsPanel"]] has been deprecated and the [[Children Panel>>extensions:Extension.Panels Application||anchor="HChildrenPanel"]] or [[Siblings Panel>>extensions:Extension.Panels Application||anchor="HSiblingsPanel"]] should be used instead. A warning message has been added (visible only to Admins) to explain this:(((

106

{{image reference="ReleaseNotesXWiki73M2@spacedocs-warning.png"/}}

107

)))

108

109

== App Within Minutes ==

110

111

Up until this version, the applications created with App Within Minutes were always located in a top level space. For instance, if you wanted to create a "Meeting" application, the application data space was "Meeting". Starting with this version you can also create an application in a nested space. In the first step of the wizard you can select the location where you want the application to be created. In the following image I have create an application with path "Marius / Apps / Meeting".

112

113

{{image reference="ReleaseNotesXWiki73M2@appLocationPicker.png" width="600"/}}

114

115

The [[App Within Minutes>>extensions:Extension.App Within Minutes Application]] wizard is now generating all the application pages in a single location, as nested pages. The code pages are grouped under the ##Code## page and are marked as hidden (so your users don't see them by default). The application entries are created under the ##Data## page. Backward compatibility is preserved so you should still be able to edit existing applications that don't have the new page organization.

The application wizard has also been modified to support any characters in the application name. The only remaining requirement for the application name is to not be empty.

120

121

== Office Importer ==

122

123

The [[extensions:Extension.Office Importer Application]] has been redesigned visually and now supports importing into Nested Spaces:

124

125

{{image reference="ReleaseNotesXWiki73M1@OfficeImporter" width="50%"/}}

126

127

== Template Providers Administration ==

128

129

The template provider UI has been adapted to Nested Pages and it now supports:

130

131

* Creating template providers deeper than the first level (as it was restricted before), reusing the location picker widget

132

* Setting allowed locations (i.e. spaces) using the tree widget

133

134

135

image:ReleaseNotesXWiki73M2@TemplateProviderCreationUI-NestedPages.png

136

137

image:ReleaseNotesXWiki73M2@TemplateProviderEditUI-NestedPages.png

138

139

image:ReleaseNotesXWiki73M2@TemplateProviderViewUI-NestedPages.png

140

141

142

For more details, see the [[XWIKI-12275>>http://jira.xwiki.org/browse/XWIKI-12275]] issue and the [[documentation>>extensions:Extension.Administration Application||anchor="HTemplates"]].

143

144

* Template providers can now specify if they create terminal or non-terminal documents. See the [[documentation>>extensions:Extension.Administration Application||anchor="HAdvanced:Creatingterminaldocumentswithtemplateproviders"]] for more information.

145

* The //Template Type// option ("type" class property) of a template provider was removed since it was not used from the start and any existing values have been migrated to use the new "terminal" property. See the [[documentation for more information on the "terminal" property>>extensions:Extension.Administration Application||anchor="HAdvanced:Creatingterminaldocumentswithtemplateproviders"]].

146

147

== XClass Application ==

148

149

The [[XClass Application>>extensions:Extension.XClass Application]] has been modified to support classes defined in nested documents. The default class sheet has been improved to use the new location picker when creating a new class entry, and the list of existing entries is now displayed using a live table. The 'Data types' page has been improved to use the new location picker when creating a new class, and the list of existing classes (data types) is now displayed using a live table.

150

151

152

image:ReleaseNotesXWiki73M2@classSheet.png

153

image:ReleaseNotesXWiki73M2@dataTypes.png

== Miscellaneous ==

* The Extension Diff view has been improved to display the page (translation) language both in the summary and the detail sections. The page name (heading) from the detail section is now a link to the local version of the page.(((

159

{{image reference="ReleaseNotesXWiki73M1@extensionDiff.png" width="200"/}}

160

)))

161

* Added the Actions column for the [[FAQ Application>>extensions:Extension.FAQ Application]]:(((

162

163

)))

164

* Pages with Slovak and Brazilian Portuguese language are now indexed by Solr and thus they are included in the search results. See the [[Migration Notes>>||anchor="HIssuesspecifictoXWiki7.3-milestone-1"]] below in case you are performing an upgrade and you want support for these languages.

165

* Clicking on the Logo (top-left of the screen) will now take you to the page that you have configured as wiki homepage by using the "Wiki Administration > Wikis > Descriptor" section. See the related [[documentation section>>extensions:Extension.Wiki Application||anchor="HConfigureWiki"]].

166

* The template providers edition has been rewritten to be more consistent with other edit forms:(((

167

{{image reference="ReleaseNotesXWiki73M1@template-provider-edit.png" width="50%"/}}

168

)))

169

* Removed the 'Edit' button when editing a template provider document. See [[XWIKI-12675>>http://jira.xwiki.org/browse/XWIKI-12675]]

170

* The [[Invitation Application>>extensions:Extension.Invitation Application]] now has an entry point in the App Bar (only visible to Admins).

171

* The [[Active Installs Client module>>extensions:Extension.Active Installs Client API||anchor="HFormatEvolution"]] had a bug leading to the ##sinceDays## field not being set correctly (was almost always set to 0).

172

* [[New ##xpage## parameter>>platform:DevGuide.Standard URL Format||anchor="HParameter:xpage"]]: ##outputTitle##. If ##true## then also display the title in addition to the content. Defaults to ##false## if not specified.

173

* The XWiki Syntax help now no longer shows help for syntaxes that are not available in the wiki.

174

* Added support for list properties in LDAP user synchronization

175

176

See the [[full list of JIRA issues>>http://jira.xwiki.org/issues/?filter=14214]] fixed in this release.

= For Developers =

== Extension Manager ==

181

182

=== Custom repositories ===

183

184

Extensions and dependencies can now provide custom repositories. For now only dependencies repositories are directly used when resolving it before trying registered repositories.

185

186

In practice it means that Maven custom repositories are now supported properly (at least to resolve artifacts dependencies). On Extension Manager side it means you get the same custom repositories duplicated in the Extension and in each ExtensionDependency.

187

188

Support also been added to Extension Repository API. It's also imported in XWiki based Extension Repository implementation but not yet exposed as REST resource.

189

190

=== Resolve dependencies in extension repository first ===

191

192

The extension repository is checked first when searching for extension dependencies.

193

194

== Extensions Repository ==

195

196

* New Extensions are now created in their own space by default (as the space home page). It will make it easier to organize documentation for large Extensions.

197

* Custom Extension repositories are now sent by the Extension Repository REST service

== REST API ==

It's now possible to get a page with everything but attachment content: for this you can enable various part of the document using the following URL parameters:

202

203

* ##objects##: enable returning document objects

204

* ##class##: enable returning document class properties

205

* ##attachments##: enable returning document attachments

206

207

They are all disabled by default.

208

209

Page objects support has also been added to the Page PUT API.

210

211

=== REST supports ##hidden## ===

212

213

You can now set and/or get information from the status ##hidden## of a page with REST service. For example, you may create a hidden page using the following file and the following request.

<title>Test of hidden</title>

</page>

curl \

--verbose \

--user Admin:admin \

--request PUT \

--header "Content-type: application/xml" \

229

--data-binary "@page.xml" \

230

"http://localhost:8080/xwiki/rest/wikis/xwiki/spaces/SomeSpace/pages/SomePage"

231

232

233

And then check the status of this ##hidden## status with a ##GET## HTTP request

curl \

--verbose \

--user Admin:admin \

--request GET \

--header "Accept: application/xml" \

241

"http://localhost:8080/xwiki/rest/wikis/xwiki/spaces/SomeSpace/pages/SomePage"

242

243

244

You may also use the ##application/x-www-form-urlencoded## to set this ##hidden## field.

curl \

--verbose \

--user Admin:admin \

--request PUT \

--header "Content-type: application/x-www-form-urlencoded" \

252

--data "title=Test of hidden&hidden=true&content=" \

253

"http://localhost:8080/xwiki/rest/wikis/xwiki/spaces/SomeSpace/pages/SomePage"

254

255

256

See [[The XWiki RESTful API>>platform:Features.XWikiRESTfulAPI]] for more details.

== Flamingo ==

The Drawer menu, the content menus and the top menus are now implemented with [[UI extensions>>extensions:Extension.UIExtension Module]]. The new Extension Points are:

261

262

|= [[##org.xwiki.plaftorm.drawer##>>platform:ExtensionPoint.DrawerItem]]|=[[##org.xwiki.plaftorm.drawer.header##>>platform:ExtensionPoint.DrawerHeaderItem]]|= [[##org.xwiki.plaftorm.editactions##>>platform:ExtensionPoint.Edit Actions]]|=[[##org.xwiki.plaftorm.adminactions##>>platform:ExtensionPoint.Admin Actions]]|=[[##org.xwiki.plaftorm.moreoptions##>>platform:ExtensionPoint.More Options]]

263

|(((

264

{{image reference="ReleaseNotesXWiki73M1@drawer-with-languages.png" width="50%"/}}

265

)))|(((

266

{{image reference="ReleaseNotesXWiki73M1@drawer-header.png" width="50%"/}}

267

)))|(((

268

{{image reference="ReleaseNotesXWiki73M2@editactions.png" width="50%"/}}

269

)))|(((

270

{{image reference="ReleaseNotesXWiki73M2@adminactions.png" width="50%"/}}

271

)))|(((

272

{{image reference="ReleaseNotesXWiki73M2@moreoptions.png" width="50%"/}}

273

)))

274

275

|= [[##org.xwiki.platform.topmenu.left##>>platform:ExtensionPoint.TopMenuLeft]]|=[[##org.xwiki.platform.topmenu.right##>>platform:ExtensionPoint.TopMenuRight]]

276

|(((

277

{{image reference="ReleaseNotesXWiki73RC1@TopMenuLeft.png" width="50%"/}}

278

)))|(((

279

{{image reference="ReleaseNotesXWiki73RC1@TopMenuRight.png" width="50%"/}}

280

)))

281

282

The extension point [[platform:ExtensionPoint.DrawerItem]] has now a parameter ##separator## to add a line separator before the drawer item.

== Miscellaneous ==

* New ##getReference()## API public scripting Element (Object, Class, etc.) to get the EntityReference of the element

287

* New functional tests for the [[extensions:Extension.Office Importer Application]] have been added to ##xwiki-platform##. To enable them, you need to enable the new profile ##office-tests##.

288

* For testing purpose, an environment variable ##XWIKI_OFFICE_HOME## can bet set to configure where the Office server is installed on the system.

289

* New [[Time Zone XProperty type>>platform:DevGuide.DataModel]] to represent Time Zones.

290

* The [[XAR plugin>>dev:Community.XARPlugin]] now verifies that Technical Pages are set as hidden and the Format Mojo sets them as hidden.

291

* A new [[XAR Integration testing framework>>dev:Community.Testing||anchor="HXARTesting"]] has been introduced. It can be used to write integration tests for wiki pages.

292

* Issue management information are now imported, displayed and exposed in the REST service in the Extensions Repository

293

* A ##displayTitle## option has been added to the hierarchy macros. By default, it is set to true. When disabled, the names of the references are displayed in the breadcrumb, instead of the document titles.

294

* The ##documentTree## macro has been moved to its own module, under the Index application, so that it can be used as a dependency in other modules without pulling the entire Index application.

295

* XAR plugin's [[Verify Mojo>>dev:Community.XARPlugin||anchor="HVerifyMojo"]] can now verify that defined pages have matching titles and now verifies titles of WebPreferences pages.

296

* log4j 1.2.17 and commons-logging 1.2 are now found as core extension (which prevent them being installed as dependencies)

297

298

== Deprecated and Retired projects ==

299

300

* The [[XML-RPC Integration>>extensions:Extension.XML-RPC Integration]] has been retired. It had been deprecated several years ago in favor of the [[REST API>>platform:Features.XWikiRESTfulAPI]] and it wasn't actively supported.

301

* Old query plugin finally been moved to https://github.com/xwiki-contrib/xwiki-platform-queryplugin

== Upgrades ==

The following dependencies have been upgraded:

306

307

* [[JSqlParser 0.9.4>>http://jira.xwiki.org/browse/XWIKI-12603]]

308

* [[Jackson 2.6.2>>http://jira.xwiki.org/browse/XCOMMONS-848]]

309

* [[Jackson 2.6.3>>http://jira.xwiki.org/browse/XCOMMONS-861]]

310

* [[httpclient 4.5.1>>http://jira.xwiki.org/browse/XCOMMONS-850]]

311

* [[Groovy 2.4.5>>http://jira.xwiki.org/browse/XCOMMONS-852]]

312

* [[Restlet 2.3.5 and JAX-RS 2>>http://jira.xwiki.org/browse/XCOMMONS-341]]

313

* [[Lucene and Solr 5.3.1>>http://jira.xwiki.org/browse/XWIKI-12131]]

314

* [[LessJs 2.5.3>>http://jira.xwiki.org/browse/XWIKI-12655]]

315

* [[Jetty 9.2.13.v20150730>>http://jira.xwiki.org/browse/XWIKI-12677]]. Note that this dependency is used only in the Jetty distribution.

316

* [[LiveValidation 1.4>>http://jira.xwiki.org/browse/XWIKI-12712]]

317

* [[bootswatch 3.3.5+4>>http://jira.xwiki.org/browse/XWIKI-12747]]

318

* [[less4j 1.15.2>>http://jira.xwiki.org/browse/XWIKI-12745]]

319

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

320

* [[Tika 1.11>>http://jira.xwiki.org/browse/XWIKI-12735]]

321

* [[cssparser 0.9.18>>http://jira.xwiki.org/browse/XCOMMONS-870]]

322

* [[ASM 5.0.4>>http://jira.xwiki.org/browse/XCOMMONS-872]]

323

* [[Bouncy Castle 1.53>>http://jira.xwiki.org/browse/XCOMMONS-871]]

324

* [[httpcore 4.4.4>>http://jira.xwiki.org/browse/XCOMMONS-873]]

325

* [[jQuery 1.11.3>>http://jira.xwiki.org/browse/XWIKI-12748]]

326

* [[jQuery UI 1.11.4>>http://jira.xwiki.org/browse/XWIKI-12754]]

= Translations =

The following translations have been updated:

= Tested Browsers & Databases =

336

337

338

The QA Tests are executed after the release has been done. Thus, they are being prepared now and will be published soon.

TODO: uncomment and update with proper link when the report is ready.

344

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

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

358

359

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

364

365

== Issues specific to XWiki 7.3 ==

366

367

* If you had modified the custom displayer for Time Zones in either ##XWiki.XWikiUsers## or ##XWiki.XWikiPreferences## then when upgrading to 7.3M1 your change will be removed. This is because we've introduced a Time Zone XProperty type which is replacing the String type used before for storing the Time Zones. If you wish to put back your change you can define a custom displayer on the new Time Zone XProperty in ##XWiki.XWikiUsers## or ##XWiki.XWikiPreferences##.

368

* In order to add support for Slovak and Brazilian Portuguese languages to the Solr search we had to modify the Solr schema and unfortunately we don't have support for automatic Solr search index migration at this point. If you want to support these languages you have to delete the 'solr' folder from the configured permanent directory of your XWiki instance. The Solr index will be recreated automatically and the entire wiki/farm (including the pages in the Slovak and Brazilian Portuguese language) will be re-indexed after a server restart.

369

* Old query plugin is not provided by default anymore. See https://github.com/xwiki-contrib/xwiki-platform-queryplugin.

370

* The values of the removed template "type" property of TemplateProviderClass have been migrated to the new "terminal" property.

== API Breakages ==

The following APIs were modified since XWiki 7.2:

375

376

* Add support for custom repositories in extensions: (((

377

378

org.xwiki.extension.Extension: Method 'public java.util.Collection getRepositories()' has been added to an interface

379

org.xwiki.extension.ExtensionDependency: Method 'public java.util.Collection getRepositories()' has been added to an interface

380

381

)))

382

* New URL parameters: (((

383

384

org.xwiki.rest.resources.pages.PageResource: In method 'public org.xwiki.rest.model.jaxb.Page getPage(java.lang.String, java.lang.String, java.lang.String, java.lang.Boolean)' the number of arguments has changed

385

386

)))

Wiki source code of Release Notes for XWiki 7.3

Quick Links

Let us know

About

About

Support

Platform

User Guide

Admin Guide

Developer Guide

Projects

XWiki

Extensions

Other

Contribute

Status

Practices

Under the Hood

Get Involved

Get Connected