Version 18.1 by Vincent Massol on 2015/01/10

Hide last authors
Guillaume Delhumeau 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 <version - 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 == <feature N> ==
14
15 <description of feature N>
16
Vincent Massol 5.1 17 == Mail Sender API Improvements ==
Guillaume Delhumeau 1.1 18
Vincent Massol 4.3 19 * You can now specify the delay to wait between each mail being sent, in milliseconds. This is done to support mail throttling and not be considered a spammer by mail servers. For example if you wish to wait 10 seconds (if not specified the default is 8 seconds, which is 450 mails per hour), set the following in your ##xwiki.properties##:(((
Vincent Massol 4.1 20 {{code language="none"}}
21 mail.sender.sendWaitTime = 10000
22 {{/code}}
Vincent Massol 10.1 23
Vincent Massol 13.2 24 The configuration parameter can also be changed from the [[Mail Admin UI>>extensions:Extension.Mail Application]]:
Vincent Massol 10.1 25
26 {{image reference="sendmailwait.png"/}}
Vincent Massol 4.1 27 )))
Vincent Massol 10.1 28 * We now save both an error summary and a full error description when a mail fails to be sent when using the Database Mail Listener. This allows to see the full stack trace of the problem to more easily debug it.(((
29 {{image reference="sendmailerror.png"/}}
30 )))
Vincent Massol 13.2 31 * The Mail Type is now displayed in the [[Mail Sender Status Admin UI>>extensions:Extension.Mail Application]]:(((
Vincent Massol 13.1 32 {{image reference="mailtype.png"/}}
33 )))
Vincent Massol 5.1 34 * The ##MailResult.isSent()## API has been renamed to ##MailResult.isProcessed()## to avoid thinking that it'll return true if all mails have been sent successfully. What it does is simply return true when all mails have been processed, whether they've been sent successfully or not.
Vincent Massol 13.1 35 * A new scripting API has been added to set the mail type:(((
36 {{code language="none"}}
37 $message.setType("Some type")
38 {{/code}}
39 )))
Vincent Massol 15.1 40 * In the [[Mail Sender Status Admin UI>>extensions:Extension.Mail Application]] we now only display mails sent by the current wiki unless we're on the main wiki.
Vincent Massol 17.1 41 * The [[Mail Application>>extensions:Extension.Mail Application]] doesn't require Programming Rights for installation anymore.
Vincent Massol 18.1 42 * Account Validation email results are now saved and visible in the [[Mail Application>>extensions:Extension.Mail Application]].
Guillaume Delhumeau 1.1 43
Guillaume Delhumeau 8.1 44 == Wikis ==
45
46 * A "Wikis" category has been created in the administration, where the configuration have been moved and split in different sections:(((
47 |=Left menu|=Right menu
48 |{{image reference="AdminWikis.png"/}}|{{image reference="AdminWikis2.png"/}}
49 )))
50
Eduard Moraru 15.2 51 == Extension Manager incompatible exceptions ==
52
Eduard Moraru 16.2 53 When trying to install an incompatible extension (i.e. you are running XWiki 6.2.4 and want to install FAQ Application 6.3), you are now displayed a proper error instead of having to read through the install log to understand what went wrong, and you are instructed to use the ##Description > Stable Versions## section to manually (for now) find a compatible version of the extension that you want to install.
Eduard Moraru 15.2 54
55 {{image reference="incompatibleExtensionError.png"/}}
56
Vincent Massol 5.1 57 == Miscellaneous ==
58
59 * A click to the Document Index does not leads to an other space anymore.
60
Guillaume Delhumeau 1.1 61 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.
62
63 = For Developers =
64
65 == <developer feature N> ==
66
67 <description of developer feature N>
68
69 == Deprecated and Retired projects ==
70
71 <description of deprecated and retired projects>
72
73 == Upgrades ==
74
75 The following dependencies have been upgraded:
76
77 * <list libraries that have been upgraded>
78
79 == Miscellaneous ==
80
Guillaume Delhumeau 3.1 81 * You can now control in which order the sections added via the [[ConfigurableClass>>extensions:Extension.Administration Application||anchor="HFieldsyoucandefine"]] are displayed in the administration.
Thomas Mortagne 9.1 82 * New APIs to generate unescaped display user name:
83 ** ##com.xpn.xwiki.XWiki#getPlainUserName(DocumentReference userReference, XWikiContext context)##
84 ** ##com.xpn.xwiki.XWiki#getUserName(DocumentReference userReference, String format, boolean link, boolean escapeXML, XWikiContext context)##
85 ** ##com.xpn.xwiki.api.#getPlainUserName(DocumentReference userReference)##
86 * New script oriented APIs to get document author/contentAuthor/creator as ##DocumentReference##
Guillaume Delhumeau 3.1 87
Guillaume Delhumeau 1.1 88 = Translations =
89
90 The following translations have been updated:
91
92 {{language codes="none, none"/}}
93
94 = Tested Browsers & Databases =
95
96 {{include reference="TestReports.ManualTestReportTemplateSummary"/}}
97
98 = Performances tests compared to <last super stable version> =
99
100 <a summary of the comparison with latest super stable version>
101
102 More details on <link to the test report>.
103
104 = Known issues =
105
106 * [[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]]
107
108 = Backward Compatibility and Migration Notes =
109
110 == General Notes ==
111
112 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.
113
114 == Issues specific to XWiki <version> ==
115
116 <issues specific to the project>
117
118 == API Breakages ==
119
120 The following APIs were modified since <project> <version - 1>:
121
122 {{code language="none"}}
123 <clirr output here>
124 {{/code}}

Get Connected