]> git.donarmstrong.com Git - lilypond.git/blobdiff - Documentation/user/lilypond.tely
Renaming chapter, rearranging.
[lilypond.git] / Documentation / user / lilypond.tely
index d988d771646410809a9a62f1ccf4a20642ff9912..4eac0037e5b61ab3f1d7a5aa2bbac9a24681363b 100644 (file)
-\input texinfo @c -*-texinfo-*-
+\input texinfo @c -*- coding: latin-1; mode: texinfo; -*-
 @setfilename lilypond.info
 @settitle GNU LilyPond
+@iftex
+@afourpaper
+@end iftex
 
+@ignore
+Distributions will want to install lilypond.info in postinstall, doing:
 
+    install-info --info-dir=/usr/share/info out/lilypond.info
+    
+@end ignore
 
-@titlepage
-@title GNU LilyPond
-@subtitle The music typesetter
-@author Han-Wen Nienhuys, Jan Nieuwenhuizen and Adrian Mariano
+@dircategory GNU music project
+@direntry
+@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.
+  
+@end ignore
 
-     Copyright @copyright{} 1999 by the authors
+* LilyPond: (lilypond/lilypond).           The GNU music typesetter.
+* abc2ly: (lilypond/lilypond)Invoking abc2ly.          Importing ABC.          
+* convert-ly: (lilypond/lilypond)Invoking convert-ly.  Older LilyPond versions.
+* etf2ly: (lilypond/lilypond)Invoking etf2ly.          Importing Finale.
+* 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
 
-@vskip 0pt plus 1filll
 
-Permission is granted to make and distribute verbatim
-copies of this manual provided the copyright notice and
-this permission notice are preserved on all copies.
+@ignore
+@omfcreator Han-Wen Nienhuys and Jan Nieuwenhuizen
+@omfdescription User manual of the LilyPond music engraving system
+@omftype user manual
+@omfcategory Applications|Publishing
+@omflanguage English
+@end ignore
 
-Permission is granted to copy and distribute modified
-versions of this manual under the conditions for
-verbatim copying, provided also that the sections
-entitled ``Copying'' and ``GNU General Public License''
-are included exactly as in the original, and provided
-that the entire resulting derived work is distributed
-under the terms of a permission notice identical to this
-one.
+@c don't remove this comment.
 
-Permission is granted to copy and distribute
-translations of this manual into another language,
-under the above conditions for modified versions,
-except that this permission notice may be stated in a
-translation approved by the Free Software Foundation.
+@ignore
 
-@end titlepage
+HINTS FOR STYLE
 
-@ifinfo
-This file documents GNU LilyPond.
+* Do not forget to create @cindex entries for new sections of text.
 
-Copyright 1999 Han-Wen Nienhuys, Jan Nieuwenhuizen and Adrian Mariano
+* Try not to use punctuation between an introductory sentence and
+  display material (music, example code).
 
-Permission is granted to make and distribute verbatim
-copies of this manual provided the copyright notice and
-this permission notice are preserved on all copies.
+* Do not refer to LilyPond in the text.  The reader knows what the
+  manual is about.  If you do, capitalization is LilyPond.
 
-@ignore
-Permission is granted to process this file through TeX
-and print the results, provided the printed document
-carries a copying permission notice identical to this
-one except for the removal of this paragraph (this
-paragraph not being relevant to the printed manual).
+* If you explicitly refer to `lilypond', the program (or any other
+  command to be executed), say `@command{lilypond}'.
 
-@end ignore
+* Do not explicitly refer to the reader/user.  There is no one else
+  besides the reader and the writer.
 
-Permission is granted to copy and distribute modified
-versions of this manual under the conditions for
-verbatim copying, provided also that the sections
-entitled ``Copying'' and ``GNU General Public License''
-are included exactly as in the original, and provided
-that the entire resulting derived work is distributed
-under the terms of a permission notice identical to this
-one.
+* Do not use abbreviations (don't, won't, etc.).  If you do, use a
+  comma after it:
 
-Permission is granted to copy and distribute
-translations of this manual into another language,
-under the above conditions for modified versions,
-except that this permission notice may be stated in a
-translation approved by the Free Software Foundation.
+    blabla blabla, i.e., blabla blabla
 
-@end ifinfo
+* Avoid fluff (``Notice that,'' ``as you can see,'' ``Currently,'').
 
-@ignore
-Should add disclaimer, abstract
+* 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.
+
+* 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.
+
+  1. To introduce lists
+  2. When beginning a quote: "So, he said,..."
+     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).
 
-"GNU LilyPond has no connection with the music package Rosegarden, other
-than the names being similar :-)"
+  . 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
 
