Show last authors
1 {{box cssClass="floatinginfobox" title="**Contents**"}}
2 {{toc/}}
3 {{/box}}
4
5 {{warning}}
6 If you are migrating from an earlier version than 4.0, and your database contains statistics collected using a version earlier than 2.2, you will probably encounter an issue during our automated database migration. To avoid that issue, you will need to clean up your statistics by executing some SQL commands described in issue [[XWIKI-8129>>http://jira.xwiki.org/browse/XWIKI-8129]]. Be sure to apply these before attempting the migration. If your are in doubt, apply it, these could not hurt. If you don't, you will face duplicate IDs errors during the migration process, and it will fail, preventing you to run your wiki.
7 {{/warning}}
8
9 {{warning}}
10 If you are upgrading to this version from an older version which uses Lucene 3.x, you have to manually delete the lucene directory in the xwiki data directory. For example, that could cause Lucene to loop endlessly while trying to index pages, among other things. This is caused by the Lucene migration to 4.0 (see [[XWIKI-8404>>http://jira.xwiki.org/browse/XWIKI-8404]]).
11 {{/warning}}
12
13 This is the release notes for XWiki Platform, XWiki Enterprise and XWiki Enterprise Manager. They share the same release notes as they are released together and have the same version.
14
15 This release is the last stabilization release for the 4.x cycle with improvements on Distribution Wizard, SOLR Search and App Within Minutes.
16
17 = New and Noteworthy (since XWiki 4.4.1) =
18
19 == Distribution Wizard improvements ==
20
21 When upgrading from an old version that didn't have the distribution wizard, the wizard doesn't know what user interface (XAR) was previously installed (imported). This information can help the Extension Manager merge automatically the wiki pages from your database with those from the new version of the user interface.
22
23 The distribution wizard will first ask you if you are performing an upgrade.
24
25 {{image reference="DW-previousUiUpgradeQuestion.png"/}}
26
27 Then you need to select the user interface version that was previously installed.
28
29 {{image reference="DW-previousUiForm-01.png"/}}
30
31 The distribution wizard determines the id of the previously imported XAR based on the selected version.
32
33 {{image reference="DW-previousUiForm-02.png"/}}
34
35 You can edit the suggested id if you know you had a different user interface previously installed.
36
37 {{image reference="DW-previousUiForm-03.png"/}}
38
39 Finally you need to repair the specified user interface extension. This will mark the extension as installed (update the extension index without actually importing the wiki pages from the XAR).
40
41 {{image reference="DW-previousUiExtension.png"/}}
42
43 {{image reference="DW-repairPreviousUiExtension.png"/}}
44
45 Next you can install the new version of the user interface.
46
47 == Translatable AppWithinMinutes apps ==
48
49 The AppWithinMinutes wizard is now generating a document translation bundle for the application which allows you to translate class field pretty names, list values (for static list fields) and live table columns names. If you have an existing application that was created with AppWithinMinutes you just have to edit and save it to get the new translation bundle.
50
51 If your wiki is setup for multilingual support then on the application home page, in the application menu, you now have an entry to translate the application. The link takes you to the document translation bundle.
52
53 {{image reference="AWM-translateAppMenu.png"/}}
54
55 When editing an application you now have the option to update the translation bundle. Note that for the moment the translation bundle (its default language) is regenerated so you may lose translation keys you added yourself. In the future we want to update the translation bundle preserving the custom keys.
56
57 {{image reference="AWM-updateTranslationsOption.png"/}}
58
59 See the [[AppWithinMinutes documentation>>extensions:Extension.App Within Minutes Application]] for more information.
60
61 == Experimental Solr search improvements ==
62
63 === Remote Solr instance support ===
64
65 You can now configure the Solr search to use a remote Solr instance instead of the embedded server that runs in the same JVM with XWiki. To do that, you have to:
66 - set the ##solr.type## property inside the ##WEB-INF/xwiki.properties## file from the default value of "embedded" to "remote"
67 - set the ##solr.remote.url## property to the URL where your remote server can be accessed.
68
69 Note: don't forget to uncomment (remove the leading # character) the properties when setting their values. If you do forget, the default values will be used instead of yours.
70
71 There can be various reasons (security, performance, economy, etc.) why you would want to use a remote server instead of the embedded one, but you will have to make sure that you are using (or building on top of) the Solr configuration that XWiki knows how to work with.
72 Once XWiki is started with ##solr.type## set to ##remote##, you can go to the ##XWiki.SolrSearchAdmin## page inside your wiki (main wiki, if using a multiwiki setup) and download the attached ##conf.zip## file. If contains the structure of your the Solr home directory that you can use for your remote instance. Just unzip it in a directory and set that directory to be your Solr home for your remote server.
73
74 === Improved multilingual support ===
75
76 In order to properly index content of various languages and, as a consequence, obtain better search results, we have chosen the single-index-multiple-fields approach.
77
78 This means that, a couple of interesting multilingual index fields (title, doccontent, comment, objcontent, propertyvalue and attcontent) are now configured as field aliases that get automatically expanded at query time to all their configured multilingual variations. Each language "variation" is of the form ##fieldName_language## (title_en, title_fr, title_ro, etc...) and contains the content indexed in a language-specific way. There also exists a ##fieldName_ml## field "variation" that is used as a form of backup, for languages outside the list of already configured ones, but is also useful in everyday queries since it does lighter analysis on the content.
79
80 Example: a query on (title:test) gets converted to (title_ml:test | title_en:test | title_ro:test | title_fr:test | ...)
81
82 Additionally, attachments, objects and object properties are now indexed for each of the languages of the translations of the original document to which they belong. This now allows them to be found when searching for content in a translation of a document and not just content in the language of the original document, as it was before.
83
84 == Miscellaneous ==
85
86 * The message sender is now using the new user/group picker.(((
87 {{image reference="messageSender-userPicker.png"/}}
88 )))
89 * The create and manage workspace forms are now using the new user picker.(((
90 {{image reference="createWorkspace-ownerAndMembers.png"/}}
91 )))
92 * You can now add or invite multiple users at once to an workspace, and the user name field uses the new user picker.(((
93 {{image reference="workspace-administration-users-add-invite.png"/}}
94 )))
95 * We improved the way changes are displayed by emphasizing the in-line changes.(((
96 {{image reference="unifiedDiff.png"/}}
97 )))
98 * Support for searching content in Java Class file attachments [[has been temporarily dropped>>http://jira.xwiki.org/browse/XWIKI-8656]].
99 * Markdown syntax support has been completely rewritten, fixing several existing bugs.
100 * The home page (##Main.WebHome##) can now safely be edited by any user who has edit permission (In earlier releases, the AJAX suggest feature for tags would unexpectedly break if users not having Programming Rights edited the page).
101 * PostGreSQL support for multiwiki mode (see Backward Compatibility notes below and the [[PostGreSQL installation instructions>>platform:AdminGuide.InstallationPostgreSQL]]).
102
103 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%2C+XEM%29+and+status+%3D+Closed+and+resolution+%3D+Fixed+and+fixVersion+%3D+%224.5-milestone-1%22&tempMax=1000]] fixed in this release.
104
105 = For Developers =
106
107 == Embed translations in JAR extension ==
108
109 It's now possible for any JAR to come with it's own translation bundle. For that you need to provide at the root of the JAR a set of ##ApplicationResources.properties## based translations. See [[Localization Module>>extensions:Extension.Localization Module]] for more.
110
111 == Deprecated and Retired projects ==
112
113 No project was retired.
114
115 == Upgrades ==
116
117 No library was upgraded.
118
119 == Miscellaneous ==
120
121 * It is now possible to delegate programming rights directly to a filesystem template to allow it to access the privileged API by adding the template name to the set defined in DefaultPrivilegedTemplateRenderer. Such a template cannot currently access the context document, but this restriction will most likely be removed in 5.0.
122
123 = Translations =
124
125 The following translations have been updated:
126
127 {{language codes="fr,ru,ko,sv"/}}
128
129 = Tested Browsers & Databases =
130
131 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]]):
132
133 {{velocity}}
134 ## name = iexplorer, firefox, chrome, safari, opera
135 {{/velocity}}
136
137 {{browser name="iexplorer" version="8"/}}
138
139 {{browser name="iexplorer" version="9"/}}
140
141 {{browser name="firefox" version="17"/}}
142
143 {{browser name="firefox" version="18"/}}
144
145 Here's the list of databases tested with this version (i.e. databases that we've tested as working - Check the list of [[supported databases>>dev:Community.DatabaseSupportStrategy]]):
146
147 {{velocity}}
148 ## name = hsqldb, mysql, postgresql, oracle, opera
149 {{/velocity}}
150
151 {{database name="hsqldb" version="2.2.9"/}}
152
153 {{database name="oracle" version="11.2"/}}
154
155 {{database name="postgresql" version="8.4.12"/}}
156
157 = Known issues =
158
159 * [[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]]
160
161 = Test Report =
162
163 You can check the [[manual test report>>TestReports.WebHome#<anchor to test report>]] to learn about what was tested and the results on various browsers.
164
165 = Backward Compatibility and Migration Notes =
166
167 == General Notes ==
168
169 {{warning}}
170 PLEASE, BACKUP YOUR DATABASE BEFORE STARTING YOUR WIKI.
171 AUTOMATED MIGRATION PROCEDURE TAKE PLACE AT STARTUP AND YOU MAY NEED TO START OVER IF YOU ENCOUNTER AN UNEXPECTED ISSUE.
172 {{/warning}}
173
174 You may also want to [[import the default wiki XAR>>Main.Download]] in order to benefit from all the improvements listed above.
175
176 {{warning}}
177 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.
178 {{/warning}}
179
180 {{warning}}
181 If you are migrating from an earlier version than 4.0, and your database contains statistics collected using a version earlier than 2.2, you will probably encounter an issue during our automated database migration. To avoid that issue, you will need to clean up your statistics by executing some SQL commands described in issue [[XWIKI-8129>>http://jira.xwiki.org/browse/XWIKI-8129]]. Be sure to apply these before attempting the migration. If your are in doubt, apply it, these could not hurt. If you don't, you will face duplicate IDs errors during the migration process, and it will fail, preventing you to run your wiki.
182 {{/warning}}
183
184 {{warning}}
185 If you have encountered an issue with the migration, you may need to start over from a backup. Be careful that during the migration, two new tables have been created (in each xwiki database for a farm) and should be dropped when you restore a backup of a database coming from a version earlier than 4.x. These two tables are DATABASECHANGELOG and DATABASECHANGELOGLOCK. These should only be removed if you restore a pre-4.x database schema. Mixing an old database with these two tables will surely cause issue during schema updates (liquibase checksum failure).
186 {{/warning}}
187
188 == Issues specific to XWiki 4.5M1 ==
189
190 * Changes in the experimental Solr implementation
191 ** The ##xwiki.properties## file now contains solr specific configuration, please make sure to merge it with your own. If you were previously using the ##search.solr.home## property to specify your own index directory, you need to use the new ##solr.embedded.home## property, as specified in the xwiki.properties file.
192 ** The Solr index and configuration files have suffered major changes. When upgrading, you need to delete the ##<permanentDirectory>/solr## directory so that Solr can reinitialize it with the new configuration and index structure. Also, a reindexation is obviously required.
193 * The new default mode for PostGreSQL is the ##schema## mode, i.e. new wikis are created as schema. Previously the default was ##database## but [[there are still issues with it>>http://jira.xwiki.org/browse/XWIKI-8753]]. The configuration is done in ##hibernate.cfg.xml## by setting {{code}}<property name="xwiki.virtual_mode">schema|database</property>{{/code}}.
194
195 == API Breakages ==
196
197 The following APIs were modified since XWiki 4.4.1:
198
199 * New method to access bundle:(((
200 {{code language="none"}}
201 org.xwiki.localization.LocalizationManager: Method 'public org.xwiki.localization.TranslationBundle getTranslationBundle(java.lang.String, java.lang.String)' has been added to an interface
202 {{/code}}
203 )))