Wiki source code of Release Notes for XWiki 7.4

Version 24.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="[email protected]"/}}
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="[email protected]"/}}
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="[email protected]" 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="[email protected]"/}}
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="[email protected]"/}}
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="[email protected]"/}}
64 )))
65 * To be more intuitive, the titles of the Rights sections in the page administration have been changed.(((
66 {{image reference="[email protected]"/}}
67 )))
68
69 == Miscellaneous ==
70
71 * Some [[bootswatch themes>>extensions:Extension.Bootswatch Themes for Flamingo]] have now a more accurate logo.
72 * When the search button on the top menu is clicked, it now closes all other menus.
73 * The Sandbox now uses XWiki Syntax 2.1.
74 * Non terminal pages are now exported with their corresponding ##WebPreferences## page
75 * The "annotations" button in the "More Actions" menu has been moved in the same menu but with other actions and renamed "Annotate".(((
76 {{image reference="[email protected]"/}}
77 )))
78 * 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"]].
79
80 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.
81
82 = For Developers =
83
84 == Flamingo ==
85
86 An extension point to add content inside the new "Notifications" menu has been added:
87
88 |=##[[org.xwiki.platform.notifications>>platform:ExtensionPoint.Notifications]]##
89 |{{image reference="[email protected]"/}}
90
91 == Tree Velocity Macros ==
92
93 You are now able to "call" the Document Tree from Velocity using something like this:
94
95 {{code language="none"}}
96 #documentTree({
97 'class': 'location-tree',
98 'finder': true,
99 'showAttachments': false,
100 'showRoot': $showRoot,
101 'showTerminalDocuments': false,
102 'showTranslations': false,
103 'showWikis': $showWikis
104 })
105 {{/code}}
106
107 The same is possible with the generic Tree Widget:
108
109 {{code language="none"}}
110 #tree({
111 'reference': 'XWiki.DocumentTree',
112 'root': 'document:xwiki:Sandbox.WebHome',
113 'openTo': 'document:xwiki:Sandbox.TestPage2'
114 })
115 {{/code}}
116
117 All the parameters that are available for the wiki macros (##~{~{documentTree}}## and ##~{~{tree}}##) should be available also for the corresponding Velocity macro.
118
119 == New public Abstract job ==
120
121 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.
122
123 == New lifespan LRU Cache setup ==
124
125 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.
126
127 {{code language="java"}}
128 // Configure cache eviction policy
129 LRUEvictionConfiguration lru = new LRUEvictionConfiguration();
130 // Set maximum size of the cache as 1000 entries
131 lru.setMaxEntries(1000);
132 // Set the maximum time to live since when the entry is used to 1 hour
133 lru.setMaxIdle(3600)
134 // Set the maximum time to live since when the entry is put in the cache to 1 hour
135 lru.setLifespan(3600)
136 {{/code}}
137
138 [[Cache Macro>>extensions:Extension.Cache Macro]] and [[Rendering Cache>>platform:AdminGuide.Performances||anchor="HRenderingcache"]] are now based on this behavior.
139
140 == VFS API ==
141
142 {{warning}}
143 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.
144 {{/warning}}
145
146 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).
147
148 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##.
149
150 See [[VFS API>>extensions:Extension.VFS API]] and [[VFS Tree Macro>>extensions:Extension.VFS Tree Macro]] for more details. Some API examples:
151
152 {{code language="velocity"}}
153 {{velocity}}
154 ## Get the URL to access the content of a file inside a zip:
155 [[link to file in zip>>$services.vfs.url("attach:[email protected]/vma.txt")]]
156
157 ## Display inline an image from a zip attached to a wiki page:
158 [[image:path:$services.vfs.url("attach:[email protected]/test.png")]]
159
160 ## Read the content of a file inside a zip attached to a page:
161 $stringtool.toString($niotool.readAllBytes("attach:[email protected]/vma.txt"), "utf-8")
162
163 ## List all entries inside a zip attached to a page:
164 #set ($dirStream = $niotool.newDirectoryStream("attach:[email protected]/"))
165 #foreach ($entry in $dirStream)
166 * {{{$entry}}} - $niotool.isDirectory($entry)
167 #end
168 {{/velocity}}
169
170 {{vfsTree root="attach:[email protected]/"/}}
171 {{/code}}
172
173 Example of using the ##vfsTree## Macro:
174
175 {{code language="none"}}
176 {{vfsTree root="attach:[email protected]/"/}}
177 {{/code}}
178
179 Results in:
180
181 {{image reference="[email protected]"/}}
182
183
184 == Miscellaneous ==
185
186 * 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.
187 * 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.(((
188 {{code language="none"}}
189 $escapetool.css('a#b.c d[e=f]g{h:i;j}k')
190 ## Output: a\\#b\\.c\\ d\\[e\\=f\\]g\\{h\\:i\\;j\\}k
191 {{/code}}
192 )))
193 * 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.(((
194 {{code language="none"}}
195 {{documentTree filterHiddenDocuments="false" /}}
196 {{/code}}
197 )))
198 * Temporary resources can now be forced to be downloaded by using the ##force-download=1## URL parameter
199 * [[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}}
200 * 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:(((
201 {{code language="none"}}
202 {
203 ... (node JSON) ...
204 'a_attr': {
205 'class': 'jstree-no-link',
206 'href': 'some/url'
207 }
208 }
209 {{/code}}
210 )))
211 * The ##$regextool## [[Velocity Tool>>extensions:Extension.Velocity Module||anchor="HVelocityTools"]] has a new method:(((
212 {{code language="java"}}
213 /**
214 * @param content the content to parse
215 * @param regex the regular expression to look for in the passed content
216 * @return an empty list if the passed regular expression doesn't match the content, several {@link RegexResult}
217 * objects containing the matched position and matched content for all capturing groups and sub-groups
218 * otherwise
219 */
220 public List<List<RegexResult>> findAll(String content, String regex)
221 {{/code}}
222
223 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:
224
225 {{code language="java"}}
226 @Test
227 public void findAll()
228 {
229 RegexTool tool = new RegexTool();
230 List<List<RegexResult>> result =
231 tool.findAll("one :two three (:four) five :six seven=:eight", ":(\\w+) (\\w+)");
232
233 Assert.assertEquals(2, result.size());
234 Assert.assertEquals(":two three", result.get(0).get(0).getGroup());
235 Assert.assertEquals(":six seven", result.get(1).get(0).getGroup());
236
237 Assert.assertEquals(3, result.get(0).size());
238 Assert.assertEquals("two", result.get(0).get(1).getGroup());
239 Assert.assertEquals("three", result.get(0).get(2).getGroup());
240
241 Assert.assertEquals(3, result.get(1).size());
242 Assert.assertEquals("six", result.get(1).get(1).getGroup());
243 Assert.assertEquals("seven", result.get(1).get(2).getGroup());
244 }
245 {{/code}}
246 )))
247
248 * 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.
249 * 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.
250
251 == Deprecated and Retired projects ==
252
253 * XML-RPC module have been moved to https://github.com/xwiki-contrib/xwiki-platform-xmlrpc
254
255 == Upgrades ==
256
257 The following dependencies have been upgraded:
258
259 * [[Batik 1.8>>http://jira.xwiki.org/browse/XWIKI-12904]]
260 * [[commons-collections 4.1>>http://jira.xwiki.org/browse/XCOMMONS-889]]
261 * [[commons-dbcp2 2.1.1>>http://jira.xwiki.org/browse/XCOMMONS-884]]
262 * [[commons-net 3.4>>http://jira.xwiki.org/browse/XCOMMONS-887]]
263 * [[FOP 2.0>>http://jira.xwiki.org/browse/XWIKI-12871]]
264 * [[guava 19>>http://jira.xwiki.org/browse/XCOMMONS-894]]
265 * [[Guice 4.0>>http://jira.xwiki.org/browse/XCOMMONS-883]]
266 * [[Jackson 2.6.4>>http://jira.xwiki.org/browse/XCOMMONS-893]]
267 * [[jboss-logging 3.1.4>>http://jira.xwiki.org/browse/XCOMMONS-885]]
268 * [[Joda-Time 2.9.1>>http://jira.xwiki.org/browse/XWIKI-12816]]
269 * [[Less4j 1.15.4>>http://jira.xwiki.org/browse/XWIKI-12905]]
270 * [[Maven 3.3.9>>http://jira.xwiki.org/browse/XCOMMONS-883]]
271 * [[slf4j 1.7.13>>http://jira.xwiki.org/browse/XCOMMONS-879]]
272 * [[Woodstox 4.4.1>>http://jira.xwiki.org/browse/XWIKI-12853]]
273
274 = Translations =
275
276 The following translations have been updated:
277
278 {{language codes="none, none"/}}
279
280 = Tested Browsers & Databases =
281
282 {{warning}}
283 The QA Tests are executed after the release has been done. Thus, they are being prepared now and will be published soon.
284 {{/warning}}
285
286 {{comment}}
287 TODO: uncomment and update with proper link when the report is ready.
288 {{include reference="TestReports.ManualTestReportTemplateSummary"/}}
289 {{/comment}}
290
291 = Performances tests compared to <last super stable version> =
292
293 <a summary of the comparison with latest super stable version>
294
295 More details on <link to the test report>.
296
297 = Known issues =
298
299 * [[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]]
300
301 = Backward Compatibility and Migration Notes =
302
303 == General Notes ==
304
305 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.
306
307 == Issues specific to XWiki 7.4 ==
308
309 * Better backward-compatibility for URLs has been added for the following 2 cases:
310 ** 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
311 ** The ##view## action can be specified even when the wiki is configured to hide the ##view## action.
312 ** Note that this fixes [[some backward-compatibility issue introduced in XWiki 7.2>>ReleaseNotes.ReleaseNotesXWiki72||anchor="HURLs"]]
313
314 == API Breakages ==
315
316 The following APIs were modified since <project> <version - 1>:
317
318 {{code language="none"}}
319 <clirr output here>
320 {{/code}}

Get Connected