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