Merge branch 'master' of ssh://jneem@git.sv.gnu.org/srv/git/lilypond into tmp

[lilypond.git] / Documentation / user / policy.txt

diff --git a/Documentation/user/policy.txt b/Documentation/user/policy.txt
index 7fe186a3f1e2a67fe004de2a4678392fecd2d91a..0460e7ad3b4bff11187deb9b2a64481f05b678b1 100644 (file)
--- a/Documentation/user/policy.txt
+++ b/Documentation/user/policy.txt
@@ -66,7 +66,7 @@ Users are not expected to read this manual from start to finish.
 
 
 * Music Glossary: information about the music notation itself.
-  Explainations and translations about notation terms go here.
+  Explanations and translations about notation terms go here.
 
 Users are not expected to read this manual from start to finish.
 
@@ -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,
@@ -137,6 +142,20 @@ main docs
   (ie 1.1.1 Writing Pitches).
 
 
+%%%%% CHECKING CROSS-REFERENCES
+
+Cross-references between different manuals are heavily used in the
+documentation, but they are not checked during compilation.  However,
+if you compile the documentation, a script called check_texi_refs can
+help you with checking and fixing these cross-references; for
+information on usage, cd into a source tree where documentation has
+been built, cd into Documentation and look for check-xrefs and
+fix-xrefs targets in 'make help' output.  Note that you have to find
+yourself the source files to fix cross-references in the generated
+documentation such as the Internals Reference; e.g. you can grep
+scm/ and lily/.
+
+
 %%%%% GENERAL WRITING
 
 * Do not forget to create @cindex entries for new sections of text.
@@ -153,6 +172,11 @@ main docs
   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.
@@ -162,6 +186,7 @@ simultaenous    NOT concurrent
 measure: the unit of music
 bar line: the symbol delimiting a measure   NOT barline
 note head   NOT notehead
+chord construct   NOT chord (when referring to <>)
 
 
 %%%%% TECHNICAL WRITING STYLE