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