Version 22.1 by Clemens Robbenhaar on 2014/06/20

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 6.1 milestone 2) =
10
11 [[Full list of issues fixed and Dashboard for 6.1>>http://jira.xwiki.org/secure/Dashboard.jspa?selectPageId=12290]].
12
13 == Flamingo Skin ==
14
15 * The preview action has been implemented:(((
16 {{image reference="preview.png" width="60%"/}}
17 )))
18 * The user's avatar is now displayed in the main menu:(((
19 {{image reference="navbar.png" width="60%"/}}
20 )))
21 * 'Share by email' menu entry is moved from 'Page' submenu to 'More actions' submenu:(((
22 {{image reference="moreActions.png"/}}
23 )))
24 * Annotations are back!(((
25 {{image reference="flamingo-annotations.png" width="60%"/}}
26 )))
27 * A lot of polishing have been made too, in order to have a skin usable in production.
28
29 == Miscellaneous ==
30
31 <insert misc user stuff and important bug fix descriptions here in a list, when they are too small to warrant a section by themselves - Change the version in the URL below!>
32
33 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+%226.1-rc-1%22&tempMax=1000]] fixed in this release.
34
35 = For Developers =
36
37 == Log from a script ==
38
39 A new API to get a SLF4J Logger has been added to the ##logging## script service.
40
41 {{code language="velocity"}}
42 $services.logging.getLogger('My script').info('Hello {}', 'world')
43 {{/code}}
44
45 == New contextual authorization manager role ==
46
47 A new role is now available to ease the replacement of the old Right Service (com.xpn.xwiki.user.api.XWikiRightService).
48 Compared to the old service, the component does not manage authentication which should have been ensured previously if needed. (No redirection to login is ever done)
49 The new component has a similar interface to the AuthorizationManager, but it take care of all external context aspects, like the currently executed macro block, the rendering context restrictions, the dropping of rights, etc...
50 This new role should be used from now on by any component that needs to check rights for the current user, in the current context.
51
52 == New security authorization script service ==
53
54 A new script service is now available to access the default AuthorizationManager and the ContextualAuthorizationManager.
55
56 Here is some sample:
57
58 {{code language="velocity"}}
59 #if ($services.security.authorization.hasAccess("edit"))
60 ... show some UI that require edit access on the current document by the current user ...
61 #end
62 #if ($services.security.authorization.hasAccess("edit", "xwiki:Sandbox.TestPage1"))
63 ... show some UI that require edit access on Sandbox.TestPage1 document by the current user ...
64 #end
65 #if ($services.security.authorization.hasAccess("edit", "xwiki:XWiki.User1", "xwiki:Sandbox.TestPage1"))
66 ... show some UI that require edit access on Sandbox.TestPage1 document by XWiki.User1 ...
67 #end
68 {{/code}}
69
70 {{code language="velocity"}}
71 $services.security.authorization.checkAccess("edit")
72 ... do some task that require edit access ...
73 {{/code}}
74
75 In this second sample, the macro will fail with an AccessDeniedException if the right is not allowed.
76
77 == Access to BlockMatchers from velocity scripts ==
78
79 To be able to use the ##Block.getBlocks(BlockMatcher, Block.Axes)## method on the rendering blocks in the documents XDOM from velocity, a converter has been introduced that maps string expressions to BlockMatcher objects. The current implementation only supports mapping to ClassBlockMatchers, and allows to get all blocks of a given type from the XDOM.
80
81 {{code language="velocity"}}
82 #foreach($headerBlock in $doc.getDocument().getXDOM().getBlocks("class:HeaderBlock", "DESCENDANT"))
83 ... do something with the header block ...
84 {{/code}}
85
86 == Deprecated and Retired projects ==
87
88 <description of deprecated and retired projects>
89
90 == Upgrades ==
91
92 The following dependencies have been upgraded:
93
94 * [[commons-collections 4.0>>http://jira.xwiki.org/browse/XCOMMONS-605]]
95 * [[httpclient 4.3.4>>http://jira.xwiki.org/browse/XCOMMONS-606]]
96 * [[commons-beanutils 1.9.2>>http://jira.xwiki.org/browse/XCOMMONS-607]]
97 * [[reflections 0.9.9-RC2>>http://jira.xwiki.org/browse/XCOMMONS-608]]
98 * [[slf4j 1.7.7>>http://jira.xwiki.org/browse/XCOMMONS-609]]
99
100 == Miscellaneous ==
101
102 * The [[Mail Sender API>>extensions:Extension.Mail Sender API]] now allows to send Mails from a Template. This is achieved with 2 calls:
103 ** One for setting the Subject from the Template. The following will generate a ##MimeMessage## with the subject pre-filled. The value will be that of the ##subject## xproperty from an ##XWiki.Mail## xobject in the Document pointed to by the passed ##documentReference##:(((
104 {{code language="none"}}
105 #set ($message = $services.mailsender.createMessage("template", documentReference))
106 #set ($message = $services.mailsender.createMessage("template", documentReference, parameters))
107 {{/code}}
108 )))
109 ** One for setting the Body Part content from the Template:(((
110 {{code language="none"}}
111 $message.addPart("xwiki/template", $documentReference, {"velocityVariables" : { "var1" : "value1" }})
112 $message.addPart("xwiki/template", $documentReference, {"velocityVariables" : { "var1" : "value1" }, "attachments" : $attachments})
113 {{/code}}
114 )))
115
116 = Translations =
117
118 The following translations have been updated:
119
120 {{language codes="none, none"/}}
121
122 = Tested Browsers & Databases =
123
124 {{include reference="TestReports.ManualTestReportXWiki61RC1Summary"/}}
125
126 = Known issues =
127
128 * [[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]]
129
130 = Backward Compatibility and Migration Notes =
131
132 == General Notes ==
133
134 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.
135
136 == Issues specific to XWiki <version> ==
137
138 <issues specific to the project>
139
140 == API Breakages ==
141
142 The following APIs were modified since <project> <version - 1>:
143
144 {{code language="none"}}
145 <clirr output here>
146 {{/code}}

Get Connected