Changes

[http://lilypond.org LilyPond] is a great music engraver, and you can include LilyPond in ConTeXt source using [[moduleshttps:t-lilypond|//github.com/adityam/filter the lilypond filter module]with some setup. This is different from using the lilypond-book preprocessor with LaTeX. (For LaTeX there’s also a package that works similar to our ConTeXt setup here: [https://github.com/jperon/lyluatex lyluatex].)

== Deprecation Warning Simple Filter Setup ==

The LilyPond module doesn't work any more This works with recent versions ConTeXt MkII and MkIV, but takes only the first page of ConTeXt. You can simply replace it with multi-pages scores, and you must create the [http://modules.contextgarden.net/filter Filter module] like thisfolder "lilytemp" manually:

filtercommand={lilypond -dbackend=eps -dno-gs-load-fonts -dinclude-eps-fonts -ddelete-intermediate-files -o"lilytemp/\externalfilterbasefile" "\externalfilterinputfile"}]

You can't use == Multi Page Filter Setup == This uses Lua and therefore only works with ConTeXt MkIV. It includes all pages of multi-page scores.It doesn’t look into the complete (multi-page) PDF, but reads a "-system.count" auxiliary file written by LilyPond that contains the number of systems (pages) and includes the single-system PDFs. <cmdtexcode>setuplilypond\def\LILYTEMP{lilytemp} % name of folder for LilyPond/buffer files \def\ParseLilypondFile#1% #1 is the name of the output file {\ctxlua{thirddata.parselilypondfile("#1")}} \startluacode thirddata = thirddata or {} -- create temp folder if missing if not lfs.isdir("\LILYTEMP") then lfs.mkdir("\LILYTEMP") end function thirddata.parselilypondfile(name) -- include all systems (pages) -- name is like \LILYTEMP/mainfile-temp-lilypond-21.pdf logs.report("LILYPOND","name='" .. name .. "'") local scname = string.gsub(name, '%.pdf$', '-systems.count') local syco = tonumber(io.loaddata(scname)) or 0 for nr = 1, syco do logs.report("LILYPOND","including system no." .. nr) context("\\externalfigure[" .. string.gsub(name, '%.pdf$', '-' .. nr) .. "]") end end\stopluacode \usemodule[filter]\defineexternalfilter[lilypond] [continue=yes, cache=yes, readcommand=\ParseLilypondFile, directory=\LILYTEMP/, output={\externalfilterbasefile.pdf}, filtercommand={lilypond -dbackend=eps -o"\LILYTEMP/\externalfilterbasefile" "\externalfilterinputfile"}]</cmdtexcode> any more, but there is a better replacement:   == LilyPond Settings == Collect your LilyPond settings in a .ly file, put it in your lilytemp directory and include it from within your lilypond block like this:

\usemodulestartbuffer[lilypond::settings]\include "mysettings.ly"\stopbuffer \defineexternalfilter[lilypond][ ... bufferbefore={lilypond::settings}, ...]

=== options Sample Include File ==={| style="border: solid 1px black; padding: 0.5em; vertical-align: top; width: 80%;" |- style="border: solid 1px black; padding: 0.5em; vertical-align: top; background: #eeeeee;"! option !! values !! default !! meaning|-| staffsize || number (pt) || 20 || height of the staff|-| linewidth || measure || <cmd>localhsize</cmd> || width of the staff|-| betweensystemspace || measure || 54pt || space between systems|-| align || yes/no || depends on fragment || ragged-right = (not align)|-| indent || measure || 0pt || first line indent|-| time || yes/no || yes || count the time (i.e. show time signature, draw bars, split the staff)?|-| clef || yes/no || yes || show the clef?|-| fragment || yes/no || no || typeset only a snippet (instead of a whole line)?|-| barnumbers || yes/no || no || show measure numbers?|-| showempty || yes/no || no || drop empty staves?|-| seriffont || "name" || "Tex Gyre Schola" || serif font (e.g. for Lyrics and \markup; was Century Schoolbook L before)|-| sansfont || "name" || "LMSans10" || sans serif font (e.g. for chords)|-| monofont || "name" || "LMTypewriter10" || monospace font (normally not used)|-| tmpdir || "name" || "./lilytemp" || directory for temporary files (.tmp, .md5, .eps); gets created if not existant|-| imgdir || "name" || "./lilypdfs" || directory for LilyPond PDFs; gets created if not existant|}

There are some notes \lilypond{ \relative{bes a c b} } embedded in this version "2.18.2"#(ly:set-option (quote no-point-and-click))#(set-global-staff-size 14) % --- start of setup for single-lineoutput files ---#(define default-toplevel-book-handler print-book-with-defaults-as-systems ) #(define toplevel-book-handler (lambda ( .rest) (set! output-empty-score-list #f)</texcode> (apply print-book-with-defaults rest)))

E.g#(define toplevel-score-handler (lambda ( . rest) (apply collect-scores-for a songbook you want to place big chunks of LilyPond output (i.e. note staffs-book rest))) in your text. It behaves like any other graphics, especially similar to embedded [[MetaPost]] code:

