X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=Documentation%2Fweb%2Fcommunity.itexi;h=d06932a3ff44905ccc32aac598f7a4c9c1e35b42;hb=32a34dcef0c0041c6d62677487a380b5c8b85712;hp=d6918d1fbc0504526444c58c5edac755016938ac;hpb=f41973ff763d5972a85995b6d40c864281ec6714;p=lilypond.git diff --git a/Documentation/web/community.itexi b/Documentation/web/community.itexi index d6918d1fbc..d06932a3ff 100644 --- a/Documentation/web/community.itexi +++ b/Documentation/web/community.itexi @@ -41,9 +41,15 @@ discussing LilyPond. @item @ref{Help us}: your assistance is requested. +@item +@ref{Sponsoring}: financial contributions. + @item @ref{Development}: for contributors and testers. +@item +@ref{GSoC 2012}: our ideas for 2012 edition of Google Summer of Code. + @item @ref{Authors}: the people who made LilyPond what it is today. @@ -61,6 +67,9 @@ discussing LilyPond. @item @ref{Old news}: an archive. +@item +@ref{Attic}: announcements and changelogs from past versions. + @end itemize @divEnd @@ -72,10 +81,13 @@ discussing LilyPond. * Tiny examples:: * Bug reports:: * Help us:: +* Sponsoring:: * Development:: +* GSoC 2012:: * Authors:: * Publications:: * Old news:: +* Attic:: @end menu @divEnd @@ -262,6 +274,13 @@ guidelines for @ref{Bug reports}.} @divEnd +@divClass{column-right-bottom} +@subheading Sensitive emails + +Private matters should be sent to Graham Percival (project +manager), who will discuss it with those concerned. + +@divEnd @node Tiny examples @@ -270,7 +289,7 @@ guidelines for @ref{Bug reports}.} @divClass{column-center-top} @subheading What are @qq{Tiny examples}? -A tiny example is an example from which nothing can be removed. +A tiny example is an example from which @strong{nothing} can be removed. @divEnd @divClass{column-left-bottom} @@ -284,12 +303,12 @@ The simpler the example is, the quicker potential helpers can understand it and help you. @item -A simple example demonstrates that you have put effort towards +A tiny example demonstrates that you have put effort towards solving the problem yourself. When people send huge portions of -input, it looks like they don't care how if we help them or not. +input, it looks like they don't care if we help them or not. @item -Creating a tiny example forces you to understand what is +Creating a tiny example helps you to understand what is happening. Many false problem reports can be avoided by attempting to create a tiny example; if you cannot replicate a @qq{bug} in a tiny example, then the problem was probably an @@ -302,50 +321,93 @@ insufficient understanding of LilyPond, not an actual bug! @divClass{column-right-bottom} -@subheading How do I create them? +@subheading How to create them? @divClass{keep-bullets} @itemize @item -Include the \version number. +Include the @code{\version} number. @item Make it small! Examples about spacing or page layout might require many bars of music, but most issues can be reproduced -using only a single measure. +using less than a single measure. @item When trying to create an example, try commenting out @w{(@code{%} -or @code{%@{ @dots{} %@}})} sections of your file. If you can -comment something while still demonstrating the main idea, then -remove the commented-material! +or @code{%@{ @dots{} %@}})} sections of your file. If you +can comment something while still demonstrating the main idea, +then remove the commented-material. @item -Avoid using complicated notes, keys, or time signatures, unless +Avoid using complicated notes, keys or time signatures, unless the bug is about the behavior of those items. @item Do not use @code{\override} or @code{\set} commands unless the bug -is about those particular commands. +is about those specific commands. + +@item +Optionally, attach an image showing the desired graphical output. @end itemize @divEnd @divEnd +@divClass{column-center-bottom} +@subheading How tiny should they be? +Is the code below a minimal example? + +@example +\version "2.14.1" +\include "english.ly" + +\score @{ + \new Staff @{ + \key d \major + \numericTimeSignature + \time 2/4 + 16 8. + %% Here: the tie on the D's looks funny + %% Too tall? Left-hand endpoint is not aligned with the B tie? + ~ + 8 [ ] + @} +@} +@end example + +Well, it is not very big, but a truly minimal example is here: + +@example +\version "2.14.1" +@{ + % middle tie looks funny here: + 8. ~ 8 +@} +@end example + +Very few tiny examples exceed 10 lines of code - +quite often 4 lines are enough to demonstrate the problem! + +@divEnd @node Bug reports @unnumberedsec Bug reports + +@divClass{heading-center} +If you have input that results in a crash or wrong output, +then that is a bug. +@divEnd + @divClass{column-center-top} @subheading Step 1: Known bugs -If you have input that results in a crash or an erroneous output, -then that is a bug. There is a list of current bugs on our google -bug tracker, +We may already know about this bug. Check here: @example @uref{http://code.google.com/p/lilypond/issues/list} @@ -361,12 +423,12 @@ free to add more information to that report.} @divClass{column-left-bottom} @subheading Step 2: Creating a bug report -If you have discovered a bug which is not listed, please help us -by creating a bug report. +If you have discovered a bug which is not listed, +please help us by creating a bug report. -@warning{We only accept bug reports in the form of -@ref{Tiny examples}. We have very limited resources to deal with -bug reports, so any non-minimal example will be rejected. Almost +@warning{We only accept reports in the form of +@ref{Tiny examples}. We have very limited resources, +so any non-minimal example will be rejected. Almost every bug can be demonstrated in four notes or less!} Here is an example of a good bug report: @@ -423,13 +485,14 @@ report. @divClass{column-center-bottom} @subheading Step 4: Wait for a response -Once your bug has been sent to the list, our Bug Squad will -examine the report. Please allow up to 24 hours, as we have a -limited number of volunteers for this task. They may ask you for -more information, or may add the report to the tracker and let you -know what the issue number is. +Once your bug report has been sent to the list, our Bug Squad will +examine it; they may ask you for more information. You will be notified +when the report will be added to the bug tracker. Please allow up to 4 days, +as we have a limited number of volunteers for this task. -You may mark the bug so that you automatically receive emails when +Once a bug has been added to the tracker, you can comment it to add +more information about it. +You may also mark the bug so that you automatically receive emails when any activity on the bug occurs. This requires you have a google account. @divEnd @@ -456,16 +519,96 @@ demonstrate what you think it should look like! @divClass{column-left-top} @divClass{keep-bullets} -@helpusTasks +@helpusSimple @divEnd @divEnd @divClass{column-right-top} -@helpusProjects +@helpusAdvanced + +@divEnd + + +@node Sponsoring +@unnumberedsec Sponsoring + +@divClass{keep-bullets} +@divClass{column-left-top} +@subheading Bounties + +In the past, + +@itemize +@item some users have paid for new features +@item some developers have added new features for hire +@end itemize + +The LilyPond project does not organize such efforts; we neither +endorse nor discourage such agreements. Any contracts between +private individuals is the business of those individuals, not +ours. + +@divEnd + +@divClass{column-right-top} +@subheading Guidelines + +Any user wanting to offer money in exchange for work should bear +in mind the following points: + +@itemize +@item +LilyPond developers may advertise their services on the lilypond +email lists from time to time. + +@item +Any agreements between private individuals should include the +normal precautions when conducting business: who pays, how much do +they pay, with what method of payment, and upon what set of +conditions. We suggest that any ambiguity or uncertainty in these +questions should be resolved before any work begins. + +@end itemize @divEnd +@divClass{column-center-bottom} +@subheading Interested developers + +Here is a list of people who have expressed an interest in +bounties. Note that the amount of work done by individuals varies +quite a bit throughout the years. We do not guarantee that this +list is up-to-date, nor do we guarantee that the people listed +here have any ability. The only criteria is "XYZ asked to be +listed on this page". + +Looking at the git history is a good way to determine who the most +active and experienced developers are. Statistics up to version +@versionDevel{}: + +@multitable @columnfractions .3 .3 .3 +@item @uref{http://lilypond.org/~graham/gitstats-all/, overall history} +@tab @uref{http://lilypond.org/~graham/gitstats-1year/, past year} +@tab @uref{http://lilypond.org/~graham/gitstats-3months/, past three months} +@end multitable + +Interested developers: +@table @asis +@item @email{dak@@gnu.org, David Kastrup} +Donations are required to let me continue my current fulltime work on +LilyPond. I focus on user and programmer interface design, coherence, +implementation, simplification, documentation, and debugging. + +@c Format +@c @item @email{name@@adress.domain, Name} +@c area of interest (256 chars max) + +@end table + +@divEnd +@divEnd + @node Development @unnumberedsec Development @@ -726,6 +869,165 @@ manuals can be found at @url{http://lilypond.org}} +@node GSoC 2012 +@unnumberedsec GSoC 2012 + +@divClass{column-center-top} +@subheading What is Google Summer of Code? + +It is a global program run by Google that offers students stipends +for working on open source software projects during summer vacations. + +The LilyPond Team decided that this is an excellent opportunity to find +new contributors and encourage students already participating in LilyPond +development to become more involved. One of our contributors was accepted +for 2012 edition of the program as part of the +@uref{http://www.gnu.org/, GNU project}; +we hope to participate in future editions as well. + +@divEnd + +@divClass{column-center-bottom} +@subheading Our 2012 Ideas List + +Below is a list of projects that we suggested for GSoC 2012 students. +Although the application period is over, we decided to keep this webpage +online as an inspiration for anyone who is interested in developing LilyPond. +Some members of the development team are willing to help people who would like +to tackle these projects. + +Of course, there are many more things to improve in LilyPond, including +very small ones. A full list of all known issues can be found +@uref{http://code.google.com/p/lilypond/issues/list, here}. + +@subheading Grace notes + +Fix problems with synchronization of grace notes, +together with all underlying architecture (see +@uref{http://code.google.com/p/lilypond/issues/detail?id=34, +issue 34 in our tracker}). Grace notes are confusing to LilyPond's +timing because they're like going back in time. This causes weird +effects, especially when one staff has a grace note and the other +doesn't. + +@strong{Difficulty:} medium + +@strong{Requirements:} C++, MIDI + +@strong{Recommended:} familiarity with LilyPond internals + +@strong{Mentor(s):} Mike Solomon, Carl Sorensen + +@subheading MusicXML + +Adding comprehensive MusicXML export and improving import, +together with tests checking that it works. Depending on time available, +implement some or all of the following: + +@divClass{keep-bullets} +@itemize + +@item +Handle basic musical content export like the MIDI export (i.e. using +dedicated exporter classes, derived from the translator class) + +@item +Build the XML tree of the basic musical content, +add a connection from music event to XML tag + +@item +Let all LilyPond engravers do their job + +@item +Add ability to link each output object +(basically each stencil / group of stencils) to the music cause +(and thus to the XML tag in the XML tree) + +@item +Add a XML output backend, which can then add the layout information +for each output object to the XML tags + +@end itemize +@divEnd + +The goal will be considered achieved when a (previously chosen) score +could be imported from MusicXML and exported back with no unintentional +loss of data. + +@strong{Difficulty:} medium + +@strong{Requirements:} MusicXML, Python, basic LilyPond knowledge + +@strong{Mentor(s):} Reinhold Kainhofer, Mike Solomon + +Familiarity with other scorewriters (for cross-testing) would be a nice +bonus. + +@subheading Improve slurs and ties + +The default shape of slur and tie curves is often unsatisfactory. +Ties on enharmonic notes @code{@{ cis'~ des' @}} are not supported, +ties "broken" by clef or staff change aren't supported well. +The project includes collecting and sorting examples of bad output, +deciding on the intended output and writing the actual code. + +@strong{Difficulty:} hard + +@strong{Requirements:} C++, experience with writing heuristics + +@strong{Recommended knowledge:} LilyPond knowledge, aesthetic sense + +@strong{Mentor(s):} Mike Solomon + +@subheading Adding special variant of font glyphs +Adding on-staff-line, between-staff-line, shorter and narrower variants +of some glyphs, for example accidentals, together with a generic +infrastructure to support them. An example is ancient notation breve +notehead coming in two variants, with smaller and bigger hole. + +@strong{Difficulty:} easy + +@strong{Requirements:} MetaFont, C++, good eye for details + +@strong{Recommended knowledge:} basic LilyPond knowledge + +@strong{Mentor(s):} Werner Lemberg + +@subheading Improve beaming + +Default positioning of regular, cross-staff, broken and kneed beams +should be improved. Beaming should depend on context and neighbor notes +(see @uref{http://icking-music-archive.org/lists/sottisier/sottieng.pdf, +section 2.2 here}). If possible, reduce beaming computation time. + +@strong{Difficulty:} medium + +@strong{Requirements:} C++, experience with writing heuristics + +@strong{Recommended knowledge:} aesthetic sense + +@strong{Mentor(s):} Mike Solomon, Carl Sorensen + +@subheading Clean up various compilation warnings + +Clean up compiler warnings, static code analysis, and valgrind warnings. +Automatic code analysis tools (warnings in @code{g++} and @code{clang}) +and analysis tools like valgrind memory leak detection and callgrind +code profilers provide valuable information about possible flaws in C++ +code. Cleaning these warnings would allow us to automatically reject +any patch which introduced extra warnings. + +@strong{Difficulty:} medium + +@strong{Requirements:} C++ + +@strong{Mentor(s):} Joe Neeman, Reinhold Kainhofer + +@divEnd + + + + @node Authors @unnumberedsec Authors @@ -826,10 +1128,8 @@ manuals can be found at @url{http://lilypond.org}} @divEnd @divClass{column-center-bottom} - @subheading What people did with LilyPond - @divClass{keep-bullets} @include others-did.itexi @@ -843,6 +1143,66 @@ manuals can be found at @url{http://lilypond.org}} @node Old news @unnumberedsec Old news +@divClass{heading-center} +@warning{Many old announcements and changelogs can be found in +the @ref{Attic}} +@divEnd + @include web/news-front.itexi @include web/news.itexi + + +@node Attic +@unnumberedsec Attic + +@divClass{column-center-top} +@subheading Announcements + +Announcements and news by version: +@uref{http://lilypond.org/doc/v2.14/Documentation/web/index#LilyPond-2_002e14_002e0-released_0021-June-6_002c-2011,v2.14}, +@miscLink{announce-v2.12,v2.12}, +@miscLink{announce-v2.10,v2.10}, +@miscLink{announce-v2.8,v2.8}, +@miscLink{announce-v2.6,v2.6}, +@miscLink{announce-v2.4,v2.4}, +@miscLink{announce-v2.2,v2.2}, +@miscLink{announce-v2.0,v2.0}, +@miscLink{ANNOUNCE-1.2,v1.2}, +@miscLink{ANNOUNCE-1.0,v1.0}, +@miscLink{ANNOUNCE-0.1,v0.1} + +Descriptive list of changes by version: +@uref{http://lilypond.org/doc/v2.14/Documentation/changes/index.html,v2.14}, +@uref{http://lilypond.org/doc/v2.12/Documentation/topdocs/NEWS,v2.12}, +@uref{http://lilypond.org/doc/v2.10/Documentation/topdocs/NEWS,v2.10}, +@uref{http://lilypond.org/doc/v2.8/Documentation/topdocs/NEWS,v2.8}, +@uref{http://lilypond.org/doc/v2.6/Documentation/topdocs/NEWS,v2.6}, +@uref{http://lilypond.org/doc/v2.4/Documentation/topdocs/out-www/NEWS,v2.4}, +@uref{http://lilypond.org/doc/v2.2/Documentation/topdocs/out-www/NEWS,v2.2}, +@uref{http://lilypond.org/doc/v2.0/Documentation/topdocs/out-www/NEWS,v2.0}, +@uref{http://lilypond.org/doc/v1.8/Documentation/topdocs/out-www/NEWS,v1.8}, +@uref{http://lilypond.org/doc/v1.6/Documentation/out-www/NEWS,v1.6}, +@miscLink{NEWS-1.4,v1.4}, +@miscLink{NEWS-1.2,v1.2} + +@divEnd + +@divClass{column-center-bottom} +@subheading Changelogs + +Developers' changelogs by version: +@miscLink{ChangeLog-2.10,v2.10}, +@miscLink{ChangeLog-2.3,v2.3}, +@miscLink{ChangeLog-2.1,v2.1}, +@miscLink{ChangeLog-1.5,v1.5 (1)}, +@miscLink{CHANGES-1.5,v1.5 (2)}, +@miscLink{CHANGES-1.4,v1.4}, +@miscLink{CHANGES-1.3,v1.3}, +@miscLink{CHANGES-1.2,v1.2}, +@miscLink{CHANGES-1.1,v1.1}, +@miscLink{CHANGES-1.0,v1.0}, +@miscLink{CHANGES-0.1,v0.1}, +@miscLink{CHANGES-0.0,v0.0} + +@divEnd