Skip to Content

Wiki source code of Release Notes for XWiki 7.4

Version 22.1 by Guillaume Delhumeau on 2015/12/28
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 7.3) =
10
11 [[Full list of issues fixed and Dashboard for 7.4>>http://jira.xwiki.org/secure/Dashboard.jspa?selectPageId=13590]].
12
13 == Notifications & Watchlist ==
14
15 * A new menu has been added to the top bar, on the right: the "notifications" menu (represented by a bell). In the future, it will be the place where you can find notifications about some events happening on the wiki (personal message, a page has been modified, etc...).(((
16 {{image reference="Notifications.png"/}}
17 )))
18 * In this menu, we have moved the Watchlist icons (watch this page, watch this wiki, etc...). These actions can be triggered with the new switch buttons(((
19 {{image reference="WatchList-Notifications.png"/}}
20 )))
21 * The livetable of the [[WatchList macro>>extensions:Extension.Watchlist Application]] have been updated to support Nested Pages.(((
22 {{image reference="WatchListTable.png"/}}
23 )))
24
25 == App Within Minutes ==
26
27 The application Code and Data pages are now being created. The Code page lists the application code pages.
28
29 {{image reference="ReleaseNotesXWiki74M1@awmCodeHomePage.png"/}}
30
31 The application Data page shows a live table with the application entries. The application home page has been modified to include the Data page.
32
33 {{image reference="ReleaseNotesXWiki74M1@awmDataHomePage.png"/}}
34
35 The application entries (custom) live table results page is not generated any more because it was used only to load the translations on demand and now they are loaded on the wiki or user scope, based on the user rights.
36
37 == Support for template hierarchies ==
38
39 When creating a new document from template, if the template has descendent documents under its path, those documents will also be copied over to the new document's location, preserving the hierarchy, as it was under the template document.
40
41 The save operation will display progress and if it was a Save&View operation, the form will be disabled until the operation is complete.
42
43 More details on the [[documentation page on document templates>>extensions:Extension.Administration Application||anchor="HUsingahierarchyofNestedDocumentsastemplate"]].
44
45 {{image reference="ReleaseNotesXWiki74M2@savingNewDocumentWithTemplateHierarchy.png" width="50%"/}}
46
47 == Automatic Redirect on Page Rename ==
48
49 The [[Rename Page>>platform:Features.DocumentLifecycle||anchor="HMove2FRename"]] action has a new option (selected by default) to create an automatic redirect from the old page location to the new one. This will ensure that the external links (e.g. the bookmarks) to the renamed page (and its children) will continue to work.
50
51 {{image reference="ReleaseNotesXWiki74M2@RenameConfirmFlamingo.png"/}}
52
53 == Database Search ==
54
55 The [[Database Search>>extensions:Extension.Search Application||anchor="HDatabaseSearch"]] UI has been modified to support nested pages.
56
57 {{image reference="ReleaseNotesXWiki74M2@databaseSearch.png"/}}
58
59 == Changes in the UI ==
60
61 * The default logo is now optimized for "Retina" screens, and can be scaled to any dimensions since it's a vectorial image.
62 * The Information tab, at the bottom of each page, does not display the parent and the children of the current page anymore. Since this information is available both in the breadcrumb and in the children viewer, they were redundant and have been removed.(((
63 {{image reference="ReleaseNotesXWiki74RC1@InformationsTab.png"/}}
64 )))
65 * The search and the notification icons have been inverted. The new order looks more natural when the search bar is expanded.(((
66 {{image reference="ReleaseNotesXWiki74RC1@NotificationsAndSearch.png"/}} {{image reference="ReleaseNotesXWiki74RC1@SearchExtended.png"/}}
67 )))
68 * To be more intuitive, the titles of the Rights sections in the page administration have been changed.(((
69 {{image reference="ReleaseNotesXWiki74RC1@RightsAdmin.png"/}}
70 )))
71
72 == Miscellaneous ==
73
74 * Some [[bootswatch themes>>extensions:Extension.Bootswatch Themes for Flamingo]] have now a more accurate logo.
75 * When the search button on the top menu is clicked, it now closes all other menus.
76 * The Sandbox now uses XWiki Syntax 2.1.
77 * Non terminal pages are now exported with their corresponding ##WebPreferences## page
78 * The "annotations" button in the "More Actions" menu has been moved in the same menu but with other actions and renamed "Annotate".(((
79 {{image reference="ReleaseNotesXWiki74M2@Annotate.png"/}}
80 )))
81 * The Create Page UI allows you to view and change the location of the new page (that is going to be created) even when you [[open directly the URL of a new page>>platform:Features.DocumentLifecycle||anchor="HByenteringdirectlytheURLofthenewpage"]].
82
83 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%29+and+status+%3D+Closed+and+resolution+%3D+Fixed+and+fixVersion+%3D+%227.4%22&tempMax=1000]] fixed in this release.
84
85 = For Developers =
86
87 == Flamingo ==
88
89 An extension point to add content inside the new "Notifications" menu has been added:
90
91 |=##[[org.xwiki.platform.notifications>>platform:ExtensionPoint.Notifications]]##
92 |{{image reference="ReleaseNotesXWiki74M1@NotificationsInside.png"/}}
93
94 == Tree Velocity Macros ==
95
96 You are now able to "call" the Document Tree from Velocity using something like this:
97
98 {{code language="none"}}
99 #documentTree({
100 'class': 'location-tree',
101 'finder': true,
102 'showAttachments': false,
103 'showRoot': $showRoot,
104 'showTerminalDocuments': false,
105 'showTranslations': false,
106 'showWikis': $showWikis
107 })
108 {{/code}}
109
110 The same is possible with the generic Tree Widget:
111
112 {{code language="none"}}
113 #tree({
114 'reference': 'XWiki.DocumentTree',
115 'root': 'document:xwiki:Sandbox.WebHome',
116 'openTo': 'document:xwiki:Sandbox.TestPage2'
117 })
118 {{/code}}
119
120 All the parameters that are available for the wiki macros (##~{~{documentTree}}## and ##~{~{tree}}##) should be available also for the corresponding Velocity macro.
121
122 == New public Abstract job ==
123
124 A public ##org.xwiki.job.AbstractJob## (and corresponding ##AbstractJobStatus##) is now provided to help implementing a Job. An ##AbstractJob## class already existed since a long time but it was in an internal package.
125
126 == New lifespan LRU Cache setup ==
127
128 It's now possible to define the maximum time to live since the entry is put in the cache. It used to be possible to set it only since the last time the value was used.
129
130 {{code language="java"}}
131 // Configure cache eviction policy
132 LRUEvictionConfiguration lru = new LRUEvictionConfiguration();
133 // Set maximum size of the cache as 1000 entries
134 lru.setMaxEntries(1000);
135 // Set the maximum time to live since when the entry is used to 1 hour
136 lru.setMaxIdle(3600)
137 // Set the maximum time to live since when the entry is put in the cache to 1 hour
138 lru.setLifespan(3600)
139 {{/code}}
140
141 [[Cache Macro>>extensions:Extension.Cache Macro]] and [[Rendering Cache>>platform:AdminGuide.Performances||anchor="HRenderingcache"]] are now based on this behavior.
142
143 == VFS API ==
144
145 {{warning}}
146 Right now the [[VFS API is missing authorization checks>>http://jira.xwiki.org/browse/XWIKI-12912]], meaning that you should use it only for public archives.
147 {{/warning}}
148
149 Replacement of the [[Zip Explorer Plugin>>extensions:Extension.ZIP Explorer Plugin]]. API to access the content of archives files (zip, jar, gzip, tar, etc) located as attachments in wiki pages or elsewhere (external URLs, file system, et).
150
151 In addition a new [[Velocity Tool>>extensions:Extension.Velocity Module||anchor="HVelocityTools"]] was added in order to be able to use a portion of the NIO2 API from Velocity: ##niotool##.
152
153 See [[VFS API>>extensions:Extension.VFS API]] and [[VFS Tree Macro>>extensions:Extension.VFS Tree Macro]] for more details. Some API examples:
154
155 {{code language="velocity"}}
156 {{velocity}}
157 ## Get the URL to access the content of a file inside a zip:
158 [[link to file in zip>>$services.vfs.url("attach:Sandbox.WebHome@vma.txt.zip/vma.txt")]]
159
160 ## Display inline an image from a zip attached to a wiki page:
161 [[image:path:$services.vfs.url("attach:Sandbox.WebHome@test.zip/test.png")]]
162
163 ## Read the content of a file inside a zip attached to a page:
164 $stringtool.toString($niotool.readAllBytes("attach:Sandbox.WebHome@vma.txt.zip/vma.txt"), "utf-8")
165
166 ## List all entries inside a zip attached to a page:
167 #set ($dirStream = $niotool.newDirectoryStream("attach:Sandbox.WebHome@vma.txt.zip/"))
168 #foreach ($entry in $dirStream)
169 * {{{$entry}}} - $niotool.isDirectory($entry)
170 #end
171 {{/velocity}}
172
173 {{vfsTree root="attach:Sandbox.WebHome@vma.txt.zip/"/}}
174 {{/code}}
175
176 Example of using the ##vfsTree## Macro:
177
178 {{code language="none"}}
179 {{vfsTree root="attach:Sandbox.WebHome@vma.txt.zip/"/}}
180 {{/code}}
181
182 Results in:
183
184 {{image reference="ReleaseNotesXWiki74M2@vfstree.png"/}}
185
186
187 == Miscellaneous ==
188
189 * A new ##extractFirstReference(EntityType)## API has been added to ##EntityReference##: Extract the first entity of the given type from this one by traversing the current entity to the root. This differentiates it from ##extractReference(EntityType)## which extracts the last entity of the given type.
190 * The escape Velocity tool has a new method to escape CSS identifiers. This is similar to ##CSS.escape()## available in JavaScript, and is useful if you want to create CSS selectors dynamicaly using untrusted input.(((
191 {{code language="none"}}
192 $escapetool.css('a#b.c d[e=f]g{h:i;j}k')
193 ## Output: a\\#b\\.c\\ d\\[e\\=f\\]g\\{h\\:i\\;j\\}k
194 {{/code}}
195 )))
196 * The Document Tree Macro has a new parameter to control whether the hidden documents are filtered or not. Set to false to force the display of the hidden documents in the tree.(((
197 {{code language="none"}}
198 {{documentTree filterHiddenDocuments="false" /}}
199 {{/code}}
200 )))
201 * Temporary resources can now be forced to be downloaded by using the ##force-download=1## URL parameter
202 * [[WebJars URL format>>extensions:Extension.WebJars Integration||anchor="HURLFormat"]] now supports a ##wiki## query string parameter to specify the wiki in which the webjars resource is available. For example: {{code language="none"}}/xwiki/webjars/AjaxQ/0.0.2/ajaxq.js?wiki=mywiki{{/code}}
203 * The default link behaviour can be disabled for a tree node, when you use the [[Tree Widget>>extensions:Extension.Tree Widget]], by using the 'jstree-no-link' CSS class on the node anchor, which can be set from the node JSON:(((
204 {{code language="none"}}
205 {
206 ... (node JSON) ...
207 'a_attr': {
208 'class': 'jstree-no-link',
209 'href': 'some/url'
210 }
211 }
212 {{/code}}
213 )))
214 * The ##$regextool## [[Velocity Tool>>extensions:Extension.Velocity Module||anchor="HVelocityTools"]] has a new method:(((
215 {{code language="java"}}
216 /**
217 * @param content the content to parse
218 * @param regex the regular expression to look for in the passed content
219 * @return an empty list if the passed regular expression doesn't match the content, several {@link RegexResult}
220 * objects containing the matched position and matched content for all capturing groups and sub-groups
221 * otherwise
222 */
223 public List<List<RegexResult>> findAll(String content, String regex)
224 {{/code}}
225
226 We had to add a new method because the existing ##RegexTool#find(String, String)## returns information about only the first capturing group. Here's a test to show how the new method works:
227
228 {{code language="java"}}
229 @Test
230 public void findAll()
231 {
232 RegexTool tool = new RegexTool();
233 List<List<RegexResult>> result =
234 tool.findAll("one :two three (:four) five :six seven=:eight", ":(\\w+) (\\w+)");
235
236 Assert.assertEquals(2, result.size());
237 Assert.assertEquals(":two three", result.get(0).get(0).getGroup());
238 Assert.assertEquals(":six seven", result.get(1).get(0).getGroup());
239
240 Assert.assertEquals(3, result.get(0).size());
241 Assert.assertEquals("two", result.get(0).get(1).getGroup());
242 Assert.assertEquals("three", result.get(0).get(2).getGroup());
243
244 Assert.assertEquals(3, result.get(1).size());
245 Assert.assertEquals("six", result.get(1).get(1).getGroup());
246 Assert.assertEquals("seven", result.get(1).get(2).getGroup());
247 }
248 {{/code}}
249 )))
250
251 * The top level Commons POM now performs some checks on the POMs that have it as parent; for example it checks that non core POMs don't use the "XWiki Development Team" in the developers section so that non-core Extensions deployed on extensions.xwiki.org don't appear as developed by the XWiki Development Team.
252 * You can now disable the default [[Live Table>>extensions:Extension.Livetable Macro]] query filters by passing the empty string as the value of the ##queryFilters## parameter.
253
254 == Deprecated and Retired projects ==
255
256 * XML-RPC module have been moved to https://github.com/xwiki-contrib/xwiki-platform-xmlrpc
257
258 == Upgrades ==
259
260 The following dependencies have been upgraded:
261
262 * [[Batik 1.8>>http://jira.xwiki.org/browse/XWIKI-12904]]
263 * [[commons-collections 4.1>>http://jira.xwiki.org/browse/XCOMMONS-889]]
264 * [[commons-dbcp2 2.1.1>>http://jira.xwiki.org/browse/XCOMMONS-884]]
265 * [[commons-net 3.4>>http://jira.xwiki.org/browse/XCOMMONS-887]]
266 * [[FOP 2.0>>http://jira.xwiki.org/browse/XWIKI-12871]]
267 * [[guava 19>>http://jira.xwiki.org/browse/XCOMMONS-894]]
268 * [[Guice 4.0>>http://jira.xwiki.org/browse/XCOMMONS-883]]
269 * [[Jackson 2.6.4>>http://jira.xwiki.org/browse/XCOMMONS-893]]
270 * [[jboss-logging 3.1.4>>http://jira.xwiki.org/browse/XCOMMONS-885]]
271 * [[Joda-Time 2.9.1>>http://jira.xwiki.org/browse/XWIKI-12816]]
272 * [[Less4j 1.15.4>>http://jira.xwiki.org/browse/XWIKI-12905]]
273 * [[Maven 3.3.9>>http://jira.xwiki.org/browse/XCOMMONS-883]]
274 * [[slf4j 1.7.13>>http://jira.xwiki.org/browse/XCOMMONS-879]]
275 * [[Woodstox 4.4.1>>http://jira.xwiki.org/browse/XWIKI-12853]]
276
277 = Translations =
278
279 The following translations have been updated:
280
281 {{language codes="none, none"/}}
282
283 = Tested Browsers & Databases =
284
285 {{warning}}
286 The QA Tests are executed after the release has been done. Thus, they are being prepared now and will be published soon.
287 {{/warning}}
288
289 {{comment}}
290 TODO: uncomment and update with proper link when the report is ready.
291 {{include reference="TestReports.ManualTestReportTemplateSummary"/}}
292 {{/comment}}
293
294 = Performances tests compared to <last super stable version> =
295
296 <a summary of the comparison with latest super stable version>
297
298 More details on <link to the test report>.
299
300 = Known issues =
301
302 * [[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]]
303
304 = Backward Compatibility and Migration Notes =
305
306 == General Notes ==
307
308 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.
309
310 == Issues specific to XWiki 7.4 ==
311
312 * Better backward-compatibility for URLs has been added for the following 2 cases:
313 ** If the ##view## action is omitted in the URL and the first space name doesn't match an action name, then the "view" action is implied
314 ** The ##view## action can be specified even when the wiki is configured to hide the ##view## action.
315 ** Note that this fixes [[some backward-compatibility issue introduced in XWiki 7.2>>ReleaseNotes.ReleaseNotesXWiki72||anchor="HURLs"]]
316
317 == API Breakages ==
318
319 The following APIs were modified since <project> <version - 1>:
320
321 {{code language="none"}}
322 <clirr output here>
323 {{/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