X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=Documentation%2Fuser%2Flilypond.tely;h=5b4a769f9b2f696a27f67dfcff96927dfc82ae7b;hb=150ff905539154877da98ae5d59fcf8938dcda97;hp=b6821bda026d09222ec321376988dd2fb7e5028b;hpb=402045837e7134cdf90d1fcf31768c62227a4936;p=lilypond.git diff --git a/Documentation/user/lilypond.tely b/Documentation/user/lilypond.tely index b6821bda02..5b4a769f9b 100644 --- a/Documentation/user/lilypond.tely +++ b/Documentation/user/lilypond.tely @@ -1,5 +1,4 @@ -\version "2.1.22" -\input texinfo @c -*-texinfo-*- +\input texinfo @c -*- coding: latin-1; mode: texinfo; -*- @setfilename lilypond.info @settitle GNU LilyPond @iftex @@ -7,31 +6,42 @@ @end iftex @ignore -Distributions will want to install lilypond.info doing: +Distributions will want to install lilypond.info in postinstall, doing: - ./install-info --info-dir=/usr/share/info out/lilypond.info + install-info --info-dir=/usr/share/info out/lilypond.info @end ignore + @dircategory GNU music project @direntry -@c ;; prepend GNU for dir, must be unique -* GNU LilyPond: (lilypond). The GNU music typesetter. -* lilypond: (lilypond)Invoking lilypond:: Titling LilyPond scores. -* Glossary: (music-glossary). Glossary of music terms. -* convert-ly: (lilypond)Invoking convert-ly:: Older LilyPond versions. -* midi2ly: (lilypond)Invoking midi2ly:: Importing MIDI. -* etf2ly: (lilypond)Invoking etf2ly:: Importing Finale. -* abc2ly: (lilypond)Invoking abc2ly:: Importing ABC. -* pmx2ly: (lilypond)Invoking pmx2ly:: Importing PMX. -* musedata2ly: (lilypond)Invoking musedata2ly:: - Importing Musedata. -* mup2ly: (lilypond)Invoking mup2ly:: Importing MUP. +@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 + +* 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 @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 @@ -43,24 +53,109 @@ Distributions will want to install lilypond.info doing: HINTS FOR STYLE -* don't refer to LilyPond in the text. The reader knows what the -manual is about +* Do not forget to create @cindex entries for new sections of text. + +* 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. 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. + +* Do not use abbreviations (don't, won't, etc.). If you do, use a + comma after it: + + 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. + +* 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: -* if you do, capitalization is LilyPond. + 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 -* don't explicitly refer to the reader/user. There is no one else -besides the reader and the writer. + @example + foo { + bar + } + @end example -* don't use abbreviations (don't, won't, etc.) + should be replaced with -* avoid fluff (``Notice that,'' ``as you can see,'' ``Currently,'') + @example + foo { + bar + } + @end example -* avoid long stretches of input code. Noone is go to read them in -print. Instead refer to an example input file (@inputfileref), these -are clickable in HTML. + where `@example' starts the line (without leading spaces). -* abbrevs in caps, e.g. HTML, DVI, MIDI, etc. + . 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 @@ -70,17 +165,26 @@ PostScript} and @uref{../lilypond.pdf,PDF}. @end ifhtml +@documentlanguage en +@documentencoding ISO-8859-1 + +@syncodeindex fn cp +@syncodeindex ky cp +@syncodeindex pg cp +@syncodeindex tp cp +@syncodeindex vr cp + + +@finalout + @titlepage @title GNU LilyPond @subtitle The music typesetter -@author Han-Wen Nienhuys -@author Jan Nieuwenhuizen -@author J@"{u}rgen Reuter -@author Rune Zedeler +@author The LilyPond development team -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 @@ -91,22 +195,23 @@ Copyright @copyright{} 1999--2004 by the authors @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 \notes { - \override Score.RehearsalMark #'self-alignment-X = #LEFT + \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 } - \paper { + \layout { indent = 0.0\pt raggedright = ##t } } @end lilypond - @end titlepage @@ -114,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 @@ -128,17 +233,19 @@ Copyright 1999--2004 by the authors @ifnottex @node Top -@top +@top GNU LilyPond --- The music typesetter +@c HJJ: Info needs `@top', which is a synonym for `@unnumbered' in TeX. -@chapter GNU LilyPond --- The music typesetter - -This is the user manual for GNU LilyPond 2.1.0. +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 @cindex web site 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. +@uref{http://@/www@/.lilypond@/.org/}. The website contains on-line copies +of this and other documentation. @include dedication.itely @@ -146,17 +253,25 @@ this and other documentation. * Preface:: Preface. * Introduction:: What, Why, How. * Tutorial:: A tutorial introduction. -* Notation manual:: All notation supported, and how to - produce it. -* Literature list:: Books about notation and engraving. -* Technical manual:: How it all works. -* Invoking LilyPond:: Operation. +* 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. * Converting from other formats:: Converting to lilypond source format. -* lilypond-book manual:: Integrating text and music with lilypond-book. -* Unified index:: -* Reference manual details:: -* Cheat sheet:: +* LilyPond-book:: Integrating text and music. +* Literature list:: +* Scheme tutorial:: +* Notation manual details:: +* Point and click:: * GNU Free Documentation License:: FDL. +* Cheat sheet:: +* Unified index:: @end menu @end ifnottex @@ -167,22 +282,32 @@ this and other documentation. @include preface.itely @include introduction.itely @include tutorial.itely -@include refman.itely -@include literature.itely -@include internals.itely -@include invoking.itexi +@include examples.itely +@include invoking.itely +@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 @include converters.itely @c FIXME: Index has two alphabetically sorted lists @code vs plain? -@node Unified index -@unnumbered Unified index -@printindex cp -@include appendices.itely +@include literature.itely +@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 + @bye