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