Skip to content

Commit 1a44d75

Browse files
Add design log
1 parent f17b4af commit 1a44d75

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

project/log/20200822-design.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# `queue-sheet-haskell` Design Log
2+
3+
Author
4+
: Travis Cardwell
5+
6+
Date
7+
: 2020-08-22
8+
9+
## Sharing
10+
11+
Queue sheets are convenient for tracking progress through conference videos
12+
and university lectures. I would like to share those that I make with others,
13+
and I made the following major design changes to make the program easier for
14+
multiple people to work with:
15+
16+
* Support was added for a "default" section, for queue sheets that do not need
17+
sections. One can specify the queue list as a top-level array to simplify
18+
queue files in this case.
19+
* Support was added for importing other queue files, either inheriting
20+
sections or overriding them. This allows users to easily create a custom
21+
queue sheet that includes queues defined in separate files.
22+
* Support was added for associating URLS with queues as well as queue items.
23+
This makes it easy for users to easily locate the media indexed by a queue.
24+
25+
## User-Defined Tags
26+
27+
Support was added for user-defined tags, which can be handled in any way that
28+
the user wants in the template. This simplifies the design of the program yet
29+
makes it more flexible.
30+
31+
The initial design used a special "split" flag, intended to be used to display
32+
items on separate lines. This flag has been removed, as the same
33+
functionality can be implemented using a "split" tag.

0 commit comments

Comments
 (0)