Wiki source code of Release Notes for XWiki 8.3 milestone 1
Version 39.3 by Vincent Massol on 2016/08/23
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 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 release brings mostly usability improvements. You now have the ability to export children pages along with the current one in XAR and HTML formats. The rating of the extensions is displayed in the home page. You can easily use a color theme from the main wiki in other subwikis. New hints are displayed in the user profile preferences. Some suggestions are displayed when you try to reach a page or an attachment that does not exist. | ||
| 8 | |||
| 9 | For the developers, some improvements have been done, especially in the Script contexts. | ||
| 10 | |||
| 11 | Finally, more than 30 bugs have been fixed! | ||
| 12 | |||
| 13 | = New and Noteworthy (since XWiki 8.2) = | ||
| 14 | |||
| 15 | [[Full list of issues fixed and Dashboard for 8.3>>http://jira.xwiki.org/secure/Dashboard.jspa?selectPageId=13629]]. | ||
| 16 | |||
| 17 | == Export a page with children == | ||
| 18 | |||
| 19 | It's now possible, for HTML and XAR formats, to export selected children along with the current page: | ||
| 20 | |||
| 21 | ((( | ||
| 22 | {{image reference="export.png"/}} | ||
| 23 | ))) | ||
| 24 | |||
| 25 | == Repository improvements == | ||
| 26 | |||
| 27 | Rating is now displayed in the home page livetable. | ||
| 28 | The number of active installs is displayed for each extension in the home page livetable and in the extension page. | ||
| 29 | |||
| 30 | {{image reference="rating_home.png"/}}{{image reference="exo4.png"/}} | ||
| 31 | |||
| 32 | == Miscellaneous == | ||
| 33 | |||
| 34 | * It's now possible, on a subwiki, to use a color theme coming from the main wiki (global themes):((( | ||
| 35 | {{image reference="FlamingoThemePicker.png"/}} | ||
| 36 | {{image reference="FlamingoThemesHome.png"/}} | ||
| 37 | ))) | ||
| 38 | * The Blog Category Panel now has an entry for All blog posts with a RSS feed for all:((( | ||
| 39 | {{image reference="BlogPanel.png"/}} | ||
| 40 | ))) | ||
| 41 | * Added hints for User Profile Preferences:((( | ||
| 42 | {{image reference="userProfileHints.png"/}} | ||
| 43 | ))) | ||
| 44 | * Added suggestions for the "document not found" and "attachment not found" error screens. The suggestions address minor typos and misspelling (including lower case vs upper case), but also bad location requests: | ||
| 45 | ** Documents: | ||
| 46 | {{image reference="docnotfound-suggestsions-mixed.png"/}} | ||
| 47 | ** Attachments: | ||
| 48 | {{image reference="attachmentnotfound-suggestsions-mixed.png"/}} | ||
| 49 | * It's now possible to customize a Maven repository in ##xwiki.properties## with any Aether property. See [[extensions:Extension.XWiki Commons - Extension - Repository - Maven]]. | ||
| 50 | * It's now possible to change the socket and connection timeouts of a XWiki Repository in xwiki.properties. See [[extensions:Extension.XWiki Commons - Extension - Repository - XWiki]]. | ||
| 51 | * Active installs client now send the memory used by the instance | ||
| 52 | * Debian packages now override standard configuration files handling for ##xwiki.cfg##, ##xwiki.properties## and ##web.xml## to provide 3 ways merge with standard dpkg and apt command line tools | ||
| 53 | |||
| 54 | 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+%3D+%228.3-milestone-1%22&tempMax=1000]] fixed in this release. | ||
| 55 | |||
| 56 | = For Developers = | ||
| 57 | |||
| 58 | == Velocity and Script context improvements == | ||
| 59 | |||
| 60 | ##VelocityContext## and ##ScriptContext## are here since a long time and were not fully a sync leading to many hack having to deal with both (and often forgetting one of the other). | ||
| 61 | |||
| 62 | They are now fully in synch (and if you find a use case where it's not true create a BUG on http://jira.xwiki.org) and VelocityContext is now close to internal detail. From now on if you want to set some binding for whatever script is going to be executed next you should to it trough ##ScriptContext## and completely forget that ##VelocityContext## ever existed in most cases. | ||
| 63 | |||
| 64 | New APIs to help with that: | ||
| 65 | |||
| 66 | * ##VelocityManager#evaluate(Writer out, String templateName, Reader source)## which execute the passed velocity content with the passed template name and write the result in the passed Writer. This method deal with ##VelocityContext## internally | ||
| 67 | * ##ScriptContextManager#getCurrentScriptContext()## should be used when you want to SET something in the current script context so that it end up in a script that might be executed later | ||
| 68 | * ##ScriptContextManager#getScriptContext()## is not new but should be used only if you want to get the ##ScriptContext## exactly as a script would get it (to see if it contains something you want to access), this should be a rare use case. | ||
| 69 | |||
| 70 | Another consequence of this is that you can (finally) do things like: | ||
| 71 | |||
| 72 | {{code}} | ||
| 73 | {{velocity}} | ||
| 74 | ## Setting some script binding in Velocity | ||
| 75 | #set($myvar = "toto") | ||
| 76 | {{/velocity}} | ||
| 77 | |||
| 78 | {{groovy}} | ||
| 79 | // Lets use the script binding that has been set in previous script | ||
| 80 | print myvar | ||
| 81 | {{/groovy}} | ||
| 82 | {{/code}} | ||
| 83 | |||
| 84 | The opposite was already possible but there was some limitations, for example it was impossible to overwrite in groovy a binding that was already in the ##VelocityContext##. | ||
| 85 | |||
| 86 | == Filter framework improvements == | ||
| 87 | |||
| 88 | Thanks to Java 8 now supporting getting method parameter names through reflection, it's not required anymore to use ##@Name## annotation in the definition of a filter. See [[extensions:Extension.Filter Module||anchor="#HAnnotations"]] for more details. | ||
| 89 | |||
| 90 | It's also possible to override the name of the event (which is by default extracted from the method name) using the ##@Name## annotation. | ||
| 91 | |||
| 92 | Filter manager make sure to calculate the event descriptor based on the top most overridden method (usually coming from an interface). Various things were not always properly inherited (like event name or reflection based parameters names). | ||
| 93 | |||
| 94 | == Cache module moved to XWiki Commons == | ||
| 95 | |||
| 96 | This mostly means that you can now use it in commons and rendering modules. Nothing change in the classes or packages names, just need to update group id and artifact id in your build tool. | ||
| 97 | |||
| 98 | == Deprecated and Retired projects == | ||
| 99 | |||
| 100 | * Application Manager moved to https://github.com/xwiki-contrib/xwiki-platform-application-manager, it can still be installed as extension if required | ||
| 101 | |||
| 102 | == Upgrades == | ||
| 103 | |||
| 104 | The following dependencies have been upgraded: | ||
| 105 | |||
| 106 | * [[Jackson 2.8.1>>http://jira.xwiki.org/browse/XCOMMONS-1015]] | ||
| 107 | * [[cssparser 0.9.20>>http://jira.xwiki.org/browse/XCOMMONS-1024]] | ||
| 108 | * [[Infinispan 8.2.4>>http://jira.xwiki.org/browse/XCOMMONS-1046]] | ||
| 109 | * [[JSON-Java 20160810>>http://jira.xwiki.org/browse/XCOMMONS-1045]] | ||
| 110 | * [[Bouncy Castle 1.55>>http://jira.xwiki.org/browse/XCOMMONS-1049]] | ||
| 111 | |||
| 112 | == Miscellaneous == | ||
| 113 | |||
| 114 | * 2 new generic extension points for the Document/Attachment Not Found views: | ||
| 115 | ** [[platform:ExtensionPoint.Document Does Not Exist]] | ||
| 116 | ** [[platform:ExtensionPoint.Attachment Does Not Exist]] | ||
| 117 | * 2 new specific extension points for providing recommendations in the Document/Attachment Not Found views: | ||
| 118 | ** [[platform:ExtensionPoint.Suggestions for Document Does Not Exist]] | ||
| 119 | ** [[platform:ExtensionPoint.Suggestions for Attachment Does Not Exist]] | ||
| 120 | * injected extension repositories can now be associated with a priority | ||
| 121 | |||
| 122 | <other dev stuff to add and link to JIRA for all issues fixed> | ||
| 123 | |||
| 124 | = Translations = | ||
| 125 | |||
| 126 | The following translations have been updated: | ||
| 127 | |||
| 128 | {{language codes="none, none"/}} | ||
| 129 | |||
| 130 | = Tested Browsers & Databases = | ||
| 131 | |||
| 132 | {{warning}} | ||
| 133 | The QA Tests are executed after the release has been done. Thus, they are being prepared now and will be published soon. | ||
| 134 | {{/warning}} | ||
| 135 | |||
| 136 | {{comment}} | ||
| 137 | TODO: uncomment and update with proper link when the report is ready. | ||
| 138 | {{include reference="TestReports.ManualTestReportTemplateSummary"/}} | ||
| 139 | {{/comment}} | ||
| 140 | |||
| 141 | = Performances tests compared to <last super stable version> = | ||
| 142 | |||
| 143 | <a summary of the comparison with latest super stable version> | ||
| 144 | |||
| 145 | More details on <link to the test report>. | ||
| 146 | |||
| 147 | = Known issues = | ||
| 148 | |||
| 149 | * [[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]] | ||
| 150 | |||
| 151 | = Backward Compatibility and Migration Notes = | ||
| 152 | |||
| 153 | == General Notes == | ||
| 154 | |||
| 155 | 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. | ||
| 156 | |||
| 157 | == Issues specific to XWiki 8.3 Milestone 1 == | ||
| 158 | |||
| 159 | === LDAP Module moved to Contrib === | ||
| 160 | |||
| 161 | The module containing among other things the standard LDAP authenticator has been moved to http://github.com/xwiki-contrib/ldap and is not embedded anymore in XE. Starting with 8.3M1 you need to install it if you want to use it. See http://extensions.xwiki.org/xwiki/bin/view/Extension/LDAP/#H8.3.x for more details on what between the XWiki Platform module and the new Contrib Extension. | ||
| 162 | |||
| 163 | === Cache module moved to XWiki Commons === | ||
| 164 | |||
| 165 | The only thing that changed is the id of the modules. If you have any dependency on those you just need to change ##org.xwiki.platform:xwiki-platform-*## to ##org.xwiki.commons:xwiki-commons-*## | ||
| 166 | |||
| 167 | == API Breakages == | ||
| 168 | |||
| 169 | The following APIs were modified since <project> <version - 1>: | ||
| 170 | |||
| 171 | {{comment}} | ||
| 172 | Remove! | ||
| 173 | {{backwardCompatiblityReport version="<version>"/}} | ||
| 174 | {{/comment}} | ||
| 175 | |||
| 176 | = Credits = | ||
| 177 | |||
| 178 | The following people have contributed code to this release (sorted alphabetically): | ||
| 179 | |||
| 180 | <code contributors> |
