Documentation/user/putting.itely

   1 @c -*- coding: latin-1; mode: texinfo; -*-
   2 @node Putting it all together
   3 @chapter Putting it all together
   4
   5 This section will demonstrate more complicated stuff in LilyPond, probably
   6 via annotated examples.  It's currently incomplete and serves as a
   7 placeholder so that the chapter numbering doesn't change later.
   8
   9 @menu
  10 * Suggestions for writing LilyPond files::
  11 @end menu
  12
  13 @c  explain \score{}  ?  Add a note to the tutorial?
  14
  15 @node Suggestions for writing LilyPond files
  16 @section Suggestions for writing LilyPond files
  17
  18 Now you're ready to begin writing larger LilyPond files -- not just the
  19 little examples in the tutorial, but whole pieces.  But how should you
  20 go about doing it?
  21
  22 The best answer is ``however you want to do it.''  As long as LilyPond
  23 can understand your files and produces the output that you want, it
  24 doesn't matter what your files look like.  That said, sometimes we
  25 make mistakes when writing files.  If LilyPond can't understand your
  26 files, or produces output that you don't like, how do you fix the
  27 problem?
  28
  29 Here are a few suggestions that can help you to avoid or fix
  30 problems:
  31
  32 @itemize @bullet
  33 @item Include @code{\version} numbers in every file.  Note that all
  34 templates contain a @code{\version "2.4.0"} string.  We
  35 highly recommend that you always include the @code{\version}, no matter
  36 how small your file is.  Speaking from personal experience, it's
  37 quite frustrating to try to remember which version of LilyPond you were
  38 using a few years ago.  @code{convert-ly} requires you to declare
  39 which version of LilyPond you used.
  40
  41 @item Include checks: See @ref{Bar check} and @ref{Octave check}.  If you
  42 include checks every so often, then if you make a mistake, you can pinpoint
  43 it quicker.  How often is ``every so often''?  It depends on the complexity
  44 of the music.  For very simple music, perhaps just once or twice.  For
  45 very complex music, every bar.
  46
  47 @item One bar per line.  If there is anything complicated, either in the music
  48 itself or in the output you desire, it's often good to write only one bar
  49 per line.  Saving screen space by cramming eight bars per line just isn't
  50 worth it if you have to `debug' your files.
  51
  52 @item Comment your files, with either bar numbers (every so often) or
  53 references to musical themes (``second theme in violins'', ``fourth
  54 variation'').  You may not need it when you're writing the piece for
  55 the first time, but if you want to go back and change something two
  56 or three years later, you won't know how your file is structured if you
  57 don't comment the file.
  58
  59 @end itemize
  60
  61