Release Notes for XWiki 6.2 Milestone 2

Last modified by Thomas Mortagne on 2017/03/24
Contents

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 mostly focuses on the Flaming skin and sets it as the new default skin for XWiki. A new themes application for the new skin is introduces, along with the AppBar set by default and other various UI polishes and improvements. On the developers side, a new "blame" API has been introduced and some dependencies were upgraded. Finally, a considerable amount of bug fixes (34) and improvements (32) were made so make sure to try it out.

Since the Flamingo skin is now the default skin and we wish to make it as good as possible for the final 6.2 release, please report as many issues you notice in our Issue Tracker. Thanks!

New and Noteworthy (since XWiki 6.2M1)

Full list of issues fixed and Dashboard for 6.2.

Flamingo

  • Flamingo is the new default skin in XWiki!
  • The applications panel (also known as the "Applications Bar") has been set by default on the left panel.
  • The default icon theme is now Font Awesome.
  • A new application has been made to manage color themes on Flamingo. It does not only permit to change colors anymore, but also the typography, etc... That is why it is called Flamingo Theme Application.
    FlamingoThemeEditor.png
  • By default, a new theme is enabled: FlamingoDefaultTheme, made with the new application described above.
  • Colibri Skin can use the themes from Flamingo thanks to a mapping between Flamingo Theme Application and Color Theme Application. The results may not be perfect though.
  • Improved Login form

    flamingoLogin.png

  • The page headers from Colibri ColorThemes can be displayed for Flamingo skin by setting the $displayPageHeader to true in layoutExtraVars.vm. By default this variable is set to false

    Flamingo_displayPageHeader_false.png Flamingo_displayPageHeader_true.png 

  • You can control whether or not you want to display the create and the "more actions" menus with 2 new variables: $displayCreateMenu and $displayMoreActionsMenu. You can manually set them in the layoutExtraVars.vm file.

    You can see the results of all this changes in the following screenshot:
    flamingo.png

Miscellaneous

  • ModalPopup and LightBox resource components are now responsive. For small resolutions their width will occupy the whole screen.

    afterAddUsers.png afterSharebyEmail.png 

  • Deleted document translations can now be restored, even if the main document or a different translation has already been restored (as long as no conflict exists). See XWIKI-9567 and the documentation.

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

For Developers

Building XWiki is now possible using Maven 3.1 and 3.2

The packager Maven plugin was using temporary APIs used only in Maven 3.0, which made it impossible to build modules depending on that plugin with other versions of Maven than 3.0.x. This has now been fixed, and the build works with any 3.x Maven version.

Blame generic API and Script Service

Provides the implementation of the blame/annotate/praise algorithm.

Like the diff module API, this API is not tied to any type so you have to first transform the datas you want to blame into lists and you will be able to link them with any kind of revision metadata. Blame will link each elements of the initial list with the revision metadata of the original revision it came from. You will have to call blame in loop with each revised list, starting from the most recent one, until all element are annotated.

See Blame Module for more information.

Upgrades

The following dependencies have been upgraded:

Miscellaneous

  • New $doc.isTranslation() method is available in the web API. See XWIKI-10805
  • xwiki-platform-font-awesome has been moved in the xwiki-platform-icon module and renamed xwiki-platform-icon-fontawesome.
  • Icon Theme can now use JavaScript Extensions.
  • The Icon class of the Icon Theme does not store the name of the icon anymore, since it is already stored in a map in the IconSet class (better memory usage).
  • It is now possible to compile a LESS file or to compute a color theme from an other skin.
  • xwiki-platform-less-css has been renamed xwiki-platform-lesscss in order to be consistent with our naming conventions.

Tested Browsers & Databases

Failed to execute the [velocity] macro. Cause: [The execution of the [velocity] script macro is not allowed in [xwiki:TestReports.ManualTestReportXWiki62M2Summary]. 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 36Not Tested
Chrome30.pngGoogle Chrome 37Smoke testing
Firefox30.pngMozilla Firefox 31Jira Tickets Marked as Fixed in the Release Notes
IE30.pngInternet Explorer 8Not Tested
IE30.pngInternet Explorer 9Not Tested
IE30.pngInternet Explorer 10Full Tested

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

DatabaseStatus
hypersql.pngHyperSQL 2.3.2Jira Tickets Marked as Fixed in the Release Notes Full Tested
mysql.pngMySQL 5.6.17Not Tested
oracle.pngOracle 11.2Not Tested
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.1:

  • Young APIs:
    org.xwiki.rendering.transformation.RenderingContext: Method 'public org.xwiki.rendering.syntax.Syntax getTargetSyntax()' has been added to an interface
    org.xwiki.wiki.descriptor.WikiDescriptorManager: Method 'public java.util.Collection getAllIds()' has been added to an interface
    org.xwiki.mail.MailSender: Method 'public void send(javax.mail.internet.MimeMessage, javax.mail.Session, org.xwiki.mail.MailResultListener)' has been removed
    org.xwiki.mail.MailSender: Method 'public void sendAsynchronously(javax.mail.internet.MimeMessage, javax.mail.Session, org.xwiki.mail.MailResultListener)' has been added to an interface
    org.xwiki.mail.MailResultListener: Parameter 2 of 'public void onError(javax.mail.internet.MimeMessage, java.lang.Throwable)' has changed its type to java.lang.Exception
    org.xwiki.mail.script.MimeMessageWrapper: Parameter 1 of 'public MimeMessageWrapper(javax.mail.internet.MimeMessage, javax.mail.Session, org.xwiki.mail.MailSender, org.xwiki.context.Execution, org.xwiki.component.manager.ComponentManager)' has changed its type to org.xwiki.mail.internal.ExtendedMimeMessage
    org.xwiki.mail.script.MimeMessageWrapper: Return type of method 'public javax.mail.internet.MimeMessage getMessage()' has been changed to org.xwiki.mail.internal.ExtendedMimeMessage
  • The extended class got moved to a new package with the upgrade to velocity-tools 2.0 and the old location got deprecated.
    org.xwiki.velocity.XWikiWebappResourceLoader: Removed org.apache.velocity.tools.view.servlet.WebappLoader from the list of superclasses

About

About

Support

Platform

User Guide

Admin Guide

Developer Guide

Projects

XWiki

Extensions

Other

Contribute

Status

Practices

Under the Hood

Get Involved

Get Connected