Wiki source code of Release Notes for XWiki 6.2

Last modified by Thomas Mortagne on 2023/10/13

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
Guillaume Delhumeau 26.1 7 {{error}}
Guillaume Delhumeau 27.1 8 We've discovered a regression in this version after it was released:
Thomas Mortagne 38.1 9 * It is impossible to change the logo in the new Flamingo Theme Application ([[XWIKI-11081>>https://jira.xwiki.org/browse/XWIKI-11081]]).
Guillaume Delhumeau 26.1 10
Guillaume Delhumeau 31.1 11 It is fixed in the [[6.2.1 version>>ReleaseNotes.ReleaseNotesXWiki621]].
Guillaume Delhumeau 26.1 12 {{/error}}
13
Eduard Moraru 25.3 14 This release is mainly focused on the Flamingo skin and it being now used by default, but also features improvements for applications such as AWM and Blog and various performance improvements. Developers can benefit from new APIs such as the new Mail Sender API and the new Blame API but also from improved APIs such as the wiki module API and JS widgets.
Guillaume Delhumeau 1.1 15
Eduard Moraru 10.4 16 = New and Noteworthy (since XWiki 6.1) =
Guillaume Delhumeau 1.1 17
Thomas Mortagne 38.1 18 [[Full list of issues fixed and Dashboard for 6.2>>https://jira.xwiki.org/secure/Dashboard.jspa?selectPageId=12494]].
Guillaume Delhumeau 1.1 19
Guillaume Delhumeau 2.1 20 == Flamingo ==
Guillaume Delhumeau 1.1 21
Eduard Moraru 25.2 22 * **[[Flamingo>>extensions:Extension.Flamingo Skin]] is the new default skin in XWiki!**
23 * The [[applications panel>>extensions:Extension.Panels Application||anchor="HApplicationPanel"]] (also known as the "Applications Bar") has been set by default on the left panel.
24 * The default icon theme is now [[Font Awesome>>extensions:Extension.Font Awesome Icon Theme]].
25 * A new application has been made to manage color themes on Flamingo. It does not only permit to change colors anymore, but also the typography, etc... That is why it is called [[extensions:Extension.Flamingo Theme Application]].
26 {{image reference="FlamingoThemeEditor.png" width="50%"/}}
27 * By default, a new theme is enabled: ##FlamingoDefaultTheme##, made with the new application described above.
28 * [[extensions:Extension.Colibri Skin]] can use the themes from Flamingo thanks to a mapping between [[extensions:Extension.Flamingo Theme Application]] and [[extensions:Extension.Color Theme Application]]. The results may not be perfect though.
29 * Improved Login form(((
30 {{image reference="flamingoLogin.png"/}}
31 )))
Thomas Mortagne 34.1 32 * The page headers from Colibri ColorThemes can be displayed for Flamingo skin by setting the ##$displayPageHeader## to ##true## in ##layoutExtraVars.vm##. By default this variable is set to false(((
Eduard Moraru 25.2 33 [[{{image reference="Flamingo_displayPageHeader_false.png" width="400px"/}}>>attach:Flamingo_displayPageHeader_false.png]] [[{{image reference="Flamingo_displayPageHeader_true.png" width="400px"/}}>>attach:Flamingo_displayPageHeader_true.png]]
34 )))
35 * You can control whether or not you want to display the create and the "more actions" menus with 2 new variables: ##$displayCreateMenu## and ##$displayMoreActionsMenu##. You can manually set them in the ##layoutExtraVars.vm## file.(((
Guillaume Delhumeau 2.1 36 * The textarea now use a monospace font.
Eduard Moraru 10.5 37 * The user profile looks better on smartphones:(((
38 {{image reference="flamingo-user-profile.png" width="12%"/}}
39 )))
40
Eduard Moraru 25.2 41 You can see the results of all this changes in the following screenshot:
42 {{image reference="flamingo.png" width="65%"/}}
43 )))
Eduard Moraru 10.5 44
45 == Icon Theme Application ==
46
47 A new application is now bundled in XWiki: [[extensions:Extension.Icon Theme Application]]. Its purpose is to let the user chose which icon set she would like to have in her wiki.
48
49 {{image reference="iconset-administration.png"/}}
50
51 This application is compatible with icon stored as images but also with font icons such as [[FontAwesome>>http://fortawesome.github.io/Font-Awesome/]]!
52
53 == Font Awesome ==
54
55 [[Font Awesome>>extensions:Extension.Font Awesome Icon Theme]] is our first alternative to [[silk>>http://www.famfamfam.com/lab/icons/silk/]] as an Icon Theme. It is now bundled in XWiki, but the Icon Theme mapping is still at a beta state.
56
Eduard Moraru 25.2 57 == Initialization screen improvements ==
58
59 If XWiki initialization failed you get a detailed log and it stop refreshing the page.
60
61 {{image reference="init_errors.png"/}}
62
Eduard Moraru 10.5 63 == Application Bar ==
64
65 * The icons are now bigger.
66 * The icons displayed in the application bar use the new Icon Theme Application, in order to let the user choose the icon set she wants to see:
67 \\{{image reference="appbar-with-fontawesome.png" width="40%"/}} {{image reference="appbar-with-silk.png" width="40%"/}}
68 * On devices with small screen, when panels are displayed under the page content (currently, it is the case for Flamingo only), the appbar is now displayed differently to use all the available width:
69 \\{{image reference="AppBarLowRes.png"/}}
70
71 == Blog Application ==
72
73 The blog panels are now displayed on the right column by default, to fit Flamingo:
74
75 (((
76 {{image reference="flamingo-blog.png" width="60%"/}}
77 )))
78
Eduard Moraru 25.2 79 == New structure for apps created with App Within Minutes ==
80
81 When you create a new application using AWM, your application will be structured into 2 spaces (one for data and the other for code). For more details, see [[AWM's documentation>>extensions:Extension.App Within Minutes Application||anchor="HApplicationStructure"]].
82
83 {{image reference="AppWithinMinutes-Step1.png"/}}
84
Guillaume Delhumeau 1.1 85 == Miscellaneous ==
86
Vincent Massol 6.1 87 * The RTF export is now only supported when an Office Server is connected to XWiki (we used to default to using FOP when no Office Server is connected but the quality of the export was too low to consider this a viable solution).
Vincent Massol 5.1 88 * When using the Standalone distribution, the format has changed when passing parameters. The shell used has also been changed from ##sh## to ##bash## The new format is:(((
Vincent Massol 4.1 89 start_xwiki.sh:
90
91 {{code language="none"}}
92 # ----------------------------------------------------------------------------------------------------------------
93 # Optional ENV vars
94 # -----------------
95 # XWIKI_OPTS - parameters passed to the Java VM when running XWiki e.g. to increase the memory allocated to the
96 # JVM to 1GB, use set XWIKI_OPTS=-Xmx1024m
97 # JETTY_PORT - the port on which to start Jetty.
98 # JETTY_STOP_PORT - the port on which Jetty listens for a Stop command.
99 #
100 # Optional Parameters
101 # -------------------
102 # -p, --port: The Jetty HTTP port to use. Overrides any value from JETTY_PORT. Defaults to 8080.
103 # -sp, --stopport: The Jetty stop port to use. Overrides any value from JETTY_STOP_PORT. Defaults to 8079.
104 # -ld, --lockdir: The directory where the executing process id is stored to verify that that only one instance is
105 # started. Defaults to /var/tmp.
106 # -k, --kill: If set then kills any already executing XWiki instance before starting a new one.
107 #
108 # Example
109 # -------
110 # start_xwiki.sh -p 8080 -sp 8079 -k
111 # ----------------------------------------------------------------------------------------------------------------
112 {{/code}}
113
114 start_xwiki_debug.sh:
115
116 {{code language="none"}}
117 # ----------------------------------------------------------------------------------------------------------------
118 # Optional ENV vars
119 # -----------------
120 # XWIKI_OPTS - parameters passed to the Java VM when running XWiki e.g. to increase the memory allocated to the
121 # JVM to 1GB, use set XWIKI_OPTS=-Xmx1024m
122 # JETTY_PORT - the port on which to start Jetty.
123 # JETTY_STOP_PORT - the port on which Jetty listens for a Stop command.
124 #
125 # Optional Parameters
126 # -------------------
127 # -p, --port: The Jetty HTTP port to use. Overrides any value from JETTY_PORT. Defaults to 8080.
128 # -sp, --stopport: The Jetty stop port to use. Overrides any value from JETTY_STOP_PORT. Defaults to 8079.
129 # -ld, --lockdir: The directory where the executing process id is stored to verify that that only one instance is
130 # started. Defaults to /var/tmp.
131 # -k, --kill: If set then kills any already executing XWiki instance before starting a new one.
132 # -yp, --yourkitpath: The path where Yourkit can find the agent. If not passed then YourKit won't be enabled.
133 # For example: "/Applications/YourKit Java Profiler 7.0.11.app/bin/mac"
134 # or "/home/User/yjp-11.0.8/bin/linux-x86-64/"
135 #
136 # Example
137 # -------
138 # start_xwiki_debug.sh -yp "/Applications/YourKit Java Profiler 7.0.11.app/bin/mac"
139 # ----------------------------------------------------------------------------------------------------------------
140 {{/code}}
141
142 stop_xwiki.sh:
143
144 {{code language="none"}}
145 # ----------------------------------------------------------------------------------------------------------------
146 # Optional ENV vars
147 # -----------------
148 # XWIKI_OPTS - parameters passed to the Java VM when running XWiki e.g. to increase the memory allocated to the
149 # JVM to 1GB, use set XWIKI_OPTS=-Xmx1024m
150 # JETTY_STOP_PORT - the port on which Jetty listens for a Stop command.
151 #
152 # Optional Parameters
153 # -------------------
154 # -p, --port: The Jetty HTTP port that was used to start XWiki. Defaults to 8080.
155 # -sp, --stopport: The Jetty stop port to use. Overrides any value from JETTY_STOP_PORT. Defaults to 8079.
156 # -ld, --lockdir: The directory where the executing process id is stored to verify that that only one instance is
157 # started. Defaults to /var/tmp.
158 #
159 # Example
160 # -------
161 # stop_xwiki.sh -sp 8079
162 # ----------------------------------------------------------------------------------------------------------------
163 {{/code}}
164 )))
Eduard Moraru 10.5 165 * When using the standalone package, the logs can also be found in files under ##data/logs/##.
166 * The jetty configuration is now split in several files, making it easier to configure the needed parts.
167 * There's a sample configuration file for enabling HTTPS for the standalone Jetty server.
168 * The port on which Jetty listens for request can be configured using the ##JETTY_PORT## environment variables; ##JETTY_STOP_PORT## can be used to configure the port where stop commands are expected.
169 * Jetty's messages are now more informative: internal information isn't displayed, while notifications for the users are printed both at startup and shutdown.
170 * Single line fields in documents are not merged at character level anymore. This might increase a bit the number of potential conflicts but at the same time improve the suggestion in most cases in case of real conflict since most of the time this kind of field cannot really be merged.
171 * The XWiki Snapshots maven extensions repository is now used by default (when no other repositories are configured) on snapshot/development builds of XWiki Enterprise in order to make the testing of snapshot builds easier and faster.
172 * ModalPopup and LightBox resource components are now responsive. For small resolutions their width will occupy the whole screen.(((
173 {{image reference="afterAddUsers.png"/}} {{image reference="afterSharebyEmail.png"/}}
174 )))
Thomas Mortagne 38.1 175 * Deleted document translations can now be restored, even if the main document or a different translation has already been restored (as long as no conflict exists). See [[XWIKI-9567>>https://jira.xwiki.org/browse/XWIKI-9567]] and the [[documentation>>extensions:Extension.Index Application||anchor="HRestoringatranslation"]].
Eduard Moraru 10.5 176 * The [[Font Awesome Icon Theme>>extensions:Extension.Font Awesome Icon Theme]] has been improved with 50 new icons.
177 * In Flamingo, the form of the login page has been changed to navigate easily using the keyboard.
178 * Annotations initialization speedup
179 * Wiki macros initialization speedup
Vincent Massol 4.1 180
Thomas Mortagne 38.1 181 See the [[full list of JIRA issues>>https://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.2%22&tempMax=1000]] fixed in this release.
Guillaume Delhumeau 1.1 182
183 = For Developers =
184
Eduard Moraru 10.5 185 == Wiki module improvements ==
Guillaume Delhumeau 1.1 186
Eduard Moraru 10.5 187 * Added an API to directly get the wiki identifiers:
188 ** From Velocity:(((
189 {{code language="velocity"}}
190 #set($wikiIds = $services.wiki.allIds)
191 {{/code}}
192 )))
193 ** From Java:(((
194 {{code language="java"}}
195 Collection<String> wikiIds = wikiDescriptorManager.getAllIds();
196 {{/code}}
197 )))
Guillaume Delhumeau 1.1 198
Eduard Moraru 10.5 199 == The ##XWiki.widgets.ConfirmationBox## widget can display a //Cancel// button ==
Guillaume Delhumeau 1.1 200
Eduard Moraru 10.5 201 By passing the ##showCancelButton : true## option in the ##interactionParameters## argument to the constructor, a //Cancel// button will be displayed next to the //Yes// and //No// ones. The label of the button can be specified with the ##cancelButtonText## interaction option, and an optional callback to execute with the ##onCancel## behavior option.
Guillaume Delhumeau 1.1 202
Eduard Moraru 10.5 203 == The ##XWiki.widgets.ModalPopup#createButton## method now accepts an ##extraClass## parameter ==
204
205 The fifth parameter can be used to add additional classes, besides the standard ##button##, to the created buttons.
206
207 == WikiStream module renamed to Filter module ==
208
209 The heart of WikiStream being far more generic than wikis, most of it have been moved to commons in the already existing [[Filter module>>extensions:Extension.Filter Module]].
210
211 Most of WikiStream module moved to commons filter module (everything that wasn't really depending on any platform project) and it also been renamed to ##Filter## on platform side to follow commons naming. The structure of the API did not changed a bit except for the naming. In short every "WikiStream" in your code should be changed to ##Filter## or ##FilterStream##. None of the existing streams identifiers changed except for the generic XML streams which is is now ##filter+xml## (instead of wiki+xml).
212
213 == Mail Sender API ==
214
215 * The new [[Mail Sender API>>extensions:Extension.Action API]] is now bundled by default in XWiki Enterprise.
216 * It's now possible to access the Mail Sending API configuration from scripts by calling ##$services.mailsender.configuration##.
217 * The ##send()## API now sends messages synchronously and a new ##sendAsynchronously()## API has been added
218 * Using the following will now automatically add a template body part too:(((
219 {{code language="none"}}
220 #set ($message = $services.mailsender.createMessage('template', $templateReference, $mailParameters)
221 {{/code}}
222 )))
223 * In addition the "template" Mime Message Factory supports passing "to", "from", "cc" and "bcc" addresses in the parameters list, for example:(((
224 {{code language="none"}}
225 #set ($mailParameters = {'from' : '[email protected]', 'to' : '[email protected]', 'language' : $xcontext.language, 'velocityVariables' : { 'var1' : 'value1' }})
226 #set ($message = $services.mailsender.createMessage('template', $templateReference, $mailParameters)
227 {{/code}}
228 )))
229
230 == Building XWiki is now possible using Maven 3.1 and 3.2 ==
231
Thomas Mortagne 38.1 232 The packager Maven plugin was using temporary APIs used only in Maven 3.0, which [[made it impossible to build modules depending on that plugin with other versions of Maven than 3.0.x>>https://jira.xwiki.org/browse/XWIKI-9760]]. This has now been fixed, and the build works with any 3.x Maven version.
Eduard Moraru 10.5 233
234 == Blame generic API and Script Service ==
235
236 Provides the implementation of the blame/annotate/praise algorithm.
237
238 Like the diff module API, this API is not tied to any type so you have to first transform the datas you want to blame into lists and you will be able to link them with any kind of revision metadata. Blame will link each elements of the initial list with the revision metadata of the original revision it came from. You will have to call blame in loop with each revised list, starting from the most recent one, until all element are annotated.
239
240 See [[Blame Module>>extensions:Extension.Blame Module]] for more information.
241
Guillaume Delhumeau 1.1 242 == Upgrades ==
243
244 The following dependencies have been upgraded:
245
Thomas Mortagne 38.1 246 * [[Bootstrap 3.2.0>>https://jira.xwiki.org/browse/XWIKI-10579]]
247 * [[HTML5Shiv 3.7.2>>https://jira.xwiki.org/browse/XWIKI-10615]]
248 * [[Jetty 8.1.15>>https://jira.xwiki.org/browse/XWIKI-10653]]
249 * [[JFreechart 1.0.19>>https://jira.xwiki.org/browse/XWIKI-10689]]
250 * [[Joda-Time 2.4>>https://jira.xwiki.org/browse/XWIKI-10692]]
251 * [[xalan 2.7.2>>https://jira.xwiki.org/browse/XWIKI-10694]]
252 * [[Groovy 2.3.6>>https://jira.xwiki.org/browse/XCOMMONS-625]]
253 * [[Velocity Tools 2.0>>https://jira.xwiki.org/browse/XWIKI-5347]]
254 * [[Jython 2.7-b3>>https://jira.xwiki.org/browse/XWIKI-10837]]
255 * [[httpclient 4.3.5>>https://jira.xwiki.org/browse/XCOMMONS-631]]
256 * [[Guava 18.0>>https://jira.xwiki.org/browse/XCOMMONS-632]]
257 * [[Apache FOP 1.1>>https://jira.xwiki.org/browse/XWIKI-8351]]
258 * [[Maven 3.2.3>>https://jira.xwiki.org/browse/XCOMMONS-634]]
259 * [[JGroups 3.4.5>>https://jira.xwiki.org/browse/XWIKI-10890]]
260 * [[HTMLCleaner 2.9>>https://jira.xwiki.org/browse/XCOMMONS-635]]
261 * [[Font Awesome 4.2.0>>https://jira.xwiki.org/browse/XWIKI-10913]]
Guillaume Delhumeau 1.1 262
263 == Miscellaneous ==
264
Thomas Mortagne 39.1 265 * The ##auto## value has been added to the ##align## option of the ##[[Auto Suggest Widget>>Documentation.DevGuide.AutoSuggestWidget]]##.
266 * A new parameter ##targetQueryString## has been added to the UI Extension points [[##org.xwiki.platform.panels.Applications##>>Documentation.DevGuide.ExtensionPoint.AddApplicationUIX]] and [[##org.xwiki.platform.panels.Applications.more##>>Documentation.DevGuide.ExtensionPoint.MoreApplicationUIX]].
Thomas Mortagne 37.1 267 * New ##com.xpn.xwiki.api.Collection#getValue(String name)##. That means you can write directly ##$myobject.getValue('fieldname')## instead of ##$myobject.getProperty('fieldname').value##. Who knows, maybe we will get a bit less missuses of ## com.xpn.xwiki.api.Object#get(String name)##.
Thomas Mortagne 10.1 268 * New org.xwiki.text.StringUtils which extends org.apache.commons.lang3.StringUtils with new useful methods. See [[http://extensions.xwiki.org/xwiki/bin/view/Extension/Text+Module#HFeatures]].
Thomas Mortagne 38.1 269 * The user of an Activity Stream event is now always stored as an absolute serialized reference. See [[XWIKI-9066>>https://jira.xwiki.org/browse/XWIKI-9066]] for more details.
Eduard Moraru 10.5 270 * A new user and group references related reference resolver have been provided:(((
271 {{code language="java"}}
272 @Inject
273 @Named("user/current")
274 private DocumentReferenceResolver<String> currentUserDocumentResolver;
Guillaume Delhumeau 1.1 275
Eduard Moraru 10.5 276 @Inject
277 @Named("user/current")
278 private EntityReferenceResolver<String> currentUserEntityResolver;
279
280 @Inject
281 @Named("user")
282 private EntityReferenceResolver<String> defaultUserEntityResolver;
283 {{/code}}
284 )))
285 * Each XWiki class property can now control how it's merged. Just need to overwrite ##com.xpn.xwiki.objects.classes.PropertyClass#mergeProperty## method.
286 * The target syntax is now part of the Rendering Context when the Rendering is used to render some Blocks (otherwise it's ##null##. For example when parsing content).
287 * Added new ##org.xwiki.rendering.renderer.printer.WriterWikiPrinter## to output all calls to ##org.xwiki.rendering.renderer.printer.WikiPrinter## into a ##org.xwiki.rendering.renderer.printer.Writer##
288 * Added the new component ##org.xwiki.skinx.internal.LinkSkinExtension## (with the hint "##linkx##") that wraps the ##$xwiki.linkx## plugin
Thomas Mortagne 38.1 289 * New ##$cookietool## available for working with cookies in Velocity. See [[XCOMMONS-627>>https://jira.xwiki.org/browse/XCOMMONS-627]]
290 * New ##$doc.isTranslation()## method is available in the web API. See [[XWIKI-10805>>https://jira.xwiki.org/browse/XWIKI-10805]]
Eduard Moraru 10.5 291 * ##xwiki-platform-font-awesome## has been moved in the ##xwiki-platform-icon## module and renamed ##xwiki-platform-icon-fontawesome##.
292 * [[Icon Theme>>extensions:Extension.Icon Theme Application]] can now use JavaScript Extensions.
293 * The [[Icon class>>https://github.com/xwiki/xwiki-platform/blob/master/xwiki-platform-core/xwiki-platform-icon/xwiki-platform-icon-api/src/main/java/org/xwiki/icon/Icon.java]] of the [[Icon Theme>>extensions:Extension.Icon Theme Application]] does not store the name of the icon anymore, since it is already stored in a map in the [[IconSet class>>https://github.com/xwiki/xwiki-platform/blob/master/xwiki-platform-core/xwiki-platform-icon/xwiki-platform-icon-api/src/main/java/org/xwiki/icon/IconSet.java]] (better memory usage).
294 * It is now possible to compile a LESS file or to compute a color theme from an other skin.
295 * ##xwiki-platform-less-css## has been renamed ##xwiki-platform-lesscss## in order to be consistent with our naming conventions.
Thomas Mortagne 39.1 296 * new API to flush rendering cache. See [[Documentation.AdminGuide.Performances||anchor="HConfigurationbased"]].
Eduard Moraru 10.5 297
Guillaume Delhumeau 1.1 298 = Translations =
299
300 The following translations have been updated:
301
Eduard Moraru 10.5 302 {{language codes="da, de, fr, lv, pl, ru, sv, zh"/}}
Guillaume Delhumeau 1.1 303
304 = Tested Browsers & Databases =
305
Manuel Smeria 8.1 306 {{include reference="TestReports.ManualTestReportSummaryXWiki62"/}}
Guillaume Delhumeau 1.1 307
Thomas Mortagne 33.1 308 = Performances tests compared to 5.4.5 =
Thomas Mortagne 32.1 309
Vincent Massol 36.2 310 6.2 is generally slower than 5.4.5 except macro rendering which gets a big improvement and it uses a bit less memory. The big slow down on initialization is when compiling Flamingo less files. There's still work to do, however a lot of the losses accumulated during 6.0 and 6.1 have been regained (see some partial results on [[test:Performances.Jetty HSQLDB single wiki]]).
Thomas Mortagne 32.1 311
Thomas Mortagne 35.1 312 {{display reference="test:Performances.Jetty HSQLDB single wiki 545 to 62" section="HSummary"/}}
Thomas Mortagne 34.1 313
Thomas Mortagne 32.1 314 More details on [[performance comparison on single wiki between 6.2 and 5.4.5>>test:Performances.Jetty HSQLDB single wiki 545 to 62]].
315
Guillaume Delhumeau 1.1 316 = Known issues =
317
Thomas Mortagne 38.1 318 * [[Bugs we know about>>https://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]]
Guillaume Delhumeau 1.1 319
320 = Backward Compatibility and Migration Notes =
321
322 == General Notes ==
323
324 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.
325
326 == API Breakages ==
327
Eduard Moraru 10.3 328 The following APIs were modified since XWiki 6.1:
Guillaume Delhumeau 1.1 329
Eduard Moraru 10.3 330 * Young APIs:(((
Guillaume Delhumeau 1.1 331 {{code language="none"}}
Eduard Moraru 10.3 332 org.xwiki.rendering.transformation.RenderingContext: Method 'public org.xwiki.rendering.syntax.Syntax getTargetSyntax()' has been added to an interface
Guillaume Delhumeau 1.1 333 {{/code}}
Eduard Moraru 10.3 334
335 * Added an API for a very common use case so that we optimize it
336
337 {{code language="none"}}
338 org.xwiki.wiki.descriptor.WikiDescriptorManager: Method 'public java.util.Collection getAllIds()' has been added to an interface
339 {{/code}}
340
341 {{code language="none"}}
342 org.xwiki.mail.MailSender: Method 'public void send(javax.mail.internet.MimeMessage, javax.mail.Session, org.xwiki.mail.MailResultListener)' has been removed
343 org.xwiki.mail.MailSender: Method 'public void sendAsynchronously(javax.mail.internet.MimeMessage, javax.mail.Session, org.xwiki.mail.MailResultListener)' has been added to an interface
344 org.xwiki.mail.MailResultListener: Parameter 2 of 'public void onError(javax.mail.internet.MimeMessage, java.lang.Throwable)' has changed its type to java.lang.Exception
345 org.xwiki.mail.script.MimeMessageWrapper: Parameter 1 of 'public MimeMessageWrapper(javax.mail.internet.MimeMessage, javax.mail.Session, org.xwiki.mail.MailSender, org.xwiki.context.Execution, org.xwiki.component.manager.ComponentManager)' has changed its type to org.xwiki.mail.internal.ExtendedMimeMessage
346 org.xwiki.mail.script.MimeMessageWrapper: Return type of method 'public javax.mail.internet.MimeMessage getMessage()' has been changed to org.xwiki.mail.internal.ExtendedMimeMessage
347 {{/code}}
348 )))
349
350 * The extended class got moved to a new package with the upgrade to velocity-tools 2.0 and the old location got deprecated.(((
351 {{code language="none"}}
352 org.xwiki.velocity.XWikiWebappResourceLoader: Removed org.apache.velocity.tools.view.servlet.WebappLoader from the list of superclasses
353 {{/code}}
354 )))
355
356 * Not really APIs to begin with.(((
357 {{code language="none"}}
358 com.xpn.xwiki.doc.XWikiDocument: Removed field compactEntityReferenceSerializer
359 com.xpn.xwiki.doc.XWikiDocument: Removed field compactWikiEntityReferenceSerializer
360 com.xpn.xwiki.doc.XWikiDocument: Removed field currentDocumentReferenceResolver
361 com.xpn.xwiki.doc.XWikiDocument: Removed field currentMixedDocumentReferenceResolver
362 com.xpn.xwiki.doc.XWikiDocument: Removed field currentReferenceDocumentReferenceResolver
363 com.xpn.xwiki.doc.XWikiDocument: Removed field currentReferenceObjectReferenceResolver
364 com.xpn.xwiki.doc.XWikiDocument: Removed field defaultEntityReferenceSerializer
365 com.xpn.xwiki.doc.XWikiDocument: Removed field explicitDocumentReferenceResolver
366 com.xpn.xwiki.doc.XWikiDocument: Removed field explicitReferenceDocumentReferenceResolver
367 com.xpn.xwiki.doc.XWikiDocument: Removed field localEntityReferenceSerializer
368 com.xpn.xwiki.doc.XWikiDocument: Removed field localUidStringEntityReferenceSerializer
369 com.xpn.xwiki.doc.XWikiDocument: Removed field relativeEntityReferenceResolver
370 com.xpn.xwiki.doc.XWikiDocument: Removed field syntaxFactory
371 com.xpn.xwiki.doc.XWikiDocument: Removed field uidStringEntityReferenceSerializer
372 com.xpn.xwiki.doc.XWikiDocument: Removed field xClassEntityReferenceResolver
373 {{/code}}
374 )))
375
376 * The annotation API already needs a larger refactoring, this small fix stay in line with the existing API and does not deserve the creation of a new (temporary) API.(((
377 {{code language="none"}}
378 org.xwiki.annotation.io.IOTargetService: Method 'public org.xwiki.rendering.block.XDOM getXDOM(java.lang.String)' has been added to an interface
379 org.xwiki.annotation.io.IOTargetService: Method 'public org.xwiki.rendering.block.XDOM getXDOM(java.lang.String, java.lang.String)' has been added to an interface
380 {{/code}}
381 )))

Get Connected