Documentation/web/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.  For details, see the Contributors'
   7     Guide, node Updating translation committishes..
   8 @end ignore
   9
  10 @node Manuals
  11 @unnumbered Manuals
  12
  13 @macro details{reference}
  14 @spanClass{detail}
  15 (@ref{\reference\, details of \reference\})
  16 @spanEnd
  17 @end macro
  18
  19 @divClass{heading-center}
  20 @ifclear web_version
  21   @heading Manuals for LilyPond @version
  22 @end ifclear
  23 @ifset web_version
  24   @heading Manuals for LilyPond @versionStable
  25 @end ifset
  26
  27 @divEnd
  28
  29 @divClass{link-headings}
  30
  31 @divClass{column-center-top}
  32 @subheading Introduction
  33
  34 @itemize
  35
  36 @item
  37 @ref{Text input}:
  38 LilyPond is a @strong{text-based} music engraver.  Read this first!
  39
  40 @item
  41 @ifWebLinks{@manualStableLearningSplitNoName,@rlearningnamed{Top,Learning}}
  42 a @qq{must-read} gentle introduction to LilyPond.
  43 @details{Learning}
  44
  45 @item
  46 @ifWebLinks{@manualStableGlossarySplitNoName,@rglosnamed{Top,Glossary}}
  47 @emph{(optional reading)} musical terms and translations.
  48 @details{Glossary}
  49
  50 @item
  51 @ifWebLinks{@manualStableEssaySplitNoName,@ressaynamed{Top,Essay}}
  52 @emph{(optional reading)} background information about computer engraving.
  53 @details{Essay}
  54
  55 @end itemize
  56
  57 @divEnd
  58
  59 @divClass{column-left-top}
  60 @subheading Regular use
  61
  62 @itemize
  63
  64 @item
  65 @ifWebLinks{@manualStableNotationSplitNoName,@rusernamed{Top,Notation}}
  66 syntax reference.
  67 @details{Notation}
  68
  69 @item
  70 @ifWebLinks{@manualStableUsageSplitNoName,@rprogramnamed{Top,Usage}}
  71 running the programs.
  72 @details{Usage}
  73
  74 @item
  75 @ifWebLinks{@manualStableSnippetsSplitNoName,@rlsrnamed{Top,Snippets}}
  76 short tricks and tips.
  77 @details{Snippets}
  78
  79 @end itemize
  80
  81 @divEnd
  82
  83
  84 @divClass{column-right-top}
  85 @subheading Infrequent Use
  86
  87 @itemize
  88
  89 @item
  90 @ref{FAQ}:
  91 Frequently Asked Questions.
  92
  93 @item
  94 @ref{Top, Web}:
  95 this document.
  96 @details{Web}
  97
  98 @item
  99 @ifWebLinks{@manualStableChangesSplitNoName,@rchangesnamed{Top,Changes}}
 100 what's new?
 101 @details{Changes}
 102
 103 @item
 104 @ifWebLinks{@manualStableExtendingSplitNoName,@rextendnamed{Top,Extending}}
 105 fancy tweaks.
 106 @details{Extending}
 107
 108 @item
 109 @ifWebLinks{@manualStableInternalsSplitNoName,@rinternalsnamed{Top,Internals}}
 110 tweaks reference.
 111 @details{Internals}
 112
 113 @end itemize
 114
 115 @divEnd
 116
 117
 118 @divClass{column-center-bottom}
 119 @subheading Other material
 120
 121 @itemize
 122
 123 @item
 124 @ref{All}:
 125 previous stable versions and current as a compressed archive.
 126
 127 @item
 128 @ref{Translated}:
 129 translation status for non-English readers.
 130
 131 @item
 132 @uref{http://lsr@/.di@/.unimi@/.it,LilyPond Snippet Repository}:
 133 user-created examples, hints and tips.
 134
 135 @item
 136 @uref{http://benlemon.me/blog/music/lilypond/operation-lilypond/,Video Tutorials}:
 137 Ben Lemon, a LilyPond user, has created a range of video tutorials on
 138 his blog and which are aimed at new users.
 139
 140 @item
 141 @ref{Development}:
 142 manuals for the unstable version.
 143
 144 @item
 145 @ref{FDL}:
 146 these manuals are published under the GNU Free Documentation License.
 147
 148 @end itemize
 149
 150 @divEnd
 151
 152 @divClass{column-center-bottom}
 153 @subheading Manual formats
 154
 155 The LilyPond manuals generally come in three formats: split HTML, big HTML and
 156 PDF.  Split HTML is good for reading online.  Big HTML (and some of these can be
 157 very big) contains the whole manual in a single page.  PDF is available for
 158 downloading and using offline.  To get to these 3 formats, follow the links
 159 that read @code{details of} and then the manual name.
 160
 161 @divEnd
 162
 163 @divEnd
 164
 165
 166 @divClass{hide}
 167 @menu
 168 * Learning::             Learning.
 169 * Glossary::              Glossary.
 170 * Essay::                       Essay.
 171 * Notation::          Reference.
 172 * Usage::           Usage.
 173 * Snippets::                Snippets.
 174 * FAQ::                         FAQ.
 175 * Web::                      Web.
 176 * Changes::                     NEWS.
 177 * Extending::         Programming.
 178 * Internals::         Internals.
 179 * Translated::          Translation.
 180 * All::                 All manuals.
 181 * FDL::                     Licence.
 182 @end menu
 183
 184 @divEnd
 185
 186
 187 @c TRANSLATORS, most of the text in this file came from
 188 @c LM 1.1 About the documentation  (before this section was
 189 @c removed in July 2009).
 190
 191 @node Learning
 192 @unnumberedsec Learning
 193
 194 @divClass{column-left-top}
 195 @subheading Learning manual
 196
 197 This book explains how to begin learning LilyPond, as well as
 198 explaining some key concepts in easy terms.  You should read these
 199 chapters in a linear fashion.
 200
 201 There is a paragraph @strong{See also} at the end of each section,
 202 which contains cross-references to other sections: you should not
 203 follow these cross-references at first reading.  When you have
 204 read all of the manual, you may want to read some sections again
 205 and follow those cross-references for more information.
 206 @divEnd
 207
 208 @divClass{column-right-bottom}
 209
 210 @docLinks{Learning, learning,
 211   @rlearningnamed{Top,Learning},
 212   @manualStableLearningSplit,
 213   @manualStableLearningBig, 3 MB,
 214   @manualStableLearningPdf, 5 MB}
 215
 216 @divEnd
 217
 218
 219 @node Glossary
 220 @unnumberedsec Glossary
 221
 222 @divClass{column-left-top}
 223 @subheading Glossary
 224
 225 This explains musical terms, and includes translations to various
 226 languages.  If you are not familiar with music notation or music
 227 terminology (especially if you are a non-native English speaker),
 228 it is highly advisable to consult the glossary.
 229
 230 @divEnd
 231
 232 @divClass{column-right-bottom}
 233
 234 @docLinks{Music glossary, music-glossary,
 235   @rglosnamed{Top,Music glossary},
 236   @manualStableGlossarySplit,
 237   @manualStableGlossaryBig, 1 MB,
 238   @manualStableGlossaryPdf, 1.5 MB}
 239
 240 @divEnd
 241
 242
 243 @node Essay
 244 @unnumberedsec Essay
 245
 246 @divClass{column-left-top}
 247 @subheading Essay
 248
 249 This book gives a brief history of music typography, followed by
 250 an examination of LilyPond's engraving techniques.  A comparison
 251 between LilyPond and other music engraving systems is given.
 252
 253 @warning{the detailed typographical examples are easier to analyze
 254 in the PDF version due to its higher resolution.}
 255
 256 @divEnd
 257
 258 @divClass{column-right-bottom}
 259
 260 @docLinks{Essay, essay,
 261   @ressaynamed{Top,Essay},
 262   @manualStableEssaySplit,
 263   @manualStableEssayBig, 1 MB,
 264   @manualStableEssayPdf, 2 MB}
 265
 266 @divEnd
 267
 268
 269 @node Notation
 270 @unnumberedsec Notation
 271
 272 @divClass{column-left-top}
 273 @subheading Notation reference
 274
 275 This book explains all the LilyPond commands which produce
 276 notation.
 277
 278 @warning{the Notation reference assumes that the reader knows
 279 basic material covered in the Learning manual and is familiar with
 280 the English musical terms presented in the glossary.}
 281
 282 @divEnd
 283
 284 @divClass{column-right-bottom}
 285
 286 @docLinks{Notation, notation,
 287   @rusernamed{Top,Notation},
 288   @manualStableNotationSplit,
 289   @manualStableNotationBig, 9 MB,
 290   @manualStableNotationPdf, 35 MB}
 291
 292 @divEnd
 293
 294
 295 @node Usage
 296 @unnumberedsec Usage
 297
 298 @divClass{column-left-top}
 299 @subheading Usage manual
 300
 301 This book explains how to execute the programs, how to integrate
 302 LilyPond notation with other programs, and suggests @qq{best
 303 practices} for efficient use.  It is recommended reading before
 304 attempting any large projects.
 305
 306 @divEnd
 307
 308 @divClass{column-right-bottom}
 309
 310 @docLinks{Usage, usage,
 311   @rprogramnamed{Top,Usage},
 312   @manualStableUsageSplit,
 313   @manualStableUsageBig, 400 KB,
 314   @manualStableUsagePdf, 650 KB}
 315
 316 @divEnd
 317
 318
 319 @node Snippets
 320 @unnumberedsec Snippets
 321
 322 @divClass{column-left-top}
 323 @subheading Snippets
 324
 325 This shows a selected set of LilyPond snippets from the
 326 @uref{http://lsr@/.di@/.unimi@/.it,LilyPond Snippet Repository}
 327 (LSR).  All the snippets are in the public domain.
 328
 329 Please note that this document is not an exact subset of LSR.  LSR
 330 is running a stable LilyPond version, so any snippet which
 331 demonstrates new features of a development version must be added
 332 separately.  These are stored in @file{Documentation/snippets/new/} in the LilyPond
 333 source tree.
 334
 335 The list of snippets for each subsection of the Notation are also
 336 linked from the @strong{See also} portion.
 337 @divEnd
 338
 339 @divClass{column-right-bottom}
 340
 341 @docLinks{Snippets, snippets,
 342   @rlsrnamed{Top,Snippets},
 343   @manualStableSnippetsSplit,
 344   @manualStableSnippetsBig, 1.5 MB,
 345   @manualStableSnippetsPdf, 12.5 MB}
 346
 347 @divEnd
 348
 349
 350 @node FAQ
 351 @unnumberedsec FAQ
 352
 353 @divClass{column-center-top}
 354 @subheading Introductory questions
 355
 356 @subsubheading Where are the graphical canvas, menus, and toolbars?
 357
 358 LilyPond requires you to write music as text.  Please read about
 359 our @ref{Text input}.
 360
 361
 362 @subsubheading There's a lot of documentation!  Do I need to read it?
 363
 364 You need to read the @ref{Learning, Learning manual}.  As for the
 365 rest of documentation, you only need to read the sections which
 366 discuss the notation that you wish to create.
 367
 368
 369 @subsubheading That's still a lot of reading!  Is it worth it?
 370
 371 Please decide for yourself; the reasons why you might want to use
 372 LilyPond are given in the @ref{Introduction}.
 373
 374 @divEnd
 375
 376 @divClass{column-center-bottom}
 377 @subheading Usage questions
 378
 379 @subsubheading Something isn't working!  How do I fix it?
 380
 381 This is explained in @rprogram{Troubleshooting}.
 382
 383
 384 @subsubheading Why do you change the syntax?
 385
 386 This is explained in @rprogram{Why does the syntax change?}.
 387
 388 @divEnd
 389
 390
 391 @node Web
 392 @unnumberedsec Web
 393
 394 @divClass{column-left-top}
 395 @subheading Web
 396
 397 This manual supplies general information about LilyPond.  It also
 398 contains information about various community forums, bug
 399 reporting, and development.
 400
 401 @divEnd
 402
 403 @divClass{column-right-bottom}
 404 @subheading Read it
 405
 406 @subsubheading Latest manual
 407
 408 @divClass{keep-bullets}
 409 @itemize
 410 @ref{Top,Web}
 411 @end itemize
 412 @divEnd
 413
 414 @subsubheading Web manual in @versionDevel
 415
 416 @docLinksBare{Web, web,
 417   @ref{Top,Web},
 418   @manualDevelWebSplit,
 419   @manualDevelWebBig, 2.5 MB,
 420   @manualDevelWebPdf, 3.5 MB}
 421
 422 @divEnd
 423
 424
 425 @node Changes
 426 @unnumberedsec Changes
 427
 428 @divClass{column-left-top}
 429 @subheading Changes
 430
 431 This is a summary of important changes and new features in
 432 LilyPond since the previous stable version.
 433
 434 @divEnd
 435
 436 @divClass{column-right-bottom}
 437
 438 @docLinks{Changes, changes,
 439   @rchangesnamed{Top,Changes},
 440   @manualStableChangesSplit,
 441   @manualStableChangesBig, 90 KB,
 442   @manualStableChangesPdf, 80 KB}
 443
 444 @divEnd
 445
 446
 447 @node Extending
 448 @unnumberedsec Extending
 449
 450 @divClass{column-left-top}
 451 @subheading Extending LilyPond
 452
 453 This manual explains how to write extensions to LilyPond.
 454
 455 @divEnd
 456
 457 @divClass{column-right-bottom}
 458
 459 @docLinks{Extending, extending,
 460   @rextendnamed{Top,Extending},
 461   @manualStableExtendingSplit,
 462   @manualStableExtendingBig, 300 KB,
 463   @manualStableExtendingPdf, 500 KB}
 464
 465 @divEnd
 466
 467
 468 @node Internals
 469 @unnumberedsec Internals
 470
 471 @divClass{column-left-top}
 472 @subheading Internals reference
 473
 474 This is a set of heavily cross linked pages which document
 475 the nitty-gritty details of each and every LilyPond class, object,
 476 and function.  It is produced directly from the formatting
 477 definitions in the source code.
 478
 479 Almost all formatting functionality that is used internally is
 480 available directly to the user.  For example, most variables that
 481 control thickness values, distances, etc., can be changed in input
 482 files.  There are a huge number of formatting options, and all of
 483 them are described in this document.  Each section of the Notation
 484 Reference has a @b{See also} subsection, which refers to the
 485 generated documentation.
 486
 487 @divEnd
 488
 489 @divClass{column-right-bottom}
 490
 491 @docLinks{Internals, internals,
 492   @rinternalsnamed{Top,Internals},
 493   @manualStableInternalsSplit,
 494   @manualStableInternalsBig, 3 MB,
 495   @manualStableInternalsPdf, 4 MB}
 496
 497 @divEnd
 498
 499
 500 @node Translated
 501 @unnumberedsec Translated
 502
 503 @divClass{column-center-bottom}
 504 @subheading Translations status
 505
 506 @include translations.itexi
 507
 508 @divEnd
 509
 510
 511 @node All
 512 @unnumberedsec All
 513
 514 @divClass{column-left-top}
 515 @subheading Downloadable versions
 516
 517 @ifclear web_version
 518 Downloadable tarballs only available at @uref{http://lilypond.org}
 519 @end ifclear
 520 @ifset web_version
 521
 522 @divClass{keep-bullets}
 523 @itemize
 524
 525 @item @doctarballStable
 526
 527 @end itemize
 528
 529 @divEnd
 530 @end ifset
 531
 532 @divEnd
 533
 534 @divClass{column-right-bottom}
 535 @subheading Previous stable versions
 536
 537 @divClass{keep-bullets}
 538 @itemize
 539
 540 @item @uref{http://lilypond.org/doc/v2.16/Documentation/web/manuals,
 541 LilyPond 2.16 Documentation}
 542
 543 @item @uref{http://lilypond.org/doc/v2.14/Documentation/web/manuals,
 544 LilyPond 2.14 Documentation}
 545
 546 @item @uref{http://lilypond.org/doc/v2.12/Documentation/,
 547 LilyPond 2.12 Documentation}
 548
 549 @item @uref{http://lilypond.org/doc/v2.10/Documentation/,
 550 LilyPond 2.10 Documentation}
 551
 552 @item @uref{http://lilypond.org/doc/v2.8/Documentation/,
 553 LilyPond 2.8 Documentation}
 554
 555 @item @uref{http://lilypond.org/doc/v2.6/Documentation/,
 556 LilyPond 2.6 Documentation}
 557
 558 @item @uref{http://lilypond.org/doc/v2.4/Documentation/out-www/,
 559 LilyPond 2.4 Documentation}
 560
 561 @item @uref{http://lilypond.org/doc/v2.2/Documentation/out-www/,
 562 LilyPond 2.2 Documentation}
 563
 564 @item @uref{http://lilypond.org/doc/v2.0/Documentation/out-www/,
 565 LilyPond 2.0 Documentation}
 566
 567 @item @uref{http://lilypond.org/doc/v1.8/Documentation/out-www/,
 568 LilyPond 1.8 Documentation}
 569
 570 @item @uref{http://lilypond.org/doc/v1.6/Documentation/out-www/,
 571 LilyPond 1.6 Documentation}
 572
 573 @end itemize
 574
 575 @divEnd
 576 @divEnd
 577
 578
 579 @node FDL
 580 @unnumberedsec FDL
 581
 582 @divClass{column-center-top}
 583 @subheading Documentation license
 584
 585 The documentation for GNU LilyPond is published under the GNU Free
 586 Documentation License.  An introduction to this license, and our
 587 reasons for choosing it, is given in @ref{Freedom}.
 588
 589 @divEnd
 590
 591 @divClass{column-center-bottom}
 592 @subheading GNU Free Documentation License 1.1
 593
 594 @include fdl.itexi
 595
 596 @divEnd