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 releases improves the new client-side PDF Export feature (still experimental but getting closer to being production ready) by offering the ability to configure it in the Admin UI and by enhancing the default template. It also fixes bugs and especially several security bugs, making it a recommended upgrade.

New and Noteworthy (since XWiki 14.8)

Full list of issues fixed and Dashboard for 14.9.

For Users

Improved PDF Template

 
The default PDF template provided by the PDF Export Application has now better support for multi-page export:

  • the title of each exported wiki page is now included both in the content and in the table of contents, styled differently in order to distinguish it from normal content headings
  • the PDF header shows the title of the "current" wiki page, i.e. the wiki page that provided the content for the current PDF page
  • each exported wiki page starts on a new PDF page

Checkout the documentation for more information.

Figure macro type configuration

 
Is is now possible to manually set the type of a figure macro, instead of relying on the automatic type detection feature.

Attachment selector can use the temporary attachment store

 
When uploading an attachment using the attachment selector, and the attachment has savemode sets to form, new attachments are not saved directly on the document anymore.
Instead, the attachment is kept in a temporary attachment store and only persisted when the form containing the attachment selector is saved.
Temporary attachments are presented with a clock icon (clock) when presented in the attachments selection modal.

Miscellaneous

  • PDF File Name: The file name suggested by the web browser when downloading a PDF generated by the PDF Export Application is now, by default, the title of the wiki page from where the export was triggered (instead of the Java UUID used for the temporary resource name). Checkout the documentation for more information.

For Admins

PDF Export Administration

 
The administration section provided by the PDF Export Application has been extended to support:

  • selecting and configuring the tool used to generated the PDF
  • showing the state of the PDF generator
  • setting the page ready timeout, that is the number of seconds to wait for the web page to be ready for print before aborting the PDF export

Checkout the documentation for more information.

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:
Firefox30.pngMozilla Firefox 106Not Tested
Chrome30.pngGoogle Chrome 107Tests run and results
Edge30.pngMicrosoft Edge 107Jira Tickets Marked as Fixed in the Release Notes
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.7.0Not Tested
postgresql.pngPostgreSQL 15Not Tested
mariadb.pngMariaDB 10.6Not tested
mysql.pngMySQL 8Tests run and results
oracle.pngOracle 19cJira Tickets Marked as Fixed in the Release Notes

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.68
jetty-icon.pngJetty 10.0.7 (XWiki Standalone packaging)Not Tested
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.9

Right check for Javascript and StyleSheet XObject

In order to execute the scripts contained in xobjects (javascript XObject or stylesheet XObject) it's now necessary that the author of the page holding those xobjects has script rights.

API Breakages

The following APIs were modified since XWiki 14.8:

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).

  • Unstable API change: Script services are not supposed to expose classes from com.xpn.xwiki.doc.*
    • Violation type:
      java.method.returnTypeChanged
    • Code:
      ## Old:
      method com.xpn.xwiki.doc.XWikiAttachment org.xwiki.store.script.TemporaryAttachmentsScriptService::uploadTemporaryAttachment(org.xwiki.model.reference.DocumentReference, java.lang.String)

      ## New:
      method com.xpn.xwiki.api.Attachment org.xwiki.store.script.TemporaryAttachmentsScriptService::uploadTemporaryAttachment(org.xwiki.model.reference.DocumentReference, java.lang.String)
  • We can't provide a default implementation for this new method, it needs to be implemented on upgrade
    • Violation type:
      java.method.addedToInterface
    • Code:
      ## Old:


      ## New:
      method com.xpn.xwiki.doc.XWikiAttachment org.xwiki.store.TemporaryAttachmentSessionsManager::uploadAttachment(org.xwiki.model.reference.DocumentReference, javax.servlet.http.Part, java.lang.String) throws org.xwiki.store.TemporaryAttachmentException
  • Unstable API
    • Violation type:
      java.method.addedToInterface
    • Code:
      ## Old:


      ## New:
      method boolean org.xwiki.export.pdf.browser.BrowserTab::navigate(java.net.URL, javax.servlet.http.Cookie[], boolean, int) throws java.io.IOException

Credits

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

Gankov Andrey
Manuel Leduc
Marius Dumitru Florea
Michael Hamann
Nikita Petrenko
Oana-Lavinia Florean
Simon Urli
Simpel
Thomas Mortagne
Vincent Massol
acotiuga
nouman
xrichard

Tags:
   

Get Connected