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

This is the release notes for [[XWiki Commons>>http://commons.xwiki.org]], [[XWiki Rendering>>http://rendering.xwiki.org]], [[XWiki Platform>>http://platform.xwiki.org]] and [[XWiki Enterprise>>http://enterprise.xwiki.org]]. 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 5.4) =

10

11

[[Full list of issues fixed and Dashboard for <version>>>http://jira.xwiki.org/secure/Dashboard.jspa?selectPageId=<fill id here>]].

12

13

== Moved to Java 7 as minimum version ==

14

15

The minimum required Java version to run XWiki is now Java 7. It's not just the minimum officially supported version, XWiki won't work on Java 6.

16

17

== Wiki Application ==

18

19

* In the Wiki Index, all the wikis that the user can not access [[are not displayed anymore>>extensions:Extension.Wiki Application||anchor="HNewmenusandWikiIndex"]].

20

21

== New Chart Renderers ==

22

23

The ##stackedbar## and ##stackedbar3D## plot renderers were added in the [[Chart Macro>>extensions:Extension.Chart Macro]]:

== Panels Application Improvements ==

30

31

* The [[Panels Application>>extensions:Extension.Panels Application]] is now available from the Applications Panel:(((

32

33

)))

34

* The Panels Application's home page now uses a LiveTable to display the list of available Panels:(((

)))

== Miscellaneous ==

* The document references are displayed as //wiki >> Space >> Page// path in the extension install log.(((

41

42

)))

43

* The "membership type" options are more clear(((

44

45

)))

46

* The date search facets have a new option 'Older than 30 days':(((

47

48

)))

49

* Added built in support for Apple's open directory groups in LDAP authenticator

50

* Generate extension event in Wikistream XAR input module when the XAR contains extension informations

51

