Version 20.1 by Yuri Konotopov on 2016/04/21

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 8.1 Milestone 1) =
10
11 [[Full list of issues fixed and Dashboard for <version>>>http://jira.xwiki.org/secure/Dashboard.jspa?selectPageId=<fill id here>]].
12
13 == Documents Macro Improvement ==
14
15 The [[Documents Macro>>extensions:Extension.Documents Macro||anchor="HUsage"]] now supports a ##location## parameter to display all documents having their full reference matching the ##location## value.
16
17 For example:
18
19 {{code language="none"}}
20 {{documents location="Sand"/}}
21 {{/code}}
22
23 Gives:
24
25 {{image reference="documents-macro-location.png"/}}
26
27 == RSS Macro Improvements ==
28
29 The [[RSS Macro>>extensions:Extension.RSS Macro]] now supports feeds delivered over HTTPS. Additionally, it now uses its own ##user-agent## string, ##XWiki/VERSION##, where ##VERSION## is the version of XWiki in use.
30
31 == Synchronization of user avatar from LDAP ==
32
33 Binary photos stored in LDAP can be synchronized now to XWiki user avatar. New options are added to control this feature:
34
35 [[image:ldap-photo.png]]
36
37 Please note that user avatar will not be updated from LDAP if user set custom avatar with filename other than specified in XWiki preferences.
38
39 == Miscellaneous ==
40
41 * The [[Document Tree Macro>>extensions:Extension.Document Tree Macro||anchor="HParameters"]] has a new parameter to limit the number of child nodes displayed when a parent node is expanded for the first time.
42
43 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+%22<version>%22&tempMax=1000]] fixed in this release.
44
45 = For Developers =
46
47 == Standard java.lang.Package properties ==
48
49 The following properties are now automatically added to all Maven jar modules MANIFEST files:
50
51 {{code language="properties"}}
52 Specification-Title: ${project.name}
53 Specification-Version: ${project.version}
54 Specification-Vendor: ${project.organization.name}
55 Implementation-Title: ${project.name}
56 Implementation-Version: ${project.version}
57 Implementation-Vendor-Id: ${project.groupId}
58 Implementation-Vendor: ${project.organization.name}
59 Implementation-URL: ${project.url}
60 {{/code}}
61
62 And can be accessed using ##java.lang.Package## from any class. For example:
63
64 {{code language="java"}}
65 String myVersion = this.getClass().getPackage().getImplementationVersion();
66 {{/code}}
67
68 == Deprecated and Retired projects ==
69
70 <description of deprecated and retired projects>
71
72 == Upgrades ==
73
74 The following dependencies have been upgraded:
75
76 * [[Infinispan 8.2.1>>http://jira.xwiki.org/browse/XWIKI-13293]]
77 * [[slf4j 1.7.21>>http://jira.xwiki.org/browse/XCOMMONS-958]]
78 * [[commons-compress 1.11>>http://jira.xwiki.org/browse/XCOMMONS-960]]
79 * [[Bootstrap 3.3.6>>http://jira.xwiki.org/browse/XWIKI-12951]]
80 * [[JGroups 3.6.9>>http://jira.xwiki.org/browse/XWIKI-13344]]
81
82 == Miscellaneous ==
83
84 * The default LiveTable results page (##XWiki.LiveTableResults##, the page that generates the JSON displayed by the LiveTable) [[now supports a ##location## extra parameter>>extensions:Extension.Livetable Macro||anchor="HParameter24options"]].
85 * [[Modified WebJars URL format>>extensions:Extension.WebJars Integration||anchor="HURLFormat"]] and added some new Script Service methods:(((
86 {{code language="none"}}
87 public String url(String webjarId, String namespace, String path, Map<String, ?> params)
88 public String url(String webjarId, String namespace, String path)
89 {{/code}}
90 )))
91
92 = Translations =
93
94 The following translations have been updated:
95
96 {{language codes="none, none"/}}
97
98 = Tested Browsers & Databases =
99
100 {{warning}}
101 The QA Tests are executed after the release has been done. Thus, they are being prepared now and will be published soon.
102 {{/warning}}
103
104 {{comment}}
105 TODO: uncomment and update with proper link when the report is ready.
106 {{include reference="TestReports.ManualTestReportTemplateSummary"/}}
107 {{/comment}}
108
109 = Performances tests compared to <last super stable version> =
110
111 <a summary of the comparison with latest super stable version>
112
113 More details on <link to the test report>.
114
115 = Known issues =
116
117 * [[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]]
118
119 = Backward Compatibility and Migration Notes =
120
121 == General Notes ==
122
123 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.
124
125 == Issues specific to XWiki XWiki 8.1 Milestone 2 ==
126
127 * The WebJars URL format has been modified to support relative WebJars URL in subwikis. The new format is {{code language="none"}}/webjars/<namespace>/<path/to/resource>?...{{/code}}. Reminder: you should not use this format directly and instead you should use the Script Service to generate a valid WebJars URL; this isolate you from any URL change. Example from Velocity: {{code language="none"}}$services.webjars.url(...){{/code}}.
128
129 == API Breakages ==
130
131 The following APIs were modified since XWiki 8.0:
132
133 {{backwardCompatiblityReport version="master"/}}

Get Connected