Documentation/included/generating-output.itexi

   1 @c -*- coding: utf-8; mode: texinfo; -*-
   2 @c This file is part of web/download.itexi and
   3 @c learning/tutorial.itely
   4
   5 @c This is about "compiling" a lilypond file
   6 @c (Learning 1 Tutorial), **not** compiling the
   7 @c source code.
   8
   9 @macro lilypadOSX
  10 @warning{These instructions assume that you are using the LilyPond
  11 application.  If you are using any of the programs described in
  12 @rweb{Easier editing}, please consult the documentation for
  13 those programs if you have any problems.}
  14
  15
  16 @subsubheading Step 1. Create your @file{.ly} file
  17
  18 Double click the @command{LilyPond.app}, an example file will open.
  19
  20 @sourceimage{Learning_Macos_welcome,,,}
  21
  22 From the menus along the top left of your screen, select
  23 @w{@code{File > Save}}.
  24
  25 @sourceimage{Learning_Macos_Save_menu,,,}
  26
  27 Choose a name for your file, for example @file{test.ly}.
  28
  29 @sourceimage{Learning_Macos_Save_file_with_name,,,}
  30
  31
  32 @subsubheading Step 2. Compile (with LilyPad)
  33
  34 From the same menus, select
  35 @w{@code{Compile > Typeset}}.
  36
  37 @sourceimage{Learning_Macos_Typeset_menu,,,}
  38
  39 A new window will open showing a progress log of the compilation
  40 of the file you have just saved.
  41
  42 @sourceimage{Learning_Macos_Compiling_log,,,}
  43
  44
  45 @subsubheading Step 3. View output
  46
  47 Once the compilation has finished, a PDF file will be created with
  48 the same name as the original file and will be automatically
  49 opened in the default PDF viewer and displayed on your screen.
  50
  51 @sourceimage{Learning_Macos_pdf_output,,,}
  52
  53
  54 @subsubheading Other commands
  55
  56 To create new files for LilyPond, begin by selecting
  57 @w{@code{File > New}}
  58
  59 @sourceimage{Learning_Macos_New_menu,,,}
  60
  61 or @w{@code{File > Open}} to open and edit existing files you have
  62 saved previously.
  63
  64 @sourceimage{Learning_Macos_Open_menu,,,}
  65
  66 You must save any new edits you make to your file before you
  67 @w{@code{Compile > Typeset}} and if the PDF file is not displayed
  68 check the window with the progress log for any errors.
  69
  70 If you are not using the default Preview PDF viewer that comes
  71 with the Mac Operating system and you have the PDF file generated
  72 from a previous compilation open, then any further compilations
  73 may fail to generate an update PDF until you close the original.
  74
  75
  76
  77 @end macro
  78
  79
  80 @macro lilypadWindows
  81 @warning{These instructions assume that you are using the built-in
  82 LilyPad editor.  If you are using any of the programs described in
  83 @rweb{Easier editing}, please consult the documentation for
  84 those programs if you have any problems compiling a file.}
  85
  86
  87 @subsubheading Step 1. Create your @file{.ly} file
  88
  89 Double-click the LilyPond icon on your desktop, an example file will open.
  90
  91 @sourceimage{Learning_Win7_Welcome_File_Whole,,,}
  92
  93 From the menus that appear along the top of the example file,
  94 select @w{@code{File > Save as}}.  Do not use the @w{@code{File > Save}}
  95 for the example file as this will not work until you have given it a
  96 valid LilyPond file name.
  97
  98 @sourceimage{Learning_Win7_Save_Menu,,,}
  99
 100 Choose a name for your file, for example @file{test.ly}.
 101
 102 @sourceimage{Learning_Win7_Save_File_With_Name,,,}
 103
 104
 105 @subsubheading Step 2a. Compile (with drag-and-drop)
 106
 107 Depending on what you prefer, to compile your file either:
 108
 109 Drag-and-drop the file directly onto the LilyPond icon.
 110
 111 @sourceimage{Learning_Win7_Open_Dragndrop,,,}
 112
 113 Right-click on the file and from the pop-up context menu choose
 114 @w{@code{Open with > LilyPond}}.
 115
 116 @sourceimage{Learning_Win7_Open_Context_Menu,,,}
 117
 118
 119 @subsubheading Step 2b. Compile (with double-clicking)
 120
 121 Or simply double-click the @file{test.ly}.
 122
 123
 124 @subsubheading Step 3. View output
 125
 126 During the compilation of the @file{test.ly} file, a command window
 127 will, very briefly open and then close.  Three additional files will
 128 have been created during this process.
 129
 130 @sourceimage{Learning_Win7_All_Files_Created,,,}
 131
 132 The PDF file contains the engraved @file{test.ly} file.
 133
 134 @sourceimage{Learning_Win7_Pdf_Output,,,}
 135
 136
 137 @subsubheading Other commands
 138
 139 To create a new file, begin by selecting @w{@code{File > New}} from
 140 within any previously created file.
 141
 142 @sourceimage{Learning_Win7_New_Menu,,,}
 143
 144 @noindent
 145 or @w{@code{File > Open}} to open and edit any files you have saved
 146 before.
 147
 148 @sourceimage{Learning_Win7_Open_Menu,,,}
 149
 150 You must save any new edits you make before you compile it and if the
 151 PDF file is not created, check the log file that will have been created
 152 during the compilation attempt, for any errors.
 153
 154 @sourceimage{Learning_Win7_Log_File,,,}
 155
 156 This log file is overwritten each time you compile your LilyPond file.
 157
 158 The PS file is used internally by LilyPond to create the PDF file and
 159 can be ignored.  It also gets overwritten each time you compile your
 160 file.
 161
 162 If you are viewing your file in a PDF viewer, then you must close the
 163 PDF if you wish to make a new compilation as it may fail to create
 164 the new PDF while it is still being viewed.
 165
 166
 167 @end macro
 168
 169
 170 @c not lilypad at all, but I ran out of names.  :(
 171 @macro lilypadCommandLine
 172 @warning{These instructions assume that you are familiar with
 173 command-line programs.  If you are using any of the programs
 174 described in @rweb{Easier editing}, please consult the
 175 documentation for those programs if you have any problems
 176 compiling a file.}
 177
 178
 179 @subsubheading Step 1. Create your @file{.ly} file
 180
 181 Create a text file called @file{test.ly} and enter:
 182
 183 @c double \\ required because this is inside a macro!
 184 @example
 185 \\version "@w{@versionStable{}}"
 186 @{
 187   c' e' g' e'
 188 @}
 189 @end example
 190
 191
 192 @subsubheading Step 2. Compile (with command-line)
 193
 194 To process @file{test.ly}, type the following at the command prompt:
 195
 196 @example
 197 lilypond test.ly
 198 @end example
 199
 200 @noindent
 201 You will see something resembling:
 202
 203 @example
 204 GNU LilyPond @w{@versionStable{}}
 205 Processing `test.ly'
 206 Parsing...
 207 Interpreting music...
 208 Preprocessing graphical objects...
 209 Solving 1 page-breaking chunks...[1: 1 pages]
 210 Drawing systems...
 211 Layout output to `test.ps'...
 212 Converting to `./test.pdf'...
 213 @end example
 214
 215 @subsubheading Step 3. View output
 216
 217 You may view or print the resulting @file{test.pdf}.
 218
 219 @end macro
 220
 221