]> git.donarmstrong.com Git - lilypond.git/blobdiff - Documentation/user/policy.txt
Merge commit 'origin/dev/jneeman' into systems-per-page
[lilypond.git] / Documentation / user / policy.txt
index 4197d0c6acea3472129301e273552792aff7e9c9..0460e7ad3b4bff11187deb9b2a64481f05b678b1 100644 (file)
@@ -81,6 +81,7 @@ The order of headings inside documentation sections should be:
 
 main docs
 @predefined
+@endpredefined
 @snippets
 @seealso
 @knownissues
@@ -126,10 +127,14 @@ main docs
   Any new concepts or links which require an explanation should go
   as a full sentence(s) in the main text.
 
+  Don't insert an empty line between @seealso and the first entry!
+  Otherwise there is excessive vertical space in the PDF output.
+
 * To create links, use @ref{} if the link is within the same
   manual.
 
-* @predefined  is for commands in ly/property-init.ly
+* @predefined ... @endpredefined is for commands in ly/*-init.ly
+  FIXME?
 
 * Do not include any real info in second-level sections (ie 1.1
   Pitches).  A first-level section may have introductory material,
@@ -167,6 +172,11 @@ scm/ and lily/.
   is preferred.  (instead of `Time signature')   Only use capital
   letters for musical terms which demand them, like D.S. al Fine.
 
+  For scheme functions, only include the final part, ie
+    @funindex modern-voice-cautionary
+  and NOT
+    @funindex #(set-accidental-style modern-voice-cautionary)
+
 * Preferred terms:
     - in general, use the American spellings.  The internal
       lilypond property names use this spelling.