Wiki source code of Release Notes for XWiki 5.3 Milestone 1
Version 20.1 by Thomas Mortagne on 2013/10/21
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 | <insert description of release here> | ||
| 8 | |||
| 9 | = New and Noteworthy (since XWiki 5.2) = | ||
| 10 | |||
| 11 | [[Full list of issues fixed and Dashboard for 5.3>>http://jira.xwiki.org/secure/Dashboard.jspa?selectPageId=11698]]. | ||
| 12 | |||
| 13 | == <feature N> == | ||
| 14 | |||
| 15 | <description of feature N> | ||
| 16 | |||
| 17 | == Miscellaneous == | ||
| 18 | |||
| 19 | * Some XSS fixes. | ||
| 20 | * By default only results from XE instance pings and for non-snapshot versions are counted in Active Installs. | ||
| 21 | |||
| 22 | 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+%22<version>%22&tempMax=1000]] fixed in this release. | ||
| 23 | |||
| 24 | = For Developers = | ||
| 25 | |||
| 26 | == DocumentReference Locale now taken into account in XWiki#exists and XWiki#getDocument == | ||
| 27 | |||
| 28 | You can now use ##XWiki#exist## method to check for some translation existence too, before that the only way was to either load the XWikiDocument or write your own XWQL or HQL query. | ||
| 29 | |||
| 30 | ##XWiki#getDocument## has been modified accordingly too to be consistent so you don't need to go through ##XWikiDocument#getTranslatedDocument## anymore. | ||
| 31 | |||
| 32 | It also mean that you need to be careful of what Locale is in the DocumentReference with those APIs now. | ||
| 33 | |||
| 34 | == New Extension Manager APIs == | ||
| 35 | |||
| 36 | === Extension sub script services === | ||
| 37 | |||
| 38 | The ##extension## service now expose an extension point for extension related script service so that it's used as entry point for all of them. | ||
| 39 | |||
| 40 | By default the following are provided: | ||
| 41 | |||
| 42 | * $services.extension.core (for core extensions APIs) | ||
| 43 | * $services.extension.local (for local extensions APIs) | ||
| 44 | * $services.extension.installed (for installed extensions APIs) | ||
| 45 | * $services.extension.xar (for XAR extension APIS) | ||
| 46 | |||
| 47 | === Search for installed extension in a specific namespace === | ||
| 48 | |||
| 49 | The following method has been added ##org.xwiki.extension.repository.InstalledExtensionRepository##: | ||
| 50 | |||
| 51 | {{code language="java"}} | ||
| 52 | /** | ||
| 53 | * Search installed extensions based of the provided pattern and only in the passed namespace. | ||
| 54 | * <p> | ||
| 55 | * The pattern is a simple character chain. | ||
| 56 | * | ||
| 57 | * @param pattern the pattern to search | ||
| 58 | * @param namespace the namespace where to search | ||
| 59 | * @param offset the offset from where to start returning search results | ||
| 60 | * @param nb the maximum number of search results to return | ||
| 61 | * @return the found extensions descriptors, empty list if nothing could be found | ||
| 62 | * @throws SearchException error when trying to search provided pattern | ||
| 63 | * @since 5.3M1 | ||
| 64 | */ | ||
| 65 | IterableResult<Extension> searchInstalledExtensions(String pattern, String namespace, int offset, int nb) throws SearchException; | ||
| 66 | {{/code}} | ||
| 67 | |||
| 68 | == XWiki Enterprise Archetype == | ||
| 69 | |||
| 70 | A new archetype is now available to easily create your own product based on XWiki Enterprise. To use: | ||
| 71 | |||
| 72 | {{code}} | ||
| 73 | mvn archetype:generate \ | ||
| 74 | -DarchetypeArtifactId=xwiki-enterprise-archetype \ | ||
| 75 | -DarchetypeGroupId=org.xwiki.enterprise \ | ||
| 76 | -DarchetypeVersion=5.3-milestone-1 | ||
| 77 | {{/code}} | ||
| 78 | |||
| 79 | == XAR plugin improvements == | ||
| 80 | |||
| 81 | The XAR plugin now provides the ability to change values in the XML pages. For example: | ||
| 82 | |||
| 83 | {{code}} | ||
| 84 | <plugin> | ||
| 85 | <groupId>org.xwiki.commons</groupId> | ||
| 86 | <artifactId>xwiki-commons-tool-xar-plugin</artifactId> | ||
| 87 | <configuration> | ||
| 88 | <transformations> | ||
| 89 | <transformation> | ||
| 90 | <file>Blog/WebHome.xml</file> | ||
| 91 | <xpath>/xwikidoc/object/property/itemsPerPage</xpath> | ||
| 92 | <value>100</value> | ||
| 93 | </transformation> | ||
| 94 | <transformation> | ||
| 95 | <artifact>org.xwiki.platform:xwiki-platform-administration-ui</artifact> | ||
| 96 | <file>XWiki/XWikiPreferences.xml</file> | ||
| 97 | <xpath>/xwikidoc/object/property/colorTheme</xpath> | ||
| 98 | <value>ColorThemes.Mint</value> | ||
| 99 | </transformation> | ||
| 100 | </transformations> | ||
| 101 | </configuration> | ||
| 102 | </plugin> | ||
| 103 | {{/code}} | ||
| 104 | |||
| 105 | == Miscellaneous == | ||
| 106 | |||
| 107 | * [[Script Services implementations have been moved outside of the ##internal## package>>dev:Community.JavaCodeStyle||anchor="HPackagenames"]] in order for CLIRR to check them for backward incompatibilities and so that their API are made available in generated Javadoc. | ||
| 108 | |||
| 109 | == Deprecated and Retired projects == | ||
| 110 | |||
| 111 | <description of deprecated and retired projects> | ||
| 112 | |||
| 113 | == Upgrades == | ||
| 114 | |||
| 115 | The following dependencies have been upgraded: | ||
| 116 | |||
| 117 | * [[commons-fileupload 1.3>>http://jira.xwiki.org/browse/XCOMMONS-458]] | ||
| 118 | * [[cssparser 0.9.10>>http://jira.xwiki.org/browse/XCOMMONS-459]] | ||
| 119 | * [[XStream 1.4.5>>http://jira.xwiki.org/browse/XCOMMONS-462]] | ||
| 120 | * [[HttpClient 4.3>>http://jira.xwiki.org/browse/XCOMMONS-460]] | ||
| 121 | * [[Struts 1.3.10>>http://jira.xwiki.org/browse/XWIKI-9582]] | ||
| 122 | |||
| 123 | = Translations = | ||
| 124 | |||
| 125 | The following translations have been updated: | ||
| 126 | |||
| 127 | {{language codes="none, none"/}} | ||
| 128 | |||
| 129 | = Tested Browsers & Databases = | ||
| 130 | |||
| 131 | {{include reference="TestReports.ManualTestReportXWiki53M1Summary"/}} | ||
| 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 | = Backward Compatibility and Migration Notes = | ||
| 138 | |||
| 139 | == General Notes == | ||
| 140 | |||
| 141 | You may also want to [[import the default wiki XAR>>Main.Download]] in order to benefit from all the improvements listed above. | ||
| 142 | |||
| 143 | {{warning}} | ||
| 144 | 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. | ||
| 145 | {{/warning}} | ||
| 146 | |||
| 147 | == Issues specific to XWiki <version> == | ||
| 148 | |||
| 149 | <issues specific to the project> | ||
| 150 | |||
| 151 | == API Breakages == | ||
| 152 | |||
| 153 | The following APIs were modified since <project> <version - 1>: | ||
| 154 | |||
| 155 | {{code language="none"}} | ||
| 156 | <clirr output here> | ||
| 157 | {{/code}} |
