Release Notes for XWiki 4.5 Milestone 1

Version 17.1 by Denis Gervalle on 2013/01/14
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.

If you are migrating from an earlier version than 4.0, and your database contains statistics collected using a version earlier than 2.2, you will probably encounter an issue during our automated database migration. To avoid that issue, you will need to clean up your statistics by executing some SQL commands described in issue XWIKI-8129. Be sure to apply these before attempting the migration. If your are in doubt, apply it, these could not hurt. If you don't, you will face duplicate IDs errors during the migration process, and it will fail, preventing you to run your wiki.

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.

<insert description of release here>

New and Noteworthy (since XWiki 4.4)

Distribution Wizard improvements

When upgrading from an old version that didn't have the distribution wizard, the wizard doesn't know what user interface (XAR) was previously installed (imported). This information can help the Extension Manager merge automatically the wiki pages from your database with those from the new version of the user interface.

The distribution wizard will first ask you if you are performing an upgrade.

DW-previousUiUpgradeQuestion.png

Then you need to specify the id and version of the previously installed user interface.

DW-previousUiForm.png

Finally you need to repair the specified user interface extension. This will mark the extension as installed (update the extension index without actually importing the wiki pages from the XAR).

DW-previousUiExtension.png

Next you can install the new version of the user interface.

Translatable AppWithinMinutes apps

The AppWithinMinutes wizard is now generating a document translation bundle for the application which allows you to translate class field pretty names, list values (for static list fields) and live table columns names. If you have an existing application that was created with AppWithinMinutes you just have to edit and save it to get the new translation bundle.

If your wiki is setup for multilingual support then on the application home page, in the application menu, you now have an entry to translate the application. The link takes you to the document translation bundle.

AWM-translateAppMenu.png

When editing an application you now have the option to update the translation bundle. Note that for the moment the translation bundle (its default language) is regenerated so you may lose translation keys you added yourself. In the future we want to update the translation bundle preserving the custom keys.

AWM-updateTranslationsOption.png

See the AppWithinMinutes documentation for more information.

Miscellaneous

  • The message sender is now using the new user/group picker.

    messageSender-userPicker.png

  • The create and manage workspace forms are now using the new user picker.

    createWorkspace-ownerAndMembers.png

  • We improved the way changes are displayed by emphasizing the in-line changes.

    unifiedDiff.png

  • Support for searching content in Java Class file attachments has been temporarily dropped.
  • Markdown syntax support has been completely rewritten, fixing several existing bugs.

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

For Developers

<developer feature N>

<description of developer feature N>

Deprecated and Retired projects

<description of deprecated and retired projects>

Upgrades

The following dependencies have been upgraded:

  • <list libraries that have been upgraded>

Miscellaneous

<other dev stuff to add and link to JIRA for all issues fixed>

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.ReleaseNotesXWiki45M1]. 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

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.ReleaseNotesXWiki45M1]. 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

PLEASE, BACKUP YOUR DATABASE BEFORE STARTING YOUR WIKI.
AUTOMATED MIGRATION PROCEDURE TAKE PLACE AT STARTUP AND YOU MAY NEED TO START OVER IF YOU ENCOUNTER AN UNEXPECTED ISSUE.

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.

If you are migrating from an earlier version than 4.0, and your database contains statistics collected using a version earlier than 2.2, you will probably encounter an issue during our automated database migration. To avoid that issue, you will need to clean up your statistics by executing some SQL commands described in issue XWIKI-8129. Be sure to apply these before attempting the migration. If your are in doubt, apply it, these could not hurt. If you don't, you will face duplicate IDs errors during the migration process, and it will fail, preventing you to run your wiki.

If you have encountered an issue with the migration, you may need to start over from a backup. Be careful that during the migration, two new tables have been created (in each xwiki database for a farm) and should be dropped when you restore a backup of a database coming from a version earlier than 4.x. These two tables are DATABASECHANGELOG and DATABASECHANGELOGLOCK. These should only be removed if you restore a pre-4.x database schema. Mixing an old database with these two tables will surely cause issue during schema updates (liquibase checksum failure).

Issues specific to XWiki 4.5M1

<issues specific to the project>

API Breakages

The following APIs were modified since XWiki 4.4:

<clirr output here>

Get Connected