Wiki source code of Release Notes for XWiki 5.2 Milestone 2
Last modified by Thomas Mortagne on 2017/03/24
Hide last authors
| author | version | line-number | content |
|---|---|---|---|
 |
1.1 | 1 | {{box cssClass="floatinginfobox" title="**Contents**"}} |
| 2 | {{toc/}} | ||
| 3 | {{/box}} | ||
| 4 | |||
 |
52.1 | 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. |
| |
1.1 | 6 | |
 |
50.1 | 7 | {{warning}} |
 |
55.3 | 8 | **The support of XWiki Enterprise Manager is stopped**. XWiki Enterprise now comes with the ability to create subwikis by default, see below. |
| |
50.1 | 9 | {{/warning}} |
| 10 | |||
| |
58.2 | 11 | The second milestone of the 5.2 release comes with multiwiki support enabled by default: users are able to create new wikis without the need to install additional extensions. This is possible because the Workspace Application has been integrated in XWiki Enterprise. Besides this, the new release brings a Solr-based live search (to replace the one based on Lucene) and the ability to track active XWiki installs. Developers will be interested by the new WikiStream framework. As with other releases this one has a lot of bug fixes (92) and improvements (33) which make it worth trying. |
| |
1.1 | 12 | |
 |
6.1 | 13 | = New and Noteworthy (since XWiki 5.2 Milestone 1) = |
| |
1.1 | 14 | |
| |
62.1 | 15 | [[Full list of issues fixed and Dashboard for 5.2>>https://jira.xwiki.org/secure/Dashboard.jspa?selectPageId=11602]]. |
| |
1.1 | 16 | |
| |
26.1 | 17 | == Wiki Creation == |
| |
9.1 | 18 | |
| |
26.1 | 19 | XWiki Enterprise comes now with the ability for users to create their own wikis (a.k.a subwikis). This supersedes the notion of "workspace" and consist in the integration of the [[Workspace Application>>extensions:Extension.Workspace Application]] in the default XWiki distribution. |
| |
7.1 | 20 | |
| |
50.1 | 21 | {{image reference="add-wiki.png"/}} |
| 22 | |||
| |
56.1 | 23 | This new menu entry appears only if a wiki template is created first, see below. |
| 24 | |||
| |
26.1 | 25 | === Wiki Creation Right === |
| |
9.1 | 26 | |
| |
26.1 | 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. |
| |
7.1 | 28 | |
| |
56.1 | 29 | === Wikis Section in the Administration === |
| |
26.1 | 30 | |
| |
56.1 | 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 | |||
| |
29.1 | 33 | {{image reference="admin-wikis.png"/}} |
| |
9.1 | 34 | |
| |
32.1 | 35 | === New 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="createwiki1.png"/}} | ||
| 40 | |||
| 41 | {{image reference="createwiki2.png"/}} | ||
| 42 | |||
| |
38.1 | 43 | === XWiki Top Menu === |
| |
33.2 | 44 | |
| |
55.1 | 45 | A new top menu has appeared, near the "Profile" menu. It provides a link to the main wiki and to the Wiki Directory (which used to be the "Workspace Directory" - the list of all created wikis except the main one). |
| |
33.2 | 46 | |
| |
38.1 | 47 | It is only available when more than one wiki is created, to prevent the user who only want a single wiki to have too much elements in the UI. |
| |
33.2 | 48 | |
| |
38.1 | 49 | {{image reference="new-xwiki-menu.png"/}} |
| |
33.2 | 50 | |
| |
56.1 | 51 | {{warning}} |
| 52 | The position of the new menu is still under discussion and may change in XWiki 5.2 final. | ||
| 53 | {{/warning}} | ||
| |
55.1 | 54 | |
| |
51.1 | 55 | == Solr-based search suggest == |
| 56 | |||
| 57 | Starting with this version the [[search suggest>>doc:extensions:Extension.Search Application||anchor="HSearchSuggest"]] feature takes into account the configured search engine. To achieve this we added a new property to ##SearchSuggestSourceClass## that specifies the search engine used by the source. We also created a search suggest service based on Solr and we added search suggest sources that mimic the behaviour of the existing Lucene-based sources. As a result, the search suggest feature is now using Solr by default (as Solr is the default search engine starting with 5.1). | ||
| 58 | |||
| 59 | We also improved the search suggest administration section | ||
| 60 | |||
| |
56.1 | 61 | {{image reference="searchSuggestAdminSection.png"/}} |
| |
51.1 | 62 | |
| 63 | and we simplified the source creation form. | ||
| 64 | |||
| |
56.1 | 65 | {{image reference="searchSuggestSourceForm.png"/}} |
| |
51.1 | 66 | |
| |
20.1 | 67 | == Active Installs Tracking == |
| 68 | |||
| 69 | It' very important for the open source committers to understand how well or how badly they're faring when developing the XWiki open source project. So far we didn't know if the number of people using XWiki was increasing, decreasing or staying stable. This module allows us to know who's using XWiki. | ||
| 70 | |||
| 71 | It does the following: | ||
 |
