Version 17.1 by Thomas Mortagne 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 12.1 19 * Some XSS fixes
Thomas Mortagne 1.1 20
21 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.
22
23 = For Developers =
24
Thomas Mortagne 7.1 25 == DocumentReference Locale now taken into account in XWiki#exists and XWiki#getDocument ==
Thomas Mortagne 1.1 26
Vincent Massol 9.1 27 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 28
Vincent Massol 9.1 29 ##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 30
31 It also mean that you need to be careful of what Locale is in the DocumentReference with those APIs now.
32
Thomas Mortagne 15.1 33 == New Extension Manager APIs
34
35 === Extension sub script services
36
37 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.
38
39 By default the following are provided:
40 * $services.extension.core (for core extensions APIs)
41 * $services.extension.local (for local extensions APIs)
42 * $services.extension.installed (for installed extensions APIs)
43 * $services.extension.xar (for XAR extension APIS)
44
Thomas Mortagne 16.1 45 === Search for installed extension in a specific namespace
46
47 The following method has been added ##org.xwiki.extension.repository.InstalledExtensionRepository##:
48
49 {{code language="java"}}
50 /**
51 * Search installed extensions based of the provided pattern and only in the passed namespace.
52 * <p>
53 * The pattern is a simple character chain.
54 *
55 * @param pattern the pattern to search
56 * @param namespace the namespace where to search
57 * @param offset the offset from where to start returning search results
58 * @param nb the maximum number of search results to return
59 * @return the found extensions descriptors, empty list if nothing could be found
60 * @throws SearchException error when trying to search provided pattern
61 * @since 5.3M1
62 */
Thomas Mortagne 17.1 63 IterableResult<Extension> searchInstalledExtensions(String pattern, String namespace, int offset, int nb) throws SearchException;
Thomas Mortagne 16.1 64 {{/code}}
65
Vincent Massol 9.1 66 == XWiki Enterprise Archetype ==
67
68 A new archetype is now available to easily create your own product based on XWiki Enterprise. To use:
69
70 {{code}}
71 mvn archetype:generate \
72 -DarchetypeArtifactId=xwiki-enterprise-archetype \
73 -DarchetypeGroupId=org.xwiki.enterprise \
74 -DarchetypeVersion=5.3-milestone-1
75 {{/code}}
76
Vincent Massol 10.1 77 == XAR plugin improvements ==
78
79 The XAR plugin now provides the ability to change values in the XML pages. For example:
80
81 {{code}}
82 <plugin>
83 <groupId>org.xwiki.commons</groupId>
84 <artifactId>xwiki-commons-tool-xar-plugin</artifactId>
85 <configuration>
86 <transformations>
87 <transformation>
88 <file>Blog/WebHome.xml</file>
89 <xpath>/xwikidoc/object/property/itemsPerPage</xpath>
90 <value>100</value>
91 </transformation>
92 <transformation>
93 <artifact>org.xwiki.platform:xwiki-platform-administration-ui</artifact>
94 <file>XWiki/XWikiPreferences.xml</file>
95 <xpath>/xwikidoc/object/property/colorTheme</xpath>
96 <value>ColorThemes.Mint</value>
97 </transformation>
98 </transformations>
99 </configuration>
100 </plugin>
101 {{/code}}
102
Vincent Massol 11.1 103 == Miscellaneous ==
104
105 * [[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.
106
Thomas Mortagne 1.1 107 == Deprecated and Retired projects ==
108
109 <description of deprecated and retired projects>
110
111 == Upgrades ==
112
113 The following dependencies have been upgraded:
114
115 * [[commons-fileupload 1.3>>http://jira.xwiki.org/browse/XCOMMONS-458]]
Thomas Mortagne 2.1 116 * [[cssparser 0.9.10>>http://jira.xwiki.org/browse/XCOMMONS-459]]
Thomas Mortagne 3.1 117 * [[XStream 1.4.5>>http://jira.xwiki.org/browse/XCOMMONS-462]]
Thomas Mortagne 13.1 118 * [[HttpClient 4.3>>http://jira.xwiki.org/browse/XCOMMONS-460]]
Thomas Mortagne 14.1 119 * [[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 120
121 = Translations =
122
123 The following translations have been updated:
124
125 {{language codes="none, none"/}}
126
127 = Tested Browsers & Databases =
128
129 {{include reference="TestReports.ManualTestReportTemplateSummary"/}}
130
131 = Known issues =
132
133 * [[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]]
134
135 = Backward Compatibility and Migration Notes =
136
137 == General Notes ==
138
139 You may also want to [[import the default wiki XAR>>Main.Download]] in order to benefit from all the improvements listed above.
140
141 {{warning}}
142 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.
143 {{/warning}}
144
145 == Issues specific to XWiki <version> ==
146
147 <issues specific to the project>
148
149 == API Breakages ==
150
151 The following APIs were modified since <project> <version - 1>:
152
153 {{code language="none"}}
154 <clirr output here>
155 {{/code}}

Get Connected