Wiki source code of Release Notes for XWiki 6.1
Version 22.1 by Guillaume Delhumeau on 2014/07/07
Hide last authors
| author | version | line-number | content |
|---|---|---|---|
 |
1.1 | 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 | |||
 |
16.4 | 7 | [[Full list of issues fixed and Dashboard for 6.1>>http://jira.xwiki.org/secure/Dashboard.jspa?selectPageId=12290]]. |
| |
1.1 | 8 | |
| |
16.4 | 9 | = New and Noteworthy (since XWiki 6.0.1) = |
| |
1.1 | 10 | |
| 11 | [[Full list of issues fixed and Dashboard for 6.1>>http://jira.xwiki.org/secure/Dashboard.jspa?selectPageId=12290]]. | ||
| 12 | |||
| |
16.4 | 13 | == Improved Active Installs == |
| |
1.1 | 14 | |
| |
16.4 | 15 | The [[Active Installs feature>>extensions:Extension.Active Installs Server Application]] has been improved a lot and a new data format has been set up in order to be able to provide more information, namely: |
| 16 | |||
| 17 | * Graphing of Active Installs counter over time | ||
| 18 | * Display pie charts of XWiki versions, Java versions, Servlet Containers and Databases used for Active Installs | ||
| 19 | |||
| |
16.5 | 20 | {{image reference="ReleaseNotesXWiki61M1@as-dashboard" width="650px"/}} |
| |
16.4 | 21 | |
| 22 | In addition it's now registered in the Applications Panel: | ||
| 23 | |||
| |
16.5 | 24 | {{image reference="[email protected]"/}} |
| |
16.4 | 25 | |
| 26 | == Flamingo Skin improvements == | ||
| 27 | |||
| 28 | * Flamingo skin CSS is now computed at the runtime, using the [[LESS Module>>extensions:Extension.LESS Module]]. | ||
| 29 | * Thanks to this, we have introduced a compatibility between this skin and the old color themes: | ||
| |
17.1 | 30 | [[[[image:[email protected]||width="32%"]]>>attach:[email protected]]] [[[[image:[email protected]||width="32%"]]>>attach:[email protected]]] [[[[image:[email protected]||width="32%"]]>>attach:[email protected]]] [[[[image:[email protected]||width="32%"]]>>attach:[email protected]]] [[[[image:[email protected]||width="32%"]]>>attach:[email protected]]] |
| |
16.4 | 31 | * Flamingo has a simplified Add menu |
| |
17.1 | 32 | [[[[image:[email protected]]]>>attach:[email protected]]] |
| |
22.1 | 33 | * Annotations are back!((( |
| 34 | {{image reference="[email protected]" width="60%"/}} | ||
| 35 | ))) | ||
| |
3.1 | 36 | * The Annotations enabler is now located in the "More Actions" menu:((( |
| |
21.1 | 37 | {{image reference="flamingo-annotations.png"/}} |
| |
3.1 | 38 | ))) |
 |
5.1 | 39 | * The global menu entries have now double functionality (navigation, menu) again :((( |
| |
19.1 | 40 | {{image reference="flamingo-separation.png"/}} |
| |
5.1 | 41 | ))) |
| |
9.1 | 42 | * The log-in form has been improved:((( |
| |
19.1 | 43 | {{image reference="login-flamingo.png" width="60%"/}} |
| |
9.1 | 44 | ))) |
| |
12.1 | 45 | * The skin can now be seen on a smartphone, but it is only a first step to have a fully-usable wiki on mobile phones:((( |
| |
19.1 | 46 | {{image reference="flamingo-phone.png"/}} |
| |
12.1 | 47 | ))) |
| |
14.1 | 48 | * Still for mobiles, we have improved the annotation settings panel:((( |
| |
19.1 | 49 | {{image reference="annotations-phone.png"/}} |
| |
14.1 | 50 | ))) |
| |
16.4 | 51 | * The preview action has been implemented:((( |
| 52 | {{image reference="[email protected]" width="60%"/}} | ||
| 53 | ))) | ||
| 54 | * The user's avatar is now displayed in the main menu:((( | ||
| 55 | {{image reference="[email protected]" width="60%"/}} | ||
| 56 | ))) | ||
| 57 | * 'Share by email' menu entry is moved from 'Page' submenu to 'More actions' submenu:((( | ||
| 58 | {{image reference="[email protected]"/}} | ||
| 59 | ))) | ||
| 60 | * Buttons have now gradients:((( | ||
| 61 | {{image reference="[email protected]"/}} | ||
| 62 | ))) | ||
| |
19.2 | 63 | * To ensure the compatibility with Internet Explorer 8, the Flamingo skin uses [[Respond.js>>https://github.com/scottjehl/Respond]] and [[HTML5Shiv>>https://github.com/aFarkas/html5shiv/]]. It enables CSS3 media queries and HTML5 tags. |
| |
16.4 | 64 | * A lot of polishing have been made too, in order to have a skin usable in production. |
| |
1.1 | 65 | |
| |
17.1 | 66 | == Applications Panel improvements == |
| |
16.4 | 67 | |
| |
18.1 | 68 | * It is now possible to change the width of the panel columns: |
| 69 | |||
| 70 | {{image reference="[email protected]" width="65%"/}} | ||
| 71 | |||
| 72 | * Inside a panel, you can know the current width with the ##$xwikiPanelWidth## variable. | ||
| 73 | |||
| 74 | * The applications panel has been modified to adapt itself to the panel column width. The design is different when the size is small, to look closer to a "dock" bar: | ||
| |
17.1 | 75 | [[[[image:[email protected]||width="32%"]]>>attach:[email protected]]] (on this screenshot you can see the small version on the left, and the normal version on the right). |
| |
16.4 | 76 | |
| 77 | == Extension Manager improvements == | ||
| 78 | |||
| |
19.2 | 79 | * Extension-related jobs (install, uninstall, install plan calculation, etc.) which are not executing on the same namespace can now be run concurrently. You won't be stuck anymore, trying to install an extension when someone else is doing the same thing somewhere else on a farm. |
| 80 | * XWiki now support resolving a Maven extension with a parent from a different Maven repository | ||
| |
16.4 | 81 | |
| |
1.1 | 82 | == Miscellaneous == |
| 83 | |||
| |
16.4 | 84 | * The [[user directory>>extensions:Extension.User Directory Application]] is now displaying the user id (alias) instead of the full user document reference which is too technical:((( |
| |
16.5 | 85 | {{image reference="[email protected]" width="400px"/}} |
| |
16.4 | 86 | ))) |
| 87 | * Added [[ability to configure Pie Chart labels>>extensions:Extension.Chart Macro]] using the ##pie_label_format## property. For example using ##pie_label_format:{0} - {2}## would give:((( | ||
| |
16.5 | 88 | {{image reference="[email protected]"/}} |
| |
16.4 | 89 | ))) |
| 90 | * More HTTP cache settings, configurable using ##xwiki.httpheaders.cache## in ##xwiki.cfg## or ##headers_nocache## in ##XWiki.XWikiPreferences##: | ||
| 91 | ** ##0##: **no Cache-Control header** sent, use the browser's defaults. RFC 2616 only specifies optional behavior in this case | ||
| 92 | ** ##1## (default): **no-cache**; caches must not serve this response in a subsequent response, but the page is stored for the bf-cache | ||
| 93 | ** ##2##: **no-store, no-cache and max-age=0**; the response will never be reused, not even for bf-cache; note that unsaved changes may be lost | ||
| 94 | ** ##3##: **private**; the response will be cached by personal caches, such as a browser cache | ||
| 95 | ** ##4##: **public**; the response may be cached by both personal and shared caches | ||
| |
16.5 | 96 | * "Human" requests like ##view## or ##edit## are not waiting XWiki initialization forever and display a waiting page with initialization progress instead: {{image reference="[email protected]"/}} |
| |
16.4 | 97 | * [[extensions:Extension.SpaceIndex Macro]] has now a new parameter to sort the document by creation date, modification date, or by name. |
| 98 | * User Profile page display email hyperlink (if the email is not obfuscated) on view and preview mode. | ||
| 99 | * The SOLR index synchronization which is automatically run at XWiki startup can now be disabled using ##solr.synchronizeAtStartup## property in ##xwiki.properties## file | ||
| |
1.1 | 100 | |
| 101 | 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+%22<version>%22&tempMax=1000]] fixed in this release. | ||
| 102 | |||
| 103 | = For Developers = | ||
| 104 | |||
| |
16.4 | 105 | == LESS integration == |
| |
1.1 | 106 | |
| |
16.4 | 107 | * We are happy to propose the ability of using the [[LESS preprocessor>>http://lesscss.org/]] directly in XWiki. Right now, it is only able to compile some files located in the skin directory in the WAR. See [[extensions:Extension.LESS Module]]. |
| 108 | * The [[LESS Module>>extensions:Extension.LESS Module]] is now bundled with XWiki Enterprise. | ||
| |
19.2 | 109 | * The LESS Compiler compress the generated CSS. |
| |
16.4 | 110 | * A new component has been added to compute a Color Theme compatible with [[extensions:Extension.Color Theme Application]] from a LESS file. |
| |
1.1 | 111 | |
| |
16.4 | 112 | == New Mail module (Experimental) == |
| |
1.1 | 113 | |
| |
16.4 | 114 | Allows to send mails in Java and from wiki pages. |
| 115 | |||
| 116 | See [[Mail Sender API>>extensions:Extension.Action API]] for all details. | ||
| 117 | |||
| 118 | Example to send an email from a wiki page: | ||
| 119 | |||
| 120 | {{code language="none"}} | ||
| 121 | {{velocity}} | ||
| 122 | #set ($message = $services.mailsender.createMessage("[email protected]", "[email protected]", "subject")) | ||
| 123 | #set ($discard = $message.addPart("text/plain", "text content")) | ||
| 124 | #set ($discard = $message.send()) | ||
| 125 | #set ($discard = $message.waitTillSent(10000)) | ||
| 126 | #foreach ($error in $message.getErrors()) | ||
| 127 | * $error.message | ||
| 128 | #end | ||
| 129 | {{/velocity}} | ||
| 130 | {{/code}} | ||
| 131 | |||
| 132 | == Job module improvements == | ||
| 133 | |||
| |
19.2 | 134 | * Introduced job progress helper API, see [[Job Module>>doc:extensions:Extension.Job Module||anchor="HNotifyaboutprogress"]] for more details. |
| 135 | * A new ##org.xwiki.job.JobExecutor## component has been introduce to replace ##org.xwiki.job.JobManager## (which is now deprecated). This component adds support for parallel execution of jobs and also support grouping jobs that need to be executed in the same thread. | ||
| |
16.4 | 136 | |
| 137 | See [[extensions:Extension.Job Module]] for more details. | ||
| 138 | |||
| 139 | == Log from a script == | ||
| 140 | |||
| 141 | A new API to get a SLF4J Logger has been added to the ##logging## script service. | ||
| 142 | |||
| 143 | {{code language="velocity"}} | ||
| 144 | $services.logging.getLogger('My script').info('Hello {}', 'world') | ||
| 145 | {{/code}} | ||
| 146 | |||
| 147 | == New contextual authorization manager role == | ||
| 148 | |||
| 149 | A new role is now available to ease the replacement of the old Right Service (com.xpn.xwiki.user.api.XWikiRightService). | ||
| 150 | Compared to the old service, the component does not manage authentication which should have been ensured previously if needed. (No redirection to login is ever done) | ||
| 151 | The new component has a similar interface to the AuthorizationManager, but it take care of all external context aspects, like the currently executed macro block, the rendering context restrictions, the dropping of rights, etc... | ||
| 152 | This new role should be used from now on by any component that needs to check rights for the current user, in the current context. | ||
| 153 | |||
| 154 | == New security authorization script service == | ||
| 155 | |||
| 156 | A new script service is now available to access the default AuthorizationManager and the ContextualAuthorizationManager. | ||
| 157 | |||
| 158 | Here is some sample: | ||
| 159 | |||
| 160 | {{code language="velocity"}} | ||
| 161 | #if ($services.security.authorization.hasAccess("edit")) | ||
| 162 | ... show some UI that require edit access on the current document by the current user ... | ||
| 163 | #end | ||
| 164 | #if ($services.security.authorization.hasAccess("edit", "xwiki:Sandbox.TestPage1")) | ||
| 165 | ... show some UI that require edit access on Sandbox.TestPage1 document by the current user ... | ||
| 166 | #end | ||
| 167 | #if ($services.security.authorization.hasAccess("edit", "xwiki:XWiki.User1", "xwiki:Sandbox.TestPage1")) | ||
| 168 | ... show some UI that require edit access on Sandbox.TestPage1 document by XWiki.User1 ... | ||
| 169 | #end | ||
| 170 | {{/code}} | ||
| 171 | |||
| 172 | {{code language="velocity"}} | ||
| 173 | $services.security.authorization.checkAccess("edit") | ||
| 174 | ... do some task that require edit access ... | ||
| 175 | {{/code}} | ||
| 176 | |||
| 177 | In this second sample, the macro will fail with an AccessDeniedException if the right is not allowed. | ||
| 178 | |||
| 179 | == Access to BlockMatchers from velocity scripts == | ||
| 180 | |||
| 181 | To be able to use the ##Block.getBlocks(BlockMatcher, Block.Axes)## method on the rendering blocks in the documents XDOM from velocity, a converter has been introduced that maps string expressions to BlockMatcher objects. The current implementation only supports mapping to ClassBlockMatchers, and allows to get all blocks of a given type from the XDOM. | ||
| 182 | |||
| 183 | {{code language="velocity"}} | ||
| 184 | #foreach($headerBlock in $doc.getDocument().getXDOM().getBlocks("class:HeaderBlock", "DESCENDANT")) | ||
| 185 | ... do something with the header block ... | ||
| 186 | {{/code}} | ||
| 187 | |||
| |
1.1 | 188 | == Upgrades == |
| 189 | |||
| 190 | The following dependencies have been upgraded: | ||
| 191 | |||
| |
16.4 | 192 | * [[Guava 17.0>>http://jira.xwiki.org/browse/XCOMMONS-570]] |
| 193 | * [[Jackson 2.3.3>>http://jira.xwiki.org/browse/XCOMMONS-593]] | ||
| 194 | * [[sisu guice 3.2.1>>http://jira.xwiki.org/browse/XCOMMONS-592]] | ||
| 195 | * [[commons-compress 1.8.1>>http://jira.xwiki.org/browse/XCOMMONS-591]] | ||
| 196 | * [[cssparser 0.9.14>>http://jira.xwiki.org/browse/XCOMMONS-590]] | ||
| 197 | * [[commons-lang 3.3.2>>http://jira.xwiki.org/browse/XCOMMONS-589]] | ||
| 198 | * [[JGroups 3.4.4>>http://jira.xwiki.org/browse/XWIKI-10354]] | ||
| 199 | * [[Groovy 2.3.3>>http://jira.xwiki.org/browse/XCOMMONS-598]] | ||
| 200 | * [[Apache Lucene and Solr 4.8.1>>http://jira.xwiki.org/browse/XWIKI-10357]] | ||
| 201 | * [[commons-collections 4.0>>http://jira.xwiki.org/browse/XCOMMONS-605]] | ||
| 202 | * [[httpclient 4.3.4>>http://jira.xwiki.org/browse/XCOMMONS-606]] | ||
| 203 | * [[commons-beanutils 1.9.2>>http://jira.xwiki.org/browse/XCOMMONS-607]] | ||
| 204 | * [[reflections 0.9.9-RC2>>http://jira.xwiki.org/browse/XCOMMONS-608]] | ||
| |
1.1 | 205 | |
| 206 | == Miscellaneous == | ||
| 207 | |||
| |
16.4 | 208 | * [[XCOMMONS-582>>http://jira.xwiki.org/browse/XCOMMONS-582]]: ##$escapetool.json## should be used instead of ##$escapetool.javascript## for escaping manually constructed JSON; ##$jsontool.serialize## should be used for generating JSON, though, since it is safer. |
| 209 | * All component related API of ##com.xpn.xwiki.web.Utils## are now using the context ##ComponentManager## by default. | ||
| 210 | * We added a new method to the component script service to access the component manager corresponding to a specific namespace:((( | ||
| 211 | {{code language=""}} | ||
| 212 | {{groovy}} | ||
| 213 | def instanceForTestWiki = services.component.getComponentManager("wiki:test").getInstance(SomeRole.class) | ||
| 214 | {{/groovy}} | ||
| 215 | {{/code}} | ||
| 216 | ))) | ||
| 217 | * xwiki.cfg file properties are now accessible through ##org.xwiki.configuration.ConfigurationSource## component with role hint ##xwikicfg## | ||
| 218 | * Complete refactoring of the [[Resource module>>extensions:Extension.Resource API]]. Note that the Action module has been removed and folded into the new Resource module. | ||
| 219 | * The ##getInstance## methods in the [[Component Script Service>>extensions:Extension.Component Module||anchor="HAccessfromScripts"]] are now public and return ##null## if the Component cannot be looked up. A ##getLastError()## method was also added to get the last exception. | ||
| 220 | * New converter for ##java.lang.refect.Type## which allows converting from String to Type and opposite in Velocity and wiki macros parameters for example. | ||
| 221 | * The wiki manager API always returns a descriptor for the main wiki, and if there is no descriptor document it returns a "virtual" one that can be saved. Basically it now means that if a wiki exists there is always a corresponding descriptor, even for the main wiki. | ||
| 222 | * The "skin" parameter in the URL is now taken into account when generating the links to the skin CSS (see: [[XWIKI-10426>>http://jira.xwiki.org/browse/XWIKI-10426]]). | ||
| 223 | * Filesystem Attachment Storage now allows you to disable cleaning of empty directories on startup since on a large installation this may take considerable time. (see: [[XWIKI-10431>>http://jira.xwiki.org/browse/XWIKI-10431]]) | ||
| 224 | * Start of implementation of the [[Resource Reference Serializer>>extensions:Extension.Resource API]] notion, still need more work. | ||
| |
1.1 | 225 | |
| 226 | = Translations = | ||
| 227 | |||
| 228 | The following translations have been updated: | ||
| 229 | |||
| |
16.4 | 230 | {{language codes="da, de, fr"/}} |
| |
1.1 | 231 | |
| 232 | = Tested Browsers & Databases = | ||
| 233 | |||
 |
16.3 | 234 | {{include reference="TestReports.ManualTestReportXWiki61Summary"/}} |
| |
1.1 | 235 | |
| 236 | = Known issues = | ||
| 237 | |||
| 238 | * [[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]] | ||
| 239 | |||
| 240 | = Backward Compatibility and Migration Notes = | ||
| 241 | |||
| 242 | == General Notes == | ||
| 243 | |||
| 244 | 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. | ||
| 245 | |||
| |
16.4 | 246 | == API Breakages == |
| |
1.1 | 247 | |
| |
16.4 | 248 | The following APIs were modified since XWiki 6.0: |
| |
1.1 | 249 | |
| |
16.4 | 250 | * Young APIs |
| |
1.1 | 251 | |
| |
16.4 | 252 | {{code language="none"}} |
| 253 | org.xwiki.activeinstalls.server.DataManager: Method 'public com.google.gson.JsonObject countInstalls(java.lang.String, java.lang.String, java.util.Map)' has been added to an interface | ||
| 254 | org.xwiki.activeinstalls.server.DataManager: Method 'public long getInstallCount(java.lang.String)' has been removed | ||
| 255 | org.xwiki.activeinstalls.server.DataManager: Method 'public com.google.gson.JsonObject searchInstalls(java.lang.String, java.lang.String, java.util.Map)' has been added to an interface | ||
| 256 | org.xwiki.activeinstalls.server.script.ActiveInstallsScriptService: Method 'public long getInstallCount(java.lang.String)' has been removed | ||
| 257 | {{/code}} | ||
| |
1.1 | 258 | |
| 259 | {{code language="none"}} | ||
| |
16.4 | 260 | org.xwiki.crypto.store.CertificateStore: Class org.xwiki.crypto.store.CertificateStore removed |
| 261 | org.xwiki.crypto.store.CertificateStoreException: Class org.xwiki.crypto.store.CertificateStoreException removed | ||
| 262 | org.xwiki.crypto.store.KeyStore: Class org.xwiki.crypto.store.KeyStore removed | ||
| 263 | org.xwiki.crypto.store.KeyStoreException: Class org.xwiki.crypto.store.KeyStoreException removed | ||
| |
1.1 | 264 | {{/code}} |
| |
16.4 | 265 | |
| 266 | * Not supposed to be public | ||
| 267 | |||
| 268 | {{code language="none"}} | ||
| 269 | com.xpn.xwiki.store.XWikiHibernateBaseStore: In method 'protected void createHibernateSequenceIfRequired(java.lang.String, org.hibernate.Session)' the number of arguments has changed | ||
| 270 | com.xpn.xwiki.render.XWikiMacrosMappingRenderer: Removed org.xwiki.observation.EventListener from the set of implemented interfaces | ||
| 271 | com.xpn.xwiki.render.XWikiMacrosMappingRenderer: Method 'public java.util.List getEvents()' has been removed | ||
| 272 | com.xpn.xwiki.render.XWikiMacrosMappingRenderer: Method 'public java.lang.String getName()' has been removed | ||
| 273 | com.xpn.xwiki.render.XWikiMacrosMappingRenderer: Method 'public void onEvent(org.xwiki.observation.event.Event, java.lang.Object, java.lang.Object)' has been removed | ||
| 274 | {{/code}} |
