Overview

Last edited 157 days ago by System Writer

Add a changelog to your document. Keep users of your doc informed about the changes (new features, bug fixes) to your document using an easy to read display.

Structure

Data > Templates

This table contains the templates used by the formula to display the changelog.

Data > Changelog

The data for the changelog are located here. You can also find the Versions table here.

Changelog

This page just contains the formula to display the data found in the Changelog table.

Details

Templates

The template columns are all a canvas type, so the content can be rich. The most important information to maintain are the {} placeholders.

Main

Version: {1}

---

{2}

{1} → This will contain the version number, ie. “0.0.1.0’. If this is the most recent version in the flog, it will add “(Current version)” after the version.

{2} → The rest of the changelog entry will be displayed.

Item

[{1}] {2}

{3}

{1} → This will display the changelog type, ie. “New”, “Fix”, “Update”, etc.

{2} → This is the change item, ie. “Fixed the display bug”, etc.

{3 → The rest of the changelog entry will be displayed.

Detail

{1}

{1} → This will display the “Detail” column. This column is a canvas so you can use rich text like fonts and bullet lists, etc.

Versions

Add the versions you want to use in your changelog to this table. when you fill in the columns the formula in the “Version” column will generate a semantic version string.