1 @c -*- coding: utf-8; mode: texinfo; -*-
3 Translation of GIT committish: 7a5bfc62fcac71d5c996b2df58921fd2fe783415
5 When revising a translation, copy the HEAD committish of the
6 version that you are working on. For details, see the Contributors'
7 Guide, node Updating translation committishes..
10 @c This file is part of web/download.itexi and
11 @c learning/tutorial.itely
13 @c This is about "compiling" a lilypond file
14 @c (Learning 1 Tutorial), **not** compiling the
18 @warning{These instructions assume that you are using the LilyPond
19 application. If you are using any of the programs described in
20 @rweb{Easier editing}, consult the documentation for those
21 programs should you have any problems.}
24 @subsubheading Step 1. Create your @file{.ly} file
26 Double click the @command{LilyPond.app}, an example file will open.
28 @sourceimage{Learning_Macos_welcome,,,}
30 From the menus along the top left of your screen, select
31 @w{@code{File > Save}}.
33 @sourceimage{Learning_Macos_Save_menu,,,}
35 Choose a name for your file, for example @file{test.ly}.
37 @sourceimage{Learning_Macos_Save_file_with_name,,,}
40 @subsubheading Step 2. Compile (with LilyPad)
42 From the same menus, select
43 @w{@code{Compile > Typeset}}.
45 @sourceimage{Learning_Macos_Typeset_menu,,,}
47 A new window will open showing a progress log of the compilation
48 of the file you have just saved.
50 @sourceimage{Learning_Macos_Compiling_log,,,}
53 @subsubheading Step 3. View output
55 Once the compilation has finished, a PDF file will be created with
56 the same name as the original file and will be automatically
57 opened in the default PDF viewer and displayed on your screen.
59 @sourceimage{Learning_Macos_pdf_output,,,}
62 @subsubheading Other commands
64 To create new files for LilyPond, begin by selecting
67 @sourceimage{Learning_Macos_New_menu,,,}
69 or @w{@code{File > Open}} to open and edit existing files you have
72 @sourceimage{Learning_Macos_Open_menu,,,}
74 You must save any new edits you make to your file before you
75 @w{@code{Compile > Typeset}} and if the PDF file is not displayed
76 check the window with the progress log for any errors.
78 If you are not using the default Preview PDF viewer that comes
79 with the Mac Operating system and you have the PDF file generated
80 from a previous compilation open, then any further compilations
81 may fail to generate an update PDF until you close the original.
89 @warning{These instructions assume that you are using the built-in
90 LilyPad editor. If you are using any of the programs described in
91 @rweb{Easier editing}, consult the documentation for those programs
92 should you have any problems.}
95 @subsubheading Step 1. Create your @file{.ly} file
97 Double-click the LilyPond icon on your desktop and an example file will open.
99 @sourceimage{LilyPad,,,}
101 From the menus that appear along the top of the example file,
102 select @w{@code{File > Save as}}. Do not use the @w{@code{File > Save}}
103 for the example file as this will not work until you have given it a
104 valid LilyPond file name.
106 @sourceimage{FileSave,,,}
108 Choose a name for your file, for example @file{test.ly}.
110 @sourceimage{SaveAs,,,}
113 @subsubheading Step 2. Compile
115 To turn your LilyPond file into a music score, you need to compile it. This
116 can be done a number of ways -- using drag and drop, with right-click,
117 double-clicking or using the command line (a DOS box). We'll look at the
118 first three to start with.
120 1. Drag-and-drop the file directly onto the LilyPond icon on the desktop.
122 @sourceimage{DragDrop,,,}
124 Not much will seem to happen, but after a short while, you should
125 see two new files on your desktop -- @file{test.log} and
128 2. Right-click on the file and from the pop-up context menu and
129 choose @w{@code{Generate PDF}}.
131 @sourceimage{GenPDF,,,}
133 3. Or simply double-click the @file{test.ly}.
136 @subsubheading Step 3. View output
138 @file{test.pdf} contains the engraved @file{test.ly}
139 file. Double-click it and it should open in your PDF viewer:
141 @sourceimage{PDFRead,,,}
144 @subsubheading Other commands
146 To create a new file, begin by selecting @w{@code{File > New}} from
147 within any previously created file or @w{@code{File > Open}} to open and
148 edit any files you have saved before. You can also edit a file by
149 right-clicking it and selecting @w{@code{Edit source}}.
151 @sourceimage{EditFile,,,}
153 You must save any edits you make before you try to compile your
154 file. If the PDF file is not created or the output is not what you
155 expected, check the log file that will have been created during the
156 compilation attempt for any errors.
158 @sourceimage{BadLog,,,}
160 This log file is overwritten each time you compile your LilyPond file.
162 If you are viewing your file in a PDF viewer, then you must close the PDF
163 if you wish to try a new compilation as it may fail to create the new PDF
164 while it is still being viewed.
166 @sourceimage{BadLog2,,,}
171 @c not lilypad at all, but I ran out of names. :(
172 @macro lilypadCommandLine
173 @warning{These instructions assume that you are familiar with
174 command-line programs. If you are using any of the programs described
175 in @rweb{Easier editing}, consult the documentation for those programs
176 should you have any problems.}
179 @subsubheading Step 1. Create your @file{.ly} file
181 Create a text file called @file{test.ly} and enter:
183 @c double \\ required because this is inside a macro!
185 \\version "@w{@versionStable{}}"
192 @subsubheading Step 2. Compile (with command-line)
194 To process @file{test.ly}, type the following at the command prompt:
201 You will see something resembling:
204 GNU LilyPond @w{@versionStable{}}
207 Interpreting music...
208 Preprocessing graphical objects...
209 Solving 1 page-breaking chunks...[1: 1 pages]
211 Layout output to `test.ps'...
212 Converting to `./test.pdf'...
213 Success: compilation successfully completed
216 @subsubheading Step 3. View output
218 You may view or print the resulting @file{test.pdf}.