Release Notes for XWiki 9.8 (XWiki.org)

author	version	line-number	content
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 introduces a new feature for the Notifications: Watched Entities. It is an experimental feature that will soon replace the [[Watchlist Application>>extensions:Extension.Watchlist Application]]. To try it out and get familiar with it, you need to enable it, since it is currently disabled by default.
8
9	For users, we now have more usable notification filter settings, a nice helper when you edit a "Database List" field and a feature that was missing from the CKEditor integration, which is office import.
10
11	For developers, it is easier to propose an extension containing REST resources, or to customize the Flamingo LESS code. We have also exposed more database columns in the Query Module for users who don't have programming rights. The notification filters AST (Abstract Syntax Tree) proposes new types of nodes to create complex filter queries. There are also new facilities to avoid using SyntaxFactory, to make Extension Manager faster, or to have more control over some skin elements (CSS IDs and layout variables).
12
13	= New and Noteworthy (since XWiki 9.7) =
14
15	[[Full list of issues fixed and Dashboard for 9.8>>https://jira.xwiki.org/secure/Dashboard.jspa?selectPageId=13916]].
16
17	{{releasenotechanges/}}
18
19	=== Upgrades ===
20
21	The following runtime dependencies have been upgraded (they have a different release cycle than [[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]]):
22
23	* [[CKEditor Integration 1.17>>https://jira.xwiki.org/browse/XWIKI-14723]]
24	* [[CSS4J 0.36>>https://jira.xwiki.org/browse/XWIKI-14684]]
25	* [[Jackson 2.9.1>>https://jira.xwiki.org/browse/XCOMMONS-1254]]
26	* [[Restlet 2.3.10>>https://jira.xwiki.org/browse/XWIKI-14678]]
27	* [[org.osgi.core 6.0.0>>https://jira.xwiki.org/browse/XCOMMONS-1250]]
28	* [[Commons Configuration 2.1.1>>https://jira.xwiki.org/browse/XCOMMONS-1231]]
29	* [[Bouncy Castle 1.58>>https://jira.xwiki.org/browse/XCOMMONS-1244]]
30
31	= Translations =
32
33	The following translations have been updated:
34
35	{{language codes="hr, de, pl"/}}
36
37	= Tested Browsers & Databases =
38
39	{{include reference="TestReports.ManualTestReportSummaryXWiki98.WebHome"/}}
40
41	{{comment}}
42	TODO: uncomment and update with proper links when the report is ready.
43
44	= Performances tests compared to <last super stable version> =
45
46	<a summary of the comparison with latest super stable version>
47
48	More details on <link to the test report>.
49	{{/comment}}
50
51	= Known issues =
52
53	* [[Bugs we know about>>https://jira.xwiki.org/issues/?jql=category%20%3D%2010000%20AND%20issuetype%20%3D%20Bug%20AND%20resolution%20%3D%20Unresolved%20ORDER%20BY%20updated%20DESC]]
54
55	= Backward Compatibility and Migration Notes =
56
57	== General Notes ==
58
59	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.
60
61	== Database List Property Values ==
62
63	We fixed a few security issues around Database List properties by:
64
65	* restricting the type of explicit query you can use on the Database List definition based on the class author rights
66	* evaluating the Velocity code from the explicit query only if the class author has script right
67	* checking if the current user has the right to view the returned values (when implicit query is used)
68
69	This may break existing applications if they use Database List properties and the last author of the class that holds the property definition doesn't have sufficient rights.
70
71	== Changes in the way the ##$docextra## variable works ==
72
73	If, prior to 9.8, you were using the ##$docextra## variable to hide the document tags and creator/creation-date or to hide the viewers section in the "More actions" content menu, please be advised that it will not work as expected anymore. Please read above, in this release notes, how ##$displayContentFooter##, ##$displayDocExtra## and/or ##$displayShortcuts## should be used instead.
74
75	== API Breakages ==
76
77	The following APIs were modified since XWiki 9.7:
78
79	{{backwardCompatiblityReport version="9.8"/}}
80
81	= Credits =
82
83	The following people have contributed code to this release (sorted alphabetically):
84
85	* Anca Luca
86	* Clément Aubin
87	* Ecaterina Moraru (Valica)
88	* Eduard Moraru
89	* Guillaume Delhumeau
90	* Marius Dumitru Florea
91	* Pascal B
92	* Sergiu Dumitriu
93	* Thomas Mortagne
94	* Vincent Massol

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 introduces a new feature for the Notifications: Watched Entities. It is an experimental feature that will soon replace the [[Watchlist Application>>extensions:Extension.Watchlist Application]]. To try it out and get familiar with it, you need to enable it, since it is currently disabled by default.

8

9

For users, we now have more usable notification filter settings, a nice helper when you edit a "Database List" field and a feature that was missing from the CKEditor integration, which is office import.

10

11

For developers, it is easier to propose an extension containing REST resources, or to customize the Flamingo LESS code. We have also exposed more database columns in the Query Module for users who don't have programming rights. The notification filters AST (Abstract Syntax Tree) proposes new types of nodes to create complex filter queries. There are also new facilities to avoid using SyntaxFactory, to make Extension Manager faster, or to have more control over some skin elements (CSS IDs and layout variables).

12

13

= New and Noteworthy (since XWiki 9.7) =

14

15

[[Full list of issues fixed and Dashboard for 9.8>>https://jira.xwiki.org/secure/Dashboard.jspa?selectPageId=13916]].

=== Upgrades ===

The following runtime dependencies have been upgraded (they have a different release cycle than [[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]]):

22

23

* [[CKEditor Integration 1.17>>https://jira.xwiki.org/browse/XWIKI-14723]]

24

* [[CSS4J 0.36>>https://jira.xwiki.org/browse/XWIKI-14684]]

25

* [[Jackson 2.9.1>>https://jira.xwiki.org/browse/XCOMMONS-1254]]

26

* [[Restlet 2.3.10>>https://jira.xwiki.org/browse/XWIKI-14678]]

27

* [[org.osgi.core 6.0.0>>https://jira.xwiki.org/browse/XCOMMONS-1250]]

28

* [[Commons Configuration 2.1.1>>https://jira.xwiki.org/browse/XCOMMONS-1231]]

29

* [[Bouncy Castle 1.58>>https://jira.xwiki.org/browse/XCOMMONS-1244]]

= Translations =

The following translations have been updated:

= Tested Browsers & Databases =

38

39

{{include reference="TestReports.ManualTestReportSummaryXWiki98.WebHome"/}}

40

41

42

TODO: uncomment and update with proper links when the report is ready.

43

44

= Performances tests compared to <last super stable version> =

More details on <link to the test report>.

= Known issues =

* [[Bugs we know about>>https://jira.xwiki.org/issues/?jql=category%20%3D%2010000%20AND%20issuetype%20%3D%20Bug%20AND%20resolution%20%3D%20Unresolved%20ORDER%20BY%20updated%20DESC]]

54

55

= Backward Compatibility and Migration Notes =

== General Notes ==

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.

60

61

== Database List Property Values ==

62

63

We fixed a few security issues around Database List properties by:

64

65

* restricting the type of explicit query you can use on the Database List definition based on the class author rights

66

* evaluating the Velocity code from the explicit query only if the class author has script right

67

* checking if the current user has the right to view the returned values (when implicit query is used)

68

69

This may break existing applications if they use Database List properties and the last author of the class that holds the property definition doesn't have sufficient rights.

70

71

== Changes in the way the ##$docextra## variable works ==

72

73

If, prior to 9.8, you were using the ##$docextra## variable to hide the document tags and creator/creation-date or to hide the viewers section in the "More actions" content menu, please be advised that it will not work as expected anymore. Please read above, in this release notes, how ##$displayContentFooter##, ##$displayDocExtra## and/or ##$displayShortcuts## should be used instead.

== API Breakages ==

The following APIs were modified since XWiki 9.7:

= Credits =