Release Notes Application
Manages Release Notes for software products (creation, reports) |
Type | XAR |
Category | Application |
Developed by | |
Rating | |
License | GNU Lesser General Public License 2.1 |
Table of contents
Description
Accessing the application
The Application can be accessed from the Application Index or from the Applications Panel.
From Applications Panel
Home Page
From the home page of the application, you can:
- see existing release notes
- create a new release notes
- generate custom reports
Example of a generated Release Note:
Adding Changes
A Release Notes is composed of changes. Each change is created as a page and the changes are then displayed inside the Release Note page using either the {{changes.../}} or the {{releasenotechanges/}} macros (see below for more details on those macros).
Right now, to add a new change, you need to navigate to ReleaseNotes.Data.WebHome. In the future you'll be able to add changes directly from the Release Note pages.
Example of viewing a given change:
Custom Reports
The application home page (and the Changes home page) offer the ability for users to generate their own custom Release Note change report.
The form allows to choose the displayer to use. Currently we provide the following displayers:
- Grid Displayer
- Flow Displayer
- Simple Displayer
- List Displayer
Macros
The following macros are made available:
- {{changes products="..." versions="..." audience="..." importance="..." displayer="..." categories="..." containsScreenshots="true|false" columns="..." displayEditLink="true|false"/}}
- {{releasenotechanges/}}
Configuration
When adding a new release notes, the template used is the one defined in the ReleaseNotes.Code.ReleaseNotesConfig page's xobject which allows to configure:
- the default product name (used on the home page to pre-fill the form to add a new release note)
- the reference to the template to use.
Creating a template
When creating a release notes template, two velocity bindings are available to the template content:
- product: the name of the product
- version: the short version
Prerequisites & Installation Instructions
We recommend using the Extension Manager to install this extension (Make sure that the text "Installable with the Extension Manager" is displayed at the top right location on this page to know if this extension can be installed with the Extension Manager). Note that installing Extensions when being offline is currently not supported and you'd need to use some complex manual method.
You can also use the following manual method, which is useful if this extension cannot be installed with the Extension Manager or if you're using an old version of XWiki that doesn't have the Extension Manager:
- Log in the wiki with a user having Administration rights
- Go to the Administration page and select the Import category
- Follow the on-screen instructions to upload the downloaded XAR
- Click on the uploaded XAR and follow the instructions
- You'll also need to install all dependent Extensions that are not already installed in your wiki
Dependencies
Dependencies for this extension (org.xwiki.contrib.releasenotes:application-releasenotes-ui 1.1.1):
- org.xwiki.platform:xwiki-platform-rendering-macro-velocity 7.4
- org.xwiki.rendering:xwiki-rendering-macro-html 7.4
- org.xwiki.platform:xwiki-platform-sheet-ui 7.4
- org.xwiki.platform:xwiki-platform-livetable-ui 7.4
- org.xwiki.platform:xwiki-platform-rendering-wikimacro-store 7.4