release: 1.3.93

[lilypond.git] / Documentation / user / properties.itely

diff --git a/Documentation/user/properties.itely b/Documentation/user/properties.itely
index 15418e5a662b479a50097e4df7b414e79e25deb4..9d8e5c1bf1c032b24316da1148d6b155c944ac1b 100644 (file)
--- a/Documentation/user/properties.itely
+++ b/Documentation/user/properties.itely
@@ -7,6 +7,10 @@ property is listed in parentheses after the property name.
  (\t\)
 @end macro
 
+
+TODO:
+
+
 @table @samp
   @item @code{Generic_property_list}
     Defines names and types for generic properties. These are properties
@@ -43,24 +47,30 @@ property is listed in parentheses after the property name.
 @cindex properties!Thread
 
 @table @samp
-  @item @code{noteheadStyle}@indexcode{noteheadStyle} @propertytype{string}
-    Selects type of note head.  Choices are @code{cross},
-    @code{diamond}, @code{harmonic}, @code{transparent}, and @code{""}. 
-    They are shown in that order below.
-
-    @mudela[center,verbatim]
+  @item @code{noteHeadStyle}@indexcode{noteHeadStyle} @propertytype{symbol}
+    Selects type of note head.  Choices are @code{'cross},
+    @code{'diamond}, @code{'harmonic}, @code{'transparent}, 
+    @code{'mensural}, @code{'baroque}, and @code{'default}. 
+    They are shown in that order below. The  @code{'baroque}, 
+    style gives the default symbols except for brevis and 
+    longa notes which are square shaped as in the @code{'mensural} 
+    style.
+
+@mudela[center,verbatim]
       \score {
         \notes { 
           \property Staff.barNonAuto = 1
-          \property Voice.noteHeadStyle = cross 
+          \property Voice.noteHeadStyle = #'cross 
           a'
-          \property Voice.noteHeadStyle = diamond
+          \property Voice.noteHeadStyle = #'diamond
           a'
-          \property Voice.noteHeadStyle = harmonic
+          \property Voice.noteHeadStyle = #'harmonic
           a'
-          \property Voice.noteHeadStyle = transparent
+          \property Voice.noteHeadStyle = #'transparent
+          a' 
+          \property Voice.noteHeadStyle = #'mensural
           a' 
-          \property Voice.noteHeadStyle = ""
+          \property Voice.noteHeadStyle = #'default
           a'
         }
         \paper {
@@ -77,7 +87,7 @@ property is listed in parentheses after the property name.
 
  
 @table @samp  
-  @item @code{stemStyle}@indexcode{flagStyle} @propertytype{string}
+  @item @code{flagStyle}@indexcode{flagStyle} @propertytype{string}
     By default set to @code{"grace"} meaning that all unbeamed 
     notes with flags are typeset with a slash through the flag. 
     Setting to @code{""} gives standard flags.
@@ -92,7 +102,7 @@ c'8 \property Voice.flagStyle = "grace" c'8
 
 @cindex properties!Voice
 
-@table @samp  
+@table @samp
   @item @code{abbrev}@indexcode{abbrev} @propertytype{integer}
     Set length for tremolo to be used if no length is explicitly
     specified. 
@@ -110,7 +120,7 @@ c'8 \property Voice.flagStyle = "grace" c'8
     directions marked with `@code{^}' or `@code{_}' in the mudela file.
     
   @item @code{noAutoBeaming}@indexcode{beamAuto}  @propertytype{boolean}
-    If set to 1 then beams are not generated automatically.
+    If set to true then beams are not generated automatically.
 
   @item @code{beamAutoEnd}@indexcode{beamAutoEnd}  @propertytype{?}
     Specifies when automatically generated beams can end.  See
@@ -290,7 +300,7 @@ r\longa r\breve r1 r2 r4 r8 r16 r32 r64 r128 r128
 @end mudela            
 
 @item @code{stemLength}@indexcode{stemLength}  
-    Set length of stems.  Unit is `@code{interline}/2', so
+    Set length of stems.  Unit is `@code{staffspace}/2', so
     @code{stemLength} defaults to 7.
 @mudela[verbatim]
 g''4 \property Voice.stemLength = #14  g4 \property Voice.stemLength = #3 g4  g,,4  
@@ -358,7 +368,7 @@ number respectively. Setting it to false will prevent printing of the
 associated element. Setting the property to 'if-no-beam will make it
 print only if there is no beam associated with this tuplet bracket.
 
-[fixme examples]
+@mudelafile[verbatim]{tuplet.ly}
 
   @item @code{tupletInvisible}@indexcode{tupletInvisible} @propertytype{boolean}
 
@@ -420,11 +430,13 @@ c1 c1 \property Staff.barSize = 20 c1 c1
 
   @item @code{clefStyle}@indexcode{clefStyle} @propertytype{string}
     Determines how clefs are typeset.  If set to @code{transparent},
-    the clefs are not printed at all, if set to
+    the clefs are not printed at all [FIXME], if set to
     @code{fullSizeChanges}, clef changes in the middle of a line are
     typeset with a full size clef.  By default, clef changes are
     typeset in smaller size.
 
+       
+
   @item @code{supportedClefTypes}@indexcode{supportedClefTypes} @propertytype{alist}
 
        Clef settings supported. The value is an association list clef
@@ -480,8 +492,8 @@ no clef is printed upon creation.
 
   @item @code{instrument}, @code{instr} @propertytype{string}
     @indexcode{instrument}@indexcode{instr}  
-    If @code{Staff_margin_engraver}
-@cindex Staff_margin_engraver
+    If @code{Instrument_name_engraver}
+@cindex Instrument_name_engraver
  is
     added to the Staff translator, then the @code{instrument} property
     is used to label the first line of the staff and the @code{instr}
@@ -528,7 +540,7 @@ no clef is printed upon creation.
     The different time signature characters are shown below with its
     names:
 
-    @mudela[center,verbatim]
+@mudela[center,verbatim]
 
       \score {
         \notes\relative c'' {
@@ -591,6 +603,9 @@ no clef is printed upon creation.
 
 @cindex properties!Score
 
+
+
+
 @table @samp
   @item @code{skipBars}@indexcode{skipBars} @propertytype{boolean}
     Set to 1 to skip the empty bars that are produced by
@@ -621,6 +636,28 @@ r1 r1*3 R1*3\property Score.skipBars=1 r1*3 R1*3
          "Time_signature"
        )
 @end example
+
+
+@item @code{timing}@indexcode{timing} @propertytype{boolean}
+  Keep administration of measure length, position, bar number, etc?
+Switch off for cadenzas.
+
+@item @code{currentBarNumber}@indexcode{currentBarNumber} @propertytype{integer}
+  Contains the current barnumber. This property is incremented at
+every barline.
+
+@item @code{measurePosition}@indexcode{measurePosition} @propertytype{Moment}
+
+  How much of the current measure (measured in whole notes) have we had?
+
+@item @code{oneBeat}@indexcode{oneBeat} @propertytype{Moment}
+
+  How long does one beat in the current time signature last?
+
+@item @code{measureLength}@indexcode{measureLength} @propertytype{Moment}
+
+  How long does one measure in the current time signature last?
+
 @end table
 
 @subsubheading ChordNamesVoice properties