X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=Documentation%2Fuser%2Flilypond.tely;h=e7d66c74300cef602f9226fcaac2c265019c4f5d;hb=4bee689d7993ecf9af95d33c7f8f4ecd8d74a3cc;hp=c6b0c58d39597e239cff5a80a5bc93d7a5ea183a;hpb=de658c9789658317b265eb7f3fd34a87c7a8f953;p=lilypond.git diff --git a/Documentation/user/lilypond.tely b/Documentation/user/lilypond.tely index c6b0c58d39..e7d66c7430 100644 --- a/Documentation/user/lilypond.tely +++ b/Documentation/user/lilypond.tely @@ -1,56 +1,200 @@ -\input texinfo @c -*-texinfo-*- +\input texinfo @c -*- coding: utf-8; mode: texinfo; -*- @setfilename lilypond.info @settitle GNU LilyPond +@iftex +@afourpaper +@end iftex -@html - -@end html +@dircategory GNU music project +@direntry @ignore -Distributions will want to install lilypond.info doing: +(I think) +Current version of the manual: 2.6.0 +Please update this whenever you run convert-ly on the docs. + +convert-ly --from=... --to=... --no-version *.itely + +%%%%% + +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 +%%%%% + + * 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 -@dircategory GNU music project -@direntry -@c ;; prepend GNU for dir, must be unique -* GNU LilyPond: (lilypond). The GNU music typesetter. -* ly2dvi: (lilypond)Invoking ly2dvi:: 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. + +* 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 Music +@omfcategory Applications|Publishing +@omflanguage English @end ignore +@c don't remove this comment. + +@ignore + +HINTS FOR STYLE + +* 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 above three suggestions refer to the formal Notation Manual + (chapters 5 and up). In the Tutorial, Example templates, and + Putting it all together, you may write more colloquially + +* 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). + + . 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 utf-8 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 -This document is also available in @uref{../lilypond.ps.gz,gzipped -PostScript} and @uref{../lilypond.pdf,PDF}. +This document is also available in @uref{source/Documentation/user/out-www/lilypond.pdf,PDF}. @end ifhtml +@documentlanguage en +@documentencoding utf-8 + +@syncodeindex fn cp +@syncodeindex ky cp +@syncodeindex pg cp +@syncodeindex tp cp +@syncodeindex vr cp + + +@finalout + @titlepage -@title GNU LilyPond +@title LilyPond @subtitle The music typesetter -@author +@author The LilyPond development team -Copyright @copyright{} 1999--2002 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 @@ -59,15 +203,33 @@ Copyright @copyright{} 1999--2002 by the authors 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 -@c Han-Wen Nienhuys, Jan Nieuwenhuizen, Adrian Mariano, Tom Cato Amundsen. @ifnottex This file documents GNU LilyPond. -Copyright 1999-2002 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 @@ -81,59 +243,84 @@ Copyright 1999-2002 by the authors @ifnottex @node Top -@top - -@chapter GNU LilyPond --- The music typesetter +@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 1.7.14. +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. +@uref{http://@/www@/.lilypond@/.org/}. The website contains on-line copies +of this and other documentation. -@mbinclude dedication.itely +@include dedication.itely @menu * Preface:: Preface. * Introduction:: What, Why, How. -* Tutorial:: A tutorial introduction to LilyPond. -* Reference Manual:: Reference Manual. -* Advanced Topics:: How it all works. -* Invoking LilyPond:: Operation. +* 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. -* Integrating text and music with lilypond-book:: - The lilypond-book manual. -* Literature:: Additional reading material. -* Index:: Unified index. -* Refman appendix:: +* 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 macros.itexi -@mbinclude preface.itely -@mbinclude introduction.itely -@mbinclude tutorial.itely -@mbinclude refman.itely -@mbinclude internals.itely -@mbinclude invoking.itexi -@mbinclude lilypond-book.itely -@mbinclude converters.itely -@mbinclude literature.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 programming-interface.itely +@include lilypond-book.itely +@include converters.itely @c FIXME: Index has two alphabetically sorted lists @code vs plain? -@node Index -@unnumbered Index -@printindex cp -@mbinclude appendices.itely -@mbinclude fdl.itexi +@include literature.itely +@include scheme-tutorial.itely +@include notation-appendices.itely +@include point-and-click.itely +@include cheatsheet.itely +@include fdl.itexi + +@node LilyPond index +@appendix LilyPond index + +@printindex cp @bye