Documentation/general/community.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 Community
  10 @unnumbered Community
  11
  12
  13 @divClass{column-center-top}
  14 @subheading Interacting with the community
  15
  16 @itemize
  17
  18 @item
  19 @ref{Contact}: get help, discuss, and keep in touch!
  20
  21 @item
  22 @ref{Tiny examples}: these are @emph{highly} recommended when
  23 discussing LilyPond.
  24
  25 @item
  26 @ref{Bug reports}: something went wrong.
  27
  28 @end itemize
  29 @divEnd
  30
  31 @divClass{column-left-bottom}
  32 @subheading Making LilyPond better
  33
  34 @itemize
  35
  36 @item
  37 @ref{Help us}: your assistance is requested.
  38
  39 @item
  40 @ref{Development}: for contributors and testers.
  41
  42 @item
  43 @ref{Authors}: the people who made LilyPond what it is today.
  44
  45 @end itemize
  46 @divEnd
  47
  48 @divClass{column-right-bottom}
  49 @subheading Miscellaneous
  50
  51 @itemize
  52
  53 @item
  54 @ref{Publications}: what we wrote, and have had written about us.
  55
  56 @item
  57 @ref{Old news}: an archive.
  58
  59 @end itemize
  60 @divEnd
  61
  62
  63 @divClass{hide}
  64 @menu
  65 * Contact::
  66 * Tiny examples::
  67 * Bug reports::
  68 * Help us::
  69 * Development::
  70 * Authors::
  71 * Publications::
  72 * Old news::
  73 @end menu
  74 @divEnd
  75
  76
  77 @node Contact
  78 @unnumberedsec Contact
  79
  80
  81 @divClass{column-left-bottom}
  82 @subheading User Discussions and Help
  83
  84 @subsubheading User mailing list: @code{lilypond-user@@gnu.org}
  85
  86 This mailing list is the main place for users to discuss and help
  87 each other.
  88
  89 @quotation
  90 @uref{http://mail.gnu.org/mailman/listinfo/lilypond-user,
  91 lilypond-user subscribe and info}
  92
  93 @uref{http://mail.gnu.org/archive/html/lilypond-user/,
  94 user archive1}
  95 @uref{http://www.mail-archive.com/lilypond-user@@gnu.org/,
  96 archive2}
  97 @uref{http://dir.gmane.org/gmane.comp.gnu.lilypond.general,
  98 archive3}
  99
 100 @uref{http://post.gmane.org/post.php?group=gmane.comp.gnu.lilypond.general,
 101 send to lilypond-user with gmane}
 102 @end quotation
 103
 104 @warning{When asking questions, please use @ref{Tiny examples}!}
 105
 106
 107 @subsubheading IRC
 108
 109 Some level of support is provided on our IRC channel,
 110
 111 @example
 112 @uref{irc://irc.freenode.net/lilypond, #lilypond@@irc.freenode.net}
 113 @end example
 114
 115 This channel has no public archive, so any question that may
 116 be useful for others would better be posted to one of the mailing lists.
 117
 118
 119 @subsubheading Other languages
 120
 121 @quotation
 122 @uref{http://es.groups.yahoo.com/group/lilypond-es,
 123 Spanish yahoo group}
 124
 125 @uref{http://www.lilypondforum.de/,
 126 German forum}
 127
 128 @uref{http://groups.google.com/group/lilypond-brasil,
 129 Portugese group}
 130
 131 @uref{http://lists.gnu.org/mailman/listinfo/lilypond-user-fr,
 132 French mailing list}
 133
 134 @uref{http://www.lilypondforum.nl/,
 135 Dutch forum}
 136 @end quotation
 137
 138 @divEnd
 139
 140
 141 @divClass{column-right-top}
 142 @subheading Stay Informed
 143
 144 @subsubheading LilyPond Report
 145
 146 The easiest way to keep touch is by reading our community
 147 newsletter, the @uref{http://news.lilynet.net/, LilyPond Report}.
 148
 149 @subsubheading Releases mailing list: @code{info-lilypond@@gnu.org}
 150
 151 This mailing list is a low-volume, read-only list which receives
 152 notifications of new releases.
 153
 154 @quotation
 155 @uref{http://lists.gnu.org/mailman/listinfo/info-lilypond,
 156 info-lilypond subscribe and info}
 157
 158 @uref{http://mail.gnu.org/archive/html/info-lilypond/,
 159 info archive1}
 160 @uref{http://www.mail-archive.com/info-lilypond@@gnu.org/,
 161 archive2}
 162 @uref{http://dir.gmane.org/gmane.comp.gnu.lilypond.announce,
 163 archive3}
 164
 165 @c don't include gmane posting here.  -gp
 166 @end quotation
 167
 168
 169 @divEnd
 170
 171
 172 @divClass{column-right-bottom}
 173 @subheading Developer Discussion
 174
 175 @subsubheading Developer mailing list: @code{lilypond-devel@@gnu.org}
 176
 177 Most developer discussion takes place on this list.  Patches
 178 should be sent here.
 179
 180 @quotation
 181 @uref{http://mail.gnu.org/mailman/listinfo/lilypond-devel,
 182 lilypond-devel subscribe and info}
 183
 184 @uref{http://mail.gnu.org/archive/html/lilypond-devel/,
 185 devel archive1}
 186 @uref{http://www.mail-archive.com/lilypond-devel@@gnu.org/,
 187 archive2}
 188 @uref{http://dir.gmane.org/gmane.comp.gnu.lilypond.devel,
 189 archive3}
 190
 191 @uref{http://post.gmane.org/post.php?group=gmane.comp.gnu.lilypond.devel,
 192 send to lilypond-devel with gmane}
 193 @end quotation
 194
 195
 196 @subsubheading Bug mailing list: @code{bug-lilypond@@gnu.org}
 197
 198 Bug-specific discussion takes place here.
 199
 200 @quotation
 201 @uref{http://mail.gnu.org/mailman/listinfo/bug-lilypond,
 202 bug-lilypond subscribe and info}
 203
 204 @uref{http://mail.gnu.org/archive/html/bug-lilypond/,
 205 bug archive1}
 206 @uref{http://www.mail-archive.com/bug-lilypond@@gnu.org/,
 207 archive2}
 208 @uref{http://dir.gmane.org/gmane.comp.gnu.lilypond.bugs,
 209 archive3}
 210
 211 @c don't include gmane posting here.  -gp
 212 @end quotation
 213
 214 @warning{Before sending a message to the bug list, please read our
 215 guidelines for @ref{Bug reports}.}
 216
 217 @divEnd
 218
 219
 220
 221 @node Tiny examples
 222 @unnumberedsec Tiny examples
 223
 224 @divClass{column-center-top}
 225 @subheading What are @qq{Tiny examples}?
 226
 227 A tiny example is an example from which nothing can be removed.
 228 @divEnd
 229
 230 @divClass{column-left-bottom}
 231 @subheading Why create them?
 232
 233 @divClass{keep-bullets}
 234 @itemize
 235
 236 @item
 237 The simpler the example is, the quicker potential helpers can
 238 understand it and help you.
 239
 240 @item
 241 A simple example demonstrates that you have put effort towards
 242 solving the problem yourself.  When people send huge portions of
 243 input, it looks like they don't care how if we help them or not.
 244
 245 @item
 246 Creating a tiny example forces you to understand what is
 247 happening.  Many false problem reports can be avoided by
 248 attempting to create a tiny example; if you cannot replicate a
 249 @qq{bug} in a tiny example, then the problem was probably an
 250 insufficient understanding of LilyPond, not an actual bug!
 251
 252 @end itemize
 253 @divEnd
 254
 255 @divEnd
 256
 257
 258 @divClass{column-right-bottom}
 259 @subheading How do I create them?
 260
 261 @divClass{keep-bullets}
 262 @itemize
 263
 264 @item
 265 Include the \version number.
 266
 267 @item
 268 Make it small!  Examples about spacing or page layout might
 269 require many bars of music, but most issues can be reproduced
 270 using only a single measure.
 271
 272 @item
 273 When trying to create an example, try commenting out @w{(@code{%}
 274 or @code{%@{ @dots{} %@}})} sections of your file.  If you can
 275 comment something while still demonstrating the main idea, then
 276 remove the commented-material!
 277
 278 @item
 279 Avoid using complicated notes, keys, or time signatures, unless
 280 the bug is about the behavior of those items.
 281
 282 @item
 283 Do not use @code{\override} or @code{\set} commands unless the bug
 284 is about those particular commands.
 285
 286 @end itemize
 287 @divEnd
 288
 289 @divEnd
 290
 291
 292
 293
 294 @node Bug reports
 295 @unnumberedsec Bug reports
 296
 297 @divClass{column-center-top}
 298 @subheading Step 1: Known bugs
 299
 300 If you have input that results in a crash or an erroneous output,
 301 then that is a bug.  There is a list of current bugs on our google
 302 bug tracker,
 303
 304 @example
 305 @uref{http://code.google.com/p/lilypond/issues/list}
 306 @end example
 307
 308 @warning{Please @strong{DO NOT} add bug reports directly to the
 309 bug tracker.  Once an issue has been added to the tracker, feel
 310 free to add more information to that report.}
 311
 312 @divEnd
 313
 314
 315 @divClass{column-left-bottom}
 316 @subheading Step 2: Creating a bug report
 317
 318 If you have discovered a bug which is not listed, please help us
 319 by creating a bug report.
 320
 321 @warning{We only accept bug reports in the form of @ref{Tiny
 322 examples}.  We have very limited resources to deal with bug
 323 reports, so any non-minimal example will be rejected.  Almost
 324 every bug can be demonstrated in four notes or less!}
 325
 326 Here is an example of a good bug report:
 327
 328 @example
 329 %% the octavation command doesn't
 330 %% change the output at all!
 331
 332 \version "2.10.0"
 333 \paper@{ ragged-right=##t @}
 334 \relative c''' @{
 335   c1
 336   #(set-octavation 1)
 337   c1
 338 @}
 339 @end example
 340
 341 @divEnd
 342
 343 @divClass{column-right-bottom}
 344 @subheading Step 3: Sending a bug report
 345
 346 Once you have verified that the issue is not already known and
 347 created a bug report, please send it to us!
 348
 349 Unfortunately there is a strict @qq{no top-posting} check on the
 350 bug list, which is often incorrectly triggered by lilypond files.
 351 To avoid this, please add
 352
 353 @example
 354 > I'm not top posting.
 355 @end example
 356
 357 @noindent
 358 (you must include the @code{>} ) to the top of your bug report.
 359
 360 @uref{http://post.gmane.org/post.php?group=gmane.comp.gnu.lilypond.bugs,
 361 Post with the gmane lilypond.bugs interface}, or send an email to
 362 @uref{mailto:bug-lilypond@@gnu.prg, bug-lilypond@@gnu.org}.
 363
 364 Once your bug has been sent to the list, our Bug Meister will
 365 examine the report.  He may ask you for more information, or may
 366 add the report to the tracker and let you know what the issue
 367 number is.
 368
 369 You may mark the bug so that you automatically receive emails when
 370 any activity on the bug occurs.  This requires you have a google
 371 account.
 372 @divEnd
 373
 374
 375 @node Help us
 376 @unnumberedsec Help us
 377
 378 FIXME: before going live, rewrite this to apply to lilypond
 379 generally.  Right now it's (deliberately) website-specific.
 380
 381 @subheading This document
 382
 383 @subsubheading High priority / blocks release
 384
 385 - Features page.
 386
 387 - python: automatically insert latest version numbers into these
 388   pages.  Script already exists for the old website, but might
 389   (or might not!) require tweaking.
 390
 391 - translation infrastructure.
 392
 393 @subsubheading Low priority / may never
 394
 395 - perl: web-texi2html.pl needs to be un-hacked; I did things
 396   really messily.  Possibly even merge/share functions with
 397   the doc init.pl file?
 398
 399 - somebody to implement/work on a media=handheld CSS sheet
 400
 401 - remove the attributes from the <body> tag.  In general, clean up
 402   the HTML produced by texi2html
 403
 404
 405
 406 @node Development
 407 @unnumberedsec Development
 408
 409
 410 @divClass{heading-center}
 411 @heading Development materials for LilyPond 2.13.3
 412
 413 @warning{These are @emph{unstable development} versions.  If you
 414 have the slightest doubt about how to use or install LilyPond, we
 415 urge you to use the stable @ref{Download}, and read the stable
 416 @ref{Manuals}.}
 417
 418 @divEnd
 419
 420 @divClass{column-center-top}
 421 @subheading Release numbers
 422
 423 There are two sets of releases for LilyPond: stable releases, and
 424 unstable development releases.  Stable versions have an
 425 even-numbered @q{minor} version number (e.g., 2.8, 2.10, 2.12).
 426 Development versions have an odd-numbered @q{minor} version number
 427 (e.g., 2.7, 2.9, 2.11).
 428
 429 @divEnd
 430
 431
 432 @divClass{column-left-bottom}
 433 @subheading Download
 434
 435 @uref{http://download.linuxaudio.org/lilypond/binaries/linux-x86/lilypond-2.13.3-1.linux-x86.sh,
 436 lilypond-2.13.3-1.linux-x86.sh}
 437
 438 @uref{http://download.linuxaudio.org/lilypond/binaries/linux-64/lilypond-2.13.3-1.linux-64.sh,
 439 lilypond-2.13.3-1.linux-64.sh}
 440
 441 @uref{http://download.linuxaudio.org/lilypond/binaries/linux-ppc/lilypond-2.13.3-1.linux-ppc.sh,
 442 lilypond-2.13.3-1.linux-ppc.sh}
 443
 444 @uref{http://download.linuxaudio.org/lilypond/binaries/freebsd-x86/lilypond-2.13.3-1.freebsd-x86.sh,
 445 lilypond-2.13.3-1.freebsd-x86.sh}
 446
 447 @uref{http://download.linuxaudio.org/lilypond/binaries/freebsd-64/lilypond-2.13.3-1.freebsd-64.sh,
 448 lilypond-2.13.3-1.freebsd-64.sh}
 449
 450 @uref{
 451 http://download.linuxaudio.org/lilypond/binaries/darwin-x86/lilypond-2.13.3-1.darwin-x86.tar.bz2,
 452 lilypond-2.13.3-1.darwin-x86.tar.bz2}
 453
 454 @uref{
 455 http://download.linuxaudio.org/lilypond/binaries/darwin-x86/lilypond-2.13.3-1.darwin-ppc.tar.bz2,
 456 lilypond-2.13.3-1.darwin-ppc.tar.bz2}
 457
 458 @uref{
 459 http://download.linuxaudio.org/lilypond/binaries/mingw/lilypond-2.13.3-1.mingw.exe,
 460 lilypond-2.13.3-1.mingw-exe}
 461
 462
 463 @subheading Manuals
 464
 465 FIXME: these need the automatic symlinks or something.  Maybe even
 466 a hard-coded url to lilypond.org/docs/2.13 or something??
 467
 468 Learning:
 469 @uref{lm-html, html}
 470 @uref{lm-big-html, big html}
 471 @uref{lm-pdf, pdf}
 472
 473 Glossary:
 474 @uref{mg-html, html}
 475 @uref{mg-big-html, big html}
 476 @uref{mg-pdf, pdf}
 477
 478 Essay:
 479 @uref{essay-html, html}
 480 @uref{essay-big-html, big html}
 481 @uref{essay-pdf, pdf}
 482
 483 Notation:
 484 @uref{notation-html, html}
 485 @uref{notation-big-html, big html}
 486 @uref{notation-pdf, pdf}
 487
 488 Usage:
 489 @uref{usage-html, html}
 490 @uref{usage-big-html, big html}
 491 @uref{usage-pdf, pdf}
 492
 493 Snippets:
 494 @uref{snippets-html, html}
 495 @uref{snippets-big-html, big html}
 496 @uref{snippets-pdf, pdf}
 497
 498 Changes:
 499 @uref{changes-html, html}
 500 @uref{changes-big-html, big html}
 501 @uref{changes-pdf, pdf}
 502
 503 Internals:
 504 @uref{internals-html, html}
 505 @uref{internals-big-html, big html}
 506 @uref{internals-pdf, pdf}
 507
 508 @divEnd
 509
 510
 511 @divClass{column-right-top}
 512 @subheading Contributors' Guide
 513
 514 LilyPond development is a fairly complicated matter.  LilyPond is
 515 a large, (mostly) stable project.  At any point in time, we have
 516 between 5 and 25 active contributors.  In order to help new
 517 contributors, and to keep the whole system (mostly) stable, we
 518 have written a manual for contributors.
 519
 520 @divClass{keep-bullets}
 521 @itemize
 522
 523 @item @uref{../contributor/index.html, Contributor's guide (split HTML)}:
 524 the manual is split between many HTML pages.
 525 @emph{(small download for each page)}
 526
 527 @item @uref{../contributor-big-page.html, Contributor's guide (big HTML)}:
 528 read this manual as one huge HTML page.
 529 @emph{(large single download, around 10? Mb)}
 530
 531 @item @uref{../contributor.pdf, contributor.pdf}:
 532 download as a PDF file.
 533 @emph{(large single download, 2.8 Mb)}
 534
 535 @item @uref{FIXME, contributor.info}:
 536 GNU info format for documentation.  FIXME, link broken.
 537
 538 @end itemize
 539 @divEnd
 540 @divEnd
 541
 542 @divClass{column-right-bottom}
 543 @subheading Regression tests
 544
 545 @divClass{keep-bullets}
 546 @itemize
 547
 548 @item @uref{../../input/regression/collated-files.html, Regression tests}:
 549 This releases' tests.  (also in
 550 @uref{../../input/regression/collated-files.pdf, pdf})
 551
 552 @item @uref{../../input/regression/musicxml/collated-files.html,
 553 MusicXML Regression tests}:
 554 This releases' MusicXML tests.  (also in
 555 @uref{../../input/regression/musicxml/collated-files.pdf, pdf})
 556
 557 @item @uref{http://lilypond.org/test, Archive of regression tests}:
 558 Comparisons beteween versions.
 559
 560 @end itemize
 561 @divEnd
 562 @divEnd
 563
 564 @node Authors
 565 @unnumberedsec Authors
 566
 567 combo of:
 568
 569 http://lilypond.org/web/about/thanks
 570
 571 Documentation/topdocs/AUTHORS.texi
 572
 573 and maybe:
 574 http://lilypond.org/web/switch/
 575
 576
 577
 578
 579 @node Publications
 580 @unnumberedsec Publications
 581
 582 @divClass{column-center-top}
 583
 584 @subheading What we wrote
 585
 586 @divClass{keep-bullets}
 587 @itemize
 588
 589 @item
 590 Han-Wen Nienhuys and Jan Nieuwenhuizen, @emph{LilyPond, a system
 591 for automated music engraving}.  Proceedings of the XIV Colloquium
 592 on Musical Informatics (XIV CIM 2003), Firenze, Italy, May 2003.
 593 (@uref{ http://lilypond.org/web/images/xivcim.pdf, PDF 95k})
 594
 595 @item
 596 Han-Wen Nienhuys, @emph{LilyPond, Automated music formatting and
 597 the Art of Shipping}.  Forum Internacional Software Livre 2006
 598 (FISL7.0) (@uref{http://lilypond.org/web/images/FISL7-slides.pdf,
 599 PDF 1095k})
 600
 601 @item
 602 Erik Sandberg, @emph{Separating input language and formatter in
 603 GNU Lilypond}. Master's Thesis, Uppsala University, Department of
 604 Information Technology March 2006.
 605 (@uref{http://lilypond.org/web/images/thesis-erik-sandberg.pdf,
 606 PDF 750k})
 607
 608 @end itemize
 609
 610 @divEnd
 611 @divEnd
 612
 613
 614 @divClass{column-center-bottom}
 615
 616 @subheading What others wrote
 617
 618 @divClass{keep-bullets}
 619 @itemize
 620
 621 @item
 622 February 2008
 623
 624 In @uref{http://www.musicbyandrew.ca/finale-lilypond-1.html,
 625 articles on his personal site}, Andrew Hawryluk compares Finale
 626 and LilyPond in general terms, and evaluates in detail engraving
 627 capabilities of both pieces of software.  The second article is an
 628 instructive analysis of Rachmaninoff's Piano Prelude 6 engraving,
 629 including comparisons with a reference hand-engraved edition.
 630
 631 @item
 632 December 2005
 633
 634 linux journal cover Linux Journal publishes an article titled
 635 @uref{http://www.linuxjournal.com/article/8364, Make Stunning
 636 Schenker Graphs with GNU LilyPond}.  It is a in-depth but hands-on
 637 feature article with crisp LilyPond graphics.  Author Kris Shaffer
 638 remarks “GNU Lilypond generates beautiful graphics that make
 639 commercial alternatives seem second-rate.”
 640
 641 @item
 642 August 20, 2005
 643
 644 The Belgian newspaper De Standaard investigates what drives Free
 645 Software authors in an article titled
 646 @uref{http://www.standaard.be/Artikel/Detail.aspx?artikelId=G42H5GD6,
 647 Delen van KENNIS zonder WINSTBEJAG} (Non-profit sharing of
 648 knowlegde) in its `DS2 bijlage'.  LilyPond is used as an example
 649 and the article is interspersed with quotes from an `email
 650 interview' with Jan Nieuwenhuizen. This marks LilyPond's first
 651 appearance in mainstream printed press.
 652
 653 @item
 654 June 2005
 655
 656 A French article on the LilyPond 2.6 release appeared on
 657 @uref{http://linuxfr.org/2005/06/27/19210.html, linuxfr.org}.
 658
 659 @item
 660 October 2004
 661
 662 The editors of Computer!Totaal, a Dutch computer magazine,
 663 @uref{http://lilypond.org/web/images/computer-totaal.jpeg,
 664 describe LilyPond} in the October 2004 issue as: @qq{Wonderful
 665 free (open source) software [..] The sheet music produced by
 666 LilyPond is exceptionally pretty [..] a very powerful system that
 667 can do almost anything.}
 668
 669 @item
 670 July, August 2004
 671
 672 Dave Phillips wrote an introductory article for Linux Journal At
 673 the sounding edge: LilyPond, parts
 674 @uref{http://www.linuxjournal.com/article/7657, one} and
 675 @uref{http://www.linuxjournal.com/article/7719, two}.
 676
 677 @item
 678 March 2004
 679
 680 Chris Cannam interviewed Han-Wen Nienhuys and Jan Nieuwenhuizen on
 681 linuxmusician.com (site now defunct). This interview was also
 682 reviewed in a
 683 @uref{http://slashdot.org/article.pl?sid=04/03/13/2054227&tid=,
 684 slashdot story}.
 685
 686 @item
 687 February 2004
 688
 689 Jazz singer Gail Selkirk writes about
 690 @uref{http://www.songbirdofswing.com/editorial_page/lilypond/,
 691 Diving into LilyPond}.  @qq{... you can make lead sheets or full
 692 orchestral parts, and the results can be stunning.}
 693 @uref{http://www.computermusic.co.uk/, Computer Music Special},
 694 issue CMS06.
 695
 696 @end itemize
 697
 698 @divEnd
 699 @divEnd
 700
 701
 702 @node Old news
 703 @unnumberedsec Old news
 704
 705 @include general/news.itexi