Release Notes for XWiki 7.2 Milestone 1
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 7.1)
Full list of issues fixed and Dashboard for <version>.
<feature N>
<description of feature N>
Miscellaneous
<insert misc user stuff and important bug fix descriptions here in a list, when they are too small to warrant a section by themselves - Change the version in the URL below!>
See the full list of JIRA issues fixed in this release.
For Developers
New reference related APIs
Various new API around references has been introduced while adding support for nested spaces.
Complete references Providers
Complete references Providers (for DocumentReference, SpaceReference and WikiReference) with default or current hints. They allow getting complete reference created from each default or current part of those references (for example in SpaceReference you end up with the space of the XWikiContext document and the XWikiContext wiki)
Provider<DocumentReference> defaultDocumentReference;
@Inject
@Named("current")
Provider<DocumentReference> currentDocumentReference;
org.xwiki.model.reference.EntityReferenceProvider
org.xwiki.model.reference.EntityReferenceProvider replaces org.xwiki.model.reference.EntityReferenceValueProvider. It's essentially the same thing but with EntityReference instead of string which allow getting multiple spaces when you ask for the current EntityType.SPACE for example.
EntityReferenceProvider provider;
Properly support any kind of reference in getDocument
com.xpn.xwiki.XWiki#getDocument(EntityReference) and com.xpn.xwiki.api.XWiki#getDocument(EntityReference) support any kind of reference properly (e.g. a space reference will return the space home page, an object reference will return the object document reference, etc).
New helpers in EntityReference
- boolean equals(EntityReference otherReference, EntityType to): same as equals but only take into account reference parts up to the passed entity type (included)
- boolean equals(EntityReference otherReference, EntityType from, EntityType to): same as equals but only take into account reference parts between passed entity types (included)
- boolean equalsNonRecursive(EntityReference otherReference): same as equals but does not take into account the parent
New readonly XWikiContext provider
You can inject a new "readonly" XWikiContext the following way:
@Named("readonly")
Povider<XWikiContext> roXWikiContextProvider;
The difference with default provider is that the readonly one won't try to create a new XWikiContext and will return null if it can't find any. It's been introduce for some low level components that were used during XWikiContext creation but in general it should be used by any component that only search for some XWikiContext property that might be null even in a valid XWikiContext.
Deprecated and Retired projects
<description of deprecated and retired projects>
Upgrades
The following dependencies have been upgraded:
Miscellaneous
<other dev stuff to add and link to JIRA for all issues fixed>
Translations
The following translations have been updated:
Tested Browsers & Databases
Performances tests compared to <last super stable version>
<a summary of the comparison with latest super stable version>
More details on <link to the test report>.
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 7.2M1
Database change
There hasn't been any structural change to the database but the document space field in the database (and the corresponding XWikiDocument#getSpace() method) now contains the serialized space reference instead of the space name. In practice what it means is that ".", ":" and "\" characters are going to be escaped with a "\" (a migration will automatically update those entries in the database when upgrading). For example a space named Space:with.special\char will be stored as Space\:with\.special
Templates
All the templates specific to Colibri Skin had been moved to it. If your skin depends on some of these templates, you should set Colibri as parent of your skin.
Miscellaneous
- the String reference resolver now properly take into account spaces separator so a reference that don't follow the specification and did not escaped the . in the space part will be cut is several nested spaces. Anything that do was serialized with the standard serializer was properly escaped so not worry here.
API Breakages
The following APIs were modified since <project> <version - 1>:
