Release Notes XWiki 7.4 Milestone 2
This is the release notes for XWiki Commons, XWiki Rendering, XWiki Platform and XWiki Enterprise. They share the same release notes as they are released together and have the same version.
This is our last stabilization branch for the XWiki 7.x Cycle. It brings polishing and stabilization for the Nested Pages feature and the changes in UI that resulted from it. It also introduce a new API to indicate how long a cache entry to stay in the cache (since it was inserted in the cache).
New and Noteworthy (since XWiki 7.4 Milestone 1)
Full list of issues fixed and Dashboard for 7.4.
Support for template hierarchies
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.
The save operation will display progress and if it was a Save&View operation, the form will be disabled until the operation is complete.
More details on the documentation page on document templates.
Database Search
The Database Search UI has been modified to support nested pages.
Miscellaneous
- The "annotations" button in the "More Actions" menu has been moved in the same menu but with other actions and renamed "Annotate".
- 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.
See the full list of JIRA issues fixed in this release.
For Developers
New lifespan LRU Cache setup
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.
LRUEvictionConfiguration lru = new LRUEvictionConfiguration();
// Set maximum size of the cache as 1000 entries
lru.setMaxEntries(1000);
// Set the maximum time to live since when the entry is used to 1 hour
lru.setMaxIdle(3600)
// Set the maximum time to live since when the entry is put in the cache to 1 hour
lru.setLifespan(3600)
Cache Macro and Rendering Cache are now based on this behavior.
VFS API
Replacement of the 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).
In addition a new Velocity Tool was added in order to be able to use a portion of the NIO2 API from Velocity: niotool.
See VFS API and VFS Tree Macro for more details. Some API examples:
## Get the URL to access the content of a file inside a zip:
[[link to file in zip>>$services.vfs.url("attach:Sandbox.WebHome@vma.txt.zip/vma.txt")]]
## Display inline an image from a zip attached to a wiki page:
[[image:path:$services.vfs.url("attach:Sandbox.WebHome@test.zip/test.png")]]
## Read the content of a file inside a zip attached to a page:
$stringtool.toString($niotool.readAllBytes("attach:Sandbox.WebHome@vma.txt.zip/vma.txt"), "utf-8")
## List all entries inside a zip attached to a page:
#set ($dirStream = $niotool.newDirectoryStream("attach:Sandbox.WebHome@vma.txt.zip/"))
#foreach ($entry in $dirStream)
* {{{$entry}}} - $niotool.isDirectory($entry)
#end
{{/velocity}}
{{vfsTree root="attach:Sandbox.WebHome@vma.txt.zip/"/}}
Example of using the vfsTree Macro:
Results in:
Miscellaneous
- WebJars URL format now supports a wiki query string parameter to specify the wiki in which the webjars resource is available. For example: /xwiki/webjars/AjaxQ/0.0.2/ajaxq.js?wiki=mywiki
- The default link behaviour can be disabled for a tree node, when you use the Tree Widget, by using the 'jstree-no-link' CSS class on the node anchor, which can be set from the node JSON:{
... (node JSON) ...
'a_attr': {
'class': 'jstree-no-link',
'href': 'some/url'
}
} - The $regextool Velocity Tool has a new method:/**
* @param content the content to parse
* @param regex the regular expression to look for in the passed content
* @return an empty list if the passed regular expression doesn't match the content, several {@link RegexResult}
* objects containing the matched position and matched content for all capturing groups and sub-groups
* otherwise
*/
public List<List<RegexResult>> findAll(String content, String regex)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:
@Test
public void findAll()
{
RegexTool tool = new RegexTool();
List<List<RegexResult>> result =
tool.findAll("one :two three (:four) five :six seven=:eight", ":(\\w+) (\\w+)");
Assert.assertEquals(2, result.size());
Assert.assertEquals(":two three", result.get(0).get(0).getGroup());
Assert.assertEquals(":six seven", result.get(1).get(0).getGroup());
Assert.assertEquals(3, result.get(0).size());
Assert.assertEquals("two", result.get(0).get(1).getGroup());
Assert.assertEquals("three", result.get(0).get(2).getGroup());
Assert.assertEquals(3, result.get(1).size());
Assert.assertEquals("six", result.get(1).get(1).getGroup());
Assert.assertEquals("seven", result.get(1).get(2).getGroup());
}
Deprecated and Retired projects
- XML-RPC module have been moved to https://github.com/xwiki-contrib/xwiki-platform-xmlrpc
Upgrades
The following dependencies have been upgraded:
Translations
The following translations have been updated:
Tested Browsers & Databases
Known issues
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.
API Breakages
The following APIs were modified since <project> <version - 1>:
