Wiki source code of Release Notes for XWiki 5.1 Release Candidate 1
Last modified by Thomas Mortagne on 2017/03/24
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 Platform, XWiki Enterprise and XWiki Enterprise Manager. They share the same release notes as they are released together and have the same version. | ||
| 6 | |||
 |
20.1 | 7 | This is mostly a stabilization release leading to XWiki 5.1 and it brings Sorl search improvements and bug fixes as we plan to make Solr the default search engine in 5.1 final. There is also a new Menu Application in platform (not bundled by default) to help you create navigation menus. |
| |
1.1 | 8 | |
| 9 | = New and Noteworthy (since XWiki 5.1 Milestone 2) = | ||
| 10 | |||
 |
24.1 | 11 | [[Full list of issues fixed and Dashboard for 5.1>>https://jira.xwiki.org/secure/Dashboard.jspa?selectPageId=11595]]. |
| |
1.1 | 12 | |
| |
17.1 | 13 | == Menu Application == |
| 14 | |||
| |
19.1 | 15 | We have rewritten the [[Navigation Menu Wiki Macro>>doc:extensions:Extension.Navigation Menu Wiki Macro]] and the [[Navigation Menu Config Application>>doc:extensions:Extension.NavigationMenuConfig]] into a single application that can help you create navigation menus to be displayed either horizontally as a top bar after the page header or vertically in a side panel. See the documentation page of the new [[Menu Application>>doc:extensions:Extension.Menu Application]] for details. |
| |
17.1 | 16 | |
| |
19.1 | 17 | {{image reference="menuViewPage.png"/}} |
| 18 | |||
| |
11.1 | 19 | == Solr improvements == |
| |
1.1 | 20 | |
| |
11.1 | 21 | * at each startup a synchronization background job is started to make sure solr index and database are in sync (only update what needs to be updated) |
| |
12.1 | 22 | * ##name_exact## property has been added to document model in solr index to allow doing exact matching on a document (for example when search a specific document and several have similar names) |
| 23 | * ##doclocale## property is now stored in Solr index to indicate the technical locale of the document in database (##locale## contains the real locale after resolving default locale for default entry) | ||
| |
1.1 | 24 | |
| 25 | == Miscellaneous == | ||
| 26 | |||
| |
8.1 | 27 | * We changed the dashboard to display the gadget actions when hovering the gadget.((( |
| 28 | {{image reference="gadgetActions.png"/}} | ||
| 29 | ))) | ||
| |
15.3 | 30 | * More documents marked as hidden by default: ##Blog.News, Blog.Other, Blog.Personal, Main.Activity, Main.MessageSenderMacro, Main.Tags, Sandbox.WebPreferences, XWiki.WebHome, XWiki.XWikiAdminGroup, XWiki.XWikiAllGroup, XWiki.SearchConfig## |
| |
1.1 | 31 | |
| |
3.1 | 32 | == Full Issue List == |
| |
1.1 | 33 | |
| |
24.1 | 34 | {{jira style="list" url="https://jira.xwiki.org" fields="type, status, key, summary" source="jql"}} |
| |
3.1 | 35 | Project in ("XWiki Commons", "XWiki Rendering", "XWiki Platform", "XWiki Enterprise", "XWiki Enterprise Manager") and fixVersion in ("5.1-rc-1") and resolution in ("Fixed") and component not in ("Build, Infrastructure and Tests") |
| 36 | {{/jira}} | ||
| 37 | |||
| |
1.1 | 38 | = For Developers = |
| 39 | |||
| |
6.1 | 40 | == Merging WARs with Packager plugin == |
| |
1.1 | 41 | |
| |
6.1 | 42 | We added a ##contextPathMapping## configuration parameter to the Packager Maven plugin to allow us to bind WAR artifact IDs to the context path where they should be extracted. Here's an example: |
| |
1.1 | 43 | |
| |
6.1 | 44 | {{code language="xml"}} |
| 45 | <plugin> | ||
| 46 | <groupId>org.xwiki.platform</groupId> | ||
| 47 | <artifactId>xwiki-platform-tool-packager-plugin</artifactId> | ||
| 48 | ... | ||
| 49 | <configuration> | ||
| 50 | <contextPathMapping> | ||
| 51 | <!-- Merge the WYSIWYG editor WAR with the platform web WAR. --> | ||
| 52 | <xwiki-platform-wysiwyg-war>xwiki</xwiki-platform-wysiwyg-war> | ||
| 53 | </contextPathMapping> | ||
| 54 | </configuration> | ||
| 55 | </plugin> | ||
| 56 | {{/code}} | ||
| 57 | |||
| 58 | The Packager plugin looks for WAR artifacts in the list of dependencies. If no WAR-type dependencies are found then the following WARs are used, with the corresponding default context path binding: | ||
| 59 | |||
| 60 | {{code language="none"}} | ||
| 61 | xwiki-platform-web: xwiki | ||
| 62 | xwiki-platform-tool-rootwebapp: root | ||
| 63 | {{/code}} | ||
| 64 | |||
| 65 | If more WARs share the same context path then they are merged. Of course, in this case the order in the list of dependencies is important because the last WAR can overwrite files from the previous ones. When no mapping is defined for a WAR, its artifact id is used instead as context path. | ||
| 66 | |||
| |
13.1 | 67 | == Miscellaneous == |
| 68 | |||
| |
23.1 | 69 | * A new [[UI extension point>>doc:extensions:Extension.UIExtension Module]] is available: ##org.xwiki.platform.template.header.after##. See the list of [[available UIXs>>doc:extensions:Extension.UIExtension Module||anchor="HAvailableUIExtensionPoints"]] for more information. |
| |
14.1 | 70 | * Jobs don't share the same ##ExecutionContext## anymore. |
| 71 | * The WYSIWYG editor administration section has been moved from the [[Administration Application>>doc:extensions:Extension.Administration Application]] to its own module under ##xwiki-platform-wysiwyg##. | ||
| 72 | * A new Runnable wrapper to initialize and dispose ##ExecutionContext##:((( | ||
| 73 | {{code language="java"}} | ||
| 74 | Thread thread = new Thread(new ExecutionContextRunnable(runnable, componentManger)); | ||
| 75 | thread.start(); | ||
| 76 | {{/code}} | ||
| 77 | ))) | ||
| 78 | * A new method to add a custom Job to the JobManager:((( | ||
| 79 | {{code language="java"}} | ||
| 80 | Job myjob = new MyJob(); | ||
| 81 | this.jobManager.addJob(myjob); | ||
| 82 | {{/code}} | ||
| 83 | ))) | ||
| |
15.3 | 84 | * It's now possible to write Rendering Integration tests using Mockito. For example:((( |
| |
13.1 | 85 | {{code language="java"}} |
| 86 | @RunWith(RenderingTestSuite.class) | ||
| 87 | @RenderingTestSuite.Scope("wiki") | ||
| 88 | @AllComponents | ||
| 89 | public class WikiIntegrationTests | ||
| 90 | { | ||
| 91 | @RenderingTestSuite.Initialized | ||
| 92 | public void initialize(MockitoComponentManager componentManager) throws Exception | ||
| 93 | { | ||
| 94 | componentManager.registerComponent(MockWikiModel.getComponentDescriptor()); | ||
| 95 | |||
| 96 | // Add InterWiki Definition for links28 test | ||
| 97 | DefaultRenderingConfiguration renderingConfiguration = | ||
| 98 | (DefaultRenderingConfiguration) componentManager.getInstance(RenderingConfiguration.class); | ||
| 99 | renderingConfiguration.addInterWikiDefinition("knownalias", "http://server/common/url/"); | ||
| 100 | } | ||
| 101 | } | ||
| 102 | {{/code}} | ||
| 103 | ))) | ||
| 104 | |||
| |
1.1 | 105 | == Upgrades == |
| 106 | |||
| 107 | The following dependencies have been upgraded: | ||
| 108 | |||
| |
24.1 | 109 | * [[Groovy 2.1.5>>https://jira.xwiki.org/browse/XCOMMONS-413]] |
| |
1.1 | 110 | |
| 111 | = Translations = | ||
| 112 | |||
| 113 | The following translations have been updated: | ||
| 114 | |||
| |
21.1 | 115 | {{language codes="de, fr"/}} |
| |
1.1 | 116 | |
| 117 | = Tested Browsers & Databases = | ||
| 118 | |||
 |
15.2 | 119 | {{include reference="TestReports.ManualTestReportXWiki51RC1Summary"/}} |
| |
1.1 | 120 | |
| 121 | = Known issues = | ||
| 122 | |||
| |
24.1 | 123 | * [[Bugs we know about>>https://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]] |
| |
1.1 | 124 | |
| 125 | = Backward Compatibility and Migration Notes = | ||
| 126 | |||
| 127 | == General Notes == | ||
| 128 | |||
| 129 | You may also want to [[import the default wiki XAR>>Main.Download]] in order to benefit from all the improvements listed above. | ||
| 130 | |||
| 131 | {{warning}} | ||
| 132 | 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. | ||
| 133 | {{/warning}} | ||
| 134 | |||
| 135 | == API Breakages == | ||
| 136 | |||
| |
16.1 | 137 | The following APIs were modified since XWiki 5.0.3: |
| |
1.1 | 138 | |
| |
22.1 | 139 | * Young API: New method to separate job setup from job start to put real jobs in queue.((( |
| |
1.1 | 140 | {{code language="none"}} |
| |
22.1 | 141 | org.xwiki.job.Job: Method 'public void initialize(org.xwiki.job.Request)' has been added to an interface |
| |
1.1 | 142 | {{/code}} |
| |
22.1 | 143 | ))) |
| 144 | * Young API: New method to add a custom Job to the queue.((( | ||
| 145 | {{code language="none"}} | ||
| 146 | org.xwiki.job.JobManager: Method 'public void addJob(org.xwiki.job.Job)' has been added to an interface | ||
| 147 | {{/code}} | ||
| 148 | ))) | ||
| |
24.1 | 149 | * Needed to fix [[XWIKI-9251>>https://jira.xwiki.org/browse/XWIKI-9251]] and the IRC Bot API is still relatively new and not a mainstream API used by lots of people.((( |
| |
22.1 | 150 | {{code language="none"}} |
| 151 | org.xwiki.ircbot.IRCBot: Method 'public java.lang.String getWikiId()' has been added to an interface | ||
| 152 | {{/code}} | ||
| 153 | ))) | ||
| 154 | * Young API: The URL module has never been finished and we started working on it again.((( | ||
| 155 | {{code language="none"}} | ||
| 156 | org.xwiki.url.InvalidURLException: Class org.xwiki.url.InvalidURLException removed | ||
| 157 | {{/code}} | ||
| 158 | ))) |
