]> git.donarmstrong.com Git - lilypond.git/commitdiff
Doc: Clarifying points in CG for Lilypond examples
authorJames Lowe <james.lowe@datacore.com>
Sun, 21 Mar 2010 18:12:45 +0000 (18:12 +0000)
committerGraham Percival <graham@percival-music.ca>
Sun, 21 Mar 2010 20:03:07 +0000 (20:03 +0000)
Added some extra notes about spacing when using braces/brackets and
Slur/Beaming/Phrase marks in Examples with the documentation

Documentation/contributor/doc-work.itexi

index 6a7a1ece911fe3142b1b9b94d13d2c09d2adc558..f209dc21656d0d678d69a21fcae103c0a0a498fc 100644 (file)
@@ -296,17 +296,10 @@ checks.
 
 @item
 Tweaks should, if possible, also occur on their own line.
-Bad:
-
-@example
-\override textscript #'padding = #3 c1^"hi"
-@end example
-
-Good:
-
 @example
-\override textscript #'padding = #3
-c1^"hi"
+not:          \override TextScript #'padding = #3 c1^"hi"
+but instead:  \override TextScript #'padding = #3
+              c1^"hi"
 @end example
 
 @item
@@ -323,7 +316,7 @@ or
 @@lilypond[verbatim,quote,relative=1]
 @end example
 
-If you want to use \layout@{@} or define variables, use
+If you want to use @code{\layout@{@}} or define variables, use
 
 @example
 @@lilypond[verbatim,quote]
@@ -373,6 +366,30 @@ not:          \chordmode @{c e g@}
 but instead:  \chordmode @{ c e g @}
 @end example
 
+@item
+Use @{ @} marks for additional @code{\markup} format comands; ie
+
+@example
+not:          c^\markup \tiny\sharp
+but instead:  c^\markup @{ \tiny \sharp @}
+@end example
+
+@item
+Remove any space around @code{<} @code{>} marks; ie
+
+@example
+not:           < c e g > 4
+but instead:   <c e g>4
+@end example
+
+@item
+Beam, slur and tie marks should begin immediately after the first
+note with beam and phrase marks ending immediately after the last.
+
+@example
+a8(\ ais16[ b cis( d] b) cis4~ b' cis,\)
+@end example
+
 @item
 If you want to work on an example outside of the manual (for
 easier/faster processing), use this header:
@@ -391,7 +408,7 @@ easier/faster processing), use this header:
 @end example
 
 You may not change any of these values.  If you are making an
-example demonstrating special \paper@{@} values, contact the
+example demonstrating special @code{\paper@{@}} values, contact the
 Documentation Editor.
 
 @end itemize