Wiki source code of Release Notes for XWiki 6.3-rc-1
Last modified by Thomas Mortagne on 2023/10/13
Show last authors
author | version | line-number | content |
---|---|---|---|
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 | This release comes with 16 new Flamingo themes adapted from Bootswatch and a new application to manage them. The document index tree and the Navigation panel have been greatly improved by using a new tree widget which is exposed as a wiki macro. The developers will be interested by the new WebJar integration features. This, along with 17 improvements and 33 bug fixes, makes the release worth trying. | ||
8 | |||
9 | {{error}} | ||
10 | We've had some issues during the release of XWiki 6.3RC1 [[which led to a bug in the Jetty/HSQLDB distribution>>https://jira.xwiki.org/browse/XCOMMONS-680]]. If you create new wikis with this distribution the Distribution Wizard may not appear. This is fixed in XWiki 6.3. If you use the WAR distribution you shouldn't have any problem. | ||
11 | {{/error}} | ||
12 | |||
13 | = New and Noteworthy (since XWiki 6.3-milestone-2) = | ||
14 | |||
15 | [[Full list of issues fixed and Dashboard for 6.3>>https://jira.xwiki.org/secure/Dashboard.jspa?selectPageId=12599]]. | ||
16 | |||
17 | == Flamingo Themes Application == | ||
18 | |||
19 | Now, when you click on "Manage color theme" in the Administration, you reach the [[new application to manage the Flamingo Themes>>extensions:Extension.Flamingo Theme Application]]: | ||
20 | |||
21 | ((( | ||
22 | {{image reference="ReleaseNotes.ReleaseNotesXWiki624@FlamingoThemeWebHome.png" width="50%"/}} | ||
23 | ))) | ||
24 | |||
25 | You can use it to change the current theme, modify any theme or create new ones. | ||
26 | |||
27 | We have also added 3 new themes: Marina, Garden and Kitty. | ||
28 | |||
29 | {{gallery}} | ||
30 | image:Marina.png | ||
31 | image:Garden.png | ||
32 | image:Kitty.png | ||
33 | {{/gallery}} | ||
34 | |||
35 | == Bootswatch Themes for Flamingo == | ||
36 | |||
37 | XWiki comes with [[16 new themes for Flamingo>>extensions:Extension.Bootswatch Themes for Flamingo]], that have been adapted from [[Bootswatch>>http://bootswatch.com/]]. | ||
38 | |||
39 | {{gallery}} | ||
40 | image:Cerulean.png | ||
41 | image:Cosmo.png | ||
42 | image:Cyborg.png | ||
43 | image:Darkly.png | ||
44 | image:Flatly.png | ||
45 | image:Journal.png | ||
46 | image:Lumen.png | ||
47 | image:Paper.png | ||
48 | image:Readable.png | ||
49 | image:Sandstone.png | ||
50 | image:Simplex.png | ||
51 | image:Slate.png | ||
52 | image:Spacelab.png | ||
53 | image:Superhero.png | ||
54 | image:United.png | ||
55 | image:Yeti.png | ||
56 | {{/gallery}} | ||
57 | |||
58 | == Document Tree Macro == | ||
59 | |||
60 | We introduce [[a new wiki macro>>extensions:Extension.Document Tree Macro]] to display the hierarchy of documents: | ||
61 | |||
62 | {{code language="none"}} | ||
63 | {{documentTree /}} | ||
64 | {{/code}} | ||
65 | |||
66 | {{image reference="docHierarchyTree.png"/}} | ||
67 | |||
68 | === Document Index Tree === | ||
69 | |||
70 | The new [[Document Tree Macro>>extensions:Extension.Document Tree Macro]] is now used in the Wiki document index. | ||
71 | |||
72 | {{image reference="index-alldocs-tree.png"/}} | ||
73 | |||
74 | === Navigation Panel === | ||
75 | |||
76 | We also changed the [[Navigation Panel>>extensions:Extension.Panels Application||anchor="HNavigationPanel"]] to use the new [[Document Tree Macro>>extensions:Extension.Document Tree Macro]]. | ||
77 | |||
78 | {{info}} | ||
79 | Very importantly the old Navigation Panel was a performance hog on large wikis and it's not longer the case (since nodes are now opened dynamically and not all documents are loaded in memory)! | ||
80 | {{/info}} | ||
81 | |||
82 | {{image reference="navigationPanel.png"/}} | ||
83 | |||
84 | == Miscellaneous == | ||
85 | |||
86 | * Updated [[XAR export URL format>>Documentation.UserGuide.Features.Exports||anchor="HXARExport"]] to allow exporting a full space, a full wiki, or any list of pages matching a pattern. For example:((( | ||
87 | {{code language="none"}} | ||
88 | http://localhost:8080/xwiki/bin/export/Main/WebHome?format=xar&name=test&pages=Main.%25 | ||
89 | http://localhost:8080/xwiki/bin/export/Main/WebHome?format=xar&name=test&pages=%25.%25 | ||
90 | http://localhost:8080/xwiki/bin/export/Main/WebHome?format=xar&name=test&pages=%25.%25Home | ||
91 | {{/code}} | ||
92 | ))) | ||
93 | * Added an edit button to easily change the default Welcome message that is displayed on the homepage. Users have reportedly been struggling with this task for a while now and, until we come up with a new format for the homepage, this is the solution we have proposed to make things easier.((( | ||
94 | {{image reference="editWelcomeMessage.png"/}} | ||
95 | ))) | ||
96 | * The configuration of the [[Applications Panel>>extensions:Extension.Panels Application||anchor="HApplicationPanel"]] now works with touch-screen devices too. | ||
97 | * The Standalone Distribution [[now has a new startup parameter to enable monitoring/managing the Jetty instance>>Documentation.AdminGuide.Monitoring||anchor="HJMXConsole"]]. You can use it with ##start_xwiki.sh -j## (or ##start_xwiki.sh ~-~-jmx##). | ||
98 | * Updated the notification message when the panel layout is saved to use the standard notification widget. | ||
99 | |||
100 | 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.3-rc-1%22&tempMax=1000]] fixed in this release. | ||
101 | |||
102 | = For Developers = | ||
103 | |||
104 | == Tree Widget == | ||
105 | |||
106 | We introduce a [[new JavaScript widget>>extensions:Extension.Tree Widget]] that can be used to create tree views for the structured data stored in the wiki. It is based on [[jsTree>>http://www.jstree.com/]] and thus has support for both static and dynamic (interactive) trees. | ||
107 | |||
108 | == Tree Macro == | ||
109 | |||
110 | We introduce [[a new wiki macro>>extensions:Extension.Tree Macro]] that allows you to easily define a tree in a wiki page. It uses the tree widget. | ||
111 | |||
112 | {{code language="none"}} | ||
113 | {{tree}} | ||
114 | * Parent | ||
115 | ** Child | ||
116 | {{/tree}} | ||
117 | |||
118 | {{tree reference="Space.MyDynamicTree" /}} | ||
119 | {{/code}} | ||
120 | |||
121 | == Improved WebJars Integration == | ||
122 | |||
123 | We added 2 new features to improve the WebJars Integration: | ||
124 | |||
125 | * You can now omit the WebJar version:((( | ||
126 | {{code language="none"}} | ||
127 | $services.webjars.url('angularjs', 'angular.js') | ||
128 | {{/code}} | ||
129 | ))) | ||
130 | * You can use Velocity code in WebJar resources. This means you can use for instance Color Theme variables inside your CSS files that are packaged inside a WebJar:((( | ||
131 | {{code language="none"}} | ||
132 | $services.webjars.url('org.xwiki.contrib:my-webjar', 'style.css', {'evaluate': true}) | ||
133 | {{/code}} | ||
134 | ))) | ||
135 | |||
136 | See the [[WebJar Integration documentation>>extensions:Extension.WebJars Integration]] for more information. | ||
137 | |||
138 | == Miscellaneous == | ||
139 | |||
140 | * Suggest widget now has an extra ##propagateEventKeyCodes## option where key codes can be listed so their events will be propagated. See the [[documentation>>Documentation.DevGuide.AutoSuggestWidget||anchor="HJavascriptparametersfortheXWiki.widgets.Suggestconstructor"]]. | ||
141 | * Extended modalPopup.js to support specifying keyboard shortcut options for the defined actions. See the [[documentation>>Documentation.DevGuide.ModalPopup||anchor="HConstructorfieldsfortheModalPopupJavascriptclass"]]. | ||
142 | * You can now [[render an icon from any icon theme present on the wiki>>extensions:Extension.Icon Theme Application||anchor="HUsagewithscripts"]], referenced by its name:((( | ||
143 | {{code language="velocity"}} | ||
144 | $services.icon.render('globe', 'Silk') | ||
145 | $services.icon.render('globe', 'Font Awesome') | ||
146 | {{/code}} | ||
147 | ))) | ||
148 | |||
149 | == Upgrades == | ||
150 | |||
151 | The following dependencies have been upgraded: | ||
152 | |||
153 | * [[httpcore 4.3.3>>https://jira.xwiki.org/browse/XCOMMONS-679]] | ||
154 | |||
155 | = Translations = | ||
156 | |||
157 | The following translations have been updated: | ||
158 | |||
159 | {{language codes="de, fr, lv"/}} | ||
160 | |||
161 | = Tested Browsers & Databases = | ||
162 | |||
163 | {{include reference="TestReports.ManualTestReportSummaryXWiki63RC1"/}} | ||
164 | |||
165 | = Known issues = | ||
166 | |||
167 | * [[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]] | ||
168 | |||
169 | = Backward Compatibility and Migration Notes = | ||
170 | |||
171 | == General Notes == | ||
172 | |||
173 | 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. | ||
174 | |||
175 | == Issues specific to XWiki 6.3-rc-1 == | ||
176 | |||
177 | * Wiki page does not have access anymore to Velocity macro defined in the skin template (except for macro.vm template). | ||
178 | |||
179 | == API Breakages == | ||
180 | |||
181 | The following APIs were modified since XWiki 6.2.3: | ||
182 | |||
183 | * Add issue management and SCM information to extension descriptors. Should be safe enough since most repository handlers extend AbstractExtension instead of directly implementing Extension. | ||
184 | |||
185 | {{code language="none"}} | ||
186 | org.xwiki.extension.Extension: Method 'public org.xwiki.extension.ExtensionIssueManagement getIssueManagement()' has been added to an interface | ||
187 | org.xwiki.extension.Extension: Method 'public org.xwiki.extension.ExtensionScm getScm()' has been added to an interface | ||
188 | {{/code}} | ||
189 | |||
190 | * serializeReference method has never been public. AspectJ hacks... | ||
191 | |||
192 | {{code language="none"}} | ||
193 | com.xpn.xwiki.doc.XWikiDocument: Method 'public java.lang.String ajc$privMethod$com_xpn_xwiki_doc_XWikiDocumentCompatibilityAspect$com_xpn_xwiki_doc_XWikiDocument$serializeReference(org.xwiki.model.reference.DocumentReference, org.xwiki.model.reference.EntityReferenceSerializer, org.xwiki.model.reference.DocumentReference)' has been removed | ||
194 | {{/code}} | ||
195 | |||
196 | * Never really been supposed to be exposed as an API | ||
197 | |||
198 | {{code language="none"}} | ||
199 | com.xpn.xwiki.objects.BaseElement: Accessibility of field localEntityReferenceSerializer has been weakened from protected to private | ||
200 | {{/code}} | ||
201 | |||
202 | * Added new methods to the unstable Icon Module | ||
203 | |||
204 | {{code language="none"}} | ||
205 | org.xwiki.icon.IconManager: Method 'public java.lang.String render(java.lang.String, java.lang.String)' has been added to an interface | ||
206 | org.xwiki.icon.IconManager: Method 'public java.lang.String render(java.lang.String, java.lang.String, boolean)' has been added to an interface | ||
207 | org.xwiki.icon.IconManager: Method 'public java.lang.String renderHTML(java.lang.String, java.lang.String)' has been added to an interface | ||
208 | org.xwiki.icon.IconManager: Method 'public java.lang.String renderHTML(java.lang.String, java.lang.String, boolean)' has been added to an interface | ||
209 | org.xwiki.icon.IconSetCache: Method 'public void clear(java.lang.String, java.lang.String)' has been added to an interface | ||
210 | org.xwiki.icon.IconSetCache: Method 'public org.xwiki.icon.IconSet get(java.lang.String, java.lang.String)' has been added to an interface | ||
211 | org.xwiki.icon.IconSetCache: Method 'public void put(java.lang.String, java.lang.String, org.xwiki.icon.IconSet)' has been added to an interface | ||
212 | org.xwiki.icon.IconSetManager: Method 'public org.xwiki.icon.IconSet getIconSet(java.lang.String)' has been added to an interface | ||
213 | {{/code}} |