scm/interface-description.scm

   1 ;;;; interface-description.scm -- part of generated backend documentation
   2 ;;;;
   3 ;;;;  source file of the GNU LilyPond music typesetter
   4 ;;;;
   5 ;;;; (c) 1998--2002  Han-Wen Nienhuys <hanwen@cs.uu.nl>
   6 ;;;;                 Jan Nieuwenhuizen <janneke@gnu.org>
   7
   8
   9 ; should include default value?
  10
  11 (ly:add-interface
  12 'note-name-interface
  13  "Note name"
  14  '(style))
  15
  16 (ly:add-interface
  17  'dynamic-interface
  18    "Any kind of loudness sign"
  19    '()
  20     )
  21
  22 (ly:add-interface
  23  'finger-interface
  24  "A fingering instruction"
  25  '()
  26  )
  27
  28 (ly:add-interface
  29  'ligature-interface
  30  "A ligature"
  31  '()
  32  )
  33
  34 (ly:add-interface
  35  'mark-interface
  36  "a rehearsal mark"
  37  '(
  38    ))
  39
  40 ;;; todo: this is not typesetting info. Move to interpretation.
  41 (ly:add-interface
  42  'tablature-interface
  43  "tablature notes"
  44  '())
  45
  46
  47
  48 ;; todo: figure out where  to put this doco:
  49
  50 "
  51 Grob properties form a name space where you can set variables per
  52 object.  Each object however, may have multiple functions. For
  53 example, consider a dynamic symbol, such @code{\ff} (fortissimo). It
  54 is printed above or below the staff, it is a dynamic sign, and it is a
  55 kind of text.
  56
  57 To reflect this different functions of a grob, procedures and variables
  58 are grouped into so-called interfaces.  The dynamic text for example
  59 supports the  following interfaces:
  60 @table @code
  61 @item font-interface
  62   The glyph is built from characters from a font, hence the
  63 @code{font-interface}. For objects supporting @code{font-interface}, you
  64 can select alternate fonts by setting @code{font-style},
  65 @code{font-point-size}, etc.
  66
  67 @item dynamic-interface
  68   Dynamic interface is not associated with any variable or function in
  69 particular, but this makes it possible to distinguish this grob from
  70 other similar grobs (like @code{TextScript}), that have no meaning of
  71 dynamics.
  72
  73 @item text-interface
  74   This interface is for texts that are to be set using special routines
  75 to stack text into lines, using kerning, etc.
  76
  77 @item general-grob-interface
  78   This interface is supported by all grob types.
  79 @end table
  80 "