Documentation/web/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.  For details, see the Contributors'
   7     Guide, node Updating translation committishes..
   8 @end ignore
   9
  10 @include included/authors.itexi
  11 @include included/helpus.itexi
  12
  13 @node Community
  14 @unnumbered Community
  15
  16
  17 @divClass{column-center-top}
  18 @subheading Interacting with the community
  19
  20 @itemize
  21
  22 @item
  23 @ref{Contact}: get help, discuss, and keep in touch!
  24
  25 @item
  26 @ref{Tiny examples}: these are @emph{highly} recommended when
  27 discussing LilyPond.
  28
  29 @item
  30 @ref{Bug reports}: something went wrong.
  31
  32 @end itemize
  33 @divEnd
  34
  35 @divClass{column-left-bottom}
  36 @subheading Making LilyPond better
  37
  38 @itemize
  39
  40 @item
  41 @ref{Help us}: your assistance is requested.
  42
  43 @item
  44 @ref{Development}: for contributors and testers.
  45
  46 @item
  47 @ref{Authors}: the people who made LilyPond what it is today.
  48
  49 @end itemize
  50 @divEnd
  51
  52 @divClass{column-right-bottom}
  53 @subheading Miscellaneous
  54
  55 @itemize
  56
  57 @item
  58 @ref{Publications}: what we wrote, and have had written about us.
  59
  60 @item
  61 @ref{Old news}: an archive.
  62
  63 @end itemize
  64 @divEnd
  65
  66
  67 @divClass{hide}
  68 @menu
  69 * Contact::
  70 * Tiny examples::
  71 * Bug reports::
  72 * Help us::
  73 * Development::
  74 * Authors::
  75 * Publications::
  76 * Old news::
  77 @end menu
  78 @divEnd
  79
  80
  81 @node Contact
  82 @unnumberedsec Contact
  83
  84
  85 @divClass{column-left-bottom}
  86 @subheading User Discussions and Help
  87
  88 @subsubheading User mailing list: @code{lilypond-user@@gnu.org}
  89
  90 This mailing list is the main place for users to discuss and help
  91 each other.
  92
  93 @quotation
  94 @uref{http://lists.gnu.org/mailman/listinfo/lilypond-user,
  95 lilypond-user subscribe and info}
  96
  97 @uref{http://lists.gnu.org/archive/html/lilypond-user/,
  98 user archive1}
  99 @uref{http://www.mail-archive.com/lilypond-user@@gnu.org/,
 100 archive2}
 101 @uref{http://dir.gmane.org/gmane.comp.gnu.lilypond.general,
 102 archive3}
 103
 104 @uref{http://post.gmane.org/post.php?group=gmane.comp.gnu.lilypond.general,
 105 send to lilypond-user with gmane}
 106 @end quotation
 107
 108 @warning{When asking questions, please use @ref{Tiny examples}!}
 109
 110 @subsubheading LilyPond Snippet Repository
 111
 112 The LilyPond Snippet Repository is a large collection of
 113 user-submitted examples, which can freely be copied and used
 114 in your owm works.  See what other people have written,
 115 and add your own!
 116
 117 @example
 118 @uref{http://lsr.dsi.unimi.it}
 119 @end example
 120
 121 Particularly instructive examples from LSR are included in our
 122 official documentation, in @ref{Snippets}.
 123
 124
 125 @subsubheading IRC
 126
 127 Some level of support is provided on our IRC channel,
 128
 129 @example
 130 @uref{irc://irc.freenode.net/lilypond, #lilypond@@irc.freenode.net}
 131 @end example
 132
 133 This channel has no public archive, so any question that may
 134 be useful for others would better be posted to one of the mailing lists.
 135
 136 @html
 137 <form action="http://webchat.freenode.net"
 138       method="get"
 139       name="f_lily_irc"
 140   <label>irc name:
 141     <input name="nick" type="text" size="15" value="">
 142   </label>
 143   <input name="channels" type="hidden" value="lilypond">
 144   <input type="submit" value="Join #lilypond IRC Chat">
 145 </form>
 146
 147 <script language="JavaScript" type="text/javascript">
 148   var username = "web";
 149   var lang = window.navigator.userLanguage ? window.navigator.userLanguage
 150   : window.navigator.language;
 151   username += '-' + lang.substr(0, 2);
 152   username += '-' + navigator.appName.substr(0, 2);
 153   username += navigator.appCodeName.replace (" ", "").substr(0, 2);
 154   username += navigator.platform.replace (" ", "").replace("nux", "").replace("n32", "");
 155   document.forms["f_lily_irc"].nick.value = username;
 156 </script>
 157 @end html
 158
 159 @subsubheading Other languages
 160
 161 @quotation
 162 @uref{http://lists.gnu.org/mailman/listinfo/lilypond-es,
 163 Spanish mailing list}
 164
 165 @uref{http://www.lilypondforum.de/,
 166 German forum}
 167
 168 @uref{http://groups.google.com/group/lilypond-brasil,
 169 Portugese group}
 170
 171 @uref{http://lists.gnu.org/mailman/listinfo/lilypond-user-fr,
 172 French mailing list}
 173
 174 @uref{http://www.lilypondforum.nl/,
 175 Dutch forum}
 176 @end quotation
 177
 178 @divEnd
 179
 180
 181 @divClass{column-right-top}
 182 @subheading Stay Informed
 183
 184 @subsubheading LilyPond Report
 185
 186 The easiest way to keep touch is by reading our community
 187 newsletter, the LilyPond Report:
 188
 189 @example
 190 @uref{http://news.lilynet.net}
 191 @end example
 192
 193 @subsubheading Releases mailing list: @code{info-lilypond@@gnu.org}
 194
 195 This mailing list is a low-volume, read-only list which receives
 196 notifications of new releases.
 197
 198 @quotation
 199 @uref{http://lists.gnu.org/mailman/listinfo/info-lilypond,
 200 info-lilypond subscribe and info}
 201
 202 @uref{http://lists.gnu.org/archive/html/info-lilypond/,
 203 info archive1}
 204 @uref{http://www.mail-archive.com/info-lilypond@@gnu.org/,
 205 archive2}
 206 @uref{http://dir.gmane.org/gmane.comp.gnu.lilypond.announce,
 207 archive3}
 208
 209 @c don't include gmane posting here.  -gp
 210 @end quotation
 211
 212
 213 @divEnd
 214
 215
 216 @divClass{column-right-bottom}
 217 @subheading Developer Discussion
 218
 219 @subsubheading Developer mailing list: @code{lilypond-devel@@gnu.org}
 220
 221 Most developer discussion takes place on this list.  Patches
 222 should be sent here.
 223
 224 @quotation
 225 @uref{http://lists.gnu.org/mailman/listinfo/lilypond-devel,
 226 lilypond-devel subscribe and info}
 227
 228 @uref{http://lists.gnu.org/archive/html/lilypond-devel/,
 229 devel archive1}
 230 @uref{http://www.mail-archive.com/lilypond-devel@@gnu.org/,
 231 archive2}
 232 @uref{http://dir.gmane.org/gmane.comp.gnu.lilypond.devel,
 233 archive3}
 234
 235 @uref{http://post.gmane.org/post.php?group=gmane.comp.gnu.lilypond.devel,
 236 send to lilypond-devel with gmane}
 237 @end quotation
 238
 239
 240 @subsubheading Bug mailing list: @code{bug-lilypond@@gnu.org}
 241
 242 Bug-specific discussion takes place here.
 243
 244 @quotation
 245 @uref{http://lists.gnu.org/mailman/listinfo/bug-lilypond,
 246 bug-lilypond subscribe and info}
 247
 248 @uref{http://lists.gnu.org/archive/html/bug-lilypond/,
 249 bug archive1}
 250 @uref{http://www.mail-archive.com/bug-lilypond@@gnu.org/,
 251 archive2}
 252 @uref{http://dir.gmane.org/gmane.comp.gnu.lilypond.bugs,
 253 archive3}
 254
 255 @c don't include gmane posting here.  -gp
 256 @end quotation
 257
 258 @warning{Before sending a message to the bug list, please read our
 259 guidelines for @ref{Bug reports}.}
 260
 261 @divEnd
 262
 263
 264
 265 @node Tiny examples
 266 @unnumberedsec Tiny examples
 267
 268 @divClass{column-center-top}
 269 @subheading What are @qq{Tiny examples}?
 270
 271 A tiny example is an example from which nothing can be removed.
 272 @divEnd
 273
 274 @divClass{column-left-bottom}
 275 @subheading Why create them?
 276
 277 @divClass{keep-bullets}
 278 @itemize
 279
 280 @item
 281 The simpler the example is, the quicker potential helpers can
 282 understand it and help you.
 283
 284 @item
 285 A simple example demonstrates that you have put effort towards
 286 solving the problem yourself.  When people send huge portions of
 287 input, it looks like they don't care how if we help them or not.
 288
 289 @item
 290 Creating a tiny example forces you to understand what is
 291 happening.  Many false problem reports can be avoided by
 292 attempting to create a tiny example; if you cannot replicate a
 293 @qq{bug} in a tiny example, then the problem was probably an
 294 insufficient understanding of LilyPond, not an actual bug!
 295
 296 @end itemize
 297 @divEnd
 298
 299 @divEnd
 300
 301
 302 @divClass{column-right-bottom}
 303 @subheading How do I create them?
 304
 305 @divClass{keep-bullets}
 306 @itemize
 307
 308 @item
 309 Include the \version number.
 310
 311 @item
 312 Make it small!  Examples about spacing or page layout might
 313 require many bars of music, but most issues can be reproduced
 314 using only a single measure.
 315
 316 @item
 317 When trying to create an example, try commenting out @w{(@code{%}
 318 or @code{%@{ @dots{} %@}})} sections of your file.  If you can
 319 comment something while still demonstrating the main idea, then
 320 remove the commented-material!
 321
 322 @item
 323 Avoid using complicated notes, keys, or time signatures, unless
 324 the bug is about the behavior of those items.
 325
 326 @item
 327 Do not use @code{\override} or @code{\set} commands unless the bug
 328 is about those particular commands.
 329
 330 @end itemize
 331 @divEnd
 332
 333 @divEnd
 334
 335
 336
 337
 338 @node Bug reports
 339 @unnumberedsec Bug reports
 340
 341 @divClass{column-center-top}
 342 @subheading Step 1: Known bugs
 343
 344 If you have input that results in a crash or an erroneous output,
 345 then that is a bug.  There is a list of current bugs on our google
 346 bug tracker,
 347
 348 @example
 349 @uref{http://code.google.com/p/lilypond/issues/list}
 350 @end example
 351
 352 @warning{Please @strong{DO NOT} add bug reports directly to the
 353 bug tracker.  Once an issue has been added to the tracker, feel
 354 free to add more information to that report.}
 355
 356 @divEnd
 357
 358
 359 @divClass{column-left-bottom}
 360 @subheading Step 2: Creating a bug report
 361
 362 If you have discovered a bug which is not listed, please help us
 363 by creating a bug report.
 364
 365 @warning{We only accept bug reports in the form of @ref{Tiny
 366 examples}.  We have very limited resources to deal with bug
 367 reports, so any non-minimal example will be rejected.  Almost
 368 every bug can be demonstrated in four notes or less!}
 369
 370 Here is an example of a good bug report:
 371
 372 @example
 373 %% the octavation command doesn't
 374 %% change the output at all!
 375
 376 \version "2.10.0"
 377 \relative c''' @{
 378   c1
 379   #(set-octavation 1)
 380   c1
 381 @}
 382 @end example
 383
 384 @divEnd
 385
 386 @divClass{column-right-bottom}
 387 @subheading Step 3: Sending a bug report
 388
 389 Once you have verified that the issue is not already known and
 390 created a bug report, please send it to us!
 391
 392 Unfortunately there is a strict @qq{no top-posting} check on the
 393 bug list, which is often incorrectly triggered by lilypond files.
 394 To avoid this, please add
 395
 396 @example
 397 > I'm not top posting.
 398 @end example
 399
 400 @noindent
 401 (you must include the @code{>} ) to the top of your bug report.
 402
 403 @uref{http://post.gmane.org/post.php?group=gmane.comp.gnu.lilypond.bugs,
 404 Post with the gmane lilypond.bugs interface}, or send an email to
 405 @uref{mailto:bug-lilypond@@gnu.prg, bug-lilypond@@gnu.org}.
 406
 407 Once your bug has been sent to the list, our Bug Meister will
 408 examine the report.  He may ask you for more information, or may
 409 add the report to the tracker and let you know what the issue
 410 number is.
 411
 412 You may mark the bug so that you automatically receive emails when
 413 any activity on the bug occurs.  This requires you have a google
 414 account.
 415 @divEnd
 416
 417
 418 @node Help us
 419 @unnumberedsec Help us
 420
 421 @divClass{column-center-top}
 422 @helpusNeed
 423
 424 @divEnd
 425
 426 @divClass{column-left-top}
 427 @divClass{keep-bullets}
 428 @helpusTasks
 429
 430 @divEnd
 431 @divEnd
 432
 433 @divClass{column-right-top}
 434 @helpusProjects
 435
 436 @divEnd
 437
 438
 439 @node Development
 440 @unnumberedsec Development
 441
 442 @divClass{heading-center}
 443 @ifclear web_version
 444   @heading Development for LilyPond @version
 445 @end ifclear
 446 @ifset web_version
 447   @heading Development for LilyPond @versionDevel
 448 @end ifset
 449
 450
 451 @warning{These are @emph{unstable development} versions.  If you
 452 have the slightest doubt about how to use or install LilyPond, we
 453 urge you to use the stable @ref{Download}, and read the stable
 454 @ref{Manuals}.}
 455
 456 @divEnd
 457
 458 @divClass{column-center-top}
 459 @subheading Release numbers
 460
 461 There are two sets of releases for LilyPond: stable releases, and
 462 unstable development releases.  Stable versions have an
 463 even-numbered @q{minor} version number (e.g., 2.8, 2.10, 2.12).
 464 Development versions have an odd-numbered @q{minor} version number
 465 (e.g., 2.7, 2.9, 2.11).
 466
 467 @divEnd
 468
 469
 470 @divClass{column-left-top}
 471 @subheading Download
 472
 473 Instructions for git and compiling are in the Contributor's Guide.
 474
 475 @quotation
 476 @uref{http://git.sv.gnu.org/gitweb/?p=lilypond.git, lilypond git repository}
 477 @end quotation
 478
 479 Documentation writers and testers will generally want to download
 480 the latest binary:
 481
 482 @quotation
 483
 484 @downloadDevelLinuxNormal
 485
 486 @downloadDevelLinuxBig
 487
 488 @downloadDevelLinuxPPC
 489
 490 @downloadDevelFreeBSDNormal
 491
 492 @downloadDevelFreeBSDBig
 493
 494 @downloadDevelDarwinNormal
 495
 496 @downloadDevelDarwinPPC
 497
 498 @downloadDevelWindows
 499
 500 @downloadDevelSource
 501
 502 @end quotation
 503
 504 @divEnd
 505
 506
 507 @divClass{column-right-top}
 508 @subheading Contributor's Guide
 509
 510 LilyPond development is a fairly complicated matter.  In order to
 511 help new contributors, and to keep the whole system (mostly)
 512 stable, we have written a manual for development tasks.
 513
 514 @docLinksBare{Contributor's Guide, contributor,
 515   @rcontribnamed{Top,Contributor's Guide},
 516   @manualDevelContributorSplit,
 517   @manualDevelContributorBig, 500 kB,
 518   @manualDevelContributorPdf, 2.8 MB}
 519
 520 @divEnd
 521
 522
 523 @divClass{column-center-top}
 524 @subheading Regression tests
 525
 526 @divClass{keep-bullets}
 527 @itemize
 528
 529 @ifclear web_version
 530
 531 @item
 532 @uref{../../input/regression/collated-files.html, Regression tests}:
 533 This release's regtests.
 534 (@uref{../../input/regression/collated-files.pdf, pdf version})
 535
 536 @item
 537 @uref{../../input/regression/musicxml/collated-files.html, MusicXML tests}:
 538 This release's musicXML tests.
 539 (@uref{../../input/regression/musicxml/collated-files.pdf, pdf version})
 540 @end ifclear
 541
 542 @ifset web_version
 543 @item @regtestDevel (@regtestDevelPdf{})
 544
 545 @item @regtestDevelXml (@regtestDevelXmlPdf{})
 546
 547 @item @regtestStable (@regtestStablePdf{})
 548
 549 @item @regtestStableXml (@regtestStableXmlPdf{})
 550 @end ifset
 551
 552
 553 @item @uref{http://lilypond.org/test, Archive of regression tests}:
 554 Comparisons between versions.
 555
 556 @end itemize
 557 @divEnd
 558 @divEnd
 559
 560
 561
 562 @divClass{column-center-bottom}
 563 @subheading Manuals
 564
 565 @ifclear web_version
 566 @warning{These manuals are for LilyPond @version{}; the latest
 567 manuals can be found at @url{http://lilypond.org}}
 568 @end ifclear
 569
 570 @divClass{normal-table}
 571 @multitable @columnfractions .3 .3 .3
 572 @headitem Introduction
 573 @item
 574 @docLinkSplit{Learning,learning,@manualDevelLearningSplit}
 575 @tab
 576 @docLinkBig{Learning,learning,@manualDevelLearningBig}
 577 @tab
 578 @docLinkPdf{Learning,learning,@manualDevelLearningPdf}
 579
 580 @item
 581 @docLinkSplit{Glossary,music-glossary,@manualDevelGlossarySplit}
 582 @tab
 583 @docLinkBig{Glossary,music-glossary,@manualDevelGlossaryBig}
 584 @tab
 585 @docLinkPdf{Glossary,music-glossary,@manualDevelGlossaryPdf}
 586
 587 @item
 588 @docLinkSplit{Essay,essay,@manualDevelEssaySplit}
 589 @tab
 590 @docLinkBig{Essay,essay,@manualDevelEssayBig}
 591 @tab
 592 @docLinkPdf{Essay,essay,@manualDevelEssayPdf}
 593
 594 @headitem Regular
 595
 596 @item
 597 @docLinkSplit{Notation,notation,@manualDevelNotationSplit}
 598 @tab
 599 @docLinkBig{Notation,notation,@manualDevelNotationBig}
 600 @tab
 601 @docLinkPdf{Notation,notation,@manualDevelNotationPdf}
 602
 603 @item
 604 @docLinkSplit{Usage,usage,@manualDevelUsageSplit}
 605 @tab
 606 @docLinkBig{Usage,usage,@manualDevelUsageBig}
 607 @tab
 608 @docLinkPdf{Usage,usage,@manualDevelUsagePdf}
 609
 610 @item
 611 @docLinkSplit{Snippets,snippets,@manualDevelSnippetsSplit}
 612 @tab
 613 @docLinkBig{Snippets,snippets,@manualDevelSnippetsBig}
 614 @tab
 615 @docLinkPdf{Snippets,snippets,@manualDevelSnippetsPdf}
 616
 617 @headitem Infrequent
 618
 619 @item
 620 @docLinkSplit{Web,web,@manualDevelWebSplit}
 621 @tab
 622 @docLinkBig{Web,web,@manualDevelWebBig}
 623 @tab
 624 @docLinkPdf{Web,web,@manualDevelWebPdf}
 625
 626 @item
 627 @docLinkSplit{Changes,changes,@manualDevelChangesSplit}
 628 @tab
 629 @docLinkBig{Changes,changes,@manualDevelChangesBig}
 630 @tab
 631 @docLinkPdf{Changes,changes,@manualDevelChangesPdf}
 632
 633 @item
 634 @docLinkSplit{Extending,extending,@manualDevelExtendingSplit}
 635 @tab
 636 @docLinkBig{Extending,extending,@manualDevelExtendingBig}
 637 @tab
 638 @docLinkPdf{Extending,extending,@manualDevelExtendingPdf}
 639
 640 @item
 641 @docLinkSplit{Internals,internals,@manualDevelInternalsSplit}
 642 @tab
 643 @docLinkBig{Internals,internals,@manualDevelInternalsBig}
 644 @tab
 645 @docLinkPdf{Internals,internals,@manualDevelInternalsPdf}
 646
 647 @ifset web_version
 648 @headitem Downloadable
 649
 650 @item
 651 @doctarballDevel
 652 @end ifset
 653
 654 @end multitable
 655
 656 @divEnd
 657 @divEnd
 658
 659
 660
 661
 662 @node Authors
 663 @unnumberedsec Authors
 664
 665 @help{Under construction; this is not an accurate list!}
 666
 667
 668 @divClass{column-left-top}
 669 @subheading Current Development Team
 670
 671 @divClass{keep-bullets}
 672 @developersCurrent
 673 @divEnd
 674 @divEnd
 675
 676 @divClass{column-right-top}
 677 @subheading Previous Development Team
 678
 679 @divClass{keep-bullets}
 680 @developersPrevious
 681 @divEnd
 682 @divEnd
 683
 684
 685 @divClass{column-center-top}
 686 @subheading Current Contributors
 687
 688 @divClass{keep-bullets}
 689 @subsubheading Programming
 690
 691 @coreCurrent
 692
 693 @subsubheading Font
 694
 695 @fontCurrent
 696
 697 @subsubheading Documentation
 698
 699 @docCurrent
 700
 701 @subsubheading Bug squad
 702
 703 @bugsquadCurrent
 704
 705 @subsubheading Support
 706
 707 @supportCurrent
 708
 709 @subsubheading Translation
 710
 711 @translationsCurrent
 712
 713 @divEnd
 714 @divEnd
 715
 716
 717 @divClass{column-center-bottom}
 718 @subheading Previous Contributors
 719
 720 @divClass{keep-bullets}
 721 @subsubheading Programming
 722
 723 @corePrevious
 724
 725 @subsubheading Font
 726
 727 @fontPrevious
 728
 729 @subsubheading Documentation
 730
 731 @docPrevious
 732
 733 @c    uncomment when we have any previous members -gp
 734 @c @subsubheading Bug squad
 735
 736 @c @bugsquadCurrent
 737
 738 @subsubheading Support
 739
 740 @supportPrevious
 741
 742 @subsubheading Translation
 743
 744 @translationsPrevious
 745
 746 @divEnd
 747 @divEnd
 748
 749
 750
 751 @node Publications
 752 @unnumberedsec Publications
 753
 754 @divClass{column-center-top}
 755 @subheading What we wrote about LilyPond
 756
 757 @divClass{keep-bullets}
 758 @itemize
 759
 760 @item
 761 Han-Wen Nienhuys, @emph{LilyPond, Automated music formatting and
 762 the Art of Shipping}.  Forum Internacional Software Livre 2006
 763 (FISL7.0) (@uref{http://lilypond.org/web/images/FISL7-slides.pdf,
 764 PDF 1095k})
 765
 766 @item
 767 Erik Sandberg, @emph{Separating input language and formatter in
 768 GNU LilyPond}. Master's Thesis, Uppsala University, Department of
 769 Information Technology March 2006.
 770 (@uref{http://lilypond.org/web/images/thesis-erik-sandberg.pdf,
 771 PDF 750k})
 772
 773 @item
 774 Han-Wen Nienhuys and Jan Nieuwenhuizen, @emph{LilyPond, a system
 775 for automated music engraving}.  Proceedings of the XIV Colloquium
 776 on Musical Informatics (XIV CIM 2003), Firenze, Italy, May 2003.
 777 (@uref{ http://lilypond.org/web/images/xivcim.pdf, PDF 95k})
 778
 779 @end itemize
 780
 781 @divEnd
 782 @divEnd
 783
 784
 785 @divClass{column-center-bottom}
 786
 787 @subheading What people did with LilyPond
 788
 789 @help{Yeah, this doesn't look bad at all... there's 20-50 papers
 790 out there that cite lilypond; somebody should find at least 3 or 4
 791 of them, so that it doesn't look so graham-specific.}
 792
 793 @divClass{keep-bullets}
 794 @itemize
 795
 796 @item
 797 Graham Percival, Tosten Anders, and George Tzanetakis,
 798 @emph{Generating Targeted Rhythmic Exercises for Music Students
 799 with Constraint Satisfaction Programming}, International Computer
 800 Music Conference 2008.
 801
 802 @end itemize
 803
 804 @divEnd
 805 @divEnd
 806
 807
 808 @node Old news
 809 @unnumberedsec Old news
 810
 811 @include web/news-front.itexi
 812
 813 @include web/news.itexi
 814
 815