Release Notes for XWiki 6.1 Milestone 1

Last modified by Thomas Mortagne on 2017/03/24

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.

This release introduces the ability to change the width of the panel columns and comes with an improved Active Installs feature. Developers can now use the LESS preprocessor for skin style sheets. A couple of bug fixes (18) and some small improvements (24) make this release worth trying.

New and Noteworthy (since XWiki 6.0)

Full list of issues fixed and Dashboard for 6.1.

Improved Active Installs

The Active Installs feature has been improved a lot and a new data format has been set up in order to be able to provide more information, namely:

  • Graphing of Active Installs counter over time
  • Display pie charts of XWiki versions, Java versions, Servlet Containers and Databases used for Active Installs

as-dashboard

In addition it's now registered in the Applications Panel:

activeinstallsentry.png

Improved Panels

  • It is now possible to change the width of the panel columns:

panelWizard.png

  • Inside a panel, you can know the current width with the $xwikiPanelWidth variable.

Miscellaneous

  • The user directory is now displaying the user id (alias) instead of the full user document reference which is too technical:

    userDirectory.png

  • Added ability to configure Pie Chart labels using the pie_label_format property. For example using pie_label_format:{0} - {2} would give:

    pielabel.png

  • XWiki now support resolving a Maven extension with a parent from a different Maven repository
  • More HTTP cache settings, configurable using xwiki.httpheaders.cache in xwiki.cfg or headers_nocache in XWiki.XWikiPreferences:
    • 0: no Cache-Control header sent, use the browser's defaults. RFC 2616 only specifies optional behavior in this case
    • 1 (default): no-cache; caches must not serve this response in a subsequent response, but the page is stored for the bf-cache
    • 2: no-store, no-cache and max-age=0; the response will never be reused, not even for bf-cache; note that unsaved changes may be lost
    • 3: private; the response will be cached by personal caches, such as a browser cache
    • 4: public; the response may be cached by both personal and shared caches
  • To ensure the compatibility with Internet Explorer 8, the Flamingo skin uses Respond.js and HTML5Shiv. It enables CSS3 media queries and HTML5 tags.
  • "Human" requests like view or edit are not waiting XWiki initialization forever and display a waiting page with initialization progress instead: init.png

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

For Developers

LESS integration

  • We are happy to propose the ability of using the LESS preprocessor directly in XWiki. Right now, it is only able to compile some files located in the skin directory in the WAR. See LESS Module.

Upgrades

The following dependencies have been upgraded:

Miscellaneous

  • XCOMMONS-582: $escapetool.json should be used instead of $escapetool.javascript for escaping manually constructed JSON; $jsontool.serialize should be used for generating JSON, though, since it is safer.
  • Introduced job progress helper API, see Job Module for more details.
  • All component related API of com.xpn.xwiki.web.Utils are now using the context ComponentManager by default.
  • We added a new method to the component script service to access the component manager corresponding to a specific namespace:
    {{groovy}}
    def instanceForTestWiki = services.component.getComponentManager("wiki:test").getInstance(SomeRole.class)
    {{/groovy}}

Translations

The following translations have been updated: 

Tested Browsers & Databases

Failed to execute the [velocity] macro. Cause: [The execution of the [velocity] script macro is not allowed in [xwiki:TestReports.ManualTestReportXWiki61M1Summary]. Check the rights of its last author or the parameters if it's rendered from another script.]. Click on this message for details.

Here is the list of browsers we support and how they have been tested for this release:

BrowserStatus
Chrome30.pngGoogle Chrome 35Smoke tests
Firefox30.pngMozilla Firefox 29 Jira Tickets Marked as Fixed in the Release Notes, Migration from 5.4.4, Smoke tests
IE30.pngInternet Explorer 8Not Tested
IE30.pngInternet Explorer 9Smoke tests

Here is the list of databases we support and how they have been tested for this release:

DatabaseStatus
hypersql.pngHyperSQL 2.3.2 Jira Tickets Marked as Fixed in the Release Notes
mysql.pngMySQL 5.6.17Not Tested
oracle.pngOracle 11.2 Migration from 5.4.4
postgresql.pngPostgreSQL 9.3.4Not Tested

For the full list of tests see this page.

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.

API Breakages

The following APIs were modified since XWiki 6.0:

  • Young API
org.xwiki.activeinstalls.server.DataManager: Method 'public com.google.gson.JsonObject countInstalls(java.lang.String, java.lang.String, java.util.Map)' has been added to an interface
org.xwiki.activeinstalls.server.DataManager: Method 'public long getInstallCount(java.lang.String)' has been removed
org.xwiki.activeinstalls.server.DataManager: Method 'public com.google.gson.JsonObject searchInstalls(java.lang.String, java.lang.String, java.util.Map)' has been added to an interface
org.xwiki.activeinstalls.server.script.ActiveInstallsScriptService: Method 'public long getInstallCount(java.lang.String)' has been removed

Get Connected