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

<insert description of release here>

New and Noteworthy (since XWiki <version - 1>)

Full list of issues fixed and Dashboard for <version>.

Flamingo

  • The textarea now use a monospace font.

Miscellaneous

  • The RTF export is now only supported when an Office Server is connected to XWiki (we used to default to using FOP when no Office Server is connected but the quality of the export was too low to consider this a viable solution).
  • When using the Standalone distribution, the format has changed when passing parameters. The shell used has also been changed from sh to bash The new format is:

    start_xwiki.sh:

    # ----------------------------------------------------------------------------------------------------------------
    # Optional ENV vars
    # -----------------
    #   XWIKI_OPTS - parameters passed to the Java VM when running XWiki e.g. to increase the memory allocated to the
    #       JVM to 1GB, use set XWIKI_OPTS=-Xmx1024m
    #   JETTY_PORT - the port on which to start Jetty.
    #   JETTY_STOP_PORT - the port on which Jetty listens for a Stop command.
    #
    # Optional Parameters
    # -------------------
    #   -p, --port: The Jetty HTTP port to use. Overrides any value from JETTY_PORT. Defaults to 8080.
    #   -sp, --stopport: The Jetty stop port to use. Overrides any value from JETTY_STOP_PORT. Defaults to 8079.
    #   -ld, --lockdir: The directory where the executing process id is stored to verify that that only one instance is
    #       started. Defaults to /var/tmp.
    #   -k, --kill: If set then kills any already executing XWiki instance before starting a new one.
    #
    # Example
    # -------
    #   start_xwiki.sh -p 8080 -sp 8079 -k
    # ----------------------------------------------------------------------------------------------------------------

    start_xwiki_debug.sh:

    # ----------------------------------------------------------------------------------------------------------------
    # Optional ENV vars
    # -----------------
    #   XWIKI_OPTS - parameters passed to the Java VM when running XWiki e.g. to increase the memory allocated to the
    #       JVM to 1GB, use set XWIKI_OPTS=-Xmx1024m
    #   JETTY_PORT - the port on which to start Jetty.
    #   JETTY_STOP_PORT - the port on which Jetty listens for a Stop command.
    #
    # Optional Parameters
    # -------------------
    #   -p, --port: The Jetty HTTP port to use. Overrides any value from JETTY_PORT. Defaults to 8080.
    #   -sp, --stopport: The Jetty stop port to use. Overrides any value from JETTY_STOP_PORT. Defaults to 8079.
    #   -ld, --lockdir: The directory where the executing process id is stored to verify that that only one instance is
    #       started. Defaults to /var/tmp.
    #   -k, --kill: If set then kills any already executing XWiki instance before starting a new one.
    #   -yp, --yourkitpath: The path where Yourkit can find the agent. If not passed then YourKit won't be enabled.
    #       For example: "/Applications/YourKit Java Profiler 7.0.11.app/bin/mac"
    #       or "/home/User/yjp-11.0.8/bin/linux-x86-64/"
    #
    # Example
    # -------
    #   start_xwiki_debug.sh -yp "/Applications/YourKit Java Profiler 7.0.11.app/bin/mac"
    # ----------------------------------------------------------------------------------------------------------------

    stop_xwiki.sh:

    # ----------------------------------------------------------------------------------------------------------------
    # Optional ENV vars
    # -----------------
    #   XWIKI_OPTS - parameters passed to the Java VM when running XWiki e.g. to increase the memory allocated to the
    #       JVM to 1GB, use set XWIKI_OPTS=-Xmx1024m
    #   JETTY_STOP_PORT - the port on which Jetty listens for a Stop command.
    #
    # Optional Parameters
    # -------------------
    #   -p, --port: The Jetty HTTP port that was used to start XWiki. Defaults to 8080.
    #   -sp, --stopport: The Jetty stop port to use. Overrides any value from JETTY_STOP_PORT. Defaults to 8079.
    #   -ld, --lockdir: The directory where the executing process id is stored to verify that that only one instance is
    #       started. Defaults to /var/tmp.
    #
    # Example
    # -------
    #   stop_xwiki.sh -sp 8079
    # ----------------------------------------------------------------------------------------------------------------

See the full list of JIRA issues fixed in this release.

For Developers

<developer feature N>

<description of developer feature N>

Deprecated and Retired projects

<description of deprecated and retired projects>

Upgrades

The following dependencies have been upgraded:

  • <list libraries that have been upgraded>

Miscellaneous

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:

BrowserTest Result
Chrome30.pngGoogle Chrome 37Smoke testing
Firefox30.pngMozilla Firefox 32Jira Tickets Marked as Fixed in the Release Notes, Full testing
IE30.pngInternet Explorer 8Not Tested
IE30.pngInternet Explorer 9Not Tested

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

