]> git.donarmstrong.com Git - lilypond.git/commitdiff
Policy updates.
authorGraham Percival <graham@percival-music.ca>
Sat, 29 Mar 2008 15:02:01 +0000 (08:02 -0700)
committerGraham Percival <graham@percival-music.ca>
Sat, 29 Mar 2008 15:02:01 +0000 (08:02 -0700)
Documentation/user/editorial.itely
Documentation/user/macros.itexi
Documentation/user/pitches.itely
Documentation/user/policy.txt

index f665c31066136890f7ce56b0c1b3e83339e179d1..43d4b8ad3db0e5a779d141a690e42480d8c03a21 100644 (file)
@@ -36,7 +36,7 @@ inside the staff.
 @end menu
 
 @node Selecting notation font size
-@subsubsection Selecting notation font size
+@unnumberedsubsubsec Selecting notation font size
 
 @cindex font size
 @cindex font size, selecting
@@ -110,13 +110,15 @@ that use fonts.  These are the ones supporting the
 
 @seealso
 
-Snippets: @lsrdir{Editorial,Editorial-annotations}.
+Snippets:
+@lsrdir{Editorial,Editorial-annotations}.
 
-Internals Reference: @internalsref{font-interface}.
+Internals Reference:
+@internalsref{font-interface}.
 
 
 @node Fingering instructions
-@subsubsection Fingering instructions
+@unnumberedsubsubsec Fingering instructions
 
 @cindex fingering
 @cindex finger change
@@ -164,15 +166,18 @@ staff, see @ref{Controlling direction and placement}.
 
 @seealso
 
-Notation Reference: @ref{Controlling direction and placement}
+Notation Reference:
+@ref{Controlling direction and placement}
 
-Snippets: @lsrdir{Editorial,Editorial-annotations}.
+Snippets:
+@lsrdir{Editorial,Editorial-annotations}.
 
-Internals Reference: @internalsref{Fingering}.
+Internals Reference:
+@internalsref{Fingering}.
 
 
 @node Hidden notes
-@subsubsection Hidden notes
+@unnumberedsubsubsec Hidden notes
 
 @cindex Hidden notes
 @cindex Invisible notes
@@ -201,11 +206,12 @@ c
 
 @seealso
 
-Snippets: @lsrdir{Editorial,Editorial-annotations}.
+Snippets:
+@lsrdir{Editorial,Editorial-annotations}.
 
 
 @node Coloring objects
-@subsubsection Coloring objects
+@unnumberedsubsubsec Coloring objects
 
 @cindex colored objects
 @cindex colors
@@ -277,10 +283,12 @@ gis4 a
 
 @seealso
 
