Version 18.1 by Vincent Massol on 2013/10/16

Hide last authors
Thomas Mortagne 1.1 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 5.2) =
10
11 [[Full list of issues fixed and Dashboard for 5.3>>http://jira.xwiki.org/secure/Dashboard.jspa?selectPageId=11698]].
12
13 == <feature N> ==
14
15 <description of feature N>
16
17 == Miscellaneous ==
18
Vincent Massol 18.1 19 * Some XSS fixes.
20 * By default only results from XE instance pings and for non-snapshot versions are counted in Active Installs.
Thomas Mortagne 1.1 21
22 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%2C+XEM%29+and+status+%3D+Closed+and+resolution+%3D+Fixed+and+fixVersion+%3D+%22<version>%22&tempMax=1000]] fixed in this release.
23
24 = For Developers =
25
Thomas Mortagne 7.1 26 == DocumentReference Locale now taken into account in XWiki#exists and XWiki#getDocument ==
Thomas Mortagne 1.1 27
Vincent Massol 9.1 28 You can now use ##XWiki#exist## method to check for some translation existence too, before that the only way was to either load the XWikiDocument or write your own XWQL or HQL query.
Thomas Mortagne 1.1 29
Vincent Massol 9.1 30 ##XWiki#getDocument## has been modified accordingly too to be consistent so you don't need to go through ##XWikiDocument#getTranslatedDocument## anymore.
Thomas Mortagne 7.1 31
32 It also mean that you need to be careful of what Locale is in the DocumentReference with those APIs now.
33
Thomas Mortagne 15.1 34 == New Extension Manager APIs
35
36 === Extension sub script services
37
38 The ##extension## service now expose an extension point for extension related script service so that it's used as entry point for all of them.
39
40 By default the following are provided:
41 * $services.extension.core (for core extensions APIs)
42 * $services.extension.local (for local extensions APIs)
43 * $services.extension.installed (for installed extensions APIs)
44 * $services.extension.xar (for XAR extension APIS)
45
Thomas Mortagne 16.1 46 === Search for installed extension in a specific namespace
47
48 The following method has been added ##org.xwiki.extension.repository.InstalledExtensionRepository##:
49
50 {{code language="java"}}
51 /**
52 * Search installed extensions based of the provided pattern and only in the passed namespace.
53 * <p>
54 * The pattern is a simple character chain.
55 *
56 * @param pattern the pattern to search
57 * @param namespace the namespace where to search
58 * @param offset the offset from where to start returning search results
59 * @param nb the maximum number of search results to return
60 * @return the found extensions descriptors, empty list if nothing could be found
61 * @throws SearchException error when trying to search provided pattern
62 * @since 5.3M1
63 */
Thomas Mortagne 17.1 64 IterableResult<Extension> searchInstalledExtensions(String pattern, String namespace, int offset, int nb) throws SearchException;
Thomas Mortagne 16.1 65 {{/code}}
66
Vincent Massol 9.1 67 == XWiki Enterprise Archetype ==
68
69 A new archetype is now available to easily create your own product based on XWiki Enterprise. To use:
70
71 {{code}}
72 mvn archetype:generate \
73 -DarchetypeArtifactId=xwiki-enterprise-archetype \
74 -DarchetypeGroupId=org.xwiki.enterprise \
75 -DarchetypeVersion=5.3-milestone-1
76 {{/code}}
77
Vincent Massol 10.1 78 == XAR plugin improvements ==
79
80 The XAR plugin now provides the ability to change values in the XML pages. For example:
81
82 {{code}}
83 <plugin>
84 <groupId>org.xwiki.commons</groupId>
85 <artifactId>xwiki-commons-tool-xar-plugin</artifactId>
86 <configuration>
87 <transformations>
88 <transformation>
89 <file>Blog/WebHome.xml</file>
90 <xpath>/xwikidoc/object/property/itemsPerPage</xpath>
91 <value>100</value>
92 </transformation>
93 <transformation>
94 <artifact>org.xwiki.platform:xwiki-platform-administration-ui</artifact>
95 <file>XWiki/XWikiPreferences.xml</file>
96 <xpath>/xwikidoc/object/property/colorTheme</xpath>
97 <value>ColorThemes.Mint</value>
98 </transformation>
99 </transformations>
100 </configuration>
101 </plugin>
102 {{/code}}
103
Vincent Massol 11.1 104 == Miscellaneous ==
105
106 * [[Script Services implementations have been moved outside of the ##internal## package>>dev:Community.JavaCodeStyle||anchor="HPackagenames"]] in order for CLIRR to check them for backward incompatibilities and so that their API are made available in generated Javadoc.
107
Thomas Mortagne 1.1 108 == Deprecated and Retired projects ==
109
110 <description of deprecated and retired projects>
111
112 == Upgrades ==
113
114 The following dependencies have been upgraded:
115
116 * [[commons-fileupload 1.3>>http://jira.xwiki.org/browse/XCOMMONS-458]]
Thomas Mortagne 2.1 117 * [[cssparser 0.9.10>>http://jira.xwiki.org/browse/XCOMMONS-459]]
Thomas Mortagne 3.1 118 * [[XStream 1.4.5>>http://jira.xwiki.org/browse/XCOMMONS-462]]
Thomas Mortagne 13.1 119 * [[HttpClient 4.3>>http://jira.xwiki.org/browse/XCOMMONS-460]]
Thomas Mortagne 14.1 120 * [[Bean Validation 1.1>>http://jira.xwiki.org/browse/XCOMMONS-461]] (and [[Hibernate Validator 5.0.1>>http://jira.xwiki.org/browse/XWIKI-9548]])
Thomas Mortagne 1.1 121
122 = Translations =
123
124 The following translations have been updated:
125
126 {{language codes="none, none"/}}
127
128 = Tested Browsers & Databases =
129
130 {{include reference="TestReports.ManualTestReportTemplateSummary"/}}
131
132 = Known issues =
133
134 * [[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]]
135
136 = Backward Compatibility and Migration Notes =
137
138 == General Notes ==
139
140 You may also want to [[import the default wiki XAR>>Main.Download]] in order to benefit from all the improvements listed above.
141
142 {{warning}}
143 Always make sure you compare your ##xwiki.cfg## and ##xwiki.properties## files with the newest version since some configuration parameters were 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.
144 {{/warning}}
145
146 == Issues specific to XWiki <version> ==
147
148 <issues specific to the project>
149
150 == API Breakages ==
151
152 The following APIs were modified since <project> <version - 1>:
153
154 {{code language="none"}}
155 <clirr output here>
156 {{/code}}

Get Connected