]> git.donarmstrong.com Git - lilypond.git/blobdiff - Documentation/web/community.itexi
web: typo fix
[lilypond.git] / Documentation / web / community.itexi
index 2e73e1231755ce75312006f502adb39359adc031..d26509623a673974348adf5c68c25635c1f04b98 100644 (file)
@@ -13,6 +13,7 @@
 @node Community
 @unnumbered Community
 
+@divClass{link-headings}
 
 @divClass{column-center-top}
 @subheading Interacting with the community
@@ -40,6 +41,9 @@ discussing LilyPond.
 @item
 @ref{Help us}: your assistance is requested.
 
+@item
+@ref{Sponsoring}: financial contributions.
+
 @item
 @ref{Development}: for contributors and testers.
 
@@ -63,6 +67,7 @@ discussing LilyPond.
 @end itemize
 @divEnd
 
+@divEnd
 
 @divClass{hide}
 @menu
@@ -70,6 +75,7 @@ discussing LilyPond.
 * Tiny examples::
 * Bug reports::
 * Help us::
+* Sponsoring::
 * Development::
 * Authors::
 * Publications::
@@ -111,7 +117,7 @@ send to lilypond-user with gmane}
 
 The LilyPond Snippet Repository is a large collection of
 user-submitted examples, which can freely be copied and used
-in your owm works.  See what other people have written,
+in your own works.  See what other people have written,
 and add your own!
 
 @example
@@ -166,7 +172,7 @@ Spanish mailing list}
 German forum}
 
 @uref{http://groups.google.com/group/lilypond-brasil,
-Portugese group}
+Portuguese group}
 
 @uref{http://lists.gnu.org/mailman/listinfo/lilypond-user-fr,
 French mailing list}
@@ -260,6 +266,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
@@ -268,7 +281,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}
@@ -282,12 +295,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
@@ -300,39 +313,78 @@ 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
+    <cs' d'' b''>16 <cs' d'' b''>8.
+    %% Here: the tie on the D's looks funny
+    %% Too tall? Left-hand endpoint is not aligned with the B tie?
+    ~
+    <cs' d'' b''>8 [ <b d'' a''> ]
+  @}
+@}
+@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:
+  <c' d'' b''>8. ~ <c' d'' b''>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
@@ -370,14 +422,14 @@ every bug can be demonstrated in four notes or less!}
 Here is an example of a good bug report:
 
 @example
