Documentation/general/manuals.itexi

   1 @c -*- coding: utf-8; mode: texinfo; -*-
   2 @ignore
   3     Translation of GIT committish: FILL-IN-HEAD-COMMITTISH
   4
   5     When revising a translation, copy the HEAD committish of the
   6     version that you are working on.  See TRANSLATION for details.
   7 @end ignore
   8
   9 @node Manuals
  10 @unnumbered Manuals
  11
  12 @divClass{heading-center}
  13 @heading Documentation for LilyPond 2.12.2
  14
  15 @divEnd
  16
  17 @divClass{column-center-top}
  18 @subheading Introduction
  19
  20 @itemize
  21
  22 @item @ref{Text input}:
  23 LilyPond is a @strong{text-based} music engraver.  If you are not
  24 familiar with this concept, please read this now!
  25
  26 @item @ref{Learning}:
  27 a @qq{must-read} gentle introduction to LilyPond.
  28
  29 @item @ref{Glossary}:
  30 @emph{(optional reading)}
  31 explains musical terms and gives translations for users unfamiliar
  32 with English musical terms.
  33
  34 @item @ref{Essay}:
  35 @emph{(optional reading)}
  36 background information about the engraving process and the
  37 aesthetics of 19th century music engraving.
  38
  39
  40 @end itemize
  41
  42 @divEnd
  43
  44 @divClass{column-left-top}
  45 @subheading Regular use
  46
  47 @itemize
  48
  49 @item @ref{Notation}:
  50 the main portion of the documentation; provides detailed
  51 information about creating notation.
  52
  53 @item @ref{Snippets}:
  54 short tricks, tips, and examples.
  55
  56 @item @ref{Usage}:
  57 discusses the actual programs and operating system-specific
  58 issues.
  59
  60 @end itemize
  61
  62 @divEnd
  63
  64
  65 @divClass{column-right-top}
  66 @subheading Infrequent Use
  67
  68 @itemize
  69
  70 @item @ref{FAQ}:
  71 links to the answers of Frequently Asked Questions.
  72
  73 @item @ref{Changes}:
  74 updates since the last major version.
  75
  76 @item @ref{Internals}:
  77 information about LilyPond's internal structures, which is
  78 required for constructing tweaks.
  79
  80 @end itemize
  81
  82 @divEnd
  83
  84
  85 @divClass{column-center-bottom}
  86 @subheading Other material
  87
  88 @itemize
  89
  90 @item @ref{Translated}:
  91 translation status for non-English readers.
  92
  93 @item @ref{Old}:
  94 manuals for older versions.
  95
  96 @item @ref{Development}:
  97 manuals for the unstable version.
  98
  99 @item @ref{FDL}:
 100 these manuals are published under the GNU Free Documentation
 101 License.
 102
 103 @end itemize
 104
 105 @divEnd
 106
 107
 108 @divClass{hide}
 109 @menu
 110 * Learning::             Learning.
 111 * Glossary::              Glossary.
 112 * Essay::                       Essay.
 113 * Notation::          Reference.
 114 * Usage::           Usage.
 115 * Snippets::                Snippets.
 116 * FAQ::                         FAQ.
 117 * Changes::                     NEWS.
 118 * Internals::         Internals.
 119 * Translated::          Translation.
 120 * Old::                 Old.
 121 * FDL::                     Licence.
 122 @end menu
 123
 124 @divEnd
 125
 126
 127 @c TRANSLATORS: most of the text in this file came from
 128 @c LM 1.1 About the documentation  (before this section was
 129 @c removed in July 2009).
 130
 131 @node Learning
 132 @unnumberedsec Learning
 133
 134 This book explains how to begin learning LilyPond, as well as
 135 explaining some key concepts in easy terms.  You should read these
 136 chapters in a linear fashion.
 137
 138 There is a paragraph @strong{See also} at the end of each section,
 139 which contains cross-references to other sections: you should not
 140 follow these cross-references at first reading; when you have read
 141 all of the Learning, you may want to read some sections
 142 again and follow cross-references for further reading.
 143
 144 @itemize
 145
 146 @item
 147 @item
 148 @rlearning{Tutorial}: gives a gentle introduction to typesetting music.
 149 First time users should start here.
 150
 151 @item
 152 @rlearning{Fundamental concepts}: explains some general concepts about
 153 the LilyPond file format.  If you are not certain where to place a
 154 command, read this chapter!
 155
 156 @item
 157 @rlearning{Tweaking output}: shows how to change the default engraving
 158 that LilyPond produces.
 159
 160 @item
 161 @rlearning{Working on LilyPond projects}: discusses practical uses of
 162 LilyPond and how to avoid some common problems.  Read this before
 163 undertaking large projects!
 164
 165 @end itemize
 166
 167 The Learning also contains appendices which are not part of the
 168 recommended linear reading.  They may be useful for later
 169 viewing:
 170
 171 @itemize
 172
 173 @item
 174 @rlearning{Templates}: shows ready-made templates of LilyPond pieces.
 175 Just cut and paste a template into a file, add notes, and you're
 176 done!
 177
 178 @item
 179 @rlearning{Scheme tutorial}: presents a short introduction to Scheme,
 180 the programming language that music functions use.  This is
 181 material for advanced tweaks; many users never touch Scheme at
 182 all.
 183
 184 @end itemize
 185
 186
 187 @node Glossary
 188 @unnumberedsec Glossary
 189
 190 @rglosnamed{Top,Music glossary}
 191 this explains musical terms, and includes translations to various
 192 languages.  If you are not familiar with music notation or music
 193 terminology (especially if you are a non-native English speaker),
 194 it is highly advisable to consult the glossary.
 195
 196
 197 @node Essay
 198 @unnumberedsec Essay
 199
 200 blah
 201
 202
 203 @node Notation
 204 @unnumberedsec Notation
 205
 206 This book explains all the LilyPond commands which produce
 207 notation.
 208
 209 @warning{The Notation assumes that the reader knows
 210 basic material covered in the Learning and is familiar with
 211 the English musical terms presented in the Musical Glossary.}
 212
 213 @itemize
 214
 215 @item
 216 @ruser{Musical notation}:
 217 discusses topics grouped by notation construct.  This section
 218 gives details about basic notation that will be useful in almost
 219 any notation project.
 220
 221 @item
 222 @ruser{Specialist notation}:
 223 discusses topics grouped by notation construct.  This section
 224 gives details about special notation that will only be useful for
 225 particular instrument (or vocal) groups.
 226
 227 @item
 228 @ruser{General input and output}:
 229 discusses general information about LilyPond input files and
 230 controlling output.
 231
 232 @item
 233 @ruser{Spacing issues}:
 234 discusses issues which affect the global output, such as selecting
 235 paper size or specifying page breaks.
 236
 237 @item
 238 @ruser{Changing defaults}:
 239 explains how to tweak LilyPond to produce exactly the notation you
 240 want.
 241
 242 @item
 243 @ruser{Interfaces for programmers}:
 244 explains how to create music functions with scheme.
 245
 246 @end itemize
 247
 248 The Notation also contains appendices with useful
 249 reference charts.
 250
 251 @itemize
 252
 253 @item
 254 @ruser{Literature list}:
 255 contains a set of useful reference books for those who wish to
 256 know more on notation and engraving.
 257
 258 @item
 259 @ruser{Notation manual tables}:
 260 are a set of tables showing the chord names, MIDI instruments, a
 261 list of color names, and the Feta font.
 262
 263 @item
 264 @ruser{Cheat sheet}:
 265 is a handy reference of the most common LilyPond commands.
 266
 267 @item
 268 @ruser{LilyPond command index}:
 269 an index of all LilyPond @code{\commands}.
 270
 271 @item
 272 @ruser{LilyPond index}:
 273 a complete index.
 274
 275 @end itemize
 276
 277
 278 @node Usage
 279 @unnumberedsec Usage
 280
 281 This book explains how to execute the programs and how to integrate
 282 LilyPond notation with other programs.
 283
 284 @itemize
 285
 286 @item
 287 @rprogram{Install}:
 288 explains how to install LilyPond, including compilation if
 289 desired.
 290
 291 @item
 292 @rprogram{Setup}:
 293 describes how to configure your computer for optimum LilyPond
 294 usage, such as using special environments for certain text
 295 editors.
 296
 297 @item
 298 @rprogram{Running LilyPond}:
 299 shows how to run LilyPond and its helper programs.  In addition,
 300 this section explains how to upgrade input files from previous
 301 versions of LilyPond.
 302
 303 @item
 304 @rprogram{LilyPond-book}:
 305 explains the details behind creating documents with in-line music
 306 examples, like this manual.
 307
 308 @item
 309 @rprogram{Converting from other formats}:
 310 explains how to run the conversion programs.  These programs are
 311 supplied with the LilyPond package, and convert a variety of music
 312 formats to the @code{.ly} format.
 313
 314 @end itemize
 315
 316
 317 @node Snippets
 318 @unnumberedsec Snippets
 319
 320 @rlsrnamed{Top,LilyPond Snippets}: this shows a
 321 selected set of LilyPond snippets from the
 322 @uref{http://lsr@/.dsi@/.unimi@/.it,LilyPond Snippet Repository}
 323 (LSR).  All the snippets are in the public domain.
 324
 325 Please note that this document is not an exact subset of LSR.  LSR
 326 is running a stable LilyPond version, so any snippet which
 327 demonstrates new features of a development version must be added
 328 separately.  These are stored in @file{input/new/} in the LilyPond
 329 source tree.
 330
 331 The list of snippets for each subsection of the Notation are
 332 also linked from the @strong{See also} portion.
 333
 334
 335 @node FAQ
 336 @unnumberedsec FAQ
 337
 338 @warning{to be moved into the actual Documentation/ in master)}
 339
 340
 341 @subheading Where are the graphical canvas, menus, and toolbars?
 342
 343 LilyPond requires you to write music as text.  Please read about
 344 our @ref{Text input}.
 345
 346
 347 @subheading There's a lot of documentation!  Do I need to read it?
 348
 349 You need to read the @ref{Learning}.  As for the rest of
 350 documentation, you only need to read the sections which discuss
 351 the notation that you wish to create.
 352
 353
 354 @subheading That's still a lot of reading!  Is it worth it?
 355
 356 Please decide for yourself; the reasons why you might want to use
 357 LilyPond are given in the @ref{Introduction}.
 358
 359
 360 @subheading Something isn't working!  How do I fix it?
 361
 362 This is explained in @@ref@{FIXME LM or AU x.y@}.
 363
 364
 365 @subheading Why do you change the syntax?
 366
 367 This is explained in @@ref@{FIXME AU x.y@}.
 368
 369
 370 @node Changes
 371 @unnumberedsec Changes
 372
 373 previous-named "NEWS" doc.
 374
 375 this is a summary of important changes
 376 and new features in LilyPond since the previous version.
 377
 378
 379
 380 @node Internals
 381 @unnumberedsec Internals
 382
 383 @rinternalsnamed{Top,Internals}: this is a set
 384 of heavily cross linked HTML pages which document the nitty-gritty
 385 details of each and every LilyPond class, object, and function.
 386 It is produced directly from the formatting definitions in the
 387 source code.
 388
 389 Almost all formatting functionality that is used internally is
 390 available directly to the user.  For example, most variables that
 391 control thickness values, distances, etc., can be changed in input
 392 files.  There are a huge number of formatting options, and all of
 393 them are described in this document.  Each section of the Notation
 394 Reference has a @b{See also} subsection, which refers to the
 395 generated documentation.  In the HTML document, these subsections
 396 have clickable links.
 397
 398
 399
 400 @node Translated
 401 @unnumberedsec Translated
 402
 403 blah
 404
 405
 406 @node Old
 407 @unnumberedsec Old
 408
 409 Documentation for previous stable versions:
 410
 411 @itemize
 412
 413 @item @uref{http://lilypond.org/doc/v2.12/Documentation/,
 414 LilyPond 2.12 Documentation}
 415
 416 @item @uref{http://lilypond.org/doc/v2.10/Documentation/,
 417 LilyPond 2.10 Documentation}
 418
 419 @item @uref{http://lilypond.org/doc/v2.8/Documentation/,
 420 LilyPond 2.8 Documentation}
 421
 422 @item FIXME etc.
 423
 424 @end itemize
 425
 426
 427 @node FDL
 428 @unnumberedsec FDL
 429
 430 @divClass{column-center-top}
 431 @subheading Documentation license
 432
 433 The documentation for GNU LilyPond is published under the GNU Free
 434 Documentation License.  An introduction to this license, and our
 435 reasons for choosing it, is given in @ref{Freedom}.
 436
 437 @divEnd
 438
 439 @divClass{column-center-bottom}
 440 @subheading GNU Free Documentation License 1.1
 441
 442 @include fdl.itexi
 443
 444 @divEnd
 445
 446