DatabaseTest Result
hypersql.pngHyperSQL 2.3.2Jira Tickets Marked as Fixed in the Release Notes, Full testing
mysql.pngMySQL 5.6.17Not Tested
oracle.pngOracle 11.2Not Tested
postgresql.pngPostgreSQL 9.3.4Not Tested

For the full list of tests see this page.

Known issues

Backward Compatibility and Migration Notes

General Notes

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.

Issues specific to XWiki <version>

<issues specific to the project>

API Breakages

The following APIs were modified since XWiki 6.1:

  • Young APIs:
    org.xwiki.rendering.transformation.RenderingContext: Method 'public org.xwiki.rendering.syntax.Syntax getTargetSyntax()' has been added to an interface
    • Added an API for a very common use case so that we optimize it
    org.xwiki.wiki.descriptor.WikiDescriptorManager: Method 'public java.util.Collection getAllIds()' has been added to an interface
    org.xwiki.mail.MailSender: Method 'public void send(javax.mail.internet.MimeMessage, javax.mail.Session, org.xwiki.mail.MailResultListener)' has been removed
    org.xwiki.mail.MailSender: Method 'public void sendAsynchronously(javax.mail.internet.MimeMessage, javax.mail.Session, org.xwiki.mail.MailResultListener)' has been added to an interface
    org.xwiki.mail.MailResultListener: Parameter 2 of 'public void onError(javax.mail.internet.MimeMessage, java.lang.Throwable)' has changed its type to java.lang.Exception
    org.xwiki.mail.script.MimeMessageWrapper: Parameter 1 of 'public MimeMessageWrapper(javax.mail.internet.MimeMessage, javax.mail.Session, org.xwiki.mail.MailSender, org.xwiki.context.Execution, org.xwiki.component.manager.ComponentManager)' has changed its type to org.xwiki.mail.internal.ExtendedMimeMessage
    org.xwiki.mail.script.MimeMessageWrapper: Return type of method 'public javax.mail.internet.MimeMessage getMessage()' has been changed to org.xwiki.mail.internal.ExtendedMimeMessage
  • The extended class got moved to a new package with the upgrade to velocity-tools 2.0 and the old location got deprecated.
    org.xwiki.velocity.XWikiWebappResourceLoader: Removed org.apache.velocity.tools.view.servlet.WebappLoader from the list of superclasses
  • Not really APIs to begin with.
    com.xpn.xwiki.doc.XWikiDocument: Removed field compactEntityReferenceSerializer
    com.xpn.xwiki.doc.XWikiDocument: Removed field compactWikiEntityReferenceSerializer
    com.xpn.xwiki.doc.XWikiDocument: Removed field currentDocumentReferenceResolver
    com.xpn.xwiki.doc.XWikiDocument: Removed field currentMixedDocumentReferenceResolver
    com.xpn.xwiki.doc.XWikiDocument: Removed field currentReferenceDocumentReferenceResolver
    com.xpn.xwiki.doc.XWikiDocument: Removed field currentReferenceObjectReferenceResolver
    com.xpn.xwiki.doc.XWikiDocument: Removed field defaultEntityReferenceSerializer
    com.xpn.xwiki.doc.XWikiDocument: Removed field explicitDocumentReferenceResolver
    com.xpn.xwiki.doc.XWikiDocument: Removed field explicitReferenceDocumentReferenceResolver
    com.xpn.xwiki.doc.XWikiDocument: Removed field localEntityReferenceSerializer
    com.xpn.xwiki.doc.XWikiDocument: Removed field localUidStringEntityReferenceSerializer
    com.xpn.xwiki.doc.XWikiDocument: Removed field relativeEntityReferenceResolver
    com.xpn.xwiki.doc.XWikiDocument: Removed field syntaxFactory
    com.xpn.xwiki.doc.XWikiDocument: Removed field uidStringEntityReferenceSerializer
    com.xpn.xwiki.doc.XWikiDocument: Removed field xClassEntityReferenceResolver
  • The annotation API already needs a larger refactoring, this small fix stay in line with the existing API and does not deserve the creation of a new (temporary) API.
    org.xwiki.annotation.io.IOTargetService: Method 'public org.xwiki.rendering.block.XDOM getXDOM(java.lang.String)' has been added to an interface
    org.xwiki.annotation.io.IOTargetService: Method 'public org.xwiki.rendering.block.XDOM getXDOM(java.lang.String, java.lang.String)' has been added to an interface
Tags:
   

Get Connected