From ecc5f935fdc214257d7451027abc37cfcc77ac93 Mon Sep 17 00:00:00 2001 From: James Lowe Date: Sun, 30 May 2010 10:10:09 +0100 Subject: [PATCH] Doc: Updated CG 4.3.3 Sectioning Commands Added note about not using @ within @node with example. Minor formatting of @code text within section for consistency --- Documentation/contributor/doc-work.itexi | 24 +++++++++++++++++++----- 1 file changed, 19 insertions(+), 5 deletions(-) diff --git a/Documentation/contributor/doc-work.itexi b/Documentation/contributor/doc-work.itexi index bf0e316066..76fcf37f0f 100644 --- a/Documentation/contributor/doc-work.itexi +++ b/Documentation/contributor/doc-work.itexi @@ -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 -- 2.39.5