XWiki Enterprise 2.2 Milestone 1 (XWiki.org)

First milestone of the XWiki Enterprise 2.2 version ([[Roadmap>>enterprise:Main.Roadmap]]).

The highlights of this release are: the possibility to register wiki macros for any user or wiki, improvements of the import interface, support for OOXML (MS Office 2007) documents in the office import feature, started introducing the new Model, new UIs for viewing the contents of the document and attachment trash, and further improvements towards UI consistency and accessibility.

6

7

= New and Noteworthy (since XWiki Enterprise 2.1.1) =

8

9

== Contextual wikimacros ==

10

11

Previously, [[wiki macros>>platform:DevGuide.WikiMacroTutorial]] could only be defined by users with administrator rights, and only in the main wiki (when in a virtual wiki farm). It's now possible for any user to register wiki macros, and in any wiki. However, this follows some user rights restrictions, preventing a limited user to write dangerous scripts available to all other users. For example, if the user does not have the proper rights, only he will see and use the macro he registered. To make the macro available globally, an administrator must re-save it.

== Trash ==

While deleted documents and attachments have been stored in a trash instead of being completely deleted since XWiki 1.2, there was no general interface for viewing the contents of the trash. This has been remedied by the introduction of two new tabs in the wiki's Document Index, //Deleted Documents// and //Deleted Attachments//.

image:trash1.png

Both use the livetable, thus allowing filtering and ordering for easier browsing. A document from the trash can be viewed, permanently deleted, or restored if the location is still available.

image:trash2.png

The attachment trash contains only attachments deleted from a document, and not attachments that were deleted together with their owner document; in the latter case, the attachments are kept together with the document in the document trash. For attachments, there is no restore option yet, it will be implemented in a future release.

image:trash3.png

== General UI improvements ==

28

29

* In the wiki source code viewer, allow to toggle line numbers faster from Javascript

30

* Enable full screen view when displaying the wiki source code (viewer=code)

31

* Internationalize macro descriptors

32

* ActionMenu: Add Profile submenu item to the "current user" menu

33

image:XSCOLIBRI-170.png

34

* Reorder the document actions in the "More actions" menu: copy, rename, delete

35

* More UI components make use of the (recently introduced) color theme

36

37

== Development improvements ==

38

39

* Added support for "xcontext" binding in 1.0 groovy macro

40

* Allow set to null in velocity

41

* Add an API method for creating a LinkedHashMap

42

* New APIs for accessing deleted attachments from the trash

43

* The class wizard should propose to add a SheetClass object to the class sheet

44

* Add support for 'on page' style extensions

45

46

== Office import improvements ==

47

48

* Added support for Office2007 document formats

49

50

== XAR Import improvements ==

51

52

The XAR import interface has been revamped. The new interface (see screenshots below) now provides :

53

54

* More explicit options regarding revision history handling

55

* The new option to **add a new version to existing documents** instead of overriding them

56

* A rich UI that allows to select/unselect whole spaces at once

57

* Support for importing when no javascript is available. The UI degrades nicely to a less rich interface

58

59

[[image:importer.png||width="700"]]

60

61

== Blog improvement ==

62

63

* Add the Create a new post to category pages - when used by default select that category

64

65

== Dependencies upgrade ==

66

67

* Upgraded to Groovy 1.7

68

69

== New Model module with Reference implementation ==

70

71

