Wiki source code of Release Notes for XWiki 5.2

Version 9.4 by Marius Dumitru Florea on 2013/10/02

Show last authors
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 {{warning}}
8 **The support of XWiki Enterprise Manager is stopped**. XWiki Enterprise now comes with the ability to create (sub)wikis by default, see below.
9 {{/warning}}
10
11 <insert description of release here>
12
13 = New and Noteworthy (since XWiki 5.1) =
14
15 [[Full list of issues fixed and Dashboard for 5.2>>http://jira.xwiki.org/secure/Dashboard.jspa?selectPageId=11602]].
16
17 == Multi-wiki Support ==
18
19 XWiki Enterprise comes now with the ability for users to create their own wikis (a.k.a subwikis) without the need to install additional extensions. This supersedes the notion of "workspace" and consists in the integration of the [[Workspace Application>>extensions:Extension.Workspace Application]] in the default XWiki distribution.
20
21 {{image reference="ReleaseNotesXWiki52M2@add-wiki.png"/}}
22
23 This new menu entry appears only if a wiki template is created first, see below.
24
25 === Wiki Creation Right ===
26
27 The wiki creation is now possible for users who have the "createwiki" right. This right is only available for the main wiki users, exactly like the Programming Right.
28
29 === Wikis Administration Section ===
30
31 A new section is available in the administration of the main wiki. In this section, you can enable the wiki creation feature by creating a wiki template. It also manages who has the right to create new wikis.
32
33 {{image reference="ReleaseNotesXWiki52M2@admin-wikis.png"/}}
34
35 === Wiki Creation Wizard ===
36
37 A new wizard for the creation of a new wiki is now available from the "Add" menu.
38
39 {{image reference="ReleaseNotesXWiki52M2@createwiki1.png"/}}
40
41 {{image reference="ReleaseNotesXWiki52M2@createwiki2.png"/}}
42
43 === Home Menu ===
44
45 A new top level menu is available when there is more than one wiki.
46
47 {{image reference="ReleaseNotesXWiki52RC1@mainwiki-homemenu.png"/}}
48
49 {{image reference="ReleaseNotesXWiki52RC1@workspace-homemenu.png"/}}
50
51 The "main wiki" (the first you have when you start a new instance) is now called "**Home**".
52
53 == Toggle Email Address Obfuscation ==
54
55 The email configuration section in the [[Administration>>doc:extensions:Extension.Administration Application]] now has an option to enable/disable the obfuscation of the email addresses that are stored in object properties of [[type Email>>ReleaseNotes.ReleaseNotesXWiki42||anchor="HNewfieldtypesforemailandlistofpages"]]. The obfuscation is done by displaying only the first letter of the email account, e.g. //a...@domain.org//, the rest of the letters being replaced by an ellipsis. Email obfuscation is off by default.
56
57 {{image reference="ReleaseNotesXWiki52M1@generalEmailSettings.png"/}}
58
59 == Miscellaneous ==
60
61 <insert misc user stuff and important bug fix descriptions here in a list, when they are too small to warrant a section by themselves - Change the version in the URL below!>
62
63 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+in+%28%225.2-milestone-1%22%2C+%225.2-milestone-2%22%2C+%225.2-rc-1%22%2C+%225.2%22%29&tempMax=1000]] fixed in this release.
64
65 = For Developers =
66
67 == <developer feature N> ==
68
69 <description of developer feature N>
70
71 == Deprecated and Retired projects ==
72
73 * Google plugin (##com.xpn.xwiki.plugin.google.GooglePlugin##) has been retired, you can find it on https://github.com/xwiki-contrib/retired/tree/master/xwiki-platform-google-plugin
74
75 == Upgrades ==
76
77 The following dependencies have been upgraded:
78
79 * Aether 0.9.0.M2 (moved from org.sonatype.aether to org.eclipse.aether)
80 * CSSParser 0.9.9
81 * [[Groovy 2.1.7>>http://jira.xwiki.org/browse/XCOMMONS-445]]
82 * [[HSQLDB 2.3.0>>http://jira.xwiki.org/browse/XE-1323]]
83 * Infinispan 5.3
84 * JGroups 3.3.4
85 * Maven 3.1.0
86 * Tika 1.4
87 * Xerces2-Java 2.11.0
88
89 == Miscellaneous ==
90
91 <other dev stuff to add and link to JIRA for all issues fixed>
92
93 = Translations =
94
95 The following translations have been updated:
96
97 {{language codes="ca, cs, da, de, es, fr, gl, it, ko, lv, nl, pl, pt, pt_BR, ro, ru, sk, sv, uk, vi, zh, zh_TW"/}}
98
99 = Tested Browsers & Databases =
100
101 {{include reference="TestReports.ManualTestReportTemplateSummary"/}}
102
103 = Known issues =
104
105 * [[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]]
106
107 = Backward Compatibility and Migration Notes =
108
109 == General Notes ==
110
111 You may also want to [[import the default wiki XAR>>Main.Download]] in order to benefit from all the improvements listed above.
112
113 {{warning}}
114 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.
115 {{/warning}}
116
117 == Solr Index Format Change ==
118
119 If you're upgrading from XWiki 4.5.x to this version you'll need to perform a full re-indexation when using the Solr Search. This because in XWiki 4.5.x the Solr search was experimental and we've completely changed the indexing format in XWiki 5.1.
120
121 == Email Address Obfuscation ==
122
123 In [[4.2>>ReleaseNotes.ReleaseNotesXWiki42||anchor="HNewfieldtypesforemailandlistofpages"]] we introduced a new object property type called Email that can be used to store email addresses. In [[5.1>>ReleaseNotes.ReleaseNotesXWiki51||anchor="HUseremail"]] we decided to use this new property type in the user profile to store the user email address. With this change we also introuced a defaut custom displayer for the Email property type that obfuscates the email address in view mode. As a consequence the user profile email address became obfuscated by default. Starting with 5.2 we allow you to toggle the email address obfuscation from the administration. What is important to know is that the email address obfuscation is off by default. So if you upgrade from 5.1 and you want to preserve the obfuscation then you need to enable it from the administration.
124
125 == Instance Identifier ==
126
127 XWiki now creates a unique identifier in the database (this is used by the new Active Installs module and will be used in the future by the Extension Manager to identify your instance for example). You need to verify that your ##hibernate.cfg.xml## file has the following mapping definition next to the existing mapping definitions:
128
129 (((
130 {{code}}
131 ...
132 <mapping resource="instance.hbm.xml"/>
133 ...
134 {{/code}}
135 )))
136
137 == API Breakages ==
138
139 The following APIs were modified since XWiki 5.1:
140
141 * Moved to ##xwiki-commons-legacy-properties##
142
143 {{code language="none"}}
144 org.xwiki.properties.converter.AbstractCollectionConverter: Class org.xwiki.properties.converter.AbstractCollectionConverter removed
145 {{/code}}
146
147 * This method should never have existed
148
149 {{code language="none"}}
150 org.xwiki.rendering.listener.reference.ResourceType: Method 'public void setScheme(java.lang.String)' has been removed
151 {{/code}}
152
153 * Moved from ##xwiki-rendering-api## to ##xwiki-rendering-xml##
154
155 {{code language="none"}}
156 org.xwiki.rendering.renderer.printer.XHTMLWikiPrinter: Class org.xwiki.rendering.renderer.printer.XHTMLWikiPrinter removed
157 org.xwiki.rendering.renderer.printer.XMLWikiPrinter: Class org.xwiki.rendering.renderer.printer.XMLWikiPrinter removed
158 {{/code}}
159
160 * This field is not meant to be be modified, the final was just forgotten.
161
162 {{code language="none"}}
163 com.xpn.xwiki.XWikiContext: Field TYPE_PROVIDER is now final
164 {{/code}}
165
166 * Not an API. This should be internal.
167
168 {{code language="none"}}
169 com.xpn.xwiki.store.XWikiHibernateBaseStore: Method 'protected java.lang.String[] addHibernateSequenceIfRequired(java.lang.String[], java.lang.String, org.hibernate.Session)' has been removed
170 {{/code}}
171
172 * Has been moved to ##xwiki-platform-feed-api## since it was the only module using it. We also dropped jTidy in favor of HTMLCleaner.
173
174 {{code language="none"}}
175 com.xpn.xwiki.util.TidyMessageLogger: Class com.xpn.xwiki.util.TidyMessageLogger removed
176 {{/code}}
177
178 * Google API plugin has been retired
179
180 {{code language="none"}}
181 com.xpn.xwiki.plugin.google.GooglePlugin: Class com.xpn.xwiki.plugin.google.GooglePlugin removed
182 com.xpn.xwiki.plugin.google.GooglePluginApi: Class com.xpn.xwiki.plugin.google.GooglePluginApi removed
183 {{/code}}
184
185 * Return the number of imported documents
186
187 {{code language="none"}}
188 com.xpn.xwiki.tool.backup.Importer: Return type of method 'public void importXAR(java.io.File, java.lang.String, com.xpn.xwiki.XWikiContext)' has been changed to int
189 {{/code}}
190
191 * The JPQLParser generates source code (that should be internal but it is not) and the grammar has changed a bit.
192
193 {{code language="none"}}
194 org.xwiki.query.jpql.analysis.Analysis: Method 'public void caseAFuncnumComparableItem(org.xwiki.query.jpql.node.AFuncnumComparableItem)' has been added to an interface
195 org.xwiki.query.jpql.analysis.Analysis: Method 'public void caseAFuncstrComparableItem(org.xwiki.query.jpql.node.AFuncstrComparableItem)' has been added to an interface
196 org.xwiki.query.jpql.analysis.Analysis: Method 'public void caseAFunctimeComparableItem(org.xwiki.query.jpql.node.AFunctimeComparableItem)' has been added to an interface
197 org.xwiki.query.jpql.analysis.Analysis: Method 'public void caseAPathComparableItem(org.xwiki.query.jpql.node.APathComparableItem)' has been added to an interface
198 org.xwiki.query.jpql.node.AGroupbyItem: Parameter 1 of 'public AGroupbyItem(org.xwiki.query.jpql.node.PPath)' has changed its type to org.xwiki.query.jpql.node.PComparableItem
199 org.xwiki.query.jpql.node.AGroupbyItem: Method 'public org.xwiki.query.jpql.node.PPath getPath()' has been removed
200 org.xwiki.query.jpql.node.AGroupbyItem: Method 'public void setPath(org.xwiki.query.jpql.node.PPath)' has been removed
201 org.xwiki.query.jpql.node.AOrderbyItem: Parameter 1 of 'public AOrderbyItem(org.xwiki.query.jpql.node.PPath, org.xwiki.query.jpql.node.TOrderbySpec)' has changed its type to org.xwiki.query.jpql.node.PComparableItem
202 org.xwiki.query.jpql.node.AOrderbyItem: Method 'public org.xwiki.query.jpql.node.PPath getPath()' has been removed
203 org.xwiki.query.jpql.node.AOrderbyItem: Method 'public void setPath(org.xwiki.query.jpql.node.PPath)' has been removed
204 {{/code}}

Get Connected