Changelogs

The changelog file in core/components/[packagename]/docs/changelog.txt is read out automatically and split up so that each version in the database has its own changelog details. This will be used on the extra detail page to automatically show a formatted changelog.

To make sure this works properly, we need a consistent changelog. Here is an example of what a changelog should look like to be interpreted correctly:

MoreGallery 1.7.0-pl
--------------------
Released on 2018-07-04

New features:
- Thumbnails for PDFs are now created from the first page
- New mgGetImages properties &pdfTpl and &singlePdfTpl to ease integration of PDFs
- Added extension field to images for easy access of (source) extension
- Add [[+idx1]] placeholder to mgGetImages snippet for easier mod support ([[+idx1:mod=`3`:is=`0`:then=`...]]) [#202]

MODX3 Compatibility:
- Fix installation on MODX3
- Update the MoreGallery design and positioning (with content position set to "above") to match the latest MODX 3 alpha

Improvements:
- Make sure thumbnails can be created for SVGs that lack the <?xml header
- Expand droptarget for the file tree to include the toolbar [#195]
- Make sure image sort order when uploading multiple images is preserved [#196]
- Editing a PDF image's metadata now shows the (png) thumbnail instead of broken image

MoreGallery 1.6.2-pl
--------------------
Released on 2017-10-06

- Add moregallery.image_id_separator system setting to control the separator used between file name and image id [S14715]
- Add some missing setting lexicons
- Prevent uncaught exceptions when creating thumbnails of PDFs, improve file writing logic [#203]

MoreGallery 1.6.1-pl
--------------------
Released on 2017-04-19

- Fix issue on PHP 5.3 with the mgMediaManagerImage object [S11648]

So the format is name of package + version on line 1, at least 5 dashes (preferably equal length of the package name + version) on the second line, and "Released on YYYY-MM-DD" on the third line, followed by an empty line, and then each entry in the changelog.

Nested entries are possible, simply add more dashes in front of the changelog entry. This will be transformed into a nested list.

For minor and major versions, the changelog entries should be split up in different sections by adding an empty line, followed by the section title (this will be bold on the changelog page), followed by normal changelog entries prefixed with a dash. These sections are typically "New Features", "Improvements", and "Fixes" but can vary.

If for some reason changelogs are not parsed properly, they can be updated in the modmore.com manager via modmore > Package Provider > edit the package > edit the version.

Changelogs

Disclaimer: Viewing non-Euro pricing