* Add new Locale based API to manipulate current Locale:(((

52

~{~{code language="velocity}}

53

$xcontext.locale

54

$xcontext.interfaceLocale

55

~{~{/code}}

56

)))

57

* The "container" macro is now responsive. So if there is not enough place to display several columns side by side, they are displayed instead one after the other in a vertical alignment.

58

59

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 =

== Solr ==

=== Advanced Search Suggest Sources ===

66

67

The [[Search Suggest>>extensions:Extension.Search Application||anchor="HSearchSuggest"]] feature retrieves live search results from various configurable sources. These sources specify the search engine to use and the search query. The search doesn't perform well, at least on Solr, if we use only the search query because each query is different (when the input text is different) so the cache is not used efficiently. Best is to rely on the filter cache but for this we need to be able to specify the filter query.

68

69

Starting with this release you are able to specify more advanced search parameters in the search query and they will be passed directly to the search engine. This currently works with Solr. As an example, the following statement from the 'query' property of a Search Suggest Source

70

71

72

type:DOCUMENT AND (title:(__INPUT__*) OR name:(__INPUT__*))

could be written as

fq=type:DOCUMENT

qf=title^2 name

Note that:

* you would use the filter query which is the same for all search requests to this Search Suggest Source so it will be cached by Solr

85

* you would be able to specify the boost for each field you want to search in

86

* the query statement used is '~_~_INPUT~_~_' by default, if not specified.

87

88

In order to preserve backward compatibility with existing Solr Search Suggest Sources, we use the following convention:

89

90

> A line that doesn't start with 'xxx=' specifies the query statement; in other words, existing Solr Search Suggest Sources are specifying only the query statement.

For example:

foo __INPUT__* bar

fq=type:DOCUMENT

qf=title^2 name

means the query statement is 'foo ~_~_INPUT~_~_* bar'. Which is equivalent to:

q=foo __INPUT__* bar

fq=type:DOCUMENT

qf=title^2 name

See the [[Solr common query parameters>>http://wiki.apache.org/solr/CommonQueryParameters]] and the [[Extended DisMax query parser parameters>>http://wiki.apache.org/solr/ExtendedDisMax#Parameters]] documentation for details on what parameters you can pass to the search engine.

109

110

=== Search UI Configuration ===

111

112

Application developers can now easily create a dedicated search page for their application, tailored for the application data. You can take a look at the [[FAQ application>>extensions:Extension.FAQ Application]] for example:

#if ($searchEngine == 'solr')

119

## Customize the Solr Search UI for the FAQ application.

120

#set ($solrConfig = {

121

'queryFields': 'title^3 property.FAQCode.FAQClass.answer',

122

'facetFields': ['creator', 'creationdate', 'author', 'date', 'mimetype', 'attauthor', 'attdate', 'attsize'],

123

'filterQuery': [

124

'type:DOCUMENT',

125

"wiki:$xcontext.database",

126

"space_exact:$doc.space",

127

'class:FAQCode.FAQClass'

]

})

#end

=== Faceting on Object Properties ===

139

140

In XWiki 5.3 we added support for [[faceting on object properties>>ReleaseNotesXWiki53||anchor="HFacetingandSortingonObjectProperties"]] but the facets were not displayed nicely. We improved the facet display in this release so that the property type is taken into account: e.g. a facet on a date property will be displayed using the date facet (same as for the document creation date or the last modification date). Moreover, you can now configure the facet displayer to use and even create your own facet displayer. See the [[Solr Search Application>>extensions:Extension.Solr Search Application||anchor="HFacetingonObjectProperties"]] for details.

== Action API ==

This [[Action API module>>extensions:Extension.Action API]] is the entry point for all UIs and in charge of calling the correct backend code to display what the user has asked for (it's the Controller in MVC terminology).

145

146

Note that right now most Actions are still implemented the old way in the oldcore module without Components and using Struts. The goal is to progressively rewrite them using this new Action API.

147

148

== WebJars Integration ==

149

150

The [[WebJars integration>>extensions:Extension.WebJars Integration]] solves the issue of packaging JavaScript frameworks by bundling them as JARs. This allows XWiki Extensions to depend on JavaScript frameworks an be installable by the Extension Manager Application.

151

152

== LiveTable Query Filters ==

153

154

It's now possible to specify which [[Query filters to apply when retrieving LiveTable data>>extensions:Extension.Livetable Macro]].

155

156

For example if you want to show always hidden docs, then you would use:

...

'queryFilters': 'currentLanguage',

...

And if you wish to show all docs for all languages and hidden docs you would use:

...

'queryFilters': '',

...

== Miscellaneous ==

* The XAR plugins's ##format## mojo now handles properly the ##defaultLanguage## element: if a document has translation we assume it means the document is not a technical document and thus we set the default language to be English. This allows the XWiki SOLR Search to return results when the English language is selected in language facet.

175

* The XAR plugin's ##verify## mojo now also handles the ##defaultLanguage## check accordingly.

176

* The XAR plugin's ##verify## mojo now checks for missing license headers (if the ##formatLicense## configuration property is set to ##true##).

177

* The XAR plugin's ##format## and ##verify## mojos now support including/excluding files.

178

* We changed a bit the behaviour of Solr search with respect to the current language. We stopped using the (dynamically computed) 'locales' filter by default. We now rely only on the 'locale' facet, which has the current language preselected. See [[XWIKI-9977>>http://jira.xwiki.org/browse/XWIKI-9977]] for the full story.

179

* ##$services.wiki.getAll()## makes a better use of its internal cache, so the performances are better.

180

181

== Deprecated and Retired projects ==

182

183

* ##xwiki-platorm-wiki-manager## has been removed from the platform. It is still available on the [[contrib repository>>https://github.com/xwiki-contrib/xwiki-platform-wiki-manager]] and via the extensions [[extensions:Extension.Wiki Manager Plugin]] and [[extensions:Extension.Wiki Manager Application]].

== Upgrades ==

The following dependencies have been upgraded:

188

189

* [[Logback 1.1.0>>http://jira.xwiki.org/browse/XCOMMONS-523]]

190

* [[commons-codec 1.9>>http://jira.xwiki.org/browse/XCOMMONS-524]]

191

* [[JRuby 1.7.10>>http://jira.xwiki.org/browse/XWIKI-8680]]

192

* [[cssparser 0.9.13>>http://jira.xwiki.org/browse/XCOMMONS-526]]

193

* [[doxia 1.5>>http://jira.xwiki.org/browse/XRENDERING-330]]

194

* [[Groovy 2.2.1>>http://jira.xwiki.org/browse/XCOMMONS-527]]

195

* [[HttpClient 4.3.2>>http://jira.xwiki.org/browse/XCOMMONS-528]]

196

* [[JGroups 3.4.2>>http://jira.xwiki.org/browse/XWIKI-9969]]

197

* [[XStream 1.4.6>>http://jira.xwiki.org/browse/XCOMMONS-529]]

198

* [[SLF4J 1.7.6>>http://jira.xwiki.org/browse/XCOMMONS-530]]

199

* [[Commons FileUpload 1.3.1>>http://jira.xwiki.org/browse/XCOMMONS-532]]

200

* [[Aether 0.9.0.M4>>http://jira.xwiki.org/browse/XCOMMONS-444]]

201

* [[GWT 2.6>>http://jira.xwiki.org/browse/XWIKI-10073]]

202

* [[SmartGWT 4.0>>http://jira.xwiki.org/browse/XCOMMONS-536]]

= Translations =

The following translations have been updated:

= Tested Browsers & Databases =

211

212

{{include reference="TestReports.ManualTestReportTemplateSummary"/}}

= 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]]

217

218

= Backward Compatibility and Migration Notes =

== General Notes ==

When upgrading make sure you compare your ##xwiki.cfg##, ##xwiki.properties## and ##web.xml## files with the newest version since some configuration parameters may have been modified or 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.

223

224

== Moved to Java 7 as minimum version ==

225

226

The minimum required Java version to run XWiki is now Java 7. It's not just the minimum officially supported version, XWiki won't work on Java 6.

227

228

== Crypto Modules moved to Commons ==

229

230

The crypto modules (except the script service) have been moved to xwiki-commons. Developers should be careful to update their dependencies.

== API Breakages ==

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

Wiki source code of Release Notes for XWiki 6.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 Commons>>http://commons.xwiki.org]], [[XWiki Rendering>>http://rendering.xwiki.org]], [[XWiki Platform>>http://platform.xwiki.org]] and [[XWiki Enterprise>>http://enterprise.xwiki.org]]. 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 5.4) =
		10
		11	[[Full list of issues fixed and Dashboard for <version>>>http://jira.xwiki.org/secure/Dashboard.jspa?selectPageId=<fill id here>]].
		12
		13	== Moved to Java 7 as minimum version ==
		14
		15	The minimum required Java version to run XWiki is now Java 7. It's not just the minimum officially supported version, XWiki won't work on Java 6.
		16
		17	== Wiki Application ==
		18
		19	* In the Wiki Index, all the wikis that the user can not access [[are not displayed anymore>>extensions:Extension.Wiki Application\|\|anchor="HNewmenusandWikiIndex"]].
		20
		21	== New Chart Renderers ==
		22
		23	The ##stackedbar## and ##stackedbar3D## plot renderers were added in the [[Chart Macro>>extensions:Extension.Chart Macro]]:
		24
		25	{{image reference="stackedbar.png"/}}
		26
		27	{{image reference="stackedbar3D.png"/}}
		28
		29	== Panels Application Improvements ==
		30
		31	* The [[Panels Application>>extensions:Extension.Panels Application]] is now available from the Applications Panel:(((
		32	{{image reference="panels-application.png"/}}
		33	)))
		34	* The Panels Application's home page now uses a LiveTable to display the list of available Panels:(((
		35	{{image reference="panels-home.png"/}}
		36	)))
		37
		38	== Miscellaneous ==
		39
		40	* The document references are displayed as //wiki >> Space >> Page// path in the extension install log.(((
		41	{{image reference="docRefInExtensionLog.png"/}}
		42	)))
		43	* The "membership type" options are more clear(((
		44	{{image reference="membershipType.png"/}}
		45	)))
		46	* The date search facets have a new option 'Older than 30 days':(((
		47	{{image reference="dateFacet.png"/}}
		48	)))
		49	* Added built in support for Apple's open directory groups in LDAP authenticator
		50	* Generate extension event in Wikistream XAR input module when the XAR contains extension informations
		51	* Add new Locale based API to manipulate current Locale:(((
		52	~{~{code language="velocity}}
		53	$xcontext.locale
		54	$xcontext.interfaceLocale
		55	~{~{/code}}
		56	)))
		57	* The "container" macro is now responsive. So if there is not enough place to display several columns side by side, they are displayed instead one after the other in a vertical alignment.
		58
		59	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.
		60
		61	= For Developers =
		62
		63	== Solr ==
		64
		65	=== Advanced Search Suggest Sources ===
		66
		67	The [[Search Suggest>>extensions:Extension.Search Application\|\|anchor="HSearchSuggest"]] feature retrieves live search results from various configurable sources. These sources specify the search engine to use and the search query. The search doesn't perform well, at least on Solr, if we use only the search query because each query is different (when the input text is different) so the cache is not used efficiently. Best is to rely on the filter cache but for this we need to be able to specify the filter query.
		68
		69	Starting with this release you are able to specify more advanced search parameters in the search query and they will be passed directly to the search engine. This currently works with Solr. As an example, the following statement from the 'query' property of a Search Suggest Source
		70
		71	{{code language="none"}}
		72	type:DOCUMENT AND (title:(__INPUT__) OR name:(__INPUT__))
		73	{{/code}}
		74
		75	could be written as
		76
		77	{{code language="none"}}
		78	fq=type:DOCUMENT
		79	qf=title^2 name
		80	{{/code}}
		81
		82	Note that:
		83
		84	* you would use the filter query which is the same for all search requests to this Search Suggest Source so it will be cached by Solr
		85	* you would be able to specify the boost for each field you want to search in
		86	* the query statement used is '~_~_INPUT~_~_' by default, if not specified.
		87
		88	In order to preserve backward compatibility with existing Solr Search Suggest Sources, we use the following convention:
		89
		90	> A line that doesn't start with 'xxx=' specifies the query statement; in other words, existing Solr Search Suggest Sources are specifying only the query statement.
		91
		92	For example:
		93
		94	{{code language="none"}}
		95	foo __INPUT__* bar
		96	fq=type:DOCUMENT
		97	qf=title^2 name
		98	{{/code}}
		99
		100	means the query statement is 'foo ~_~_INPUT~_~_* bar'. Which is equivalent to:
		101
		102	{{code language="none"}}
		103	q=foo __INPUT__* bar
		104	fq=type:DOCUMENT
		105	qf=title^2 name
		106	{{/code}}
		107
		108	See the [[Solr common query parameters>>http://wiki.apache.org/solr/CommonQueryParameters]] and the [[Extended DisMax query parser parameters>>http://wiki.apache.org/solr/ExtendedDisMax#Parameters]] documentation for details on what parameters you can pass to the search engine.
		109
		110	=== Search UI Configuration ===
		111
		112	Application developers can now easily create a dedicated search page for their application, tailored for the application data. You can take a look at the [[FAQ application>>extensions:Extension.FAQ Application]] for example:
		113
		114	{{code language="none"}}
		115	{{include reference="XWiki.SearchCode"/}}
		116
		117	{{velocity output="false"}}
		118	#if ($searchEngine == 'solr')
		119	## Customize the Solr Search UI for the FAQ application.
		120	#set ($solrConfig = {
		121	'queryFields': 'title^3 property.FAQCode.FAQClass.answer',
		122	'facetFields': ['creator', 'creationdate', 'author', 'date', 'mimetype', 'attauthor', 'attdate', 'attsize'],
		123	'filterQuery': [
		124	'type:DOCUMENT',
		125	"wiki:$xcontext.database",
		126	"space_exact:$doc.space",
		127	'class:FAQCode.FAQClass'
		128	]
		129	})
		130	#end
		131	{{/velocity}}
		132
		133	{{velocity}}
		134	{{include reference="$searchPage"/}}
		135	{{/velocity}}
		136	{{/code}}
		137
		138	=== Faceting on Object Properties ===
		139
		140	In XWiki 5.3 we added support for [[faceting on object properties>>ReleaseNotesXWiki53\|\|anchor="HFacetingandSortingonObjectProperties"]] but the facets were not displayed nicely. We improved the facet display in this release so that the property type is taken into account: e.g. a facet on a date property will be displayed using the date facet (same as for the document creation date or the last modification date). Moreover, you can now configure the facet displayer to use and even create your own facet displayer. See the [[Solr Search Application>>extensions:Extension.Solr Search Application\|\|anchor="HFacetingonObjectProperties"]] for details.
		141
		142	== Action API ==
		143
		144	This [[Action API module>>extensions:Extension.Action API]] is the entry point for all UIs and in charge of calling the correct backend code to display what the user has asked for (it's the Controller in MVC terminology).
		145
		146	Note that right now most Actions are still implemented the old way in the oldcore module without Components and using Struts. The goal is to progressively rewrite them using this new Action API.
		147
		148	== WebJars Integration ==
		149
		150	The [[WebJars integration>>extensions:Extension.WebJars Integration]] solves the issue of packaging JavaScript frameworks by bundling them as JARs. This allows XWiki Extensions to depend on JavaScript frameworks an be installable by the Extension Manager Application.
		151
		152	== LiveTable Query Filters ==
		153
		154	It's now possible to specify which [[Query filters to apply when retrieving LiveTable data>>extensions:Extension.Livetable Macro]].
		155
		156	For example if you want to show always hidden docs, then you would use:
		157
		158	{{code language="none"}}
		159	...
		160	'queryFilters': 'currentLanguage',
		161	...
		162	{{/code}}
		163
		164	And if you wish to show all docs for all languages and hidden docs you would use:
		165
		166	{{code language="none"}}
		167	...
		168	'queryFilters': '',
		169	...
		170	{{/code}}
		171
		172	== Miscellaneous ==
		173
		174	* The XAR plugins's ##format## mojo now handles properly the ##defaultLanguage## element: if a document has translation we assume it means the document is not a technical document and thus we set the default language to be English. This allows the XWiki SOLR Search to return results when the English language is selected in language facet.
		175	* The XAR plugin's ##verify## mojo now also handles the ##defaultLanguage## check accordingly.
		176	* The XAR plugin's ##verify## mojo now checks for missing license headers (if the ##formatLicense## configuration property is set to ##true##).
		177	* The XAR plugin's ##format## and ##verify## mojos now support including/excluding files.
		178	* We changed a bit the behaviour of Solr search with respect to the current language. We stopped using the (dynamically computed) 'locales' filter by default. We now rely only on the 'locale' facet, which has the current language preselected. See [[XWIKI-9977>>http://jira.xwiki.org/browse/XWIKI-9977]] for the full story.
		179	* ##$services.wiki.getAll()## makes a better use of its internal cache, so the performances are better.
		180
		181	== Deprecated and Retired projects ==
		182
		183	* ##xwiki-platorm-wiki-manager## has been removed from the platform. It is still available on the [[contrib repository>>https://github.com/xwiki-contrib/xwiki-platform-wiki-manager]] and via the extensions [[extensions:Extension.Wiki Manager Plugin]] and [[extensions:Extension.Wiki Manager Application]].
		184
		185	== Upgrades ==
		186
		187	The following dependencies have been upgraded:
		188
		189	* [[Logback 1.1.0>>http://jira.xwiki.org/browse/XCOMMONS-523]]
		190	* [[commons-codec 1.9>>http://jira.xwiki.org/browse/XCOMMONS-524]]
		191	* [[JRuby 1.7.10>>http://jira.xwiki.org/browse/XWIKI-8680]]
		192	* [[cssparser 0.9.13>>http://jira.xwiki.org/browse/XCOMMONS-526]]
		193	* [[doxia 1.5>>http://jira.xwiki.org/browse/XRENDERING-330]]
		194	* [[Groovy 2.2.1>>http://jira.xwiki.org/browse/XCOMMONS-527]]
		195	* [[HttpClient 4.3.2>>http://jira.xwiki.org/browse/XCOMMONS-528]]
		196	* [[JGroups 3.4.2>>http://jira.xwiki.org/browse/XWIKI-9969]]
		197	* [[XStream 1.4.6>>http://jira.xwiki.org/browse/XCOMMONS-529]]
		198	* [[SLF4J 1.7.6>>http://jira.xwiki.org/browse/XCOMMONS-530]]
		199	* [[Commons FileUpload 1.3.1>>http://jira.xwiki.org/browse/XCOMMONS-532]]
		200	* [[Aether 0.9.0.M4>>http://jira.xwiki.org/browse/XCOMMONS-444]]
		201	* [[GWT 2.6>>http://jira.xwiki.org/browse/XWIKI-10073]]
		202	* [[SmartGWT 4.0>>http://jira.xwiki.org/browse/XCOMMONS-536]]
		203
		204	= Translations =
		205
		206	The following translations have been updated:
		207
		208	{{language codes="none, none"/}}
		209
		210	= Tested Browsers & Databases =
		211
		212	{{include reference="TestReports.ManualTestReportTemplateSummary"/}}
		213
		214	= Known issues =
		215
		216	* [[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]]
		217
		218	= Backward Compatibility and Migration Notes =
		219
		220	== General Notes ==
		221
		222	When upgrading make sure you compare your ##xwiki.cfg##, ##xwiki.properties## and ##web.xml## files with the newest version since some configuration parameters may have been modified or 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.
		223
		224	== Moved to Java 7 as minimum version ==
		225
		226	The minimum required Java version to run XWiki is now Java 7. It's not just the minimum officially supported version, XWiki won't work on Java 6.
		227
		228	== Crypto Modules moved to Commons ==
		229
		230	The crypto modules (except the script service) have been moved to xwiki-commons. Developers should be careful to update their dependencies.
		231
		232	== API Breakages ==
		233
		234	The following APIs were modified since <project> <version - 1>:
		235
		236	{{code language="none"}}
		237	<clirr output here>
		238	{{/code}}