Skip to Content

Wiki source code of Release Notes for XWiki 7.3

Version 4.15 by Ecaterina Moraru (Valica) on 2015/11/10
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 This is a stabilisation release focusing on the Nested Pages feature which was introduced in XWiki 7.2. Lots of polishing has been done for the Nested Pages feature integration and its consequences on the UI redesign (modified menus for example). The release includes a couple of bug fixes, a few dependency upgrades and new UI extension points available for extension developers.
8
9 = New and Noteworthy (since XWiki 7.2) =
10
11 [[Full list of issues fixed and Dashboard for 7.3>>http://jira.xwiki.org/secure/Dashboard.jspa?selectPageId=13500]].
12
13 == Flamingo ==
14
15 === Navigation bar ===
16
17 * The user's avatar is now displayed between the search icon and the drawer icon:(((
18 {{image reference="ReleaseNotesXWiki73M1@avatar.png"/}}
19 )))
20
21 * (((Also the search bar on the top of the screen have been improved a bit.
22
23 When the user clicks on the search button, the search bar is opened and gets the focus. Then, when the users clicks in other place, the search bar is closed, slowly.
24
25 * Closed:(((
26 {{image reference="ReleaseNotesXWiki73M1@search-closed.png"/}}
27 )))
28 * Open:(((
29 {{image reference="ReleaseNotesXWiki73M1@search.png"/}}
30 )))
31 )))
32
33 == Menus ==
34
35 The "More Options" menu has been split and a new "Page Administration" menu has been introduced:
36
37 {{gallery}}
38 image:ReleaseNotesXWiki73M2@content_menus.png
39 image:ReleaseNotesXWiki73M2@page-admin-menus.png
40 image:ReleaseNotesXWiki73M2@more-options-menu.png
41 {{/gallery}}
42
43 === Drawer ===
44
45 * In the Drawer (top right menu), the pages for which the user doesn't have permissions to access are not displayed anymore.
46
47
48 == Flamingo Theme Editor ==
49
50 The [[extensions:Extension.Flamingo Theme Application]] now handles the ##@lessCode## field. It means that you can add any code, written with LESS, to your theme and see the result live!
51
52 {{image reference="ReleaseNotesXWiki73M1@LESSCode.png" width="40%"/}}
53
54 == Office Importer ==
55
56 The [[extensions:Extension.Office Importer Application]] has been redesigned visually and now supports importing into Nested Spaces:
57
58 {{image reference="ReleaseNotesXWiki73M1@OfficeImporter" width="50%"/}}
59
60 == Breadcrumb ==
61
62 When the hierarchy of a Nested Pages is long, we do not display it entirely any more. Instead, we display a limited version, that the user can expand by clicking on the "ellipsis" character ('...'):
63
64 * limited:(((
65 {{image reference="ReleaseNotesXWiki73M2@breadcrumb-limited.png"/}}
66 )))
67 * full:(((
68 {{image reference="ReleaseNotesXWiki73M2@breadcrumb-full.png"/}}
69 )))
70
71 Note that this behavior have also been added to all hierarchy breadcrumbs, including location of search results, etc...
72
73 (((
74 {{image reference="ReleaseNotesXWiki73M2@breadcrumb-search-results.png"/}}
75 )))
76
77 The breadcrumb has now support for tree navigation. Each breadcrumb element has a drop down tree that shows the siblings and the children, helping you navigate easily around the wiki.
78
79 {{image reference="ReleaseNotesXWiki73M2@breadcrumbsTreeNavigation.png"/}}
80
81 == Page Index ==
82
83 Since we have introduced the concept of Nested Spaces we needed to replace the Space column in the LiveTable with a more generic solution. Thus, the [[extensions:Extension.Index Application]] has now merged the previous Page + Space columns into a single ##Location## column and we've introduced new ##Title## column but which now displays the title of pages, as can be seen on the following screenshot:
84
85 {{image reference="ReleaseNotesXWiki73M2@livetable-location.png" width="50%"/}}
86
87 The same strategy is implemented for the ##children## and the ##siblings## viewers.
88
89 Note that you can filter at several path levels in the Location column. For example:
90
91 {{image reference="ReleaseNotesXWiki73M2@location-filter.png" width="50%"/}}
92
93 {{info}}
94 XWiki currently doesn't support filtering on Page titles which is why the new ##Title## column doesn't allow filtering. However since the ##Location## column includes the full path, users can still search on Page names.
95
96 At a technical level the displaying of page titles was needed because all non-terminal pages names are called ##WebHome## and displaying that would not be user-friendly.
97 {{/info}}
98
99 == New Panels ==
100
101 * A [[Children Panel>>extensions:Extension.Panels Application||anchor="HChildrenPanel"]] has been added to display the list of Children pages of the current Page.(((
102 {{image reference="ReleaseNotesXWiki73M2@children.png"/}}
103 )))
104 * A [[Siblings Panel>>extensions:Extension.Panels Application||anchor="HSiblingsPanel"]] has been added to display the list of Sibling pages of the current Page.(((
105 {{image reference="ReleaseNotesXWiki73M2@siblings.png"/}}
106 )))
107 * The [[SpaceDocs Panel>>extensions:Extension.Panels Application||anchor="HSpaceDocsPanel"]] has been deprecated and the [[Children Panel>>extensions:Extension.Panels Application||anchor="HChildrenPanel"]] or [[Siblings Panel>>extensions:Extension.Panels Application||anchor="HSiblingsPanel"]] should be used instead. A warning message has been added (visible only to Admins) to explain this:(((
108 {{image reference="ReleaseNotesXWiki73M2@spacedocs-warning.png"/}}
109 )))
110
111 == App Within Minutes ==
112
113 Up until this version, the applications created with App Within Minutes were always located in a top level space. For instance, if you wanted to create a "Meeting" application, the application data space was "Meeting". Starting with this version you can also create an application in a nested space. In the first step of the wizard you can select the location where you want the application to be created. In the following image I have create an application with path "Marius / Apps / Meeting".
114
115 {{image reference="ReleaseNotesXWiki73M2@appLocationPicker.png" width="600"/}}
116
117 == Template Providers Administration ==
118
119 The template provider UI has been adapted to Nested Pages and it now supports:
120
121 * Creating template providers deeper than the first level (as it was restricted before), reusing the location picker widget
122 * Setting allowed locations (i.e. spaces) using the tree widget
123
124 {{gallery}}
125 image:ReleaseNotesXWiki73M2@TemplateProviderCreationUI-NestedPages.png
126
127 image:ReleaseNotesXWiki73M2@TemplateProviderEditUI-NestedPages.png
128
129 image:ReleaseNotesXWiki73M2@TemplateProviderViewUI-NestedPages.png
130 {{/gallery}}
131
132 For more details, see the [[XWIKI-12275>>http://jira.xwiki.org/browse/XWIKI-12275]] issue and the [[documentation>>extensions:Extension.Administration Application||anchor="HTemplates"]].
133
134 == XClass Application ==
135
136 The [[XClass Application>>extensions:Extension.XClass Application]] has been modified to support classes defined in nested documents. The default class sheet has been improved to use the new location picker when creating a new class entry, and the list of existing entries is now displayed using a live table. The 'Data types' page has been improved to use the new location picker when creating a new class, and the list of existing classes (data types) is now displayed using a live table.
137
138 {{gallery}}
139 image:ReleaseNotesXWiki73M2@classSheet.png
140 image:ReleaseNotesXWiki73M2@dataTypes.png
141 {{/gallery}}
142
143 == Miscellaneous ==
144
145 * The Extension Diff view has been improved to display the page (translation) language both in the summary and the detail sections. The page name (heading) from the detail section is now a link to the local version of the page.(((
146 {{image reference="ReleaseNotesXWiki73M1@extensionDiff.png" width="200"/}}
147 )))
148 * Added the Actions column for the [[FAQ Application>>extensions:Extension.FAQ Application]]:(((
149 {{image reference="ReleaseNotesXWiki73M1@faqActions.png"/}}
150 )))
151 * Pages with Slovak and Brazilian Portuguese language are now indexed by Solr and thus they are included in the search results. See the [[Migration Notes>>||anchor="HIssuesspecifictoXWiki7.3-milestone-1"]] below in case you are performing an upgrade and you want support for these languages.
152 * Clicking on the Logo (top-left of the screen) will now take you to the page that you have configured as wiki homepage by using the "Wiki Administration > Wikis > Descriptor" section. See the related [[documentation section>>extensions:Extension.Wiki Application||anchor="HConfigureWiki"]].
153 * The template providers edition has been rewritten to be more consistent with other edit forms:(((
154 {{image reference="ReleaseNotesXWiki73M1@template-provider-edit.png" width="50%"/}}
155 )))
156 * Removed the 'Edit' button when editing a template provider document. See [[XWIKI-12675>>http://jira.xwiki.org/browse/XWIKI-12675]]
157 * The [[Invitation Application>>extensions:Extension.Invitation Application]] now has an entry point in the App Bar (only visible to Admins).
158 * The [[Active Installs Client module>>extensions:Extension.Active Installs Client API||anchor="HFormatEvolution"]] had a bug leading to the ##sinceDays## field not being set correctly (was almost always set to 0).
159 * [[New ##xpage## parameter>>platform:DevGuide.Standard URL Format||anchor="HParameter:xpage"]]: ##outputTitle##. If ##true## then also display the title in addition to the content. Defaults to ##false## if not specified.
160 * The XWiki Syntax help now no longer shows help for syntaxes that are not available in the wiki.
161
162 See the [[full list of JIRA issues>>http://jira.xwiki.org/issues/?filter=14214]] fixed in this release.
163
164 = For Developers =
165
166 == Extension Manager ==
167
168 === Custom repositories ===
169
170 Extensions and dependencies can now provide custom repositories. For now only dependencies repositories are directly used when resolving it before trying registered repositories.
171
172 In practice it means that Maven custom repositories are now supported properly (at least to resolve artifacts dependencies). On Extension Manager side it means you get the same custom repositories duplicated in the Extension and in each ExtensionDependency.
173
174 Support also been added to Extension Repository API. It's also imported in XWiki based Extension Repository implementation but not yet exposed as REST resource.
175
176 === Resolve dependencies in extension repository first ===
177
178 The extension repository is checked first when searching for extension dependencies.
179
180 == Extensions Repository ==
181
182 * New Extensions are now created in their own space by default (as the space home page). It will make it easier to organize documentation for large Extensions.
183 * Custom Extension repositories are now sent by the Extension Repository REST service
184
185 == REST API ==
186
187 It's now possible to get a page with everything but attachment content: for this you can enable various part of the document using the following URL parameters:
188
189 * ##objects##: enable returning document objects
190 * ##class##: enable returning document class properties
191 * ##attachments##: enable returning document attachments
192
193 They are all disabled by default.
194
195 Page objects support has also been added to the Page PUT API.
196
197 === REST supports ##hidden## ===
198
199 You can now set and/or get information from the status ##hidden## of a page with REST service. For example, you may create a hidden page using the following file and the following request.
200
201 {{code language="xml"}}
202 <page xmlns="http://www.xwiki.org">
203 <title>Test of hidden</title>
204 <hidden>true</hidden>
205 <content/>
206 </page>
207 {{/code}}
208
209 {{code language="none"}}
210 curl \
211 --verbose \
212 --user Admin:admin \
213 --request PUT \
214 --header "Content-type: application/xml" \
215 --data-binary "@page.xml" \
216 "http://localhost:8080/xwiki/rest/wikis/xwiki/spaces/SomeSpace/pages/SomePage"
217 {{/code}}
218
219 And then check the status of this ##hidden## status with a ##GET## HTTP request
220
221 {{code language="none"}}
222 curl \
223 --verbose \
224 --user Admin:admin \
225 --request GET \
226 --header "Accept: application/xml" \
227 "http://localhost:8080/xwiki/rest/wikis/xwiki/spaces/SomeSpace/pages/SomePage"
228 {{/code}}
229
230 You may also use the ##application/x-www-form-urlencoded## to set this ##hidden## field.
231
232 {{code language="none"}}
233 curl \
234 --verbose \
235 --user Admin:admin \
236 --request PUT \
237 --header "Content-type: application/x-www-form-urlencoded" \
238 --data "title=Test of hidden&hidden=true&content=" \
239 "http://localhost:8080/xwiki/rest/wikis/xwiki/spaces/SomeSpace/pages/SomePage"
240 {{/code}}
241
242 See [[The XWiki RESTful API>>platform:Features.XWikiRESTfulAPI]] for more details.
243
244 == Flamingo ==
245
246 The Drawer menu and the content menus are now implemented with [[UI extensions>>extensions:Extension.UIExtension Module]]. The new Extension Points are:
247
248 |= [[##org.xwiki.plaftorm.drawer##>>platform:ExtensionPoint.DrawerItem]]|=[[##org.xwiki.plaftorm.drawer.header##>>platform:ExtensionPoint.DrawerHeaderItem]]
249 |(((
250 {{image reference="ReleaseNotesXWiki73M1@drawer-with-languages.png" width="20%"/}}
251 )))|(((
252 {{image reference="ReleaseNotesXWiki73M1@drawer-header.png" width="20%"/}}
253 )))
254 |= [[##org.xwiki.plaftorm.editactions##>>platform:ExtensionPoint.Edit Actions]]|=[[##org.xwiki.plaftorm.adminactions##>>platform:ExtensionPoint.Admin Actions]]|=[[##org.xwiki.plaftorm.moreoptions##>>platform:ExtensionPoint.More Options]]
255 |(((
256 {{image reference="editactions.png" width="50%"/}}
257 )))|(((
258 {{image reference="adminactions.png" width="50%"/}}
259 )))|(((
260 {{image reference="moreoptions.png" width="50%"/}}
261 )))
262
263 The extension point [[platform:ExtensionPoint.DrawerItem]] has now a parameter ##separator## to add a line separator before the drawer item.
264
265 == Miscellaneous ==
266
267 * New ##getReference()## API public scripting Element (Object, Class, etc.) to get the EntityReference of the element
268 * New functional tests for the [[extensions:Extension.Office Importer Application]] have been added to ##xwiki-platform##. To enable them, you need to enable the new profile ##office-tests##.
269 * For testing purpose, an environment variable ##XWIKI_OFFICE_HOME## can bet set to configure where the Office server is installed on the system.
270 * New [[Time Zone XProperty type>>platform:DevGuide.DataModel]] to represent Time Zones.
271 * The [[XAR plugin>>dev:Community.XARPlugin]] now verifies that Technical Pages are set as hidden and the Format Mojo sets them as hidden.
272 * A new [[XAR Integration testing framework>>dev:Community.Testing||anchor="HXARTesting"]] has been introduced. It can be used to write integration tests for wiki pages.
273 * Issue management information are now imported, displayed and exposed in the REST service in the Extensions Repository
274 * A ##displayTitle## option has been added to the hierarchy macros. By default, it is set to true. When disabled, the names of the references are displayed in the breadcrumb, instead of the document titles.
275 * The ##documentTree## macro has been moved to its own module, under the Index application, so that it can be used as a dependency in other modules without pulling the entire Index application.
276
277 * XAR plugin's [[Verify Mojo>>dev:Community.XARPlugin||anchor="HVerifyMojo"]] can now verify that defined pages have matching titles.
278 * log4j 1.2.17 and commons-logging 1.2 are now found as core extension (which prevent them being installed as dependencies)
279
280 == Deprecated and Retired projects ==
281
282 * The [[XML-RPC Integration>>extensions:Extension.XML-RPC Integration]] has been retired. It had been deprecated several years ago in favor of the [[REST API>>platform:Features.XWikiRESTfulAPI]] and it wasn't actively supported.
283
284 == Upgrades ==
285
286 The following dependencies have been upgraded:
287
288 * [[JSqlParser 0.9.4>>http://jira.xwiki.org/browse/XWIKI-12603]]
289 * [[Jackson 2.6.2>>http://jira.xwiki.org/browse/XCOMMONS-848]]
290 * [[httpclient 4.5.1>>http://jira.xwiki.org/browse/XCOMMONS-850]]
291 * [[Groovy 2.4.5>>http://jira.xwiki.org/browse/XCOMMONS-852]]
292 * [[Restlet 2.3.5 and JAX-RS 2>>http://jira.xwiki.org/browse/XCOMMONS-341]]
293 * [[Lucene and Solr 5.3.1>>http://jira.xwiki.org/browse/XWIKI-12131]]
294 * [[LessJs 2.5.3>>http://jira.xwiki.org/browse/XWIKI-12655]]
295 * [[Jetty 9.2.13.v20150730>>http://jira.xwiki.org/browse/XWIKI-12677]]. Note that this dependency is used only in the Jetty distribution.
296 * [[Jackson 2.6.3>>http://jira.xwiki.org/browse/XCOMMONS-861]]
297 * [[LiveValidation 1.4>>http://jira.xwiki.org/browse/XWIKI-12712]]
298
299 = Translations =
300
301 The following translations have been updated:
302
303 {{language codes="da, sk, fr, hu, pt_BR"/}}
304
305 {{comment}}
306 = Tested Browsers & Databases =
307
308 {{warning}}
309 The QA Tests are executed after the release has been done. Thus, they are being prepared now and will be published soon.
310 {{/warning}}
311 {{/comment}}
312
313 {{comment}}
314 TODO: uncomment and update with proper link when the report is ready.
315 {{include reference="TestReports.ManualTestReportTemplateSummary"/}}
316 {{/comment}}
317
318 {{comment}}
319 = Performances tests compared to <last super stable version> =
320
321 <a summary of the comparison with latest super stable version>
322
323 More details on <link to the test report>.
324 {{/comment}}
325
326 = Known issues =
327
328 * [[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]]
329
330 = Backward Compatibility and Migration Notes =
331
332 == General Notes ==
333
334 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.
335
336 == Issues specific to XWiki 7.3 ==
337
338 * If you had modified the custom displayer for Time Zones in either ##XWiki.XWikiUsers## or ##XWiki.XWikiPreferences## then when upgrading to 7.3M1 your change will be removed. This is because we've introduced a Time Zone XProperty type which is replacing the String type used before for storing the Time Zones. If you wish to put back your change you can define a custom displayer on the new Time Zone XProperty in ##XWiki.XWikiUsers## or ##XWiki.XWikiPreferences##.
339 * In order to add support for Slovak and Brazilian Portuguese languages to the Solr search we had to modify the Solr schema and unfortunately we don't have support for automatic Solr search index migration at this point. If you want to support these languages you have to delete the 'solr' folder from the configured permanent directory of your XWiki instance. The Solr index will be recreated automatically and the entire wiki/farm (including the pages in the Slovak and Brazilian Portuguese language) will be re-indexed after a server restart.
340
341 == API Breakages ==
342
343 The following APIs were modified since XWiki 7.2:
344
345 * Add support for custom repositories in extensions: (((
346 {{code language="none"}}
347 org.xwiki.extension.Extension: Method 'public java.util.Collection getRepositories()' has been added to an interface
348 org.xwiki.extension.ExtensionDependency: Method 'public java.util.Collection getRepositories()' has been added to an interface
349 {{/code}}
350 )))
351 * New URL parameters: (((
352 {{code language="none"}}
353 org.xwiki.rest.resources.pages.PageResource: In method 'public org.xwiki.rest.model.jaxb.Page getPage(java.lang.String, java.lang.String, java.lang.String, java.lang.Boolean)' the number of arguments has changed
354 {{/code}}
355 )))

About

About

Support

Platform

User Guide

Admin Guide

Developer Guide

Projects

XWiki

Extensions

Other

Contribute

Status

Practices

Under the Hood

Get Involved

Get Connected