Skip to content

Commit bfa85f6

Browse files
Add release notes
1 parent 5f1af79 commit bfa85f6

File tree

1 file changed

+43
-0
lines changed

1 file changed

+43
-0
lines changed
Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# `queue-sheet-haskell` `0.3.0.0` Release Notes
2+
3+
Date
4+
: 2020-08-23
5+
6+
## Overview
7+
8+
This release of Queue Sheet introduces a number of new features:
9+
10+
* Queues not explicitly associated with a section are implicitly associated
11+
with a default section. This provides a convenient way to create queue
12+
sheets without sections. One can specify the queue list as a top-level
13+
array to simplify queue files in this case.
14+
15+
* Queues from other queue files can be imported, either inheriting sections
16+
or overriding them. This allows users to easily create a custom queue sheet
17+
that includes queues defined in separate files.
18+
19+
* User-defined tags can now be associated with queues. They can be handled in
20+
any way that the user wants in the template.
21+
22+
See the updated man page and examples for details.
23+
24+
## Migration
25+
26+
This release includes a number of breaking changes, in both queue files and
27+
templates. Any existing files must be migrated to use the new version.
28+
29+
### Queue Files
30+
31+
The `split` property of queues is removed. Use a `split` tag instead.
32+
33+
### Templates
34+
35+
Tags are now exposed in templates with a `tag_` prefix. When using a
36+
`complete` tag, `isComplete` should be changed to `tag_complete` in templates.
37+
When using a `partial` tag, `isPartial` should be changed to `tag_partial` in
38+
templates. When using a `split` tag, `isSplit` should be changed to
39+
`tag_split` in templates.
40+
41+
For consistency, all template properties now use snake case. `prevItem`
42+
should be changed to `prev_item`, and `nextItems` should be changed to
43+
`next_items` in templates.

0 commit comments

Comments
 (0)