-Notation Reference: @ref{List of colors}, @ref{Objects connected to
+Notation Reference:
+@ref{List of colors}, @ref{Objects connected to
 the input}.
 
-Snippets: @lsrdir{Editorial,Editorial-annotations}.
+Snippets:
+@lsrdir{Editorial,Editorial-annotations}.
 
 @knownissues
 An x11 color is not necessarily exactly the same shade as a
@@ -296,7 +304,7 @@ Notes in a chord cannot be colored with @code{\override}; use
 
 
 @node Parentheses
-@subsubsection Parentheses
+@unnumberedsubsubsec Parentheses
 
 @cindex ghost notes
 @cindex notes, ghost
@@ -320,7 +328,8 @@ Non-note objects may be parenthesized as well.
 
 @seealso
 
-Snippets: @lsrdir{Editorial,Editorial-annotations}.
+Snippets:
+@lsrdir{Editorial,Editorial-annotations}.
 
 @knownissues
 
@@ -328,7 +337,7 @@ Rests cannot be parenthesized.
 
 
 @node Stems
-@subsubsection Stems
+@unnumberedsubsubsec Stems
 
 @cindex stem
 
@@ -357,9 +366,11 @@ made invisible.
 {default-direction-of-stems-on-the-center-line-of-the-staff.ly}
 
 @seealso
-Notation Reference: @ref{Controlling direction and placement}.
+Notation Reference:
+@ref{Controlling direction and placement}.
 
-Snippets: @lsrdir{Editorial,Editorial-annotations}.
+Snippets:
+@lsrdir{Editorial,Editorial-annotations}.
 
 
 @node Outside the staff
@@ -375,7 +386,7 @@ from outside of the staff.
 @end menu
 
 @node Balloon help
-@subsubsection Balloon help
+@unnumberedsubsubsec Balloon help
 
 Elements of notation can be marked and named with the help of a
 square balloon.  The primary purpose of this feature is to explain
@@ -402,13 +413,15 @@ typically within chords, to attach text to an individual note.
 
 @seealso
 
-Snippets: @lsrdir{Editorial,Editorial-annotations}.
+Snippets:
+@lsrdir{Editorial,Editorial-annotations}.
 
-Internals Reference: @internalsref{text-balloon-interface}.
+Internals Reference:
+@internalsref{text-balloon-interface}.
 
 
 @node Grid lines
-@subsubsection Grid lines
+@unnumberedsubsubsec Grid lines
 
 Vertical lines can be drawn between staves synchronized with the
 notes.
@@ -456,13 +469,14 @@ notes.
 
 @seealso
 
-Snippets: @lsrdir{Editorial,Editorial-annotations}.
+Snippets:
+@lsrdir{Editorial,Editorial-annotations}.
 
 
 
 
 @node Analysis brackets
-@subsubsection Analysis brackets
+@unnumberedsubsubsec Analysis brackets
 
 @cindex brackets
 @cindex phrasing brackets
@@ -502,8 +516,11 @@ Analysis brackets may be nested.
 
 @seealso
 
-Snippets: @lsrdir{Editorial,Editorial-annotations}.
+Snippets:
+@lsrdir{Editorial,Editorial-annotations}.
 
-Internals Reference: @internalsref{HorizontalBracket},
-@internalsref{Horizontal_bracket_engraver}, @internalsref{Staff}.
+Internals Reference:
+@internalsref{HorizontalBracket},
+@internalsref{Horizontal_bracket_engraver},
+@internalsref{Staff}.
 
index 55eacec0e36db12f3cffb73aaac25a8afdf52366..ede80d4389486d595df03456d1aeb61c15e253ef 100644 (file)
@@ -8,7 +8,7 @@
 
 @c @value{version}
 @macro version
-2.11.41
+2.11.43
 @end macro
 
 @c   ***** Displaying text *****
index 55e99d76d46cf4f766c9866b5a6f415c9dd6816a..7288e8d620434d27d8cf6f93dc28d9b31103e1b1 100644 (file)
@@ -50,7 +50,7 @@ A pitch name is specified using lowercase letters@tie{}@code{a}
 through@tie{}@code{g}.  The note names @code{c} to @code{b} are
 engraved in the octave below middle C.
 
-@c NOTE: don't use c' here.
+@c don't use c' here.
 @lilypond[verbatim,quote,ragged-right,fragment]
 \clef bass
 c d e f
@@ -77,9 +77,11 @@ d,, d, d c
 
 @seealso
 
-Music Glossary: @rglos{Pitch names}.
+Music Glossary:
+@rglos{Pitch names}.
 
-Snippets: @lsrdir{Pitches,Pitches}.
+Snippets:
+@lsrdir{Pitches,Pitches}.
 
 
 @node Relative octave entry
@@ -195,11 +197,16 @@ that each interval contains.
 
 @seealso
 
-Music Glossary: @rglos{fifth}, @rglos{interval}, @rglos{Pitch names}.
+Music Glossary:
+@rglos{fifth},
+@rglos{interval},
+@rglos{Pitch names}.
 
-Notation Reference: @ref{Octave checks}.
+Notation Reference:
+@ref{Octave checks}.
 
-Snippets: @lsrdir{Pitches,Pitches}.
+Snippets:
+@lsrdir{Pitches,Pitches}.
 
 
 @funindex \transpose
@@ -213,7 +220,7 @@ The relative conversion will not affect @code{\transpose},
 To use relative mode within transposed music, an additional
 @code{\relative} must be placed inside @code{\transpose}.
 
-@c NOTE: DEPRECATED
+@c DEPRECATED
 If no @var{startpitch} is specified for @code{\relative},
 then@tie{}@code{c'} is assumed.  However, this is a deprecated
 option and may disappear in future versions, so its use is
@@ -315,16 +322,24 @@ cis
 
 @seealso
 
-Music Glossary: @rglos{sharp}, @rglos{flat}, @rglos{double sharp},
-@rglos{double flat}, @rglos{Pitch names}, @rglos{quarter-tone}.
+Music Glossary:
+@rglos{sharp},
+@rglos{flat},
+@rglos{double sharp},
+@rglos{double flat},
+@rglos{Pitch names},
+@rglos{quarter-tone}.
 
-Learning Manual: @rlearning{Accidentals and key signatures}.
+Learning Manual:
+@rlearning{Accidentals and key signatures}.
 
-Notation Reference: @ref{Automatic accidentals},
+Notation Reference:
+@ref{Automatic accidentals},
 @ref{Musica ficta accidentals},
 @ref{Note names in other languages}.
 
-Snippets: @lsrdir{Pitches,Pitches}.
+Snippets:
+@lsrdir{Pitches,Pitches}.
 
 
 @knownissues
@@ -436,9 +451,11 @@ languages, no special names have been defined yet.
 
 @seealso
 
-Music Glossary: @rglos{Pitch names}.
+Music Glossary:
+@rglos{Pitch names}.
 
-Snippets: @lsrdir{Pitches,Pitches}.
+Snippets:
+@lsrdir{Pitches,Pitches}.
 
 
 @node Changing multiple pitches
@@ -513,7 +530,8 @@ check fail, but the second one does not fail.
 
 @seealso
 
-Snippets: @lsrdir{Pitches,Pitches}.
+Snippets:
+@lsrdir{Pitches,Pitches}.
 
 
 @node Transpose
@@ -622,11 +640,14 @@ see @ref{Instrument transpositions}.
 
 @seealso
 
-Notation Reference: @ref{Instrument transpositions}.
+Notation Reference:
+@ref{Instrument transpositions}.
 
-Snippets: @lsrdir{Pitches,Pitches}.
+Snippets:
+@lsrdir{Pitches,Pitches}.
 
-Internals Reference: @internalsref{TransposedMusic}.
+Internals Reference:
+@internalsref{TransposedMusic}.
 
 @funindex \transpose
 @funindex \chordmode
@@ -759,11 +780,14 @@ c2 c
 
 @seealso
 
-Notation Reference: @ref{Ancient clefs}.
+Notation Reference:
+@ref{Ancient clefs}.
 
-Snippets: @lsrdir{Pitches,Pitches}.
+Snippets:
+@lsrdir{Pitches,Pitches}.
 
-Internals Reference: @internalsref{Clef}.
+Internals Reference:
+@internalsref{Clef}.
 
 
 @node Key signature
@@ -803,7 +827,7 @@ is done with the @code{\key} command:
 Here, @var{mode} should be @code{\major} or @code{\minor} to get a
 key signature of @var{pitch}-major or @var{pitch}-minor,
 respectively.  You may also use the standard mode names, also
-called @q{church modes}: @code{\ionian}, @code{\dorian},
+called @notation{church modes}: @code{\ionian}, @code{\dorian},
 @code{\phrygian}, @code{\lydian}, @code{\mixolydian},
 @code{\aeolian}, and @code{\locrian}.
 
@@ -826,13 +850,18 @@ fis
 
 @seealso
 
-Music Glossary: @rglos{church mode}, @rglos{scordatura}.
+Music Glossary:
+@rglos{church mode},
+@rglos{scordatura}.
 
-Learning Manual: @rlearning{Accidentals and key signatures}.
+Learning Manual:
+@rlearning{Accidentals and key signatures}.
 
-Snippets: @lsrdir{Pitches,Pitches}.
+Snippets:
+@lsrdir{Pitches,Pitches}.
 
-Internals Reference: @internalsref{KeyCancellation},
+Internals Reference:
+@internalsref{KeyCancellation},
 @internalsref{KeySignature}, @internalsref{Key_engraver}.
 
 
@@ -868,11 +897,14 @@ The @code{set-octavation} function also takes -1 (for 8va bassa),
 
 @seealso
 
-Music Glossary: @rglos{octavation}.
+Music Glossary:
+@rglos{octavation}.
 
-Snippets: @lsrdir{Pitches,Pitches}.
+Snippets:
+@lsrdir{Pitches,Pitches}.
 
-Internals Reference: @internalsref{OttavaBracket}.
+Internals Reference:
+@internalsref{OttavaBracket}.
 
 
 
@@ -958,11 +990,15 @@ c2 g
 
 @seealso
 
-Music Glossary: @rglos{concert pitch}, @rglos{transposing instrument}.
+Music Glossary:
+@rglos{concert pitch},
+@rglos{transposing instrument}.
 
-Notation Reference: @ref{Quoting other voices}, @ref{Transpose}.
+Notation Reference:
+@ref{Quoting other voices}, @ref{Transpose}.
 
-Snippets: @lsrdir{Pitches,Pitches}.
+Snippets:
+@lsrdir{Pitches,Pitches}.
 
 
 @node Automatic accidentals
@@ -1068,7 +1104,7 @@ both staves.
 @end example
 
 
-@c NOTE: don't use verbatim in this table.
+@c don't use verbatim in this table.
 @table @code
 @item default
 This is the default typesetting behavior.  It corresponds to
@@ -1668,9 +1704,11 @@ musicB = {
 
 @seealso
 
-Snippets: @lsrdir{Pitches,Pitches}.
+Snippets:
+@lsrdir{Pitches,Pitches}.
 
-Internals Reference: @internalsref{Accidental_engraver},
+Internals Reference:
+@internalsref{Accidental_engraver},
 @internalsref{Accidental}, @internalsref{AccidentalSuggestion},
 @internalsref{AccidentalPlacement}, @internalsref{GrandStaff} and
 @internalsref{PianoStaff}, @internalsref{Staff}.
@@ -1736,11 +1774,14 @@ printed if they are not part of the key signature.
 
 @seealso
 
-Music Glossary: @rglos{ambitus}.
+Music Glossary:
+@rglos{ambitus}.
 
-Snippets: @lsrdir{Pitches,Pitches}.
+Snippets:
+@lsrdir{Pitches,Pitches}.
 
-Internals Reference: @internalsref{Ambitus},
+Internals Reference:
+@internalsref{Ambitus},
 @internalsref{AmbitusLine}, @internalsref{AmbitusNoteHead},
 @internalsref{AmbitusAccidental}, @internalsref{Ambitus_engraver},
 @internalsref{Staff}, @internalsref{Voice}.
@@ -1801,11 +1842,14 @@ To see all note head styles, see @ref{Note head styles}.
 
 @seealso
 
-Snippets: @lsrdir{Pitches,Pitches}.
+Snippets:
+@lsrdir{Pitches,Pitches}.
 
-Notation Reference: @ref{Note head styles}.
+Notation Reference:
+@ref{Note head styles}.
 
-Internals Reference: @internalsref{NoteHead},
+Internals Reference:
+@internalsref{NoteHead},
 @internalsref{LedgerLineSpanner}.
 
 
@@ -1849,11 +1893,14 @@ staff size}.
 
 @seealso
 
-Notation Reference: @ref{Setting the staff size}.
+Notation Reference:
+@ref{Setting the staff size}.
 
-Snippets: @lsrdir{Pitches,Pitches},
+Snippets:
+@lsrdir{Pitches,Pitches},
 
-Internals Reference: @internalsref{NoteHead}.
+Internals Reference:
+@internalsref{NoteHead}.
 
 
 @node Shape note heads
@@ -1897,9 +1944,11 @@ To see all note head styles, see @ref{Note head styles}.
 
 @seealso
 
-Snippets: @lsrdir{Pitches,Pitches}.
+Snippets:
+@lsrdir{Pitches,Pitches}.
 
-Notation Reference: @ref{Note head styles}.
+Notation Reference:
+@ref{Note head styles}.
 
 
 @node Improvisation
@@ -1938,9 +1987,11 @@ rhythm.  Such note heads can be created:
 
 @seealso
 
-Snippets: @lsrdir{Pitches,Pitches}.
+Snippets:
+@lsrdir{Pitches,Pitches}.
 
-Internals Reference: @internalsref{Pitch_squash_engraver},
+Internals Reference:
+@internalsref{Pitch_squash_engraver},
 @internalsref{Voice}.
 
 
index e259f39135c2b4fcc7e246c7c12c5c9298f7ac04..4dac1c28f5fdd89f1752dbda586cb458f205792d 100644 (file)
@@ -88,22 +88,40 @@ main docs
 * You _must_ include a @seealso.  The order of items inside the
   @seealso section is
 
-    Music Glossary: @rglos{foo}, @rglos{bar}.
+    Music Glossary:
+    @rglos{foo},
+    @rglos{bar}.
 
-    Learning Manual: @rlearning{baz}, @rlearning{foozle}
+    Learning Manual:
+    @rlearning{baz},
+    @rlearning{foozle}
 
-    Notation Reference: @ruser{faazle}, @ruser{boo}.
+    Notation Reference:
+    @ruser{faazle},
+    @ruser{boo}.
 
-    Application Usage: @rprogram{blah}.
+    Application Usage:
+    @rprogram{blah}.
 
-    Installed Files: @file{path/to/dir/blahz}.
+    Installed Files:
+    @file{path/to/dir/blahz}.
 
-    Snippets: @lsrdir{section}, @lsr{specific/example-name.ly}.
-      (if there is only one entry, omit a final period.  If there
-       are multiple entries, separate them by commas, do not
-       include an `and', and end with a period.)
+    Snippets:
+    @lsrdir{section},
+    @lsr{specific/example-name.ly}.
 
-    Internals Reference: @internalsref{fazzle}, @internalsref{booar}.
+    Internals Reference:
+    @internalsref{fazzle},
+    @internalsref{booar}.
+
+      If there are multiple entries, separate them by commas
+      but do not include an `and'.
+
+      Always end with a period.
+
+      Place each link on a new line as above; this makes it much
+      easier to add or remove links.  In the output, they
+      appear on a single line.
 
   ("Snippets" is REQUIRED; the others are optional)