]> git.donarmstrong.com Git - lilypond.git/blobdiff - Documentation/user/lilypond.tely
*** empty log message ***
[lilypond.git] / Documentation / user / lilypond.tely
index 2c2d0dbf56446d3da1ae150ca8f05516548da2a7..5b4a769f9b2f696a27f67dfcff96927dfc82ae7b 100644 (file)
@@ -14,24 +14,34 @@ Distributions will want to install lilypond.info in postinstall, doing:
 
 @dircategory GNU music project
 @direntry
-@c  prepend GNU for dir, must be unique
-@c  do not list the `lilypond' node at toplevel, so that `info lilypond'
-@c  goes to Top.
+@ignore
+
+  * Prepend GNU for dir, must be unique.
+  
+  * Do not list the `lilypond' node at toplevel, so that `info lilypond'
+    goes to Top.
+
+  * List all commands in direntry.
+  
 @c  * lilypond: (lilypond/lilypond)Running LilyPond.      Invoking the
-@c  LilyPond  program.
-* GNU LilyPond: (lilypond/lilypond).           The GNU music typesetter.
+@c    LilyPond  program.
+  
+@end ignore
+
+* LilyPond: (lilypond/lilypond).           The GNU music typesetter.
+* abc2ly: (lilypond/lilypond)Invoking abc2ly.          Importing ABC.          
 * convert-ly: (lilypond/lilypond)Invoking convert-ly.  Older LilyPond versions.
-* midi2ly: (lilypond/lilypond)Invoking midi2ly.        Importing MIDI.
 * etf2ly: (lilypond/lilypond)Invoking etf2ly.          Importing Finale.
-* abc2ly: (lilypond/lilypond)Invoking abc2ly.          Importing ABC.          
-* musedata2ly: (lilypond/lilypond)Invoking musedata2ly.        Importing MuseData.
+* lilypond-book: (lilypond/lilypond)LilyPond-book.     Itegrating text and music.
+* midi2ly: (lilypond/lilypond)Invoking midi2ly.        Importing MIDI.
 * mup2ly: (lilypond/lilypond)Invoking mup2ly.          Importing Mup. 
+* musedata2ly: (lilypond/lilypond)Invoking musedata2ly.        Importing MuseData.
 @end direntry
 
 
 @ignore
 @omfcreator Han-Wen Nienhuys and Jan Nieuwenhuizen
-@omfdescription User manual  of the LilyPond music engraving system
+@omfdescription User manual of the LilyPond music engraving system
 @omftype user manual
 @omfcategory Applications|Publishing
 @omflanguage English
@@ -45,28 +55,36 @@ HINTS FOR STYLE
 
 * Do not forget to create @cindex entries for new sections of text.
 
-* Try not to use punctuation between introductocing sentence and
-display material (verbatim, music, example code).
+* Try not to use punctuation between an introductory sentence and
+  display material (music, example code).
 
 * Do not refer to LilyPond in the text.  The reader knows what the
-manual is about.
+  manual is about.  If you do, capitalization is LilyPond.
 
-* If you do, capitalization is LilyPond.
+* If you explicitly refer to `lilypond', the program (or any other
+  command to be executed), say `@command{lilypond}'.
 
 * Do not explicitly refer to the reader/user.  There is no one else
-besides the reader and the writer.
+  besides the reader and the writer.
 
-* Do not use abbreviations (don't, won't, etc.).
+* Do not use abbreviations (don't, won't, etc.).  If you do, use a
+  comma after it:
 
-* Avoid fluff (``Notice that,'' ``as you can see,'' ``Currently,'') 
+    blabla blabla, i.e., blabla blabla
+
+* Avoid fluff (``Notice that,'' ``as you can see,'' ``Currently,'').
+
+* The use of the word `illegal' is inappropriate in most cases.  Say
+  `invalid' instead.
 
 * Avoid long stretches of input code.  Noone is going to read them in
-print.  Instead refer to an example input file (@inputfileref), these
-are clickable in HTML.
+  print.  Instead refer to an example input file (@inputfileref), these
+  are clickable in HTML.
 
-* Abbrevs in caps, e.g. HTML, DVI, MIDI, etc.
+* Abbrevs in caps, e.g., HTML, DVI, MIDI, etc.
 
 * Colon usage
+
   0. Do not use a colon to introduce examples, sentences just continue
 
       in the display material.
@@ -76,6 +94,69 @@ are clickable in HTML.
      This usage is rarer.  Americans often just use a comma.
   3. When adding a defining example at the end of a sentence.
 
