]> git.donarmstrong.com Git - lilypond.git/commitdiff
update.
authorGraham Percival <graham@percival-music.ca>
Tue, 23 Oct 2007 20:08:20 +0000 (13:08 -0700)
committerJohn Mandereau <john.mandereau@gmail.com>
Fri, 2 Nov 2007 08:50:45 +0000 (09:50 +0100)
Documentation/user/policy.txt

index 63ae075085f0f388e343a7c253f0296d78784d20..148b4f681b9abef8a61a874692edd9368830e8c8 100644 (file)
@@ -65,22 +65,18 @@ main docs
 
     Music glossary: @rglos{foo}, @rglos{bar}.
 
-    User manual: @ref{baz}, @ref{foozle}.
+    Learning Manual: @rlearning{baz}, @rlearning{foozle}
 
-    Snippets: @lsrdir{section}.
+    Notation Reference: @ruser{faazle}, @ruser{boo}.
+
+    Snippets: @lsrdir{section}, @lsr{specific/example-name.ly}
 
     Program reference: @internalsref{fazzle}, @internalsref{booar}.
 
   ("Snippets" is REQUIRED; the others are optional)
 
 * To create links, use @ref{} if the link is within the same
-  manual.  If you are linking to another manual (say,
-  learning->glossary or user->program usage), then use:
-    @rlearning{}
-    @ruser{}
-    @rprogram{}
-    @rglos{}
-    @internalsref{}
+  manual.
 
 * @commonprop and @refbugs are optional.
 
@@ -233,6 +229,17 @@ main docs
        @warning{}: produces a "Note: " box.  Use for important
       messages.
 
+* References must occur at the end of a sentence, for more
+  information see @ref{the texinfo manual}.  Ideally this should
+  also be the final sentence of a paragraph, but this is not
+  required.  Any link in a doc section must be duplicated in the
+  @seealso section at the bottom.
+
+* Introducing examples may be done with
+     . (ie finish the previous sentence/paragaph)
+     : (ie `in this example:')
+     , (ie `may add foo with the blah construct,')
+
 
 %%%%% READABILITY