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