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/acknowledge.itexi
  11 @include included/authors.itexi
  12 @include included/helpus.itexi
  13
  14 @node Community
  15 @unnumbered Community
  16
  17 @divClass{link-headings}
  18
  19 @divClass{column-center-top}
  20 @subheading Interacting with the community
  21
  22 @itemize
  23
  24 @item
  25 @ref{Contact}: get help, discuss, and keep in touch!
  26
  27 @item
  28 @ref{Tiny examples}: these are @emph{highly} recommended when
  29 discussing LilyPond.
  30
  31 @item
  32 @ref{Bug reports}: something went wrong.
  33
  34 @end itemize
  35 @divEnd
  36
  37 @divClass{column-left-bottom}
  38 @subheading Making LilyPond better
  39
  40 @itemize
  41
  42 @item
  43 @ref{Help us}: your assistance is requested.
  44
  45 @item
  46 @ref{Sponsoring}: financial contributions.
  47
  48 @item
  49 @ref{Development}: for contributors and testers.
  50
  51 @item
  52 @ref{Google Summer of Code}: ideas for Google Summer of Code (GSoC).
  53
  54 @item
  55 @ref{Authors}: the people who made LilyPond what it is today.
  56
  57 @item
  58 @ref{Acknowledgements}: projects and institutions that support LilyPond
  59
  60 @end itemize
  61 @divEnd
  62
  63 @divClass{column-right-bottom}
  64 @subheading Miscellaneous
  65
  66 @itemize
  67
  68 @item
  69 @ref{Publications}: what we wrote, and have had written about us.
  70
  71 @item
  72 @ref{News}: news from the LilyPond project.
  73
  74 @item
  75 @ref{Attic}: announcements and changelogs from past versions.
  76
  77 @end itemize
  78 @divEnd
  79
  80 @divEnd
  81
  82 @divClass{hide}
  83 @menu
  84 * Contact::
  85 * Tiny examples::
  86 * Bug reports::
  87 * Help us::
  88 * Sponsoring::
  89 * Development::
  90 * Google Summer of Code::
  91 * Authors::
  92 * Acknowledgements::
  93 * Publications::
  94 * News::
  95 * Attic::
  96 @end menu
  97 @divEnd
  98
  99
 100 @node Contact
 101 @unnumberedsec Contact
 102
 103
 104 @divClass{column-left-bottom}
 105 @subheading User Discussions and Help
 106
 107 @subsubheading User mailing list: @code{lilypond-user@@gnu.org}
 108
 109 This mailing list is the main place for users to discuss and help
 110 each other.
 111
 112 @quotation
 113 @uref{http://lists.gnu.org/mailman/listinfo/lilypond-user,
 114 lilypond-user subscribe and info}
 115
 116 @uref{http://lists.gnu.org/archive/html/lilypond-user/,
 117 user archive1}
 118 @uref{http://www.mail-archive.com/lilypond-user@@gnu.org/,
 119 archive2}
 120 @uref{http://dir.gmane.org/gmane.comp.gnu.lilypond.general,
 121 archive3}
 122
 123 @uref{http://post.gmane.org/post.php?group=gmane.comp.gnu.lilypond.general,
 124 send to lilypond-user with gmane}
 125 @end quotation
 126
 127 @warning{When asking questions, please use @ref{Tiny examples}!}
 128
 129 @subsubheading LilyPond Snippet Repository
 130
 131 The LilyPond Snippet Repository is a large collection of
 132 user-submitted examples, which can freely be copied and used
 133 in your own works.  See what other people have written,
 134 and add your own!
 135
 136 @example
 137 @uref{http://lsr.di.unimi.it}
 138 @end example
 139
 140 Particularly instructive examples from LSR are included in our
 141 official documentation, in @ref{Snippets}.
 142
 143
 144 @subsubheading IRC
 145
 146 Some level of support is provided on our IRC channel,
 147
 148 @example
 149 @uref{irc://irc.freenode.net/lilypond, #lilypond@@irc.freenode.net}
 150 @end example
 151
 152 This channel has no public archive, so any question that may
 153 be useful for others would better be posted to one of the mailing lists.
 154
 155 @html
 156 <form action="http://webchat.freenode.net"
 157       method="get"
 158       name="f_lily_irc"
 159   <label>irc name:
 160     <input name="nick" type="text" size="15" value="">
 161   </label>
 162   <input name="channels" type="hidden" value="lilypond">
 163   <input type="submit" value="Join #lilypond IRC Chat">
 164 </form>
 165
 166 <script language="JavaScript" type="text/javascript">
 167   var username = "web";
 168   var lang = window.navigator.userLanguage ? window.navigator.userLanguage
 169   : window.navigator.language;
 170   username += '-' + lang.substr(0, 2);
 171   username += '-' + navigator.appName.substr(0, 2);
 172   username += navigator.appCodeName.replace (" ", "").substr(0, 2);
 173   username += navigator.platform.replace (" ", "").replace("nux", "").replace("n32", "");
 174   document.forms["f_lily_irc"].nick.value = username;
 175 </script>
 176 @end html
 177
 178 @subsubheading Other languages
 179
 180 @quotation
 181 @uref{http://lists.gnu.org/mailman/listinfo/lilypond-user-fr,
 182 French mailing list}
 183
 184 @uref{http://www.lilypondforum.de/,
 185 German forum}
 186
 187 @uref{http://groups.google.com/group/lilypond-brasil,
 188 Portuguese group}
 189
 190 @uref{http://lists.gnu.org/mailman/listinfo/lilypond-es,
 191 Spanish mailing list}
 192 @end quotation
 193 @divEnd
 194
 195
 196 @divClass{column-right-top}
 197 @subheading The LilyPond Blog
 198
 199 Read our community blog, @q{Scores of Beauty}:
 200
 201 @example
 202 @uref{http://lilypondblog.org}
 203 @end example
 204
 205 @subsubheading Releases mailing list: @code{info-lilypond@@gnu.org}
 206
 207 This mailing list is a low-volume, read-only list which receives
 208 notifications of new releases.
 209
 210 @quotation
 211 @uref{http://lists.gnu.org/mailman/listinfo/info-lilypond,
 212 info-lilypond subscribe and info}
 213
 214 @uref{http://lists.gnu.org/archive/html/info-lilypond/,
 215 info archive1}
 216 @uref{http://www.mail-archive.com/info-lilypond@@gnu.org/,
 217 archive2}
 218 @uref{http://dir.gmane.org/gmane.comp.gnu.lilypond.announce,
 219 archive3}
 220
 221 @c don't include gmane posting here.  -gp
 222 @end quotation
 223
 224
 225 @divEnd
 226
 227
 228 @divClass{column-right-bottom}
 229 @subheading Developer Discussions and Translations
 230
 231 @subsubheading Developer mailing list: @code{lilypond-devel@@gnu.org}
 232
 233 Developer discussions take place on this list. Patches can also be sent
 234 here.
 235
 236 @quotation
 237 @uref{http://lists.gnu.org/mailman/listinfo/lilypond-devel,
 238 lilypond-devel subscribe and info}
 239
 240 @uref{http://lists.gnu.org/archive/html/lilypond-devel/,
 241 devel archive1}
 242 @uref{http://www.mail-archive.com/lilypond-devel@@gnu.org/,
 243 archive2}
 244 @uref{http://dir.gmane.org/gmane.comp.gnu.lilypond.devel,
 245 archive3}
 246
 247 @uref{http://post.gmane.org/post.php?group=gmane.comp.gnu.lilypond.devel,
 248 send to lilypond-devel with gmane}
 249 @end quotation
 250
 251
 252 @subsubheading Bug mailing list: @code{bug-lilypond@@gnu.org}
 253
 254 Bug reports and discussions should be sent here.  Do not send patches
 255 to this list.
 256
 257 @quotation
 258 @uref{http://lists.gnu.org/mailman/listinfo/bug-lilypond,
 259 bug-lilypond subscribe and info}
 260
 261 @uref{http://lists.gnu.org/archive/html/bug-lilypond/,
 262 bug archive1}
 263 @uref{http://www.mail-archive.com/bug-lilypond@@gnu.org/,
 264 archive2}
 265 @uref{http://dir.gmane.org/gmane.comp.gnu.lilypond.bugs,
 266 archive3}
 267
 268 @c don't include gmane posting here.  -gp
 269 @end quotation
 270
 271 @warning{Before sending a message to the bug list, please read our
 272 guidelines for @ref{Bug reports}.}
 273
 274
 275 @subsubheading Translation mailing list: @code{translations@@lilynet.org}
 276
 277 All discussions about translating LilyPond manuals should be sent here.
 278 Do not send patches to this list.
 279
 280 @quotation
 281 @uref{http://lilypond-translations.3384276.n2.nabble.com/,
 282 Translation mailing list archive}
 283 @end quotation
 284
 285 @divEnd
 286
 287
 288 @node Tiny examples
 289 @unnumberedsec Tiny examples
 290
 291 @divClass{column-center-top}
 292 @subheading What are @qq{Tiny examples}?
 293
 294 A tiny example is an example from which @strong{nothing} can be removed.
 295 @divEnd
 296
 297 @divClass{column-left-bottom}
 298 @subheading Why create them?
 299
 300 @divClass{keep-bullets}
 301 @itemize
 302
 303 @item
 304 The simpler the example is, the quicker potential helpers can
 305 understand it and help you.
 306
 307 @item
 308 A tiny example demonstrates that you have put effort towards
 309 solving the problem yourself.  When people send huge portions of
 310 input, it looks like they don't care if we help them or not.
 311
 312 @item
 313 Creating a tiny example helps you to understand what is
 314 happening.  Many false problem reports can be avoided by
 315 attempting to create a tiny example; if you cannot replicate a
 316 @qq{bug} in a tiny example, then the problem was probably an
 317 insufficient understanding of LilyPond, not an actual bug!
 318
 319 @end itemize
 320 @divEnd
 321
 322 @divEnd
 323
 324
 325 @divClass{column-right-bottom}
 326 @subheading How to create them?
 327
 328 @divClass{keep-bullets}
 329 @itemize
 330
 331 @item
 332 Include the @code{\version} number.
 333
 334 @item
 335 Make it small!  Examples about spacing or page layout might
 336 require many bars of music, but most issues can be reproduced
 337 using less than a single measure.
 338
 339 @item
 340 When trying to create an example, try commenting out @w{(@code{%}
 341 or @code{%@{ @dots{} %@}})} sections of your file.  If you
 342 can comment something while still demonstrating the main idea,
 343 then remove the commented-material.
 344
 345 @item
 346 Avoid using complicated notes, keys or time signatures, unless
 347 the bug is about the behavior of those items.
 348
 349 @item
 350 Do not use @code{\override} or @code{\set} commands unless the bug
 351 is about those specific commands.
 352
 353 @item
 354 Optionally, attach an image showing the desired graphical output.
 355
 356 @end itemize
 357 @divEnd
 358
 359 @divEnd
 360
 361 @divClass{column-center-bottom}
 362 @subheading How tiny should they be?
 363
 364 Is the code below a minimal example?
 365
 366 @example
 367 \version "2.14.1"
 368 \include "english.ly"
 369
 370 \score @{
 371   \new Staff @{
 372     \key d \major
 373     \numericTimeSignature
 374     \time 2/4
 375     <cs' d'' b''>16 <cs' d'' b''>8.
 376     %% Here: the tie on the D's looks funny
 377     %% Too tall? Left-hand endpoint is not aligned with the B tie?
 378     ~
 379     <cs' d'' b''>8 [ <b d'' a''> ]
 380   @}
 381 @}
 382 @end example
 383
 384 Well, it is not very big, but a truly minimal example is here:
 385
 386 @example
 387 \version "2.14.1"
 388 @{
 389   % middle tie looks funny here:
 390   <c' d'' b''>8. ~ <c' d'' b''>8
 391 @}
 392 @end example
 393
 394 Very few tiny examples exceed 10 lines of code -
 395 quite often 4 lines are enough to demonstrate the problem!
 396
 397 @divEnd
 398
 399
 400 @node Bug reports
 401 @unnumberedsec Bug reports
 402
 403
 404 @divClass{heading-center}
 405 If you have input that results in a crash or wrong output,
 406 then that is a bug.
 407 @divEnd
 408
 409 @divClass{column-center-top}
 410 @subheading Step 1: Known bugs
 411
 412 We may already know about this bug.  Check here:
 413
 414 @example
 415 @uref{http://sourceforge.net/p/testlilyissues/issues/}
 416 @end example
 417
 418 @warning{Please @strong{DO NOT} add bug reports directly to the
 419 bug tracker.  Once an issue has been added to the tracker, feel
 420 free to add more information to that report.}
 421
 422 @divEnd
 423
 424
 425 @divClass{column-left-bottom}
 426 @subheading Step 2: Creating a bug report
 427
 428 If you have discovered a bug which is not listed,
 429 please help us by creating a bug report.
 430
 431 @warning{We only accept reports in the form of
 432 @ref{Tiny examples}.  We have very limited resources,
 433 so any non-minimal example will be rejected.  Almost
 434 every bug can be demonstrated in four notes or less!}
 435
 436 Here is an example of a good bug report:
 437
 438 @example
 439 % Accidentals should be printed for only
 440 % the first note in a tie, but this version
 441 % prints flats on both notes.
 442 \version "2.10.1"
 443
 444 \relative c'' @{
 445  bes1 ~
 446  bes1
 447 @}
 448 @end example
 449
 450 @divEnd
 451
 452 @divClass{column-right-bottom}
 453 @subheading Step 3: Sending a bug report
 454
 455 Once you have verified that the issue is not already known and
 456 created a bug report, please send it to us!
 457
 458 @divClass{keep-bullets}
 459 @itemize
 460
 461 @item
 462 If you are subscribed to the @uref{mailto:bug-lilypond@@gnu.org,
 463 bug-lilypond@@gnu.org} mailing list, send an email like normal.
 464
 465 @item
 466 If you are not subscribed, you can still post a bug report with
 467 the
 468 @uref{http://post.gmane.org/post.php?group=gmane.comp.gnu.lilypond.bugs,
 469 gmane lilypond.bugs web interface}.
 470
 471 However, there is a strict @qq{no top-posting} check on the gmane
 472 interface, which is often incorrectly triggered by lilypond files.
 473 To avoid this, please add:
 474
 475 @example
 476 > I'm not top posting.
 477 @end example
 478
 479 @noindent
 480 (you @emph{must} include the @code{>} ) to the top of your bug
 481 report.
 482
 483 @end itemize
 484 @divEnd
 485 @divEnd
 486
 487 @divClass{column-center-bottom}
 488 @subheading Step 4: Wait for a response
 489
 490 Once your bug report has been sent to the list, our Bug Squad will
 491 examine it; they may ask you for more information.  You will be notified
 492 when the report will be added to the bug tracker.  Please allow up to 4
 493 days, as we have a limited number of volunteers for this task.
 494
 495 Once a bug has been added to the tracker, you can comment it to add
 496 more information about it.
 497 You may also mark the bug so that you automatically receive emails when
 498 any activity on the bug occurs.  This requires you have a google account
 499 login.
 500 @divEnd
 501
 502 @divClass{column-center-bottom}
 503 @subheading Optional help: show the desired behavior
 504
 505 Once an issue has been added to the tracker, it can be very
 506 helpful if we can see the desired output.  Feel free to add input
 507 code and/or images (possibly created with other tools) which
 508 demonstrate what you think it should look like!
 509
 510 @divEnd
 511
 512
 513
 514 @node Help us
 515 @unnumberedsec Help us
 516
 517 @divClass{column-center-top}
 518 @helpusNeed
 519
 520 @divEnd
 521
 522 @divClass{column-left-top}
 523 @divClass{keep-bullets}
 524 @helpusSimple
 525
 526 @divEnd
 527 @divEnd
 528
 529 @divClass{column-right-top}
 530 @helpusAdvanced
 531
 532 @divEnd
 533
 534
 535 @node Sponsoring
 536 @unnumberedsec Sponsoring
 537
 538 @divClass{keep-bullets}
 539 @divClass{column-left-top}
 540 @subheading Bounties
 541
 542 In the past,
 543
 544 @itemize
 545 @item some users have paid for new features
 546 @item some developers have added new features for hire
 547 @end itemize
 548
 549 The LilyPond project does not organize such efforts; we neither
 550 endorse nor discourage such agreements.  Any contracts between
 551 private individuals is the business of those individuals, not
 552 ours.
 553
 554 @divEnd
 555
 556 @divClass{column-right-top}
 557 @subheading Guidelines
 558
 559 Any user wanting to offer money in exchange for work should bear
 560 in mind the following points:
 561
 562 @itemize
 563 @item
 564 LilyPond developers may advertise their services on the lilypond
 565 email lists from time to time.
 566
 567 @item
 568 Any agreements between private individuals should include the
 569 normal precautions when conducting business: who pays, how much do
 570 they pay, with what method of payment, and upon what set of
 571 conditions.  We suggest that any ambiguity or uncertainty in these
 572 questions should be resolved before any work begins.
 573
 574 @end itemize
 575
 576 @divEnd
 577
 578 @divClass{column-center-bottom}
 579 @subheading Interested developers
 580
 581 Here is a list of people who have expressed an interest in
 582 bounties.  Note that the amount of work done by individuals varies
 583 quite a bit throughout the years.  We do not guarantee that this
 584 list is up-to-date, nor do we guarantee that the people listed
 585 here have any ability.  The only criteria is "XYZ asked to be
 586 listed on this page".
 587
 588 Looking at the git history is a good way to determine who the most
 589 active and experienced developers are.  Statistics up to version
 590 @versionDevel{}:
 591
 592 @multitable @columnfractions .3 .3 .3
 593 @item @uref{http://lilypond.org/~graham/gitstats-all/, overall history}
 594 @tab @uref{http://lilypond.org/~graham/gitstats-1year/, past year}
 595 @tab @uref{http://lilypond.org/~graham/gitstats-3months/, past three months}
 596 @end multitable
 597
 598 Interested developers:
 599 @table @asis
 600 @item @email{dak@@gnu.org, David Kastrup}
 601 Donations are required to let me continue my current fulltime work on
 602 LilyPond.  I focus on user and programmer interface design, coherence,
 603 implementation, simplification, documentation, and debugging.
 604
 605 @c Format
 606 @c @item @email{name@@adress.domain, Name}
 607 @c area of interest (256 chars max)
 608
 609 @end table
 610
 611 @divEnd
 612 @divEnd
 613
 614
 615 @node Development
 616 @unnumberedsec Development
 617
 618 @divClass{heading-center}
 619 @ifclear web_version
 620   @heading Development for LilyPond @version
 621 @end ifclear
 622 @ifset web_version
 623   @heading Development for LilyPond @versionDevel
 624 @end ifset
 625
 626
 627 @c we normally don't allow named references, but in this case
 628 @c it's good to emphasize the "stable" part.  -gp
 629 @warning{These are @emph{unstable development} versions.  If you
 630 have the slightest doubt about how to use or install LilyPond, we
 631 urge you to use the @ref{Download, stable Download}, and read the
 632 @ref{Manuals, stable Manuals}.}
 633
 634 @divEnd
 635
 636 @divClass{column-center-top}
 637 @subheading Release numbers
 638
 639 There are two sets of releases for LilyPond: stable releases, and
 640 unstable development releases.  Stable versions have an
 641 even-numbered @q{minor} version number (e.g., 2.8, 2.10, 2.12).
 642 Development versions have an odd-numbered @q{minor} version number
 643 (e.g., 2.7, 2.9, 2.11).
 644
 645 @divEnd
 646
 647
 648 @divClass{column-left-top}
 649 @subheading Download
 650
 651 Instructions for git and compiling are in the Contributor's Guide.
 652
 653 @quotation
 654 @uref{http://git.sv.gnu.org/gitweb/?p=lilypond.git, lilypond git repository}
 655 @end quotation
 656
 657 Documentation writers and testers will generally want to download
 658 the latest binary:
 659
 660 @quotation
 661
 662 @downloadDevelLinuxNormal
 663
 664 @downloadDevelLinuxBig
 665
 666 @downloadDevelLinuxPPC
 667
 668 @downloadDevelFreeBSDNormal
 669
 670 @downloadDevelFreeBSDBig
 671
 672 @downloadDevelDarwinNormal
 673
 674 @downloadDevelDarwinPPC
 675
 676 @downloadDevelWindows
 677
 678 @downloadDevelSource
 679
 680 @end quotation
 681
 682 @divEnd
 683
 684
 685 @divClass{column-right-top}
 686 @subheading Contributor's Guide
 687
 688 LilyPond development is a fairly complicated matter.  In order to
 689 help new contributors, and to keep the whole system (mostly)
 690 stable, we have written a manual for development tasks.
 691
 692 @docLinksBare{Contributor's Guide, contributor,
 693   @rcontribnamed{Top,Contributor's Guide},
 694   @manualDevelContributorSplit,
 695   @manualDevelContributorBig, 500 kB,
 696   @manualDevelContributorPdf, 2.8 MB}
 697
 698 @divEnd
 699
 700
 701 @divClass{column-center-top}
 702 @subheading Regression tests
 703
 704 @divClass{keep-bullets}
 705
 706 @ifclear web_version
 707
 708 @itemize
 709 @item
 710 @uref{../../input/regression/collated-files.html, Regression tests}:
 711 This release's regtests.
 712 (@uref{../../input/regression/collated-files.pdf, pdf version})
 713
 714 @item
 715 @uref{../../input/regression/musicxml/collated-files.html, MusicXML tests}:
 716 This release's musicXML tests.
 717 (@uref{../../input/regression/musicxml/collated-files.pdf, pdf version})
 718
 719 @item
 720 @uref{../../input/regression/abc2ly/collated-files.html, abc2ly tests}:
 721 This release's abc2ly tests.
 722 (@uref{../../input/regression/abc2ly/collated-files.pdf, pdf version})
 723
 724 @item
 725 @uref{../../input/regression/lilypond-book/collated-files.html, lilypond-book tests}:
 726 This release's lilypond-book tests.
 727 (@uref{../../input/regression/lilypond-book/collated-files.pdf, pdf version})
 728 @end itemize
 729
 730 @end ifclear
 731
 732 @ifset web_version
 733 @subsubheading Development version
 734
 735 @itemize
 736 @item @regtestDevel (@regtestDevelPdf{})
 737
 738 @item @regtestDevelXml (@regtestDevelXmlPdf{})
 739
 740 @item @regtestDevelAbc (@regtestDevelAbcPdf{})
 741
 742 @item @regtestDevelLilypondBook (@regtestDevelLilypondBookPdf{})
 743 @end itemize
 744
 745 @subsubheading Stable version
 746
 747 @itemize
 748 @item @regtestStable (@regtestStablePdf{})
 749
 750 @item @regtestStableXml (@regtestStableXmlPdf{})
 751
 752 @item @regtestStableAbc (@regtestStableAbcPdf{})
 753
 754 @item @regtestStableLilypondBook (@regtestStableLilypondBookPdf{})
 755 @end itemize
 756 @end ifset
 757
 758
 759 @subsubheading All versions
 760
 761 @itemize
 762 @item @uref{http://lilypond.org/test, Comparisons between regression tests}
 763
 764 @item @uref{http://lilypond.org/downloads/binaries/test-output/,
 765 Archive of all regression tests}
 766
 767 @end itemize
 768
 769 @divEnd
 770 @divEnd
 771
 772
 773
 774 @divClass{column-center-bottom}
 775 @subheading Manuals
 776
 777 @ifclear web_version
 778 @warning{These manuals are for LilyPond @version{}; the latest
 779 manuals can be found at @url{http://lilypond.org}}
 780 @end ifclear
 781
 782 @divClass{normal-table}
 783 @multitable @columnfractions .3 .3 .3
 784 @headitem Introduction
 785
 786 @item
 787 @docLinkSplit{Learning,learning,@manualDevelLearningSplit}
 788 @tab
 789 @docLinkBig{Learning,learning,@manualDevelLearningBig}
 790 @tab
 791 @docLinkPdf{Learning,learning,@manualDevelLearningPdf}
 792
 793 @item
 794 @docLinkSplit{Glossary,music-glossary,@manualDevelGlossarySplit}
 795 @tab
 796 @docLinkBig{Glossary,music-glossary,@manualDevelGlossaryBig}
 797 @tab
 798 @docLinkPdf{Glossary,music-glossary,@manualDevelGlossaryPdf}
 799
 800 @item
 801 @docLinkSplit{Essay,essay,@manualDevelEssaySplit}
 802 @tab
 803 @docLinkBig{Essay,essay,@manualDevelEssayBig}
 804 @tab
 805 @docLinkPdf{Essay,essay,@manualDevelEssayPdf}
 806 @end multitable
 807
 808 @multitable @columnfractions .3 .3 .3
 809 @headitem Regular
 810
 811 @item
 812 @docLinkSplit{Notation,notation,@manualDevelNotationSplit}
 813 @tab
 814 @docLinkBig{Notation,notation,@manualDevelNotationBig}
 815 @tab
 816 @docLinkPdf{Notation,notation,@manualDevelNotationPdf}
 817
 818 @item
 819 @docLinkSplit{Usage,usage,@manualDevelUsageSplit}
 820 @tab
 821 @docLinkBig{Usage,usage,@manualDevelUsageBig}
 822 @tab
 823 @docLinkPdf{Usage,usage,@manualDevelUsagePdf}
 824
 825 @item
 826 @docLinkSplit{Snippets,snippets,@manualDevelSnippetsSplit}
 827 @tab
 828 @docLinkBig{Snippets,snippets,@manualDevelSnippetsBig}
 829 @tab
 830 @docLinkPdf{Snippets,snippets,@manualDevelSnippetsPdf}
 831 @end multitable
 832
 833 @multitable @columnfractions .3 .3 .3
 834 @headitem Infrequent
 835
 836 @item
 837 @docLinkSplit{Web,web,@manualDevelWebSplit}
 838 @tab
 839 @docLinkBig{Web,web,@manualDevelWebBig}
 840 @tab
 841 @docLinkPdf{Web,web,@manualDevelWebPdf}
 842
 843 @item
 844 @docLinkSplit{Changes,changes,@manualDevelChangesSplit}
 845 @tab
 846 @docLinkBig{Changes,changes,@manualDevelChangesBig}
 847 @tab
 848 @docLinkPdf{Changes,changes,@manualDevelChangesPdf}
 849
 850 @item
 851 @docLinkSplit{Extending,extending,@manualDevelExtendingSplit}
 852 @tab
 853 @docLinkBig{Extending,extending,@manualDevelExtendingBig}
 854 @tab
 855 @docLinkPdf{Extending,extending,@manualDevelExtendingPdf}
 856
 857 @item
 858 @docLinkSplit{Internals,internals,@manualDevelInternalsSplit}
 859 @tab
 860 @docLinkBig{Internals,internals,@manualDevelInternalsBig}
 861 @tab
 862 @docLinkPdf{Internals,internals,@manualDevelInternalsPdf}
 863 @end multitable
 864
 865 @ifset web_version
 866 @multitable @columnfractions .3
 867 @headitem Downloadable
 868
 869 @item
 870 @doctarballDevel
 871 @end multitable
 872 @end ifset
 873
 874
 875 @divEnd
 876 @divEnd
 877
 878
 879
 880
 881 @node Google Summer of Code
 882 @unnumberedsec Google Summer of Code
 883
 884 @divClass{column-center-top}
 885 @subheading What is Google Summer of Code?
 886
 887 @uref{https://developers.google.com/open-source/gsoc/, GSoC} is a global
 888 program that offers students stipends to write code for free software
 889 and open source projects during the summer.  It is an excellent
 890 opportunity for students to gain experience with real-world software
 891 development and make a contribution that benefits everyone.  It brings
 892 new contributors to LilyPond and enables students who are already
 893 involved to become more involved.  LilyPond participates in GSoC as part
 894 of the @uref{http://www.gnu.org/, GNU project}.
 895
 896 We have had GSoC participants in 2012, 2015 and 2016 and encourage students
 897 to apply for future summers.
 898
 899 If you have questions or would like to apply, send us an email on our
 900 developer mailing list (see @ref{Contact}).
 901
 902 @divEnd
 903
 904 @divClass{column-center-middle-color2}
 905 @subheading Project Ideas List
 906
 907 Below is a list of suggested projects for GSoC or for anyone who is
 908 interested in helping to improve LilyPond. (Last updated: November 2016)
 909
 910 Mentor availability varies from project to project and from year to year.
 911 Send us an email on our developer mailing list (see @ref{Contact}), and
 912 we will help you find a mentor for a project that fits your interests
 913 and skills.
 914
 915 If you have ideas for a GSoC project that is not listed below you can
 916 send us an email as well.  There are a number of areas where LilyPond
 917 could be improved, and our development team is always willing to help
 918 those who would like to tackle a project like those listed below.
 919
 920 A full list of all the current open issues can be found
 921 @uref{http://sourceforge.net/p/testlilyissues/issues/, here}.
 922
 923 @divEnd
 924
 925 @divClass{column-center-middle-color3}
 926 @subheading Improve internal chord structure
 927
 928 The internal representation of LilyPond chords is not powerful enough
 929 to capture the nomenclature of jazz chords.  Currently the chord has
 930 a root, a bass and an inversion.  It would be nice to be able to handle
 931 stacked or polychords, minor/major, etc.  In order to do this, an
 932 internal representation with the ability to capture the essence of
 933 complex chords must be developed.  As a bonus, once the internal
 934 representation is developed, the output formatting of chord names can
 935 be improved.
 936
 937 @strong{Difficulty:} Easy/medium
 938 @strong{Requirements:} Scheme (Guile), but the level necessary can be
 939 easily learned
 940 @strong{Recommended:} Chord theory and naming
 941 @strong{Mentor:} Carl Sorensen
 942
 943 @divEnd
 944
 945 @divClass{column-center-middle-color3}
 946 @subheading Adding variants of font glyphs
 947
 948 @divClass{keep-bullets}
 949 @itemize
 950
 951 @item
 952 Adding @q{on} and @q{between} staff-line variants.
 953
 954 @item
 955 Shorter and narrower variants of some glyphs for example, accidentals.
 956 Another, more specific example could be an ancient notation breve
 957 notehead coming in two variants one with a small or big @q{hole} within
 958 it.
 959
 960 @end itemize
 961 @divEnd
 962
 963 @strong{Difficulty:} easy
 964 @strong{Requirements:} MetaFont, C++, good eye for details
 965 @strong{Recommended knowledge:} basic LilyPond knowledge
 966 @strong{Mentor:} Werner Lemberg
 967
 968 @divEnd
 969
 970 @divClass{column-center-middle-color3}
 971 @subheading Grace notes
 972
 973 Fix problems with synchronization of grace notes.  Grace notes can
 974 interfere with LilyPond's timing and cause odd effects, especially when
 975 multiple staffs are used where some have grace notes and others don't.
 976 This is one of the longest-standing and one of the more embarrassing
 977 @uref{https://sourceforge.net/p/testlilyissues/issues/34/,bugs} in
 978 LilyPond.
 979
 980 @strong{Difficulty:} medium
 981 @strong{Requirements:} C++, MIDI
 982 @strong{Recommended:} familiarity with LilyPond internals
 983 @strong{Potential Mentors:} Mike Solomon (not available for GSoC 2016),
 984 Carl Sorensen
 985
 986 @divEnd
 987
 988 @divClass{column-center-middle-color3}
 989 @subheading Improve default beam positioning
 990
 991 For regular, cross-staff, broken and kneed beams.  Beaming should depend
 992 on context and neighbor notes (see section 2.2 of
 993 @uref{http://imslp.org/wiki/Repository_of_Music-Notation_Mistakes_%28Coulon%2C_Jean-Pierre%29,
 994 this book}).  If possible also reduce beaming-computation time.
 995
 996 @strong{Difficulty:} medium
 997 @strong{Requirements:} C++, experience with writing heuristics
 998 @strong{Recommended knowledge:} aesthetic sense
 999 @strong{Potential Mentors:} Mike Solomon (not available for GSoC 2016),
1000 Carl Sorensen
1001
1002 @divEnd
1003
1004 @divClass{column-center-middle-color3}
1005 @subheading Help improve compilation behavior
1006
1007 Automatic code analysis tools, like valgrind memory leak detection or
1008 callgrind code profilers, provide valuable information about possible
1009 flaws in our C++ code.  Cleaning up warnings would allow us to automate
1010 the rejection of any patch which introduced extra warnings.
1011
1012 @strong{Difficulty:} medium
1013 @strong{Requirements:} C++
1014 @strong{Potential Mentors:} Reinhold Kainhofer (not available for GSoC
1015 2016), Joe Neeman
1016
1017 @divEnd
1018
1019 @divClass{column-center-middle-color3}
1020 @subheading MusicXML
1021
1022 Improving MusicXML import and export functions:
1023
1024 @divClass{keep-bullets}
1025 @itemize
1026
1027 @item
1028 Handle basic musical content export like the MIDI export (i.e. using
1029 dedicated exporter classes, derived from the translator class).
1030
1031 @item
1032 Build the XML tree of the basic musical content, add a connection from
1033 music event to XML tag.
1034
1035 @item
1036 Let all LilyPond engravers do their job.
1037
1038 @item
1039 Link each output object (i.e. each stencil or group of stencils) to the
1040 music cause (and thus to the XML tag in the XML tree).
1041
1042 @item
1043 Add an XML output backend, which can then add layout information for
1044 each output object to the XML tags.
1045
1046 @end itemize
1047 @divEnd
1048
1049 There are several possibilities for this project, including building upon
1050 the MusicXML export project from GSoC 2015.
1051
1052 @strong{Difficulty:} medium
1053 @strong{Requirements:} MusicXML, Python, Scheme, basic LilyPond knowledge
1054 @strong{Potential Mentors:} Reinhold Kainhofer, Mike Solomon (both not
1055 available for GSoC 2016)
1056
1057 Familiarity with other scorewriters (for cross-testing) would also help.
1058
1059 @divEnd
1060
1061 @divClass{column-center-middle-color3}
1062 @subheading Improve slurs and ties
1063
1064 The engraving quality of slurs and ties is often unsatisfactory. Ties
1065 @q{broken} by clef or staff changes are not handled well.  The project
1066 could include collecting and sorting examples of bad output, deciding on
1067 the intended output and writing code to improve them.
1068
1069 @strong{Difficulty:} hard
1070 @strong{Requirements:} C++, experience with writing heuristics
1071 @strong{Recommended knowledge:} LilyPond knowledge, aesthetic sense
1072 @strong{Potential Mentors:} Mike Solomon, Janek Warchoł (both not available for
1073 GSoC 2016)
1074
1075 @divEnd
1076
1077
1078 @node Authors
1079 @unnumberedsec Authors
1080
1081 @divClass{column-left-top}
1082 @subheading Current Development Team
1083
1084 @divClass{keep-bullets}
1085 @developersCurrent
1086 @divEnd
1087 @divEnd
1088
1089 @divClass{column-right-top}
1090 @subheading Previous Development Team
1091
1092 @divClass{keep-bullets}
1093 @developersPrevious
1094 @divEnd
1095 @divEnd
1096
1097
1098 @divClass{column-center-top}
1099 @subheading Current Contributors
1100
1101 @divClass{keep-bullets}
1102 @subsubheading Programming
1103
1104 @coreCurrent
1105
1106 @subsubheading Font
1107
1108 @fontCurrent
1109
1110 @subsubheading Documentation
1111
1112 @docCurrent
1113
1114 @subsubheading Bug squad
1115
1116 @bugsquadCurrent
1117
1118 @subsubheading Support
1119
1120 @supportCurrent
1121
1122 @subsubheading Translation
1123
1124 @translationsCurrent
1125
1126 @divEnd
1127 @divEnd
1128
1129
1130 @divClass{column-center-bottom}
1131 @subheading Previous Contributors
1132
1133 @divClass{keep-bullets}
1134 @subsubheading Programming
1135
1136 @corePrevious
1137
1138 @subsubheading Font
1139
1140 @fontPrevious
1141
1142 @subsubheading Documentation
1143
1144 @docPrevious
1145
1146 @c    uncomment when we have any previous members -gp
1147 @c @subsubheading Bug squad
1148
1149 @c @bugsquadCurrent
1150
1151 @subsubheading Support
1152
1153 @supportPrevious
1154
1155 @subsubheading Translation
1156
1157 @translationsPrevious
1158
1159 @divEnd
1160 @divEnd
1161
1162 @node Acknowledgements
1163 @unnumberedsec Acknowledgements
1164
1165 @divClass{column-center-top}
1166 @subheading Acknowledgements
1167
1168 @divClass{keep-bullets}
1169 @acknowledgementsCurrent
1170 @divEnd
1171 @divEnd
1172
1173
1174 @node Publications
1175 @unnumberedsec Publications
1176
1177 @divClass{column-center-top}
1178 @subheading What we wrote about LilyPond
1179
1180 @divClass{keep-bullets}
1181
1182 @include we-wrote.itexi
1183
1184 @divEnd
1185 @divEnd
1186
1187 @divClass{column-center-bottom}
1188 @subheading What people did with LilyPond
1189
1190 @divClass{keep-bullets}
1191
1192 @include others-did.itexi
1193
1194 @divEnd
1195 @divEnd
1196
1197 @contactUsAbout{academic papers}
1198
1199
1200 @node News
1201 @unnumberedsec News
1202
1203 @divClass{heading-center}
1204 @warning{Many old announcements and changelogs can be found in
1205 the @ref{Attic}}
1206 @divEnd
1207
1208 @include web/news-front.itexi
1209
1210 @include web/news.itexi
1211
1212
1213 @node Attic
1214 @unnumberedsec Attic
1215
1216 @divClass{column-center-top}
1217 @subheading Announcements
1218
1219 Announcements and news by version:
1220 @uref{http://lilypond.org/doc/v2.16/Documentation/web/index#Lilypond-2_002e16_002e0-released_0021-August-24_002c-2012-1,v2.16},
1221 @uref{http://lilypond.org/doc/v2.14/Documentation/web/index#LilyPond-2_002e14_002e0-released_0021-June-6_002c-2011,v2.14},
1222 @miscLink{announce-v2.12,v2.12},
1223 @miscLink{announce-v2.10,v2.10},
1224 @miscLink{announce-v2.8,v2.8},
1225 @miscLink{announce-v2.6,v2.6},
1226 @miscLink{announce-v2.4,v2.4},
1227 @miscLink{announce-v2.2,v2.2},
1228 @miscLink{announce-v2.0,v2.0},
1229 @miscLink{ANNOUNCE-1.2,v1.2},
1230 @miscLink{ANNOUNCE-1.0,v1.0},
1231 @miscLink{ANNOUNCE-0.1,v0.1}
1232
1233 Descriptive list of changes by version:
1234 @uref{http://lilypond.org/doc/v2.16/Documentation/changes/index.html,v2.16},
1235 @uref{http://lilypond.org/doc/v2.14/Documentation/changes/index.html,v2.14},
1236 @uref{http://lilypond.org/doc/v2.12/Documentation/topdocs/NEWS,v2.12},
1237 @uref{http://lilypond.org/doc/v2.10/Documentation/topdocs/NEWS,v2.10},
1238 @uref{http://lilypond.org/doc/v2.8/Documentation/topdocs/NEWS,v2.8},
1239 @uref{http://lilypond.org/doc/v2.6/Documentation/topdocs/NEWS,v2.6},
1240 @uref{http://lilypond.org/doc/v2.4/Documentation/topdocs/out-www/NEWS,v2.4},
1241 @uref{http://lilypond.org/doc/v2.2/Documentation/topdocs/out-www/NEWS,v2.2},
1242 @uref{http://lilypond.org/doc/v2.0/Documentation/topdocs/out-www/NEWS,v2.0},
1243 @uref{http://lilypond.org/doc/v1.8/Documentation/topdocs/out-www/NEWS,v1.8},
1244 @uref{http://lilypond.org/doc/v1.6/Documentation/out-www/NEWS,v1.6},
1245 @miscLink{NEWS-1.4,v1.4},
1246 @miscLink{NEWS-1.2,v1.2}
1247
1248 @divEnd
1249
1250 @divClass{column-center-bottom}
1251 @subheading Thanks
1252
1253 Thanks to developers, contributors, bug hunters and suggestions for
1254 @miscLink{THANKS-2.16,v2.16},
1255 @miscLink{THANKS-2.14,v2.14},
1256 @miscLink{THANKS-2.12,v2.12},
1257 @miscLink{THANKS-2.10,v2.10},
1258 @miscLink{THANKS-2.8,v2.8},
1259 @miscLink{THANKS-2.6,v2.6},
1260 @miscLink{THANKS-2.4,v2.4},
1261 @miscLink{THANKS-2.2,v2.2},
1262 @miscLink{THANKS-2.0,v2.0},
1263 @miscLink{THANKS-1.8,v1.8}
1264
1265 @divEnd
1266
1267 @divClass{column-center-bottom}
1268 @subheading Changelogs
1269
1270 Developers' changelogs by version:
1271 @miscLink{ChangeLog-2.10,v2.10},
1272 @miscLink{ChangeLog-2.3,v2.3},
1273 @miscLink{ChangeLog-2.1,v2.1},
1274 @miscLink{ChangeLog-1.5,v1.5 (1)},
1275 @miscLink{CHANGES-1.5,v1.5 (2)},
1276 @miscLink{CHANGES-1.4,v1.4},
1277 @miscLink{CHANGES-1.3,v1.3},
1278 @miscLink{CHANGES-1.2,v1.2},
1279 @miscLink{CHANGES-1.1,v1.1},
1280 @miscLink{CHANGES-1.0,v1.0},
1281 @miscLink{CHANGES-0.1,v0.1},
1282 @miscLink{CHANGES-0.0,v0.0}
1283
1284 @divEnd