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.
+ version that you are working on. For details, see the Contributors'
+ Guide, node Updating translation committishes..
@end ignore
@c \version "2.12.0"
This example shows a simple input file:
@example
+\version "@w{@version{}}"
@{
c' e' g' e'
@}
@subheading Producing output
-@c TODO: move index entries
@cindex PDF file
@cindex viewing music
@cindex text editors
-@cindex running LilyPond under MacOS X
-@cindex MacOS X, running LilyPond
-@cindex running LilyPond under Windows
-@cindex Windows, running LilyPond
-@cindex running LilyPond under Unix
-@cindex Unix, running LilyPond
The method of producing output depends on your operating system
and the program(s) you use.
There are several other text editors available with specific
support for LilyPond. For more information, see
-@rweb{Alternate input}.
+@rweb{Easier editing}.
@warning{The first time you ever run LilyPond, it may take a
minute or two because all of the system fonts have to be analyzed
first. After this, LilyPond will be much faster!}
+@cindex running LilyPond under MacOS X
+@cindex MacOS X, running LilyPond
@node MacOS X
@subsection MacOS X
@warning{These instructions assume that you are using the LilyPond
application. If you are using any of the programs described in
-@rweb{Alternate input}, please consult the documentation for
+@rweb{Easier editing}, please consult the documentation for
those programs if you have any problems.}
from a previous compilation open, then any further compilations
may fail to generate an update PDF until you close the original.
+@cindex running LilyPond under Windows
+@cindex Windows, running LilyPond
@node Windows
@subsection Windows
@warning{These instructions assume that you are using the built-in
LilyPad editor. If you are using any of the programs described in
-@rweb{Alternate input}, please consult the documentation for
+@rweb{Easier editing}, please consult the documentation for
those programs if you have any problems compiling a file.}
@subsubheading Step 1. Create your @file{.ly} file
-Double-click the @command{LilyPond.app}, an example file will open.
+Double-click the LilyPond icon on your desktop, an example file will open.
@sourceimage{Learning_Win7_Welcome_File_Whole,,,}
-From the menus that appear alonbg the top of the example file,
+From the menus that appear along the top of the example file,
select @w{@code{File > Save as}}. Do not use the @w{@code{File > Save}}
for the example file as this will not work until you have given it a
-valid Lilypong file name.
+valid LilyPond file name.
@sourceimage{Learning_Win7_Save_Menu,,,}
PDF if you wish to make a new compilation as it may fail to create
the new PDF while it is still being viewed.
+@cindex running LilyPond under Unix
+@cindex Unix, running LilyPond
@node Command-line
@subsection Command-line
@warning{These instructions assume that you are familiar with
command-line programs. If you are using any of the programs
-described in @rweb{Alternate input}, please consult the
+described in @rweb{Easier editing}, please consult the
documentation for those programs if you have any problems
compiling a file.}
Create a text file called @file{test.ly} and enter:
@example
+\version "@w{@version{}}"
@{
c' e' g' e'
@}
@subsubheading Step 2. Compile (with command-line)
-To process @file{test.ly}, proceed as follows:
+To process @file{test.ly}, type the following at the command prompt:
@example
lilypond test.ly
You will see something resembling:
@example
-lilypond test.ly
GNU LilyPond @version{}
Processing `test.ly'
Parsing...
Interpreting music...
Preprocessing graphical objects...
-Finding the ideal number of pages...
-Fitting music on 1 page...
+Solving 1 page-breaking chunks...[1: 1 pages]
Drawing systems...
Layout output to `test.ps'...
-Converting to `test.pdf'...
+Converting to `./test.pdf'...
@end example
@subsubheading Step 3. View output
-You may view or print the resulting @file{text.pdf}.
+You may view or print the resulting @file{test.pdf}.
@node How to write input files
@cindex case sensitive
@cindex whitespace insensitive
@cindex expressions
+@cindex versioning
+@cindex version
+@cindex version number
+@funindex \version
@funindex { ... }
@funindex %
@funindex %@{ ... %@}
LilyPond input files are similar to source files in many common
-programming languages. They are case sensitive, and white-space
+programming languages. They contain a version statement,
+are case sensitive, and white-space
is generally ignored. Expressions are formed with curly braces
@{ @}, and comments are denoted with @code{%} or
@w{@code{%@{ ... %@}}}.
@itemize
+@item
+@strong{Version statement}:
+Every LilyPond file should contain a version statement. A version
+statement is a line that describes the version of LilyPond for which
+the file was written, as in the following example:
+
+@example
+\version "@w{@version{}}"
+@end example
+
+By convention, the version statement is placed at the top of the
+LilyPond file.
+
+The version statement is important for at least two reasons. First,
+it allows automatic updating of the input file as LilyPond syntax
+changes. Second, it describes the version of LilyPond needed to
+compile the file.
+
+If the version statement is omitted from an input file, LilyPond will print
+a warning during the compilation of the file.
+
@item
@strong{Case sensitive}:
it matters whether you enter a letter in lower case (e.g.
online version.
@menu
-* Omitting braces::
+* Omitted material::
* Clickable examples::
* Keyboard navigation::
* Overview of manuals::
@end menu
-@node Omitting braces
-@subsection Omitting braces
+@node Omitted material
+@subsection Omitted material
@cindex how to read the manual
own. Most people want to add material to an existing piece, so we
format the manual this way.
+Also, remember that every LilyPond file should have a @code{@bs{}version}
+statement. Because the examples in the manuals are snippets, not files,
+the @code{@bs{}version} statement is omitted. But you should make a
+practice of including them in your files.
@node Clickable examples
@subsection Clickable examples
-@warning{This features is only available in the HTML manuals.}
+@warning{This feature is only available in the HTML manuals.}
Many people learn programs by trying and fiddling around with the
program. This is also possible with LilyPond. If you click on a
projects / lilypond.git / blobdiff