Usage¶

Roles¶

The `lily` role¶

You can use lily role to insert a single LilyPond Music Expression as inline score.

Inline Score¶

reStructuredText

:lily:`{c'}` is the first note of the C major scale.

Result

$\score{{c'}}$ is the first note of the C major scale.

If the score contains MIDI block, the extension will generate audio file and show a player beside the score:

Playable Inline Score¶

reStructuredText

:lily:`{c' e' g' } \layout{} \midi{}` is playable.

Result

$\score{{c' e' g' } \layout{} \midi{}}$ is playable.

Added in version 2.1.0.

Hint

Some implementation details to help you debug your music expressions: the music expression will be wrapped by a \score block before passing to Lilypond.

For example, :lily:`{c'}` will be converted to \scores { {c'} }.

Directives¶

The `lily` directive¶

The lily directive is used to insert a complete LilyPond score as block level element.

Result

$\version "2.20.0" \header { title = "翼をください, Excerpts" } \score { << \new Staff \relative c' { \time 4/4 \tempo 4 = 70 r4 r r c8 d e8 e f16 e8 d16 (d4) e8 d c8 c d16 c8 b16 (b4) b8 g a4 c8 a g4 c4 d4 r r r } >> \layout {} \midi {} }$

reStructuredText

.. lily::

   \version "2.20.0"
   \header {
     title = "翼をください, Excerpts"
   }

   \score {
     <<
       \new Staff \relative c' {
           \time 4/4
           \tempo 4 = 70
           r4 r r c8 d                  e8 e f16 e8 d16 (d4) e8 d
           c8 c d16 c8 b16 (b4) b8 g    a4 c8 a g4 c4
           d4 r r r
     }
     >>

     \layout {}
     \midi {}
   }

The directive supports the following options:

nocrop:: (flag) Set this option to have scores output to images with appropriate margins and preset size (A4), which is easy for printing. See 🎵 Original paper size.

Changed in version 2.0.0.
noaudio:: (flag) If the score contains MIDI block, Lilypond generates MIDI output files. which are converted to audio files by this extension. Use this option to disable audio, see 🎵 Disable Audio.

Changed in version 2.0.0.
loop:: (flag) Whethre audio player will automatically seek back to the start upon reaching the end of the audio. This conflicts with noaudio. Example: 🎵 Loop.

Added in version 1.2.
transpose:: (text) Transposing the pitches of score from one to another. Pitches are written in LilyPond Notation and separated in whitespace. For example: :transpose: g c, see 🎵 Transposing.

Added in version 2.0.0.
controls:: (text, one of the top or bottom) Specify the position of the control bar relative to the score. This implies audio. See example 🎵 Control Bar at the Top.

Added in version 1.3.

The `lilyinclude` directive¶

The lilyinclude directive is similar to The lily directive, except the source of LilyPond are read from file but not contents of directive.

Result

$\version "2.20.0" \header { title = "《Witch Spring I》OP" composer = "Kiwi Walks" arranger = "SilverRainZ" } symbols = { \time 4/4 \tempo "Allegretto" 4 = 110 % 1 c'4 c' c' c'8 b8 c'4 g' c' c'8 b8 c'4 g' (ais') c''8 b'8 c''2 r2 %14 e'4 g c'2 a8 c'8 c'8 d'8 c'2 e'4 g' c'2 c'4 d'8 e'8 c'4 g e'4 g c'2 a8 c'8 c'8 d'8 e'4 c' g4 f e f8 g8 \bar "|." } \score { << \new Staff \with {midiInstrument = "acoustic guitar (nylon)"} { \clef "G_8" \symbols } \new TabStaff { \tabFullNotation \symbols } >> \midi { } \layout { } }$

reStructuredText

.. lilyinclude:: /_scores/witch-spring.ly

Options of the directive are same to The lily directive.

The `jianpu` directive¶

Added in version 1.6.

The jianpu directive is used to insert a Jianpu (Numbered Musical Notation, 简谱) score as block level element.

Hint

The syntax of Jianpu is defined by Silas S. Brown and we use his jianpu-ly script to convert Jianpu source code to Lilypond source code, and finally engraving a music score.

Result

$\version "2.20.0" #(set-global-staff-size 20) % un-comment the next line to remove Lilypond tagline: % \header { tagline="" } \pointAndClickOff \paper { print-all-headers = ##t %% allow per-score headers % un-comment the next line for A5: % #(set-default-paper-size "a5" ) % un-comment the next line for no page numbers: % print-page-number = ##f % un-comment the next 3 lines for a binding edge: % two-sided = ##t % inner-margin = 20\mm % outer-margin = 10\mm % un-comment the next line for a more space-saving header layout: % scoreTitleMarkup = \markup { \center-column { \fill-line { \magnify #1.5 { \bold { \fromproperty #'header:dedication } } \magnify #1.5 { \bold { \fromproperty #'header:title } } \fromproperty #'header:composer } \fill-line { \fromproperty #'header:instrument \fromproperty #'header:subtitle \smaller{\fromproperty #'header:subsubtitle } } } } } %{ The jianpu-ly input was: title=C Major Scale 1=C 2/4 4=60 1 2 3 4 5 6 7 1' %} \score { << \override Score.BarNumber.break-visibility = #center-visible \override Score.BarNumber.Y-offset = -1 \set Score.barNumberVisibility = #(every-nth-bar-number-visible 5) %% === BEGIN JIANPU STAFF === \new RhythmicStaff \with { \consists "Accidental_engraver" %% Get rid of the stave but not the barlines: \override StaffSymbol.line-count = #0 %% tested in 2.15.40, 2.16.2, 2.18.0, 2.18.2, 2.20.0 and 2.22.2 \override BarLine.bar-extent = #'(-2 . 2) %% LilyPond 2.18: please make barlines as high as the time signature even though we're on a RhythmicStaff (2.16 and 2.15 don't need this although its presence doesn't hurt; Issue 3685 seems to indicate they'll fix it post-2.18) } { \new Voice="W" { \override Beam.transparent = ##f \override Stem.direction = #DOWN \override Tie.staff-position = #2.5 \tupletUp \override Stem.length-fraction = #0 \override Beam.beam-thickness = #0.1 \override Beam.length-fraction = #0.5 \override Voice.Rest.style = #'neomensural % this size tends to line up better (we'll override the appearance anyway) \override Accidental.font-size = #-4 \override TupletBracket.bracket-visibility = ##t \set Voice.chordChanges = ##t %% 2.19 bug workaround \override Staff.TimeSignature.style = #'numbered \override Staff.Stem.transparent = ##t \mark \markup{1=C} \time 2/4 \tempo 4=60 #(define (note-one grob grob-origin context) (if (and (eq? (ly:context-property context 'chordChanges) #t) (or (grob::has-interface grob 'note-head-interface) (grob::has-interface grob 'rest-interface))) (begin (ly:grob-set-property! grob 'stencil (grob-interpret-markup grob (make-lower-markup 0.5 (make-bold-markup "1"))))))) \applyOutput #'Voice #note-one c'4 #(define (note-two grob grob-origin context) (if (and (eq? (ly:context-property context 'chordChanges) #t) (or (grob::has-interface grob 'note-head-interface) (grob::has-interface grob 'rest-interface))) (begin (ly:grob-set-property! grob 'stencil (grob-interpret-markup grob (make-lower-markup 0.5 (make-bold-markup "2"))))))) \applyOutput #'Voice #note-two d'4 #(define (note-three grob grob-origin context) (if (and (eq? (ly:context-property context 'chordChanges) #t) (or (grob::has-interface grob 'note-head-interface) (grob::has-interface grob 'rest-interface))) (begin (ly:grob-set-property! grob 'stencil (grob-interpret-markup grob (make-lower-markup 0.5 (make-bold-markup "3"))))))) | %{ bar 2: %} \applyOutput #'Voice #note-three e'4 #(define (note-four grob grob-origin context) (if (and (eq? (ly:context-property context 'chordChanges) #t) (or (grob::has-interface grob 'note-head-interface) (grob::has-interface grob 'rest-interface))) (begin (ly:grob-set-property! grob 'stencil (grob-interpret-markup grob (make-lower-markup 0.5 (make-bold-markup "4"))))))) \applyOutput #'Voice #note-four f'4 #(define (note-five grob grob-origin context) (if (and (eq? (ly:context-property context 'chordChanges) #t) (or (grob::has-interface grob 'note-head-interface) (grob::has-interface grob 'rest-interface))) (begin (ly:grob-set-property! grob 'stencil (grob-interpret-markup grob (make-lower-markup 0.5 (make-bold-markup "5"))))))) | %{ bar 3: %} \applyOutput #'Voice #note-five g'4 #(define (note-six grob grob-origin context) (if (and (eq? (ly:context-property context 'chordChanges) #t) (or (grob::has-interface grob 'note-head-interface) (grob::has-interface grob 'rest-interface))) (begin (ly:grob-set-property! grob 'stencil (grob-interpret-markup grob (make-lower-markup 0.5 (make-bold-markup "6"))))))) \applyOutput #'Voice #note-six a'4 #(define (note-seven grob grob-origin context) (if (and (eq? (ly:context-property context 'chordChanges) #t) (or (grob::has-interface grob 'note-head-interface) (grob::has-interface grob 'rest-interface))) (begin (ly:grob-set-property! grob 'stencil (grob-interpret-markup grob (make-lower-markup 0.5 (make-bold-markup "7"))))))) | %{ bar 4: %} \applyOutput #'Voice #note-seven b'4 \applyOutput #'Voice #note-one c''4^. \bar "|." } } % === END JIANPU STAFF === >> \header{ title="C Major Scale" } \layout{} } \score { \unfoldRepeats << % === BEGIN MIDI STAFF === \new Staff { \new Voice="X" { \transpose c c { \key c \major \time 2/4 \tempo 4=60 c'4 d'4 | %{ bar 2: %} e'4 f'4 | %{ bar 3: %} g'4 a'4 | %{ bar 4: %} b'4 c''4 } } } % === END MIDI STAFF === >> \header{ title="C Major Scale" } \midi { \context { \Score tempoWholesPerMinute = #(ly:make-moment 84 4)}} }$

reStructuredText

.. jianpu::

   title=C Major Scale
   1=C
   2/4
   4=60

   1 2 3 4 5 6 7 1'

Options of the directive are same to The lily directive.

The `jianpuinclude` directive¶

Added in version 1.6.

The jianpuinclude directive is similar to The jianpu directive, except the source of Jianpu are read from file but not contents of directive.

Result

reStructuredText

.. jianpuinclude:: /_scores/songbie.jp

Usage¶

Roles¶

The lily role¶

Directives¶

The lily directive¶

The lilyinclude directive¶

The jianpu directive¶

The jianpuinclude directive¶

The `lily` role¶

The `lily` directive¶

The `lilyinclude` directive¶

The `jianpu` directive¶

The `jianpuinclude` directive¶