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 @version
  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 basic material
 295 covered in the Learning manual and is familiar with the English musical
 296 terms presented in the Musical Glossary.}
 297
 298 @divEnd
 299
 300 @divClass{column-right-top}
 301 @subheading Read it now
 302
 303 @itemize
 304
 305 @item @rusernamed{Top,Notation}:
 306 read this manual in the same format as this one.
 307
 308 @end itemize
 309 @divEnd
 310
 311 @divClass{column-center-bottom}
 312 @subheading Other formats
 313
 314 @divClass{keep-bullets}
 315 @itemize
 316
 317 @item @uref{../notation/index.html, Notation (split HTML)}:
 318 the manual is split between many HTML pages.
 319 @emph{(small download for each page)}
 320
 321 @item @uref{../notation-big-page.html, Notation (big HTML)}:
 322 read this manual as one huge HTML page.
 323 @emph{(large single download, around 10? Mb)}
 324
 325 @item @uref{../notation.pdf, notation.pdf}:
 326 download as a PDF file.
 327 @emph{(large single download, 2.8 Mb)}
 328
 329 @item @uref{FIXME, notation.info}:
 330 GNU info format for documentation.  FIXME, link broken.
 331
 332 @end itemize
 333 @divEnd
 334 @divEnd
 335
 336
 337 @node Usage
 338 @unnumberedsec Usage
 339
 340 @divClass{column-left-top}
 341 @subheading Usage manual
 342
 343 This book explains how to execute the programs, how to integrate
 344 LilyPond notation with other programs, and suggests @qq{best
 345 practices} for efficient use.  It is recommended reading before
 346 attempting any large projects.
 347 @divEnd
 348
 349 @divClass{column-right-top}
 350 @subheading Read it now
 351
 352 @itemize
 353
 354 @item @rprogramnamed{Top,Usage}:
 355 read this manual in the same format as this one.
 356
 357 @end itemize
 358 @divEnd
 359
 360 @divClass{column-center-bottom}
 361 @subheading Other formats
 362
 363 @divClass{keep-bullets}
 364 @itemize
 365
 366 @item @uref{../usage/index.html, Usage (split HTML)}:
 367 the manual is split between many HTML pages.
 368 @emph{(small download for each page)}
 369
 370 @item @uref{../usage-big-page.html, Usage (big HTML)}:
 371 read this manual as one huge HTML page.
 372 @emph{(large single download, around 10? Mb)}
 373
 374 @item @uref{../usage.pdf, usage.pdf}:
 375 download as a PDF file.
 376 @emph{(large single download, 2.8 Mb)}
 377
 378 @item @uref{FIXME, lilypond-usage.info}:
 379 GNU info format for documentation.  FIXME, link broken.
 380
 381 @end itemize
 382 @divEnd
 383 @divEnd
 384
 385
 386 @node Snippets
 387 @unnumberedsec Snippets
 388
 389 @divClass{column-left-top}
 390 @subheading Snippets
 391
 392 This shows a selected set of LilyPond snippets from the
 393 @uref{http://lsr@/.dsi@/.unimi@/.it,LilyPond Snippet Repository}
 394 (LSR).  All the snippets are in the public domain.
 395
 396 Please note that this document is not an exact subset of LSR.  LSR
 397 is running a stable LilyPond version, so any snippet which
 398 demonstrates new features of a development version must be added
 399 separately.  These are stored in @file{input/new/} in the LilyPond
 400 source tree.
 401
 402 The list of snippets for each subsection of the Notation are also
 403 linked from the @strong{See also} portion.
 404 @divEnd
 405
 406 @divClass{column-right-top}
 407 @subheading Read it now
 408
 409 @itemize
 410
 411 @item @rlsrnamed{Top,Snippets}:
 412 read this manual in the same format as this one.
 413
 414 @end itemize
 415 @divEnd
 416
 417 @divClass{column-center-bottom}
 418 @subheading Other formats
 419
 420 @divClass{keep-bullets}
 421 @itemize
 422
 423 @item @uref{../snippets/index.html, Snippets (split HTML)}:
 424 the manual is split between many HTML pages.
 425 @emph{(small download for each page)}
 426
 427 @item @uref{../snippets-big-page.html, Snippets (big HTML)}:
 428 read this manual as one huge HTML page.
 429 @emph{(large single download, around 10? Mb)}
 430
 431 @item @uref{../snippets.pdf, snippets.pdf}:
 432 download as a PDF file.
 433 @emph{(large single download, 2.8 Mb)}
 434
 435 @item @uref{FIXME, snippets.info}:
 436 GNU info format for documentation.  FIXME, link broken.
 437
 438 @end itemize
 439 @divEnd
 440 @divEnd
 441
 442
 443 @node FAQ
 444 @unnumberedsec FAQ
 445
 446 @divClass{column-center-top}
 447 @subheading Introductory questions
 448
 449 @subsubheading Where are the graphical canvas, menus, and toolbars?
 450
 451 LilyPond requires you to write music as text.  Please read about
 452 our @ref{Text input}.
 453
 454
 455 @subsubheading There's a lot of documentation!  Do I need to read it?
 456
 457 You need to read the @ref{Learning, Learning manual}.  As for the
 458 rest of documentation, you only need to read the sections which
 459 discuss the notation that you wish to create.
 460
 461
 462 @subsubheading That's still a lot of reading!  Is it worth it?
 463
 464 Please decide for yourself; the reasons why you might want to use
 465 LilyPond are given in the @ref{Introduction}.
 466
 467 @divEnd
 468
 469 @divClass{column-center-bottom}
 470 @subheading Usage questions
 471
 472 @subsubheading Something isn't working!  How do I fix it?
 473
 474 This is explained in @rprogram{Troubleshooting}.
 475
 476
 477 @subsubheading Why do you change the syntax?
 478
 479 This is explained in @rprogram{Why does the syntax change?}.
 480
 481 @divEnd
 482
 483
 484 @node Changes
 485 @unnumberedsec Changes
 486
 487 @divClass{column-left-top}
 488 @subheading Changes
 489
 490 This is a summary of important changes and new features in
 491 LilyPond since the previous stable version.
 492
 493 @divEnd
 494
 495 @divClass{column-right-top}
 496 @subheading Read it now
 497
 498 @itemize
 499
 500 @item @rchangesnamed{Top,Changes}:
 501 read this manual in the same format as this one.
 502
 503 @end itemize
 504 @divEnd
 505
 506 @divClass{column-center-bottom}
 507 @subheading Other formats
 508
 509 @divClass{keep-bullets}
 510 @itemize
 511
 512 @c Changes isn't available as a split manual.
 513 @c  (maybe it should be, but it isn't so far)
 514 @c @item @uref{../changes/index.html, Changes (split HTML)}:
 515 @c the manual is split between many HTML pages.
 516 @c @emph{(small download for each page)}
 517
 518 @c @item @uref{../changes-big-page.html, Changes (big HTML)}:
 519 @c read this manual as one huge HTML page.
 520 @c @emph{(large single download, around 10? Mb)}
 521
 522 @item @uref{../changes.html, Changes}:
 523 read this manual as a HTML page.
 524
 525 @item @uref{../changes.pdf, changes.pdf}:
 526 download as a PDF file.
 527 @emph{(small single download, 0.5 ?? Mb)}
 528
 529 @item @uref{FIXME, changes.info}:
 530 GNU info format for documentation.  FIXME, link broken.
 531
 532 @end itemize
 533 @divEnd
 534 @divEnd
 535
 536
 537
 538 @node Internals
 539 @unnumberedsec Internals
 540
 541 @divClass{column-left-top}
 542 @subheading Internals reference
 543
 544 This is a set of heavily cross linked HTML pages which document
 545 the nitty-gritty details of each and every LilyPond class, object,
 546 and function.  It is produced directly from the formatting
 547 definitions in the source code.
 548
 549 Almost all formatting functionality that is used internally is
 550 available directly to the user.  For example, most variables that
 551 control thickness values, distances, etc., can be changed in input
 552 files.  There are a huge number of formatting options, and all of
 553 them are described in this document.  Each section of the Notation
 554 Reference has a @b{See also} subsection, which refers to the
 555 generated documentation.  In the HTML document, these subsections
 556 have clickable links.
 557
 558 @divEnd
 559
 560 @divClass{column-right-top}
 561 @subheading Read it now
 562
 563 @itemize
 564
 565 @item @rinternalsnamed{Top,Internals}:
 566 read this manual in the same format as this one.
 567
 568 @end itemize
 569 @divEnd
 570
 571 @divClass{column-center-bottom}
 572 @subheading Other formats
 573
 574 @divClass{keep-bullets}
 575 @itemize
 576
 577 @item @uref{../internals/index.html, Internals (split HTML)}:
 578 the manual is split between many HTML pages.
 579 @emph{(small download for each page)}
 580
 581 @item @uref{../internals-big-page.html, Internals (big HTML)}:
 582 read this manual as one huge HTML page.
 583 @emph{(large single download, around 10? Mb)}
 584
 585 @item @uref{../internals.pdf, internals.pdf}:
 586 download as a PDF file.
 587 @emph{(large single download, 2.8 Mb)}
 588
 589 @item @uref{FIXME, internals.info}:
 590 GNU info format for documentation.  FIXME, link broken.
 591
 592 @end itemize
 593 @divEnd
 594 @divEnd
 595
 596
 597
 598 @node Translated
 599 @unnumberedsec Translated
 600
 601 @divClass{column-center-bottom}
 602 @subheading Translation status
 603
 604 TODO: clean up / prettify
 605
 606 @uref{../translations.html}.
 607
 608 @divEnd
 609
 610
 611 @node All
 612 @unnumberedsec All
 613
 614 @divClass{column-left-top}
 615 @subheading Downloadable versions
 616
 617 FIXME: compare tarball vs. zip size, ask about windows users
 618 dealing with tarballs (both gz and bz2), etc.
 619
 620 @divClass{keep-bullets}
 621 @itemize
 622
 623 @item html-split zip
 624
 625 @item html-big zip
 626
 627 @item pdf zip
 628
 629 @item info zip maybe?!?!
 630
 631 @end itemize
 632
 633 @divEnd
 634 @divEnd
 635
 636 @divClass{column-right-top}
 637 @subheading Previous stable versions
 638
 639 @divClass{keep-bullets}
 640 @itemize
 641
 642 @item @uref{http://lilypond.org/doc/v2.12/Documentation/,
 643 LilyPond 2.12 Documentation}
 644
 645 @item @uref{http://lilypond.org/doc/v2.10/Documentation/,
 646 LilyPond 2.10 Documentation}
 647
 648 @item @uref{http://lilypond.org/doc/v2.8/Documentation/,
 649 LilyPond 2.8 Documentation}
 650
 651 @item FIXME etc.
 652
 653 @end itemize
 654
 655 @divEnd
 656 @divEnd
 657
 658
 659 @node FDL
 660 @unnumberedsec FDL
 661
 662 @divClass{column-center-top}
 663 @subheading Documentation license
 664
 665 The documentation for GNU LilyPond is published under the GNU Free
 666 Documentation License.  An introduction to this license, and our
 667 reasons for choosing it, is given in @ref{Freedom}.
 668
 669 @divEnd
 670
 671 @divClass{column-center-bottom}
 672 @subheading GNU Free Documentation License 1.1
 673
 674 @include fdl.itexi
 675
 676 @divEnd
 677
 678