Version 16.1 by Caleb James DeLisle on 2012/06/18

Show last authors
1 {{box cssClass="floatinginfobox" title="**Contents**"}}
2 {{toc/}}
3 {{/box}}
4
5 This is the second release of the 4.x cycle ([[Roadmap>>Main.Roadmap]]). This release brings Extension Manager improvements such as merging of configuration documents during extension upgrade, a more gentle learning curve by hiding internal documents from non-technical users, and lots of goodies for the developers such as easy sharing of variables between scripts in different languages.
6
7 = New and Noteworthy (since XWiki Enterprise 4.0 version) =
8
9 Here are notable new features and improvements. For the full list of issues (including statistics) see the [[JIRA Dashboard>>http://jira.xwiki.org/secure/Dashboard.jspa?selectPageId=11191]].
10
11 == Improvements to the Extension Manager ==
12
13 The speed and reliability of the [[Extension Repository>>extensions:Extension.Extension Repository Application]] has been improved considerably. For example the [[XWiki.org Extension Repository>>extensions:Extension.WebHome]] is now much faster when you access it from XWiki Enterprise and you should now be able to browse and install extensions in no time.
14
15 Upgrading applications with related configuration documents is now handled using the merge conflict resolution UI. Changes are displayed as if you were comparing versions from a document's history.
16
17 {{image reference="EM-mergeConflict.png"/}}
18
19 If extension installation fails, the error message is extracted from the logs and displayed. You can view the full stack trace by clicking on the error message.
20
21 (in the image below the job of computing the install plan fails)
22
23 image:EM-extensionLog.png
24
25 The install and uninstall plans display extensions like in the dependency section. This way you can follow the link of an extension to find out more about what is going to be installed.
26
27 image:EM-uninstallPlan.png
28
29 The install and uninstall process is now completely asynchronous. You can see below how the progress is indicated.
30
31 image:EM-asyncInstall.png
32
33 See the [[Extension Manager Application documentation>>doc:extensions:Extension.Extension Manager Application]] for more details.
34
35 == Hide technical documents from non-technical users ==
36
37 * Users who do not opt to see hidden documents do not see them on panels or in search results.
38 * For advanced users, it is now possible to specify that a document should be hidden when editing the document (only //wiki// or //wysiwyg// edit modes):(((
39 [[image:HideDocument.png||style="border:1px solid silver" width="240px"]]
40
41 And now there's a new setting in the user profiles, letting users choose whether they want hidden documents to appear in search results and panels:
42
43 [[image:ShowHiddenDocuments.png||style="border:1px solid silver" width="300px"]]
44
45 * If the user doesn't set explicitly the Hidden setting value in his profile, he won't see hidden documents by default. Thus seeing hidden documents is an explicit choice.
46 )))
47
48
49 == New types of charts ==
50
51 We've [[added 2 new types of charts>>extensions:Extension.Chart Macro]], **bar3D** and **line3D**, which draw 3D charts.
52
53 For example the following code:
54
55 {{code}}
56 {{chart type='bar3D' source='inline' params='range:B2-B9;series:columns'}}
57 |=Date|=Value
58 |2012-02-21|1.97
59 |2012-02-26|2.96
60 |2012-03-04|3.93
61 |2012-03-11|4.84
62 |2012-03-18|5.83
63 |2012-03-25|4.5
64 |2012-04-01|3.85
65 |2012-04-08|4.87
66 {{/chart}}
67 {{/code}}
68
69 Will be rendered as this:
70
71 [[image:chart-example.png]]
72
73
74 It's now possible to select [[custom colors in Chart graphs>>extensions:Extension.Chart Macro]]. For example:
75
76 {{code}}
77 {{chart type="pie" source="inline" params="range:B2-D5;series:columns;colors:C3E3F7,1D9FF5,015891,012A45" title="Chart Test" width="320" height="240"}}
78 | |X |Y |Z
79 |Q1|1.2|3.4|1.3
80 |Q2|4.5|3.4|2.3
81 |Q3|1.2|4.5|9.0
82 |Q4|3.4|1.2|1.2
83 {{/chart}}
84 {{/code}}
85
86 Will generate:
87
88 {{image reference="extensions:Extension.Chart Macro@customcolors.png"/}}
89
90
91 == New macro for sending messages ==
92
93 Whereas the Activity Stream allows users to send a message as well as observing messages and activities of other users, this macro allows the explicit message sending functionality to be duplicated in other places without including the activity stream as well.
94
95 The code:
96
97 {{code language="none"}}
98 {{messageSender /}}
99 {{/code}}
100
101 Produces the following:
102
103 {{image reference="messageSenderMacro.png"/}}
104
105 == Danish Translation ==
106
107 [[image:Denmark.png||width=50px]] XWiki Enterprise is now available in the Danish language.
108
109 == Global and per-user timezone setting ==
110
111 Wiki administrators can now use a specific timezone regardless of the clock configuration on the wiki server. The following setting can be found under **Administration > Localization**.
112 Users will find the same setting, allowing them to see dates reflecting their current location. The user setting is accessible through **Profile > Preferences > Localization Preferences**.
113
114 {{image reference="timezone.jpg"/}}
115
116
117 = For developers =
118
119 * New rendering [[Compatibility Test Suite>>rendering:Main.CompatibilityTestSuite]] to make testing easier and simplify implementation of new syntax Parsers and Renderers. You can checkout the [[Compatibility report>>rendering:Main.SyntaxReport]] for all the syntaxes that are supported out of the box by XWiki.
120
121 * New diff/merge module has been added to make easier to deal with diff and merge both from component and scripts. See [[Diff module >>extensions:Extension.Diff Module]] for details.
122
123 == Easy variable sharing between scripts ==
124 It's now much easier to share variable between languages.
125 You can now create a variable in a Groovy script and use it in a Velocity script.
126
127 For example:(((
128 {{code language="none"}}
129 {{python}}
130 a = "This"
131 {{/python}}
132
133 {{groovy}}
134 b = "changes";
135 {{/groovy}}
136
137 {{velocity}}
138 $a $b everything.
139 {{/velocity}}
140 {{/code}}
141 )))
142
143 == Script access to Component Manager ==
144 With the [[new Component Access Script Service>>platform:DevGuide.Scripting||anchor="HXWikiComponentAccess"]] privileged scripts can now easily load components from the Component Manager (XWiki's dependency injection system). This is not available in Velocity because of it's limited capability to load classes.
145
146 For example:(((
147 {{code}}
148 {{groovy}}
149 def myComponent = services.component.getInstance(MyComponentRole.class)
150 {{/groovy}}
151 {{/code}}
152 )))
153
154 == Velocity interprets Strings in function calls ==
155 With the [[new Velocity uberspector>>doc:extensions:Extension.Velocity Module||anchor="HMethodArgumentsUberspector"]], Velocity will convert method arguments in string form to formal parameter types when the passed arguments don't match the method signature.
156
157 For example:(((
158 {{code}}
159 $obj.someMethod('VALUE')
160 // will forward to
161 obj.someMethod(SomeEnum.VALUE)
162 // if obj has a method with signature someMethod(SomeEnum) and not someMethod(String)
163 {{/code}}
164
165 But this is not limited to enums. The conversion is done using the [[Properties Module>>doc:extensions:Extension.Properties Module]] which means you can create and register custom converters for data types specific to your application domain.
166 )))
167
168
169 == Taming of Groovy scripts ==
170
171 Since traditionally, Groovy scripts can enter into unstoppable infinite loops, use reflection to violate security assumptions, access server resources, or even crash the virtual machine, they have been off limits to non-administrators.
172
173 In a bid to open up new scripting options to less permitted users (especially in wiki farms where getting Programming Rights is a problem since it means having those rights on the whole farm), steps have been taken to make Groovy safer.
174
175 Groovy scripts are now technically allowed to users having simple Edit rights but the Groovy Sandbox is currently very restrictive (said differently, you cannot do anything useful with it at the moment! :)). Now that we have the mechanism in place our plan is to slowly open up allowed operations.
176
177 To enable and test this feature read the document for both the [[Commons Groovy Module>>extensions:Extension.GroovyModuleCommons]] and the [[Platform Groovy Module>>extensions:Extension.GroovyModulePlatform]].
178
179 === Compilation customizers ===
180
181 Customizers can be registered to alter the Groovy script as it is compiled such as filtering System.exit() calls and adding timeout checks to loops to prevent infinite looping. Learn more: http://www.jroller.com/melix/entry/upcoming_groovy_goodness_automatic_thread
182
183 === Stop run-away scripts after a configurable timeout ===
184
185 You can now configure your wiki to stop Groovy scripts after a configurable amount of run time. For example if you wish to have a timeout of 10 seconds for your XWiki runtime, you'd configure xwiki's ##xwiki.properties## with:
186
187 {{code language="none"}}
188 groovy.compilationCustomizers=timedinterrupt
189 groovy.customizer.timedInterrupt.timeout=10
190 {{/code}}
191
192 == Shorthand HQL queries in the Query Manager ==
193
194 When you send a search query to the Query Manager such as {{code language="none"}}where doc.creationDate > '2008-01-01'{{/code}} It is now assumed that you meant:
195
196 {{code language="none"}}
197 select doc.fullName from XWikiDocument as doc where doc.creationDate > '2008-01-01'
198 {{/code}}
199
200 == Bug fixes and improvements ==
201
202 * Filenames of entries in XAR files are now [[always decoded using UTF-8 during import>>http://jira.xwiki.org/browse/XWIKI-6863]]. The previous behavior was to use the platform encoding. The filenames have always been encoded using UTF-8 in XAR files, but now also the Unicode extra fields are included, so unpacking XAR files with InfoZIP will result in the filenames beeing properly reencoded with the local filesystems character set.
203 * Temporary files are now placed in a special sub-directory of the normal temporary directory, this sub-directory called "xwiki-temp" is deleted after each startup of the xwiki system so it is critical that nothing else it placed in it. This improvement means that temporary files such as cached attachments will be removed even if the JVM crashes.
204 * Fixed wrong calculation of IDs for stats values making it impossible to upgrade a wiki to version 4.0 if statistics collection is enabled.
205 * Faster first startup time by not running a database migration when it is not needed.
206 * Simplify reverse proxy setup by making all HTTP redirects use relitive URLs.
207 * Add support for bold, italic and monospace in the TeX Renderer
208 * Was impossible to delete then recreate a subwiki with the same name, fixed.
209 * Fixed Javascript error when scrolling over Search Suggest results in Internet Explorer 6.
210 * Trying to change a document's parent from the REST service resulted in an error, fixed.
211 * It is now possible for non-administrators to execute cross-wiki XWQL queries.
212 * Move ComponentManager deprecated methods to Legacy modules
213 * New Groovy module in xwiki-commons
214 * Add legacy module structure for XWiki Rendering
215 * Have one Maven module per XWiki Rendering syntax
216 * Separate Event Syntax from Rendering API by moving it to a Syntax module
217 * Plain syntax and Event syntax have been moved out of Rendering API nto their own modules.
218 * [[XWIKI-7913>>http://jira.xwiki.org/browse/XWIKI-7913]] Could not register a Javascript or CSS skin extension for the whole wiki.
219
220
221 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+%28fixVersion+%3D+%224.1-milestone-1%22+%7C%7C+fixVersion+%3D+%224.1-milestone-2%22+%7C%7C+fixVersion+%3D+%224.1-rc-1%22+%7C%7C+fixVersion+%3D+%224.1%22%29&tempMax=1000]] fixed in the 4.1 release cycle.
222
223
224 == Upgrades ==
225
226 The following dependencies have been upgraded since XWiki Enterprise 4.0
227
228 === Upgraded in XWiki Enterprise Milestone 1 ===
229
230 * Tika 1.1
231 * JGroups 3.0.10
232 * Pygments 1.5
233 * Selenium 2.21
234 * Maven AspectJ Plugin 1.4
235 * commons-io 2.3
236 * Maven Shade plugin 1.6
237
238 === Upgraded in XWiki Enterprise Milestone 2 ===
239
240 * Restlet 2.0.14
241 ** Prior to Restlet 2.0.14, there was a REST bug allowing arbitrary filesystem read access for registered users.
242 * Reflections 0.9.7
243
244 = Tested Browsers =
245
246 Here's the list of browsers tested with this version (i.e. browsers that we've tested as working - Check the list of [[supported browsers>>dev:Community.BrowserSupportStrategy]]):
247
248
249 {{todo/}}
250
251
252 = Tested Databases =
253
254 {{todo/}}
255
256
257 = Known issues =
258
259 * [[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]]
260
261 = Test Report =
262
263 You can check the [[manual test report>>TestReports.ManualTestReportXE41]] to learn about what was tested and the results on various browsers.
264
265 = Backward Compatibility and Migration Notes =
266
267 == General Notes ==
268
269 {{info}}
270 If you're running in a multiwiki setup you'll also need to define the property //xwiki.store.migration.databases// in your //xwiki.cfg// file if you want to explicitly name some databases to be migrated as the default is now to migrate all databases. Database that are not migrated could not be accessed.
271 {{/info}}
272
273 You may also want to [[import the default wiki XAR>>Main.Download]] in order to benefit from all the improvements listed above.
274
275 {{warning}}
276 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.
277 {{/warning}}
278
279 == Issues specific to XWiki Enterprise 4.1 ==
280
281 The old experimental real-time synchronization plugin for the WYSIWYG content editor has been retired. We hope that its functionality will be replaced by the real-time editing feature developed on the [[Wiki 3.0>>https://github.com/xwiki-contrib/wiki30]] project. If you want to continue using the old plugin you need to:
282
283 * take the code from [[##xwiki-contrib/retired## GitHub repo>>https://github.com/xwiki-contrib/retired/tree/master/xwiki-platform-wysiwyg-plugin-sync]]
284 * add the client and server side as dependencies to the WYSIWYG client and server side respectively
285 * modify ##WysiwygEditorFactory## to register the factory of the sync plugin
286 * rebuild the editor and update the jars and client side resources on your XWiki Enterprise instance
287
288 == API Breakages ==
289
290 The following APIs were modified since version 4.0:
291
292 * Breakage in Query module done to support adding several Filters to a Query:(((
293 {{code language="none"}}
294 org.xwiki.query.QueryFilter: Method 'public java.util.List filterResults(java.util.List)' has been added to an interface
295 {{/code}}
296 )))
297 * This method should have been internal from the beginning:(((
298 {{code language="none"}}
299 org.xwiki.environment.EnvironmentConfiguration: Class org.xwiki.environment.EnvironmentConfiguration removed
300 {{/code}}
301 )))
302 * The Job module is new and is still considered a "young API":(((
303 {{code language="none"}}
304 org.xwiki.job.AbstractJob: Changed type of field status from org.xwiki.job.internal.DefaultJobStatus to org.xwiki.job.internal.AbstractJobStatus
305 org.xwiki.job.AbstractJob: Return type of method 'protected org.xwiki.job.internal.DefaultJobStatus createNewStatus(org.xwiki.job.Request)' has been changed to org.xwiki.job.internal.AbstractJobStatus
306 org.xwiki.job.AbstractJob: Method 'protected java.lang.String getId()' has been removed
307 org.xwiki.job.AbstractRequest: Return type of method 'public java.lang.String getId()' has been changed to java.util.List
308 org.xwiki.job.Job: Method 'public void join()' has been added to an interface
309 org.xwiki.job.Job: Method 'public boolean join(long, java.util.concurrent.TimeUnit)' has been added to an interface
310 org.xwiki.job.JobManager: Method 'public org.xwiki.job.event.status.JobStatus getJobStatus(java.util.List)' has been added to an interface
311 org.xwiki.job.Request: Return type of method 'public java.lang.String getId()' has been changed to java.util.List
312 org.xwiki.job.event.JobEvent: Return type of method 'public java.lang.String getJobId()' has been changed to java.util.List
313 org.xwiki.job.event.JobFinishedEvent: Return type of method 'public java.lang.String getJobId()' has been changed to java.util.List
314 org.xwiki.job.event.JobStartedEvent: Return type of method 'public java.lang.String getJobId()' has been changed to java.util.List
315 org.xwiki.job.event.status.JobStatus: Method 'public java.util.Date getEndDate()' has been added to an interface
316 org.xwiki.job.event.status.JobStatus: Method 'public java.util.Date getStartDate()' has been added to an interface
317 {{/code}}
318 )))
319 * The Extension module is relatively new and is still undergoing some API tuning:(((
320 {{code language="none"}}
321 org.xwiki.extension.job.plan.ExtensionPlan: Return type of method 'public java.util.Collection getTree()' has been changed to org.xwiki.extension.job.plan.ExtensionPlanTree
322 org.xwiki.extension.version.VersionConstraint: Method 'public boolean isCompatible(org.xwiki.extension.version.Version)' has been added to an interface
323 {{/code}}
324 )))
325 * This class was added in 3.2M2 by error in a user-public package. It's been moved again in the internal package as it should have been. We don't expect many users to be affected by this:(((
326 {{code language="none"}}
327 com.xpn.xwiki.doc.merge.MergeUtils: Class com.xpn.xwiki.doc.merge.MergeUtils removed
328 {{/code}}
329 )))
330 * In 2.2M1 we refactored BaseCollection to add getXClass() but we forgot to add it to the ObjectInterface interface. Even though this could break user we think it's very limited since nobody should implement directly ObjectInterface; instead everyone should extend BaseClass or BaseCollection:(((
331 {{code language="none"}}
332 com.xpn.xwiki.objects.ObjectInterface: Method 'public com.xpn.xwiki.objects.classes.BaseClass getXClass(com.xpn.xwiki.XWikiContext)' has been added to an interface
333 {{/code}}
334 )))
335 * The Autotag plugin has been extracted from the oldcore module and is now a module on its own so the following are not real breakages:(((
336 {{code language="none"}}
337 com.xpn.xwiki.plugin.autotag.AutoTagPlugin: Class com.xpn.xwiki.plugin.autotag.AutoTagPlugin removed
338 com.xpn.xwiki.plugin.autotag.AutoTagPluginAPI: Class com.xpn.xwiki.plugin.autotag.AutoTagPluginAPI removed
339 com.xpn.xwiki.plugin.autotag.FrenchStemmer: Class com.xpn.xwiki.plugin.autotag.FrenchStemmer removed
340 com.xpn.xwiki.plugin.autotag.Tag: Class com.xpn.xwiki.plugin.autotag.Tag removed
341 com.xpn.xwiki.plugin.autotag.TagCloud: Class com.xpn.xwiki.plugin.autotag.TagCloud removed
342 {{/code}}
343 )))
344 * The WYSIWYG Diff and Sync plugins have been extracted into their own modules so the following are not real breakages:(((
345 {{code language="none"}}
346 org.xwiki.gwt.wysiwyg.client.Images: Method 'public com.google.gwt.resources.client.ImageResource sync()' has been removed
347 org.xwiki.gwt.wysiwyg.client.Strings: Method 'public java.lang.String sync()' has been removed
348 org.xwiki.gwt.wysiwyg.client.diff.AddDelta: Class org.xwiki.gwt.wysiwyg.client.diff.AddDelta removed
349 org.xwiki.gwt.wysiwyg.client.diff.ChangeDelta: Class org.xwiki.gwt.wysiwyg.client.diff.ChangeDelta removed
350 org.xwiki.gwt.wysiwyg.client.diff.Chunk: Class org.xwiki.gwt.wysiwyg.client.diff.Chunk removed
351 org.xwiki.gwt.wysiwyg.client.diff.DeleteDelta: Class org.xwiki.gwt.wysiwyg.client.diff.DeleteDelta removed
352 org.xwiki.gwt.wysiwyg.client.diff.Delta: Class org.xwiki.gwt.wysiwyg.client.diff.Delta removed
353 org.xwiki.gwt.wysiwyg.client.diff.Diff: Class org.xwiki.gwt.wysiwyg.client.diff.Diff removed
354 org.xwiki.gwt.wysiwyg.client.diff.DiffAlgorithm: Class org.xwiki.gwt.wysiwyg.client.diff.DiffAlgorithm removed
355 org.xwiki.gwt.wysiwyg.client.diff.DiffException: Class org.xwiki.gwt.wysiwyg.client.diff.DiffException removed
356 org.xwiki.gwt.wysiwyg.client.diff.DifferentiationFailedException: Class org.xwiki.gwt.wysiwyg.client.diff.DifferentiationFailedException removed
357 org.xwiki.gwt.wysiwyg.client.diff.PatchFailedException: Class org.xwiki.gwt.wysiwyg.client.diff.PatchFailedException removed
358 org.xwiki.gwt.wysiwyg.client.diff.Revision: Class org.xwiki.gwt.wysiwyg.client.diff.Revision removed
359 org.xwiki.gwt.wysiwyg.client.diff.RevisionVisitor: Class org.xwiki.gwt.wysiwyg.client.diff.RevisionVisitor removed
360 org.xwiki.gwt.wysiwyg.client.diff.SimpleDiff: Class org.xwiki.gwt.wysiwyg.client.diff.SimpleDiff removed
361 org.xwiki.gwt.wysiwyg.client.diff.ToString: Class org.xwiki.gwt.wysiwyg.client.diff.ToString removed
362 org.xwiki.gwt.wysiwyg.client.diff.myers.DiffNode: Class org.xwiki.gwt.wysiwyg.client.diff.myers.DiffNode removed
363 org.xwiki.gwt.wysiwyg.client.diff.myers.MyersDiff: Class org.xwiki.gwt.wysiwyg.client.diff.myers.MyersDiff removed
364 org.xwiki.gwt.wysiwyg.client.diff.myers.PathNode: Class org.xwiki.gwt.wysiwyg.client.diff.myers.PathNode removed
365 org.xwiki.gwt.wysiwyg.client.diff.myers.Snake: Class org.xwiki.gwt.wysiwyg.client.diff.myers.Snake removed
366 org.xwiki.gwt.wysiwyg.client.plugin.sync.SyncPlugin: Class org.xwiki.gwt.wysiwyg.client.plugin.sync.SyncPlugin removed
367 org.xwiki.gwt.wysiwyg.client.plugin.sync.SyncPluginFactory: Class org.xwiki.gwt.wysiwyg.client.plugin.sync.SyncPluginFactory removed
368 org.xwiki.gwt.wysiwyg.client.plugin.sync.SyncResult: Class org.xwiki.gwt.wysiwyg.client.plugin.sync.SyncResult removed
369 org.xwiki.gwt.wysiwyg.client.plugin.sync.SyncService: Class org.xwiki.gwt.wysiwyg.client.plugin.sync.SyncService removed
370 org.xwiki.gwt.wysiwyg.client.plugin.sync.SyncServiceAsync: Class org.xwiki.gwt.wysiwyg.client.plugin.sync.SyncServiceAsync removed
371 org.xwiki.gwt.wysiwyg.client.plugin.sync.SyncStatus: Class org.xwiki.gwt.wysiwyg.client.plugin.sync.SyncStatus removed
372 org.xwiki.gwt.wysiwyg.client.plugin.sync.SyncTools: Class org.xwiki.gwt.wysiwyg.client.plugin.sync.SyncTools removed
373 org.xwiki.wysiwyg.server.plugin.sync.SyncEngine: Class org.xwiki.wysiwyg.server.plugin.sync.SyncEngine removed
374 org.xwiki.wysiwyg.server.plugin.sync.SyncException: Class org.xwiki.wysiwyg.server.plugin.sync.SyncException removed
375 {{/code}}
376 )))

Get Connected