-%% the octavation command doesn't
-%% change the output at all!
-
-\version "2.10.0"
-\relative c''' @{
-  c1
-  #(set-octavation 1)
 c1
+% Accidentals should be printed for only
+% the first note in a tie, but this version
+% prints flats on both notes.
+\version "2.10.1"
+
+\relative c'' @{
+ bes1 ~
bes1
 @}
 @end example
 
@@ -389,23 +441,40 @@ Here is an example of a good bug report:
 Once you have verified that the issue is not already known and
 created a bug report, please send it to us!
 
-Unfortunately there is a strict @qq{no top-posting} check on the
-bug list, which is often incorrectly triggered by lilypond files.
-To avoid this, please add
+@divClass{keep-bullets}
+@itemize
+
+@item
+If you are subscribed to the @uref{mailto:bug-lilypond@@gnu.org,
+bug-lilypond@@gnu.org} mailing list, send an email like normal.
+
+@item
+If you are not subscribed, you can still post a bug report with
+the
+@uref{http://post.gmane.org/post.php?group=gmane.comp.gnu.lilypond.bugs,
+gmane lilypond.bugs web interface}.
+
+However, there is a strict @qq{no top-posting} check on the gmane
+interface, which is often incorrectly triggered by lilypond files.
+To avoid this, please add:
 
 @example
 > I'm not top posting.
 @end example
 
 @noindent
-(you must include the @code{>} ) to the top of your bug report.
+(you @emph{must} include the @code{>} ) to the top of your bug
+report.
 
-@uref{http://post.gmane.org/post.php?group=gmane.comp.gnu.lilypond.bugs,
-Post with the gmane lilypond.bugs interface}, or send an email to
-@uref{mailto:bug-lilypond@@gnu.prg, bug-lilypond@@gnu.org}.
+@end itemize
+@divEnd
+@divEnd
+
+@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
+examine the report.  Please allow up to 4 days, 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.
@@ -415,6 +484,17 @@ any activity on the bug occurs.  This requires you have a google
 account.
 @divEnd
 
+@divClass{column-center-bottom}
+@subheading Optional help: show the desired behavior
+
+Once an issue has been added to the tracker, it can be very
+helpful if we can see the desired output.  Feel free to add input
+code and/or images (possibly created with other tools) which
+demonstrate what you think it should look like!
+
+@divEnd
+
+
 
 @node Help us
 @unnumberedsec Help us
@@ -426,16 +506,96 @@ account.
 
 @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
@@ -449,10 +609,12 @@ account.
 @end ifset
 
 
+@c we normally don't allow named references, but in this case
+@c it's good to emphasize the "stable" part.  -gp
 @warning{These are @emph{unstable development} versions.  If you
 have the slightest doubt about how to use or install LilyPond, we
-urge you to use the stable @ref{Download}, and read the stable
-@ref{Manuals}.}
+urge you to use the @ref{Download, stable Download}, and read the
+@ref{Manuals, stable Manuals}.}
 
 @divEnd
 
@@ -525,10 +687,10 @@ stable, we have written a manual for development tasks.
 @subheading Regression tests
 
 @divClass{keep-bullets}
-@itemize
 
 @ifclear web_version
 
+@itemize
 @item
 @uref{../../input/regression/collated-files.html, Regression tests}:
 This release's regtests.
@@ -538,23 +700,57 @@ This release's regtests.
 @uref{../../input/regression/musicxml/collated-files.html, MusicXML tests}:
 This release's musicXML tests.
 (@uref{../../input/regression/musicxml/collated-files.pdf, pdf version})
+
+@item
+@uref{../../input/regression/abc2ly/collated-files.html, abc2ly tests}:
+This release's abc2ly tests.
+(@uref{../../input/regression/abc2ly/collated-files.pdf, pdf version})
+
+@item
+@uref{../../input/regression/lilypond-book/collated-files.html, lilypond-book tests}:
+This release's lilypond-book tests.
+(@uref{../../input/regression/lilypond-book/collated-files.pdf, pdf version})
+@end itemize
+
 @end ifclear
 
 @ifset web_version
+@subsubheading Development version
+
+@itemize
 @item @regtestDevel (@regtestDevelPdf{})
 
 @item @regtestDevelXml (@regtestDevelXmlPdf{})
 
+@item @regtestDevelAbc (@regtestDevelAbcPdf{})
+
+@item @regtestDevelLilypondBook (@regtestDevelLilypondBookPdf{})
+@end itemize
+
+@subsubheading Stable version
+
+@itemize
 @item @regtestStable (@regtestStablePdf{})
 
 @item @regtestStableXml (@regtestStableXmlPdf{})
+
+@item @regtestStableAbc (@regtestStableAbcPdf{})
+
+@item @regtestStableLilypondBook (@regtestStableLilypondBookPdf{})
+@end itemize
 @end ifset
 
 
-@item @uref{http://lilypond.org/test, Archive of regression tests}:
-Comparisons between versions.
+@subsubheading All versions
+
+@itemize
+@item @uref{http://lilypond.org/test, Comparisons between regression tests}
+
+@item @uref{http://lilypond.org/download/binaries/test-output/,
+Archive of all regression tests}
 
 @end itemize
+
 @divEnd
 @divEnd
 
@@ -663,9 +859,6 @@ manuals can be found at @url{http://lilypond.org}}
 @node Authors
 @unnumberedsec Authors
 
-@help{Under construction; this is not an accurate list!}
-
-
 @divClass{column-left-top}
 @subheading Current Development Team
 
@@ -756,55 +949,26 @@ manuals can be found at @url{http://lilypond.org}}
 @subheading What we wrote about LilyPond
 
 @divClass{keep-bullets}
-@itemize
 
-@item
-Han-Wen Nienhuys, @emph{LilyPond, Automated music formatting and
-the Art of Shipping}.  Forum Internacional Software Livre 2006
-(FISL7.0) (@uref{http://lilypond.org/web/images/FISL7-slides.pdf,
-PDF 1095k})
-
-@item
-Erik Sandberg, @emph{Separating input language and formatter in
-GNU LilyPond}. Master's Thesis, Uppsala University, Department of
-Information Technology March 2006.
-(@uref{http://lilypond.org/web/images/thesis-erik-sandberg.pdf,
-PDF 750k})
-
-@item
-Han-Wen Nienhuys and Jan Nieuwenhuizen, @emph{LilyPond, a system
-for automated music engraving}.  Proceedings of the XIV Colloquium
-on Musical Informatics (XIV CIM 2003), Firenze, Italy, May 2003.
-(@uref{ http://lilypond.org/web/images/xivcim.pdf, PDF 95k})
-
-@end itemize
+@include we-wrote.itexi
 
 @divEnd
 @divEnd
 
-
 @divClass{column-center-bottom}
 
 @subheading What people did with LilyPond
 
-@help{Yeah, this doesn't look bad at all... there's 20-50 papers
-out there that cite lilypond; somebody should find at least 3 or 4
-of them, so that it doesn't look so graham-specific.}
 
 @divClass{keep-bullets}
-@itemize
-
-@item
-Graham Percival, Tosten Anders, and George Tzanetakis,
-@emph{Generating Targeted Rhythmic Exercises for Music Students
-with Constraint Satisfaction Programming}, International Computer
-Music Conference 2008.
 
-@end itemize
+@include others-did.itexi
 
 @divEnd
 @divEnd
 
+@contactUsAbout{academic papers}
+
 
 @node Old news
 @unnumberedsec Old news
@@ -812,5 +976,3 @@ Music Conference 2008.
 @include web/news-front.itexi
 
 @include web/news.itexi
-
-