Documentation/user/properties.itely

   1 @node Properties, , , Reference Manual
   2
   3 Properties are Scheme values, so they have a type.  The type of a
   4 property is listed in parentheses after the property name.
   5
   6 @macro propertytype{t}
   7  (\t\)
   8 @end macro
   9
  10
  11 @table @samp
  12
  13   @item @code{midiInstrument}@indexcode{midiInstrument} @propertytype{string}
  14     Sets the instrument for MIDI output.  If this property is not set
  15     then LilyPond will use the @code{instrument} property.  This must
  16     be set to one of the strings on the list of MIDI instruments that
  17     appears in section XREF-midilist [FIXME].  If you use a string which
  18     is not listed, LilyPond will silently substitute piano.
  19
  20   @item @code{restStyle}@indexcode{restStyle} @propertytype{string}
  21     Change the layout of rests shorter than quarter notes.
  22     Currently, the standard layout @code{""} and mensural notation
  23     @code{"mensural"} are available. Mensural rests of duration
  24     32 or shorter are not available.
  25 @lilypond[verbatim]
  26 r\longa r\breve r1 r2 r4 r8 r16 r32 r64 r128 r128
  27 \property Staff.restStyle = "mensural"
  28 r\longa r\breve r1 r2 r4 r8 r16 r32 r64 r128 r128
  29 @end lilypond
  30
  31   @item @code{transposing}@indexcode{transposing} @propertytype{integer}
  32     Transpose the MIDI output.  Set this property to the number of
  33     half-steps to transpose by.
  34
  35
  36
  37 @item @code{tupletSpannerDuration} @indexcode{tupletSpannerDuration}
  38 @propertytype{moment}
  39
  40 @end table
  41
  42 @subsubheading Staff properties
  43
  44 @cindex properties!Staff
  45
  46 @table @samp
  47
  48
  49   @item @code{noVoltaBraces}@indexcode{noVoltaBraces} @propertytype{boolean}
  50     Set to true to suppress the printing of brackets over alternate
  51     endings specified by the command @code{\alternative}. [BROKEN]
  52
  53
  54   @item @code{keyOctaviation}@indexcode{keyOctaviation} @propertytype{boolean}
  55     If set to false, then keys are the same in all octaves.  If set
  56     to true then the key signature for different octaves can be
  57     different and is specified independently:
  58
  59     @example
  60       \keysignature bes fis'
  61     @end example
  62
  63     The default value is @code{#f}.  Can be set to @code{#t} with
  64     @code{\specialkey} or reset with @code{\normalkey}. [BROKEN]
  65
  66   @item @code{timeSignatureStyle}@indexcode{timeSignatureStyle} @propertytype{string}
  67     Changes the default two-digit layout for time signatures.  The
  68     following values are recognized:
  69
  70     @table @samp
  71       @item @code{C}@indexcode{C}
  72         4/4 and 2/2 are typeset as C and struck C, respectively.  All
  73         other time signatures are written with two digits.
  74
  75       @item @code{old}@indexcode{old}
  76         2/2, 3/2, 2/4, 3/4, 4/4, 6/4, 9/4, 4/8, 6/8 and 9/8 are
  77         typeset with old-style mensuration marks.  All other time
  78         signatures are written with two digits.
  79
  80       @item @code{1}@indexcode{1}
  81         All time signatures are typeset with a single
  82         digit, e.g. 3/2 is written as 3.
  83
  84       @item @indexcode{CM/N}@code{C}@var{M}@code{/}@var{N},
  85       @indexcode{oldM/N}@code{old}@var{M}@code{/}@var{N} or
  86       @code{old6/8alt}@indexcode{old6/8alt}
  87         Tells LilyPond to use a specific symbol as time signature.
  88     @end table
  89
  90     The different time signature characters are shown below with its
  91     names:
  92
  93 @lilypond[center,verbatim]
  94
  95       \score {
  96         \notes\relative c'' {
  97           \property Voice.textStyle = typewriter
  98           \property Staff.timeSignatureStyle = "C2/2"
  99           \time 2/2; a2^"C2/2" a2
 100           \property Staff.timeSignatureStyle = "C4/4"
 101           \time 2/2; a2^"C4/4" a2
 102           \property Staff.timeSignatureStyle = "old2/2"
 103           \time 2/2; a2^"old2/2" a2
 104           \property Staff.timeSignatureStyle = "old3/2"
 105           \time 2/2; a2^"old3/2" a2
 106           \property Staff.timeSignatureStyle = "old2/4"
 107           \time 2/2; a2^"old2/4" a2
 108           \property Staff.timeSignatureStyle = "old4/4"
 109           \time 2/2; a2^"old4/4" a2
 110           \property Staff.timeSignatureStyle = "old6/4"
 111           \time 2/2; a2^"old6/4" a2
 112           \property Staff.timeSignatureStyle = "old9/4"
 113           \time 2/2; a2^"old9/4" a2
 114           \property Staff.timeSignatureStyle = "old4/8"
 115           \time 2/2; a2^"old4/8" a2
 116           \property Staff.timeSignatureStyle = "old6/8"
 117           \time 2/2; a2^"old6/8" a2
 118           \property Staff.timeSignatureStyle = "old6/8alt"
 119           \time 2/2; a2^"old6/8alt" a2
 120           \property Staff.timeSignatureStyle = "old9/8"
 121           \time 2/2; a2^"old9/8" a2
 122         }
 123         \paper {
 124           linewidth = 4.5 \in;
 125         }
 126       }
 127
 128 @end lilypond
 129
 130
 131 @end table
 132