21.2 | 72 | |
| |
20.1 | 73 | * A client side JAR is bundled with XWiki and it sends a ping with data once per day |
| 74 | * A server side Application is installed on xwiki.org, allowing us to query the data sent and to display a counter of Active Installs of XWiki (i.e. installs for which we've received a ping in the last N days, for example at least one ping in the past month). | ||
| 75 | |||
| 76 | The data sent is anonymous and consists of the following: | ||
| |
21.2 | 77 | |
| |
20.1 | 78 | * A unique id (UUID) representing the XWiki instance. Note that not even the IP is kept and there's no way to find who's having a give UUID (it's generated using Java's UUID implementation) |
| 79 | * The date of the ping | ||
| |
22.2 | 80 | * The version of your XWiki distribution |
| |
20.1 | 81 | * The technical ids and versions of extensions you have installed. |
| 82 | |||
| 83 | This will allow us to present the following data: | ||
| |
21.2 | 84 | |
| |
20.1 | 85 | * Number of total installs of XWiki |
| 86 | * Number of Active Installs | ||
| 87 | * Most used extensions across versions of XWiki | ||
| 88 | * How frequently the XWiki user base upgrades to newer versions of XWiki | ||
| 89 | |||
| |
35.1 | 90 | {{image reference="stats.png"/}} |
| 91 | |||
| |
20.1 | 92 | {{info}} |
| 93 | In the near future we'll offer a UI feature to opt-out (in the Administration pages) but at the moment if you wish to opt-out (please don't, we need your help, knowing who's using us and that it's growing is what keeps us motivated to continue developing XWiki!), then simply remove the ##WEB-INF/lib/xwiki-platform-activeinstalls*## JAR and restart. | ||
| 94 | {{/info}} | ||
| 95 | |||
| |
23.1 | 96 | Reference documentation: |
| |
24.1 | 97 | |
| |
23.1 | 98 | * [[Client side module>>extensions:Extension.Active Installs Client API]]. |
| 99 | * [[Server side module>>extensions:Extension.Active Installs Server Application]]. | ||
| |
21.1 | 100 | |
| |
1.1 | 101 | == Miscellaneous == |
| 102 | |||
| |
3.1 | 103 | * The ##line## [[chart>>doc:extensions:Extension.Chart Macro]] type has two parameters, ##hideShapes## and ##hideLines##, to hide the shapes used to display the data points or to hide the interpolation lines that connect the data points.((( |
| 104 | {{image reference="lineWithoutShapes.png"/}} | ||
| 105 | ))) | ||
| |
15.1 | 106 | * When creating or editing a [[template provider>>doc:extensions:Extension.Administration Application||anchor="HCreatethetemplateprovider"]] the template name field is now mandatory.((( |
| 107 | {{image reference="templateNameMandatory.png"/}} | ||
| 108 | ))) | ||
| |
26.3 | 109 | * New [[Instance Module>>extensions:Extension.Instance Module]] used to compute a unique id for each XWiki instance (used by the [[Active Installs Client API>>extensions:Extension.Active Installs Client API]] |
| |
1.1 | 110 | |
| |
62.1 | 111 | 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-milestone-2%22&tempMax=1000 |
| |
59.2 | 112 | ]] fixed in this release. |
| |
1.1 | 113 | |
| 114 | = For Developers = | ||
| 115 | |||
| |
25.1 | 116 | == New WikiStream framework == |
| |
24.1 | 117 | |
| 118 | Wiki Stream goal is to provide generic API to make easier for different representations of a wiki instance to communicate with each other. | ||
| 119 | |||
| 120 | It's still in a very early stage and the API might change during 5.x but it's already pretty complete and usable and the following streams modules are provided: | ||
| 121 | |||
| 122 | * XWiki instance input (send WikiStream events from various data of the XWiki instance like the documents in the database etc.) | ||
| 123 | * XAR instance output (write a XAR package from WikiStream events) | ||
| 124 | |||
| |
2.1 | 125 | == Forcing IE Compatibility mode == |
| |
1.1 | 126 | |
| |
2.1 | 127 | Now, we force the Compatibility mode for Internet Explorer (IE) browsers to use the latest rendering mode. |
| |
62.1 | 128 | Before, the IE browser displayed all intranet sites in compatibility mode by default. This means that even if the user was using IE9, he saw the content rendered with IE7 standards. Since we don't [[support>>dev:Community.BrowserSupportStrategy]] IE6/7 anymore this lead in displaying broken layout, scrollbars, etc. See [[XWIKI-8907>>https://jira.xwiki.org/browse/XWIKI-8907]]. |
| |
1.1 | 129 | |
 |
