qlab-html v1.1.0

qlab-html

qlab-html is a Node.js module and CLI that renders QLab workspaces as self-contained HTML documents, which can then be printed or saved to PDF from your browser.

qlab-html works by importing the frontmost open workspace's data over OSC with osc.js and dynamically generating HTML with Cheerio.

The design of qlab-html's rendered pages is heavily inspired by Josh Langman's QLab 3 font and particularly the associated font specimen.

Examples

• Light theme, HTML
• Light theme with notes, HTML
• Light theme, portrait PDF
• Light theme with notes, portrait PDF
• Light theme, landscape PDF
• Light theme with notes, landscape PDF
• Dark theme, HTML
• Dark theme with notes, HTML

Use

1. Install the qlab-html CLI with npm install -g qlab-html.
2. Open the QLab workspace you want to export - it doesn't have to be focused, but it must be the frontmost open workspace.
3. Run qlab-html -p to export the workspace to <workspace name>.html and open the file in your default browser.
4. Run qlab-html -h for full CLI options.

Known bugs/issues

• Non-ASCII cue names do not render properly
• Very large workspaces (>600-800 cues) may fail to export with a RangeError
• Cues generated with the --truncate-cue-names option do not resize to fit the window/printed page
• Cue cart cues generated with the --truncate-cue-names option do not wrap to fill the cell
• There is no support for rendering collapsed group cues as such (this data is not available from QLab over OSC)
• Cue cart cue hotkeys do not display within the cue's cell (this data is not available from QLab over OSC)