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