Release Notes for XWiki 5.0 Milestone 1

Version 39.1 by Thomas Mortagne on 2013/03/06
Warning: For security reasons, the document is displayed in restricted mode as it is not the current version. There may be differences and errors due to this.

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.

This release is the first release for the 5.x cycle with a new Release application and contains various Extension Manager and Distribution Wizard improvements.

New and Noteworthy (since XWiki 4.5)

Full list of issues fixed and Dashboard for 5.0.

Release Application

A new Release application is available to help you in releasing software projects.

release1.png

Office Import using the Office Macro

We added an option to the WYSIWYG Editor's Import Office Document dialog to allow you to import an office file using the Office Macro. This is useful if you don't plan to edit the content of the office file after the import or if you don't want to mix the content of the office file with the content of the wiki page.

xwe-importOfficeDocumentDialog.png

The generated wiki syntax looks like this:

{{office attachment="presentation.odp"/}}

Of course, you need to have the Office server connected in order to use this feature.

Extension Manager improvements

We added more information to the Description section and we added the ability to retrieve the list of stable versions that are available in the configured extension repositories.

EM-extensionDescription.png

We also grouped the action buttons (e.g. Install and Install of farm) as you can see in the image above. This allowed us to move the Apply button that you had to click to confirm an extension action like install from the bottom of the Progress section to the extension actions section. The Install and Install of farm buttons are still available in the drop down menu to allow you recompute the install plan if you want to.

EM-continueInstall.png

See the Extension Manager Application documentation for more information.

Distribution Wizard improvements

We fixed an important bug in Distribution Wizard () that was preventing you from properly upgrading the installed extensions in the second step. We now list extensions by the namespace (wiki) where they have been installed. For now you have to review and upgrade each extension individually. We hope to improve this soon by allowing you upgrade more extensions at once.

DW-upgradeExtensions.png

Miscellaneous

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

For Developers

Button Group Widget

We added a small widget to group form buttons.

buttonGroup.png

It can be used either with a static list of buttons, when you know beforehand that you have more than 1 button and you know the main one, or with a dynamic list of buttons, if you want the buttons to be grouped on the client side if there are more than one.

The static button group works even with JavaScript disabled (in a modern browser):

<p class="buttons">
  <span class="buttonwrapper button-group">
    <button>Action</button><a href="#foo" class="dropdown-toggle" tabindex="0"><span/></a>
    <span id="foo" class="dropdown-menu">
      <button>First item</button>
      <input type="submit" value="Second item" class="button" />
      <a href="#third">Third item</a>
    </span>
  </span>
</p>

The dynamic group obviously requires JavaScript. The first button found in the group is considered the main one. The buttons are grouped only if there are more than one. If the main button is secondary then the button group is styled as a secondary button.

<span class="dynamic-button-group">
  <span class="buttonwrapper">
    <button>One</button>
  </span>
  <span class="buttonwrapper">
    <input type="submit" class="button secondary" value="Two" />
  </span>
  <span class="buttonwrapper">
    <a href="#three" class="secondary">Three</a>
  </span>
</span>

In both cases you need to include the widget resources:

#set ($discard = $xwiki.ssfx.use('uicomponents/widgets/buttonGroup.css', true))
#set ($discard = $xwiki.jsfx.use('uicomponents/widgets/buttonGroup.js'))

Deprecated and Retired projects

<description of deprecated and retired projects>

Upgrades

The following dependencies have been upgraded:

Miscellaneous

Translations

The following translations have been updated: 

Tested Browsers & Databases

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):

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

Firefox
18.0.2

Here's the list of databases tested with this version (i.e. databases that we've tested as working - Check the list of supported databases):

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

x.x

Known issues

Test Report

You can check the manual test report to learn about what was tested and the results on various browsers.

Backward Compatibility and Migration Notes

General Notes

You may also want to import the default wiki XAR in order to benefit from all the improvements listed above.

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.

Issues specific to XWiki 5.0 Milestone 1

  • the default resolver used by the model script service moved from currentmixed to current. In practice it means $services.model.resolveDocument('') will now return a document reference with currentwiki:currentspace.currentdocument instead of currentwiki:currentspace.WebHome. See XWIKI-8834 for more details.

API Breakages

The following APIs were modified since XWiki 4.5.1:

<clirr output here>
Tags:
   

Get Connected