Hi Klaus,
On Wed, Mar 19, 2014 at 9:40 AM, Klaus Föhl <klaus.fo...@uni-giessen.de>wrote:
> Hello,
>
> Recently I was talking with a person who also prepares music editions.
> We were sitting there later in the night over a beer or two, and then
> to illustrate a point I first had to fetch a choral piece on paper
> set in lilypond and then also to resort to the laptop.
>
> On paper: lyrics syllables spacing within one word was causing irritation.
> From my old 2.12.3 I still run I know syllables do not have a magnetic
> snap property. If they are the minimum distance apart, a hyphen appears.
> An unclosed smaller than that gap without hyphen was deemed irritating.
> Me suggesting the magnetic snap, my counterpart suggesting
> as an alternative being able to force hyphens even in tight spacing.
> Reading the 2.18.2 documentation, no word there
> neither of magnetic snapping nor of forced hyphenisation.
>
The question of "magnetic snapping" has come up.
You might be interested in the following thread:
http://lists.gnu.org/archive/html/lilypond-devel/2013-12/msg00425.html
This thread went private after a time, and I proposed the attached
solution. Mike S. had suggested the use of a new grob to collect
syllables, and this is what I did. The new grob is called "LyricWord," and
it groups syllables and hyphens. Collecting grobs like this allows for
fairly easy manipulation. The file contains some *bonus* functions which
illustrate stuff you can with the new LyricWord grobs.
Hopefully, the examples in the file illustrate the usage well enough. One
thing deserves comment: if the distance between syllables is greater than
"threshold," no compression happens.
The examples in the files are a little...odd. The intent here was to show
that this would work will all sorts of modifications to the appearance of
the markups.
Anyway, hope this helps!
--David
P.S. Noticed something interesting. Originally after \lyricsto "foo" in
the example file, there was a \lyricsmode. To get this to run with 2.19.3,
I had to take this \lyricsmode out. So, depending on your version, you may
need to put it back in? Not sure.
\version "2.18.0"
%%%%%%%%%%%%%%%%%%%%%%%%% ADD NEW GROB INTERFACE %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
#(ly:add-interface
'lyric-word-interface
"A word of lyrics. Includes syllables and hyphens."
'(text-items))
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%%%%%%%%%%%%% CREATE NEW GROB PROPERTY %%%%%%%%%%%%%%%%%%%%%%%%%%%%
#(define (define-grob-property symbol type? description)
(if (not (equal? (object-property symbol 'backend-doc) #f))
(ly:error (_ "symbol ~S redefined") symbol))
(set-object-property! symbol 'backend-type? type?)
(set-object-property! symbol 'backend-doc description)
symbol)
#(map
(lambda (x)
(apply define-grob-property x))
`(
(text-items ,list? "Syllables and hyphens of a word of lyrics")))
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%%%%%%%%%%%% ADD DEFINITION OF GROB %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
#(define (add-grob-definition grob-name grob-entry)
(let* ((meta-entry (assoc-get 'meta grob-entry))
(class (assoc-get 'class meta-entry))
(ifaces-entry (assoc-get 'interfaces meta-entry)))
(set-object-property! grob-name 'translation-type? list?)
(set-object-property! grob-name 'is-grob? #t)
(set! ifaces-entry (append (case class
((Item) '(item-interface))
((Spanner) '(spanner-interface))
((Paper_column) '((item-interface
paper-column-interface)))
((System) '((system-interface
spanner-interface)))
(else '(unknown-interface)))
ifaces-entry))
(set! ifaces-entry (uniq-list (sort ifaces-entry symbol<?)))
(set! ifaces-entry (cons 'grob-interface ifaces-entry))
(set! meta-entry (assoc-set! meta-entry 'name grob-name))
(set! meta-entry (assoc-set! meta-entry 'interfaces
ifaces-entry))
(set! grob-entry (assoc-set! grob-entry 'meta meta-entry))
(set! all-grob-descriptions
(cons (cons grob-name grob-entry)
all-grob-descriptions))))
#(add-grob-definition
'LyricWord
`(;(stencil . ,ly:lyric-word::print)
(meta . ((class . Spanner)
(interfaces . (lyric-hyphen-interface
lyric-word-interface
text-interface))))))
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
#(define (add-bound-item spanner item)
(if (null? (ly:spanner-bound spanner LEFT))
(ly:spanner-set-bound! spanner LEFT item)
(ly:spanner-set-bound! spanner RIGHT item)))
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% ENGRAVER %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
collectlyricwordEngraver =
% Collect lyric syllables and hyphens into words. (LyricExtender?)
% The bounds of a LyricWord should be LyricText grobs, when available.
% When a LyricWord consists of a single syllable, the left and right bounds
% should be the same grob.
% When a spanner is broken, the ends not attached to LyricText grobs should
% attach to NonMusicalPaperColumn, as with any spanner.
#(lambda (context)
(let ((word-bits '()) ; holds syllables and hyphens
(word '()) ; LyricWord grob we're building
(collect #f)) ; signal to end word and begin another
(make-engraver
(acknowledgers
((lyric-syllable-interface engraver grob source-engraver)
(set! collect #t)
(set! word-bits (append word-bits (list grob)))
(if (ly:grob? word)
(add-bound-item word grob)))
((lyric-hyphen-interface engraver grob source-engraver)
(let* ((props (ly:grob-basic-properties grob))
(meta (assoc-get 'meta props))
(name (assoc-get 'name meta)))
; don't collect LyricSpace
; use it as our signal to end o word/start a new one
(if (eq? name 'LyricSpace)
(set! collect #f)
(set! word-bits (append word-bits (list grob)))))))
((process-music trans)
(if (and collect (pair? word-bits))
(begin
(if (not (ly:grob? word))
(set! word (ly:engraver-make-grob trans 'LyricWord '())))
; car should always be a LyricText grob, but maybe a check is in order
(add-bound-item word (car word-bits))
(for-each
(lambda (x)
(ly:pointer-group-interface::add-grob word 'text-items x))
word-bits)))
(if (not collect)
(begin
(if (ly:grob? word)
(begin
(if (pair? word-bits)
(begin
(for-each
(lambda (x)
(ly:pointer-group-interface::add-grob word 'text-items x))
word-bits)
(if (null? (ly:spanner-bound word RIGHT))
(ly:spanner-set-bound!
word RIGHT
(car word-bits)))))
(set! word (ly:engraver-make-grob trans 'LyricWord '()))
(set! collect #t)))
(if (not (ly:grob? word))
(begin
(set! word (ly:engraver-make-grob trans 'LyricWord '()))
(if (pair? word-bits)
(begin
(ly:spanner-set-bound! word LEFT (car word-bits))
(for-each
(lambda (x)
(ly:pointer-group-interface::add-grob word 'text-items x))
word-bits)
(if (null? (ly:spanner-bound word RIGHT))
(ly:spanner-set-bound! word RIGHT (car word-bits)))))
(set! word '())))))
(set! word-bits '())))))
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
#(define (compress-pair syl-a hyphen syl-b threshold)
(let* ((hyphen-sten (ly:lyric-hyphen::print hyphen))
(hyphen-ex
(if (ly:stencil? hyphen-sten)
(ly:stencil-extent hyphen-sten X)
(cons (/ threshold -2) (/ threshold 2)))))
(if (> (interval-length hyphen-ex) threshold)
'() ; no compression--DO NOTHING!
(let*
((syl-a-text (ly:grob-property syl-a 'text))
(syl-a-text (if (markup? syl-a-text) syl-a-text (markup syl-a-text)))
(syl-b-text (ly:grob-property syl-b 'text))
(syl-b-text (if (markup? syl-b-text) syl-b-text (markup syl-b-text)))
(full-text (make-concat-markup (list syl-a-text syl-b-text))))
(set! (ly:grob-property syl-a 'text) full-text)
(set! (ly:grob-property syl-b 'text) empty-markup)
(set! (ly:grob-property syl-a 'stencil) lyric-text::print)
(set! (ly:grob-property syl-b 'stencil) lyric-text::print)
(set! (ly:grob-property hyphen 'stencil) empty-stencil)))))
#(define (lyric-word-compressor threshold)
(lambda (grob) ; LyricWord
(let* ((items (ly:grob-object grob 'text-items))
(item-list (ly:grob-array->list items)))
(if (> (length item-list) 1) ; do nothing to monosyllabic words
(let* ((text-grobs
(filter
(lambda (item)
(grob::has-interface item 'lyric-syllable-interface))
item-list))
(hyphen-grobs
(filter
(lambda (item)
(grob::has-interface item 'lyric-hyphen-interface))
item-list)))
(define (helper seed tx-list hy-list)
(if (and (pair? (cdr tx-list))
(pair? hy-list))
(let ((next-syl (cadr tx-list))
(hyphen (car hy-list)))
(compress-pair seed hyphen next-syl threshold)
(if (equal? empty-markup (ly:grob-property next-syl 'text))
(helper seed (cdr tx-list) (cdr hy-list))
(helper (cadr tx-list) (cdr tx-list) (cdr hy-list))))))
(helper (car text-grobs) text-grobs hyphen-grobs))))))
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% EXAMPLE %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%% SOME OTHER FUNCTIONS %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
#(define (dim-hack grob ax)
(let* ((elts (ly:grob-object grob 'text-items))
(common (ly:grob-common-refpoint-of-array grob elts ax))
(rel (ly:relative-group-extent elts common ax))
(off (ly:grob-relative-coordinate grob common ax)))
(coord-translate rel (- off))))
#(define (height-hack grob)
(dim-hack grob Y))
#(define (width-hack grob)
(dim-hack grob X))
#(define (ly:lyric-word::underline grob)
(let* ((height (height-hack grob))
(width (width-hack grob)))
(make-line-stencil 0.1 (car width) 0 (cdr width) 0)))
#(define (ly:lyric-word::boxer grob)
(let* ((yext (height-hack grob))
(xext (width-hack grob))
(thick 0.1))
(ly:stencil-add
(make-filled-box-stencil xext (cons (- (car yext) thick) (car yext)))
(make-filled-box-stencil xext (cons (cdr yext) (+ (cdr yext) thick)))
(make-filled-box-stencil (cons (cdr xext) (+ (cdr xext) thick)) yext)
(make-filled-box-stencil (cons (- (car xext) thick) (car xext)) yext))))
wordunderline = \once \override LyricWord.stencil = #ly:lyric-word::underline
wordbox = \once \override LyricWord.stencil = #ly:lyric-word::boxer
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% EXAMPLES %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
<<
\new Voice = "foo" \relative c' {
\repeat unfold 16 { a8 b a2 a8 b }
}
\new Lyrics \lyricsto "foo" {
\override Lyrics.LyricWord.after-line-breaking = #(lyric-word-compressor 0)
\override Lyrics.LyricHyphen.minimum-distance = #0
\override Lyrics.LyricSpace.minimum-distance = #1
\repeat unfold 10 { foo }
\repeat unfold 10 { foo -- \markup \caps bar }
\repeat unfold 10 { \markup \bold syl -- la -- ble }
a \markup \with-color #red ran -- \markup \box dom string of mo -- no -- syl -- la -- bic
and mul -- ti -- \markup \fontsize #5 syl -- la -- bic
\markup \bold \underline ver -- \markup \italic bi -- age
\markup {
\stencil #(make-circle-stencil 0.5 0 #f)
}
}
>>
<<
\new Voice = "foo" \relative c' {
\repeat unfold 16 { a8 b a2 a8 b }
}
\new Lyrics \lyricsto "foo" {
\override Lyrics.LyricWord.after-line-breaking = #(lyric-word-compressor 0.4)
\override Lyrics.LyricHyphen.minimum-distance = #0
\override Lyrics.LyricSpace.minimum-distance = #1
\repeat unfold 10 { foo }
\repeat unfold 10 { foo -- \markup \caps bar }
\repeat unfold 10 { \markup \bold syl -- la -- ble }
a ran -- \markup \box dom string of
\wordunderline mo -- no -- syl -- \markup \underline la -- bic
and \wordbox mul -- ti -- \markup \fontsize #5 syl -- la -- \markup \box bic
\wordunderline ver -- \markup \italic bi -- age
\markup {
\stencil #(make-circle-stencil 0.5 0 #f)
}
}
>>
\layout {
ragged-last = ##t
\context {
\Global
\grobdescriptions #all-grob-descriptions
}
\context {
\Lyrics
\consists \collectlyricwordEngraver
}
}
_______________________________________________
lilypond-user mailing list
lilypond-user@gnu.org
https://lists.gnu.org/mailman/listinfo/lilypond-user