Wiki source code of Release Notes for XWiki 8.2
Version 5.3 by Ecaterina Moraru (Valica) on 2016/07/22
Show last authors
| 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 integrates CKEditor as the default WYSIWYG content editor. It also features a redesigned default homepage, a tour on the home page to describe the XWiki user interface to newcomers, new default templates, a new application index in the drawer and a new administration UI to help manage available syntaxes. There are also minor improvements to the template providers, the Flamingo skin and Ratings. For developers, we have Livetable macro improvements and a long overdue change of behavior for the ##getRenderedContent()## method. | ||
| 8 | |||
| 9 | = New and Noteworthy (since XWiki 8.1) = | ||
| 10 | |||
| 11 | [[Full list of issues fixed and Dashboard for 8.2>>http://jira.xwiki.org/secure/Dashboard.jspa?selectPageId=13615]]. | ||
| 12 | |||
| 13 | == CKEditor Becomes the Default WYSIWYG Editor == | ||
| 14 | |||
| 15 | 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. | ||
| 16 | |||
| 17 | {{image reference="ReleaseNotes.ReleaseNotesXWiki82RC1.WebHome@ckeditor.png" width="600"/}} | ||
| 18 | |||
| 19 | 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. | ||
| 20 | |||
| 21 | {{image reference="ReleaseNotes.ReleaseNotesXWiki82RC1.WebHome@defaultWysiwygEditorConfig.png" width="600"/}} | ||
| 22 | |||
| 23 | == New Homepage == | ||
| 24 | |||
| 25 | We replaced the Dashboard application from the main Homepage and added introductory steps as wiki syntax. This change will make it simpler for new users to edit the Homepage content, while also benefiting from some basic help concepts. The left panels area also showcases now the "Navigation" panel, while the right panels area contain a "Need Help?" panel. | ||
| 26 | {{image reference="Homepage.png" width="600px;"/}} | ||
| 27 | |||
| 28 | == Tour for Homepage == | ||
| 29 | |||
| 30 | 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. | ||
| 31 | |||
| 32 | {{image reference="ReleaseNotes.ReleaseNotesXWiki82RC1.WebHome@step4.png" width="600px;"/}} | ||
| 33 | |||
| 34 | == Default Templates == | ||
| 35 | |||
| 36 | We added 4 default templates that will appear in the Create step. Their purpose is to showcase the template feature, by providing pre-created page structure that can be used immediately. The templates added are: Article, Encyclopedia, Meeting Report and Simple Page. | ||
| 37 | |||
| 38 | {{image reference="templates_create.png" width="600px;"/}} | ||
| 39 | |||
| 40 | {{image reference="templates.png" width="600px;"/}} | ||
| 41 | |||
| 42 | == Application Index == | ||
| 43 | |||
| 44 | We removed some applications from the AppBar (like Scheduler, Invitation, Panels, etc.) with the intention to simplify the interface and promote a smaller number of applications inside the AppBar panel. In order for the applications to still be discoverable, we added in the Drawer an [[Application Index>>extensions:Extension.Application Index Application]]. | ||
| 45 | |||
| 46 | {{image reference="ReleaseNotes.ReleaseNotesXWiki82M2.WebHome@appIndex.png" width="600px;"/}} | ||
| 47 | |||
| 48 | == Configure Syntaxes in Administration UI == | ||
| 49 | |||
| 50 | It's now possible to [[easily configure the markup syntaxes>>extensions:Extension.Rendering Administration Application]] that you wish to be made available to your users when writing pages, directly from the Admin UI. | ||
| 51 | |||
| 52 | {{image reference="ReleaseNotesXWiki82M1@admin-rendering.png"/}} | ||
| 53 | |||
| 54 | We've also modified the default syntax configuration when you start with a fresh new XWiki; by default the only configured syntax is the XWiki Syntax 2.1. To add more you need to install extensions offering new syntaxes or go to the Admin UI to configure more syntaxes for those bundled by default in XWiki. | ||
| 55 | |||
| 56 | Note that the ##xwiki/2.1## syntax is the only configured syntax by default now (we used to also have the ##xwiki/2.0## syntax too but we want to incitate users to use the newest syntax). In addition when the user is an Admin and only 1 syntax is configured, a hint is given to the user to let him know he can configure more syntaxes: | ||
| 57 | |||
| 58 | {{image reference="ReleaseNotesXWiki82M1@edit-more-syntaxes.png"/}} | ||
| 59 | |||
| 60 | == Miscellaneous == | ||
| 61 | |||
| 62 | * Removed ##Main.Welcome## page from the Dashboard since we now have a new Homepage that contains the welcome messages | ||
| 63 | * You now have the option to create a blog post from anywhere inside the Blog page (or one of its children) by simply using the ##+## (create page) button and selecting //Blog Post// as your new page's type. | ||
| 64 | * When creating a new page, the Template Providers for specific applications can now add an //icon// and a //description//, in order to display additional information in template providers list. We added new icons and descriptions for the Blog and Dashboard default templates. ((( | ||
| 65 | {{gallery}} | ||
| 66 | image:ReleaseNotes.ReleaseNotesXWiki82RC1.WebHome@templates.png | ||
| 67 | image:ReleaseNotes.ReleaseNotesXWiki82RC1.WebHome@templateView.png | ||
| 68 | image:ReleaseNotes.ReleaseNotesXWiki82RC1.WebHome@templateEdit.png | ||
| 69 | {{/gallery}} | ||
| 70 | ))) | ||
| 71 | * Events produced during Filter conversion job are now folded by default. This essentially means that they won't appear in Activity Stream anymore. | ||
| 72 | * Improved the edit section styling to be in consistency with the Flamingo Skin style((( | ||
| 73 | {{image reference="ReleaseNotes.ReleaseNotesXWiki82M2.WebHome@edit_section.png" width="600px;"/}} | ||
| 74 | ))) | ||
| 75 | * Improved the way ratings stars are displayed by removing the white background from picture ((( | ||
| 76 | {{image reference="ReleaseNotes.ReleaseNotesXWiki82M2.WebHome@stars.png"/}} | ||
| 77 | ))) | ||
| 78 | * Default XWiki Syntax 1.0 configuration has been removed from ##xwiki.cfg## and is now [[documented here>>extensions:Extension.Old XWiki 1\.0 syntax renderer||anchor="HConfiguration"]]. | ||
| 79 | |||
| 80 | See the [[full list of JIRA issues>>http://jira.xwiki.org/issues/?filter=14320]] fixed in this release. | ||
| 81 | |||
| 82 | = For Developers = | ||
| 83 | |||
| 84 | == Associate Editors to Data Types == | ||
| 85 | |||
| 86 | 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. | ||
| 87 | |||
| 88 | == Instance Filter improvements == | ||
| 89 | |||
| 90 | * 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. | ||
| 91 | * Instance Output Filter now use the context locale as default locale (used to be empty locale). | ||
| 92 | |||
| 93 | == Deprecated and Retired projects == | ||
| 94 | |||
| 95 | === MediaWiki parser === | ||
| 96 | |||
| 97 | ##xwiki-rendering-syntax-mediawiki## has been deprecated and moved to https://github.com/xwiki-contrib/syntax-mediawiki-1.0. | ||
| 98 | |||
| 99 | It's now recommended to use [[MediaWiki Syntax extension>>extensions:Extension.MediaWiki.MediaWiki Syntax]] instead. | ||
| 100 | |||
| 101 | == Upgrades == | ||
| 102 | |||
| 103 | The following dependencies have been upgraded: | ||
| 104 | |||
| 105 | * [[Guice 4.1.0>>http://jira.xwiki.org/browse/XCOMMONS-1004]] | ||
| 106 | * [[Commons Compress 1.12>>http://jira.xwiki.org/browse/XCOMMONS-1005]] | ||
| 107 | * [[httpasyncclient 4.1.2>>http://jira.xwiki.org/browse/XCOMMONS-1009]] | ||
| 108 | * [[JGroups 3.6.10>>http://jira.xwiki.org/browse/XWIKI-13532]] | ||
| 109 | * [[Less4j 1.17.2>>http://jira.xwiki.org/browse/XWIKI-13119]] | ||
| 110 | * [[Infinispan 8.2.3>>http://jira.xwiki.org/browse/XWIKI-13561]] | ||
| 111 | * [[Groovy 2.4.7>>http://jira.xwiki.org/browse/XCOMMONS-995]] | ||
| 112 | * [[Jackson 2.7.5>>http://jira.xwiki.org/browse/XCOMMONS-998]] | ||
| 113 | * [[httpcore 4.4.5>>http://jira.xwiki.org/browse/XCOMMONS-999]] | ||
| 114 | * [[cssparser 0.9.19>>http://jira.xwiki.org/browse/XCOMMONS-983]] | ||
| 115 | * [[Tika 1.13>>http://jira.xwiki.org/browse/XWIKI-13448]] | ||
| 116 | * [[HSQLDB 2.3.4>>http://jira.xwiki.org/browse/XWIKI-13449]] | ||
| 117 | * [[Infinispan 8.2.2>>http://jira.xwiki.org/browse/XWIKI-13451]] | ||
| 118 | * [[Pygments 2.1.3>>http://jira.xwiki.org/browse/XWIKI-13453]] | ||
| 119 | * [[Commons FileUpload 1.3.2>>http://jira.xwiki.org/browse/XCOMMONS-990]] | ||
| 120 | * [[Joda-Time 2.9.4>>http://jira.xwiki.org/browse/XWIKI-13462]] | ||
| 121 | * [[httpasyncclient 4.1.1>>http://jira.xwiki.org/browse/XCOMMONS-991]] | ||
| 122 | * [[old Jackson 1.9.13>>http://jira.xwiki.org/browse/XCOMMONS-992]] | ||
| 123 | * [[JBoss Logging 3.3.0>>http://jira.xwiki.org/browse/XCOMMONS-993]] | ||
| 124 | * [[javax.mail 1.4.7>>http://jira.xwiki.org/browse/XCOMMONS-981]] | ||
| 125 | |||
| 126 | == Miscellaneous == | ||
| 127 | |||
| 128 | * New ##org.xwiki.rendering.listener.SectionGeneratorListener## to generate section events from headers events | ||
| 129 | * Instance Output filter now indicate the target syntax for Input filters producing rendering events | ||
| 130 | * 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 | ||
| 131 | * ##$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:((( | ||
| 132 | {{code language="none"}} | ||
| 133 | #set ($out = $out.replaceAll(" (id|for)=('|"")$regextool.quote($oldId)", | ||
| 134 | " ${escapetool.d}1=${escapetool.d}2$regextool.quoteReplacement($newId)")) | ||
| 135 | {{/code}} | ||
| 136 | ))) | ||
| 137 | * Added 2 new column types for the Livetable macro: [["boolean" and "multilist">>extensions:Extension.Livetable Macro||anchor="HAllacceptedvalues-2"]]((( | ||
| 138 | {{image reference="ReleaseNotes.ReleaseNotesXWiki82M2.WebHome@livetable-boolean.png"/}} | ||
| 139 | |||
| 140 | |||
| 141 | {{image reference="ReleaseNotes.ReleaseNotesXWiki82M2.WebHome@livetable-multilist.png"/}} | ||
| 142 | ))) | ||
| 143 | * The URL API module (##xwiki-platform-url-api##) [[now provides>>extensions:Extension.URL API||anchor="HTools"]] an ##EntityReferenceResolver<String>## resolver and an ##EntityReferenceSerializer<String>## serializer implementations (with hint ##url##) that can be used to parse/serialize ##EntityReference## when used in URLs. The rationale is that Tomcat, for security reasons, doesn't support forward and backward slashes (##/##, ##\##) in URLs by default. Thus, if a reference contains some reserved characters such as dot (##.##), colon (##:##), etc and you use a default serializer they'll be escaped using a backslash, leading to problems under Tomcat. So this resolver/serializer uses a different escape character (namely, it uses ##!##) | ||
| 144 | |||
| 145 | = Translations = | ||
| 146 | |||
| 147 | The following translations have been updated: | ||
| 148 | |||
| 149 | {{language codes="ca, de, es, fr, lv, nl, pt_BR, ru, sk"/}} | ||
| 150 | |||
| 151 | = Tested Browsers & Databases = | ||
| 152 | |||
| 153 | {{warning}} | ||
| 154 | The QA Tests are executed after the release has been done. Thus, they are being prepared now and will be published soon. | ||
| 155 | {{/warning}} | ||
| 156 | |||
| 157 | {{comment}} | ||
| 158 | TODO: uncomment and update with proper link when the report is ready. | ||
| 159 | {{include reference="TestReports.ManualTestReportTemplateSummary"/}} | ||
| 160 | {{/comment}} | ||
| 161 | |||
| 162 | {{comment}} | ||
| 163 | = Performances tests compared to <last super stable version> = | ||
| 164 | |||
| 165 | <a summary of the comparison with latest super stable version> | ||
| 166 | |||
| 167 | More details on <link to the test report>. | ||
| 168 | {{/comment}} | ||
| 169 | |||
| 170 | = Known issues = | ||
| 171 | |||
| 172 | * [[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]] | ||
| 173 | |||
| 174 | = Backward Compatibility and Migration Notes = | ||
| 175 | |||
| 176 | == General Notes == | ||
| 177 | |||
| 178 | 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. | ||
| 179 | |||
| 180 | == Issues specific to XWiki 8.2 == | ||
| 181 | |||
| 182 | * 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]]. | ||
| 183 | ** The following breaking changes have been done: | ||
| 184 | *** ##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## | ||
| 185 | *** ##$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## | ||
| 186 | ** 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. | ||
| 187 | *** 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. | ||
| 188 | *** If the TextArea property supports wiki syntax but it's mostly code (e.g. Velocity, HTML) then best is to configure the Text editor. | ||
| 189 | *** Finally, if the TextArea property supports wiki syntax and it's mostly free text then best is to configure the WYSIWYG editor. | ||
| 190 | * The behavior of the ##getRenderedContent## methods located in Document/XWikiDocument changed a bit. | ||
| 191 | ** methods taking a String to render in the context of the document: they are still rendering in the context of the document but with the right of whatever called the method | ||
| 192 | ** methods rendering the document itself: they are still rendering in the context of whatever called this method but with the right of the document | ||
| 193 | * The ##xwiki.rendering.syntaxes## configuration property from ##xwiki.cfg## has changed purpose. It's now used only to define the //initial// list of active syntaxes. Then an Admin can go to the Admin UI to enable or disable syntaxes. | ||
| 194 | * Support for the Markdown syntax is no longer bundled by default and needs to be [[installed as an Extension>>extensions:Extension.Markdown Syntaxes]] if needed. | ||
| 195 | |||
| 196 | == API Breakages == | ||
| 197 | |||
| 198 | The following APIs were modified since XWiki 8.1: | ||
| 199 | |||
| 200 | <api breakages> | ||
| 201 | |||
| 202 | {{comment}} | ||
| 203 | Remove! | ||
| 204 | {{backwardCompatiblityReport version="8.2"/}} | ||
| 205 | {{/comment}} | ||
| 206 | |||
| 207 | = Credits = | ||
| 208 | |||
| 209 | The following people have contributed code to this release (sorted alphabetically): | ||
| 210 | |||
| 211 | Alexandru Cotiuga | ||
| 212 | Anca Luca | ||
| 213 | Clemens Robbenhaar | ||
| 214 | Denis Gervalle | ||
| 215 | Ecaterina Moraru (Valica) | ||
| 216 | Eduard Moraru | ||
| 217 | Guillaume Delhumeau | ||
| 218 | katpavlova | ||
| 219 | Marius Dumitru Florea | ||
| 220 | Medjdoub | ||
| 221 | Pascal Bastien | ||
| 222 | Raluca Stavro | ||
| 223 | rnveach | ||
| 224 | Sean Whalen | ||
| 225 | Sergiu Dumitriu | ||
| 226 | Thomas Mortagne | ||
| 227 | Vincent Massol |
