]> git.donarmstrong.com Git - lilypond.git/blobdiff - Documentation/user/README.txt
Merge with master
[lilypond.git] / Documentation / user / README.txt
index 82d313bd30cafdb819bda45ccb9a0b12f4159449..b10f6607f18e4cec3c50951fd8fba5ac048405a9 100644 (file)
@@ -1,7 +1,7 @@
 Info for Documentation
 ----------------------
 
-Current version of the manual: 2.8.0
+Current version of the manual: 2.11.10 ?
 *** Please update this whenever you run convert-ly on the docs.
 
 convert-ly --from=... --to=... --no-version *.itely
@@ -41,6 +41,10 @@ is writtin in formal technical writing style.
 GENERAL GUIDELINES
 
 * Do not forget to create @cindex entries for new sections of text.
+  Enter commands with @funindex, i.e.
+  @funindex \relative
+  do not bother with the @code{} (they are added automatically).  These
+  items are added to both the command index and the unified index.
 
 * The use of the word `illegal' is inappropriate in most cases.  Say
   `invalid' instead.
@@ -129,6 +133,10 @@ GENERAL GUIDELINES
 
 * Lines should be less than 80 characters long.
 
+* Use @q instead of `...' and @qq instead of ``...''.  The latter macro
+  should be used with care since we use `...' as the default quoting
+  throughout the manual, except for things related to direct speech.
+
 
 %%%%%
 HINTS FOR TECHNICAL WRITING STYLE