LilyRunner - A Helper Application for Lilypond

Version 1.0.0, 12 February 2009

What is it for?

LilyRunner is an application that helps you typesetting music by LilyPond.

Specifically, LilyRunner invokes the command-line version of lilypond, and if compilation is successful open the resulting PDF file.

It also recognizes clicking on the musical symbol on the PDF file, and opens the source file with an external editor and moves the insertion pointer to the appropriate position.

How can I install it?

  1. Copy the application to the "/Application" or "~/Application" folder.
  2. Launch the application, and select "LilyRunner" -> "Preferences".
  3. Select the LilyPond application. You can specify either the application package (LilyPond.app), or the command-line executable directly (such as /usr/local/bin/lilypond).
  4. Select the Preview and Editor applications.
  5. Edit the script to respond to click on PDF. When the url textedit://(file-path):line:column is clicked on the PDF viewer, this script is called with the file path, the line number and the colun number (both starting from 1) as the arguments.

How can I use it?

To compile (typeset) the source

Drag and drop the lilypond source file on the LilyRunner application. The LilyPond begins to compile, and if it is successful the resulting PDF file is opened with the Preview application.

Alternatively, you can use "File" -> "Open and compile..." menu command, or an AppleScript 'tell application "LilyRunner" to open FILE'.

To update syntax

Use "File" -> "Open and update syntax" menu command to select the source files. Alternatively, you can use "File" -> "Update syntax" menu command while the lilypond log window for that source file is still open.

Another way is an AppleScript, 'tell application "LilyRunner" to update syntax (FILE as alias)'.

To jump to the source position from PDF

Click on one of the musical symbols, then LilyRunner is invoked, opens the source file with the external editor, and move to the line/column position.

License

LilyRunner is distributed under the terms of the "modified BSD License." See the last section in this page for details.

Disclaimer

Copyright (c) 2009 Toshi Nagata. All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.