Re: Doc: standardise level 5 headings (2730) (issue 6443116)

[tdanielsmusic]

Reviewers: John Mandereau, Graham Percival,

Message:
On 2012/08/13 08:46:10, Graham Percival wrote:

> How do you feel about @subsubsubheading {TEXT}?

Perfectly happy!  I'll change it and complete
Chapter 1 in the next patch set.

Description:
Doc: standardise level 5 headings (2730)

 - add subsubheadingitalic macro for use as level 5
   heading

 - update CG to document its use

 - amend first 2 chapters of NR

Please review this at http://codereview.appspot.com/6443116/

Affected files:
  M Documentation/common-macros.itexi
  M Documentation/contributor/doc-work.itexi
  M Documentation/notation/pitches.itely
  M Documentation/notation/rhythms.itely


Index: Documentation/common-macros.itexi
diff --git a/Documentation/common-macros.itexi  
b/Documentation/common-macros.itexi
index  
1fda210772dca9152ba331fb1457d3bc1bbafa61..8ee182542b1864cbba3add59a2350faec81af8ce  
100644
--- a/Documentation/common-macros.itexi
+++ b/Documentation/common-macros.itexi
@@ -77,6 +77,11 @@

 @c   ***** Headers *****

address@hidden For use as the Level 5 header
address@hidden subsubheadingitalic {TEXT}
address@hidden @i{\TEXT\}
address@hidden macro
+
 @ifclear snippets-sections
 @macro lydoctitle {TEXT}
 @need 600
Index: Documentation/contributor/doc-work.itexi
diff --git a/Documentation/contributor/doc-work.itexi  
b/Documentation/contributor/doc-work.itexi
index  
8695d340ee6bf025063629b37ebf1fbe372707a6..547aaf3c208274c3b6e2687b08458e489bed81e6  
100644
--- a/Documentation/contributor/doc-work.itexi
+++ b/Documentation/contributor/doc-work.itexi
@@ -221,15 +221,36 @@ how to modify the snippet files and SL, see @ref{LSR  
work}.
 @node Sectioning commands
 @subsection Sectioning commands

-Most of the manual operates at the
+The Notation Reference uses section headings at four, occasionally
+five, levels.
+
address@hidden
+
address@hidden Level 1: @@chapter
address@hidden Level 2: @@section
address@hidden Level 3: @@subsection
address@hidden Level 4: @@unnumberedsubsubsec
address@hidden Level 5: @@subsubheadingitalic
address@hidden itemize
+
+The first three levels are numbered in html, the last two are not.
+Numbered sections correspond to a single html page in the split html
+documents.
+
+The first four levels always have accompanying nodes so they can be
+referenced and are also included in the ToC in html.
+
+Most of the manual is written at level 4 under

 @example
 @@node Foo
-@@subsubsection Foo
+@@unnumberedsubsubsec Foo
 @end example

 @noindent
-level.  Sections are created with
+headings.
+
+Level 3 subsections are created with

 @example
 @@node Foo
@@ -263,11 +284,10 @@ match the node name exactly.
 No commas may be used in the node names.

 @item
-If a heading is desired without creating a @code{@@node}, please use
-the following:
+If a heading is desired without creating a @code{@@node}, please use:

 @example
-@@subheading Foo
+@@subsubheadingitalic Foo
 @end example

 @item
Index: Documentation/notation/pitches.itely
diff --git a/Documentation/notation/pitches.itely  
b/Documentation/notation/pitches.itely
index  
99e8e0932b0936ebab737cf19ded2cb4663f9d99..e4a8fd736e0cc451e0c02b3c2959df5199bfdfaa  
100644
--- a/Documentation/notation/pitches.itely
+++ b/Documentation/notation/pitches.itely
@@ -900,7 +900,7 @@ It may also be reversed to produce its  
@notation{retrograde}, see
 @warning{Any note that does not lie within the given scale will be
 left untransformed.}

address@hidden Modal transposition
address@hidden Modal transposition

 @cindex modal transposition
 @cindex transposition, modal
@@ -957,7 +957,7 @@ motif = \relative c' { c8 d e f g a b c }
 }
 @end lilypond

address@hidden Modal inversion
address@hidden Modal inversion

 @cindex modal inversion
 @cindex inversion, modal
Index: Documentation/notation/rhythms.itely
diff --git a/Documentation/notation/rhythms.itely  
b/Documentation/notation/rhythms.itely
index  
fc3af0d5efefc532b3cdd9ac5c20f7b1e5cdb290..46f9b8cff7000c0def7f2c454d7e323d219b7a38  
100644
--- a/Documentation/notation/rhythms.itely
+++ b/Documentation/notation/rhythms.itely
@@ -1560,7 +1560,7 @@ Explicitly create a @code{Voice} context when  
starting a piece with
 Polymetric notation is supported explicitly or by manually modifying the
 visible time signature symbol and/or scaling note durations.

address@hidden Different time signatures with equal-length measures
address@hidden Different time signatures with equal-length measures

 Set a common time signature for each staff, and set the
 @code{timeSignatureFraction} to the desired fraction.  Then use the
@@ -1602,7 +1602,7 @@ affect the autobeaming rules.
 >>
 @end lilypond

address@hidden Different time signatures with unequal-length measures
address@hidden Different time signatures with unequal-length measures

 Each staff can be given its own independent time signature by
 moving the @code{Timing_translator} and the
@@ -1650,7 +1650,7 @@ moving the @code{Timing_translator} and the
 @cindex compound time signatures
 @cindex time signature, compound

address@hidden Compound time signatures
address@hidden Compound time signatures

 These are created using the @code{\compoundMeter} function.  The syntax
 for this is:
@@ -2004,7 +2004,7 @@ by
 @end example


address@hidden @i{Beaming based on @code{baseMoment} and  
@code{beatStructure}}
address@hidden Beaming based on @code{baseMoment} and  
@code{beatStructure}

 In most instances, automatic beams will end at the end of a beat.
 The ending points for beats are determined by the context properties
@@ -2106,7 +2106,7 @@ By default @code{baseMoment} is set to one over the  
denominator of
 the time signature. Any exceptions to this default can be found in
 @file{scm/time-signature-settings.scm}.

address@hidden @i{Beaming based on @code{beamExceptions}}
address@hidden Beaming based on @code{beamExceptions}

 Special autobeaming rules (other than ending a beam on a beat)
 are defined in the @code{beamExceptions} property.
@@ -2219,7 +2219,7 @@ r4. a8 a a |
 r4. a8 a a |
 @end lilypond

address@hidden @i{How automatic beaming works}
address@hidden How automatic beaming works

 When automatic beaming is enabled, the placement of automatic beams
 is determined by the context properties