Show last authors
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 integrates CKEditor as the default WYSIWYG content editor and adds a //tour// on the home page to describe the XWiki user interface to newcomers.
8
9 = New and Noteworthy (since XWiki 8.2 Milestone 2) =
10
11 [[Full list of issues fixed and Dashboard for 8.2>>http://jira.xwiki.org/secure/Dashboard.jspa?selectPageId=13615]].
12
13 == Tour for Homepage ==
14
15 A [[tour>>extensions:Extension.Tour Application]] has been created to present the existing UI elements from the home page. Every user will be guided through this tour in order to become familiar with XWiki.
16
17 {{image reference="step4.png" width="600px;"/}}
18
19 == CKEditor Becomes the Default WYSIWYG Editor ==
20
21 Starting with this version we have a new WYSIWYG editor: the [[CKEditor>>extensions:Extension.CKEditor Integration]]. The integration with CKEditor was already available as an extension and now this extension is bundled with the standard XWiki distribution.
22
23 {{image reference="ckeditor.png" width="600"/}}
24
25 The old WYSIWYG editor is still available and if you want to switch back to it you can do it from the "Edit Mode Settings" section in the wiki administration.
26
27 {{image reference="defaultWysiwygEditorConfig.png" width="600"/}}
28
29 == Miscellaneous ==
30
31 * Removed ##Main.Welcome## page from the Dashboard since we now have a new Homepage that contains the welcome messages
32 * In the TemplateProviderClass, 2 new properties have been added: //description// and //icon//, in order to display additional information in template providers list.(((
33 {{gallery}}
34 image:templates.png
35 image:templateView.png
36 image:templateEdit.png
37 {{/gallery}}
38 )))
39 * events produced during Filter conversion job are now folded by default. This essentially means that they won't appear in Activity Stream anymore.
40
41 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%29+and+status+%3D+Closed+and+resolution+%3D+Fixed+and+fixVersion+%3D+%228.2-rc-1%22&tempMax=1000]] fixed in this release.
42
43 = For Developers =
44
45 == Associate Editors to Data Types ==
46
47 This version introduces a new module that provides APIs to associate editors to data types. For instance you can associate a date picker to ##java.util.Date##, or a WYSIWYG editor to ##org.xwiki.rendering.block.XDOM##. There can be multiple editors available for a specific data type and the user or the administrator can configure the preferred one. Checkout the [[Edit Module>>extensions:Extension.Edit Module]] documentation for more details. This new API has been used to embed CKEditor as the default WYSIWYG editor.
48
49 == Instance Filter improvements ==
50
51 * Instance Output Filter now support missing begin/end event on document locale and revision so input filter for which those two concept don't make sense don't have to send them anymore.
52 * Instance Output Filter now use the context locale as default locale (used to be empty locale).
53
54 == Deprecated and Retired projects ==
55
56 === MediaWiki parser ===
57
58 ##xwiki-rendering-syntax-mediawiki## has been deprecated and moved to https://github.com/xwiki-contrib/syntax-mediawiki-1.0.
59
60 It's now recommended to use [[MediaWiki Syntax extension>>extensions:Extension.MediaWiki.MediaWiki Syntax]] instead.
61
62 == Upgrades ==
63
64 The following dependencies have been upgraded:
65
66 * [[Guice 4.1.0>>http://jira.xwiki.org/browse/XCOMMONS-1004]]
67 * [[Commons Compress 1.12>>http://jira.xwiki.org/browse/XCOMMONS-1005]]
68 * [[httpasyncclient 4.1.2>>http://jira.xwiki.org/browse/XCOMMONS-1009]]
69 * [[JGroups 3.6.10>>http://jira.xwiki.org/browse/XWIKI-13532]]
70 * [[Less4j 1.17.2>>http://jira.xwiki.org/browse/XWIKI-13119]]
71 * [[Infinispan 8.2.3>>http://jira.xwiki.org/browse/XWIKI-13561]]
72
73 == Miscellaneous ==
74
75 * new ##org.xwiki.rendering.listener.SectionGeneratorListener## to generate section events from headers events
76 * Instance Output filter now indicate the target syntax for Input filters producing rendering events
77 * The same relative file path supported for ##source## filter properties parameter is now supported for any InputSource filter properties parameter in the Filter test framework
78 * ##$regextool## [[Velocity Tool>>extensions:Extension.Velocity Module||anchor="HVelocityTools"]] has a new method to quote the replacement string in ##String#replaceAll()##. Here's how you can use it:(((
79 {{code language="none"}}
80 #set ($out = $out.replaceAll(" (id|for)=('|"")$regextool.quote($oldId)",
81 " ${escapetool.d}1=${escapetool.d}2$regextool.quoteReplacement($newId)"))
82 {{/code}}
83 )))
84
85 = Translations =
86
87 The following translations have been updated:
88
89 {{language codes="fr, nl"/}}
90
91 = Tested Browsers & Databases =
92
93 {{warning}}
94 The QA Tests are executed after the release has been done. Thus, they are being prepared now and will be published soon.
95 {{/warning}}
96
97 {{comment}}
98 TODO: uncomment and update with proper link when the report is ready.
99 {{include reference="TestReports.ManualTestReportSummaryXWiki82RC1"/}}
100 {{/comment}}
101
102 = Known issues =
103
104 * [[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]]
105
106 = Backward Compatibility and Migration Notes =
107
108 == General Notes ==
109
110 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.
111
112 == Issues specific to XWiki 8.2RC1 ==
113
114 We refactored the way in which the editors are loaded for page content and TextArea properties. We're now using the new [[Edit API>>extensions:Extension.Edit Module]]. The following breaking changes have been done:
115 * ##textarea_text.vm## and ##textarea_wysiwyg.vm## Velocity templates have been removed. In case you have customized these templates you can port the changes to the new editor templates available in ##/templates/editors/xdom*.vm##
116 * ##$xcontext.getEditorWysiwyg()## has been deprecated and is now returning ##null## all the time (which translates into "no TextArea fields that need a WYSIWYG editor"). If you were using this method to customize the WYSIWYG editor then you can do the same from the new editor templates available in ##/templates/editors/xdom*.vm##
117
118 A side effect of this refactoring is that the Object and Class editors are now using the configured preferred editor, unless it is overwritten using the "editor" meta property.
119 * If you have a TextArea property that doesn't support wiki syntax then best is to configure the xclass to use the //PureText// editor for this property.
120 * If the TextArea property supports wiki syntax but it's mostly code (e.g. Velocity, HTML) then best is to configure the Text editor.
121 * Finally, if the TextArea property supports wiki syntax and it's mostly free text then best is to configure the WYSIWYG editor.
122
123 == API Breakages ==
124
125 The following APIs were modified since XWiki 8.1:
126
127 {{backwardCompatiblityReport version="8.2-rc-1"/}}
128
129 = Credits =
130
131 The following people have contributed code to this release (sorted alphabetically):
132
133 * Alexandru Cotiuga
134 * Anca Luca
135 * Ecaterina Moraru (Valica)
136 * Eduard Moraru
137 * Guillaume Delhumeau
138 * Marius Dumitru Florea
139 * Raluca Stavro
140 * Thomas Mortagne
141 * Vincent Massol

Get Connected