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