Release Notes for XWiki 14.3

Last modified by Manuel Leduc on 2022/05/02

This is the release notes for XWiki Commons, XWiki Rendering and XWiki Platform. They share the same release notes as they are released together and have the same version.

This release introduces a new (experimental) image dialog for the WYSIWYG editor and a new administration section to define image styles, with the goal to simplify the insertion and editing of images. On the same topic, the image popover now provides an image permalink and the image lightbox added the ability to copy the image identifier to clipboard to be used as link anchor or to be referenced by wiki macros. Finally, the images (or any files) uploaded through the WYSIWYG editor are not saved right away anymore but, instead, they create temporary attachments that are saved only when the edited content is saved. All these image related improvements, along with a lot of bug fixes, make this release worth trying.

The following regressions were introduced in this release (and found after it was released). Please check them out and if they impact you we recommend waiting to upgrade to a version where they are fixed.

New and Noteworthy (since XWiki 14.2.1)

Full list of issues fixed and Dashboard for 14.3.

For Users

New Experimental Image Dialog

 
The WYSIWYG editor has a new (experimental) image dialog that simplifies the insertion and edition of images. The new dialog is currently disabled by default but you can enable it from the WYSIWYG Editor section in the Wiki Administration: look for 'xwiki-image' in the drop down of disabled CKEditor plugins and uncheck it then save.

The new image dialog is integrated with the Image Style Administration section so users can apply image styles defined by an administrator. Checkout the CKEditor Integration documentation for more information.

Display image popover at cursor location

 
The image popover will be now displayed at cursor location, to make it more visible and accessible.

Display image ids in the Lightbox

 
Users can now copy to the image ID (which is either manually added using the Id Macro, or automatically generated) to clipboard from the lightbox menu or from the image toolbar, without the need to open the lightbox. From the image toolbar, users can also get the direct link to the image, which can then be shared easily.

Miscellaneous

  • Temporary Attachments: Starting with this release the files uploaded through the WYSIWYG editor (e.g. when inserting an image or when dropping a file on the editing area) are not saved right away as page attachments. Instead, they become temporary attachments that are saved (linked to the edited page) only when the content of the WYSIWYG editor is saved by the user. This means for instance that when creating a new page, uploading a file doesn't create the page anymore. The user needs to click on the Save button to create the page. Of course, the Cancel button is now behaving as expected: any file uploaded since the last save is discarded along with all the unsaved content changes.

For Admins

Image Style Administration

 
An Image Style Administration is now available. This interface allows to define standardized image styles that will later be used by the New Experimental Image Dialog to quickly define the appearance of images. 

Miscellaneous

  • Change the default font size used by the Formula macro: It is now possible to set the default font size to be used by the formula macro using the configuration key macro.formula.defaultFontSize. See the formula macro documentation to learn more.

For Developers

No changes!

Upgrades

The following runtime dependencies have been upgraded (they have a different release cycle than XWiki Commons, XWiki Rendering and XWiki Platform):

Translations

The following translations have been updated:

Tested Browsers & Databases

Here is the list of browsers we support and how they have been tested for this release:

 BrowserTested on:
Edge30.pngMicrosoft Edge 100
Chrome30.pngGoogle Chrome 100
Firefox30.pngMozilla Firefox 99Not Tested
Safari30.pngSafari 15Not Tested

Here is the list of databases we support and how they have been tested for this release:

 DatabaseTested on:
hypersql.pngHyperSQL 2.6.1Not Tested
postgresql.pngPostgreSQL 14Not Tested
mysql.pngMySQL 8
mariadb.pngMariaDB 10.6
oracle.pngOracle 19cNot Tested

Here is the list of Servlet Containers we support and how they have been tested for this release:

 Servlet ContainerTested on:
tomcat-icon.pngTomcat 9.0.62
jetty-icon.pngJetty 10.0.7 (XWiki Standalone packaging)
jetty-icon.pngJetty 10.0.7Not Tested

Known issues

Backward Compatibility and Migration Notes

General Notes

  • When upgrading make sure you compare and merge the following XWiki configuration files since some parameters may have been modified, removed or added:
    • xwiki.cfg
    • xwiki.properties
    • web.xml
    • hibernate.cfg.xml
  • Add xwiki.store.migration=1 in xwiki.cfg so that XWiki will attempt to automatically migrate your current database to any new schema. Make sure you backup your Database before doing anything.

Issues specific to XWiki 14.3

The long deprecated inline action has been moved to legacy. It is still bundled in XWiki Standard for now but we encourage all extension developers to update their code to use the edit action instead:

- $doc.getURL('inline')
+ $doc.getURL('edit')

API Breakages

The following APIs were modified since XWiki 14.2.1:

Unstable APIs

Not real backward compatibility breakages since they were done on APIs marked @Unstable (a.k.a Young APIs). Thus it's part of the contract that they can be broken until they become stable. They're listed purely for reference in case you decided to still use them (and thus agreed to be broken).

  • This class should have been marked as unstable on 14.1RC1. Moved to the package 'org.xwiki.doc.tasks' since it was not located in the right package.
    • Violation type:
      java.class.removed
    • Code:
      ## Old:
      class com.xpn.xwiki.doc.tasks.XWikiDocumentIndexingTask
  • This class should have been marked as unstable on 14.1RC1. The accessors are moved to 'org.xwiki.doc.tasks.XWikiDocumentIndexingTask' since we are not relying on a composite id anymore.
    • Violation type:
      java.class.removed
    • Code:
      ## Old:
      class com.xpn.xwiki.doc.tasks.XWikiDocumentIndexingTaskId

Credits

The following people have contributed code and translations to this release (sorted alphabetically):

  • Clemens Klein-Robbenhaar
  • ClĂ©ment Aubin
  • DenisF
  • Eduard Moraru
  • Jaeseop So
  • Manuel Leduc
  • Marius Dumitru Florea
  • Michael Hamann
  • Oana-Lavinia Florean
  • ParkHK
  • Prosenjit Mondal
  • Simon Urli
  • Simpel
  • Thomas Mortagne
  • Vincent Massol
  • xrichard
Tags:
   

Get Connected