<texcode>\sectionpaper {Starlight #(rounddefine dump-extents #t) indent = 0\mm ragged-bottom = ##t ragged-last-bottom = ##t print-page-number = ##f line-width = 120\mm oddFooterMarkup = ##f oddHeaderMarkup = ##f bookTitleMarkup = ##f scoreTitleMarkup = ##f}

\startlilypond<<\context Staff = onlyone <<layout { \clef treble#(layout-set-staff-size 14) % beware, this resets fonts! \key a \major% set fonts for rm / ss / tt \time 6#(define fonts (make-pango-font-tree "TeX Gyre Schola" "LMSans10" "LMTypewriter10 Regular" (/814 20))) \context Voice = one {\Score \relative cremove "Bar_number_engraver" \override PaperColumn #'' {keep-inside-line = ##t a4.^\markup{1. } e' | e8( d cis) b4. | % some example settings e4.^ \markupcontext {2.} d4 d8 |\Staff cis( b) a b4 e,8 | a4 a8 gis( a) b | \override TimeSignature #'style = #'numbered cis4 cis8 b( cis d) | cis( d) e e4 e,8 | fis4 fis8 gis4. } }>>\lyricsto one \new Lyrics context { \lyricmode {ChordNames Star -- light, star -- bright,chordChanges = ##t first star I see to -- night; I wish I may, I wish I might have the wish I wish to -- night.majorSevenSymbol = \markup{ 7+ }

If you’d like to exchange measures like text width between ConTeXt and LilyPond depends on , you could write those into the fonts that pango/fontconfig can findLilyPond buffer. But not even all of those will workTo give LilyPond measures to ConTeXt, e.g. no fonts from the TeX tree you would need to write them into a temp file (using Scheme) and read that in again (don't know whyuseing Lua), only one face per font file etc.Therefore it doesn't use ConTeXt's font setupFor the time being this is left as an exercise to the user.;)

If Unfortunately you want to know which fonts of your system LilyPond can see can’t define LilyPond’s text (lyrics) size with which names, try lilypond -dshow-available-fonts any(The 3rd parameter is necessaryan absolute value, but can be anythingonly relative to staff size...)

<texcode>\usetypescriptfile[typeNormally, your LilyPond snippets just get a running number. If you re-otf]order your scores, each one gets re-rendered.

\starttypescript[wiki][songbook] \usetypescript [serif] You can avoid that if you name your LilyPond snippets: just add <tt>[schoolbookname=myfunnyname] \definetypeface [songbook] [rm] [serif] [schola] [default] \definetypeface [songbook] [ss] [sans] [default][default] \definetypeface [songbook] [</tt] [mono] [default][default]\stoptypescript> to <cmd>startlilypond</cmd>.

\usetypescript [wiki] If you have just one LilyPond part per component (e.g. songs in a songbook), you could use <tt>[songbook]name=\setupbodyfont[songbook, rm, 8.5ptcurrentcomponent]</texcodett>.

== Current workarounds Automatical width adaption ==

This section lists workarounds needed in some circumstances; we surely hope If you want to move them set your note line width automatically to [[#Older_Workarounds|'''Older Workarounds''']] as soon as possible!your current text width, try this:

-- this goes after "create temp folder" io.savedata("\LILYTEMP/texsettings.ly", "\\paper { line-width === Something " .. string.gsub(number.todimen(LilyPondtex.dimen.textwidth),"pt", GhostScript etc"\\pt") .. " } \n") isn't found ===

Depending on and then adapt your setup (path, installation directories, snippets or preamble buffer:<texcode>\include "../mysettings.) you must call the lilypond app with the full pathly"\include "texsettings.ly"</texcode>

If <tt>pstopdf<You must comment/tt> can't create PDFs (but LilyPond has made EPS files) delete the "line-width" setting in mysettings.ly, otherwise it might be that you must set the environment variable <tt>GS_LIB</tt> for GhostScriptdoesn’t work.

=== LilyPond pre-2.12 =Example ==

The module as Here's an example of 2009-05-03 works only placing score snippets in the body of the text, with LilyPond 2.12 (probably also with some versions of 2.11).fonts in the score & body matching:

For older versions <texcode>\def\LILYTEMP{lilytemp} % name of folder for LilyPond please use an older version of the module. 2008-09 fits LilyPond 2.10/buffer files

Lilypond has commands to typeset fret diagrams for the guitar chords. The most important one is called <code>\fret-diagram</code> and if you want to use it, you need to play a bit with the catcode of the <code>minus</code> sign since ConTeXt is apparently confused by this. In addition, you can't type the example found in [http://lilypond.org/doc/v2.10/Documentation/user/lilypond/Overview-of-text-markup-commands#index-g_t_0040code_007bfret_002ddiagram_007d-935 the Lilypond documentation] on its own because Lilypond won't accept a score with only markup (the fret diagram) and nothing else; you have to place the markup on the page.startluacode thirddata = thirddata or {}

<texcode> function thirddata.parselilypondfile(name) -- include all systems (pages) -- name is like \usemodule[LILYTEMP/mainfile-temp-lilypond]-21.pdf\starttext logs.report("LILYPOND","name='" .. name .. "'")\catcode`\ local scname = string.gsub(name, '%.pdf$', '-systems.count') local syco =11tonumber(io.loaddata(scname)) or 0

D chord: for nr = 1, syco do logs.report("LILYPOND","including system no." .. nr) context("\\setupfloats[location=right,frame=off]\\placefigure[none]{}{\\externalfigure[" .. string.gsub(name, '%.pdf$', '-' .. nr) .. "]}") end end\blankstopluacode

\startlilypondusemodule[filter]d'' ^ \markup defineexternalfilter[lilypond] [continue=yes, cache=yes, readcommand=\ParseLilypondFile, directory=\LILYTEMP/, output={ \fret-diagram #"s:0externalfilterbasefile.75;f:1;6pdf}, filtercommand={lilypond -x;5dbackend=eps -x;4dinclude-o;3eps-2fonts -1;2dno-3gs-3;1load-2fonts -2;o" }\stoplilypondLILYTEMP/\catcode`externalfilterbasefile" "\-=12externalfilterinputfile"}]

\stoptextsetuplayout[textwidth=6in] % matches line-width below</texcode>\definefontfeature[main][protrusion=quality, expansion=quality]\definefontfamily[mainface][rm][Adobe Jenson Pro][features=main]\setupbodyfont[mainface,13pt]\setupalign[hz,hanging]

Known bugs:\layout{* LilyPond indent=0\mm ragged-right = ##f}\paper {myStaffSize = #20 #(define fonts (make-pango-font-tree "Adobe Jenson Pro" "Myriad Pro" "Myriad Pro"(/ myStaffSize 20)))line-width=6\in oddFooterMarkup=##f oddHeaderMarkup=##f bookTitleMarkup = ##f scoreTitleMarkup = ##f }melody = \relative c's EPS bounding box is sometimes a bit too small, so sometimes the content is cropped. Perhaps call eps2eps or the like to fix that?' { \clef treble \key c \major \time 4/4

'''Beware: These relate to the old version of the module and older versions of LilyPond (earlier than lower = \relative c { \clef bass \key c \major \time 2.7)! Nowadays, LilyPond and epstopdf get called via texmfstart, that works without patching!'''/4

For the latest versions of the module work with ConTeXt MkIV (LuaTeX) exclusively, so we moved this to \score { << \new Voice = "Oldermel":{ \autoBeamOff \melody } \new Lyrics \lyricsto mel \text \new PianoStaff << \new Staff = "upper" \upper \new Staff = "lower" \lower >> >> \layout { \context { \Staff \RemoveEmptyStaves } }}

<texcode>\starttypescript[wiki][songbook]\usetypescript [serif] [schoolbook] [\defaultencoding]\definetypeface [songbook] [rm] [serif] [schoolbook] [default] [encoding=\defaultencoding]\definetypeface [songbook] [ss] [sans] [default][default] [encoding=ec]\definetypeface [songbook] [tt] [mono] [default][default] [encoding=ec]stoplilypond\stoptypescriptinput tufte

\usetypescript [wiki] [songbook]\setupbodyfont[songbook, rm, 8.5pt]stoptext

==Too many open files = LilyPond is not found === Calling lilypond from command line in Windows fails. You have two options:* modify the module, so that lilypond is called with the whole path (<code>C:/prog/lilypond/usr/bin/lilypond</code> for example instead of <code>lilypond</code> alone).* place a <code>lilypond.bat</code> somewhere in your search path, calling c:/prog/lilypond/usr/bin/lilypond %1 %2 %3 %4 %5 %6 %7 %8 %9 Calling lilypond from ConTeXt via shell exit (write18) in MacOS X also fails, even if the shell's path is right. (Seems more like write18 wouldn't use the environment.) Modify the module (try <tt>which lilypond</tt> to get its path).

LilyPond 2.7.26 comes without a command line With bigger projects and the above setup you might run into "versiontoo many open files"errors, at least in the MacOS X editionLinux, i.eOSX and other Unix-like OSes. Ask your shell about the <tt>lilypond.sh</tt> script is missing.Here's open files maximum and set it's relevant contenthigher:

#!/bin/sh $ ulimit -n ## where was the app installed? 256 INSTALLDIR=/Applications if [ " $1" == "-ulimit -printS -appdir" ]; then echo "$INSTALLDIR/LilyPond.app/" exit 0 fi # where to put the output export LILYPOND_DESTDIR=`pwd` # run the program python "$INSTALLDIR/LilyPond.app/Contents/Resources/lilycall.py" \ "$INSTALLDIR/LilyPond.app/" $@n 2048

=== The old LilyPond stops module (t-lilypond) doesn't work any more with an 'Unbound variable' error ===recent versions of ConTeXt, therefore we removed its documentation here.