title: QUEUE-SHEET section: 1 hyphenate: false ...
queue-sheet - queue sheet utility
queue-sheet [OPTIONS] QUEUES.yaml
Queue Sheet is a utility that builds PDFs of lists. Printed PDFs can be used to track progress through queues when offline.
-h, --help : show help and exit
--version : show version and exit
-t, --template TEMPLATE.tex : template file (default: template.tex)
-o, --output QUEUES.pdf : output file
QUEUES.yaml : queue file
A queue is a named list of items. For example, a podcast can be represented as a queue where the queue name is the name of the podcast and each item in the queue is an episode of the podcast. Queues can optionally be organized into sections. For example, sections can be used to organize podcast queues by theme.
Queues are specified in YAML format. They may be specified in a few different ways, depending on how you want to organize them.
To create a queue sheet of queues without sections, the YAML file consists of an array of queue objects, which have the following properties:
name : queue name (string, required)
url : queue URL (string, optional)
date : date of last update (string, optional)
tags : list of tags (space-separated string or array of strings, optional)
prev : previous item (item, optional)
next : list of next items (space-separated string or array of items, optional)
The only required property is name.
The tags property associates one or more string tags with the queue. Tags can be specified using a space-separated string or an array of strings. A tag must consist of at least one ASCII letter, number, period, underscore, or dash. For example, tag "complete" can be used to indicate that there will be no new episodes of a podcast that is complete.
The next property is a list of next items in the queue. When the list is exhausted, the previous item can be specified using the prev property. If both prev and next are specified, prev is ignored.
Next items can be specified using a space-separated string or an array or items. When specifying items using an array, the item name can be specified using a string or a number, or an object with the following properties can be used in order to specify more item information:
name : name of the item (string, required)
url : item URL (string, optional)
tags : list of tags (space-separated string or array of strings, optional)
To organize queues into sections, the YAML file should be written as an object with two properties:
sections : list of sections names (array of strings, optional)
queues : list of queue objects (array of queue objects, required)
Sections names are specified using strings. The order that the sections are specified determines the order that they are displayed on the queue sheet.
Queue objects are as above, with an additional property to specify the section:
section : name of the section (string, optional)
Queues that are not explicitly associated with a section are associated with an implicit default section.
To make it easier to share queue files, imports are also supported. Import another queue file using an import object instead of a queue object in an array of queues. An import object has the following properties:
import : path to the queue file to import (string, required)
section : section to associate all of the imported queues with (string, optional)
Paths are relative to the current file. For example, simply specify the filename of the file to import when the file is in the same directory.
When you specify section, the section must be defined in the current file. When you do not specify section, the sections of the imported queues are used, but they must also be defined in the current file.
YAML files specify the data, and templates determine how that data is
displayed. A LaTeX template is used to build the PDF, using XeTeX. Unless
specified otherwise, template.tex is used.
It is a Jinja2-style template using the following syntax:
Interpolations
: << section.name >>
Tags
: <! if section.name !>
Comments
: <# comment #>
The context contains a single value:
sections : list of sections
A section is an object with the following properties:
name : name of the section (string)
queues : list of queues
Only sections that contain queues are passed to the template. The name property of the default section is empty.
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)
date : date or empty string if no date (string)
prev_item : previous item or empty string if not set (item)
next_items : list of next items (list of items)
Queue tags are exposed as boolean properties prefixed with "tag_". For example, a tag named "complete" is exposed as "tag_complete".
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)
Item tags are exposed as boolean properties prefixed with "tag_". For example, a tag named "em" is exposed as "tag_em".
Unless specified otherwise, the built PDF is output to a file with the same
base name as the queues file but with a .pdf extension.
0 : no error
1 : execution error
2 : command-line error
GitHub: : https://github.com/ExtremaIS/queue-sheet-haskell
Reporting issues: : GitHub: https://github.com/ExtremaIS/queue-sheet-haskell/issues
Email: <bugs@extrema.is>Copyright : Copyright (c) 2020-2025 Travis Cardwell
License : The MIT License https://opensource.org/licenses/MIT