Release Notes for XWiki 5.1 Release Candidate 1

Version 12.1 by Thomas Mortagne on 2013/06/24

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 5.1 Milestone 2)

Full list of issues fixed and Dashboard for 5.1.

Solr improvements

  • at each startup a synchronization background job is started to make sure solr index and database are in sync (only update what needs to be updated)
  • name_exact property has been added to document model in solr index to allow doing exact matching on a document (for example when search a specific document and several have similar names)
  • doclocale property is now stored in Solr index to indicate the technical locale of the document in database (locale contains the real locale after resolving default locale for default entry)

Miscellaneous

  • We changed the dashboard to display the gadget actions when hovering the gadget.

    gadgetActions.png

Full Issue List

For Developers

Merging WARs with Packager plugin

We added a contextPathMapping configuration parameter to the Packager Maven plugin to allow us to bind WAR artifact IDs to the context path where they should be extracted. Here's an example:

<plugin>
 <groupId>org.xwiki.platform</groupId>
 <artifactId>xwiki-platform-tool-packager-plugin</artifactId>
  ...
 <configuration>
   <contextPathMapping>
     <!-- Merge the WYSIWYG editor WAR with the platform web WAR. -->
     <xwiki-platform-wysiwyg-war>xwiki</xwiki-platform-wysiwyg-war>
   </contextPathMapping>
 </configuration>
</plugin>

The Packager plugin looks for WAR artifacts in the list of dependencies. If no WAR-type dependencies are found then the following WARs are used, with the corresponding default context path binding:

xwiki-platform-web: xwiki
xwiki-platform-tool-rootwebapp: root

If more WARs share the same context path then they are merged. Of course, in this case the order in the list of dependencies is important because the last WAR can overwrite files from the previous ones. When no mapping is defined for a WAR, its artifact id is used instead as context path.

Deprecated and Retired projects

<description of deprecated and retired projects>

Upgrades

The following dependencies have been upgraded:

Miscellaneous

  • Jobs don't share the same ExecutionContext anymore.
  • The WYSIWYG editor administration section has been moved from the Administration Application to its own module under xwiki-platform-wysiwyg.
  • A new Runnable wrapper to initialize and dispose ExecutionContext:
    Thread thread = new Thread(new ExecutionContextRunnable(runnable, componentManger));
    thread.start();
  • A new method to add a custom Job to the JobManager:
    Job myjob = new MyJob();
    this.jobManager.addJob(myjob);

Translations

The following translations have been updated: 

Tested Browsers & Databases

Known issues

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.

Warning

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 <version>

<issues specific to the project>

API Breakages

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

<clirr output here>

Get Connected