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 improves the PDF export, especially when using the Chrome Docker Container, and brings experimental support for clustering to the realtime editors. It also includes a lot of bug fixes and dependency upgrades. Last but not least, this release contains security fixes, with the highest severity being 8.6/10.

New and Noteworthy (since XWiki 17.10.0)

Full list of issues fixed and Dashboard for 17.10.1.

For Users

PDF Outline

 
We changed the headless Chrome Docker image used to perform the PDF export in order to be able to use the latest version of Chrome. This allowed us to activate two features provided by Chrome:

• generation of PDF outline (bookmarks), simplifying the navigation within the PDF
• generation of tagged PDFs, which is supposed to make the generated PDFs more accessible

You need to configure the PDF Export Application to use the Chrome Docker Container as generator, if you want to try these features.

Miscellaneous

• Better Table Handling in PDF Export: Table handling in PDF export had been improved:

  • there is now a lower limit enforced on the column widths, in order to avoid having very thin columns that fit only a single character
  • tables that overflow the print page width are scaled down, first by reducing the font size and then by applying a CSS transformation
  • rowspan and colspan attributes are removed before printing in order to avoid problems with splitting such tables across multiple print pages; in order to maintain a consistent table layout we insert empty table cells matching the values of the rowspan and colspan attributes. This changes the table layout a bit, from what you see in view mode, but it prevents missing table rows in the generated PDF.

  See the PDF Export Application for more information.

For Admins

• Realtime clustering support: Experimental clustering support has been added for the realtime editors. You don't need to do anything to enable it, but it hasn't been tested much yet, so don't hesitate to report problems you may encounter.

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:

• German
• French
• Korean
• Slovenian
• Ukrainian
• Simplified Chinese

Tested Browsers & Databases

Automated testing

XWiki executes a lot of automated tests during its build, testing all supported configurations. In addition, some manual QA is also executed to try to discover additional problems (see below):

Manual testing

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

	Browser	Tested on:
	Mozilla Firefox 146	Not Tested
	Google Chrome 143	Jira Tickets Marked as Fixed in the Release Notes
	Microsoft Edge 143	Tests run and results
	Safari 18	Not Tested

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

	Database	Tested on:
	HyperSQL 2.7.4	Not Tested
	MariaDB 11.8	Tests run and results
	MySQL 9.3	Not Tested
	PostgreSQL 17	Jira Tickets Marked as Fixed in the Release Notes
	Oracle 19c	Not Tested

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

	Servlet Container	Tested on:
	Tomcat 11.0.15	Not Tested
	Jetty 12.1.4 (XWiki Standalone packaging)	Jira Tickets Marked as Fixed in the Release Notes Tests run and results
	Jetty 12.1.4	Not Tested

NOTE: This XWki version has been manually tested by the QA and has been validated.

Security Issues

Security issues are not listed in issue lists or dashboards to avoid disclosing ways to use them, but they will appear automatically in them once they're disclosed. See the XWiki Security Policy for more details.

Known issues

• Bugs we know about

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 17.10.1

New Headless Chrome Docker Image

We changed the headless Chrome Docker image used for PDF export from zenika/alpine-chrome to femtopixel/google-chrome-headless in order to be able to use a more recent version of Chrome. The PDF export code has been updated to work with this new Docker image. The previously used Docker image might not work as a result. If you have customized the "Chrome Docker Image" configuration from the PDF Export administration section, or the export.pdf.chromeDockerImage configuration from xwiki.properties, we highly recommend you update your configuration to use the new supported image. For reference, the default value is currently femtopixel/google-chrome-headless:144.0.7524.3 but you should be able to use a different version (tag) of this image if needed.

API Breakages

The following APIs were modified since XWiki 17.10.0:

No breakage!

Credits

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

• 이경철 
• Anca Luca
• anonymous
• Cédric LAMBLIN
• Ilie Andriuta
• Lucas Charpentier
• Manuel Leduc
• Marius Dumitru Florea
• Michael Hamann
• Nikita Petrenko
• Rostyslav Haitkulov
• Saa Kiraly
• Simon Urli
• Simpel
• Thomas Mortagne
• Vincent Massol
• Xiaofei Cui
• xrichard