Release Notes for XWiki Enterprise 2.0

New and Noteworthy (since XWiki Enterprise 1.9.3)

Colibri skin

See Colibri skin documentation for more details.

XWiki 2.0 introduces a new, lightweight, easily customizable skin. The main goal of the Colibri skin is to provide the proper support for fast and easy modifications of the look and feel of the wiki. The Colibri skin colors and decorative images are defined in ColorTheme objects inside Wiki documents, that can be changed directly in the web interface.

Several predefined themes are bundled with XE:

General UI

• Make section editing work for any section level. You can configure it using the new property xwiki.section.depth in xwiki.cfg file
• Change button order in preview mode
• Make all skins display the document title as the top level header and ensure there's no duplicate titles displayed. WarningNot all the pages has been converted to new title handling. It will be fixed during the 2.0.x branch life (hopefully for 2.0.1).
• Space Index, Document Index and Orphaned Page now use generic livetable tools
• Remove "History" from the edit modes
• TOC macro now starts at first level by default
• Several IE6/7 bugfixes
• Improve group creation form
• Reorganize editor button
• Diff UI improvement
• Improve the Rename form
• Nicer pagination of the document history
• Display a friendly message instead of an error when clicking on History after having created a new page
• The "Rights editor help" panels has been removed
• Improve Import administration section
• Improved document footer section
• Improved tag display and editing

WYSIWYG

See WYSIWYG documentation for more details.

• Upgrade to GWT 1.7.0
• Faster navigation for image and link insertion
• Add internationalization support
• Improve UX in wysiwyg dialogs / wizards: navigation, error reporting, forms, etc

Double click to edit a macro

User can now double click on a macro to edit it and double click in the list of macro to insert it.

Nicer macro names in the list of macros

WYSIWYG does not expose macro identifier anymore but human readable names provided by the different macros.

Macros categories

Each macro can now be added in a default category the macro author thinks appropriate. It's also possible to overwrite the macro category with configuration.

The macros categories are mainly used in WYSIWYG to make it easier to find the macros to use.

Rendering 2.0

• New Section editing
• Allow default document syntax to be specified in User profile configuration

Output syntax parameter

It's now possible to decide which renderer to use to print the document content. For example if you want to generate dome JSON page you can use "?outputSyntax=plain&xpage=plain" to make sure only the content is printed and there is no html syntax printed, just a plain text of what exactly was generated by a velocity macro (without macro markers html comments etc.)

See URL parsing documentation.

New Wiki rendering 2.0 macros

See WikiMacroTutorial.

New Tag Cloud Panel

A panels containing the tag cloud is now provided by default and can be used like any other panel.

New Search Interface

The default search page UI has been improved to be easier to understand and use.

New info, warning and error macros

See Message macro documentation for more details.

New Chart macro for XWiki 2.0 syntax

See Chart macro documentation.

Script macro improvements

See the Script Macro documentation for more details.

