Skip to content

Latest commit

 

History

History
292 lines (175 loc) · 11.7 KB

CHANGELOG.md

File metadata and controls

292 lines (175 loc) · 11.7 KB

Sublime PML Changelog

Users are strongly advised to regularly check this changelog in order to keep up with the latest package features. Due to the package being installed directly from its GitHub repository, update notifications within Sublime Text are not available, therefore all package updates will happen silently in the background.

Although we initially tried versioning the package and using tagged releases, when we discovered that these were not beneficial in providing package updates notifications we stopped versioning the package and creating releases.

Updates will be logged according to their date, without a Semantic Versioning scheme for the entire duration of the Alpha stage of the package. This approach considerably slims down the development and maintenance work, allowing for more frequent package updates.

WARNING — I haven't been always updating this changelog regularly, but I'm striving to catch up and annotate at least the important milestones.


Table of Contents


2023-03-25

PML 4.0.0 | ST 4148

Footnotes Nodes 2/4

  • Implement syntax support for footnotes placeholder [fnotes and inline footnotes [fnote.
  • Define colour scheme style for footnotes contents (markup.other.footnote).

Fix ID Symbols Indexing

Text transforms for identifiers indexing (#<id>) was being applied only to unquoted IDs, now it also works with quoted IDs.

2023-03-24

PML 4.0.0 | ST 4148

Footnotes Completions and Snippets

Added various completions and snippets triggers to simplify working with footnotes, even though the syntax doesn't yet support scoping footnote related nodes.

trigger desc
fndef Footnote Definition
fnote Inline Footnote
fnpholder Footnotes Placeholder
fnref Footnote Reference
fntref Footnote Text Reference

2023-03-07

PML 4.0.0 | ST 4147

Paragraph Node

Added support for [p node and its attributes (id and HTML attributes).

2023-03-04

PML 4.0.0 | ST 4147

Raw-Blocks Snippets

Added snippets to quickly create raw-text fenced blocks (selection will be enclosed in the block), with the following triggers:

  • bkhtml → HTML Block ([html)
  • bkcode → Source Code Block ([code)
  • bkinput → Input Block ([input)
  • bkoutput → Output Block ([output)

Options Block Snippet

Added new opts snippet to create an [options .. ] block, but only if outside the main [doc note, since PML 4.x requires the options block to precede the actual document.

Tweaked all snippets and completions to exclude common nodes and their attributes from being suggested inside an options block. Likewise, disabled quick formatting keyboard shortcuts from working inside an options block.

2023-03-03

PML 4.0.0 | ST 4147

Options Completions

Dropped previous attributes completions for [doc node and re-implemented them as their [options sub-nodes counterparts:

  • highlighter[highlighter ${1:highlightjs}]\n$0
  • hljs[highlighter highlightjs]\n$0
  • prism[highlighter prism]\n$0
  • tocposition[TOC_position ${1:top}]\n$0
  • toctitle[TOC_title ${1:Contents}]\n$0

For more info, see the Sublime PML User Guide, which has also been updated.

Input and Output Nodes

Added support for [input and [output raw-text nodes.

2023-02-24

PML 4.0.0 | ST 4147

PML 4.0.0

Package updated to support new PML 4.0.0 release and its breaking changes.

Raw-Text Nodes

Updated [raw-text] nodes [code and [html to new PML 4 syntax, supporting both Standard Text Syntax and Delimited Text Syntax, dropping support for Text Block Syntax.

Quote Node

Fixed the [quote node according to PML 4.0.0 breaking changes:

  • Dropped source attribute and associated completions.
  • Implemented new [qsource node.

2022-12-08

PML 3.1.0 | ST 4134

Options Nodes

Added support for [options node:

  • [highlighterhighlightjs, prism, none.
  • [TOC_max_levelinteger.
  • [TOC_positionleft, top, none.
  • [TOC_titlestring.

2022-08-21

PML 3.0.0 | ST 4134

PML 3.0.0

Package updated to new PML 3.0.0 release.

In terms of breaking changes, this update currently only affected the package build systems, since the PML Companion command line opinions underwent radical changed.

PML Dark: Switch to Relaxed Theme

In the PML Dark default scheme, stop using the old Base16 Railcasts colour scheme and replace it with the Relaxed Theme by Michael Kühnel

Update the PML Dark definitions to make the most out of the new scheme, improving previously covered syntax elements and adding missing elements.

The resulting syntax colouring experience is now more pleasant to the eye, and its overall consistence has been greatly improved.

2022-08-12

PML 2.3.0 | ST 4134

Shared Title Node

Tweak the syntax definition to use a commonly shared context for [title between [doc and [ch (see Discussion #35).

The separate contexts were a left over feature from PML 1.5.0 when title was a node attribute instead of a node in its own right.

A shared [title implementation reduced maintenance efforts and simplifies the upcoming implementation of [subtitle. From the end users perspective, the only difference is that now document titles are being indexed along with chapter titles.

New Changelog Menu

Added new menu to quickly open in the browser the package CHANGELOG:

  • Tools > PML > Sublime PML Changelog

Drop Versioning and Releases

Because we realized that tagged releases were not affecting package updates as we expected, i.e. that the installation from GitHub prevents updates from occurring only at tagged releases, and package update messages are not being shown to end users after an update, we stopped versioning the package and creating tagged releases on GitHub.

The package is now simply updated whenever new commits are present in main branch, and since we don't have to prepare a release for each update this allows us to simplify development and offer updates more frequently.

The Sublime PML User Guide no longer tracks the package version number (there isn't a version number any longer). Updates are now tracked by their date, i.e. when they were merged into main.

2022-08-03

PML 2.3.0 | ST 4134

Sublime PML User Guide

Sublime PML has now an official online user guide, hosted at the repository website.

A new menu has been added to easily open the guide in the default browser:

  • Tools > PML > Sublime PML User Guide

Title Formatting

Add support for inline nodes within a [title (document and chapter titles).

Before indexing, chapter headings are also stripped from any font-formatting tags, newline sequences and redundant spaces, to beautify lookup operations in the Goto Symbol panel.

2022-07-19

PML 2.3.0 | ST 4134

PML 2.3.0

This is the first Sublime PML public release which can be installed directly from its GitHub repository via Sublime Text's native Package manager.

The package offers decent PML syntax support by implementing the most important nodes and capturing all other nodes as "generic nodes". Thanks to smart symbols indexing, Goto Definition functionality, completions and snippets, keyboard shortcuts and a dedicated color scheme, users can already use this package in production, even though it's still in its early stages.

Being in Alpha stage, the package is still experimental can be subject to frequent changes in its scoping conventions or any other features, if better approaches to handling the PML syntax are discovered.