Wiki source code of Release Notes for XWiki 4.2

Version 5.1 by Jerome on 2012/09/26

Show last authors
1 {{box cssClass="floatinginfobox" title="**Contents**"}}
2 {{toc/}}
3 {{/box}}
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.
7 This is the thir release of the 4.x cycle ([[Roadmap>>Main.Roadmap]]).
9 = New and Noteworthy (since XWiki 4.1) =
11 == JIRA Macro ==
13 A [[new JIRA Macro>>extensions:Extension.JIRA Macro]] is now part of the Platform but is not bundled by default (you'll need to install it with the Extension Manager). We previously had a [[Contributed JIRA Macro>>extensions:Extension.Contrib JIRA Macro]] but we decided that the JIRA macro was a good candidate to have in the Platform and thus supported by the XWiki Development Team. Compared to the older Contributed JIRA Macro, the new Macro has the following advantages:
15 * No Programming Rights required
16 * Supports issue ordering
17 * Supports ability to register new Styles, new Data Sources and new Field Displayers
18 * Displays closed issues as Striked-out
19 * Written in Java with automated tests
21 {{image reference="extensions:Extension.JIRA [email protected]"/}}
23 == Extension Manager improvements ==
25 Main improvements:
27 * Starting with this version you can downgrade an extension. In other words, you can install an older version of an extension even if a newer version is currently installed. This doesn't apply to core extensions, which cannot be uninstalled, upgraded or downgraded individually. In order to downgrade an extension that is already installed you need to search for an older version. Currently this is possible only using the advanced search.(((
28 {{image reference="EM-extensionDowngradePlan.png"/}}
29 )))
30 * From the main wiki of a wiki farm you now have the option to trigger extension jobs (install, uninstall, upgrade, downgrade, etc.) that target all the wikis. For instance, as you can see below, you can install an extension on the entire wiki farm:(((
31 {{image reference="EM-extensionGlobalInstall.png"/}}
32 )))
33 * The log messages have been improved to include links to the affected documents or extensions as indicated in the following image~:(((
34 {{image reference="EM-extensionLogMessage"/}}
35 )))
37 == New field types for email and list of pages ==
39 Two new types of class properties have been added:
41 * The //Email// type extends the normal //String// type, adding by default a validation regular expression that should accept only a valid email address
42 * The //Page// type extends the normal //DBList// type, and allows to select one or more documents from the current wiki
44 These two new properties are still in development, and further improvements will be implemented in the next milestone.
46 == Computed class fields ==
48 Another new type of class fields adds support for //virtual values// computed live from other class values, data from the database, data obtained from an external service, or practically any other source of data. These fields are non-editable and aren't stored in the database, since they only provide some wiki content that will be rendered each time such a property is displayed.
50 Traditionally, this kind of computation would have been written directly in the sheet used to display instances of that class, but putting it in a class field allows easier reuse of the code, since the property will be //displayed// in livetables, when indexing the document in Lucene, when displaying documents in an index page, and so on.
52 == Improvements to the Extension Repository Application ==
54 We modified the extension sheet to display the release notes for all the available versions of an extension. Check for instance the release notes for the [[Extended TODO Application>>extensions:Extension.Extended Todo Application#HReleaseNotes]]:
56 {{image reference="ER-releaseNotes.png"/}}
58 == Improvements to Extension Manager ==
60 An administrator of a subwiki can now install XAR extension (as long as it does not require a JAR extension).
63 == Improved upload UI ==
65 The new HTML5 FileUploader has been integrated in a few places:
67 * The standard attachment upload form
68 * The Import section of the Administration
70 See [[below>>||anchor="HNewHTML5FileUploadwidget"]] for more details about this feature.
72 == New logging administration UI ==
74 It's now possible to review and modify the log level for all registered loggers.
76 {{image reference="extensions:Extension.Logging [email protected]"/}}
78 == Experimental install/upgrade wizard ==
80 Accessing a wiki page in view mode after an upgrade or when the database is empty (new install) will trigger a wizard that will allow you to install or update the default set of wiki pages and to upgrade or downgrade the extensions you may have previously installed.
82 The wizard currently has two steps. In the first step you can see which XWiki distribution you are running and what is its recommended default set of wiki pages (the default user interface). You should install, upgrade or downgrade the UI so that it matches the distribution version.
84 {{image reference="Distribution-MainUI.png"/}}
86 The step has three possible actions:
88 * Skip means 'go to the next step and ask me again after a server restart'
89 * Cancel means 'go to the next step and don't ask me again until I change my distribution'
90 * Continue, only after the recommended UI version is installed
92 In the second step you can upgrade the installed extensions. We group them in two categories:
94 * extensions that don't work with your current distribution but which have new versions available that are compatible with your current distribution. These extension require an upgrade.
95 * extensions that should work fine with your current distribution but which have upgrades available. Upgrading these extensions is optional.
97 {{image reference="Distribution-OutdatedExtensions.png"/}}
99 You can refresh the list of extensions by clicking on the Reload button. The Skip and Cancel buttons have the same meaning as in the previous step. The Continue button is available only after the required upgrades are performed.
101 At the end you'll be redirected back to the wiki page you have accessed in the first place.
103 == New Applications Panel ==
105 There's now a new "Applications" panel by default in XWiki Enterprise. This panel displays the applications present in your wiki.
107 {{image reference="applicationsPanelStandard.png"/}}
109 Administrators will get a couple of additional links, allowing them to install applications through the [[Extension Manager>>extensions:Extension.Extension Manager Application]], or to create new applications thanks to the [[App Within Minutes feature>>extensions:Extension.App Within Minutes Application]].
111 {{image reference="applicationsPanel.png"/}}
113 {{info}}
114 Note for application developers: your applications can provide their own entries in this menu by [[declaring a UI Extension>>extensions:Extension.UIExtension Module]].
115 {{/info}}
117 == Chart Macro Improvements ==
119 * The [[Chart macro>>extensions:Extension.Chart Macro]] will now automatically default to the ##inline## Data Source type when not specified and the Chart Macro has some content.
120 * [[Two new Chart types have been added: XY Line 3D and XY Step>>extensions:Extension.Chart Macro]]. Examples:(((
121 {{image reference="timeseries-line3D.png"/}}
123 {{image reference="timeseries-step.png"/}}
124 )))
126 == New Content Macro ==
128 The [[new Content macro>>extensions:Extension.Content Macro]] allows to enter content in any of the supported Syntaxes and thus allows to have content written in various syntaxes. For example, in a page in XWiki Syntax 2.0:
130 {{code}}
131 This is in **bold**
133 {{content syntax="confluence/1.0"}}
134 This is *bold* too!
135 {{/content}}
136 {{/code}}
138 == Documents Macro improvements ==
140 The ##~{~{documents}}## macro [[now supports specifying the list of columns to display>>extensions:Extension.Documents Macro]]. For example:
142 {{code}}
143 {{documents count="5" actions="false" space="Main" parent="Main.WebHome" columns="doc.title"/}}
144 {{/code}}
146 would display:
148 {{image reference="documents-columns.png"/}}
150 == Search improvements ==
152 The Lucene index also stores the MIME type of the indexed attachments, allowing to customize the search to only include or exclude attachments of a certain type. The new field is named [[##mimetype##>>doc:extensions:Extension.Search Application Query Syntax||anchor="Hmimetype"]] and it contains a valid MIME type string, as returned by the container in which XWiki is running. For example, add ##-mimetype:image/*## to a query to exclude all image attachments from the results, or add ##mimetype:application/pdf## to only search inside PDF attachments.
154 Remember that in case of an upgrade, you have to rebuild the entire index to have this new field for existing documents.
156 = For Developers =
158 == New Git Module ==
160 A new, optional (i.e. not installed by default), [[Git Module has been added>>extensions:Extension.Git Module]]. It allows to easily perform Git operations from within wiki pages. For example to count all commits for the past year and list all committers who's committed code during this period, you could write in a wiki page:
162 {{code language="java"}}
163 {{groovy}}
164 import*
165 import org.eclipse.jgit.api.*
166 import org.eclipse.jgit.lib.*
167 import org.eclipse.jgit.revwalk.*
168 import*
169 import org.gitective.core.*
170 import org.gitective.core.filter.commit.*
172 def service = services.get("git")
173 def commonsRepository = service.getRepository("git://", "xwiki-commons")
174 // Do a Git pull to get latest commits
175 new Git(commonsRepository).pull().call()
176 def finder = new CommitFinder(commonsRepository)
178 def dateFilter = new CommitterDateFilter(System.currentTimeMillis() - 365*24*60*60*1000L)
179 def countFilter = new CommitCountFilter()
180 def authorFilter = new AuthorSetFilter()
181 def filters = new AndCommitFilter()
182 filters.add(countFilter, authorFilter)
183 finder.setFilter(dateFilter)
184 finder.setMatcher(filters)
185 finder.find()
187 println "There have been ${countFilter.count} commits in the past year!"
188 println ""
190 println "The following committers have participated in those commits:"
191 authorFilter.getPersons().each() {
192 println "* ${} (${it.emailAddress})"
193 }
194 {{/groovy}}
195 {{/code}}
197 == Default custom displayers for Easier customization of the way object fields are displayed ==
199 While XWiki allowed to specify a custom display for a given field, it was impossible to change the way field types, such as //DateProperty// or //IntegerProperty//, are displayed in general. Now it is possible to define custom displayers at the farm or wiki level, which gives the administrators more power to change the look and feel of the wiki. For example, this allows to use HTML5 input types for dates and numbers, to use custom suggestions for //list of users// fields, or to always add a validation input for all the //password// field types.
201 To use this feature, first you need to compute a //type// name for your property type. This is obtained from the java class simple name, removing the ##Class## suffix, and lowercasing. For example, for numbers the java class used is ##com.xpn.xwiki.objects.classes.NumberClass##, with the simple name ##NumberClass##, which gives ##number## as the type name. For a database list, we get ##dblist## from ##DBListClass##.
203 Next, there are three places where a default custom displayer can be defined.
205 1. If a document whose name is the //type// capitalized and suffixed with ##Displayer## exists in the ##XWiki## space in the current wiki, then its content is used as the default custom displayer for that type of property. For example, ##localwiki:XWiki.NumberDisplayer## and ##localwiki:XWiki.DblistDisplayer##.
206 1. If a document whose name is the //type// capitalized and suffixed with ##Displayer## exists in the ##XWiki## space in the main wiki, then its content is used as the default custom displayer for that type of property. For example, ##xwiki:XWiki.NumberDisplayer## and ##xwiki:XWiki.DblistDisplayer##.
207 1. If a velocity template whose name is the //type// suffixed with ##.vm## exists in the current skin, then it is evaluated as the default custom displayer for that type of property. A skin file can be defined in many places, such as an attachment of a skin document, a file in a named skin on the filesystem, or a file in the ##templates/## directory.
209 If a specific class property provides custom display code in the XClass, then that code takes priority over an eventual default custom displayer for that property.
211 As with property custom displayers, when evaluating the display code several objects are placed in the context:
213 * ##name## is the name of the property being displayed
214 * ##prefix## is the HTML name prefix to append to an eventual input field name, and contains the XClass name, an underscore, the object number, and another underscore, for example ##XWiki.XWikiUsers_0_##
215 * ##object## is the object owning the displayed property, an instance of the public ##com.xpn.xwiki.api.Object## class
216 * ##type## is the target display type, one of ##view##, ##edit##, ##hidden## or ##search##
218 == New API to manipulate log level ==
220 Several method as been added to ##org.xwiki.logging.LoggerManager## to manipulate the log level of registered loggers.
222 {{code language="java"}}
223 /**
224 * Associate the passed logger to the passed log level.
225 *
226 * @param loggerName the logger
227 * @param level the level of the logger
228 */
229 void setLoggerLevel(String loggerName, LogLevel level);
231 /**
232 * @param loggerName the logger
233 * @return the log level associated to the logger
234 */
235 LogLevel getLoggerLevel(String loggerName);
237 /**
238 * @return all the registered loggers
239 */
240 Collection<Logger> getLoggers();
241 {{/code}}
244 == New HTML5 File Upload widget ==
246 The [[File Upload widget>>doc:platform:DevGuide.HTML5Upload]] can enhance HTML input elements of type file to provide an interactive upload UI. It can submit files either automatically when the user selects local files, or after the user presses the container form's submit button.
248 To use this widget, it is enough to create a new instance of ##XWiki.FileUploader## passing the target ##input## element as the first parameter, and an optional configuration object as the second parameter.
250 {{code language="javascript"}}
251 new XWiki.FileUploader(targetInput, {
252 autoUpload: true,
253 progressAutohide: true
254 });
255 {{/code}}
257 [[image:platform:Dev[email protected]||class="screenshot"]]
259 == JSRX and SSRX ==
261 It's now possible by default to add [[skin extensions>>extensions:Extension.Skin Extension Plugin]] located in JAR files. Example usage:
263 {{code}}
264 $xwiki.jsrx("/lib/codemirror.js")
265 $xwiki.ssrx("/lib/codemirror.css")
266 {{/code}}
268 == Attachment Picker improvements ==
270 It is now possible to specify a different document for the source (and target in case of uploads) of attachments, using the new ##targetdocname## macro parameter.
272 == Extension Manager improvements ==
274 * the custom Maven property <xwiki.extension.features> now accept any number of new lines and white spaces between elements(((
275 {{code language="xml"}}
276 <xwiki.extension.features>
277 org.xwiki.platform:xwiki-platform-oldcore,
278 com.xpn.xwiki.platform:xwiki-core
279 </xwiki.extension.features>
280 {{/code}}
281 )))
282 * new custom properties added to overwrite standard Maven properties:
283 ** to overwrite ##<name>##
284 ** ##xwiki.extension.summary## to overwrite ##<description>##
285 ** to overwrite ##<url>##
287 == XAR format improvement ==
289 It's now possible to indicate the extension identifier right in the XAR package descriptor (package.xml). Among other things this allow standard import UI to find what it currently importing and register it automatically as installed extension if it can be found in the registered repositories during import process.
291 The XAR Maven plugin automatically take care of adding this information to the generated package.xml for Maven project. If for some reason you need to indicate it by hand you can use the property <extensionId> under the the <infos> element in the package.xml file.
293 {{code language="xml"}}
294 <package>
295 <infos>
296 <name>XWiki Platform - Extension - UI</name>
297 <description>XWiki Extension Manager, an application for managing extensions in a wiki.</description>
298 <licence></licence>
299 <author>XWiki.Admin</author>
300 <extensionId>org.xwiki.platform:xwiki-platform-extension-ui</extensionId>
301 <version>4.2-SNAPSHOT</version>
302 <backupPack>true</backupPack>
303 </infos>
304 <files>
305 [...]
306 </files>
307 </package>
308 {{/code}}
310 == New UI Extension mechanism (experimental) ==
312 We're in the process of allowing applications to insert custom content in pre-defined places in the user interface. A first Extension Point has been defined in the new "Applications" panel, you can read more about this in the [[UI Extension module documentation>>extensions:Extension.UIExtension Module]].
314 == Miscellaneous ==
316 * The transformation context have a "restricted" flag to indicate that macros and other transformations should not perform modifications to the database, expensive computations or other potentially harmful operations. Developers of macros and other rendering extensions should pay attention to this flag.
317 * The messageSender macro now accepts 3 parameters that allow you to customize it by overriding the default displayed visibility levels for a message (that a user can choose from), the default selected visibility level and the default value (in case of user or group visibility). More details on {{jira style="enum" url=""}}XWIKI-7974{{/jira}}.
318 * The [[new experimental Security API that was first released in XWiki 4.0>>xwiki:ReleaseNotes.ReleaseNotesXWikiEnterprise40||anchor="HNewRightsImplementation28Experimental29"]] is now bundled by default in XWiki Enterprise.
319 * It's now possible to access root ComponentManager using "root" role hint:(((
320 {{code language="java"}}
321 @Inject
322 @Named("root")
323 private ComponentManager rootComponentManager;
324 {{/code}}
325 )))
326 * A Provider has been added to easily access the context ComponentManager (a proxy which choose the right ComponentManager depending on context information like the current user and the current wiki)(((
327 {{code language="java"}}
328 @Inject
329 @Named("context")
330 private Provider<ComponentManager> contextComponentManager;
331 {{/code}}
332 )))
333 * The ##AbstractMockingComponentTestCase## testing framework class has been modified. Read the [[Testing page>>dev:Community.Testing]] for more details on how to use it.
335 == Deprecated and Retired projects ==
337 <description of deprecated and retired projects>
339 == Upgrades ==
341 The following dependencies have been upgraded:
343 * Infinispan 5.1.5
344 * JDeb 0.11
345 * JGroups 3.1.0
346 * Tika 1.2
347 * GWT 2.5 RC1
348 * Selenium 2.25
349 * Prototype.js 1.7.1
350 * Jython 2.5.3
351 * Pegdown 1.1.0 (used by the XWiki Markdown Parser)
352 * Xalan 2.7.1
354 == Miscellaneous ==
356 * the progress tab is selected by default when you view the extension details if there is a job running (e.g. install in progress) for that extension
357 * when there is a merge conflict, the 'Show changes' button updates the changes asynchronously without reloading the entire page
358 * attachments of pages installed with the extension manager now have the right author set: the current user instead of the author from the XAR as it used to be
359 * the file size of attachments installed with the extension manager is now properly set
360 * the installation process is now more robust with respect to the exceptions that can occur while installing a JAR extension with components
361 * Document attachments so far have been displayed in the order in which they are returned by the database, which most of the time happened to be the upload date. Starting with this version attachments are displayed ordered by their filename, which makes it easier to find an attachment, but support for selecting a different order (date, size, author...) will be added soon.
362 * Uploading attachments with '+' character in their file names using the WebDAV interface shouldn't pose any more problems.
363 * It's now possible to use Velocity scripts in the Copyright field in the Administration.
364 * The XWiki Installer now fully works on Windows 7. The XWiki Data is now put in the ##%APPDATA%\XWiki Enterprise <version>\data## directory, while the binaries are installed in ##Program Files##.
365 * It is no longer allowed to use scripts in comments. This reduces the security risk from users that only have comment rights.
366 * Macro parameters may now contain macro syntax. Example: {{{ {{box title="{{info}}Hello!{{/info}}" }}Lorem ipsum ...{{/box}} }}}
367 * Improve OOB support for JBoss AS7:
368 ** Removed Struts Taglibs completely since we don't use them and some were defined but not made available, causing errors in deployments on JBoss AS7 ({{jira style="enum" url=""}}XWIKI-7986{{/jira}})
369 ** Fixed Logging conflict between JBoss AS and XWiki ({{jira style="enum" url=""}}XWIKI-7987{{/jira}})
370 * The [[IRC Bot Application>>extensions:Extension.IRC Bot Application]] now recognizes XAR import events and when receiving one, it doesn't send subsequent IRC notifications for modified or created documents to avoid spamming the IRC channel.
371 * Display the request URL in the IRC channel when the Link Checker bot listener is active and a broken link is found, thus making it easier to reproduce and debug the broken link
373 == Translations ==
375 The following translations have been updated:
377 {{language codes="da, fr, pt_BR, ru, zhm, hu, it, lv, sv"/}}
379 = Tested Browsers =
381 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]]):
383 {{velocity}}
384 ## name = iexplorer, firefox, chrome, safari, opera
385 {{/velocity}}
387 {{browser name="browser" version="x.x"/}}
389 = Known issues =
391 * [[Bugs we know about>>]]
393 = Test Report =
395 You can check the [[manual test report>>TestReports.WebHome#<anchor to test report>]] to learn about what was tested and the results on various browsers.
397 = Backward Compatibility and Migration Notes =
399 == General Notes ==
401 You may also want to [[import the default wiki XAR>>Main.Download]] in order to benefit from all the improvements listed above.
403 {{warning}}
404 Always make sure you compare your ##xwiki.cfg## and files with the newest version since some configuration parameters were 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.
405 {{/warning}}
407 == Issues specific to XWiki <version> ==
409 <issues specific to the project>
411 == API Breakages ==
413 The following APIs were modified since <project> <version - 1>:
415 {{code language="none"}}
416 <clirr output here>
417 {{/code}}

Get Connected