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

• When using the Standalone distribution, the format has changed when passing parameters. 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

• The auto value has been added to the align option of the Auto Suggest Widget.
• A new parameter targetQueryString has been added to the UI Extension points org.xwiki.platform.panels.Applications and org.xwiki.platform.panels.Applications.more.

Translations

The following translations have been updated: 

• Language
• Language

Tested Browsers & Databases

Known issues

• Bugs we know about

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 <project> <version - 1>: