Wiki source code of Release Notes for XWiki 14.1

Last modified by Ilie Andriuta on 2022/03/01

Show last authors
1 {{velocity}}
2 #set ($rnObject = $doc.getObject('ReleaseNotes.Code.ReleaseNoteClass'))
3 #set ($product = $rnObject.product)
4 #set ($version = $rnObject.version)
5 #set ($versionPrefix = $stringtool.substringBefore($version, '-'))
6 #set ($versionParts = $stringtool.split($versionPrefix, '.'))
7 #set ($isRC = $version.contains('rc'))
8 #set ($isFinal = !$isRC)
9 #set ($isFirstFinal = $versionParts.size() == 2 && $isFinal)
10 {{/velocity}}
11
12 {{box cssClass="floatinginfobox" title="**Contents**"}}
13 {{toc/}}
14 {{/box}}
15
16 This is the release notes for [[XWiki Commons>>http://commons.xwiki.org]], [[XWiki Rendering>>http://rendering.xwiki.org]] and [[XWiki Platform>>http://platform.xwiki.org]]. They share the same release notes as they are released together and have the same version.
17
18 This release adds support for displaying images from the page content in a lightbox and extends the image syntax to support image captions. The latter requires HTML5, so we added support for HTML5 in various places, such as the HTML Macro, WYSIWYG Editor, rendered diff. For developers, we introduce a new API to perform asynchronous document static analysis, which is currently used to collect mentions from page content or comments, and will be soon used to collect backlinks. Another notable change is the jQuery upgrade, which comes with some API breakages, so please make sure you read the migration notes.
19
20 {{error}}
21 The following regressions were introduced in this release (and found after it was released). Please check them out and if they impact you we recommend waiting to upgrade to a version where they are fixed.
22
23 {{velocity}}
24 #if ($isFirstFinal)
25 #set ($affectedVersions = "${version}-rc-1, ${version}")
26 #set ($fixVersionJQL = " and (fixVersion != ${version}-rc-1 or fixVersion is empty)")
27 #else
28 #set ($affectedVersions = "${version}")
29 #set ($fixVersionJQL = "")
30 #end
31 {{jira id="xwikiorg" source="jql"}}
32 category = 10000 and affectedVersion in ($affectedVersions)${fixVersionJQL}and priority = Blocker and resolution in (Fixed, Unresolved)
33 {{/jira}}
34 {{/velocity}}
35 {{/error}}
36
37 = New and Noteworthy (since {{velocity}}$product{{/velocity}} 14.0) =
38
39 [[Full list of issues fixed and Dashboard for 14.1>>https://jira.xwiki.org/secure/Dashboard.jspa?selectPageId=14914]].
40
41 {{releasenotechanges/}}
42
43 === Upgrades ===
44
45 The following runtime dependencies have been upgraded (they have a different release cycle than [[XWiki Commons>>http://commons.xwiki.org]], [[XWiki Rendering>>http://rendering.xwiki.org]] and [[XWiki Platform>>http://platform.xwiki.org]]):
46
47 * [[Apache Xerces 2.12.2>>https://jira.xwiki.org/browse/XCOMMONS-2360]]
48 * [[Apache XML Graphics Commons 2.7>>https://jira.xwiki.org/browse/XWIKI-19374]]
49 * [[Checker Qual 3.21.2>>https://jira.xwiki.org/browse/XCOMMONS-2368]]
50 * [[CKEditor Integration 1.60.1>>https://jira.xwiki.org/browse/XWIKI-19416]]
51 * [[Closure Compiler v20220202>>https://jira.xwiki.org/browse/XCOMMONS-2372]]
52 * [[Error Prone annotations 2.11.0>>https://jira.xwiki.org/browse/XCOMMONS-2357]]
53 * [[Hibernate 5.6.5>>https://jira.xwiki.org/browse/XWIKI-19371]]
54 * [[HSQLDB 2.6.1>>https://jira.xwiki.org/browse/XWIKI-18549]]
55 * [[Infinispan 13.0.6.Final>>https://jira.xwiki.org/browse/XCOMMONS-2364]]
56 * [[JAXB Runtime 2.3.6>>https://jira.xwiki.org/browse/XCOMMONS-2363]]
57 * [[jQuery 3.6.0>>https://jira.xwiki.org/browse/XWIKI-14928]]
58 * [[lessjs 4.1.2>>https://jira.xwiki.org/browse/XWIKI-15111]]
59 * [[Liquibase 4.7.1>>https://jira.xwiki.org/browse/XWIKI-19373]]
60 * [[MariaDB connector 3.0.3>>https://jira.xwiki.org/browse/XWIKI-19372]]
61 * [[Netty 4.1.74.Final>>https://jira.xwiki.org/browse/XWIKI-19403]]
62 * [[node 16.3.2>>https://jira.xwiki.org/browse/XWIKI-19395]]
63 * [[PostgresSQL connector 42.3.2>>https://jira.xwiki.org/browse/XWIKI-19392]]
64 * [[Protobuf Java 3.19.4>>https://jira.xwiki.org/browse/XCOMMONS-2362]]
65 * [[SLF4J 1.7.36>>https://jira.xwiki.org/browse/XCOMMONS-2359]]
66 * [[Tika 2.3.0>>https://jira.xwiki.org/browse/XWIKI-19402]]
67 * [[Tour Application 1.3.4>>https://jira.xwiki.org/browse/XWIKI-19414]]
68 * [[@vue/cli-service 4.5.15>>https://jira.xwiki.org/browse/XWIKI-19242]]
69
70 = Translations =
71
72 The following translations have been updated:
73
74 {{language codes="de, fr, no, ru"/}}
75
76 = Tested Browsers & Databases =
77
78 {{include reference="TestReports.ManualTestReportSummaryXWiki141.WebHome"/}}
79
80 {{comment}}
81 TODO: uncomment and update with proper links when the report is ready.
82
83 = Performances tests compared to <last super stable version> =
84
85 {{display reference="test:Performances.Jetty HSQLDB single wiki xxx to yyy" section="HSummary"/}}
86
87 More details on [[performance comparison on single wiki between x.x and y.y>>test:Performances.Jetty HSQLDB single wiki xxx to yyy]].
88 {{/comment}}
89
90 = Known issues =
91
92 * [[Bugs we know about>>https://jira.xwiki.org/issues/?jql=category%20%3D%2010000%20AND%20issuetype%20%3D%20Bug%20AND%20resolution%20%3D%20Unresolved%20ORDER%20BY%20updated%20DESC]]
93
94 = Backward Compatibility and Migration Notes =
95
96 == General Notes ==
97
98 * When upgrading make sure you compare and merge the following XWiki configuration files since some parameters may have been modified, removed or added:
99 ** ##xwiki.cfg##
100 ** ##xwiki.properties##
101 ** ##web.xml##
102 ** ##hibernate.cfg.xml##
103 * Add ##xwiki.store.migration=1## in ##xwiki.cfg## so that XWiki will attempt to automatically migrate your current database to any new schema. Make sure you backup your Database before doing anything.
104
105 == Issues specific to {{velocity}}$product $version{{/velocity}} ==
106
107 === Mentions ===
108
109 The underlying implementation of the [[doc:extensions:Extension.Mentions Application.WebHome]], [[H2 MVStore>>url:https://www.h2database.com/html/mvstore.html]] is now replaced by the newly introduced [[Asynchronous document static analysis>>||anchor="HAsynchronousdocumentstaticanalysis"]] module. When upgrading to 14.1RC1+ the H2 MVStore files are not used anymore.
110
111 {{warning}}
112 Consequently, any updated document queued for upgrade when the server is stopped will be discarded, and some users will not be notified of their mentions.
113 Please make sure that the queue size is at zero before upgrading (see [[JMX>>doc:extensions:Extension.Mentions Application.WebHome||anchor="HJMX"]]).
114 {{/warning}}
115
116 === WYSIWYG API ===
117
118 The [[WYSIWYG editor script service>>doc:extensions:Extension.WYSIWYG Editor Module.WebHome]] has been changed to parse and render HTML 5 instead of XHTML 1.0. The actual changes should be subtle in most cases and all HTML code that has been previously parsed should still be parsed but the new caption support (see above) requires that the WYSIWYG editor preserves ##<figure>## and ##<figcaption>##-tags. Further, as the ##<tt>## HTML tag is [[obsolete>>https://html.spec.whatwg.org/multipage/obsolete.html#tt]] in HTML 5, it is replaced by a ##<span class="monospace">## which is equivalent to the HTML output in view mode. WYSIWYG editors can detect the new version through the presence of the new method ##getHTMLSyntax()## that currently returns the [[Annotated HTML 5>>rendering:Syntax.HTMLVariants.WebHome||anchor="HAnnotatedHTML5"]] syntax. The bundled [[CKEditor integration>>doc:extensions:Extension.CKEditor Integration.WebHome]] has been adapted for this change.
119
120 === Prototype.js and Scriptaculous loaded from WebJars ===
121
122 The following JavaScript files were removed from the XWiki WAR and are now loaded from their WebJars:
123
124 * ##js/prototype/prototype.js##
125 * ##js/scriptaculous/effects.js##
126 * ##js/scriptaculous/dragdrop.js##
127
128 ##prototype.js## was loaded by default on every page and it still is so there's no reason to worry about it. On the other hand, ##effects.js## and ##dragdrop.js## weren't loaded by default so if you have code that loads them from the skin, using for instance:
129
130 {{code language="none"}}
131 $xwiki.jsfx.use('js/scriptaculous/effects.js')
132 $xwiki.jsfx.use('js/scriptaculous/dragdrop.js')
133 {{/code}}
134
135 then you need to update it to load them using RequireJS, such as:
136
137 {{code language="js"}}
138 require(['scriptaculous/dragdrop'], function() {
139 // Do your thing.
140 });
141 {{/code}}
142
143 See this [[commit>>https://github.com/xwiki/xwiki-platform/commit/0775036399624a3d42e6d3f03a56aebc9d6c6464]] for a migration example.
144
145 === jQuery 3.6.0 upgrade ===
146
147 jQuery has been upgraded from 2.2.4 to 3.6.0 and the new version comes with a couple of API breakages. We recommend reviewing the [[jQuery upgrade guide>>https://jquery.com/upgrade-guide/]] for versions 3.0 and 3.5. Existing code should not be broken during the 14.x XWiki cycle because we are going to load the jQuery migrator plugin which ensures backward compatibility. Nevertheless we recommend refactoring your JavaScript code to use the latest jQuery APIs as soon as possible, to ensure it will continue to work after we stop loading the jQuery migrator plugin.
148
149 === less.js 4.1.2 upgrade ===
150
151 Less.js has been upgraded from 2.5.3 to 4.1.2 and the new version comes with some breaking changes. First of all, you should know that ##less.js## is currently used only for color theme **preview** in the color theme editor, so this upgrade has no effect on how the color theme is applied when accessing your wiki. Then, the color theme preview may be broken only if you customized the color theme using the Advanced section (##@lessCode##). Check the [[change log>>https://github.com/less/less.js/blob/master/CHANGELOG.md]] to see what has been changed between version 2.5.3 and 4.1.2. The most important breaking change we noticed is related to [[Math operations>>https://lesscss.org/usage/#less-options-math]]: by default no division is performed outside of parens using ##/## (slash) operator. This means you need to check your ##@lessCode## text area for division operations and wrap them with parentheses. Don't worry, the preview window should show the Less compilation error pointing you to the line you need to fix.
152
153 == API Breakages ==
154
155 The following APIs were modified since {{velocity}}$product{{/velocity}} 14.0:
156
157 {{velocity}}
158 {{backwardCompatibilityReport134 version="$version"/}}
159 {{/velocity}}
160
161 = Credits =
162
163 The following people have contributed code and translations to this release (sorted alphabetically):
164
165 * Eduard Moraru
166 * Gankov Andrey
167 * Jarle Sandmo
168 * Manuel Leduc
169 * Marius Dumitru Florea
170 * Michael Hamann
171 * Oana-Lavinia Florean
172 * Simon Urli
173 * Simpel
174 * Thomas Mortagne
175 * Vincent Massol
176 * jingkaimori
177 * slauriere
178 * u74a8 zhou
179 * xrichard

Get Connected