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