]> git.donarmstrong.com Git - lilypond.git/commitdiff
Doc: Updated CG 4.3.3 Sectioning Commands
authorJames Lowe <james.lowe@datacore.com>
Sun, 30 May 2010 09:10:09 +0000 (10:10 +0100)
committerGraham Percival <graham@percival-music.ca>
Sun, 30 May 2010 15:25:00 +0000 (16:25 +0100)
Added note about not using @ within @node with example.
Minor formatting of @code text within section for consistency

Documentation/contributor/doc-work.itexi

index bf0e31606695542455fb0465f689cd397ad847dd..76fcf37f0f68b9ff960e91f3fef885861ac3853a 100644 (file)
@@ -229,11 +229,25 @@ level.  Sections are created with
 
 @itemize
 @item
-Please leave two blank lines above a @@node; this makes it
+Please leave two blank lines above a @code{@@node}; this makes it
 easier to find sections in texinfo.
 
 @item
-If a heading is desired without creating a node, please use
+Do not use any @code{@@} commands for a @code{@@node}.  They may be
+used for any @code{@@sub...} sections or headings however.
+
+@example
+not:
+@@node @@code@{Foo@} Bar
+@@subsection @@code@{Foo@} Bar
+
+but instead:
+@@node Foo Bar
+@@subsection @@code@{Foo@} Bar
+@end example
+
+@item
+If a heading is desired without creating a @code{@@node}, please use
 the following:
 
 @example
@@ -241,9 +255,9 @@ the following:
 @end example
 
 @item
-Sectioning commands (@@node and @@section) must not appear
-inside an @@ignore.  Separate those commands with a space, ie
-@@n@tie{}ode.
+Sectioning commands (@code{@@node} and @code{@@section}) must not appear
+inside an @code{@@ignore}.  Separate those commands with a space, ie
+@code{@@n}@tie{}@code{ode}.
 
 @end itemize