• It's now possible to add JARs attached to a page to the Script Macro class loader.
• All the script macros in the same rendering process (a document and it's included documents) share the same class loader. For example this makes possible to declare a groovy class in a document and use it in other documents which includes it.
• It's now possible to not parse velocity macro content for wiki syntax by using the wiki="false" parameter.

New Python macro

See PythonMacro for more details.

Footnote macro

See Footnote macro documentation.

Formula macro

Ability to render Mathematical Formulas using the {{formula}} macro (see documentation page).

You can check for examples on the Wikipedia Math Markup page.

Smaller XHTML output

We introduced a light XHTML renderer which avoid having all extra datas needed by the WYSIWYG. You will not get any weird XHTML comment anymore in the rendered page.

Renderers are now real components

The same way it's possible to add any parser it's now possible to add any renderer for a specific output simply by registering it as a component.

See RenderingModule for more details.

New plain text parser

Plain text parser make possible to put in a page some plain text to render it exactly as it. The syntax name of plain text renderer is plain/1.0, you can enable it in xwiki.cfg.

Scheduler improvements

• Allow to manually trigger a job (execute it once)
• Upgrade to Quartz 1.6.5

Watchlist

• Add watch/unwatch wiki in the Watch menu
• Improve notification email readability by displaying icons for objects, classes and properties
• Watch List support registering for user activity
• Put document metadata modifications in diffs
• Make the watchlist work across multiple wikis
• Put links to pages in email notifications
• Use activitystream feed building feature to generate watchlist RSS feed
• In virtual mode allow each wiki to have its own watchlist email template document
• big speed improvement by refactoring the watchlist based on activity stream plugin
• add support for class and object diff in the mails
• add support for full wiki watching
• allow to create watchlist notifications for any interval of time
• mails design improvement

New Activity stream

• Provide a way to delete events after a configurable amount of time
• Allow to store all activity events in the main wiki in virtual mode

New events for XWiki startup/shutdown

It's now possible for a component or a plugin to register to startup or shutdown events. It's very useful when some plugin need to start and stop an external service.

Velocity tools and Velocity properties can be easily changed

See velocity.tools and velocity.properties parameters in xwiki.properties.

1.1.1 Component Manager api improvements

• Add way to directly provide the component instance when register it
• Add way to unregister component

1.1.1 New xwiki-properties module

• Java bean populating support
• Java type conversion support
• Java bean validation support

Among other things this mean the following changes for the 2.0 macros:

• any case is supported for macros parameters names
• public fields are now supported (not only getters and setters)
• java macro parameters bean is validated agains JSR 303 (See )
• macro properties java bean can implements RawProperties to get custom non converted parameters
• you can add support for any type conversion by implementing Converter component
• any Enum conversion is supported (no need to register each Enum subclass agains ConvertUtils anymore)
• support for Color conversion

See [Properties module documentation>code:Modules.PropertiesModule].

1.1.1 Remote Observation Manager

It's now possible to make different instances of XWiki or other programs shares events.

The main use cases for this are:
- clustering
- external monitoring of XWiki

This release include documents events support for code using new Observation Manager and remote events support in document cache so that's it's possible to do basic clustering already. The old code using old notification system will be upgraded during the RC process before the final 2.0 version and support will be added for other types of events. Note that Remote Observation Manager already support any kind of fully Serializable events.

Known issues

• Bugs we know about

Backward Compatibility and Migration Notes

General Notes

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

API Breakages

The following APIs were modified since XWiki Enterprise 1.9:

• Rendering Module
  • >Block.replace() has been replaced by Block.replaceChild()>
  • ParseException constructor and methods have been modified since they were unused
  • XWikiXHTMLImageRenderer and XWikiXHTMLLinkRenderer classes have been moved to a XWiki-specific module so that the main Rendering module can be used standalone
  • Merged SimpleXHTMLImageRenderer and XWikiXHTMLImageRenderer into DefaultXHTMLImageRenderer which now handles the case where we're inside a wiki or not
  • Merged SimpleXHTMLLinkRenderer and XWikiXHTMLLinkRenderer into DefaultXHTMLLinkRenderer which now handles the case where we're inside a wiki or not
  • AbstractBlock constructors has been refactored to make easier to create new common macros. Main change is that the macro author does not have to provide the MacroDescriptor anymore.
  • Macro parameters bean are now supposed to use xwiki-properties annotations instead of org.xwiki.rendering.macro.descriptor.annotation.* annotations. Simply change org.xwiki.rendering.macro.descriptor.annotation.Parameter* by org.xwiki.properties.annotation.Property* to upgrade you macro parameters bean.
  • Macro have to provide a human readable name in various AbstractMacro helpers constructors
  • Big refactor around renderers and the way to use them since they are real components now
  • Syntax, SyntaxFactory and SyntaxType classes moved to the proper package (org.xwiki.rendering.syntax)
  • Definition lists now take parameters
  • Details:
    
    {{code}}
    
    == Dependencies
    
    This release includes the following modules in the specified versions since XWiki Enterprise 1.9.3 was released:
    
    === Core/Web
    
    |=Group Id|=Artifact Id|=New Version|=Old Version|=JIRA URL
    |##com.xpn.xwiki.platform##|##xwiki-*##|2.0|1.9.3|
    |##org.xwiki.platform##|##xwiki-*##|2.0|1.9.3|
    
    === Applications
    
    |=Group Id|=Artifact Id|=New Version|=Old Version|=JIRA URL
    |##com.xpn.xwiki.platform.applications##|##xwiki-application-administration##|1.17|1.12|[[jira>>http://jira.xwiki.org/jira/browse/XAADMINISTRATION]]
    |##com.xpn.xwiki.platform.applications##|##xwiki-application-blog##|1.12|1.8|[[jira>>http://jira.xwiki.org/jira/browse/XABLOG]]
    |##com.xpn.xwiki.platform.applications##|##xwiki-application-officeimporter##|1.11|1.9|[[jira>>http://jira.xwiki.org/jira/browse/XAOFFICE]]
    |##com.xpn.xwiki.platform.applications##|##xwiki-application-panels##|1.24|1.20.1|[[jira>>http://jira.xwiki.org/jira/browse/XAPANELS]]
    |##com.xpn.xwiki.platform.applications##|##xwiki-application-scheduler##|1.12|1.11|
    |##com.xpn.xwiki.platform.applications##|##xwiki-application-statistics##|1.5|1.4|
    |##com.xpn.xwiki.platform.applications##|##xwiki-application-tag##|1.7|1.7|
    |##com.xpn.xwiki.platform.applications##|##xwiki-application-watchlist##|1.20|1.16|
    |##com.xpn.xwiki.platform.applications##|##xwiki-application-webdav##|1.2|1.2|
    |##com.xpn.xwiki.platform.applications##|##xwiki-application-wiki-macro-bridge##|1.2|N/A|
    
    === Plugins
    
    |=Group Id|=Artifact Id|=New Version|=Old Version|=JIRA URL
    |##com.xpn.xwiki.platform.plugins##|##xwiki-plugin-activitystream##|1.4|N/A|
    |##com.xpn.xwiki.platform.plugins##|##xwiki-plugin-jodatime##|1.3|1.3|
    |##com.xpn.xwiki.platform.plugins##|##xwiki-plugin-lucene##|1.10|1.8|
    |##com.xpn.xwiki.platform.plugins##|##xwiki-plugin-mailsender##|1.13|1.10|
    |##com.xpn.xwiki.platform.plugins##|##xwiki-plugin-scheduler##|1.12|1.9|
    |##com.xpn.xwiki.platform.plugins##|##xwiki-plugin-skinx##|1.10|1.9|
    |##com.xpn.xwiki.platform.plugins##|##xwiki-plugin-tag##|1.7|1.6|
    |##com.xpn.xwiki.platform.plugins##|##xwiki-plugin-watchlist##|1.20|1.16|
    
    === Skins
    
    |=Group Id|=Artifact Id|=New Version|=Old Version|=JIRA URL
    |##com.xpn.xwiki.platform.skins##|##xwiki-skin-albatross##|1.24|1.21|
    |##com.xpn.xwiki.platform.skins##|##xwiki-skin-colibri##|1.3|N/A|
    |##com.xpn.xwiki.platform.skins##|##xwiki-skin-toucan##|1.28|1.22|
    
    === Top Level POM
    
    |=Group Id|=Artifact Id|=New Version|=Old Version|=JIRA URL
    |##com.xpn.xwiki.platform##|##xwiki##|27|24|
    
    === Tools
    
    |=Group Id|=Artifact Id|=New Version|=Old Version|=JIRA URL
    |##org.xwiki.platform.tools##|##xwiki-jetty-resources##|1.16|1.14|
    |##org.xwiki.platform.tools##|##xwiki-rootwebapp##|1.2|1.1|
    |##org.xwiki.platform.tools##|##xwiki-xar-handlers##|1.9|1.8|
    |##org.xwiki.platform.tools##|##xwiki-xar-plugin##|1.13|1.12|
    |##org.xwiki.platform.tools##|##xwiki-configuration-resources##|1.32|1.27|
    |##org.xwiki.platform.tools##|##xwiki-packager-plugin##|1.13|1.12|
    |##org.xwiki.platform.tools##|##xwiki-license-resources##|1.1|1.0|
    |##org.xwiki.platform.tools##|##xwiki-verification-resources##|1.14|1.13|