The goal is to provide [[APIs>>http://svn.xwiki.org/svnroot/xwiki/platform/core/trunk/xwiki-model/]] to remove all String manipulations around documents and attachment names. It also introduces the concept of Reference for any entity of the model and the parser/serializer associated. For now Wiki, Space, Document and attachment are supported; classes objects and properties should come in milestone 2.

72

73

From a user point of view this will result in supporting any character in document names for example. In addition, this is also a step in the direction of supporting nested spaces (the storage would also need to be changed to support that).

74

75

In practice the existing code has not yet been fully refactored to benefit from the new implementation. The work has been started in XWiki Enterprise 2.2 Milestone 1 and will continue in XWiki Enterprise 2.2 Milestone 2 and beyond.

== Miscellaneous ==

* Always use UTF-8 for URL encoding

80

* Attachments should produce document modification events

81

82

* Lots of accessibility fixes

* Lots of bugs fixes

= Known issues =

* [[Bugs we know about>>http://jira.xwiki.org/jira/secure/IssueNavigator.jspa?reset=true&&type=1&pid=10010&resolution=-1&sorter/field=updated&sorter/order=DESC]]

88

* A regression was introduced in this release: Parent references are saved in the Database without the space prefix. The consequence is that getChildren() will fail to return all children when the current document is located in another space. A more direct consequence is that rename will not rename all pages having a parent pointing to the document being renamed. This has been fixed in XE 2.2M2 but you'll need to resave the documents to have their parents saved correctly in the database.

89

90

= Backward Compatibility and Migration Notes =

91

92

== Important non-compatible changes ==

93

94

95

The way URLs are generated and parsed has changed. While previously the wiki encoding was used to convert non-ASCII bytes to their ##%XY## escapes, as allowed by the older HTTP/URL specifications, now all URLs escape the UTF-8 bytes of the path, to better adhere to the modern URI specification. This should only affect non-UTF-8 wikis, and only by breaking some bookmarks.

The velocity configuration has been changed so that setting ##null## values to variables is now allowed. This could break some scripts and macros, please check before upgrading.

100

101

102

This means that the following script will generate a different result:

#set($s = 'abc')

$s

#set($s = $util.null)

$s

While previously the result would have been ##abc abc##, now it is ##abc $s##.

112

113

Special care must be taken care with constructs like the following:

#set($var = '')

#set($var = $xwiki.methodThatMightReturnNull())

#if($var != '')

The method succeeded

#else

The method failed

#end

Since ##null != ''## in Velocity, now a different branch will be executed. The following rewrites work.

126

127

Works in both modes, with or without null allowed:

128

129

#set($var = '')

130

#set($var = $xwiki.methodThatMightReturnNull())

#if("$!var" != '')

The method succeeded

#else

The method failed

#end

Works only in the new mode, with null allowed, but is shorter, slightly faster, and more familiar for java developers:

139

140

#set($var = $xwiki.methodThatMightReturnNull())

141

#if($!var != $util.null)

The method succeeded

#else

The method failed

#end

== General Notes ==

{{warning}}If you're running in a multiwiki setup you'll also need to define the property //xwiki.store.migration.databases=all// to your //xwiki.cfg// file or explicitly name all databases to be migrated as in <tt>xwiki.store.migration.databases=db1,db2,...//.{{/warning}}

151

152

You may also want to [[import the default wiki XAR>>Main.Download]] in order to benefit from the improvements listed above.

153

154

{{warning}}Always make sure you compare your //xwiki.cfg// file with the newest version since some configuration parameters were added. Note 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.{{/warning}}

155

156

== Migration Notes ==

157

158

* The new parser/serializer for document names comes with new features and changes some behaviors:

159

** introducing escaping means:

160

*** ##\## which is now the escaping character needs to be doubled in full document name, as in ##Space.Docu\\ment##, which means space ##Space## and document ##Docu\ment##

161

*** some generated documents names will now contains ##\## to escape thing like dot in a document name. For example ##Space.Docu\.ment## means space ##Space## and document ##Docu.ment##

162

** support for the syntax ##wikiname:Document## has been dropped, so in this example "wikiname:Document" will be seen as the document name because no ##.## has been found

= Dependencies =

This release includes the following modules in the specified versions since XWiki Enterprise 2.1.1 was released.

== Core/Web ==

== Applications ==

== Plugins ==

== Skins ==

== Top Level POM ==

|=Group Id|=Artifact Id|=New Version|=Old Version

210

|##com.xpn.xwiki.platform##|##xwiki##|28|28

== Tools ==

Wiki source code of XWiki Enterprise 2.2 Milestone 1

Quick Links

Let us know

About

About

Support

Platform

User Guide

Admin Guide

Developer Guide

Projects

XWiki

Extensions

Other

Contribute

Status

Practices

Under the Hood

Get Involved

Get Connected

author	version	line-number	content
		1	{{box cssClass="floatinginfobox" title="Contents"}}{{toc/}}{{/box}}
		2
		3	First milestone of the XWiki Enterprise 2.2 version ([[Roadmap>>enterprise:Main.Roadmap]]).
		4
		5	The highlights of this release are: the possibility to register wiki macros for any user or wiki, improvements of the import interface, support for OOXML (MS Office 2007) documents in the office import feature, started introducing the new Model, new UIs for viewing the contents of the document and attachment trash, and further improvements towards UI consistency and accessibility.
		6
		7	= New and Noteworthy (since XWiki Enterprise 2.1.1) =
		8
		9	== Contextual wikimacros ==
		10
		11	Previously, [[wiki macros>>platform:DevGuide.WikiMacroTutorial]] could only be defined by users with administrator rights, and only in the main wiki (when in a virtual wiki farm). It's now possible for any user to register wiki macros, and in any wiki. However, this follows some user rights restrictions, preventing a limited user to write dangerous scripts available to all other users. For example, if the user does not have the proper rights, only he will see and use the macro he registered. To make the macro available globally, an administrator must re-save it.
		12
		13	== Trash ==
		14
		15	While deleted documents and attachments have been stored in a trash instead of being completely deleted since XWiki 1.2, there was no general interface for viewing the contents of the trash. This has been remedied by the introduction of two new tabs in the wiki's Document Index, //Deleted Documents// and //Deleted Attachments//.
		16
		17	image:trash1.png
		18
		19	Both use the livetable, thus allowing filtering and ordering for easier browsing. A document from the trash can be viewed, permanently deleted, or restored if the location is still available.
		20
		21	image:trash2.png
		22
		23	The attachment trash contains only attachments deleted from a document, and not attachments that were deleted together with their owner document; in the latter case, the attachments are kept together with the document in the document trash. For attachments, there is no restore option yet, it will be implemented in a future release.
		24
		25	image:trash3.png
		26
		27	== General UI improvements ==
		28
		29	* In the wiki source code viewer, allow to toggle line numbers faster from Javascript
		30	* Enable full screen view when displaying the wiki source code (viewer=code)
		31	* Internationalize macro descriptors
		32	* ActionMenu: Add Profile submenu item to the "current user" menu
		33	image:XSCOLIBRI-170.png
		34	* Reorder the document actions in the "More actions" menu: copy, rename, delete
		35	* More UI components make use of the (recently introduced) color theme
		36
		37	== Development improvements ==
		38
		39	* Added support for "xcontext" binding in 1.0 groovy macro
		40	* Allow set to null in velocity
		41	* Add an API method for creating a LinkedHashMap
		42	* New APIs for accessing deleted attachments from the trash
		43	* The class wizard should propose to add a SheetClass object to the class sheet
		44	* Add support for 'on page' style extensions
		45
		46	== Office import improvements ==
		47
		48	* Added support for Office2007 document formats
		49
		50	== XAR Import improvements ==
		51
		52	The XAR import interface has been revamped. The new interface (see screenshots below) now provides :
		53
		54	* More explicit options regarding revision history handling
		55	* The new option to add a new version to existing documents instead of overriding them
		56	* A rich UI that allows to select/unselect whole spaces at once
		57	* Support for importing when no javascript is available. The UI degrades nicely to a less rich interface
		58
		59	[[image:importer.png\|\|width="700"]]
		60
		61	== Blog improvement ==
		62
		63	* Add the Create a new post to category pages - when used by default select that category
		64
		65	== Dependencies upgrade ==
		66
		67	* Upgraded to Groovy 1.7
		68
		69	== New Model module with Reference implementation ==
		70
		71	The goal is to provide [[APIs>>http://svn.xwiki.org/svnroot/xwiki/platform/core/trunk/xwiki-model/]] to remove all String manipulations around documents and attachment names. It also introduces the concept of Reference for any entity of the model and the parser/serializer associated. For now Wiki, Space, Document and attachment are supported; classes objects and properties should come in milestone 2.
		72
		73	From a user point of view this will result in supporting any character in document names for example. In addition, this is also a step in the direction of supporting nested spaces (the storage would also need to be changed to support that).
		74
		75	In practice the existing code has not yet been fully refactored to benefit from the new implementation. The work has been started in XWiki Enterprise 2.2 Milestone 1 and will continue in XWiki Enterprise 2.2 Milestone 2 and beyond.
		76
		77	== Miscellaneous ==
		78
		79	* Always use UTF-8 for URL encoding
		80	* Attachments should produce document modification events
		81
		82	* Lots of accessibility fixes
		83	* Lots of bugs fixes
		84
		85	= Known issues =
		86
		87	* [[Bugs we know about>>http://jira.xwiki.org/jira/secure/IssueNavigator.jspa?reset=true&&type=1&pid=10010&resolution=-1&sorter/field=updated&sorter/order=DESC]]
		88	* A regression was introduced in this release: Parent references are saved in the Database without the space prefix. The consequence is that getChildren() will fail to return all children when the current document is located in another space. A more direct consequence is that rename will not rename all pages having a parent pointing to the document being renamed. This has been fixed in XE 2.2M2 but you'll need to resave the documents to have their parents saved correctly in the database.
		89
		90	= Backward Compatibility and Migration Notes =
		91
		92	== Important non-compatible changes ==
		93
		94	{{warning}}
		95	The way URLs are generated and parsed has changed. While previously the wiki encoding was used to convert non-ASCII bytes to their ##%XY## escapes, as allowed by the older HTTP/URL specifications, now all URLs escape the UTF-8 bytes of the path, to better adhere to the modern URI specification. This should only affect non-UTF-8 wikis, and only by breaking some bookmarks.
		96	{{/warning}}
		97
		98	{{warning}}
		99	The velocity configuration has been changed so that setting ##null## values to variables is now allowed. This could break some scripts and macros, please check before upgrading.
		100	{{/warning}}
		101
		102	This means that the following script will generate a different result:
		103
		104	{{code language="none"}}
		105	#set($s = 'abc')
		106	$s
		107	#set($s = $util.null)
		108	$s
		109	{{/code}}
		110
		111	While previously the result would have been ##abc abc##, now it is ##abc $s##.
		112
		113	Special care must be taken care with constructs like the following:
		114
		115	{{code language="none"}}
		116	#set($var = '')
		117	#set($var = $xwiki.methodThatMightReturnNull())
		118	#if($var != '')
		119	The method succeeded
		120	#else
		121	The method failed
		122	#end
		123	{{/code}}
		124
		125	Since ##null != ''## in Velocity, now a different branch will be executed. The following rewrites work.
		126
		127	Works in both modes, with or without null allowed:
		128	{{code language="none"}}
		129	#set($var = '')
		130	#set($var = $xwiki.methodThatMightReturnNull())
		131	#if("$!var" != '')
		132	The method succeeded
		133	#else
		134	The method failed
		135	#end
		136	{{/code}}
		137
		138	Works only in the new mode, with null allowed, but is shorter, slightly faster, and more familiar for java developers:
		139	{{code language="none"}}
		140	#set($var = $xwiki.methodThatMightReturnNull())
		141	#if($!var != $util.null)
		142	The method succeeded
		143	#else
		144	The method failed
		145	#end
		146	{{/code}}
		147
		148	== General Notes ==
		149
		150	{{warning}}If you're running in a multiwiki setup you'll also need to define the property //xwiki.store.migration.databases=all// to your //xwiki.cfg// file or explicitly name all databases to be migrated as in <tt>xwiki.store.migration.databases=db1,db2,...//.{{/warning}}
		151
		152	You may also want to [[import the default wiki XAR>>Main.Download]] in order to benefit from the improvements listed above.
		153
		154	{{warning}}Always make sure you compare your //xwiki.cfg// file with the newest version since some configuration parameters were added. Note 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.{{/warning}}
		155
		156	== Migration Notes ==
		157
		158	* The new parser/serializer for document names comes with new features and changes some behaviors:
		159	** introducing escaping means:
		160	*** ##\## which is now the escaping character needs to be doubled in full document name, as in ##Space.Docu\\ment##, which means space ##Space## and document ##Docu\ment##
		161	*** some generated documents names will now contains ##\## to escape thing like dot in a document name. For example ##Space.Docu\.ment## means space ##Space## and document ##Docu.ment##
		162	** support for the syntax ##wikiname:Document## has been dropped, so in this example "wikiname:Document" will be seen as the document name because no ##.## has been found
		163
		164	= Dependencies =
		165
		166	This release includes the following modules in the specified versions since XWiki Enterprise 2.1.1 was released.
		167
		168	== Core/Web ==
		169
		170	\|=Group Id\|=Artifact Id\|=New Version\|=Old Version\|=JIRA URL
		171	\|##com.xpn.xwiki.platform##\|##xwiki-*##\|2.2-milestone-1\|2.1.1\|[[jira>>http://jira.xwiki.org/jira/browse/XWIKI]]
		172	\|##org.xwiki.platform##\|##xwiki-*##\|2.2-milestone-1\|2.1.1\|[[jira>>http://jira.xwiki.org/jira/browse/XWIKI]]
		173
		174	== Applications ==
		175
		176	\|=Group Id\|=Artifact Id\|=New Version\|=Old Version\|=JIRA URL
		177	\|##com.xpn.xwiki.platform.applications##\|##xwiki-application-administration##\|1.22\|1.21\|[[jira>>http://jira.xwiki.org/jira/browse/XAADMINISTRATION]]
		178	\|##com.xpn.xwiki.platform.applications##\|##xwiki-application-blog##\|1.19\|1.18\|[[jira>>http://jira.xwiki.org/jira/browse/XABLOG]]
		179	\|##com.xpn.xwiki.platform.applications##\|##xwiki-application-officeimporter##\|1.13\|1.12\|[[jira>>http://jira.xwiki.org/jira/browse/XAOFFICE]]
		180	\|##com.xpn.xwiki.platform.applications##\|##xwiki-application-panels##\|1.31\|1.30\|[[jira>>http://jira.xwiki.org/jira/browse/XAPANELS]]
		181	\|##com.xpn.xwiki.platform.applications##\|##xwiki-application-scheduler##\|1.16\|1.15\|[[jira>>http://jira.xwiki.org/jira/browse/XASCH]]
		182	\|##com.xpn.xwiki.platform.applications##\|##xwiki-application-statistics##\|1.6\|1.5\|[[jira>>http://jira.xwiki.org/jira/browse/XASTATS]]
		183	\|##com.xpn.xwiki.platform.applications##\|##xwiki-application-tag##\|1.8\|1.8\|[[jira>>http://jira.xwiki.org/jira/browse/XATAG]]
		184	\|##com.xpn.xwiki.platform.applications##\|##xwiki-application-watchlist##\|1.24\|1.23\|[[jira>>http://jira.xwiki.org/jira/browse/XPWATCHLIST]]
		185	\|##com.xpn.xwiki.platform.applications##\|##xwiki-application-webdav##\|1.2\|1.2\|[[jira>>http://jira.xwiki.org/jira/browse/XAWEBDAV]]
		186	\|##com.xpn.xwiki.platform.applications##\|##xwiki-application-wiki-macro-bridge##\|1.3\|1.2\|[[jira>>http://jira.xwiki.org/jira/browse/XAWMB]]
		187
		188	== Plugins ==
		189
		190	\|=Group Id\|=Artifact Id\|=New Version\|=Old Version\|=JIRA URL
		191	\|##com.xpn.xwiki.platform.plugins##\|##xwiki-plugin-activitystream##\|1.5\|1.5\|[[jira>>http://jira.xwiki.org/jira/browse/XPAS]]
		192	\|##com.xpn.xwiki.platform.plugins##\|##xwiki-plugin-jodatime##\|1.3\|1.3\|[[jira>>http://jira.xwiki.org/jira/browse/XPJODA]]
		193	\|##com.xpn.xwiki.platform.plugins##\|##xwiki-plugin-lucene##\|1.13\|1.12\|[[jira>>http://jira.xwiki.org/jira/browse/XPLUCENE]]
		194	\|##com.xpn.xwiki.platform.plugins##\|##xwiki-plugin-mailsender##\|1.13\|1.13\|[[jira>>http://jira.xwiki.org/jira/browse/XPMAIL]]
		195	\|##com.xpn.xwiki.platform.plugins##\|##xwiki-plugin-scheduler##\|1.16\|1.15\|[[jira>>http://jira.xwiki.org/jira/browse/XASCH]]
		196	\|##com.xpn.xwiki.platform.plugins##\|##xwiki-plugin-skinx##\|1.13\|1.12\|[[jira>>http://jira.xwiki.org/jira/browse/XSKINX]]
		197	\|##com.xpn.xwiki.platform.plugins##\|##xwiki-plugin-tag##\|1.8\|1.8\|[[jira>>http://jira.xwiki.org/jira/browse/XATAG]]
		198	\|##com.xpn.xwiki.platform.plugins##\|##xwiki-plugin-watchlist##\|1.24\|1.23\|[[jira>>http://jira.xwiki.org/jira/browse/XPWATCHLIST]]
		199
		200	== Skins ==
		201
		202	\|=Group Id\|=Artifact Id\|=New Version\|=Old Version\|=JIRA URL
		203	\|##com.xpn.xwiki.platform.skins##\|##xwiki-skin-albatross##\|1.27\|1.27\|[[jira>>http://jira.xwiki.org/jira/browse/XSALBATROSS]]
		204	\|##com.xpn.xwiki.platform.skins##\|##xwiki-skin-colibri##\|1.10\|1.9\|[[jira>>http://jira.xwiki.org/jira/browse/XSCOLIBRI]]
		205	\|##com.xpn.xwiki.platform.skins##\|##xwiki-skin-toucan##\|1.32\|1.32\|[[jira>>http://jira.xwiki.org/jira/browse/XSTOUCAN]]
		206
		207	== Top Level POM ==
		208
		209	\|=Group Id\|=Artifact Id\|=New Version\|=Old Version
		210	\|##com.xpn.xwiki.platform##\|##xwiki##\|28\|28
		211
		212	== Tools ==
		213
		214	\|=Group Id\|=Artifact Id\|=New Version\|=Old Version\|=JIRA URL
		215	\|##org.xwiki.platform.tools##\|##xwiki-configuration-resources##\|1.36\|1.36\|[[jira>>http://jira.xwiki.org/jira/browse/XTCONFRES]]
		216	\|##org.xwiki.platform.tools##\|##xwiki-jetty-resources##\|1.17\|1.17\|[[jira>>http://jira.xwiki.org/jira/browse/XTJETTY]]
		217	\|##org.xwiki.platform.tools##\|##xwiki-license-resources##\|1.1\|1.1\|[[jira>>http://jira.xwiki.org/jira/browse/XTLICENSE]]
		218	\|##org.xwiki.platform.tools##\|##xwiki-packager-plugin##\|1.15\|1.15\|[[jira>>http://jira.xwiki.org/jira/browse/XTPACKAGER]]
		219	\|##org.xwiki.platform.tools##\|##xwiki-rootwebapp##\|1.3\|1.3\|[[jira>>http://jira.xwiki.org/jira/browse/XTROOT]]
		220	\|##org.xwiki.platform.tools##\|##standards-validator##\|1.1\|1.1\|[[jira>>http://jira.xwiki.org/jira/browse/XTVALIDATOR]]
		221	\|##org.xwiki.platform.tools##\|##xwiki-xar-handlers##\|1.9\|1.9\|[[jira>>http://jira.xwiki.org/jira/browse/XTXARHANDLER]]
		222	\|##org.xwiki.platform.tools##\|##xwiki-xar-plugin##\|1.13\|1.13\|[[jira>>http://jira.xwiki.org/jira/browse/XPXARPLUGIN]]
		223	\|##org.xwiki.platform.tools##\|##xwiki-verification-resources##\|1.14\|1.14\|[[jira>>http://jira.xwiki.org/jira/browse/XTVERIFICATIONS]]