Version 55.2 by Vincent Massol on 2014/01/31

Show last authors
1 {{box cssClass="floatinginfobox" title="**Contents**"}}
2 {{toc/}}
3 {{/box}}
5 This is the release notes for [[XWiki Commons>>]], [[XWiki Rendering>>]], [[XWiki Platform>>]] and [[XWiki Enterprise>>]]. They share the same release notes as they are released together and have the same version.
7 This is an improvement and stability release for things started during the 5.x cycle.
9 = New and Noteworthy (since XWiki 5.4 Milestone 1) =
11 [[Full list of issues fixed and Dashboard for XWiki 5.4>>]].
13 == Solr Search Improvements ==
15 The search facets now support multiple selection. Moreover, selecting a facet value doesn't hide the rest of the values of that facet. You can still see the number of results matching that value. We also decided to display a facet even when it has only one value, so that the user understands that all the results have that value for the specified facet. The facet selection is now preserved when you perform a new search. You can reset the current facets from the header of the facet pane if you want.
17 {{image reference="searchFacetMultipleSelection.png"/}}
19 === Advanced Search Options Removed ===
21 We decided to remove the Advanced Search Options (i.e. the search filters) because they weren't visible enough (you had to notice the arrow at the end of the search input) and, most importantly, because most of these options were duplicated by search facets, creating confusion. We integrated into the facet column the filters that were not already present there. The query boost option is no longer available but you can achieve the same thing from the query input and we'll add later a query boost configuration in the search administration section.
23 Following this change, we aligned the search input to the left. The reason it was centered before is because we didn't want the advanced search pane to hide the start of the first search results.
25 The Result Type facet has the document type selected by default. This is consistent with the old Result Type filter from the Advanced Search Options which was set to include by default only documents in the search results.
27 === Improved File Type Facet ===
29 The File Type facet filters results based on the attachment file type. E.g. "documents that have attached images", "text attachments". File types are grouped by category. You can select both an entire category and a specific file type. Categories can be expanded and collapsed.
31 {{image reference="searchFileTypeFacet.png"/}}
33 === Improved File Size Facet ===
35 The File Size facet lets you filter the results based on the size (in bytes) of the attachments. You can new choose between 4 ranges:
37 * tiny (less than 10KB)
38 * small (between 10KB and 500KB)
39 * medium (between 500KB and 5MB)
40 * large (more than 5MB)
42 {{image reference="searchFileSizeFacet.png"/}}
44 === Debug Mode ===
46 You can enable search debug mode by adding ##&debug=true## to the search URL query string. See the [[Solr Search Application>>extensions:Extension.Solr Search Application]] for more details.
48 {{image reference="searchDebug.png" width="400"/}}
50 == Distribution Wizard improvements ==
52 We changed the labels of the Skip and Cancel buttons from the Distribution Wizard steps. We hope this will remove some of the confusion around these two buttons. Additionally, we added a confirmation pop-up when the Never button (former Cancel) is clicked to prevent users from discarding the Distribution Wizard by mistake.
54 {{image reference="dw-welcomeStep.png"/}}
56 === No ##Upgrade Mode## anymore ===
58 The Upgrade Mode step has been removed. Instead, both upgrade modes are kind of enabled: you can upgrade your wikis when running the Distribution Wizard on the main wiki, from the Wikis step, but you can also run the Distribution Wizard on each of your wikis separately (like on the main wiki). As a consequence, upgrading the wikis in the Wikis step is now optional: you always get the Continue button. So it's up to you if you want to upgrade the default set of wiki pages on your wikis now or later by accessing each wiki.
60 {{image reference="dw-wikisStep.png"/}}
62 === New report step ===
64 A new last step has been introduce to display all the changes made to the wiki and give a chance to do some rollbacks.
66 {{image reference="dw-report.png"/}}
68 === Repair Previous UI ===
70 When repairing the previous UI, you can now enter a version that is not on the list by clicking on the pencil icon after the version list box. Moreover, the version list box should contain now all the available stable versions of the recommended UI.
72 {{image reference="dw-repairPreviousUI-editVersion"/}}
74 On the Wikis step, you can now repair the previous UI on all the available wikis.
76 {{image reference="dw-wikisStep-repairPreviousUI.png"/}}
78 == Activity Stream improvements ==
80 * The name of the wiki where the event has happened is displayed now, if the event concerns an other wiki than the current one.
81 * On the main wiki, Activity Stream now display events from every wikis where the current user has view right.
82 [[{{image reference="activity.png" width="35%"/}}>>attach:activity.png]]
84 == Miscellaneous ==
86 * Images that are copy-pasted as HTML in the WYSIWYG editor now work fine, thanks to the added support of the [[Data URI scheme>>]] in XWiki Syntax 2.1. The wiki syntax is:(((
87 {{code language="none"}}
88 image:data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABHNCSVQICAgIfAhkiAAAAO9JREFUOE+lUrsNwjAUdCyWIBXjIEokVoCejgkyQ2gYAIkSsQUrUIUxwrund5bjX4OlyPG9u3v22Z2rjM1uWEtpkq//PC/fCs35UoHi/WGL8mTrErVsAJGJHU2KagGzHUi3I8iP+0s1nInXjBSPSfI/n2/vGTNFJZOVCRkYltdGl1FMRqmHYL0FFM6MjnFXaxCwNJMOZAbW6JyVkI1cbwcD3T5MGBjZLQxi8Lw9kp5iFFikUYwZr2dNQzQT7EavsDFOwl2ErNuIh5kgaX1E0bEyMTiZAcA0WAa26GSL7CUaHjJJz1wyqWLpe6gS/yn8AD9tcjFN7/ajAAAAAElFTkSuQmCC
89 {{/code}}
90 )))
91 * The user and group pickers now take into account [[the User Scope specified when you create a new wiki>>extensions:Extension.Wiki Application||anchor="HCreateanewwiki"]]. If the current wiki supports only global users then the user picker will suggest global users. If the current wiki supports both local and global users then the user picker has a toggle that lets you choose whether to get local or global suggestions. The group picker behaves slightly different because you can have local groups even when only global users are allowed (to be able to setup various rights for the global users). Thus the group picker shows the scope toggle when you are in a subwiki that accepts global users, otherwise it suggests only local groups (from the current wiki, which can be the main wiki).
92 * Increased the size of the security cache to improve performances from 500 entries to 10000 entries. This setting could still be overwritten in the infinispan configuration of the cache named This new setting should be sufficient for most usages while the previous default were only valid for small single wiki.
93 * Improvement in the wiki descriptor pages. It is now consistent with our [[vertical forms standard>>platform:DevGuide.VerticalForms]].
94 [[{{image reference="descriptor-improvement1.png" width="35%"/}}>>attach:descriptor-improvement1.png]] [[{{image reference="descriptor-improvement2.png" width="35%"/}}>>attach:descriptor-improvement2.png]]
95 * When the user creates a new wiki, without a template, a message is displayed to explain him the Distribution Wizard will be started to initialize the new created wiki.
96 [[{{image reference="create-a-wiki-dw.png" width="35%"/}}>>attach:create-a-wiki-dw.png]]
97 * In the Activity Stream, the name of the wiki where the event has happened is displayed now, if the event concerns an other wiki than the current one.
98 [[{{image reference="activity.png" width="35%"/}}>>attach:activity.png]]
100 See the [[full list of JIRA issues>>]] fixed in this release.
102 = For Developers =
104 == New APIs to manipulate XAR files ==
106 A new ##"xar"## ScriptService has been introduced with APIs to manipulate XAR files. It does not yet contains a lot of methods and new will be added as needed. See [[XAR Module extension>>extensions:Extension.XAR Module]] for more details.
108 == Miscellaneous ==
110 * We added a new parameter to the [[Live Table Velocity macro>>extensions:Extension.Livetable Macro]] named 'selectedTags' which controls the list of tags that are selected initially in the tag cloud. You can still select different tags after the live table loads. With this new parameter you can have a permanent link to a live table that has the rows filtered initially by some tags:(((
111 {{code language="none"}}
112 ## /xwiki/bin/view/Demo/WebHome?tag=news&tag=science
113 #set ($options = {
114 'className': 'Demo.DemoClass',
115 ...
116 'tagCloud': true,
117 'selectedTags': $request.getParameterValues('tag'),
118 ...
119 })
120 {{/code}}
121 )))
122 * The module {{code}}xwiki-platform-wiki-rest{{/code}} replaces the old module {{code}}xwiki-platform-wiki-manager-rest{{/code}} in order to move {{code}}xwiki-platform-wiki-manager{{/code}} in {{code}}contrib{{/code}}, but the API is unchanged.
123 * Verbosity of the job is now configurable right from the ##org.xwiki.job.Request## object
124 * Log generator now generates BeginEvent/EndEvent variants based on marker informations
125 * The following ##java.lang.Class## methods are now allowed in Velocity by default: ##name, isArray, isAssignableFrom, isEnum, isInstance, isInterface, isLocalClass, isMemberClass, isPrimitive, isSynthetic##
126 * Default job status does not provide log tree anymore. Was making the API too complex. It can be created from the log queue very easily in Java and a helper method has been added in logging ScriptService to create one: {{code language="velocity"}}$services.logging.toLogTree($logs){{/code}}
127 * Various APIs have been added to help translate log. See [[Logging Module>>extensions:Extension.Logging Module||anchor="HTranslatelog"]] for more details
128 * It's now [[possible to add new Images Types when rendering in XHTML>>rendering:Main.Extending||anchor="HAddinganewImageType"]]
129 * Introduced ##org.xwiki.observation.AbstractEventListener##
130 * New model API and script service API to create a tree from a list of entity references. See [[Model Module>>extensions:Extension.Model Module]] for more details
131 * [[New option in the XAR plugin's ##format## mojo to add missing license headers>>dev:Community.XARPlugin||anchor="HFormatMojo"]]
132 * If you want to restrict the list of wikis that are searchable by default with Solr from the main wiki then you can define the following Velocity variable in a page that includes ##Main.SolrSearch##:(((
133 {{code language="none"}}
134 #set ($wikisSearchableFromMainWiki = ["xwiki", "platform", "enterprise", ..., "commons", "rendering"])
135 {{/code}}
136 )))
137 * {{code language="none"}}${{/code}}, {{code language="none"}}${{/code}}, {{code language="none"}}${{/code}} are deprecated now. Please use the corresponding {{code language="none"}}lastError{{/code}} function instead.
139 = Translations =
141 The following translations have been updated:
143 {{language codes="none, none"/}}
145 = Tested Browsers & Databases =
147 {{include reference="TestReports.ManualTestReportXWiki54RC1Summary"/}}
149 = Known issues =
151 * [[Bugs we know about>>]]
153 = Backward Compatibility and Migration Notes =
155 == General Notes ==
157 When upgrading make sure you compare your ##xwiki.cfg##, and ##web.xml## files with the newest version since some configuration parameters may have been modified or added. Note that you should add so that XWiki will attempt to automatically migrate your current database to the new schema. Make sure you backup your Database before doing anything.
159 == Issues specific to XWiki 5.4RC1 ==
161 === New Velocity uberspector ===
163 If you modified {{code language="properties"}} = runtime.introspector.uberspect.chainClasses = ...{{/code}} property in ##xwiki.propertes## file you should make sure to replace ##org.apache.velocity.util.introspection.SecureUberspector## with ##org.xwiki.velocity.introspection.SecureUberspector##.
165 == API Breakages ==
167 The following APIs were modified since 5.3:
169 {{code language="none"}}
170 org.xwiki.wikistream.xar.input.XARInputProperties: Method 'public boolean isReferencesOnly()' has been removed
171 org.xwiki.wikistream.xar.input.XARInputProperties: Method 'public void setReferencesOnly(boolean)' has been removed
172 org.xwiki.wikistream.model.filter.WikiDocumentFilter: Field PARAMETER_REVISION has been removed, but it was previously a constant
173 org.xwiki.wikistream.model.filter.WikiObjectPropertyFilter: Parameter 2 of 'public void onWikiObjectProperty(java.lang.String, java.lang.String, org.xwiki.filter.FilterEventParameters)' has changed its type to java.lang.Object
174 {{/code}}

Get Connected