Release Notes for XWiki 7.4

Version 15.1 by Guillaume Delhumeau on 2015/12/28

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

<insert description of release here>

New and Noteworthy (since XWiki 7.3)

Full list of issues fixed and Dashboard for 7.4.

Notifications & Watchlist

  • A new menu has been added to the top bar, on the right: the "notifications" menu (represented by a bell). In the future, it will be the place where you can find notifications about some events happening on the wiki (personal message, a page has been modified, etc...).

    Notifications.png

  • In this menu, we have moved the Watchlist icons (watch this page, watch this wiki, etc...). These actions can be triggered with the new switch buttons

    WatchList-Notifications.png

  • The livetable of the WatchList macro have been updated to support Nested Pages.

      WatchListTable.png

App Within Minutes

The application Code and Data pages are now being created. The Code page lists the application code pages.

awmCodeHomePage.png

The application Data page shows a live table with the application entries. The application home page has been modified to include the Data page.

awmDataHomePage.png

The application entries (custom) live table results page is not generated any more because it was used only to load the translations on demand and now they are loaded on the wiki or user scope, based on the user rights.

Support for template hierarchies

When creating a new document from template, if the template has descendent documents under its path, those documents will also be copied over to the new document's location, preserving the hierarchy, as it was under the template document.

The save operation will display progress and if it was a Save&View operation, the form will be disabled until the operation is complete.

More details on the documentation page on document templates.

savingNewDocumentWithTemplateHierarchy.png

Automatic Redirect on Page Rename

The Rename Page action has a new option (selected by default) to create an automatic redirect from the old page location to the new one. This will ensure that the external links (e.g. the bookmarks) to the renamed page (and its children) will continue to work.

RenameConfirmFlamingo.png

Database Search

The Database Search UI has been modified to support nested pages.

databaseSearch.png

Miscellaneous

  • Some bootswatch themes have now a more accurate logo.
  • When the search button on the top menu is clicked, it now closes all other menus.
  • The Sandbox now uses XWiki Syntax 2.1.
  • Non terminal pages are now exported with their corresponding WebPreferences page
  • The "annotations" button in the "More Actions" menu has been moved in the same menu but with other actions and renamed "Annotate".

      Annotate.png

  • The Create Page UI allows you to view and change the location of the new page (that is going to be created) even when you open directly the URL of a new page.

See the full list of JIRA issues fixed in this release.

For Developers

Flamingo

An extension point to add content inside the new "Notifications" menu has been added:

org.xwiki.platform.notifications
NotificationsInside.png

Tree Velocity Macros

You are now able to "call" the Document Tree from Velocity using something like this:

#documentTree({
  'class': 'location-tree',
  'finder': true,
  'showAttachments': false,
  'showRoot': $showRoot,
  'showTerminalDocuments': false,
  'showTranslations': false,
  'showWikis': $showWikis
})

The same is possible with the generic Tree Widget:

#tree({
  'reference': 'XWiki.DocumentTree',
  'root': 'document:xwiki:Sandbox.WebHome',
  'openTo': 'document:xwiki:Sandbox.TestPage2'
})

All the parameters that are available for the wiki macros ({{documentTree}} and {{tree}}) should be available also for the corresponding Velocity macro.

New public Abstract job

A public org.xwiki.job.AbstractJob (and corresponding AbstractJobStatus) is now provided to help implementing a Job. An AbstractJob class already existed since a long time but it was in an internal package.

Miscellaneous

  • A new extractFirstReference(EntityType) API has been added to EntityReference: Extract the first entity of the given type from this one by traversing the current entity to the root. This differentiates it from extractReference(EntityType) which extracts the last entity of the given type.
  • The escape Velocity tool has a new method to escape CSS identifiers. This is similar to CSS.escape() available in JavaScript, and is useful if you want to create CSS selectors dynamicaly using untrusted input.
    $escapetool.css('a#b.c d[e=f]g{h:i;j}k')
    ## Output: a\\#b\\.c\\ d\\[e\\=f\\]g\\{h\\:i\\;j\\}k
  • The Document Tree Macro has a new parameter to control whether the hidden documents are filtered or not. Set to false to force the display of the hidden documents in the tree.
    {{documentTree filterHiddenDocuments="false" /}}
  • Temporary resources can now be forced to be downloaded by using the force-download=1 URL parameter

Upgrades

The following dependencies have been upgraded:

Translations

The following translations have been updated: 

Tested Browsers & Databases

Warning

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

Performances tests compared to <last super stable version>

<a summary of the comparison with latest super stable version>

More details on <link to the test report>.

Known issues

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.

Issues specific to XWiki 7.4

  • Better backward-compatibility for URLs has been added for the following 2 cases:
    • If the view action is omitted in the URL and the first space name doesn't match an action name, then the "view" action is implied
    • The view action can be specified even when the wiki is configured to hide the view action.
    • Note that this fixes some backward-compatibility issue introduced in XWiki 7.2

API Breakages

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

<clirr output here>

Get Connected