Create Release Notes

2025/04/25 • 3 min. to read

In this topic

Snippets

Release Notes can be added using the _ReleaseNotes snippets. For files named ReleaseNote, the Help Builder automatically adds version details for each version when viewing the page. Version details are only added if the version is specified in a <h2> after the text Version separated by a space. Alternatively, the AppID can also be specified instead of the text "Version". Example:

Version 22.1.2.0
as of Business Central 22 Important Update
2024/01/01

The version details are stored in a database on navax.app. Further details (access data etc.) have to be coordinated with the NAVAX App Team. If downgrade versions are available for a version, a note is automatically added. Example:

Note

This version is also available as a downgrade version for Business Central 22, 21 and 20.

Snippets
The following snippets are available:
Snippet	Information/Result
_New_ReleaseNotes	Creates an example which can be used as a starting point. Note <releasenotestext>, <upcomingupdates>, <upcomingupdatestext>, <downgradeinfo> and <initialversion> are automatically replaced by text and displayed to the user in German or English. Result: Release Notes Would you like to know what has changed in the extension? Below you'll find an overview of the new features and changes made in the updates. Version TODO Initial Version
_ReleaseNotes_AddVersion	Adds a new version. Note <improvements>, <modifications> and <corrections> are automatically replaced by text and displayed to the user in German or English. Result: Version TODO Improvements TODO_ListEntry TODO_ListEntry TODO_ListEntry Modifications TODO_ListEntry TODO_ListEntry TODO_ListEntry Corrections TODO_ListEntry TODO_ListEntry TODO_ListEntry
_ReleaseNotes_AddEntry	Result: TODO_ListEntry
_ReleaseNotes_AddNCEXUpdateInfo	Result: NAVAX Extension Base extension update. For more information, see *[Docs]* NAVAX Extension Base - Release Notes
_ReleaseNotes_AddLicUpdateInfo	Result: Important Due to changes in the Granules, the Business Central license needs to be updated for On-Premises installations.