gardener, Interface administrators, Administrators
1,539
edits
Changes
Jump to navigation
Jump to search
m
* First you need a working, recent [http://www.lilypond.org LilyPond] installation (version 2.10.x) plus dependencies like GhostScript.
* Include the lilypond module
* If you want, you can change the default settings using <cmd>setuplilypond</cmd>
* If you need lyrics with accented characters (e.g. umlauts), you '''must''' typeset in UTF-8 encoding (see [[Encodings_and_Regimes]]), because LilyPond doesn't understand anything else. And you need to use UTF-8 without BOM (byte order marker), because ConTeXt doesn't understand BOMs.
* The module works with LuaTeX.
== Snippets ==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.
There are some notes \lilyponddef\LILYTEMP{lilytemp} % name of folder for LilyPond/buffer files \def\ParseLilypondFile#1% #1 is the name of the output file { \relativectxlua{bes a c bthirddata.parselilypondfile("#1")}} \startluacode thirddata = thirddata or {} embedded in this line -- 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"}]
== Sections ==
E.g. for == LilyPond Settings == Collect your LilyPond settings in a songbook you want to place big chunks of LilyPond output (i.e. note staffs) ly file, put it in your text. It behaves lilytemp directory and include it from within your lilypond block like any other graphics, especially similar to embedded [[MetaPost]] codethis:
\section{A Tune}
There's nothing to say about this tune yet; someone heard it from Lúnasa\defineexternalfilter[lilypond][ ... bufferbefore={lilypond::settings}, ...]
>>
\stoplilypond
== Font hints ==Please look up the meaning of settings in [http://lilypond.org/doc/v2.18/Documentation/web/manuals LilyPond’s great documentation]!
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...)
LilyPond's default text font is Century Schoolbook. You can use it in ConTeXt MkIV (OpenType fonts) like this:== Named Buffers ==
\starttypescript[wiki][songbook] \usetypescript [serif] [schoolbook] \definetypeface [songbook] [rm] [serif] [schola] [default] \definetypeface [songbook] [ss] [sans] [default][default] \definetypeface [songbook] [tt] [mono] [default][default]\stoptypescript== Automatical width adaption ==
\usetypescript [wiki] [songbook]\setupbodyfont[songbookIf you want to set your note line width automatically to your current text width, rm, 8.5pt]</texcode>try this:
For ConTeXt MkII use: -- this goes after "create temp folder" io.savedata("\LILYTEMP/texsettings.ly", "\\paper { line-width = " .. string.gsub(number.todimen(tex.dimen.textwidth),"pt","\\pt") .. " } \n")
== Current workarounds ==You must comment/delete the "line-width" setting in mysettings.ly, otherwise it doesn’t work.
This section lists workarounds needed in some circumstances; we surely hope to move them to [[#Older_Workarounds|'''Older Workarounds''']] as soon as possible!== Example ==
=== Something (LilyPondHere's an example of placing score snippets in the body of the text, GhostScript etc.) isn't found ===with fonts in the score & body matching:
Depending on your setup (path, installation directories, ...) you must call the lilypond app with the full path.<texcode>\def\LILYTEMP{lilytemp} % name of folder for LilyPond/buffer files
If <tt>pstopdf</tt> can't create PDFs \def\ParseLilypondFile#1% #1 is the name of the output file {\ctxlua{thirddata.parselilypondfile(but LilyPond has made EPS files"#1") it might be that you must set the environment variable <tt>GS_LIB</tt> for GhostScript.}}
LilyPond 2 -- create temp folder if missing if not lfs.11 isdir(and probably 2"\LILYTEMP") then lfs.12mkdir("\LILYTEMP") changes the call syntax, thus the module for 2.10 doesn't work. end
Look for the function thirddata.parselilypondfile(name) -- include all systems (pages) -- name is like \LILYTEMP/mainfile-temp-lilypond call in <tt>t-lilypond21.pdf logs.tex</tt> and replace report("LILYPOND","name='"-beps.. name .. " with '") local scname = string.gsub(name, '%.pdf$', '-dbackendsystems.count') local syco =eps"tonumber(io. loaddata(scname)) or 0
Lilypond has commands to typeset fret diagrams for the guitar chords. The most important one is called <code>\fret-diagram<usemodule[filter]\defineexternalfilter[lilypond] [continue=yes, cache=yes, readcommand=\ParseLilypondFile, directory=\LILYTEMP/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 output={\externalfilterbasefile. In additionpdf}, you can't type the example found in [http:// filtercommand={lilypond.org/doc/v2.10/Documentation/user/lilypond/Overview-ofdbackend=eps -dinclude-eps-fonts -textdno-markupgs-commands#indexload-g_t_0040code_007bfret_002ddiagram_007dfonts -935 the Lilypond documentationo"\LILYTEMP/\externalfilterbasefile" "\externalfilterinputfile"}] 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.
All in all \setuplayout[textwidth=6in] % matches line-width below\definefontfeature[main][protrusion=quality, something like this will work:expansion=quality]\definefontfamily[mainface][rm][Adobe Jenson Pro][features=main]\setupbodyfont[mainface,13pt]\setupalign[hz,hanging]
<texcode>
\usemodule[lilypond]
\catcode`\-=11
D chord:\blankinput zapf
d'' ^ \markup { \fret-diagram #"s:0.75;f:1;6-x;5-x;4-o;3-2-1;2-3-3;1-2-2;" }
\stoplilypond
\catcode`\-=12
If you find a real solution to the <code>catcode</code> problem, please document it here, or report it to the list -- [[User:Arthur|Arthur]]b c d}
For information how the integration works, please check the module code and its PDF version (both available from [[modules:t-lilypond|LilyPond on Modules]]). Unlike <tt>lilypond-book<upper = \relative c'' { \clef treble \key c \major \time 2/tt> for LaTeX, the module does not use a precompiling step and thus can react to local width changes and the like, even if the LilyPond code is stored in a buffer.4
Known bugs: a4 b c d* LilyPond's EPS bounding box is a bit too small, so sometimes the content is cropped. Perhaps call eps2eps or the like to fix that?}
Things that have not been implemented yet include:* make lilypond call back on ConTeXt for included TeX (cf. [http://lsr.dsi.unimi.it/LSR/Item?idlower =107])\relative c {* get information from LilyPond about the baseline, for run-in music fragments \clef bass* tell LilyPond how much space is left on the first page \key c \major* check and probably work on proper multi-page music* it's not possible to set variables in LilyPond* lots of features \time 2/4
To remember: a2 c* see [http://lilypond.org/doc/v2.10/Documentation/ LilyPond Docs]!}
--[[User:ChristopherCreutzig|Christopher Creutzig]] after ideas by [[User:Hraban|Hraban]]\score { << \new Voice = "mel" { \autoBeamOff \melody } \new Lyrics \lyricsto mel \text \new PianoStaff << \new Staff = "upper" \upper \new Staff = "lower" \lower >> >> \layout { \context { \Staff \RemoveEmptyStaves } }}
== Older Workarounds ==\stoplilypond\input tufte
'''Beware: These relate to the old version of the module and older versions of LilyPond (earlier than 2.7)! Nowadays, LilyPond and epstopdf get called via texmfstart, that works without patching!'''\stoptext === LilyPond is not found === Calling lilypond from command line in Windows fails. (Seems like a bug in lilypond.)</texcode>
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== Too many open files ==
Calling lilypond from ConTeXt via shell exit (write18) With bigger projects and the above setup you might run into "too many open files" errors, at least in MacOS X also failsLinux, even if the shell's path is right. (Seems more OSX and other Unix-like write18 wouldn't use the environmentOSes.) Modify Ask your shell about the module (try <tt>which lilypond</tt> to get its path).open files maximum and set it higher:
LilyPond 2.7.26 comes without a command line "version", at least in the MacOS X edition, i.e. the <tt>lilypond.sh</tt> script is missing.Here's it's relevant content: $ ulimit -n #!/bin/sh 256 ## where was the app installed? INSTALLDIR=/Applications if [ " $1" == "ulimit -S -print-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
Save this as <tt>lilypond.sh</tt>, make it executable and symlink it into a directory on your path, e.g. chmod a+x lilypond.sh sudo ln -s lilypond.sh /usr/local/bin/lilypond== Deprecation ==
=== 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.
The [http://modules.contextgarden.net/t-lilypond LilyPond module] as of 2005-09-12 uses some commands in its header that work only with LilyPond 2.6 (at least no more with 2.7.25); replace "ly:parser-print-score" with "print-score-with-defaults" and "ly:music-scorify" with "scorify-music" for LilyPond 2.7 series.
[[Category:Music]]
[[Category:Requests]]
fix link of filter module
< [[Graphics]] | [[Using Graphics]] >
[http://www.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].)
== Simple Filter Setup == This works with ConTeXt MkII and MkIV, but takes only the first page of multi-pages scores, and you must create the folder "lilytemp" manually:
<texcode>
\def\readPDFfile#1{\externalfigure[#1]} \usemodule[filter]\defineexternalfilter[lilypond] [continue=yes, readcommand=\readPDFfile, directory=lilytemp/, % directory for LilyPond's files output={\externalfilterbasefile.pdf}, filtercommand={lilypond-dbackend=eps -ddelete-intermediate-files -o"lilytemp/\externalfilterbasefile" "\externalfilterinputfile"}]
</texcode>
==Multi Page Filter Setup = options ==={| 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)|}
<texcode>
</texcode>
<texcode>
\startlilypond
\relative { \repeat volta 2 { \partial 4 e4 | a2 c4 d | e2 f4 e | d2. c4 | b4. c8 d4 e | a,2 c4 d | e2 f4 e | g,2 a | \partial 2. b2. | } \repeat volta 2 { \partial 4 r4 | f' g f d | e f e c | a b c d | e2include "mysettings. e4 | f g f8 e d4 |ly" e f e c | a c b8 a g4 | } \alternative { { \partial 2. g2. } { \partial 2. a2. } }}
\stoplilypond
</texcode>
You can avoid this \include line following [http://modules.contextgarden.net/dl/t-filter/doc/context/third/filter/filter.txt filter module documentation], section "Prepend and append text".
In short: you can inline your complete LilyPond settings or at least the include line:
<texcode>
\startbuffer[lilypond::settings]
\include "mysettings.ly"
\stopbuffer
</texcode>
=== Sample Include File ===
"mysettings.ly" could look like this:
<texcode>
\sectionversion "2.18.2"#(ly:set-option (quote no-point-and-click))#(set-global-staff-size 14) % --- start of setup for single-line output files ---#(define default-toplevel-book-handler print-book-with-defaults-as-systems ) #(define toplevel-book-handler (lambda ( . rest) (set! output-empty-score-list #f) (apply print-book-with-defaults rest))) #(define toplevel-music-handler (lambda ( . rest) (apply collect-music-for-book rest))) #(define toplevel-score-handler (lambda ( . rest) (apply collect-scores-for-book rest))) #(define toplevel-text-handler (lambda ( . rest) (apply collect-scores-for-book rest))) #(set! output-empty-score-list #t) % --- stop single-line setup --- \paper {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+ }
}
}
</texcode>
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.;)
Normally, your LilyPond snippets just get a running number. If you re-order your scores, each one gets re-rendered. You can avoid that if you name your LilyPond snippets: just add <tt>[name=myfunnyname]</tt> to <cmd>startlilypond<texcode/cmd>. If you have just one LilyPond part per component (e.g. songs in a songbook), you could use <tt>[name=\usetypescriptfile[type-otfcurrentcomponent]</tt>.
and then adapt your snippets or preamble buffer:
<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]\stoptypescript \usetypescript [wiki] [songbook]include "../mysettings.ly"\setupbodyfont[songbook, rm, 8include "texsettings.5pt]ly"
</texcode>
\startluacode thirddata === LilyPond 2.11 ===thirddata or {}
for nr =1, syco do logs.report("LILYPOND","including system no." .. nr) context("\\setupfloats[location=right,frame= Typesetting fret diagrams ===off]\\placefigure[none]{}{\\externalfigure[" .. string.gsub(name, '%.pdf$', '-' .. nr) .. "]}") end end\stopluacode
\starttext
\startlilypond
\stoptextlayout{< 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'' { \clef treble \key c \major \time 4/texcode>4
text == Developer's Corner ==\lyricmode {Aaa Bee Cee Dee}
[[Category:Modules]]
