ly/property.ly

   1 % property.ly
   2 % list of properties that lily recognises
   3 % and some shorthands (ugh)
   4
   5 %{
   6
   7 PROPERTIES
   8
   9 name                    value   effect                  shorthand
  10
  11 [Voice]
  12 ydirection              -1      force stem down         \stemdown
  13 ydirection              0       stem direction free     \stemboth
  14 ydirection              1       force stem up           \stemup
  15
  16 pletvisibility          0       show nothing
  17 pletvisibility          1       show number
  18 pletvisibility          2       show (number and bracket)-if-no-beam
  19 pletvisibility          3       show number, and bracket-if-no-beam
  20 pletvisibility          4       show number, and bracket
  21
  22 slurdash                0       normal slurs
  23 slurdash                1       dotted slurs
  24 slurdash                >1      dashed slurs
  25
  26 slurydirection          -1      force stem down         \slurdown
  27 slurydirection          0       stem direction free     \slurboth
  28 slurydirection          1       force stem up           \slurup
  29
  30 slurydirection          -1      force stem down         \slurdown
  31 slurydirection          0       stem direction free     \slurboth
  32 slurydirection          1       force stem up           \slurup
  33
  34 textalignment           -1      left alignment of text
  35 textalignment           0       center alignment of text
  36 textalignment           1       right alignment of text
  37
  38 [Score?]
  39 beamslopedamping        0       no damping              \beamslopeproportional
  40 beamslopedamping        1       damping1)               \beamslopedamped
  41 beamslopedamping        100000  zero slope              \beamslopezero
  42
  43 [Score?]
  44 beamquantisation        0       no quantisations        \beamposfree
  45 beamquantisation        1       quantise pos and slope  \beamposnormal
  46 beamquantisation        2       quantise avoide wedge2) \beampostraditional
  47
  48 [Staff]
  49 keyoctaviation  0       Key signature only for specified octave \specialkey
  50 keyoctaviation  1       Key signature for all octaves   \normalkey
  51
  52 [Staff]
  53 barAlways               0       none
  54 barAlways               1       generate bar at every moment
  55
  56 [Staff]
  57 barAuto                 0       none
  58 barAuto                 1       auto-generate bar every measure
  59 barAtLineStart          0/1     generate bar at beginning of line
  60
  61 [Staff]
  62 beamAuto                0/1     auto-beam on/off
  63 beamAutoEnd             "num/den"    end auto-beam
  64 beamAutoEnd_8           "num/den"    end auto-beam of 8ths
  65 beamAutoEnd_16          "num/den"    end auto-beam of 16ths
  66
  67 timeSignatureStyle      C       Use C and stroked C for 4/4,2/2
  68 timeSignatureStyle      old     Use old style mensuration marks
  69 timeSignatureStyle      1       Use single number
  70 timeSignatureStyle      ""      Use normal two-digit time signature
  71 timeSignatureStyle      Cn/m    Set symbol explicitly, n/m=2/2 or 4/4
  72 timeSignatureStyle      oldn/m  Set symbol explicitly,
  73                                 n/m=2/2,3/2,3/4,4/4,6/4 or 9/4.
  74 [Staff]
  75 voltaVisibility         0/1     on/off
  76 voltaSpannerDuration    Rat.    Coda kludge: set length of volta-spanner,
  77                                 typically set to one measure: "1"
  78
  79 [Staff]
  80 clefStyle       "fullSizeChanges" Clef changes typeset in full size
  81 clefStyle       "transparent"     No clef typeset
  82
  83 [Staff?]
  84 instrument              ascii   midi instrument table lookup
  85
  86 [Score]
  87 chordInversion          0/1     Find and display chord with inversion?
  88
  89
  90 1) after beam slope damping table suggested in [Wanske]
  91 2) [Wanske] as well as [Ross] suggests that beams sloped upward must not
  92    start sitting on a staffline, and beams sloped downward must not hang
  93    from a staffline (similar for beam-ends).  This would create a wedge
  94    that is traditionally being avoided because it could easily be filled-up
  95    with ink.
  96    However, avoiding these wedges restricts the freedom of beams quite a lot
  97    while they don't seem to be a problem in modern printing.
  98    In no piece of sheetmusic engraved after 1953 (Baerenreiter) i've seen
  99    these wedges being avoided.
 100
 101 %}
 102
 103 %hmm, (these) abbrevs suck, imo
 104 % i guess they're meant as some form of doco
 105 % that's what i use them for...
 106 stemup =
 107         \property Voice.ydirection = \up
 108 stemboth=       \property Voice.ydirection = \center
 109 stemdown =      \property Voice.ydirection = \down
 110
 111 slurup = \notes {
 112         s1*0
 113         \property Voice.slurydirection = \up
 114         }
 115 slurboth= \notes {
 116         s1*0
 117         \property Voice.slurydirection = \center
 118 }
 119 slurdown = \notes {
 120         s1*0
 121         \property Voice.slurydirection = \down
 122 }
 123
 124 shifton =       \property Voice.hshift = 1
 125 shiftoff =      \property Voice.hshift = 0
 126
 127 onevoice = {
 128         \stemboth \shiftoff
 129 }
 130
 131 voiceone = {
 132         \type Voice = one
 133         \stemup
 134 }
 135
 136 voicetwo = {
 137         \type Voice = two
 138         \stemdown
 139 }
 140
 141 voicethree = {
 142         \type Voice = three
 143         \stemup
 144
 145 }
 146
 147 voicefour = {
 148         \type Voice = four
 149         \stemdown
 150         \shifton
 151 }
 152
 153 onestaff =
 154         \translator Staff=one
 155
 156
 157 staffone = {
 158         \translator Staff=one
 159         \property Staff.ydirection = \center
 160         \property Staff.hshift = 0
 161 }
 162
 163 stafftwo = {
 164         \translator Staff=two
 165         \property Staff.ydirection = \center
 166         \property Staff.hshift = 0
 167 }
 168
 169 staffthree = {
 170         \translator Staff=three
 171         \property Staff.ydirection = \center
 172         \property Staff.hshift = 0
 173 }
 174
 175 stafffour = {
 176         \translator Staff=four
 177         \property Staff.ydirection = \center
 178         \property Staff.hshift = 0
 179 }
 180
 181 % ugh, cluttering global namespace...
 182 none=0
 183 free=0
 184 normal=1
 185 traditional=2
 186 infinity=10000
 187
 188 beamslopeproportional =
 189         \property Score.beamslopedamping = \none
 190
 191 beamslopedamped =
 192         \property Score.beamslopedamping = \normal
 193
 194
 195 beamslopezero =
 196         \property Score.beamslopedamping = \infinity
 197
 198
 199 % this sucks, you'd want to pass an array, at least
 200 % (or embedded code: you still can't dictate the slope / stemlength)
 201 beamposfree =
 202         \property Score.beamquantisation = \none
 203
 204
 205 beamposnormal =
 206         \property Score.beamquantisation = \normal
 207
 208
 209 beampostraditional =
 210         \property Score.beamquantisation = \traditional
 211
 212
 213 slurnormal =
 214         \property Voice.slurdash = ""
 215
 216
 217 slurdotted =
 218         \property Voice.slurdash = 1
 219
 220
 221 %{
 222  for grace note hack, see input/test/grace.ly
 223 %}
 224 pletoff = {
 225         \property Voice.pletvisibility = 0
 226 }
 227 pleton = {
 228         \property Voice.pletvisibility = 3
 229 }
 230 tiny  = {
 231         \property Voice.fontsize= "-2"
 232         \pletoff %urg
 233 }
 234
 235 small  = {
 236         \property Voice.fontsize= "-1"
 237 }
 238
 239 normalsize = {
 240         \property Voice.fontsize= "0"
 241         \pleton %urg
 242 }
 243
 244 %{
 245   [urg: try at] temporary grace note hack
 246   the total visible duration of the grace notes must be half
 247   the duration of the 'at' note: e.g.:
 248
 249   \grace b8 \graceat c4 \ecarg
 250   \grace c16 b16 \graceat c4 \ecarg
 251
 252 grace = {
 253         \tiny
 254 % it would be so cool not to have to specify these factors each time...
 255 % :-(
 256         \property Voice.pletvisibility = 0
 257         \[1/16
 258 }
 259
 260 graceat = \melodic {
 261         \normalsize
 262         \property Voice.pletvisibility = 0
 263         \] \[31/32
 264 }
 265
 266 ecarg =  \melodic {
 267         \property Voice.pletvisibility = 0
 268         \]
 269         \property Voice.pletvisibility = 3
 270 }
 271 %}
 272
 273 normalkey = {
 274         \property Staff.keyoctaviation = 1
 275 }
 276
 277 specialkey = {
 278         \property Staff.keyoctaviation = 0
 279 }
 280
 281 % End the incipit and print a ``normal line start''.
 282 endincipit = \notes{
 283     \partial 16; s16  % Hack to handle e.g. \bar ".|"; \endincipit
 284     \property Staff.clefStyle = "fullSizeChanges"
 285     \nobreak \bar "";
 286 }