Skip to Content

Version 51.1 by Marius Dumitru Florea on 2014/02/25
Show last authors
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 == Miscellaneous ==
30
31 * The document references are displayed as //wiki >> Space >> Page// path in the extension install log.(((
32 {{image reference="docRefInExtensionLog.png"/}}
33 )))
34 * The "membership type" options are more clear(((
35 {{image reference="membershipType.png"/}}
36 )))
37 * The date search facets have a new option 'Older than 30 days':(((
38 {{image reference="dateFacet.png"/}}
39 )))
40 * Added built in support for Apple's open directory groups in LDAP authenticator
41 * Generate extension event in Wikistream XAR input module when the XAR contains extension informations
42 * Add new Locale based API to manipulate current Locale:(((
43 ~{~{code language="velocity}}
44 $xcontext.locale
45 $xcontext.interfaceLocale
46 ~{~{/code}}
47 )))
48
49 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.
50
51 = For Developers =
52
53 == Solr ==
54
55 === Advanced Search Suggest Sources ===
56
57 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.
58
59 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
60
61 {{code language="none"}}
62 type:DOCUMENT AND (title:(__INPUT__*) OR name:(__INPUT__*))
63 {{/code}}
64
65 could be written as
66
67 {{code language="none"}}
68 fq=type:DOCUMENT
69 qf=title^2 name
70 {{/code}}
71
72 Note that:
73
74 * 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
75 * you would be able to specify the boost for each field you want to search in
76 * the query statement used is '~_~_INPUT~_~_' by default, if not specified.
77
78 In order to preserve backward compatibility with existing Solr Search Suggest Sources, we use the following convention:
79
80 > 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.
81
82 For example:
83
84 {{code language="none"}}
85 foo __INPUT__* bar
86 fq=type:DOCUMENT
87 qf=title^2 name
88 {{/code}}
89
90 means the query statement is 'foo ~_~_INPUT~_~_* bar'. Which is equivalent to:
91
92 {{code language="none"}}
93 q=foo __INPUT__* bar
94 fq=type:DOCUMENT
95 qf=title^2 name
96 {{/code}}
97
98 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.
99
100 === Search UI Configuration ===
101
102 We extracted the configuration parameters from the Solr Search UI code in a separate wiki page, ##Main.SolrSearchConfig##. This simplifies the process of customizing the search UI and more importantly allows application developers to easily create a dedicated search page for their application data. As an example, we updated the FAQ application to use the new configuration parameters:
103
104 {{code language="none"}}
105 {{include reference="XWiki.SearchCode"/}}
106
107 {{velocity}}
108 ##
109 ## Customize the Solr Search UI.
110 ##
111 #if ($searchEngine == 'solr')
112 ## Create the configuration object.
113 {{include reference="Main.SolrSearchConfig"/}}
114 #end
115 {{/velocity}}
116 {{velocity output="false"}}
117 #if ($solrConfig)
118 ## Overwrite some configuration parameters.
119 ## We don't use the Result Type facet because the result type is specified in the filter query below so we set the
120 ## query and sort fields for all result types.
121 #set ($discard = $solrConfig.queryFields.put($NULL, 'title^3 property.FAQCode.FAQClass.answer'))
122 #set ($discard = $solrConfig.sortFields.put($NULL, $solrConfig.sortFields.DOCUMENT))
123 #set ($solrConfig.filterQuery = [
124 'type:DOCUMENT',
125 "wiki:$xcontext.database",
126 "space_exact:$doc.space",
127 'class:FAQCode.FAQClass'
128 ])
129 #set ($solrConfig.facetFields = ['creator', 'creationdate', 'author', 'date', 'mimetype', 'attauthor', 'attdate', 'attsize'])
130 ## No preselected facets.
131 #set ($solrConfig.facetQuery = {})
132 #end
133 {{/velocity}}
134
135 {{velocity}}
136 {{include reference="$searchPage"/}}
137 {{/velocity}}
138 {{/code}}
139
140 === Faceting on Object Properties ===
141
142 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.
143
144 == Action API ==
145
146 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).
147
148 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.
149
150 == WebJars Integration ==
151
152 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.
153
154 == Miscellaneous ==
155
156 * 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.
157 * The XAR plugin's ##verify## mojo now also handles the ##defaultLanguage## check accordingly.
158 * The XAR plugin's ##verify## mojo now checks for missing license headers (if the ##formatLicense## configuration property is set to ##true##).
159 * The XAR plugin's ##format## and ##verify## mojos now support including/excluding files.
160 * 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.
161 * ##$services.wiki.getAll()## makes a better use of its internal cache, so the performances are better.
162
163 == Deprecated and Retired projects ==
164
165 * ##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]].
166
167 == Upgrades ==
168
169 The following dependencies have been upgraded:
170
171 * [[Logback 1.1.0>>http://jira.xwiki.org/browse/XCOMMONS-523]]
172 * [[commons-codec 1.9>>http://jira.xwiki.org/browse/XCOMMONS-524]]
173 * [[JRuby 1.7.10>>http://jira.xwiki.org/browse/XWIKI-8680]]
174 * [[cssparser 0.9.13>>http://jira.xwiki.org/browse/XCOMMONS-526]]
175 * [[doxia 1.5>>http://jira.xwiki.org/browse/XRENDERING-330]]
176 * [[Groovy 2.2.1>>http://jira.xwiki.org/browse/XCOMMONS-527]]
177 * [[HttpClient 4.3.2>>http://jira.xwiki.org/browse/XCOMMONS-528]]
178 * [[JGroups 3.4.2>>http://jira.xwiki.org/browse/XWIKI-9969]]
179 * [[XStream 1.4.6>>http://jira.xwiki.org/browse/XCOMMONS-529]]
180 * [[SLF4J 1.7.6>>http://jira.xwiki.org/browse/XCOMMONS-530]]
181 * [[Commons FileUpload 1.3.1>>http://jira.xwiki.org/browse/XCOMMONS-532]]
182 * [[Aether 0.9.0.M4>>http://jira.xwiki.org/browse/XCOMMONS-444]]
183 * [[GWT 2.6>>http://jira.xwiki.org/browse/XWIKI-10073]]
184 * [[SmartGWT 4.0>>http://jira.xwiki.org/browse/XCOMMONS-536]]
185
186 = Translations =
187
188 The following translations have been updated:
189
190 {{language codes="none, none"/}}
191
192 = Tested Browsers & Databases =
193
194 {{include reference="TestReports.ManualTestReportTemplateSummary"/}}
195
196 = Known issues =
197
198 * [[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]]
199
200 = Backward Compatibility and Migration Notes =
201
202 == General Notes ==
203
204 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.
205
206 == Moved to Java 7 as minimum version ==
207
208 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.
209
210 == API Breakages ==
211
212 The following APIs were modified since <project> <version - 1>:
213
214 {{code language="none"}}
215 <clirr output here>
216 {{/code}}

About

About

Support

Platform

User Guide

Admin Guide

Developer Guide

Projects

XWiki

Extensions

Other

Contribute

Status

Practices

Under the Hood

Get Involved

Get Connected