X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=Documentation%2Fuser%2Flilypond.tely;h=62045348ba3f6c7b203d5455f80479232711bad0;hb=ece2e45d587f63565e81af44e1937ebe1f5e47a8;hp=b6ce0497da180c44a4be9712de568802ec9821c1;hpb=049a7731eb43f3a214ed3c370b7e09ca411da5ef;p=lilypond.git diff --git a/Documentation/user/lilypond.tely b/Documentation/user/lilypond.tely index b6ce0497da..62045348ba 100644 --- a/Documentation/user/lilypond.tely +++ b/Documentation/user/lilypond.tely @@ -1,48 +1,61 @@ \input texinfo @c -*- coding: utf-8; mode: texinfo; -*- +@ignore + Translation of GIT committish: FILL-IN-HEAD-COMMITTISH + + When revising a translation, copy the HEAD committish of the + version that you are working on. See TRANSLATION for details. +@end ignore @setfilename lilypond.info -@settitle GNU LilyPond +@settitle GNU LilyPond user manual +@documentencoding UTF-8 +@documentlanguage en + @iftex @afourpaper +@c don't replace quotes with directed quotes +@tex +\gdef\SETtxicodequoteundirected{Foo} +\gdef\SETtxicodequotebacktick{Bla} +@end tex @end iftex -@dircategory GNU music project -@direntry +@c Keep this here, since it pertains to the direntry below. @ignore -(I think) -Current version of the manual: 2.8.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[-www]/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 -* 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. -@end direntry +@c +@c Info files are no longer installed in a subdirectory, images are +@c expected to be found in lilypond/ subdirectory. +@dircategory GNU LilyPond --- the music typesetter +@direntry +* LilyPond Learning Manual: (lilypond-learning). Start here. +* Music Glossary: (music-glossary). For non-English users. +* LilyPond: (lilypond). LilyPond Notation Reference. +* LilyPond Internals Reference: (lilypond-internals). Definitions for tweaking. +* LilyPond Application Usage: (lilypond-program). Installing and running applications. +* abc2ly: (lilypond-program)Invoking abc2ly. Importing ABC. +* convert-ly: (lilypond-program)Updating files with convert-ly. Older LilyPond versions. +* etf2ly: (lilypond-program)Invoking etf2ly. Importing Finale. +* lilypond-book: (lilypond-program)LilyPond-book. Integrating text and music. +* midi2ly: (lilypond-program)Invoking midi2ly. Importing MIDI. +* musicxml2ly: (lilypond-program)Invoking musicxml2ly. Importing MusicXML. +@end direntry + +@c don't remove this comment. @ignore @omfcreator Han-Wen Nienhuys, Jan Nieuwenhuizen and Graham Percival @omfdescription User manual of the LilyPond music engraving system @@ -51,134 +64,16 @@ Distributions will want to install lilypond.info in postinstall, doing: @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{source/Documentation/user/lilypond.pdf,PDF}. +This document is also available as a +@uref{source/Documentation/user/lilypond.pdf,PDF} and as +@uref{source/Documentation/user/lilypond-big-page.html,one big page}. @end ifhtml -@documentlanguage en -@documentencoding utf-8 - +@c This produces the unified index @syncodeindex fn cp -@syncodeindex ky cp -@syncodeindex pg cp -@syncodeindex tp cp @syncodeindex vr cp @@ -187,63 +82,73 @@ This document is also available in @uref{source/Documentation/user/lilypond.pdf, @titlepage @title LilyPond @subtitle The music typesetter +@titlefont{User manual} @author The LilyPond development team +Copyright @copyright{} 1999--2007 by the authors - -Copyright @copyright{} 1999--2006 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''. +@quotation +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 quotation @vskip 20pt -@c Not yet debugged or reported. This crashes gs-8.01: -@c compiling gs-8.01 right now... -- jcn @lilypond[ragged-right] \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 - ragged-right = ##t - } + \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 + } } @end lilypond @end titlepage +@copying +Copyright @copyright{} 1999--2007 by the authors + +@quotation +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 quotation +@end copying @ifnottex This file documents GNU LilyPond. -Copyright 1999--2006 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''. +Copyright 1999--2007 by the authors +@quotation +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 quotation @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.8.x series. +This is the user manual for GNU LilyPond 2.11.x series. @ifhtml (See the bottom of this page for the exact version number). @end ifhtml @@ -251,35 +156,30 @@ This is the user manual for GNU LilyPond 2.8.x series. @cindex web site @cindex URL -A further source of information is the website, which can be found at +More information 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. -* Working on LilyPond projects:: 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. +* Musical notation:: Musical notation. +* Specialist notation:: Notation which is only used for + specific purposes. +* Input syntax:: General information about + lilypond input files. +* Non-musical notation:: Output that is not musical notation. +* Spacing issues:: Display of output on paper. * Changing defaults:: Tuning output. -* Global issues:: 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. +* Interfaces for programmers:: Expert usage. + +Appendices + +* Literature list:: Reference works about music notation. +* Notation manual tables:: Tables and charts. +* Cheat sheet:: Summary of LilyPond syntax. +* GNU Free Documentation License:: License of this document. +* LilyPond command index:: * LilyPond index:: @end menu @end ifnottex @@ -288,33 +188,28 @@ of this and other documentation. @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 +@include notation.itely +@include specialist.itely +@include input.itely +@include non-music.itely +@include spacing.itely -@c FIXME: Index has two alphabetically sorted lists @code vs plain? +@include changing-defaults.itely +@include programming-interface.itely @include literature.itely -@include scheme-tutorial.itely @include notation-appendices.itely -@include point-and-click.itely @include cheatsheet.itely @include fdl.itexi +@node LilyPond command index +@appendix LilyPond command index + +@printindex ky + @node LilyPond index @appendix LilyPond index