Do not scale the size of open and mute symbols ("X", "O") twice with the "size" prope...

[lilypond.git] / Documentation / user / writing-texinfo.txt

diff --git a/Documentation/user/writing-texinfo.txt b/Documentation/user/writing-texinfo.txt
index 4c988f754eb83724971cff8d21f78d3121d2771f..4b10aebd0d691adf6344002f7e30ae68c7ac7cae 100644 (file)
--- a/Documentation/user/writing-texinfo.txt
+++ b/Documentation/user/writing-texinfo.txt
@@ -34,6 +34,11 @@ commands.
   to this scheme construct.  ie
     \set Staff.instrumentName = #"cello"
 
+* All engravers should have double-quotes around them:
+    \consists "Spans_arpeggio_engraver"
+  Again, LilyPond does not strictly require this, but it is a
+  useful standard to follow.
+
 * Examples should end with a complete bar if possible.
 
 * If possible, only write one bar per line.  The notes on each
@@ -65,6 +70,12 @@ commands.
   in print.  Please create a smaller example.  (the smaller
   example does not need to be minimal, however)
 
+* Specify durations for at least the first note of every bar.
+
+* If you only have one bar per line, omit bar checks.  If you
+  put more than one bar per line (not recommended), then include
+  bar checks.
+
 * If you want to work on an example outside of the manual (for
   easier/faster processing), use this header:
 
@@ -100,6 +111,9 @@ commands.
 
 * Use two spaces after a period.
 
+* In examples of syntax, use @var{musicexpr} for a music
+  expression.
+
 * Variables or numbers which consist of a single character
   (probably followed by a punctuation mark) should be tied
   properly, either to the previous or the next word.  Example:
@@ -161,6 +175,19 @@ commands.
 
   Do not use @itemize @bullet.
 
+* To get LilyPond version, use @version{} (this does not work inside
+  LilyPond snippets).  If you write "@version{}" (enclosed with
+  quotes), or generally if @version{} is not followed by a space,
+  enclose it with
+
+  @w{ ... }
+
+  e.g.
+
+  @w{"@version{}"}
+
+  to prevent an ugly line break in PDF output.
+
 
 %%%%% SYNTAX SURVEY
 
@@ -186,17 +213,17 @@ commands.
 @q{} - Single quotes. Used for `vague' terms.
 @qq{} - Double quotes.  Used for actual quotes ("he said").
 
-@warning{}: produces a "Note: " box.  Use for important
-      messages.
-
 @tie{} - Variables or numbers which consist of a single character
   (probably followed by a punctuation mark) should be tied
   properly, either to the previous or the next word.  Example:
     "The letter@tie{}@q{I} is skipped"
 
 @var - Use for variables.
-@warning{} - produces a "Note: " box.
-  Any `\' used inside this must be written as `\\'.
+@warning{} - produces a "Note: " box. Use for important messages.
+
+@bs - Generates a backslash inside @warning.
+    Any `\' used inside @warning (and @q or @qq) must be written as `@bs{}' 
+    (texinfo would also allow \\, but this breaks with PDF output).