# Wiki source code of Release Notes for XWiki Enterprise 3.4

1 {{box cssClass="floatinginfobox" title="**Contents**"}}
2 {{toc/}}
3 {{/box}}
4
5 XWiki Enterprise 3.4 is a stabilization release as we're approaching the end of the [[3.x cycle>>enterprise:Main.Roadmap#HXWikiEnterprise3.xCycle]] so its main goal was to improve the Extension Manager and App Within Minutes features. However, this release also comes with a new look and a new default wiki page syntax.
6
7 = New and Noteworthy (since XWiki Enterprise 3.3 version) =
8
9 Checkout the full unabridged [[list of issues>>https://jira.xwiki.org/sr/jira.issueviews:searchrequest-printable/11290/SearchRequest-11290.html?tempMax=1000]] fixed in this release and, if you're interested in statistics, the [[JIRA dashboard>>https://jira.xwiki.org/secure/Dashboard.jspa?selectPageId=10790]].
10
11 == New color themes ==
12
13 XWiki Enterprise 3.4 comes with a new default color theme and other three (Mint, Ruby and Dusk) that you can choose from. All four use CSS3 rules and new color variables in order to be able to have gradients. All color themes that were previously available are now considered deprecated and have been published as extensions: [[Default>>extensions:Extension.Default33 ColorTheme]], [[Bordo>>extensions:Extension.Bordo ColorTheme]], [[Nature>>extensions:Extension.Nature ColorTheme]], [[BlueSky>>extensions:Extension.BlueSky ColorTheme]], [[Inner Dark>>extensions:Extension.Inner Dark ColorTheme]], [[Nightfall>>extensions:Extension.Nightfall ColorTheme]] and [[Peach>>extensions:Extension.Peach ColorTheme]].
14
15 {{warning}}
16 This means that custom build color themes or skins build on top of Colibri may not be compatible with the recent changes when doing an upgrade.
17 {{/warning}}
18
19 In order to solve this problem you have two solutions: adjust your custom color themes with the new changes or don't upgrade the following wiki pages when upgrading the XAR: ##ColorThemes.DefaultColorTheme##, ##ColorThemes.ColorThemeTemplate##, ##XWiki.AdminSheet##, ##colorThemeInit.vm## and the following CSS files from Colibri skin: ##colibri.css## and ##ie-all.css##.
20
21 If you were using one of the deprecated colorthemes, please change the colortheme to one of the new bundled compatible ColorThemes: Default, Mint, Ruby or Dusk.
22
23 [[[[image:ReleaseNotesXWikiEnterprise34RC1@colorthemes34.png||style="border:1px solid gray; padding: 0.2em; width:600px;"]]>>attach:ReleaseNotesXWikiEnterprise34RC1@colorthemes34.png]]
24
25 == XWiki Syntax 2.1 is the default page syntax ==
26
27 Even though the XWiki Syntax 2.1 has been available for a long time already, it was marked experimental. We've now made it final which means no more changes will be brought to the XWiki Syntax 2.1 (any new change will be made in a new XWiki Syntax 2.2).
28
29 What it also means is that when you create a new page from now on, it'll be created in XWiki Syntax 2.1 syntax by default (you can still choose another syntax using the Syntax chooser in edit mode, see [[Page Editing>>platform:Features.PageEditing#HChoosingaSyntax]]).
30
31 As a reminder here are below the differences between XWiki Syntax 2.0 and XWiki Syntax 2.1.
32
33 === Changes to the link syntax from XWiki Syntax 2.0 ===
34
35 The query string and the anchor (URL fragment) are no longer specified in the reference section of the link syntax:
36
37 (% class="box code" %)
39
41
42 (% class="box code" %)
44
45 The canonical representation of a link reference is prefixed with the reference type:
46
47 (% class="box code" %)
48 ~[~[Source repository>>**url:**https:~/~/github.com/organizations/xwiki]]
49 ~[~[Syntax Help>>**doc:**platform:Main.XWikiSyntax]]
50
51 InterWiki links have a dedicated reference type:
52
53 (% class="box code" %)
54 ~[~[XWiki on Wikipedia>>**interwiki:**wikipedia:XWiki]]
55
56 Two new reference types: relative path and [[UNC (Universal Naming Convention)>>http://en.wikipedia.org/wiki/Path_%28computing%29#Uniform_Naming_Convention]].
57
58 (% class="box code" %)
59 ~[~[Edit this page>>**path:**$doc.getURL('edit')]] 60 ~[~[File system access>>**unc:**~\~\myserver\path\to\file.txt]] 61 62 See the [[full link specification>>platform:Main.XWikiSyntax#HXWikiSyntax2.1LinkSpecification]] for more details. 63 64 === Changes to the image syntax from XWiki Syntax 2.0 === 65 66 You can pass the query string of the image URL as a special image parameter: 67 68 (% class="box code" %) 69 ~[~[image~:MyPage@myPicture.png||**queryString**="parameter=value"]] 70 71 You can use a relative path as the image reference. This is useful to display images from the skin: 72 73 (% class="box code" %) 74 image~:**path:**$xwiki.getSkinFile('logo.png')
75
76 It is now possible to reference an icon from the [[XWiki Icon Set>>http://www.famfamfam.com/lab/icons/silk/previews/index_abc.png]]:
77
78 (% class="box code" %)
79 image~:**icon:**chart_pie
80
81 See the [[full image specification>>platform:Main.XWikiSyntax#HXWikiSyntax2.1ImageSpecification]] for more details.
82
83 == Delete space menu ==
84
85 You can now delete an entire space using the Space menu. This will move all the pages from that space to the recycle bin. Note that in case you want to restore the space you have to restore each page individually from the recycle bin. We're hoping to offer a way to easily restore the space in the next versions.
86
88
89 == Simple space templates ==
90
91 You can now create simple space templates. If you go to Templates section of the wiki administration and create a new template provider you'll notice that you can choose the template type. "Space homepage" templates are used to create new spaces.
92
93 [[image:ReleaseNotesXWikiEnterprise34M1@SpaceTemplateProvider.png||style="border:1px solid gray; padding: 0.2em;"]]
94
95 All the available space templates are listed on the Create Space dialog that you can access from the Add > Space menu.
96
97 [[image:ReleaseNotesXWikiEnterprise34M1@CreateSpace.png||style="border:1px solid gray; padding: 0.2em;"]]
98
99 XWiki Enterprise comes by default with a space dashboard template which can be used to create a new space whose home page is a dashboard.
100
101 == Special characters in attachment name ==
102
103 Starting with this version, non-ASCII characters are not filtered anymore from the file name when uploading an attachment.
104
105 == Minimized action menu ==
106
107 The action menu is now minimized when the page is scrolled. You can access it by hovering the top of the browser window.
108
110
111 == Display macro ==
112
113 New display macro to replace include macro with context=new. See [[extensions:Extension.Display Macro]] for more details.
114
115 = Bug fixes and improvements =
116
117 * Tree view from document index should work fine in Internet Explorer 9.
118 * Adding users to a group through the administration should work fine in Internet Explorer 9.
119 * Extension manager UI has been polished.
120 * Created workspaces should now be stabilized and no longer report errors after an XWiki restart or in the Administration section.
121
122 = For Developers =
123
124 * Component manager bug fixes and improvements (including an important optimization which should bring a significant speed improvement)
125 * [[StringUtils>>http://commons.apache.org/lang/api/org/apache/commons/lang3/StringUtils.html]] can be accessed in Velocity using ##$stringtool## 126 * ###stop## Velocity directive is working again 127 * You can now stop the execution of a Velocity macro or template using ###break($macro)## and ###break($template)## respectively. ##$template## can also be used to find the name of the current Velocity name space (usually the name of the current Velocity template).
128 * [[Markdown>>http://en.wikipedia.org/wiki/Markdown]] syntax support added.
129 * The database migration code has been fully rewritten:
130 ** [[XWIKI-7006>>https://jira.xwiki.org/browse/XWIKI-7006]] Accessing a store that is not migrated to the lastest data version should not be allowed
131 ** [[XWIKI-1859>>https://jira.xwiki.org/browse/XWIKI-1859]] Do not start migrations on a clean installation of XWiki
132 * Oracle support improved
133 ** [[XWIKI-6368>>https://jira.xwiki.org/browse/XWIKI-6368]] - Exception "inconsistent datatypes" on VisitStats in Oracle 10g
134 ** [[XWIKI-7278>>https://jira.xwiki.org/browse/XWIKI-7278]] - Virtual mode fails on Oracle with "ORA-01435: user does not exist"
135 * Skin changes:
136 ** new ##.disabled## CSS class to mark disabled inputs, see [[documentation>>http://platform.xwiki.org/xwiki/bin/view/DevGuide/VerticalForms#H7.Disabling]].
137 ** new ##.hasIcon## class to be used for elements that have a background-icon attached. The class works in pair with other classes that specify the icon that will be used (e.g. ##.iconRSS##, ##.tmEdit## etc.). Checkout the [[documentation>>http://platform.xwiki.org/xwiki/bin/view/DevGuide/SpecialCSSClasses#HA.Generalclasses]] for other general purpose CSS classes.
138 ** in order to write more easily all the proprietary declarations for CSS3 background gradients and box-sizing properties you can use the following macros: ###css3_backgroundLinearGradient##, ###css3_backgroundIconAndLinearGradient## and ###css3_boxSizing##.
139 ** you can use the ##.png## version for the icons in the Silk icons set (the ##.gif## versions will gradually be replaced).
140
142
143 The following dependencies have been upgraded:
144
145 * AETHER 1.13.1
146 * Groovy 1.8.5
147 * Hibernate 3.6.9
148 * jdeb 0.9
149 * Restlet 2.0.11
150 * Selenium 2.17
151 * Selenium Maven Plugin 2.2
152 * SmartGWT 3.0
153
154 == Translations ==
155
156 The following translations have been updated:
157
158 {{language codes="de, es, fr, hi, hr, lv, ru, sv, uk, zh_TW"/}}
159
160 = Tested Browsers =
161
162 Here's the list of browsers tested with this version (i.e. browsers that we've tested as working - Check the list of [[supported browsers>>dev:Community.BrowserSupportStrategy]]):
163
164 {{browser name="firefox" version="9.0.1"/}}
165
166 {{browser name="chrome" version="16"/}}
167
168 = Test Report =
169
170 You can check the [[manual test report>>TestReports.ManualTestReportXE34]] to learn about what was tested and the results on various browsers.
171
172 = Known issues =
173
174 * [[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]]
175
176 = Backward Compatibility and Migration Notes =
177
178 == General Notes ==
179
180 {{info}}
181 If you're running in a multiwiki setup you'll also need to define the property //xwiki.store.migration.databases// in your //xwiki.cfg// file if you want to explicitly name some databases to be migrated as the default is now to migrate all databases. Database that are not migrated could not be accessed.
182 {{/info}}
183
184 You may also want to [[import the default wiki XAR>>Main.Download]] in order to benefit from all the improvements listed above.
185
186 {{warning}}
187 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.
188 {{/warning}}
189
190 {{warning}}
191 Upgrading may lead to style/display problems for custom build color themes or skins build on top of Colibri, since they may not be compatible with the recent colorthemes/skin changes [[read more>>ReleaseNotes.ReleaseNotesXWikiEnterprise34#HNewcolorthemes]]
192 {{/warning}}
193
194 == Issues specific to XWiki Enterprise 3.4 ==
195
196 === Default wiki access method changed to path-based ===
197
198 In virtual mode, XWiki can work in two ways: based on domain names, where each virtual wiki is accessed from a different DNS domain, like ##__wikiname__.myfarm.net##, and path-based, where each virtual wiki is accessed on a different path of the same domain, like ##www.myfarm.net/wikis/__wikiname__/##. Since the former mode is harder to set up, since it requires a custom DNS server, we have enabled the second mode by default in this release.
199
200 {{warning}}
201 When merging the xwiki.cfg for the migration process, keep in mind that the value of 'xwiki.virtual.usepath' has been changed to a default of 1 instead of 0. If your wiki is set to virtual mode and is using subdomains to access subwikis, make sure to set 'xwiki.virtual.usepath' to 0.
202 {{/warning}}
203
204 == API Breakages ==
205
206 The following APIs were modified since version 3.3:
207
208 {{code language="none"}}
209 org.xwiki.rest.XWikiAuthentication: Removed org.restlet.Filter from the list of superclasses
210 org.xwiki.rest.XWikiAuthentication: Removed org.restlet.Guard from the list of superclasses
211 org.xwiki.rest.XWikiAuthentication: Removed org.restlet.Uniform from the list of superclasses
212 org.xwiki.rest.XWikiAuthentication: In method 'public int authenticate(org.restlet.data.Request)' the number of arguments has changed
213 org.xwiki.rest.XWikiAuthentication: Return type of method 'public int authenticate(org.restlet.data.Request)' has been changed to boolean
214 org.xwiki.rest.XWikiAuthentication: Method 'public boolean checkSecret(org.restlet.data.Request, java.lang.String, char[])' has been removed
215 org.xwiki.rest.XWikiRestletJaxRsApplication: Removed org.restlet.Uniform from the list of superclasses
216 org.xwiki.rest.XWikiRestletServlet: Removed com.noelios.restlet.ext.servlet.ServerServlet from the list of superclasses
217 org.xwiki.rest.XWikiSetupCleanupFilter: Removed org.restlet.Filter from the list of superclasses
218 org.xwiki.rest.XWikiSetupCleanupFilter: Removed org.restlet.Uniform from the list of superclasses
219 org.xwiki.rest.XWikiSetupCleanupFilter: Parameter 1 of 'protected void afterHandle(org.restlet.data.Request, org.restlet.data.Response)' has changed its type to org.restlet.Request
220 org.xwiki.rest.XWikiSetupCleanupFilter: Parameter 2 of 'protected void afterHandle(org.restlet.data.Request, org.restlet.data.Response)' has changed its type to org.restlet.Response
221 org.xwiki.rest.XWikiSetupCleanupFilter: Parameter 1 of 'protected int beforeHandle(org.restlet.data.Request, org.restlet.data.Response)' has changed its type to org.restlet.Request
222 org.xwiki.rest.XWikiSetupCleanupFilter: Parameter 2 of 'protected int beforeHandle(org.restlet.data.Request, org.restlet.data.Response)' has changed its type to org.restlet.Response
223 org.xwiki.rest.XWikiSetupCleanupFilter: Parameter 1 of 'protected javax.servlet.http.HttpServletRequest getHttpRequest(org.restlet.data.Request)' has changed its type to org.restlet.Request
224 org.xwiki.rest.resources.BrowserAuthenticationResource: Removed org.restlet.Handler from the list of superclasses
225 org.xwiki.rest.resources.BrowserAuthenticationResource: Removed org.restlet.resource.Resource from the list of superclasses
226 org.xwiki.rest.resources.BrowserAuthenticationResource: Parameter 2 of 'public BrowserAuthenticationResource(org.restlet.Context, org.restlet.data.Request, org.restlet.data.Response)' has changed its type to org.restlet.Request
227 org.xwiki.rest.resources.BrowserAuthenticationResource: Parameter 3 of 'public BrowserAuthenticationResource(org.restlet.Context, org.restlet.data.Request, org.restlet.data.Response)' has changed its type to org.restlet.Response
228 {{/code}}