Wiki source code of Release Notes for XWiki 5.3 Milestone 2

Last modified by Thomas Mortagne on 2017/03/24
Hide line numbers
  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 comes with a new syntax quide, an improved faceted search and the ability to import content from Confluence wiki. Also, the wiki creation wizard has now support for creating wiki templates and for choosing the user scope (local, global or both). This release also includes a lot of bug fixes (33) and a few improvements (19) so you should definitely check it out.
  8: 
  9: = New and Noteworthy (since XWiki 5.3 Milestone 1) =
 10: 
 11: [[Full list of issues fixed and Dashboard for 5.3>>https://jira.xwiki.org/secure/Dashboard.jspa?selectPageId=11698]].
 12: 
 13: == Solr Search Improvements ==
 14: 
 15: === Search Facets ===
 16: 
 17: The display of some of the search facets has been improved. The Author and Creator facets now show the user full name, alias and avatar.
 18: 
 19: {{image reference="search-userFacet.png"/}}
 20: 
 21: The wiki facet displays the wiki pretty name instead of the wiki identifier.
 22: 
 23: {{image reference="search-wikiFacet.png"/}}
 24: 
 25: The language facet displays the full language name and country (when applicable) in the current locale.
 26: 
 27: {{image reference="search-languageFacet.png"/}}
 28: 
 29: The number of displayed facet values is limited to 5 by default but you can see the rest of the values by clicking on the link following the facet values (each click will show 5 more values).
 30: 
 31: The date facets (last modification date and creation date) have been improved to display a list of predefined date intervals, with the possibility to specify a custom date interval.
 32: 
 33: {{image reference="search-dateFacet.png"/}}
 34: 
 35: When selected, the date facet displays the end points of the date interval. If you specify only the start/end date then the interval will include all dates after/before the specified date.
 36: 
 37: {{image reference="search-dateFacet-selected.png"/}}
 38: 
 39: === RSS Feed ===
 40: 
 41: We added a RSS feed for Solr search results. You can find the link on the default search page after the list of results. The feed provides the most recent results that match the current search query and filters. It contains the same type of information that was included in the Lucene search RSS feed.
 42: 
 43: See the [[Solr Search Application documentation>>extensions:Extension.Solr Search Application]] for details.
 44: 
 45: == WikiStream improvements ==
 46: 
 47: === Allow exporting Large Wikis by default ===
 48: 
 49: The WikiStream module is now used by default in the standard export action, thus allowing exporting wikis with lots of content.
 50: 
 51: Note that you can still put back the old implementation in case you find a problem by setting {{code language="none"}}xwiki.action.export.xar.usewikistream=0{{/code}} at the end of your ##xwiki.cfg## file.
 52: 
 53: === New WikiStream application ===
 54: 
 55: A new generic UI has been introduced to manipulate WikiStream modules easily. See [[extensions:Extension.XWiki Platform - WikiStream - UI]] for more details.
 56: 
 57: === Script service improvements ===
 58: 
 59: * added a properties converter for ##WikiStreamType## to make easier to manipulate it from Velocity
 60: * made APIs asynchronous
 61: 
 62: === Confluence XML input module for WikiStream ===
 63: 
 64: A new WikiStream input module has been added to parse [[Confluence backup packages>>https://confluence.atlassian.com/display/DOC/Exporting+Confluence+Pages+and+Spaces+to+XML]].
 65: 
 66: === New XHTML based Confluence syntax ===
 67: 
 68: Since 4.0 Confluence moved to a XHTML based syntax for page content. So in order to import recent version of Confluences a parser for this syntax had to be written first.
 69: 
 70: == New Syntax Guide ==
 71: 
 72: The Syntax Guide has been completely rewritten to better support growing number of syntaxes and make it easier to add documentation other syntaxes. For now it includes ##xwiki/1.0##, ##xwiki/2.0## and ##xwiki/2.1##.
 73: 
 74: {{image reference="helpui221.png"/}}
 75: 
 76: {{image reference="helpui222.png"/}}
 77: 
 78: == Multi-Wiki ==
 79: 
 80: * The "create wiki" wizard now offers the ability to create a new wiki template:(((
 81: {{image reference="wizard-new-template.png"/}}
 82: )))
 83: * It is also possible to select the "user scope" of the new wiki. The user scope determines if local or global users are enabled, or both:(((
 84: {{image reference="wizard-user-scope.png"/}}
 85: )))
 86: * When the user creates a wiki from a template, a new step is displayed in the wizard, while the system is provisioning the wiki:(((
 87: {{image reference="wizard-provisioning.png"/}}
 88: )))
 89: * The "users" section in the administration of a (sub)wiki gives the opportunity to change the user scope setting, and the membership type too:(((
 90: {{image reference="admin-wiki-users.png"/}}
 91: )))
 92: * In the "wikis" section of the administration of the main wiki, the created templates are displayed:(((
 93: {{image reference="admin-wiki-template.png"/}}
 94: )))
 95: * It is also possible to edit wikis directly from the wiki index.
 96: * All the documentation is available on the [[application page>>extensions:Extension.Wiki Application]].
 97: 
 98: == Miscellaneous ==
 99: 
100: * We're now officially not supporting saving Servlet Session in URL (a.k.a URL Rewriting). This means that if you want to remain logged on in XWiki you need to enable cookies (See why ##jsessionid## are considered harmful [[here>>https://randomcoder.org/articles/jsessionid-considered-harmful]] and [[here>>http://java.dzone.com/articles/java-jsessionid-harmful]]).
101: * The Statistics Application now has an entry point in the Applications Panel (only visible by Admins by default):(((
102: {{image reference="statsentry.png"/}}
103: )))
104: * The Scheduler Application now has an entry point in the Applications Panel (only visible by Admins by default):(((
105: {{image reference="schedulerentry.png"/}}
106: )))
107: * The URL Legacy JAR is now correctly bundled in the XE WAR. This is important since otherwise you'd need to set the URL configuration properties in your ##xwiki.properties## file in addition to setting them in ##xwiki.cfg##. For example ##url.standard.multiwiki.isPathBased## in ##xwiki.properties## **and** ##xwiki.virtual.usepath## in ##xwiki.cfg##).
108: * Deleted users do not appear anymore in the "Top Active Members" list in the wiki dashboard.
109: 
110: See the [[full list of JIRA issues>>https://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.3-milestone-2%22&tempMax=1000]] fixed in this release.
111: 
112: = For Developers =
113: 
114: == Multi-Wiki ==
115: 
116: * The modules {{code}}xwiki-platform-wiki-manager{{/code}} and {{code}}wiki-platform-workspaces{{/code}} are now replaced by the module {{code}}xwiki-platform-wiki{{/code}}, that now manages how (sub)wikis are created and how users can access to them.
117: 
118: == Deprecated and Retired projects ==
119: 
120: * Workspace has been moved to https://github.com/xwiki-contrib/xwiki-platform-workspace
121: 
122: == Upgrades ==
123: 
124: The following dependencies have been upgraded:
125: 
126: * [[Groovy 2.1.9>>https://jira.xwiki.org/browse/XWIKI-9603]]
127: * [[Bouncy Castle Crypto package 1.49>>https://jira.xwiki.org/browse/XWIKI-9631]] (Warning: Not fully binary compatible)
128: 
129: == Miscellaneous ==
130: 
131: * New {{code language="none"}}com.xpn.xwiki.doc.XWikiDocument#getDocumentReferenceWithLocale(){{/code}} method to get the real reference of the document to use in {{code language="none"}}com.xpn.xwiki.XWiki#getDocument(DocumentReference, XWikiContext){{/code}} for example
132: * [[New Java API + a few new APIs in the Git module>>extensions:Extension.Git Module]]
133: 
134: = Translations =
135: 
136: The following translations have been updated: 
137: 
138: {{language codes="de, fr, it, lv, ru, sv, uk"/}}
139: 
140: = Tested Browsers & Databases =
141: 
142: {{include reference="TestReports.ManualTestReportXWiki53M2Summary"/}}
143: 
144: = Known issues =
145: 
146: * [[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]]
147: 
148: = Backward Compatibility and Migration Notes =
149: 
150: == General Notes ==
151: 
152: == General Notes ==
153: 
154: 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.
155: 
156: == API Breakages ==
157: 
158: The following APIs were modified since XWiki 5.2.1:
159: 
160: * Requesting a dependency without indicating the namespace does not really make sense. This interface is not really supposed to be implemented anyway.
161: 
162: {{code language="none"}}
163: org.xwiki.extension.ExtensionManager: Method 'public org.xwiki.extension.Extension resolveExtension(org.xwiki.extension.ExtensionDependency, java.lang.String)' has been added to an interface
164: {{/code}}
165: 
166: * Needed to filter search by namespace. This interface is not really supposed to be implemented anyway.
167: 
168: {{code language="none"}}
169: org.xwiki.extension.repository.InstalledExtensionRepository: Method 'public org.xwiki.extension.repository.result.IterableResult searchInstalledExtensions(java.lang.String, java.lang.String, int, int)' has been added to an interface
170: {{/code}}
171: 
172: * Young API. Not supposed to be implemented from outside.
173: 
174: {{code language="none"}}
175: org.xwiki.filter.xml.parser.XMLParserFactory: Method 'public javax.xml.stream.XMLEventWriter createXMLEventWriter(java.lang.Object, org.xwiki.filter.xml.XMLConfiguration)' has been added to an interface
176: org.xwiki.filter.xml.serializer.XMLSerializerFactory: Method 'public java.lang.Object createSerializer(java.lang.Class[], javax.xml.transform.Result, org.xwiki.filter.xml.XMLConfiguration)' has been added to an interface
177: {{/code}}
178: 
179: * Young API. Not supposed to be implemented from outside.
180: 
181: {{code language="none"}}
182: org.xwiki.filter.FilterDescriptorManager: Method 'public java.lang.Object createCompositeFilter(java.lang.ClassLoader, java.lang.Object[])' has been added to an interface
183: org.xwiki.filter.FilterDescriptorManager: Method 'public java.lang.Object createFilterProxy(java.lang.Object, java.lang.ClassLoader, java.lang.Class[])' has been added to an interface
184: {{/code}}
185: 
186: * Young API that has been refactored to introduce the new Resource module.
187: 
188: {{code language="none"}}
189: org.xwiki.url.AbstractXWikiURL: Class org.xwiki.url.AbstractXWikiURL removed
190: org.xwiki.url.URLCreationException: Class org.xwiki.url.URLCreationException removed
191: org.xwiki.url.UnsupportedURLException: Class org.xwiki.url.UnsupportedURLException removed
192: org.xwiki.url.XWikiEntityURL: Class org.xwiki.url.XWikiEntityURL removed
193: org.xwiki.url.XWikiURL: Class org.xwiki.url.XWikiURL removed
194: org.xwiki.url.XWikiURLFactory: Class org.xwiki.url.XWikiURLFactory removed
195: org.xwiki.url.XWikiURLManager: Class org.xwiki.url.XWikiURLManager removed
196: org.xwiki.url.XWikiURLSerializer: Class org.xwiki.url.XWikiURLSerializer removed
197: org.xwiki.url.XWikiURLType: Class org.xwiki.url.XWikiURLType removed
198: {{/code}}
199: 
200: * XWikiURL (now Resource) should only be in the Execution Context and not in the Request.
201: 
202: {{code language="none"}}
203: org.xwiki.container.servlet.ServletRequest: Method 'public org.xwiki.url.XWikiURL getURL()' has been removed
204: org.xwiki.container.servlet.ServletRequest: Method 'public void setXWikiURL(org.xwiki.url.XWikiURL)' has been removed
205: org.xwiki.container.portlet.PortletRequest: Method 'public org.xwiki.url.XWikiURL getURL()' has been removed
206: org.xwiki.container.portlet.PortletRequest: Method 'public void setXWikiURL(org.xwiki.url.XWikiURL)' has been removed
207: org.xwiki.container.Request: Field XWIKI_URL has been removed, but it was previously a constant
208: {{/code}}
209: 
210: * Lots of refactoring in WikiStream.
211: 
212: {{code language="none"}}
213: org.xwiki.wikistream.WikiStream: Class org.xwiki.wikistream.WikiStream removed
214: org.xwiki.wikistream.descriptor.DefaultWikiStreamBeanParameterDescriptor: Method 'public java.lang.reflect.Type getPropertyType()' has been removed
215: org.xwiki.wikistream.descriptor.WikiStreamPropertyDescriptor: Method 'public java.lang.reflect.Type getPropertyType()' has been removed
216: org.xwiki.wikistream.descriptor.WikiStreamPropertyDescriptor: Method 'public java.lang.reflect.Type getType()' has been added to an interface
217: org.xwiki.wikistream.filter.FarmFilter: Class org.xwiki.wikistream.filter.FarmFilter removed
218: org.xwiki.wikistream.filter.WikiAttachmentFilter: Class org.xwiki.wikistream.filter.WikiAttachmentFilter removed
219: org.xwiki.wikistream.filter.WikiClassFilter: Class org.xwiki.wikistream.filter.WikiClassFilter removed
220: org.xwiki.wikistream.filter.WikiClassPropertyFilter: Class org.xwiki.wikistream.filter.WikiClassPropertyFilter removed
221: org.xwiki.wikistream.filter.WikiDocumentFilter: Class org.xwiki.wikistream.filter.WikiDocumentFilter removed
222: org.xwiki.wikistream.filter.WikiFilter: Class org.xwiki.wikistream.filter.WikiFilter removed
223: org.xwiki.wikistream.filter.WikiObjectFilter: Class org.xwiki.wikistream.filter.WikiObjectFilter removed
224: org.xwiki.wikistream.filter.WikiObjectPropertyFilter: Class org.xwiki.wikistream.filter.WikiObjectPropertyFilter removed
225: org.xwiki.wikistream.filter.WikiSpaceFilter: Class org.xwiki.wikistream.filter.WikiSpaceFilter removed
226: org.xwiki.wikistream.input.BeanInputWikiStreamFactory: Removed org.xwiki.wikistream.WikiStream from the set of implemented interfaces
227: org.xwiki.wikistream.input.InputWikiStreamFactory: Removed org.xwiki.wikistream.WikiStream from the set of implemented interfaces
228: org.xwiki.wikistream.output.BeanOutputWikiStreamFactory: Removed org.xwiki.wikistream.WikiStream from the set of implemented interfaces
229: org.xwiki.wikistream.output.BeanOutputWikiStreamFactory: Method 'public org.xwiki.wikistream.output.OutputWikiStream creaOutputWikiStream(java.lang.Object)' has been removed
230: org.xwiki.wikistream.output.BeanOutputWikiStreamFactory: Method 'public org.xwiki.wikistream.output.OutputWikiStream createOutputWikiStream(java.lang.Object)' has been added to an interface
231: org.xwiki.wikistream.output.OutputWikiStreamFactory: Removed org.xwiki.wikistream.WikiStream from the set of implemented interfaces
232: org.xwiki.wikistream.output.OutputWikiStreamFactory: Method 'public org.xwiki.wikistream.output.OutputWikiStream creaOutputWikiStream(java.util.Map)' has been removed
233: org.xwiki.wikistream.output.OutputWikiStreamFactory: Method 'public org.xwiki.wikistream.output.OutputWikiStream createOutputWikiStream(java.util.Map)' has been added to an interface
234: org.xwiki.wikistream.type.WikiStreamType: Removed field XWIKI_XAR
235: org.xwiki.wikistream.instance.input.AbstractInstanceInputEventGenerator: Removed org.xwiki.wikistream.filter.FarmFilter from the set of implemented interfaces
236: org.xwiki.wikistream.instance.input.AbstractInstanceInputEventGenerator: Removed org.xwiki.wikistream.filter.WikiDocumentFilter from the set of implemented interfaces
237: org.xwiki.wikistream.instance.input.AbstractInstanceInputEventGenerator: Removed org.xwiki.wikistream.filter.WikiFilter from the set of implemented interfaces
238: org.xwiki.wikistream.instance.input.AbstractInstanceInputEventGenerator: Removed org.xwiki.wikistream.filter.WikiSpaceFilter from the set of implemented interfaces
239: org.xwiki.wikistream.instance.input.EntityEventGenerator: Method 'public org.xwiki.wikistream.descriptor.WikiStreamDescriptor getDescriptor()' has been added to an interface
240: org.xwiki.wikistream.instance.input.InstanceInputEventGenerator: Removed org.xwiki.wikistream.filter.FarmFilter from the set of implemented interfaces
241: org.xwiki.wikistream.instance.input.InstanceInputEventGenerator: Removed org.xwiki.wikistream.filter.WikiDocumentFilter from the set of implemented interfaces
242: org.xwiki.wikistream.instance.input.InstanceInputEventGenerator: Removed org.xwiki.wikistream.filter.WikiFilter from the set of implemented interfaces
243: org.xwiki.wikistream.instance.input.InstanceInputEventGenerator: Removed org.xwiki.wikistream.filter.WikiSpaceFilter from the set of implemented interfaces
244: org.xwiki.wikistream.instance.input.InstanceInputEventGenerator: Method 'public org.xwiki.wikistream.descriptor.WikiStreamDescriptor getDescriptor()' has been added to an interface
245: org.xwiki.wikistream.instance.input.InstanceInputEventGenerator: Method 'public java.util.Collection getFilterInterfaces()' has been added to an interface
246: org.xwiki.wikistream.instance.input.InstanceInputEventGenerator: Method 'public void setWikiDocumentParameters(java.lang.String, org.xwiki.filter.FilterEventParameters)' has been added to an interface
247: org.xwiki.wikistream.instance.input.InstanceInputEventGenerator: Method 'public void setWikiFarmParameters(org.xwiki.filter.FilterEventParameters)' has been added to an interface
248: org.xwiki.wikistream.instance.input.InstanceInputEventGenerator: Method 'public void setWikiParameters(java.lang.String, org.xwiki.filter.FilterEventParameters)' has been added to an interface
249: org.xwiki.wikistream.instance.input.InstanceInputEventGenerator: Method 'public void setWikiSpaceParameters(java.lang.String, org.xwiki.filter.FilterEventParameters)' has been added to an interface
250: org.xwiki.wikistream.instance.output.OutputInstanceWikiStreamFactory: Removed org.xwiki.wikistream.WikiStream from the set of implemented interfaces
251: org.xwiki.wikistream.instance.script.InstanceWikiStreamScriptService: Method 'public void export(org.xwiki.wikistream.type.WikiStreamType, org.xwiki.wikistream.instance.internal.input.InstanceInputProperties, java.util.Map)' has been removed
252: org.xwiki.wikistream.script.WikiStreamScriptService: Method 'public void convert(org.xwiki.wikistream.type.WikiStreamType, java.util.Map, org.xwiki.wikistream.type.WikiStreamType, java.util.Map)' has been removed
253: org.xwiki.wikistream.script.WikiStreamScriptService: Method 'public org.xwiki.wikistream.input.InputWikiStream createInputWikiStream(org.xwiki.wikistream.type.WikiStreamType, java.util.Map)' has been removed
254: org.xwiki.wikistream.script.WikiStreamScriptService: Method 'public org.xwiki.wikistream.output.OutputWikiStream createOutputWikiStream(org.xwiki.wikistream.type.WikiStreamType, java.util.Map)' has been removed
255: {{/code}}
Wiki source code of Release Notes for XWiki 5.3 Milestone 2

Quick Links

Let us know

About

About

Support

Platform

User Guide

Admin Guide

Developer Guide

Projects

XWiki

Extensions

Other

Contribute

Status

Practices

Under the Hood

Get Involved

Get Connected
