Release Notes for XWiki 5.3 Milestone 1

Version 17.1 by Thomas Mortagne on 2013/10/16

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.

<insert description of release here>

New and Noteworthy (since XWiki 5.2)

Full list of issues fixed and Dashboard for 5.3.

<feature N>

<description of feature N>

Miscellaneous

  • Some XSS fixes

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

For Developers

DocumentReference Locale now taken into account in XWiki#exists and XWiki#getDocument

You can now use XWiki#exist method to check for some translation existence too, before that the only way was to either load the XWikiDocument or write your own XWQL or HQL query.

XWiki#getDocument has been modified accordingly too to be consistent so you don't need to go through XWikiDocument#getTranslatedDocument anymore.

It also mean that you need to be careful of what Locale is in the DocumentReference with those APIs now.

New Extension Manager APIs

Extension sub script services

The extension service now expose an extension point for extension related script service so that it's used as entry point for all of them.

By default the following are provided:

  • $services.extension.core (for core extensions APIs)
  • $services.extension.local (for local extensions APIs)
  • $services.extension.installed (for installed extensions APIs)
  • $services.extension.xar (for XAR extension APIS)

Search for installed extension in a specific namespace

The following method has been added org.xwiki.extension.repository.InstalledExtensionRepository:

    /**
     * Search installed extensions based of the provided pattern and only in the passed namespace.
     * <p>
     * The pattern is a simple character chain.
     *
     * @param pattern the pattern to search
     * @param namespace the namespace where to search
     * @param offset the offset from where to start returning search results
     * @param nb the maximum number of search results to return
     * @return the found extensions descriptors, empty list if nothing could be found
     * @throws SearchException error when trying to search provided pattern
     * @since 5.3M1
     */

    IterableResult<Extension> searchInstalledExtensions(String pattern, String namespace, int offset, int nb) throws SearchException;

XWiki Enterprise Archetype

A new archetype is now available to easily create your own product based on XWiki Enterprise. To use:

mvn archetype:generate \
 -DarchetypeArtifactId=xwiki-enterprise-archetype \
 -DarchetypeGroupId=org.xwiki.enterprise \
 -DarchetypeVersion=5.3-milestone-1

XAR plugin improvements

The XAR plugin now provides the ability to change values in the XML pages. For example:

<plugin>
 <groupId>org.xwiki.commons</groupId>
 <artifactId>xwiki-commons-tool-xar-plugin</artifactId>
 <configuration>
   <transformations>
     <transformation>
       <file>Blog/WebHome.xml</file>
       <xpath>/xwikidoc/object/property/itemsPerPage</xpath>
       <value>100</value>
     </transformation>
     <transformation>
       <artifact>org.xwiki.platform:xwiki-platform-administration-ui</artifact>
       <file>XWiki/XWikiPreferences.xml</file>
       <xpath>/xwikidoc/object/property/colorTheme</xpath>
       <value>ColorThemes.Mint</value>
     </transformation>
   </transformations>
 </configuration>
</plugin>

Miscellaneous

Deprecated and Retired projects

<description of deprecated and retired projects>

Upgrades

The following dependencies have been upgraded:

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.

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

Get Connected