-@node Top, , , (dir)
-@chapter GNU LilyPond --- The music typesetter
+@ifhtml
+This document is also available in @uref{source/Documentation/user/out-www/lilypond.pdf,PDF}.
+@end ifhtml
 
-@contents
 
-@menu
-* Tutorial::                       A tutorial introduction to lilypond.
-* Invoking LilyPond::              Operation.
-* Reporting Bugs::                 Where to report bugs.
-* Reference Manual::               Reference Manual.
-@c Move to Reference Manual?
-* Internals:(lilypond-internals).  Auto generated detailed documentation.
-* More information::               Where to turn to for more help.
-* convert-mudela::                 Upgrading input files.
-@c Hmm, having the generated doco in a separate file,
-@c the index can't refer to that.
-* Index::                          Unified index.
-@end menu
+@documentlanguage en
+@documentencoding ISO-8859-1
+
+@syncodeindex fn cp
+@syncodeindex ky cp
+@syncodeindex pg cp
+@syncodeindex tp cp
+@syncodeindex vr cp
 
-@macro keyindex {word}
-@cindex \word\
 
-@end macro
+@finalout
 
-@macro indexcode {word}
-@cindex \word\
+@titlepage
+@title LilyPond
+@subtitle The music typesetter
+@author The LilyPond development team
+
+
+
+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
+  or any later version published by the Free Software Foundation;
+  with no Invariant Sections.
+  A copy of the license is included in the section entitled ``GNU
+  Free Documentation License''.
+
+@vskip 20pt
+
+@c Not yet debugged or reported.  This crashes gs-8.01:
+@c compiling gs-8.01 right now... -- jcn
+@lilypond[raggedright]
+\score {
+    \context Lyrics {
+        \override Score.RehearsalMark #'self-alignment-X = #LEFT
+        \override Score.RehearsalMark #'font-size = #-2 
+        \mark #(ly:export (string-append
+             "(For LilyPond version " (lilypond-version) ")"))
+        s2
+     }
+     \layout {
+         indent = 0.0\pt
+         raggedright = ##t
+     }
+}
+@end lilypond
+
+@end titlepage
 
-@end macro
 
+@ifnottex
+This file documents GNU LilyPond.
+
+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
+  or any later version published by the Free Software Foundation;
+  with no Invariant Sections.
+  A copy of the license is included in the section entitled ``GNU
+  Free Documentation License''.
+
+@end ifnottex
+
+
+@ifnottex
+@node Top
+@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.6.x series.
+@ifhtml
+(See the bottom of this page for the exact version number).
+@end ifhtml
+
+@cindex web site
+@cindex URL
+
+A further source of information is the website, which can be found at
+@uref{http://@/www@/.lilypond@/.org/}.  The website contains on-line copies
+of this and other documentation.
+
+@include dedication.itely
+
+@menu
+* Preface::                        Preface.
+* Introduction::                   What, Why, How.
+* Tutorial::                       A tutorial introduction.
+* Example templates::              Larger examples.
+* Putting it all together::        Demonstrates real-life LilyPond usage.
+* Running LilyPond::               Operation.
+* Basic notation::                 Standard musical notation.
+* Instrument-specific notation::   Notation that is only used for some
+                                   instruments.
+* Advanced notation::              Less frequently used notation.
+* Changing defaults::              Tuning output.
+* Output formats::                 What LilyPond produces.
+
+* Interfaces for programmers::
+* LilyPond-book::                  Integrating text and music.
+* Converting from other formats::  Converting to lilypond source format.
+* Literature list::
+* Scheme tutorial::
+* Notation manual details::
+* Point and click::             
+* Cheat sheet::     
+* GNU Free Documentation License:: FDL.
+* LilyPond index::
+@end menu
+@end ifnottex
+
+@contents
 
-@mbinclude tutorial.itely
 
+@include macros.itexi
+@include preface.itely
+@include introduction.itely 
+@include tutorial.itely
+@include examples.itely
+@include putting.itely
+@include invoking.itely
+@include basic-notation.itely
+@include instrument-notation.itely
+@include advanced-notation.itely
+@include changing-defaults.itely
+@include global.itely
 
-@include invoking.itexi
+@include programming-interface.itely
+@include lilypond-book.itely
+@include converters.itely
 
-@include bugs.itexi
 
-@mbinclude refman.itely
+@c FIXME: Index has two alphabetically sorted lists @code vs plain?
 
-@include moreinfo.itexi
 
-@include convert-mudela.itexi
+@include literature.itely
+@include scheme-tutorial.itely
+@include notation-appendices.itely
+@include point-and-click.itely
+@include cheatsheet.itely
+@include fdl.itexi
 
-@node Index, , , Top
-@unnumbered Index
+@node LilyPond index
+@appendix LilyPond index
 
 @printindex cp