Wiki source code of Release Notes for XWiki Enterprise 4.0 Milestone 2
Version 30.1 by Thomas Mortagne on 2012/04/05
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | (% style="font-size:x-large;" %) | ||
| 2 | {{warning}}Before upgrading to this version, be sure to have a working backup of your database(s).{{/warning}} | ||
| 3 | |||
| 4 | {{box cssClass="floatinginfobox" title="**Contents**"}} | ||
| 5 | {{toc/}} | ||
| 6 | {{/box}} | ||
| 7 | |||
| 8 | This is the second and last milestone of the XWiki Enterprise 4.0 version ([[Roadmap>>Main.Roadmap]]). This version mainly introduces various ways of customizing users directory and profiles and it also bring all comments features to annotation (answer, threaded annotation, etc.) by merging the two concepts in one comment with optional precise location. | ||
| 9 | |||
| 10 | = New and Noteworthy (since XWiki Enterprise 4.0 Milestone 2 version) = | ||
| 11 | |||
| 12 | == Extension Manager improvements == | ||
| 13 | |||
| 14 | We improved the way the list of dependencies of an extension is displayed. You can now see the status of each dependency. In the following image you can see for instance that the Commons IO dependency is in conflict with the version of Commons IO bundled with XWiki Enterprise. | ||
| 15 | |||
| 16 | {{image reference="EM-dependencies.png"/}} | ||
| 17 | |||
| 18 | The extension status is also displayed when you view the extension separately. For instance, if you click on the Commons IO dependency link to get more details, you'll see the incompatibility message displayed as below: | ||
| 19 | |||
| 20 | {{image reference="EM-status.png"/}} | ||
| 21 | |||
| 22 | We also improved the search bar to allow users to search in different types of extensions. See below the result for searching "html" in core extensions, i.e. extensions bundled with XWiki Enterprise. | ||
| 23 | |||
| 24 | {{image reference="EM-search.png"/}} | ||
| 25 | |||
| 26 | == Annotations merged with Comments by default == | ||
| 27 | |||
| 28 | Starting with version 4.0M2, annotations have been merged by default with comments. More specifically, this means: | ||
| 29 | |||
| 30 | * You can now reply to an Annotation (threaded annotations) | ||
| 31 | * The Annotations tab has been removed and annotations are now located in the Comments tab where you can see both annotations and comments | ||
| 32 | * The default annotation class is now ##XWiki.XWikiComments## instead of AnnotationCode.AnnotationClass. It also means we've modified the ##XWiki.XWikiComments## class by adding new fields to support annotations (See [[Migration Notes>>||anchor="HAnnotationsApplication]] below). | ||
| 33 | |||
| 34 | {{image reference="annotations-merged-with-comments-screenshot.png"/}} | ||
| 35 | |||
| 36 | == User profile customization == | ||
| 37 | |||
| 38 | An admin can now configure which information is displayed in the user profile (the "Profile" tab of a user's profile page). A new section has been added in the Administration where an admin can configure which fields of the ##XWiki.XWikiUsers## class to display. The admin still has to add the new fields to the class the old way, using the class editor for the page ##XWiki.XWikiUsers##, but he no longer needs to write any code. | ||
| 39 | |||
| 40 | {{image reference="userProfileCustomizer-screenshot.png"/}} | ||
| 41 | |||
| 42 | == User directory improvements and user customized view == | ||
| 43 | |||
| 44 | The User Directory can now display, as columns, filterable and sortable properties of users, as opposed to the previous version where you just had a fixed column that displayed a composed name in the form "first_name last_name (profilePageID)". | ||
| 45 | |||
| 46 | In addition, each user can now customize his view over the User Directory by adding or removing columns, or resetting it to the default columns. | ||
| 47 | |||
| 48 | The default displayed columns are "first_name" and "last_name", and the unmodifiable columns (that will always be displayed as first columns) are "_avatar" and "doc.fullName". | ||
| 49 | |||
| 50 | {{image reference="customizableUserDirectory-customize.png"/}} | ||
| 51 | |||
| 52 | {{info}}In the near future, we're planning to allow Admins to customize globally the User Directory for all users too.{{/info}} | ||
| 53 | |||
| 54 | == ColorThemes gradients customizable from ColorTheme Wizard == | ||
| 55 | |||
| 56 | In version [[3.4>>xwiki:ReleaseNotes.ReleaseNotesXWikiEnterprise34]] we deprecated the old default bundled ColorThemes (because of incompatible variable mix). In version 4.0 this is no longer the case, old default bundled ColorThemes (like [[Bordo>>extensions:Extension.Bordo ColorTheme]], [[Nature>>extensions:Extension.Nature ColorTheme]], etc.) are now being compatible with the 3.4 Colibri Skin changes. We fixed this by adding new gradient ColorThemes variables. All these gradient ColorTheme variables are now changeble from the ColorTheme Wizard. | ||
| 57 | |||
| 58 | {{image reference="ColorThemeWizard.png"/}} | ||
| 59 | |||
| 60 | = Bug fixes and improvements = | ||
| 61 | |||
| 62 | 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.0-milestone-2%22&tempMax=1000]] fixed in this release. | ||
| 63 | |||
| 64 | = For Developers = | ||
| 65 | |||
| 66 | == New Velocity tool to serialize Java objects to JSON format == | ||
| 67 | |||
| 68 | We introduced a new Velocity tool to be able to serialize Java objects to the JSON format. Checkout the [[documentation>>doc:extensions:Extension.Velocity Module||anchor="HJSONTool"]]. Here's an example that shows how to serialize a Map object: | ||
| 69 | |||
| 70 | {{code}} | ||
| 71 | {{velocity}} | ||
| 72 | #set($map = {'name': 'xwiki', 'values': [1, 2, 3], 'enabled': true}) | ||
| 73 | $jsontool.serialize($map) | ||
| 74 | {{/velocity}} | ||
| 75 | {{/code}} | ||
| 76 | |||
| 77 | The result is: | ||
| 78 | |||
| 79 | {{code language="none"}} | ||
| 80 | {"name":"xwiki","values":[1,2,3],"enabled":true} | ||
| 81 | {{/code}} | ||
| 82 | |||
| 83 | We also refactored ##XWiki.LiveTableResultsMacros## page to generate the live table JSON in memory using a Map, which is serialized in the end using the new JSON tool. This makes it easier to customize the live table JSON. For example this is how the JSON for the AppWithinMinutes applications live table is generated: | ||
| 84 | |||
| 85 | {{code}} | ||
| 86 | {{include document="XWiki.LiveTableResultsMacros" /}} | ||
| 87 | |||
| 88 | {{velocity}} | ||
| 89 | #if($xcontext.action == 'get' && "$!{request.outputSyntax}" == 'plain') | ||
| 90 | $response.setContentType('application/json') | ||
| 91 | #set($map = {}) | ||
| 92 | #gridresult_buildJSON("$!request.classname" $request.collist.split(',') $map) | ||
| 93 | ## Change the URL and permission for the edit and delete actions: | ||
| 94 | ## * edit action must trigger the AppWithinMinutes wizard. | ||
| 95 | ## * delete action must delete the application space. | ||
| 96 | #foreach($row in $map.get('rows')) | ||
| 97 | #set($editQueryString = "appName=$escapetool.url($row.get('doc_space'))") | ||
| 98 | #set($discard = $row.put('doc_edit_url', $xwiki.getURL('AppWithinMinutes.CreateApplication', 'view', $editQueryString))) | ||
| 99 | #if($row.get('doc_hasdelete')) | ||
| 100 | ## Deleting an application requires space administration rights. | ||
| 101 | #set($discard = $row.put('doc_hasdelete', $xwiki.hasAccessLevel('admin', $xcontext.user, "${row.get('doc_space')}.WebPreferences"))) | ||
| 102 | #end | ||
| 103 | #set($rowDocRef = $services.model.createDocumentReference($row.get('doc_wiki'), $row.get('doc_space'), $row.get('doc_name'))) | ||
| 104 | #set($discard = $row.put('doc_delete_url', $xwiki.getURL($rowDocRef, 'deletespace', ''))) | ||
| 105 | #end | ||
| 106 | $jsontool.serialize($map) | ||
| 107 | #end | ||
| 108 | {{/velocity}} | ||
| 109 | {{/code}} | ||
| 110 | |||
| 111 | == Class reference always local == | ||
| 112 | |||
| 113 | The class reference is now stored as a local reference in the BaseObject/BaseCollection which means that like in the storage you can't assign a class coming from another wiki to an xobject which was causing some issue when copying wikis. You can still provide absolute reference but the wiki reference will be automatically removed. | ||
| 114 | |||
| 115 | == Upgrades == | ||
| 116 | |||
| 117 | The following dependencies have been upgraded: | ||
| 118 | |||
| 119 | * Json-lib 2.4 | ||
| 120 | |||
| 121 | = Tested Browsers = | ||
| 122 | |||
| 123 | 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]]): | ||
| 124 | |||
| 125 | {{browser name="firefox" version="11.0"/}} | ||
| 126 | |||
| 127 | {{browser name="chrome" version="18"/}} | ||
| 128 | |||
| 129 | = Tested Databases = | ||
| 130 | |||
| 131 | TODO: Sorin please add information here | ||
| 132 | |||
| 133 | = Known issues = | ||
| 134 | |||
| 135 | * [[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]] | ||
| 136 | |||
| 137 | = Test Report = | ||
| 138 | |||
| 139 | You can check the [[manual test report>>TestReports.ManualTestReportXE40M2]] to learn about what was tested and the results on various browsers. | ||
| 140 | |||
| 141 | = Backward Compatibility and Migration Notes = | ||
| 142 | |||
| 143 | == General Notes == | ||
| 144 | |||
| 145 | {{info}} | ||
| 146 | 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. | ||
| 147 | {{/info}} | ||
| 148 | |||
| 149 | You may also want to [[import the default wiki XAR>>Main.Download]] in order to benefit from all the improvements listed above. | ||
| 150 | |||
| 151 | {{warning}} | ||
| 152 | 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. | ||
| 153 | {{/warning}} | ||
| 154 | |||
| 155 | == Annotations Application == | ||
| 156 | |||
| 157 | If you were/are using a custom annotations class, other than the previously default AnnotationsCode.AnnotationsClass, in the annotations configuration then the merging-with-comments feature will not be available to you. What you can do is to enable back the Annotations tab by going to the Administration > Look and Feel > Page Elements and changing the value of "Show document annotations " from "No" to "Yes". Now you will still be able to use your custom annotations without being affected by the changes. | ||
| 158 | |||
| 159 | Also, a migration script will automatically convert all your existing default annotations (that are using the default AnnotationCode.AnnotationClass) to the new default class (XWiki.XWikiComments). After the migration, the new database version will be 40001. | ||
| 160 | |||
| 161 | == User profile customization == | ||
| 162 | |||
| 163 | If you have a customized user profile tab (you have edited the "XWiki.XWikiUserProfileSheet" page), pay attention when importing the default XAR. If you want keep your customization and don't use the new User Profile Customization UI, just skip the "XWiki.XWikiUserProfileSheet" page. Also, if you do so, the new "User Profile" section in Administration will be useless. | ||
| 164 | |||
| 165 | == API Breakages == | ||
| 166 | |||
| 167 | The following APIs were modified since version 3.5: | ||
| 168 | |||
| 169 | {{code language="none"}} | ||
| 170 | ERROR: 7012: org.xwiki.component.descriptor.ComponentRole: Method 'public java.lang.reflect.Type getRoleType()' has been added to an interface | ||
| 171 | ERROR: 7012: org.xwiki.component.manager.ComponentManager: Method 'public org.xwiki.component.descriptor.ComponentDescriptor getComponentDescriptor(java.lang.reflect.Type, java.lang.String)' has been added to an interface | ||
| 172 | ERROR: 7012: org.xwiki.component.manager.ComponentManager: Method 'public java.util.List getComponentDescriptorList(java.lang.reflect.Type)' has been added to an interface | ||
| 173 | ERROR: 7012: org.xwiki.component.manager.ComponentManager: Method 'public boolean hasComponent(java.lang.reflect.Type)' has been added to an interface | ||
| 174 | ERROR: 7012: org.xwiki.component.manager.ComponentManager: Method 'public boolean hasComponent(java.lang.reflect.Type, java.lang.String)' has been added to an interface | ||
| 175 | ERROR: 7012: org.xwiki.component.manager.ComponentManager: Method 'public java.lang.Object lookupComponent(java.lang.reflect.Type)' has been added to an interface | ||
| 176 | ERROR: 7012: org.xwiki.component.manager.ComponentManager: Method 'public java.lang.Object lookupComponent(java.lang.reflect.Type, java.lang.String)' has been added to an interface | ||
| 177 | ERROR: 7012: org.xwiki.component.manager.ComponentManager: Method 'public java.util.List lookupList(java.lang.reflect.Type)' has been added to an interface | ||
| 178 | ERROR: 7012: org.xwiki.component.manager.ComponentManager: Method 'public java.util.Map lookupMap(java.lang.reflect.Type)' has been added to an interface | ||
| 179 | ERROR: 7012: org.xwiki.component.manager.ComponentManager: Method 'public void unregisterComponent(java.lang.reflect.Type, java.lang.String)' has been added to an interface | ||
| 180 | ERROR: 7012: org.xwiki.component.manager.ComponentManager: Method 'public void unregisterComponent(org.xwiki.component.descriptor.ComponentDescriptor)' has been added to an interface | ||
| 181 | ERROR: 7002: org.xwiki.component.annotation.DefaultComponentDependencyFactory: Method 'protected java.lang.Class getFieldRole(java.lang.reflect.Field)' has been removed | ||
| 182 | ERROR: 8001: org.xwiki.bridge.AttachmentName: Class org.xwiki.bridge.AttachmentName removed | ||
| 183 | ERROR: 7002: org.xwiki.bridge.DocumentAccessBridge: Method 'public java.io.InputStream getAttachmentContent(org.xwiki.bridge.AttachmentName)' has been removed | ||
| 184 | ERROR: 7002: org.xwiki.bridge.DocumentAccessBridge: Method 'public java.lang.String getAttachmentURL(org.xwiki.bridge.AttachmentName, boolean)' has been removed | ||
| 185 | ERROR: 7002: org.xwiki.bridge.DocumentAccessBridge: Method 'public java.util.List getAttachmentURLs(org.xwiki.bridge.DocumentName, boolean)' has been removed | ||
| 186 | ERROR: 7002: org.xwiki.bridge.DocumentAccessBridge: Method 'public java.util.List getAttachments(org.xwiki.bridge.DocumentName)' has been removed | ||
| 187 | ERROR: 7002: org.xwiki.bridge.DocumentAccessBridge: Method 'public org.xwiki.bridge.DocumentName getCurrentDocumentName()' has been removed | ||
| 188 | ERROR: 7002: org.xwiki.bridge.DocumentAccessBridge: Method 'public org.xwiki.bridge.DocumentModelBridge getDocument(org.xwiki.bridge.DocumentName)' has been removed | ||
| 189 | ERROR: 7002: org.xwiki.bridge.DocumentAccessBridge: Method 'public org.xwiki.bridge.DocumentName getDocumentName(java.lang.String)' has been removed | ||
| 190 | ERROR: 7002: org.xwiki.bridge.DocumentModelBridge: Method 'public org.xwiki.bridge.DocumentName getDocumentName()' has been removed | ||
| 191 | ERROR: 8001: org.xwiki.bridge.DocumentName: Class org.xwiki.bridge.DocumentName removed | ||
| 192 | ERROR: 4001: org.xwiki.gwt.user.client.ui.ListBox: Removed com.google.gwt.event.dom.client.KeyDownHandler from the set of implemented interfaces | ||
| 193 | ERROR: 4001: org.xwiki.gwt.user.client.ui.ListBox: Removed com.google.gwt.event.dom.client.KeyPressHandler from the set of implemented interfaces | ||
| 194 | ERROR: 4001: org.xwiki.gwt.user.client.ui.ListBox: Removed com.google.gwt.event.dom.client.KeyUpHandler from the set of implemented interfaces | ||
| 195 | ERROR: 7002: org.xwiki.gwt.user.client.ui.ListBox: Method 'public void onKeyDown(com.google.gwt.event.dom.client.KeyDownEvent)' has been removed | ||
| 196 | ERROR: 7002: org.xwiki.gwt.user.client.ui.ListBox: Method 'public void onKeyPress(com.google.gwt.event.dom.client.KeyPressEvent)' has been removed | ||
| 197 | ERROR: 7002: org.xwiki.gwt.user.client.ui.ListBox: Method 'public void onKeyUp(com.google.gwt.event.dom.client.KeyUpEvent)' has been removed | ||
| 198 | ERROR: 7006: org.xwiki.test.ui.browser.IgnoreBrowser: Return type of method 'public java.lang.String[] value()' has been changed to java.lang.String | ||
| 199 | ERROR: 7012: org.xwiki.test.ui.browser.IgnoreBrowser: Method 'public java.lang.String version()' has been added to an interface | ||
| 200 | ERROR: 7002: org.xwiki.test.ui.po.CommentsTab: Method 'public void clickAddComment()' has been removed | ||
| 201 | ERROR: 7002: org.xwiki.test.ui.po.CommentsTab: Method 'public void clickSaveComment()' has been removed | ||
| 202 | ERROR: 7002: org.xwiki.test.ui.po.CommentsTab: Method 'public void setCommentContent(java.lang.String)' has been removed | ||
| 203 | ERROR: 8001: org.xwiki.test.ui.po.DeleteConfirmationPage: Class org.xwiki.test.ui.po.DeleteConfirmationPage removed | ||
| 204 | ERROR: 8001: org.xwiki.test.ui.po.DeletePage: Class org.xwiki.test.ui.po.DeletePage removed | ||
| 205 | ERROR: 7006: org.xwiki.test.ui.po.ViewPage: Return type of method 'public org.xwiki.test.ui.po.DeletePage delete()' has been changed to org.xwiki.test.ui.po.ConfirmationPage | ||
| 206 | ERROR: 4001: org.xwiki.gwt.wysiwyg.client.plugin.line.IELinePlugin: Removed com.google.gwt.event.dom.client.KeyDownHandler from the set of implemented interfaces | ||
| 207 | ERROR: 4001: org.xwiki.gwt.wysiwyg.client.plugin.line.IELinePlugin: Removed com.google.gwt.event.dom.client.KeyPressHandler from the set of implemented interfaces | ||
| 208 | ERROR: 4001: org.xwiki.gwt.wysiwyg.client.plugin.line.IELinePlugin: Removed com.google.gwt.event.dom.client.KeyUpHandler from the set of implemented interfaces | ||
| 209 | ERROR: 4001: org.xwiki.gwt.wysiwyg.client.plugin.line.IELinePlugin: Removed com.google.gwt.event.shared.EventHandler from the set of implemented interfaces | ||
| 210 | ERROR: 4001: org.xwiki.gwt.wysiwyg.client.plugin.line.LinePlugin: Removed com.google.gwt.event.dom.client.KeyDownHandler from the set of implemented interfaces | ||
| 211 | ERROR: 4001: org.xwiki.gwt.wysiwyg.client.plugin.line.LinePlugin: Removed com.google.gwt.event.dom.client.KeyPressHandler from the set of implemented interfaces | ||
| 212 | ERROR: 4001: org.xwiki.gwt.wysiwyg.client.plugin.line.LinePlugin: Removed com.google.gwt.event.dom.client.KeyUpHandler from the set of implemented interfaces | ||
| 213 | ERROR: 4001: org.xwiki.gwt.wysiwyg.client.plugin.line.LinePlugin: Removed com.google.gwt.event.shared.EventHandler from the set of implemented interfaces | ||
| 214 | ERROR: 7002: org.xwiki.gwt.wysiwyg.client.plugin.line.LinePlugin: Method 'public void onKeyDown(com.google.gwt.event.dom.client.KeyDownEvent)' has been removed | ||
| 215 | ERROR: 7002: org.xwiki.gwt.wysiwyg.client.plugin.line.LinePlugin: Method 'public void onKeyPress(com.google.gwt.event.dom.client.KeyPressEvent)' has been removed | ||
| 216 | ERROR: 7002: org.xwiki.gwt.wysiwyg.client.plugin.line.LinePlugin: Method 'public void onKeyUp(com.google.gwt.event.dom.client.KeyUpEvent)' has been removed | ||
| 217 | ERROR: 7004: org.xwiki.gwt.wysiwyg.client.plugin.list.ListBehaviorAdjuster: In method 'public ListBehaviorAdjuster()' the number of arguments has changed | ||
| 218 | ERROR: 7002: org.xwiki.gwt.wysiwyg.client.plugin.list.ListBehaviorAdjuster: Method 'protected void dispatchKey(com.google.gwt.user.client.ui.Widget, int, org.xwiki.gwt.dom.client.Event)' has been removed | ||
| 219 | ERROR: 7002: org.xwiki.gwt.wysiwyg.client.plugin.list.ListBehaviorAdjuster: Method 'public org.xwiki.gwt.user.client.ui.rta.RichTextArea getTextArea()' has been removed | ||
| 220 | ERROR: 7002: org.xwiki.gwt.wysiwyg.client.plugin.list.ListBehaviorAdjuster: Method 'public void setTextArea(org.xwiki.gwt.user.client.ui.rta.RichTextArea)' has been removed | ||
| 221 | ERROR: 7004: org.xwiki.gwt.wysiwyg.client.plugin.macro.exec.InsertExecutable: In method 'public InsertExecutable(org.xwiki.gwt.wysiwyg.client.plugin.macro.MacroSelector)' the number of arguments has changed | ||
| 222 | ERROR: 7012: org.xwiki.wysiwyg.server.WysiwygEditorConfiguration: Method 'public java.lang.Integer getHistorySize()' has been added to an interface | ||
| 223 | {{/code}} |
