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