]> git.donarmstrong.com Git - lilypond.git/blobdiff - scm/music-types.scm
doc patch by Graham Percival
[lilypond.git] / scm / music-types.scm
index 284dfc64e710ac2f3d0dc0f7dd6311e6074c6a8d..a2795ad7b9ffd6bc22d045e6a50d28c7a1d8ef8c 100644 (file)
@@ -3,14 +3,15 @@
   `(
     (AbortEvent
      . (
-       (description .  "Abort currently running spanners.")
+   (description .  "End the currently running spanners.")
        (internal-class-name . "Event")
        (span-type . "abort")
        (types . (general-music event abort-event))
        ))
     (AbsoluteDynamicEvent
      . (
-       (description . "")
+   (description . "Creates a dynamic mark.  Syntax: @var{note}@code{\\x},
+where x is one of \@\{\\ppp, \\pp, \\p, \\mp, \\mf, \\f, \\ff, \\fff.\@\}")
        (internal-class-name . "Event")
        (types . (general-music event dynamic-event absolute-dynamic-event))
        ))
     ;; separate non articulation scripts  
     (ArticulationEvent
      . (
-       (description .  "")
+   (description .  "Adds an articulation marking to a note.  Syntax:
+@var{note}@code{X}@code{Y}, where X is a direction (up @code{^}, down
+@code{_}, or Lilypond's choice (no direction specified)), and where Y
+is an articulation (such as @code{-.}, @code{->}, @code{\\tenuto},
+@code{\\downbow}).  See the user manual for details.")
 
        (internal-class-name . "Event")
        (types . (general-music event articulation-event script-event))
        ))
     (BeamEvent
      . (
-       (description .  "")
+   (description .  "Starts or stops a beam.  Syntax for manual control:
+\[c8 c c\] c8")
 
        (internal-class-name . "Event")
        (types . (general-music event beam-event span-event))
        ))
     (BreakEvent
      . (
-       (description .  "")
+   (description .  "Creates a line break.  Syntax: \\break.")
 
        (internal-class-name . "Event")
        (types . (general-music break-event event))
        ))
     (BreathingSignEvent
      . (
-       (description .  "")
+   (description .  "Creates a `breath mark' or `comma'.  Syntax:
+@var{note}\\breathe.")
 
        (internal-class-name . "Event")
        (types . (general-music event breathing-event))
@@ -90,7 +97,9 @@
        ))
     (CrescendoEvent
      . (
-       (description .  "")
+   (description .  "Begins or ends a crescendo.  Syntax: @var{note}\\cr
+... @var{note}\\rc (you can also use \\<, \\!, \\cresc, and
+\\endcresc.  See the user manual for details.).")
 
        (internal-class-name . "Event")
        (types . (general-music dynamic-event crescendo-event event))
        )) 
     (TieEvent
      . (
-       (description .  "A tie. Entered as ~.")
+       (description .  "A tie.  Entered as ~.")
        (internal-class-name . "Event")
        (types . (general-music tie-event event))
        ))