11.1 | 130 | == Choosing which types of attachments can be displayed inline (Security) == |
| 131 | |||
| |
61.3 | 132 | In order to prevent XSS via FileUpload, a new feature has been added: you can now specify in ##xwiki.properties## which types of attachment can be displayed inline. |
| 133 | In the "Attachment" section of ##xwiki.properties##, you can either precise a whitelist of mimetypes that can be displayed inline, or precise a blacklist of mimetypes that shouldn't be displayed inline (if you use this configuration, it is strongly advised to blacklist at least ##text/html## and ##text/javascript## mimetypes for security reasons). | ||
| 134 | |||
| |
26.4 | 135 | Note that attachments provided by users having Programming Rights won't be affected by these restrictions. |
| |
11.1 | 136 | |
| |
26.5 | 137 | == Miscellaneous == |
| 138 | |||
| 139 | * Added support for custom facets in Solr search API | ||
| 140 | |||
| |
1.1 | 141 | == Upgrades == |
| 142 | |||
| 143 | The following dependencies have been upgraded: | ||
| 144 | |||
| |
62.1 | 145 | * [[HSQLDB 2.3.0>>https://jira.xwiki.org/browse/XE-1323]] |
| 146 | * [[Groovy 2.1.7>>https://jira.xwiki.org/browse/XCOMMONS-445]] | ||
| |
1.1 | 147 | |
| 148 | = Translations = | ||
| 149 | |||
| 150 | The following translations have been updated: | ||
| 151 | |||
| |
54.1 | 152 | {{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"/}} |
| |
1.1 | 153 | |
| 154 | = Tested Browsers & Databases = | ||
| 155 | |||
| |
21.2 | 156 | {{include reference="TestReports.ManualTestReportXWiki52M2Summary"/}} |
| |
1.1 | 157 | |
| 158 | = Known issues = | ||
| 159 | |||
| |
62.1 | 160 | * [[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]] |
| 161 | * If you're migrating an XWiki instance using PostgreSQL or Oracle you may get [[this error>>https://jira.xwiki.org/browse/XWIKI-9473]] (fixed in XWiki 5.2). The workaround is to remove the ##hibernate_sequence## sequence prior to starting XWiki (for the main wiki and all subwikis). | ||
| |
1.1 | 162 | |
| 163 | = Backward Compatibility and Migration Notes = | ||
| 164 | |||
| 165 | == General Notes == | ||
| 166 | |||
| |
61.2 | 167 | == General Notes == |
| |
1.1 | 168 | |
| |
61.2 | 169 | 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. |
| |
1.1 | 170 | |
| |
59.1 | 171 | == Issues specific to XWiki 5.2 Milestone 2 == |
| 172 | |||
| 173 | * 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:((( | ||
| 174 | {{code}} | ||
| 175 | ... | ||
| 176 | <mapping resource="instance.hbm.xml"/> | ||
| 177 | ... | ||
| 178 | {{/code}} | ||
| 179 | ))) | ||
| |
61.1 | 180 | * 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 |
| 181 | format in XWiki 5.1. | ||
| |
59.1 | 182 | |
| |
1.1 | 183 | == API Breakages == |
| 184 | |||
| |
57.1 | 185 | The following APIs were modified since XWiki 5.1: |
| |
1.1 | 186 | |
| |
57.1 | 187 | * Moved to ##xwiki-commons-legacy-properties## |
| 188 | |||
| |
1.1 | 189 | {{code language="none"}} |
| |
57.1 | 190 | org.xwiki.properties.converter.AbstractCollectionConverter: Class org.xwiki.properties.converter.AbstractCollectionConverter removed |
| |
1.1 | 191 | {{/code}} |
| |
57.1 | 192 | |
| 193 | * This method should never have existed | ||
| 194 | |||
| 195 | {{code language="none"}} | ||
| 196 | org.xwiki.rendering.listener.reference.ResourceType: Method 'public void setScheme(java.lang.String)' has been removed | ||
| 197 | {{/code}} | ||
| 198 | |||
| 199 | * Moved from ##xwiki-rendering-api## to ##xwiki-rendering-xml## | ||
| 200 | |||
| 201 | {{code language="none"}} | ||
| 202 | org.xwiki.rendering.renderer.printer.XHTMLWikiPrinter: Class org.xwiki.rendering.renderer.printer.XHTMLWikiPrinter removed | ||
| 203 | org.xwiki.rendering.renderer.printer.XMLWikiPrinter: Class org.xwiki.rendering.renderer.printer.XMLWikiPrinter removed | ||
| 204 | {{/code}} | ||
| 205 | |||
| 206 | * This field is not meant to be be modified, the final was just forgotten. | ||
| 207 | |||
| 208 | {{code language="none"}} | ||
| 209 | com.xpn.xwiki.XWikiContext: Field TYPE_PROVIDER is now final | ||
| 210 | {{/code}} | ||
| 211 | |||
| 212 | * Has been moved to ##xwiki-platform-feed-api## since it was the only module using it. We also dropped jTidy in favor of HTMLCleaner. | ||
| 213 | |||
| 214 | {{code language="none"}} | ||
| 215 | com.xpn.xwiki.util.TidyMessageLogger: Class com.xpn.xwiki.util.TidyMessageLogger removed | ||
| 216 | {{/code}} | ||
| 217 | |||
| 218 | * Google API plugin has been retired | ||
| 219 | |||
| 220 | {{code language="none"}} | ||
| 221 | com.xpn.xwiki.plugin.google.GooglePlugin: Class com.xpn.xwiki.plugin.google.GooglePlugin removed | ||
| 222 | com.xpn.xwiki.plugin.google.GooglePluginApi: Class com.xpn.xwiki.plugin.google.GooglePluginApi removed | ||
| 223 | {{/code}} | ||
| 224 | |||
| 225 | * Return the number of imported documents | ||
| 226 | |||
| 227 | {{code language="none"}} | ||
| 228 | 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 | ||
| 229 | {{/code}} | ||
| 230 | |||
| 231 | * The JPQLParser generates source code (that should be internal but it is not) and the grammar has changed a bit. | ||
| 232 | |||
| 233 | {{code language="none"}} | ||
| 234 | org.xwiki.query.jpql.analysis.Analysis: Method 'public void caseAFuncnumComparableItem(org.xwiki.query.jpql.node.AFuncnumComparableItem)' has been added to an interface | ||
| 235 | org.xwiki.query.jpql.analysis.Analysis: Method 'public void caseAFuncstrComparableItem(org.xwiki.query.jpql.node.AFuncstrComparableItem)' has been added to an interface | ||
| 236 | org.xwiki.query.jpql.analysis.Analysis: Method 'public void caseAFunctimeComparableItem(org.xwiki.query.jpql.node.AFunctimeComparableItem)' has been added to an interface | ||
| 237 | org.xwiki.query.jpql.analysis.Analysis: Method 'public void caseAPathComparableItem(org.xwiki.query.jpql.node.APathComparableItem)' has been added to an interface | ||
| 238 | 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 | ||
| 239 | org.xwiki.query.jpql.node.AGroupbyItem: Method 'public org.xwiki.query.jpql.node.PPath getPath()' has been removed | ||
| 240 | org.xwiki.query.jpql.node.AGroupbyItem: Method 'public void setPath(org.xwiki.query.jpql.node.PPath)' has been removed | ||
| 241 | 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 | ||
| 242 | org.xwiki.query.jpql.node.AOrderbyItem: Method 'public org.xwiki.query.jpql.node.PPath getPath()' has been removed | ||
| 243 | org.xwiki.query.jpql.node.AOrderbyItem: Method 'public void setPath(org.xwiki.query.jpql.node.PPath)' has been removed | ||
| 244 | {{/code}} |
