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