| Docs Help
  AppSource  
Print this pageEntire manual (printable version)
Docs  /  NAVAX Help Builder  /  Write Help  /  Basics

 Create Release Notes


2024/04/15 • 4 min. to read
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:
SnippetInformation/Result
_NewReleaseNotesCreates 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

_ReleaseNotesAddAdds 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
_ReleaseNotesAddUpcoming

Note

<upcomingupdatestext> is automatically replaced by text and displayed to the user in German or English.
Result:

Upcoming Updates

  • Please note:

  • The features are in various stages of progress. They are not final, so they are subject to change. This is not an exhaustive list of everything that is being considered or currently being developed.
    • TODO_ListEntry
    • TODO_ListEntry
    • TODO_ListEntry
_ReleaseNotesAddDowngradeInfo

Note

<downgradeinfo> is automatically replaced by text and displayed to the user in German or English.
Result:

Downgrade information

  • TODO_Text
  • TODO_Text
  • TODO_Text
_ReleaseNotesAddImprovements

Note

<improvements> is automatically replaced by text and displayed to the user in German or English.
Result:

  • Improvements

    • TODO_ListEntry
    • TODO_ListEntry
    • TODO_ListEntry
_ReleaseNotesAddModifications

Note

<modifications> is automatically replaced by text and displayed to the user in German or English.
Result:

  • Modifications

    • TODO_ListEntry
    • TODO_ListEntry
    • TODO_ListEntry
_ReleaseNotesAddCorrections

Note

<corrections> is automatically replaced by text and displayed to the user in German or English.
Result:

  • Corrections

    • TODO_ListEntry
    • TODO_ListEntry
    • TODO_ListEntry
_ReleaseNotesAddRowResult:
    • TODO_ListEntry

Submit feedback for
DE|EN Imprint
◀☰▶
△