Release 0.2.0.0

Author: TravisCardwell

CHANGELOG.md

@@ -24,6 +24,12 @@ following conventions:
 
 [KaC]: <https://keepachangelog.com/en/1.0.0/>
 
+## 0.2.0.0 (2020-08-11)
+
+### Breaking
+
+* Add URL support
+
 ## 0.1.0.0 (2020-07-25)
 
 ### Breaking

README.md

@@ -15,10 +15,11 @@
 
 ## Overview
 
-Queue Sheet is a utility that builds PDFs of lists.  The printed PDFs can be
-used to track progress through the queues when offline.
+Queue Sheet is a utility that builds PDFs of lists.  Printed PDFs can be used
+to track progress when offline.  Optionally include URLs when sharing a PDF
+with others so that they can easily access the media.
 
-Use Queue Sheet to track progress through:
+Use Queue Sheet to track:
 
 * podcasts
 * research papers

doc/queue-sheet.1.md

@@ -51,6 +51,9 @@ properties:
 *name*
 :   name of the queue (string, required)
 
+*url*
+:   queue URL (string, optional)
+
 *section*
 :   name of the section (string, required)
 
@@ -64,13 +67,22 @@ properties:
 :   date of last update (string, optional)
 
 *prev*
-:   previous (complete) item (string, optional)
+:   previous (complete) item (item, optional)
 
 *next*
-:   list of next items (list of string, optional)
+:   list of next items (list of items, optional)
 
 If both *prev* and *next* are specified, then *prev* is ignored.
 
+An item name may be specified using a string.  To associate a URL with an
+item, use an object with the following properties:
+
+*name*
+:   name of the item (string, required)
+
+*url*
+:   item URL (string, optional)
+
 The following tags are supported:
 
 *complete*
@@ -113,6 +125,9 @@ A queue is an object with the following properties:
 *name*
 :   name of the queue (string)
 
+*url*
+:   queue URL or empty string if no URL (string)
+
 *isSplit*
 :   *true* to display items on separate lines (boolean)
 
@@ -126,10 +141,18 @@ A queue is an object with the following properties:
 :   date or empty string if no date (string)
 
 *prevItem*
-:   previous item or empty string if not set (string)
+:   previous item or empty string if not set (item)
 
 *nextItems*
-:   list of next items (list of strings)
+:   list of next items (list of items)
+
+An item is an object with the following properties:
+
+*name*
+:   name of the item (string)
+
+*url*
+:   item URL or empty string if no URL (string)
 
 ## `QUEUES.pdf`
 

example/podcasts.pdf

@@ -8,52 +8,63 @@ sections:
 queues:
 
   - name: AI Podcast
+    url: https://lexfridman.com/ai/
     section: Other
-    date: 2020-01-17
-    prev: 72
+    date: 2020-08-09
+    next:
+      - name: 114
+        url: https://lexfridman.com/russ-tedrake/
 
   - name: Changelog
+    url: https://changelog.com/podcast
     section: Programming
     tags:
       - partial
-    date: 2020-01-20
-    prev: 377
+    date: 2020-08-07
+    next:
+      - 407
 
   - name: Co-Recursive
+    url: https://corecursive.com/
     section: Functional
-    date: 2020-01-16
-    prev: 44
+    date: 2020-08-03
+    prev: 55
 
   - name: Functional Geekery
+    url: https://www.functionalgeekery.com/
     section: Functional
-    date: 2019-12-24
-    prev: 129
+    date: 2020-05-19
+    prev: 131
 
   - name: Haskell Weekly
+    url: https://haskellweekly.news/podcast.html
     section: Functional
     date: 2019-11-08
     prev: 24
 
   - name: LambdaCast
+    url: https://soundcloud.com/lambda-cast
     section: Functional
     date: 2019-06-14
     prev: 22
 
   - name: Mindscape
+    url: https://www.preposterousuniverse.com/podcast/
     section: Other
-    date: 2020-01-20
+    date: 2020-08-10
     next:
