Examples for vertical spacing: Reduce number of measures per line so that they don...

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

diff --git a/Documentation/user/policy.txt b/Documentation/user/policy.txt
index 4dac1c28f5fdd89f1752dbda586cb458f205792d..b4436a9085837cbb2c6a948fd9415b62165dcff0 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.
 
 
 * 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.
 
 
 Users are not expected to read this manual from start to finish.
 


@@ -94,7 +94,7 @@ main docs
 
     Learning Manual:
     @rlearning{baz},
 
     Learning Manual:
     @rlearning{baz},

-    @rlearning{foozle}
+    @rlearning{foozle}.

 
     Notation Reference:
     @ruser{faazle},
 
     Notation Reference:
     @ruser{faazle},


@@ -106,13 +106,11 @@ main docs
     Installed Files:
     @file{path/to/dir/blahz}.
 
     Installed Files:
     @file{path/to/dir/blahz}.
 

-    Snippets:
-    @lsrdir{section},
-    @lsr{specific/example-name.ly}.
+    Snippets: @rlsr{section}.

 
     Internals Reference:
 
     Internals Reference:

-    @internalsref{fazzle},
-    @internalsref{booar}.
+    @rinternals{fazzle},
+    @rinternals{booar}.

 
       If there are multiple entries, separate them by commas
       but do not include an `and'.
 
       If there are multiple entries, separate them by commas
       but do not include an `and'.


@@ -131,12 +129,28 @@ main docs
 * To create links, use @ref{} if the link is within the same
   manual.
 
 * To create links, use @ref{} if the link is within the same
   manual.
 

+* @predefined  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,
   but other than that all material goes into third-level sections
   (ie 1.1.1 Writing Pitches).
 
 
 * Do not include any real info in second-level sections (ie 1.1
   Pitches).  A first-level section may have introductory material,
   but other than that all material goes into third-level sections
   (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.
 %%%%% GENERAL WRITING
 
 * Do not forget to create @cindex entries for new sections of text.


@@ -153,6 +167,11 @@ main docs
   is preferred.  (instead of `Time signature')   Only use capital
   letters for musical terms which demand them, like D.S. al Fine.
 
   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.
 * Preferred terms:
     - in general, use the American spellings.  The internal
       lilypond property names use this spelling.


@@ -162,6 +181,7 @@ simultaenous    NOT concurrent
 measure: the unit of music
 bar line: the symbol delimiting a measure   NOT barline
 note head   NOT notehead
 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
 
 
 %%%%% TECHNICAL WRITING STYLE