Last modified by Thomas Mortagne on 2017/03/24

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 This is mostly a stabilization release leading to XWiki 5.2 final and it brings a new "Home" top level menu (available when there is more than one wiki) and a new Distribution Wizard step to upgrade all wikis. The WikiStream framework has been improved and now can be used to export large wikis in XAR format. Besides this the new release includes 49 bug fixes and 16 small improvements.
8
9 = New and Noteworthy (since XWiki 5.2 Milestone 2) =
10
11 [[Full list of issues fixed and Dashboard for 5.2>>https://jira.xwiki.org/secure/Dashboard.jspa?selectPageId=11602]].
12
13 == New "Home" menu when there is more than one wiki ==
14
15 Compared to XWiki 5.2-milestone-2, we have removed the XWiki right menu and created a "Home" menu instead.
16 {{image reference="mainwiki-homemenu.png"/}}
17 {{image reference="workspace-homemenu.png"/}}
18
19 The "main wiki" (the first you have when you start a new instance) is now called "**Home**".
20
21 == Distribution Wizard Step to Upgrade All Wikis ==
22
23 We added a new step to the [[Distribution Wizard>>doc:platform:Features.DistributionWizard]] to update the default set of wiki pages on each of the existing wikis. This step is triggered only if you choose to upgrade the entire farm in the "Upgrade Mode" step.
24
25 {{image reference="dw-wikisStep.png" width="600px"/}}
26
27 == Markdown Syntax 1.1 ==
28
29 We've added [[version 1.1 of the Rendering Syntax for Markdown>>rendering:Main.Markdown11]], adding support for:
30
31 * Macros
32 * Superscript and subscript
33 * (X)HTML improvements
34
35 == Export large wikis as XARs ==
36
37 It's possible to enable the use of new [[WikiStream>>doc:extensions:Extension.WikiStream Module]] framework in standard export action (use in the standard export UI for example). Among other things it allows exporting a wiki of pretty much any size.
38
39 [[WikiStream>>doc:extensions:Extension.WikiStream Module]] is too young to be enabled by default and will require heavy testing. In the meantime you can try it by uncommenting {{code}}# xwiki.action.export.xar.usewikistream=1{{/code}} at the end of xwiki.cfg file.
40
41 == Miscellaneous ==
42
43 * Improved Active Installs Server side API to be able to pass any query to count installs.
44 * Active Installs Client now also send the Distribution id in addition to the Distribution version to identify the "product" sending the ping
45 * The checkboxes for the global rights settings are now displayed on the left of their labels.(((
46 {{image reference="RightsAdministration-CheckboxOnTheLeft.png"/}}
47 )))
48 * The live search (search suggest) now displays a message when there are no results.(((
49 {{image reference="liveSearch-noResults.png"/}}
50 )))
51 * The blog application is now packaged by default in the Home wiki only (not in new wikis).
52 * The "Create a new wiki" link has been removed from the wiki index. Now, you can only use the //Add > Wiki// menu.
53 * The Distribution Wizard does not appear anymore just after creating a new wiki based on the default template.
54
55 = For Developers =
56
57 == WikiStream improvements ==
58
59 Various improvements and bugfixes to fully support the use case of exporting a entire wiki into a XAR package.
60
61 Also added a XAR input module for [[WikiStream>>doc:extensions:Extension.WikiStream Module]], the only thing left before covering XAR import use case in Instance output module.
62
63 == Upgrades ==
64
65 The following dependencies have been upgraded:
66
67 * Xerces2-Java 2.11.0
68
69 == Miscellaneous ==
70
71 * Added DocumentReference and EntityReference property converters which makes possible to:
72 ** use them in rendering macros parameters beans (see [[How to write a macro>>rendering:Main.ExtendingMacro||anchor="HMacroCode"]])
73 ** in Velocity pass a String directly to a method requiring a DocumentReference or EntityReference
74 * Added new API to the JODA Time plugin to get an ISO8601 formatter.
75
76 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%2C+XEM%29+and+status+%3D+Closed+and+resolution+%3D+Fixed+and+fixVersion+%3D+%225.2-rc-1%22&tempMax=1000]] fixed in this release.
77
78 = Translations =
79
80 The following translations have been updated:
81
82 {{language codes="da, de, fr, pt_BR"/}}
83
84 = Tested Browsers & Databases =
85
86 {{include reference="TestReports.ManualTestReportXWiki52RC1Summary"/}}
87
88 = Known issues =
89
90 * [[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]]
91
92 = Backward Compatibility and Migration Notes =
93
94 == General Notes ==
95
96 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.
97
98 == SOLR Search Format Change ==
99
100 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.
101
102 == API Breakages ==
103
104 The following APIs were modified since XWiki 5.1:
105
106 * Moved to ##xwiki-commons-legacy-properties##
107
108 {{code language="none"}}
109 org.xwiki.properties.converter.AbstractCollectionConverter: Class org.xwiki.properties.converter.AbstractCollectionConverter removed
110 {{/code}}
111
112 * This method should never have existed
113
114 {{code language="none"}}
115 org.xwiki.rendering.listener.reference.ResourceType: Method 'public void setScheme(java.lang.String)' has been removed
116 {{/code}}
117
118 * Moved from ##xwiki-rendering-api## to ##xwiki-rendering-xml##
119
120 {{code language="none"}}
121 org.xwiki.rendering.renderer.printer.XHTMLWikiPrinter: Class org.xwiki.rendering.renderer.printer.XHTMLWikiPrinter removed
122 org.xwiki.rendering.renderer.printer.XMLWikiPrinter: Class org.xwiki.rendering.renderer.printer.XMLWikiPrinter removed
123 {{/code}}
124
125 * This field is not meant to be be modified, the final was just forgotten.
126
127 {{code language="none"}}
128 com.xpn.xwiki.XWikiContext: Field TYPE_PROVIDER is now final
129 {{/code}}
130
131 * Not an API. This should be internal.
132
133 {{code language="none"}}
134 com.xpn.xwiki.store.XWikiHibernateBaseStore: Method 'protected java.lang.String[] addHibernateSequenceIfRequired(java.lang.String[], java.lang.String, org.hibernate.Session)' has been removed
135 {{/code}}
136
137 * Has been moved to ##xwiki-platform-feed-api## since it was the only module using it. We also dropped jTidy in favor of HTMLCleaner.
138
139 {{code language="none"}}
140 com.xpn.xwiki.util.TidyMessageLogger: Class com.xpn.xwiki.util.TidyMessageLogger removed
141 {{/code}}
142
143 * Google API plugin has been retired
144
145 {{code language="none"}}
146 com.xpn.xwiki.plugin.google.GooglePlugin: Class com.xpn.xwiki.plugin.google.GooglePlugin removed
147 com.xpn.xwiki.plugin.google.GooglePluginApi: Class com.xpn.xwiki.plugin.google.GooglePluginApi removed
148 {{/code}}
149
150 * Return the number of imported documents
151
152 {{code language="none"}}
153 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
154 {{/code}}
155
156 * The JPQLParser generates source code (that should be internal but it is not) and the grammar has changed a bit.
157
158 {{code language="none"}}
159 org.xwiki.query.jpql.analysis.Analysis: Method 'public void caseAFuncnumComparableItem(org.xwiki.query.jpql.node.AFuncnumComparableItem)' has been added to an interface
160 org.xwiki.query.jpql.analysis.Analysis: Method 'public void caseAFuncstrComparableItem(org.xwiki.query.jpql.node.AFuncstrComparableItem)' has been added to an interface
161 org.xwiki.query.jpql.analysis.Analysis: Method 'public void caseAFunctimeComparableItem(org.xwiki.query.jpql.node.AFunctimeComparableItem)' has been added to an interface
162 org.xwiki.query.jpql.analysis.Analysis: Method 'public void caseAPathComparableItem(org.xwiki.query.jpql.node.APathComparableItem)' has been added to an interface
163 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
164 org.xwiki.query.jpql.node.AGroupbyItem: Method 'public org.xwiki.query.jpql.node.PPath getPath()' has been removed
165 org.xwiki.query.jpql.node.AGroupbyItem: Method 'public void setPath(org.xwiki.query.jpql.node.PPath)' has been removed
166 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
167 org.xwiki.query.jpql.node.AOrderbyItem: Method 'public org.xwiki.query.jpql.node.PPath getPath()' has been removed
168 org.xwiki.query.jpql.node.AOrderbyItem: Method 'public void setPath(org.xwiki.query.jpql.node.PPath)' has been removed
169 {{/code}}

Get Connected