Release Notes for XWiki 5.0 Milestone 1 (XWiki.org)

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.

6

7

8

9

= New and Noteworthy (since XWiki 4.5) =

10

11

[[Full list of issues fixed and Dashboard for 5.0>>http://jira.xwiki.org/secure/Dashboard.jspa?selectPageId=11493]].

12

13

== Release Application ==

14

15

A new [[Release application>>extensions:Extension.Release Application]] is available to help you in releasing software projects.

== Office Import using the Office Macro ==

20

21

We added an option to the [[WYSIWYG Editor>>platform:Features.WysiwygEditor]]'s Import Office Document dialog to allow you to import an office file using the [[Office Macro>>extensions:Extension.Office Macro]]. This is useful if you don't plan to edit the content of the office file after the import or if you don't want to mix the content of the office file with the content of the wiki page.

The generated wiki syntax looks like this:

Of course, you need to have the Office server connected in order to use this feature.

32

33

== Extension Manager improvements ==

34

35

We added more information to the Description section and we added the ability to retrieve the list of stable versions that are available in the configured extension repositories.

36

37

{{image reference="ReleaseNotesXWiki451@EM-extensionDescription.png" /}}

38

39

We also grouped the action buttons (e.g. Install and Install of farm) as you can see in the image above. This allowed us to move the Apply button that you had to click to confirm an extension action like install from the bottom of the Progress section to the extension actions section. The Install and Install of farm buttons are still available in the drop down menu to allow you recompute the install plan if you want to.

40

41

{{image reference="ReleaseNotesXWiki451@EM-continueInstall.png" /}}

42

43

See the [[Extension Manager Application documentation>>extensions:Extension.Extension Manager Application]] for more information.

44

45

== Distribution Wizard improvements ==

46

47

We fixed an important bug in Distribution Wizard ({{jira url="http://jira.xwiki.org" style="enum"}}XWIKI-8749{{/jira}}) that was preventing you from properly upgrading the installed extensions in the second step. We now list extensions by the namespace (wiki) where they have been installed. For now you have to review and upgrade each extension individually. We hope to improve this soon by allowing you upgrade more extensions at once.

48

49

{{image reference="ReleaseNotesXWiki451@DW-upgradeExtensions.png"/}}

50

51

== Button Group Widget ==

52

53

We added a small widget to group form buttons.

It can be used either with a static list of buttons, when you know beforehand that you have more than 1 button and you know the main one, or with a dynamic list of buttons, if you want the buttons to be grouped on the client side if there are more than one.

58

59

The static button group works even with JavaScript disabled (in a modern browser):

<button>Action</button><a href="#foo" class="dropdown-toggle" tabindex="0"><span/></a>

65

66

<button>First item</button>

67

68

<a href="#third">Third item</a>

</span>

</span>

</p>

The dynamic group obviously requires JavaScript. The first button found in the group is considered the main one. The buttons are grouped only if there are more than one. If the main button is secondary then the button group is styled as a secondary button.

</span>

</span>

<a href="#three" class="secondary">Three</a>

</span>

</span>

In both cases you need to include the widget resources:

91

92

93

#set ($discard = $xwiki.ssfx.use('uicomponents/widgets/buttonGroup.css', true))

94

#set ($discard = $xwiki.jsfx.use('uicomponents/widgets/buttonGroup.js'))

== Miscellaneous ==

* Ability to [[more easily create multiple FAQ spaces>>extensions:Extension.FAQ Application||anchor="HCreatemultipleFAQs"]].

100

* Add support for Numbered Lists and Verbatim for the LaTex Renderer

101

* Increased [[Permgen requirements from recommended 128MB to 196MB>>platform:AdminGuide.Installation]]

102

* The Jetty distribution now uses Jetty 8.1.9.v20130131

103

* The [[FAQ Application>>extensions:Extension.FAQ Application]] can now be translated into multiple languages + added translation for French.

104

105

See the [[full list of JIRA issues>>http://jira.xwiki.org/sr/jira.issueviews:searchrequest-printable/temp/SearchRequest.html?jqlQuery=project+in+%28XCOMMONS%2C+XRENDERING%2C+XWIKI%2C+XE%2C+XEM%29+and+status+%3D+Closed+and+resolution+%3D+Fixed+and+fixVersion+%3D+%22<version>%22&tempMax=1000]] fixed in this release.

= For Developers =

== <developer feature N> ==

== Deprecated and Retired projects ==

== Upgrades ==

The following dependencies have been upgraded:

120

121

* [[XStream 1.4.4>>http://jira.xwiki.org/browse/XCOMMONS-338]]

122

* [[Tika 1.3>>http://jira.xwiki.org/browse/XWIKI-8788]]

123

* [[Groovy 2.1.1>>http://jira.xwiki.org/browse/XCOMMONS-331]]

124

* [[httpclient 4.2.3>>http://jira.xwiki.org/browse/XCOMMONS-339]]

125

* [[Apache Ivy 2.3.0>>http://jira.xwiki.org/browse/XCOMMONS-340]]

126

* [[JGroups 3.2.7.Final>>http://jira.xwiki.org/browse/XWIKI-8790]]

127

* [[Liquibase 2.0.5>>http://jira.xwiki.org/browse/XWIKI-8791]]

128

* [[Pygments 1.6>>http://jira.xwiki.org/browse/XWIKI-8787]]

129

* [[Jython 2.5.4-rc1>>http://jira.xwiki.org/browse/XWIKI-8812]]

130

* [[GWT 2.5.0 and SmartGWT 3.1>>http://jira.xwiki.org/browse/XWIKI-8847]]

== Miscellaneous ==

* [[More API added to the Model Script Service>>extensions:Extension.Model Module]]

135

* You can now specify a target user or an email address in the share page URL like this:

136

{{code language="none"}}/xwiki/bin/view/Space/Page?viewer=share&target=foo@bar.org&target=XWiki.mflorea{{/code}}

= Translations =

The following translations have been updated:

= Tested Browsers & Databases =

145

146

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>>dev:Community.BrowserSupportStrategy]]):

147

148

149

## name = iexplorer, firefox, chrome, safari, opera

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>>dev:Community.DatabaseSupportStrategy]]):

155

156

157

## name = hsqldb, mysql, postgresql, oracle, opera

= Known issues =

* [[Bugs we know about>>http://jira.xwiki.org/secure/IssueNavigator.jspa?reset=true&jqlQuery=category+%3D+%22Top+Level+Projects%22+AND+issuetype+%3D+Bug+AND+resolution+%3D+Unresolved+ORDER+BY+updated+DESC]]

= Test Report =

You can check the [[manual test report>>TestReports.WebHome#<anchor to test report>]] to learn about what was tested and the results on various browsers.

169

170

= Backward Compatibility and Migration Notes =

== General Notes ==

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

175

176

177

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.

178

179

180

== Issues specific to XWiki 5.0 Milestone 1 ==

181

182

* the default resolver used by the model script service moved from ##currentmixed## to ##current##. In practice it means ##$services.model.resolveDocument('')## will now return a document reference with ##currentwiki:currentspace.currentdocument## instead of ##currentwiki:currentspace.WebHome##. See [[XWIKI-8834>>http://jira.xwiki.org/browse/XWIKI-8834]] for more details.

== API Breakages ==

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

Wiki source code of Release Notes for XWiki 5.0 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"}}
		2	{{toc/}}
		3	{{/box}}
		4
		5	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.
		6
		7	<insert description of release here>
		8
		9	= New and Noteworthy (since XWiki 4.5) =
		10
		11	[[Full list of issues fixed and Dashboard for 5.0>>http://jira.xwiki.org/secure/Dashboard.jspa?selectPageId=11493]].
		12
		13	== Release Application ==
		14
		15	A new [[Release application>>extensions:Extension.Release Application]] is available to help you in releasing software projects.
		16
		17	{{image reference="release1.png"/}}
		18
		19	== Office Import using the Office Macro ==
		20
		21	We added an option to the [[WYSIWYG Editor>>platform:Features.WysiwygEditor]]'s Import Office Document dialog to allow you to import an office file using the [[Office Macro>>extensions:Extension.Office Macro]]. This is useful if you don't plan to edit the content of the office file after the import or if you don't want to mix the content of the office file with the content of the wiki page.
		22
		23	{{image reference="xwe-importOfficeDocumentDialog.png"/}}
		24
		25	The generated wiki syntax looks like this:
		26
		27	{{code language="none"}}
		28	{{office attachment="presentation.odp"/}}
		29	{{/code}}
		30
		31	Of course, you need to have the Office server connected in order to use this feature.
		32
		33	== Extension Manager improvements ==
		34
		35	We added more information to the Description section and we added the ability to retrieve the list of stable versions that are available in the configured extension repositories.
		36
		37	{{image reference="ReleaseNotesXWiki451@EM-extensionDescription.png" /}}
		38
		39	We also grouped the action buttons (e.g. Install and Install of farm) as you can see in the image above. This allowed us to move the Apply button that you had to click to confirm an extension action like install from the bottom of the Progress section to the extension actions section. The Install and Install of farm buttons are still available in the drop down menu to allow you recompute the install plan if you want to.
		40
		41	{{image reference="ReleaseNotesXWiki451@EM-continueInstall.png" /}}
		42
		43	See the [[Extension Manager Application documentation>>extensions:Extension.Extension Manager Application]] for more information.
		44
		45	== Distribution Wizard improvements ==
		46
		47	We fixed an important bug in Distribution Wizard ({{jira url="http://jira.xwiki.org" style="enum"}}XWIKI-8749{{/jira}}) that was preventing you from properly upgrading the installed extensions in the second step. We now list extensions by the namespace (wiki) where they have been installed. For now you have to review and upgrade each extension individually. We hope to improve this soon by allowing you upgrade more extensions at once.
		48
		49	{{image reference="ReleaseNotesXWiki451@DW-upgradeExtensions.png"/}}
		50
		51	== Button Group Widget ==
		52
		53	We added a small widget to group form buttons.
		54
		55	{{image reference="ReleaseNotesXWiki451@buttonGroup.png"/}}
		56
		57	It can be used either with a static list of buttons, when you know beforehand that you have more than 1 button and you know the main one, or with a dynamic list of buttons, if you want the buttons to be grouped on the client side if there are more than one.
		58
		59	The static button group works even with JavaScript disabled (in a modern browser):
		60
		61	{{code language="html"}}
		62	<p class="buttons">
		63	<span class="buttonwrapper button-group">
		64	<button>Action</button><a href="#foo" class="dropdown-toggle" tabindex="0"><span/></a>
		65	<span id="foo" class="dropdown-menu">
		66	<button>First item</button>
		67	<input type="submit" value="Second item" class="button" />
		68	<a href="#third">Third item</a>
		69	</span>
		70	</span>
		71	</p>
		72	{{/code}}
		73
		74	The dynamic group obviously requires JavaScript. The first button found in the group is considered the main one. The buttons are grouped only if there are more than one. If the main button is secondary then the button group is styled as a secondary button.
		75
		76	{{code language="html"}}
		77	<span class="dynamic-button-group">
		78	<span class="buttonwrapper">
		79	<button>One</button>
		80	</span>
		81	<span class="buttonwrapper">
		82	<input type="submit" class="button secondary" value="Two" />
		83	</span>
		84	<span class="buttonwrapper">
		85	<a href="#three" class="secondary">Three</a>
		86	</span>
		87	</span>
		88	{{/code}}
		89
		90	In both cases you need to include the widget resources:
		91
		92	{{code language="none"}}
		93	#set ($discard = $xwiki.ssfx.use('uicomponents/widgets/buttonGroup.css', true))
		94	#set ($discard = $xwiki.jsfx.use('uicomponents/widgets/buttonGroup.js'))
		95	{{/code}}
		96
		97	== Miscellaneous ==
		98
		99	* Ability to [[more easily create multiple FAQ spaces>>extensions:Extension.FAQ Application\|\|anchor="HCreatemultipleFAQs"]].
		100	* Add support for Numbered Lists and Verbatim for the LaTex Renderer
		101	* Increased [[Permgen requirements from recommended 128MB to 196MB>>platform:AdminGuide.Installation]]
		102	* The Jetty distribution now uses Jetty 8.1.9.v20130131
		103	* The [[FAQ Application>>extensions:Extension.FAQ Application]] can now be translated into multiple languages + added translation for French.
		104
		105	See the [[full list of JIRA issues>>http://jira.xwiki.org/sr/jira.issueviews:searchrequest-printable/temp/SearchRequest.html?jqlQuery=project+in+%28XCOMMONS%2C+XRENDERING%2C+XWIKI%2C+XE%2C+XEM%29+and+status+%3D+Closed+and+resolution+%3D+Fixed+and+fixVersion+%3D+%22<version>%22&tempMax=1000]] fixed in this release.
		106
		107	= For Developers =
		108
		109	== <developer feature N> ==
		110
		111	<description of developer feature N>
		112
		113	== Deprecated and Retired projects ==
		114
		115	<description of deprecated and retired projects>
		116
		117	== Upgrades ==
		118
		119	The following dependencies have been upgraded:
		120
		121	* [[XStream 1.4.4>>http://jira.xwiki.org/browse/XCOMMONS-338]]
		122	* [[Tika 1.3>>http://jira.xwiki.org/browse/XWIKI-8788]]
		123	* [[Groovy 2.1.1>>http://jira.xwiki.org/browse/XCOMMONS-331]]
		124	* [[httpclient 4.2.3>>http://jira.xwiki.org/browse/XCOMMONS-339]]
		125	* [[Apache Ivy 2.3.0>>http://jira.xwiki.org/browse/XCOMMONS-340]]
		126	* [[JGroups 3.2.7.Final>>http://jira.xwiki.org/browse/XWIKI-8790]]
		127	* [[Liquibase 2.0.5>>http://jira.xwiki.org/browse/XWIKI-8791]]
		128	* [[Pygments 1.6>>http://jira.xwiki.org/browse/XWIKI-8787]]
		129	* [[Jython 2.5.4-rc1>>http://jira.xwiki.org/browse/XWIKI-8812]]
		130	* [[GWT 2.5.0 and SmartGWT 3.1>>http://jira.xwiki.org/browse/XWIKI-8847]]
		131
		132	== Miscellaneous ==
		133
		134	* [[More API added to the Model Script Service>>extensions:Extension.Model Module]]
		135	* You can now specify a target user or an email address in the share page URL like this:
		136	{{code language="none"}}/xwiki/bin/view/Space/Page?viewer=share&target=foo@bar.org&target=XWiki.mflorea{{/code}}
		137
		138	= Translations =
		139
		140	The following translations have been updated:
		141
		142	{{language codes="none, none"/}}
		143
		144	= Tested Browsers & Databases =
		145
		146	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>>dev:Community.BrowserSupportStrategy]]):
		147
		148	{{velocity}}
		149	## name = iexplorer, firefox, chrome, safari, opera
		150	{{/velocity}}
		151
		152	{{browser name="firefox" version="18.0.2"/}}
		153
		154	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>>dev:Community.DatabaseSupportStrategy]]):
		155
		156	{{velocity}}
		157	## name = hsqldb, mysql, postgresql, oracle, opera
		158	{{/velocity}}
		159
		160	{{database name="none" version="x.x"/}}
		161
		162	= Known issues =
		163
		164	* [[Bugs we know about>>http://jira.xwiki.org/secure/IssueNavigator.jspa?reset=true&jqlQuery=category+%3D+%22Top+Level+Projects%22+AND+issuetype+%3D+Bug+AND+resolution+%3D+Unresolved+ORDER+BY+updated+DESC]]
		165
		166	= Test Report =
		167
		168	You can check the [[manual test report>>TestReports.WebHome#<anchor to test report>]] to learn about what was tested and the results on various browsers.
		169
		170	= Backward Compatibility and Migration Notes =
		171
		172	== General Notes ==
		173
		174	You may also want to [[import the default wiki XAR>>Main.Download]] in order to benefit from all the improvements listed above.
		175
		176	{{warning}}
		177	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.
		178	{{/warning}}
		179
		180	== Issues specific to XWiki 5.0 Milestone 1 ==
		181
		182	* the default resolver used by the model script service moved from ##currentmixed## to ##current##. In practice it means ##$services.model.resolveDocument('')## will now return a document reference with ##currentwiki:currentspace.currentdocument## instead of ##currentwiki:currentspace.WebHome##. See [[XWIKI-8834>>http://jira.xwiki.org/browse/XWIKI-8834]] for more details.
		183
		184	== API Breakages ==
		185
		186	The following APIs were modified since <project> <version - 1>:
		187
		188	{{code language="none"}}
		189	<clirr output here>
		190	{{/code}}