-      - 78
-      - 79
-      - 80
+      - 108
+      - 109
 
   - name: Quanta
+    url: https://www.quantamagazine.org/tag/podcast/
     section: Other
-    prev: 128
+    prev: 142
 
   - name: Software Engineering Radio
+    url: https://www.se-radio.net/
     section: Programming
     tags:
       - partial
-    date: 2020-01-10
-    prev: 395
+    date: 2020-08-06
+    prev: 420

example/podcasts.yaml

@@ -17,6 +17,9 @@
 % use titlesec package for custom sections
 \usepackage{titlesec}
 
+% use hyperref for URLs
+\usepackage[hidelinks]{hyperref}
+
 % do not indent paragraphs
 \setlength{\parindent}{0pt}
 
@@ -48,22 +51,6 @@
    \fontdimen3\font=\origiwstr
 }
 
-% create queue environment
-\newenvironment{queue}[2]
-{
-  \begin{minipage}{1.0\textwidth}
-  \textbf{#1}\hfill #2\\
-  \vspace{-1em}
-  \hrule
-  \vspace{0.2em}
-  \begin{fontspace}{1.5}{2}
-}
-{
-  \end{fontspace}
-  \end{minipage}
-  \vspace{2em}
-}
-
 % define partial mark
 \newcommand*{\partialMark}{☯}
 
@@ -79,15 +66,36 @@
 \section*{<< section.name >>}
 
 <! for queue in section.queues !>
-\begin{queue}{<< queue.name >>}{<< queue.date >><! if queue.isPartial !> \partialMark<! endif !><! if queue.isComplete !> \completeMark<! endif !>}
+\begin{minipage}{1.0\textwidth}
+<! if queue.url !>
+\href{<< queue.url >>}{\bfseries <<queue.name>>}\hfill
+<! else !>
+\textbf{<< queue.name >>}\hfill
+<! endif !>
+<< queue.date >><! if queue.isPartial !> \partialMark<! endif !><! if queue.isComplete !> \completeMark<! endif !>\\
+\vspace{-1em}
+\hrule
+\vspace{0.2em}
+\begin{fontspace}{1.5}{2}
 <! if queue.prevItem !>
-\previous{<< queue.prevItem >>}
+<! if queue.prevItem.url !>
+\href{<< queue.prevItem.url >>}{\previous{<< queue.previtem.name >>}}
+<! else !>
+\previous{<< queue.prevItem.name >>}
+<! endif !>
 <! else !>
 <! for item in queue.nextItems !>
-<< item >> <! if queue.isSplit !>\\<! endif !>
+<! if item.url !>
+\href{<< item.url >>}{<< item.name >>}
+<! else !>
+<< item.name >>
+<! endif !>
+<! if queue.isSplit !>\\<! endif !>
 <! endfor !>
 <! endif !>
-\end{queue}
+\end{fontspace}
+\end{minipage}
+\vspace{2em}
 
 <! endfor !>
 <! endfor !>

example/template.tex

@@ -0,0 +1,13 @@
+# `queue-sheet-haskell` `0.2.0.0` Release Notes
+
+Date
+: 2020-08-11
+
+## Overview
+
+This release of Queue Sheet adds support for associating URLs with queues as
+well as queue items.  This allows others to easily access the media when a
+Queue Sheet PDF is shared.  See the updated man page and example for details.
+
+YAML files used with version `0.1.0.0` work with version `0.2.0.0` without
+change, but YAML files that include URLs will not work with version `0.1.0.0`.

project/release/queue-sheet-haskell-0.2.0.0.md

@@ -1,5 +1,5 @@
 name:           queue-sheet
-version:        0.1.0.0
+version:        0.2.0.0
 category:       Utils
 synopsis:       queue sheet utility
 description:

queue-sheet.cabal

@@ -92,7 +92,7 @@ defaultTemplate = "template.tex"
 ------------------------------------------------------------------------------
 -- $Types
 
--- | Name of a queue
+-- | Name of a queue or queue item
 newtype Name = Name Text
   deriving newtype Show
 
@@ -105,6 +105,19 @@ instance Ginger.ToGVal m Name where
 instance TTC.Render Name where
   render (Name t) = TTC.fromT t
 
+-- | URL of queue or queue item
+newtype Url = Url Text
+  deriving newtype Show
+
+instance FromJSON Url where
+  parseJSON = fmap Url . parseToString
+
+instance Ginger.ToGVal m Url where
+  toGVal (Url t) = Ginger.toGVal $ escapeTeX t
+
+instance TTC.Render Url where
+  render (Url t) = TTC.fromT t
+
 -- | Section used to organize queues
 newtype Section = Section Text
   deriving newtype (Eq, Show)
@@ -144,22 +157,38 @@ instance TTC.Render Date where
   render (Date t) = TTC.fromT t
 
 -- | Queue item
-newtype Item = Item Text
-  deriving newtype Show
+data Item
+  = Item
+    { itemName :: !Name
+    , itemUrl  :: !(Maybe Url)
+    }
+  deriving Show
 
 instance FromJSON Item where
-  parseJSON = fmap Item . parseToString
+  parseJSON = \case
+    (A.Object o) ->
+      Item
+        <$> o .:  "name"
+        <*> o .:? "url"
+    value ->
+      Item
+        <$> fmap Name (parseToString value)
+        <*> pure Nothing
 
 instance Ginger.ToGVal m Item where
-  toGVal (Item t) = Ginger.toGVal $ escapeTeX t
+  toGVal Item{..} = Ginger.dict
+    [ "name" ~> itemName
+    , "url"  ~> itemUrl
+    ]
 
-instance TTC.Render Item where
-  render (Item t) = TTC.fromT t
+--instance TTC.Render Item where
+--  render (Item t) = TTC.fromT t
 
 -- | Queue information
 data Queue
   = Queue
     { queueName    :: !Name
+    , queueUrl     :: !(Maybe Url)
     , queueSection :: !Section
     , queueSplit   :: !Bool
     , queueTags    :: ![Tag]
@@ -171,6 +200,7 @@ data Queue
 instance FromJSON Queue where
   parseJSON = A.withObject "Queue" $ \o -> do
     queueName    <- o .:  "name"
+    queueUrl     <- o .:? "url"
     queueSection <- o .:  "section"
     queueSplit   <- o .:? "split" .!= False
     queueTags    <- o .:? "tags" .!= []
@@ -262,6 +292,7 @@ loadQueuesYaml path = do
 data QueueCtx
   = QueueCtx
     { name       :: !Name
+    , url        :: !(Maybe Url)
     , isSplit    :: !Bool
     , isPartial  :: !Bool
     , isComplete :: !Bool
@@ -273,6 +304,7 @@ data QueueCtx
 instance Ginger.ToGVal m QueueCtx where
   toGVal QueueCtx{..} = Ginger.dict
     [ "name"       ~> name
+    , "url"        ~> url
     , "isSplit"    ~> isSplit
     , "isPartial"  ~> isPartial
     , "isComplete" ~> isComplete
@@ -285,6 +317,7 @@ instance Ginger.ToGVal m QueueCtx where
 queueCtx :: Queue -> QueueCtx
 queueCtx Queue{..} = QueueCtx
     { name       = queueName
+    , url        = queueUrl
     , isSplit    = queueSplit
     , isPartial  = TagPartial `elem` queueTags
     , isComplete = TagComplete `elem` queueTags
@@ -384,7 +417,7 @@ data Options
     }
   deriving Show
 
--- Parse program options
+-- | Parse program options
 parseOptions :: IO Options
 parseOptions = OA.execParser
     $ OA.info (LibOA.helper <*> LibOA.versioner version <*> options)

queue-sheet.hs

@@ -4,7 +4,7 @@
 }:
 mkDerivation {
   pname = "queue-sheet";
-  version = "0.1.0.0";
+  version = "0.2.0.0";
   src = ./.;
   isLibrary = false;
   isExecutable = true;