]> git.donarmstrong.com Git - lilypond.git/commitdiff
Change docstrings for microtonal music
authorCarl Sorensen <c_sorensen@byu.edu>
Thu, 8 Jan 2009 18:17:30 +0000 (11:17 -0700)
committerCarl Sorensen <c_sorensen@byu.edu>
Thu, 8 Jan 2009 18:17:30 +0000 (11:17 -0700)
Update the documentation strings for microtonal music, according
to recommendations made by Graham Breed.

Patches created by Jonathan Kulp.

Patches applied by Carl Sorensen.

Documentation/user/input.itely
lily/pitch-scheme.cc
lily/scale.cc

index 3f4eb2fc320543ccd8d19dfa65f66cb8e19c8008..f290a3370ea920edaf490c524d935f1a0e6ec64c 100644 (file)
@@ -1604,7 +1604,7 @@ The following items of notation are reflected in the MIDI output:
 
 @itemize
 @item Pitches
-@item Quarter tones (See @ref{Accidentals}. Rendering needs a
+@item Microtones (See @ref{Accidentals}. Rendering needs a
 player that supports pitch bend.)
 @item Chords entered as chord names
 @item Rhythms entered as note durations, including tuplets
@@ -1630,6 +1630,7 @@ The following items of notation have no effect on the MIDI output:
 @item Crescendi, decrescendi over a single note
 @item Tremolos entered with @q{@code{:}[@var{number}]}
 @item Figured bass
+@item Microtonal chords
 @end itemize
 
 
index 6ad6f8c89a2ded2209abebc340e379d57702db6b..1ecc247ed13911110dfccf21463d739a718d0fe3 100644 (file)
@@ -25,10 +25,11 @@ LY_DEFINE (ly_pitch_transpose, "ly:pitch-transpose",
 LY_DEFINE (ly_make_pitch, "ly:make-pitch",
           2, 1, 0, (SCM octave, SCM note, SCM alter),
           "@var{octave} is specified by an integer, zero for the octave"
-          " containing middle@tie{}C.  @var{note} is a number from 0"
-          " to@tie{}6, with 0 corresponding to pitch@tie{}C and 6"
-          " corresponding to pitch@tie{}B.  @var{alter} is a rational"
-          " number of whole tones for alteration.")
+          " containing middle@tie{}C. @var{note} is a number indexing the"
+          " global default scale, with 0 corresponding to pitch@tie{}C"
+          " and 6 usually corresponding to pitch@tie{}B. @var{alter} is" 
+          " a rational number of 200-cent whole tones for alteration.")
+
 {
   LY_ASSERT_TYPE (scm_is_integer, octave, 1);
   LY_ASSERT_TYPE (scm_is_integer, note, 2);
index 2c5ca19102b418af82314a82a2c10a9f16af1f52..c1f9a81f0550c394a8f9ec6dc06e9b06d5c68869 100644 (file)
@@ -20,7 +20,8 @@ LY_DEFINE (ly_make_scale, "ly:make-scale",
           1, 0, 0, (SCM steps),
           "Create a scale."
           "  The argument is a vector of rational numbers, each of which"
-          " represents the number of tones of a pitch above the tonic.")
+          " represents the number of 200 cent tones of a pitch above the"
+          " tonic.")
 {
   bool type_ok = scm_is_vector (steps);
 
@@ -66,7 +67,12 @@ Scale * default_global_scale = 0;
 
 LY_DEFINE (ly_set_default_scale, "ly:set-default-scale",
           1, 0, 0, (SCM scale),
-          "Set the global default scale.")
+          "Set the global default scale. This determines the tuning of"
+          " pitches with no accidentals or key signatures.  The first"
+          " pitch is C. Alterations are calculated relative to this"
+          " scale.  The number of pitches in this scale determines the"
+          " number of scale steps that make up an octave.  Usually the"
+          " 7-note major scale.")
 {
   LY_ASSERT_SMOB (Scale, scale, 1);