Skip to content

Releases: hilverd/glossary-page-template

v4.4.0

24 Jan 08:59
Compare
Choose a tag to compare

SRI Hashes

See static assets for how to use these.

  • glossary.min.js: sha384-+QsYsNNDhWUdYYs0iqoFBk5qaQW0v8Tej9fpPE3SMJKMZJewI97L8rEfYlo6jE3U
  • glossary.min.css: sha384-iL1PAI/nJSxAwF87utcPRxNr3HJou2PWfdn9oEXqpubJDmRM6GpG2zJIaW53Wqvp

Added

  • Include tags in Markdown export.
  • Add experimental worker.min.js script to releases.

v4.3.0

08 Jan 08:34
Compare
Choose a tag to compare

SRI Hashes

See static assets for how to use these.

  • glossary.min.js: sha384-GUUdUo8VGUppT7nvy4E6JdLu+C3HTnGor9kYZAckViYa1yTpql4T5UIcxbLHxOgX
  • glossary.min.css: sha384-8L7n6QlynW05uQtPjyCy+mjW3ZJ+IR5FONYflj/7PlZEzCfp7MgfnMdCcK/amICO

Added

  • Allow exporting to JSON.

Fixed

  • Restore initial instructions for opening/editing a glossary. These were no longer being shown if the file was being opened directly in a browser (using a file:// URL).

v4.2.0

16 Dec 15:09
Compare
Choose a tag to compare

SRI Hashes

See static assets for how to use these.

  • glossary.min.js: sha384-yqcnKMjWCxi4hjLyp3MZVDr06PXGIxhu+8FK2L4Bo9y/RmpL9NUn4Ry1Z4x7p02c
  • glossary.min.css: sha384-8HZJXMjf2Duyj1kjxIiqb8jTOd0tBnWC+FwIOOTRTfu79u1w4+Qzh3V712Ea4WGy

Added

  • When viewing a single item, show its (disambiguated) preferred term in the page title.

Changed

  • Move all UI text to Internationalisation directory to facilitate translations (see issue #10).

Fixed

  • Fix minor bug where changes were applied in memory even if saving failed.
  • Don't show select menu for disambiguation tag if there are no tags.
  • Fix bug where button for making changes in memory was wrongly hidden.

v4.1.0

30 Nov 21:45
Compare
Choose a tag to compare

This release contains a (very minor) breaking change that only affects a specific scenario when editing a glossary. This scenario occurs when you reload the page if the URL contains query parameters (which are now used to store which tag is being filtered by and the item sort order). The Node.js script for the editor does not currently cope with query parameters and needs a small tweak -- please see below.

How to upgrade from v4.0.0

  1. Point the static assets to a version starting with @4 or @4.1.
  2. In the Node.js script at the bottom of the file, replace
var filePath = '.' + req.url;

with

var filePath = '.' + req.url.replace(/\?.*$/g, '');

SRI Hashes

See static assets for how to use these.

  • glossary.min.js: sha384-tlI48cvI3XOu58MUkir5wV80QlZwmzGdoIcFvkel6tMmTJ6sDTZhYgHBRFFG4FZU
  • glossary.min.css: sha384-8q4LU/g5637c7EMZTqwXpj9nBKVbhHY7e+oP1xwmBteaVwHmm5JM6T6ZvEIJDTy8

Added

  • Support tags in Anki export.
  • Use URL query parameter to save tag being filtered by.
  • Show a warning in edit mode if there are more than 500 items, which is currently not recommended for performance reasons.

Changed

  • When creating a new item, if a tag is being filtered by then auto-tick that tag's checkbox.
  • Use URL query parameter for order-items-by instead of localStorage.

Fixed

  • Fix minor HTML/UI bug -- don't give IDs to alternative terms, to prevent duplicates.
  • Make clicking on a tag to filter by also scroll to the top.
  • Improve formatting when exporting to Markdown.

v4.0.0

24 Nov 09:53
Compare
Choose a tag to compare

This release introduces support for tags, improves support for items that have terms in common, and removes support for "plain text" in favour of Markdown. It contains breaking changes that should only affect you if

  • you have items with multiple definitions or are using plain text, or
  • you are opening the glossary as a file in a browser (using a file:// URL).

The latter now only shows the (initial) help message, and to see the actual glossary you will need to either use the built-in editor or "host" the glossary.html file using e.g. python3 -m http.server 8000.

Download glossary.html to see some examples of the new features.

How to upgrade from v3

  1. Point the static assets to a version starting with @4.
  2. If you were using plain text rather than Markdown, then inspect all terms and definitions and correct the formatting where needed.
  3. Similarly, if you had items with multiple definitions, then you will want to inspect their definitions and correct the formatting where needed.

Added

  • Add support for tags.
    • You can use these to attach "labels" to items that people can then filter by. This may be useful for large glossaries that span multiple topics, where there is a need to categorize or group items. Tags can also be used to "disambiguate" items that have the same preferred term but whose meaning depends on some "context". For example, the term "default" has a different meaning in the context of computer science than it does in the context of finance.
  • Add a small "Built using Glossary Page Template" footer to the list page.
  • Add keyboard shortcut "e" for making changes.
  • Show spinner while saving changes.

Changed

  • Only allow one definition per item, but allow items to have alternative terms in common.
  • Make the concept of a preferred term (and alternative terms) clearer in the UI.
  • Show "Make changes" button when Node.js backend is running. This is to make it easier to see the glossary in "read-only" mode.

Removed

  • Remove support for plain text syntax in favour of Markdown.

SRI Hashes

See static assets for how to use these.

  • glossary.min.js: sha384-SYZNWjvYZgZFWkRdYoBIFwCqWZyfOJP31XpKEeYxCJze2ChmsPJyTjPqLtbAzR7Y
  • glossary.min.css: sha384-JlCOdWxsL2X/4dhUUyw3XMqpOeis36btOddsazICT7l1ghAFXOcoyzP6Ub18RNiP

v3.8.0

13 Oct 10:45
Compare
Choose a tag to compare

SRI Hashes

See static assets for how to use these.

  • glossary.min.js: sha384-ygsPK8AARm6P97ugLFwvExT4FinWAJGnXGJOW+UToaXUMjpJm4hxHIj8n/zBXSQE
  • glossary.min.css: sha384-fCJijPpK6B9WknPrnW8U7fm3lQNkvdmqxRoybKO/WEb5f+3rfiphbPMCFcjhbUsx

Added

  • Allow hiding "Order items" buttons in Settings.

Changed

  • Show terms beginning with 0-9 before those starting with a letter, and group them under "0–9" in the index.

v3.7.0

19 Aug 10:52
Compare
Choose a tag to compare

SRI Hashes

See static assets for how to use these.

  • glossary.min.js: sha384-7ji1VqUkOvQts9k1uNgoaNFCC/sm4ARsuvN207chbvUSoOWqu0pYLV3NKHArKZ9f
  • glossary.min.css: sha384-fCJijPpK6B9WknPrnW8U7fm3lQNkvdmqxRoybKO/WEb5f+3rfiphbPMCFcjhbUsx

Added

  • Make it easier to rearrange related items.

Changed

  • Add button to easily copy command for running editor to clipboard.

v3.6.1

10 Aug 19:39
Compare
Choose a tag to compare

SRI Hashes

See static assets for how to use these.

  • glossary.min.js: sha384-/nOekL9rq7yfYSS4/2XpAg4zsT7j5eBl0YPXLTe8Lij4Mm1ct1nKtoyOUw903YqJ
  • glossary.min.css: sha384-U6iKlbX1he3hfeXWXAA8dtIbuzda/9Jm/Ulfgg900fCOp3zlnq2E4JN39WWMAXUW

Added

  • Add logo to home page.

Changed

  • Use logo for favicons.

v3.6.0

09 Aug 19:44
Compare
Choose a tag to compare

SRI Hashes

See static assets for how to use these.

  • glossary.min.js: sha384-/nOekL9rq7yfYSS4/2XpAg4zsT7j5eBl0YPXLTe8Lij4Mm1ct1nKtoyOUw903YqJ
  • glossary.min.css: sha384-f3iXAmHUaXt209+j8PBPRO8lppCtz3qGh/DEl48qDZArnPII1qsO6ltVRSYkufNS

Added

  • Allow ordering items "focused on" a particular term. Items that are closely related to this term (i.e. have a shorter path to the term's item via "See also" links) are shown earlier. For larger glossaries, this hopefully provides a way to focus on a certain topic by allowing the user to browse the items closely related to that topic, gradually moving towards topics that are further removed.

Changed

  • Upgrade KaTeX to version 0.16.8.

Fixed

  • Fix minor layout bug for "This field can't be empty" message.

v3.5.2

11 Jul 12:49
Compare
Choose a tag to compare

SRI Hashes

See static assets for how to use these.

  • glossary.min.js: sha384-hBvBcknaxGdIeYAC1JldPWbjR3BT4zne9P2C7SnESlM2fZ/UahNrR5S19bB73Ggx
  • glossary.min.css: sha384-2+hEf85rh8tmyw0k+eCeCierOl/JvhvLDbn3NcRJLoh4z8CBWQNg9YJGh64BsRMp

Changed

  • Use "definition" in the editor UI instead of "description" or "details" for consistency.