Wiki source code of Release Notes for XWiki 5.0 Milestone 2
Version 10.1 by Thomas Mortagne on 2013/03/20
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 Platform, XWiki Enterprise and XWiki Enterprise Manager. 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.0 Milestone 1) = | ||
| 10 | |||
| 11 | [[Full list of issues fixed and Dashboard for 5.0>>http://jira.xwiki.org/secure/Dashboard.jspa?selectPageId=11493]]. | ||
| 12 | |||
| 13 | == Automatic Paste Cleaning in WYSIWYG Editor == | ||
| 14 | |||
| 15 | Starting with this version, whenever you paste some content into the rich text area of the WYSIWYG Editor that content is (by default) automatically cleaned before being inserted into the rest of the content. | ||
| 16 | |||
| 17 | You can disable the automatic cleaning from the WYSIWYG Editor administration section if you wish: | ||
| 18 | |||
| 19 | {{image reference="WYSIWYGEditor-AdminSection-cleanPasteAutomatically.png"/}} | ||
| 20 | |||
| 21 | == Virtual mode is always enabled == | ||
| 22 | |||
| 23 | Virtual mode and ##multiwiki## is now part of XWiki's model and can no longer be disabled. What this means is that the difference between the 2 main products ([[XE>>enterprise:Main.WebHome]] and [[XEM>>manager:Main.WebHome]]) is getting smaller and smaller. | ||
| 24 | |||
| 25 | In the past, XEM differed from XE by the fact that it allowed the creation of multiple wikis (called subwikis) because it had the property ##xwiki.virtual=1## by default in xwiki.cfg, where as XE had ##xwiki.virtual=0## by default. Coupled with the [[extensions:Extension.Wiki Manager Application]] and the [[extensions:Extension.Workspace Application]] which were bundled by default, this allowed XEM to create and manage subwikis, while XE could not. This was causing confusion to users that had installed one product and later on, found out that they needed the other. | ||
| 26 | |||
| 27 | To avoid confusion and to simplify our development as well, we have defaulted to a virtual mode enabled by default, allowing you to create and manage subwikis/workspaces no matter what product you have downloaded. For instance, if you have downloaded XE, you now only have to install one or two extensions ([[extensions:Extension.Wiki Manager Application]] and/or [[extensions:Extension.Workspace Application]]) using the extension manager and you are all set. Most likely we will also switch to a single product scheme in the future. | ||
| 28 | |||
| 29 | == Replace "xwiki.virtual.redirect" with an error template(or page) == | ||
| 30 | |||
| 31 | This xwiki.cfg setting allowed the admin to redirect to a specified URL an user that tried to access an nonexistent wiki. However, it was enabled by default and the default value was ##http://127.0.0.1:9080/xwiki/bin/Main/ThisWikiDoesNotExist ## which was definitely wrong and was causing more problems than it solved. See {{jira url="http://jira.xwiki.org" style="enum"}}XWIKI-479{{/jira}} for an example. | ||
| 32 | |||
| 33 | We have decided to drop this feature and replace it with an error template ##wikidoesnotexist.vm## that can be overridden by a document in the main wiki named ##XWiki.WikiDoesNotExist##, to be consistent with what we are doing for other XWiki entities (documents, attachments, etc). | ||
| 34 | |||
| 35 | However, to avoid hitting problems with accessing your main wiki, this feature is disabled by default and can be enabled by uncommenting ##xwiki.virtual.failOnWikiDoesNotExist## in ##xwiki.cfg## and setting its value to ##1##. Otherwise, by default, the user will always get server the content of the main wiki if the wiki he requested is not found. | ||
| 36 | |||
| 37 | For those that want to achieve the same behavior as before (by redirecting to a fixed URL every time), they have to enable ##xwiki.virtual.failOnWikiDoesNotExist## in ##xwiki.cfg## and then redirect to the desired URL either in ##wikidoesnotexist.vm## or in the main wiki's ##XWiki.WikiDoesNotExist##. | ||
| 38 | |||
| 39 | == Miscellaneous == | ||
| 40 | |||
| 41 | <insert misc user stuff and important bug fix descriptions here in a list, when they are too small to warrant a section by themselves - Change the version in the URL below!> | ||
| 42 | |||
| 43 | - ##autowww## is not enabled by default {{jira url="http://jira.xwiki.org" style="enum"}}XWIKI-8877{{/jira}} and mandatory (can not be disabled), since with virtual mode enabled by default if could prove problematic to access your main wiki without a proper wiki descriptor set up. The main reason why you could have needed to disable it was if you actually had subwiki named ##www## and you wanted to access it instead of the main wiki. Now the ##autowww## feature checks for this case and serves the right content. | ||
| 44 | |||
| 45 | 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+%225.0-milestone-2%22&tempMax=1000]] fixed in this release. | ||
| 46 | |||
| 47 | = For Developers = | ||
| 48 | |||
| 49 | == Translate log == | ||
| 50 | |||
| 51 | It's possible to provide a translation key with any log to let log displayer use some localization framework to find proper translation for it. | ||
| 52 | |||
| 53 | See [[extensions:Extension.Logging Module||anchor="HTranslatelog"]] for more details. | ||
| 54 | |||
| 55 | == JQuery in XWiki using AMD/Require.js == | ||
| 56 | |||
| 57 | Now with [[require.js>>http://requirejs.org/]] you can pull in jQuery and use it when you need it without incurring the performance penalty when you don't need it. | ||
| 58 | To use jquery, use the script below: | ||
| 59 | |||
| 60 | {{code language="html"}} | ||
| 61 | {{html}} | ||
| 62 | <script> | ||
| 63 | require(['jquery'], function($) { | ||
| 64 | $('#document-title>h1').text('JQuery in action'); | ||
| 65 | }); | ||
| 66 | </script> | ||
| 67 | {{/html}} | ||
| 68 | {{/code}} | ||
| 69 | |||
| 70 | You can learn more about the power of AMD javascript modules by reading [[require.js documentation>>http://requirejs.org/docs/whyamd.html]]. | ||
| 71 | |||
| 72 | == Deprecated and Retired projects == | ||
| 73 | |||
| 74 | <description of deprecated and retired projects> | ||
| 75 | |||
| 76 | == Upgrades == | ||
| 77 | |||
| 78 | The following dependencies have been upgraded: | ||
| 79 | |||
| 80 | * GWT 2.5.1 | ||
| 81 | * JUnit 4.11 | ||
| 82 | * slf4j 1.7.4 | ||
| 83 | * logback 1.0.10 | ||
| 84 | |||
| 85 | == Miscellaneous == | ||
| 86 | |||
| 87 | <other dev stuff to add and link to JIRA for all issues fixed> | ||
| 88 | |||
| 89 | - Added methods to query existing wikis: api.XWiki.getWikiNames() {{jira url="http://jira.xwiki.org" style="enum"}}XWIKI-8841{{/jira}} and api.XWiki.hasSubWikis() {{jira url="http://jira.xwiki.org" style="enum"}}XWIKI-8875{{/jira}} | ||
| 90 | - Virtual mode is now enabled by default so development needs to consider the fact that the main wiki may not be the only wiki available. | ||
| 91 | - With the transition to virtual mode by default, the XWiki.XWikiServerClass is now a mandatory class to be used when creating a wiki descriptor. Its existence will be, like all mandatory classes, checked when XWiki starts, but only for the main wiki. It was formerly initialized by and part of the wiki-manager module but it's now part of the core. Also, the XWiki.XWikiServerClassSheet has been moved to the wiki-manager-ui module. | ||
| 92 | |||
| 93 | = Translations = | ||
| 94 | |||
| 95 | The following translations have been updated: | ||
| 96 | |||
| 97 | {{language codes="none, none"/}} | ||
| 98 | |||
| 99 | = Tested Browsers & Databases = | ||
| 100 | |||
| 101 | {{include reference="TestReports.ManualTestReportTemplateSummary"/}} | ||
| 102 | |||
| 103 | = Known issues = | ||
| 104 | |||
| 105 | * [[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]] | ||
| 106 | |||
| 107 | = Backward Compatibility and Migration Notes = | ||
| 108 | |||
| 109 | == General Notes == | ||
| 110 | |||
| 111 | You may also want to [[import the default wiki XAR>>Main.Download]] in order to benefit from all the improvements listed above. | ||
| 112 | |||
| 113 | {{warning}} | ||
| 114 | 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. | ||
| 115 | {{/warning}} | ||
| 116 | |||
| 117 | == Issues specific to XWiki 5.0 Milestone 2 == | ||
| 118 | |||
| 119 | <issues specific to the project> | ||
| 120 | |||
| 121 | - The translations page for each workspace (xwiki:WorkspaceManager.TemplateTranslations) has been moved to the template (and implicitly locally, on each workspace) in XWiki.WorkspaceTranslations. Existing workspaces will still use any existing xwiki:WorkspaceManager.TemplateTranslations document (registered as translation bundle) that you may still have on the main wiki. New workspaces will use their local XWiki.WorkspaceTranslations document. | ||
| 122 | |||
| 123 | == API Breakages == | ||
| 124 | |||
| 125 | The following APIs were modified since XWiki 4.5.2: | ||
| 126 | |||
| 127 | {{code language="none"}} | ||
| 128 | <clirr output here> | ||
| 129 | {{/code}} |
