GNU LilyPond

Welcome to the home of the GNU Music Typesetter

Node:TextScript, Next:TextSpanner, Previous:SystemStartDelimiter, Up:LilyPond backend

TextScript

TextScript grobs are created by: A2_engraver and Text_engraver

font-interface

Any symbol that is typeset through fixed sets of glyphs (ie. fonts)

font-style (symbol):

a precooked set of font definitions, eg. finger volta timesig mark script large Large dynamic. Default value: (unset)

font-series (symbol):

partial font definition: medium, bold. Default value: (unset)

font-shape (symbol):

partial font definition: upright or italic. Default value: (unset)

font-family (symbol):

partial font definition: music roman braces dynamic math ... Default value: 'roman

font-name (symbol):

partial font definition: base name of font file FIXME: should override other partials. Default value: (unset)

font-design-size (number):

partial font definition: exact font size in points FIXME: should override font-relative-size. Default value: (unset)

font-relative-size (number):

partial font definition: the relative size compared the `normal' size. 0 is style-sheet's normal size, -1 is smaller, +1 is bigger, -1 is smaller. Default value: (unset)

side-position-interface

Position a victim object (this one) next to other objects (the support). #'direction = where to put the victim object (left or right?)

side-support (list):

the support, a list of grobs. Default value: (unset)

direction-source (grob (GRaphical OBject)):

in case side-relative-direction is set, which grob to get the direction from . Default value: (unset)

direction (direction):

up or down, left or right?. Default value: -1

side-relative-direction (direction):

if set: get the direction from a different object, and multiply by this. Default value: (unset)

minimum-space (number):

minimum distance that the victim should move (after padding).

FIXME: also pair? (cons LEFT RIGHT)

Default value: (unset)

padding (number):

add this much extra space between objects that are next to each other. Default value: 0.5

self-alignment-X (number):

real number: -1 = left aligned, 0 = center, 1 right-aligned in X direction.

Set to an grob pointer, if you want that grob to be the center. In this case, the center grob should have this object as a reference point. . Default value: (unset)

self-alignment-Y (number):

like self-alignment-X but for Y axis. Default value: (unset)

text-interface

A scheme markup text

text (markup (list or string)):

Scheme markup text. It is defined as follows:

text: string | (head? text+)
head: markup | (markup+)
markup-item: property | abbrev
property: (key . value)
abbrev: columns lines roman music bold italic named super sub overstrike text
        finger volta timesig mmrest mark script large Large dynamic

The following abbreviations are currently defined:

columns

horizontal mode: set all text on one line (default)

lines

vertical mode: set every text on new line

roman

select roman font

music

select feta font, and lookup by character name

bold

select bold series

italic

select italic shape

named

lookup by character name

text

plain text lookup (by character value)

super

superscript

sub

subscript

overstrike

the next text or character overstrikes this one

finger

select fingering number fontstyle

volta

select volta number fontstyle

timesig

select time signature number fontstyle

mmrest

select multi measure rest number fontstyle

mark

select mark number fontstyle

script

select scriptsize roman fontstyle

large

select large roman fontstyle

Large

select Large roman fontstyle

dynamic

select dynamics fontstyle

. Default value: (unset)

align (number):

the alignment of the text, 0 is horizontal, 1 is vertical. Default value: (unset)

baseline-skip (number):

Baseline skip to use for multiple lines of text. Default value: 2

lookup (symbol):

lookup method: 'value for plain text, 'name for character-name. Default value: (unset)

raise (number):

height for text to be raised (a negative value lowers the text. Default value: (unset)

kern (number):

amount of extra white space to add.

For text, this is `relative'(?) to the current alignment.

For barline, space after a thick line. Default value: (unset)

magnify (number):

the magnification factor. FIXME: doesn't work for feta fonts. Default value: (unset)

text-script-interface

Any text script

general-grob-interface

All grobs support this

X-offset-callbacks (list):

list of functions, each taking an grob and axis argument. The function determine the position relative to this grob's parent. The last one in the list is called first. Default value: (unset)

Y-offset-callbacks (list):

see X-offset-callbacks. Default value: (unset)

X-extent-callback (procedure):

procedure taking an grob and axis argument, returning a number-pair. The return value is the extent of the grob. Default value: (unset)

Y-extent-callback (procedure):

see X-extent-callback. Default value: (unset)

molecule-callback (procedure):

Function taking grob as argument, returning a Scheme encoded Molecule. Default value: #<primitive-procedure Text_item::brew_molecule>

font-relative-size (number):

partial font definition: the relative size compared the `normal' size. 0 is style-sheet's normal size, -1 is smaller, +1 is bigger, -1 is smaller. Default value: (unset)

extra-offset (pair of numbers):

pair of reals (a cons) forcing an extra offset before outputting. extra-offset is added just before `printing' the grob, so the typesetting engine is completely oblivious to it.

Default value: (unset)

interfaces (list):

list of symbols indicating the interfaces supported by this object. Is initialized from the meta field. Default value: (unset)

dependencies (list):

list of score-grob pointers that indicate who to compute first for certain global passes. Default value: (unset)

no-spacing-rods (boolean):

read from grobs: boolean that makes Separation_item ignore this item (MOVE ME TO ITEM). Default value: #t

extra-extent-X (pair of numbers):

enlarge in X dimension by this much, measured in staff space. Default value: (unset)

extra-extent-Y (pair of numbers):

see extra-extent-Y. Default value: (unset)

minimum-extent-X (pair of numbers):

minimum size in X dimension, measured in staff space. Default value: (unset)

minimum-extent-Y (pair of numbers):

see minimum-extent-Y. Default value: (unset)

origin (input location):

location in input file of the definition. Default value: (unset)

transparent (boolean):

This is almost the same as setting molecule-callback to #f, but this retains the dimensions of this grob, which means that you can erase grobs individually. . Default value: (unset)

Please send GNU LilyPond questions and comments to lilypond-user@gnu.org.

Please send comments on these web pages to lilypond@packages.debian.org

Copyright (c) 1997--2001 Han-Wen Nienhuys and Jan Nieuwenhuizen.

Verbatim copying and distribution of this entire article is permitted in any medium, provided this notice is preserved.