+* To produce good looking texinfo output (for both TTY and DVI) some
+  additional formatting rules should be followed.
+
+  . Do not use tabs.  They expand to nothing in DVI output.
+
+  . Do not use spaces at the beginning of a line (except in @example
+    or @verbatim environments), and do not use more than a single space
+    between words.  `makeinfo' copies the input lines verbatim without
+    removing those spaces.
+
+  . Variables or numbers which consist of a single character (probably
+    followed by a punctuation mark) should be tied properly, either to
+    the previous or the next word.  Example:
+
+      The variable@tie{}@var{a} ...
+
+  . To get consistent indentation in the DVI output it is better to avoid
+    the @verbatim environment.  Use the @example environment instead if
+    possible, but without extraneous indentation.  For example, this
+
+      @example
+        foo {
+          bar
+        }
+      @end example
+
+    should be replaced with
+
+      @example
+      foo {
+        bar
+      }
+      @end example
+
+    where `@example' starts the line (without leading spaces).
+
+  . Use the `quote' option in @lilypond commands if possible.
+
+  . Do not compress the input vertically; this is, do not use
+
+      Beginning of logical unit
+      @example
+      ...
+      @end example
+      continuation of logical unit
+
+    but
+
+      Beginning of logical unit
+
+      @example
+      ...
+      @end example
+
+      @noindent
+      continuation of logical unit
+
+    This makes it easier to not forget `@noindent'.
+
+  . Non-ASCII characters which are in latin-1 should be directly used;
+    this is, don't say `Ba@ss{}tuba' but `Baßtuba'.  This ensures that
+    all such characters appear in all output formats.
+
 @end ignore
 
 @ifhtml
@@ -103,7 +184,7 @@ PostScript} and @uref{../lilypond.pdf,PDF}.
 
 
 
-Copyright @copyright{} 1999--2004 by the authors
+Copyright @copyright{} 1999--2005 by the authors
 
   Permission is granted to copy, distribute and/or modify this document
   under the terms of the GNU Free Documentation License, Version 1.1
@@ -119,8 +200,8 @@ Copyright @copyright{} 1999--2004 by the authors
 @lilypond[raggedright]
 \score {
     \context Lyrics {
-        \override Score.RehearsalMark   #'self-alignment-X = #LEFT
-        \override Score.RehearsalMark   #'font-size = #-2 
+        \override Score.RehearsalMark #'self-alignment-X = #LEFT
+        \override Score.RehearsalMark #'font-size = #-2 
         \mark #(ly:export (string-append
              "(For LilyPond version " (lilypond-version) ")"))
         s2
@@ -138,7 +219,7 @@ Copyright @copyright{} 1999--2004 by the authors
 @ifnottex
 This file documents GNU LilyPond.
 
-Copyright 1999--2004 by the authors
+Copyright 1999--2005 by the authors
 
   Permission is granted to copy, distribute and/or modify this document
   under the terms of the GNU Free Documentation License, Version 1.1
@@ -155,7 +236,7 @@ Copyright 1999--2004 by the authors
 @top GNU LilyPond --- The music typesetter
 @c HJJ: Info needs `@top', which is a synonym for `@unnumbered' in TeX.
 
-This is the user manual for GNU LilyPond 2.3.x series.
+This is the user manual for GNU LilyPond 2.5.x series.
 @ifhtml
 (See the bottom of this page for the exact version number).
 @end ifhtml
@@ -172,22 +253,25 @@ of this and other documentation.
 * Preface::                        Preface.
 * Introduction::                   What, Why, How.
 * Tutorial::                       A tutorial introduction.
-* Example templates::              Larger examples
-* Notation manual::                All notation supported, and how to
-                                   produce it.
-* Sound::                          Producing MIDI output
+* Example templates::              Larger examples.
+* Basic notation::                 Standard musical notation.
+* Instrument-specific notation::   Notation that is only used for some
+                                   instruments.
+* Advanced notation::              Less frequently used notation.
+* Global issues::                  Non-notation commands.
+
 * Changing defaults::              Tuning output.
 * Interfaces for programmers::
-* Running LilyPond::              Operation.
+* Running LilyPond::               Operation.
 * Converting from other formats::  Converting to lilypond source format.
-* Integrating text and music::     Integrating text and music with lilypond-book.
+* LilyPond-book::                  Integrating text and music.
 * Literature list::
 * Scheme tutorial::
 * Notation manual details::
 * Point and click::             
-* Unified index::
 * GNU Free Documentation License:: FDL.
 * Cheat sheet::     
+* Unified index::
 @end menu
 @end ifnottex
 
@@ -200,8 +284,11 @@ of this and other documentation.
 @include tutorial.itely
 @include examples.itely
 @include invoking.itely
-@include notation.itely
-@include sound-output.itexi
+@include basic-notation.itely
+@include instrument-notation.itely
+@include advanced-notation.itely
+@include global.itely
+
 @include changing-defaults.itely
 @include programming-interface.itely
 @include lilypond-book.itely
@@ -215,14 +302,12 @@ of this and other documentation.
 @include scheme-tutorial.itely
 @include notation-appendices.itely
 @include point-and-click.itely
+@include cheatsheet.itely
+@include fdl.itexi
 
 @node Unified index
 @appendix Unified index
 
 @printindex cp
 
-@include fdl.itexi
-
-@include cheatsheet.itely
-
 @bye