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