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