"releasenotechanges" Macro
Reference
Description
Renders the whole body of a release note: one section per audience, the buttons that add a change, and the changes of the milestones and release candidates that the version aggregates. It is what the shipped release note template calls, and what a template of your own should call too.
It takes no product or version parameter: it reads the product and the released state from the ReleaseNoteClass object of the page it runs on, and derives the versions to aggregate from that page's name. A page named 8.3M1 queries 8.3-milestone-1, 8.3RC1 queries 8.3-rc-1, and a final 8.3 queries 8.3 together with every milestone and release candidate below it.
Usage
{{releasenotechanges exclusions="..."/}}Parameters
| Name | Mandatory | Allowed Values | Default Value | Description |
|---|---|---|---|---|
| exclusions | No | Comma-separated change page references | (empty) | Changes to leave out of the release note, by page reference. This is how a change that was superseded before the final release is kept out of it |
Examples
Example 1: A release note body
{{releasenotechanges/}}Example 2: Leaving out a superseded change
{{releasenotechanges exclusions="ReleaseNotes.Data.XWiki.8.3M1.Entry004.WebHome"/}}FAQ
Why is a milestone change missing from the final release note?
The aggregation goes by page name, so the milestone page has to be named <version>M<n> or <version>RC<n> below the same product; see Release Note Structure.
