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{All}:
  94 manuals for older versions and downloadable 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 * All::                 All manuals.
 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 @divClass{column-left-top}
 135 @subheading Learning manual
 136
 137 This book explains how to begin learning LilyPond, as well as
 138 explaining some key concepts in easy terms.  You should read these
 139 chapters in a linear fashion.
 140
 141 There is a paragraph @strong{See also} at the end of each section,
 142 which contains cross-references to other sections: you should not
 143 follow these cross-references at first reading.  When you have
 144 read all of the manual, you may want to read some sections again
 145 and follow those cross-references for more information.
 146 @divEnd
 147
 148 @divClass{column-right-top}
 149 @subheading Read it now
 150
 151 @itemize
 152
 153 @item @rlearningnamed{Top,Learning}:
 154 read this manual in the same format as this one.
 155
 156 @end itemize
 157 @divEnd
 158
 159 @divClass{column-center-bottom}
 160 @subheading Other formats
 161
 162 @divClass{keep-bullets}
 163 @itemize
 164
 165 @item @uref{../learning/index.html, Learning (split HTML)}:
 166 the manual is split between many HTML pages.
 167 @emph{(small download for each page)}
 168
 169 @item @uref{../learning-big-page.html, Learning (big HTML)}:
 170 read this manual as one huge HTML page.
 171 @emph{(large single download, around 10? Mb)}
 172
 173 @item @uref{../learning.pdf, learning.pdf}:
 174 download as a PDF file.
 175 @emph{(large single download, 2.8 Mb)}
 176
 177 @item @uref{FIXME, learning.info}:
 178 GNU info format for documentation.  FIXME, link broken.
 179
 180 @end itemize
 181 @divEnd
 182 @divEnd
 183
 184
 185 @node Glossary
 186 @unnumberedsec Glossary
 187
 188 @divClass{column-left-top}
 189 @subheading Glossay
 190
 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 @divEnd
 197
 198 @divClass{column-right-top}
 199 @subheading Read it now
 200
 201 @itemize
 202
 203 @item
 204 @rglosnamed{Top,Music glossary}:
 205 read this manual in the same format as this one.
 206
 207 @end itemize
 208 @divEnd
 209
 210 @divClass{column-center-bottom}
 211 @subheading Other formats
 212
 213 @divClass{keep-bullets}
 214 @itemize
 215
 216 @item @uref{../glossary/index.html, Glossary (split HTML)}:
 217 the manual is split between many HTML pages.
 218 @emph{(small download for each page)}
 219
 220 @item @uref{../glossary-big-page.html, Glossay (big HTML)}:
 221 read this manual as one huge HTML page.
 222 @emph{(large single download, around 10? Mb)}
 223
 224 @item @uref{../glossary.pdf, glossary.pdf}:
 225 download as a PDF file.
 226 @emph{(large single download, 2.8 Mb)}
 227
 228 @item @uref{FIXME, glossary.info}:
 229 GNU info format for documentation.  FIXME, link broken.
 230
 231 @end itemize
 232 @divEnd
 233 @divEnd
 234
 235
 236 @node Essay
 237 @unnumberedsec Essay
 238
 239 @divClass{column-left-top}
 240 @subheading Essay
 241
 242 This book gives a brief history of music typography, followed by
 243 an examination of LilyPond's engraving techniques.  A comparison
 244 between LilyPond and other music engraving systems is given.
 245
 246 @divEnd
 247
 248 @divClass{column-right-top}
 249 @subheading Read it now
 250
 251 @itemize
 252
 253 @item @ressaynamed{Top,Essay}:
 254 read this manual in the same format as this one.
 255
 256 @end itemize
 257 @divEnd
 258
 259 @divClass{column-center-bottom}
 260 @subheading Other formats
 261
 262 @divClass{keep-bullets}
 263 @itemize
 264
 265 @item @uref{../essay/index.html, Essay (split HTML)}:
 266 the manual is split between many HTML pages.
 267 @emph{(small download for each page)}
 268
 269 @item @uref{../essay-big-page.html, Essay (big HTML)}:
 270 read this manual as one huge HTML page.
 271 @emph{(large single download, around FIXME? Mb)}
 272
 273 @item @uref{../essay.pdf, essay.pdf}:
 274 download as a PDF file.
 275 @emph{(large single download, FIXME? Mb)}
 276
 277 @item @uref{FIXME, essay.info}:
 278 GNU info format for documentation.  FIXME, link broken.
 279
 280 @end itemize
 281 @divEnd
 282 @divEnd
 283
 284
 285 @node Notation
 286 @unnumberedsec Notation
 287
 288 @divClass{column-left-top}
 289 @subheading Notation reference
 290
 291 This book explains all the LilyPond commands which produce
 292 notation.
 293
 294 @warning{The Notation assumes that the reader knows
 295 basic material covered in the Learning and is familiar with
 296 the English musical terms presented in the Musical Glossary.}
 297 @divEnd
 298
 299 @divClass{column-right-top}
 300 @subheading Read it now
 301
 302 @itemize
 303
 304 @item @rusernamed{Top,Notation}:
 305 read this manual in the same format as this one.
 306
 307 @end itemize
 308 @divEnd
 309
 310 @divClass{column-center-bottom}
 311 @subheading Other formats
 312
 313 @divClass{keep-bullets}
 314 @itemize
 315
 316 @item @uref{../notation/index.html, Notation (split HTML)}:
 317 the manual is split between many HTML pages.
 318 @emph{(small download for each page)}
 319
 320 @item @uref{../notation-big-page.html, Notation (big HTML)}:
 321 read this manual as one huge HTML page.
 322 @emph{(large single download, around 10? Mb)}
 323
 324 @item @uref{../notation.pdf, notation.pdf}:
 325 download as a PDF file.
 326 @emph{(large single download, 2.8 Mb)}
 327
 328 @item @uref{FIXME, notation.info}:
 329 GNU info format for documentation.  FIXME, link broken.
 330
 331 @end itemize
 332 @divEnd
 333 @divEnd
 334
 335
 336 @node Usage
 337 @unnumberedsec Usage
 338
 339 @divClass{column-left-top}
 340 @subheading Learning manual
 341
 342 This book explains how to execute the programs, how to integrate
 343 LilyPond notation with other programs, and suggests @qq{best
 344 practices} for efficient use.  It is recommended reading before
 345 attempting any large projects.
 346 @divEnd
 347
 348 @divClass{column-right-top}
 349 @subheading Read it now
 350
 351 @itemize
 352
 353 @item @rprogramnamed{Top,Usage}:
 354 read this manual in the same format as this one.
 355
 356 @end itemize
 357 @divEnd
 358
 359 @divClass{column-center-bottom}
 360 @subheading Other formats
 361
 362 @divClass{keep-bullets}
 363 @itemize
 364
 365 @item @uref{../application/index.html, Usage (split HTML)}:
 366 the manual is split between many HTML pages.
 367 @emph{(small download for each page)}
 368
 369 @item @uref{../application-big-page.html, Usage (big HTML)}:
 370 read this manual as one huge HTML page.
 371 @emph{(large single download, around 10? Mb)}
 372
 373 @item @uref{../application.pdf, application.pdf}:
 374 download as a PDF file.
 375 @emph{(large single download, 2.8 Mb)}
 376
 377 @item @uref{FIXME, application.info}:
 378 GNU info format for documentation.  FIXME, link broken.
 379
 380 @end itemize
 381 @divEnd
 382 @divEnd
 383
 384
 385 @node Snippets
 386 @unnumberedsec Snippets
 387
 388 @divClass{column-left-top}
 389 @subheading Learning manual
 390
 391 This shows a selected set of LilyPond snippets from the
 392 @uref{http://lsr@/.dsi@/.unimi@/.it,LilyPond Snippet Repository}
 393 (LSR).  All the snippets are in the public domain.
 394
 395 Please note that this document is not an exact subset of LSR.  LSR
 396 is running a stable LilyPond version, so any snippet which
 397 demonstrates new features of a development version must be added
 398 separately.  These are stored in @file{input/new/} in the LilyPond
 399 source tree.
 400
 401 The list of snippets for each subsection of the Notation are also
 402 linked from the @strong{See also} portion.
 403 @divEnd
 404
 405 @divClass{column-right-top}
 406 @subheading Read it now
 407
 408 @itemize
 409
 410 @item @rlsrnamed{Top,Snippets}:
 411 read this manual in the same format as this one.
 412
 413 @end itemize
 414 @divEnd
 415
 416 @divClass{column-center-bottom}
 417 @subheading Other formats
 418
 419 @divClass{keep-bullets}
 420 @itemize
 421
 422 @item @uref{../snippets/index.html, Snippets (split HTML)}:
 423 the manual is split between many HTML pages.
 424 @emph{(small download for each page)}
 425
 426 @item @uref{../snippets-big-page.html, Snippets (big HTML)}:
 427 read this manual as one huge HTML page.
 428 @emph{(large single download, around 10? Mb)}
 429
 430 @item @uref{../snippets.pdf, snippets.pdf}:
 431 download as a PDF file.
 432 @emph{(large single download, 2.8 Mb)}
 433
 434 @item @uref{FIXME, snippets.info}:
 435 GNU info format for documentation.  FIXME, link broken.
 436
 437 @end itemize
 438 @divEnd
 439 @divEnd
 440
 441
 442 @node FAQ
 443 @unnumberedsec FAQ
 444
 445 @divClass{column-center-top}
 446 @subheading Introductory questions
 447
 448 @subsubheading Where are the graphical canvas, menus, and toolbars?
 449
 450 LilyPond requires you to write music as text.  Please read about
 451 our @ref{Text input}.
 452
 453
 454 @subsubheading There's a lot of documentation!  Do I need to read it?
 455
 456 You need to read the @ref{Learning, Learning manual}.  As for the
 457 rest of documentation, you only need to read the sections which
 458 discuss the notation that you wish to create.
 459
 460
 461 @subsubheading That's still a lot of reading!  Is it worth it?
 462
 463 Please decide for yourself; the reasons why you might want to use
 464 LilyPond are given in the @ref{Introduction}.
 465
 466 @divEnd
 467
 468 @divClass{column-center-bottom}
 469 @subheading Usage questions
 470
 471 @subsubheading Something isn't working!  How do I fix it?
 472
 473 This is explained in @@ref@{FIXME LM or AU x.y@}.
 474
 475
 476 @subsubheading Why do you change the syntax?
 477
 478 This is explained in @@ref@{FIXME AU x.y@}.
 479
 480 @divEnd
 481
 482
 483 @node Changes
 484 @unnumberedsec Changes
 485
 486 @divClass{column-left-top}
 487 @subheading Learning manual
 488
 489 This is a summary of important changes and new features in
 490 LilyPond since the previous stable version.
 491
 492 @divEnd
 493
 494 @divClass{column-right-top}
 495 @subheading Read it now
 496
 497 @itemize
 498
 499 @item @rchangesnamed{Top,Changes}:
 500 read this manual in the same format as this one.
 501
 502 @end itemize
 503 @divEnd
 504
 505 @divClass{column-center-bottom}
 506 @subheading Other formats
 507
 508 @divClass{keep-bullets}
 509 @itemize
 510
 511 @c Changes isn't available as a split manual.
 512 @c  (maybe it should be, but it isn't so far)
 513 @c @item @uref{../changes/index.html, Changes (split HTML)}:
 514 @c the manual is split between many HTML pages.
 515 @c @emph{(small download for each page)}
 516
 517 @c @item @uref{../changes-big-page.html, Changes (big HTML)}:
 518 @c read this manual as one huge HTML page.
 519 @c @emph{(large single download, around 10? Mb)}
 520
 521 @item @uref{../changes.html, Changes}:
 522 read this manual as a HTML page.
 523
 524 @item @uref{../changes.pdf, changes.pdf}:
 525 download as a PDF file.
 526 @emph{(small single download, 0.5 ?? Mb)}
 527
 528 @item @uref{FIXME, changes.info}:
 529 GNU info format for documentation.  FIXME, link broken.
 530
 531 @end itemize
 532 @divEnd
 533 @divEnd
 534
 535
 536
 537 @node Internals
 538 @unnumberedsec Internals
 539
 540 @divClass{column-left-top}
 541 @subheading Learning manual
 542
 543 This is a set of heavily cross linked HTML pages which document
 544 the nitty-gritty details of each and every LilyPond class, object,
 545 and function.  It is produced directly from the formatting
 546 definitions in the source code.
 547
 548 Almost all formatting functionality that is used internally is
 549 available directly to the user.  For example, most variables that
 550 control thickness values, distances, etc., can be changed in input
 551 files.  There are a huge number of formatting options, and all of
 552 them are described in this document.  Each section of the Notation
 553 Reference has a @b{See also} subsection, which refers to the
 554 generated documentation.  In the HTML document, these subsections
 555 have clickable links.
 556
 557 @divEnd
 558
 559 @divClass{column-right-top}
 560 @subheading Read it now
 561
 562 @itemize
 563
 564 @item @rinternalsnamed{Top,Internals}:
 565 read this manual in the same format as this one.
 566
 567 @end itemize
 568 @divEnd
 569
 570 @divClass{column-center-bottom}
 571 @subheading Other formats
 572
 573 @divClass{keep-bullets}
 574 @itemize
 575
 576 @item @uref{../internals/index.html, Internals (split HTML)}:
 577 the manual is split between many HTML pages.
 578 @emph{(small download for each page)}
 579
 580 @item @uref{../internals-big-page.html, Internals (big HTML)}:
 581 read this manual as one huge HTML page.
 582 @emph{(large single download, around 10? Mb)}
 583
 584 @item @uref{../internals.pdf, internals.pdf}:
 585 download as a PDF file.
 586 @emph{(large single download, 2.8 Mb)}
 587
 588 @item @uref{FIXME, internals.info}:
 589 GNU info format for documentation.  FIXME, link broken.
 590
 591 @end itemize
 592 @divEnd
 593 @divEnd
 594
 595
 596
 597 @node Translated
 598 @unnumberedsec Translated
 599
 600 @divClass{column-center-bottom}
 601 @subheading Translation status
 602
 603 TODO: clean up / prettify
 604
 605 @uref{../translations.html}.
 606
 607 @divEnd
 608
 609
 610 @node All
 611 @unnumberedsec All
 612
 613 @divClass{column-left-top}
 614 @subheading Downloadable versions
 615
 616 FIXME: compare tarball vs. zip size, ask about windows users
 617 dealing with tarballs (both gz and bz2), etc.
 618
 619 @divClass{keep-bullets}
 620 @itemize
 621
 622 @item html-split zip
 623
 624 @item html-big zip
 625
 626 @item pdf zip
 627
 628 @item info zip maybe?!?!
 629
 630 @end itemize
 631
 632 @divEnd
 633 @divEnd
 634
 635 @divClass{column-right-top}
 636 @subheading Previous stable versions
 637
 638 @divClass{keep-bullets}
 639 @itemize
 640
 641 @item @uref{http://lilypond.org/doc/v2.12/Documentation/,
 642 LilyPond 2.12 Documentation}
 643
 644 @item @uref{http://lilypond.org/doc/v2.10/Documentation/,
 645 LilyPond 2.10 Documentation}
 646
 647 @item @uref{http://lilypond.org/doc/v2.8/Documentation/,
 648 LilyPond 2.8 Documentation}
 649
 650 @item FIXME etc.
 651
 652 @end itemize
 653
 654 @divEnd
 655 @divEnd
 656
 657
 658 @node FDL
 659 @unnumberedsec FDL
 660
 661 @divClass{column-center-top}
 662 @subheading Documentation license
 663
 664 The documentation for GNU LilyPond is published under the GNU Free
 665 Documentation License.  An introduction to this license, and our
 666 reasons for choosing it, is given in @ref{Freedom}.
 667
 668 @divEnd
 669
 670 @divClass{column-center-bottom}
 671 @subheading GNU Free Documentation License 1.1
 672
 673 @include fdl.itexi
 674
 675 @divEnd
 676
 677