1 @c -*- coding: utf-8; mode: texinfo; -*-
3 Translation of GIT committish: FILL-IN-HEAD-COMMITTISH
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..
10 @include included/authors.itexi
11 @include included/helpus.itexi
16 @divClass{link-headings}
18 @divClass{column-center-top}
19 @subheading Interacting with the community
24 @ref{Contact}: get help, discuss, and keep in touch!
27 @ref{Tiny examples}: these are @emph{highly} recommended when
31 @ref{Bug reports}: something went wrong.
36 @divClass{column-left-bottom}
37 @subheading Making LilyPond better
42 @ref{Help us}: your assistance is requested.
45 @ref{Sponsoring}: financial contributions.
48 @ref{Development}: for contributors and testers.
51 @ref{Authors}: the people who made LilyPond what it is today.
56 @divClass{column-right-bottom}
57 @subheading Miscellaneous
62 @ref{Publications}: what we wrote, and have had written about us.
65 @ref{Old news}: an archive.
88 @unnumberedsec Contact
91 @divClass{column-left-bottom}
92 @subheading User Discussions and Help
94 @subsubheading User mailing list: @code{lilypond-user@@gnu.org}
96 This mailing list is the main place for users to discuss and help
100 @uref{http://lists.gnu.org/mailman/listinfo/lilypond-user,
101 lilypond-user subscribe and info}
103 @uref{http://lists.gnu.org/archive/html/lilypond-user/,
105 @uref{http://www.mail-archive.com/lilypond-user@@gnu.org/,
107 @uref{http://dir.gmane.org/gmane.comp.gnu.lilypond.general,
110 @uref{http://post.gmane.org/post.php?group=gmane.comp.gnu.lilypond.general,
111 send to lilypond-user with gmane}
114 @warning{When asking questions, please use @ref{Tiny examples}!}
116 @subsubheading LilyPond Snippet Repository
118 The LilyPond Snippet Repository is a large collection of
119 user-submitted examples, which can freely be copied and used
120 in your own works. See what other people have written,
124 @uref{http://lsr.dsi.unimi.it}
127 Particularly instructive examples from LSR are included in our
128 official documentation, in @ref{Snippets}.
133 Some level of support is provided on our IRC channel,
136 @uref{irc://irc.freenode.net/lilypond, #lilypond@@irc.freenode.net}
139 This channel has no public archive, so any question that may
140 be useful for others would better be posted to one of the mailing lists.
143 <form action="http://webchat.freenode.net"
147 <input name="nick" type="text" size="15" value="">
149 <input name="channels" type="hidden" value="lilypond">
150 <input type="submit" value="Join #lilypond IRC Chat">
153 <script language="JavaScript" type="text/javascript">
154 var username = "web";
155 var lang = window.navigator.userLanguage ? window.navigator.userLanguage
156 : window.navigator.language;
157 username += '-' + lang.substr(0, 2);
158 username += '-' + navigator.appName.substr(0, 2);
159 username += navigator.appCodeName.replace (" ", "").substr(0, 2);
160 username += navigator.platform.replace (" ", "").replace("nux", "").replace("n32", "");
161 document.forms["f_lily_irc"].nick.value = username;
165 @subsubheading Other languages
168 @uref{http://lists.gnu.org/mailman/listinfo/lilypond-es,
169 Spanish mailing list}
171 @uref{http://www.lilypondforum.de/,
174 @uref{http://groups.google.com/group/lilypond-brasil,
177 @uref{http://lists.gnu.org/mailman/listinfo/lilypond-user-fr,
180 @uref{http://www.lilypondforum.nl/,
187 @divClass{column-right-top}
188 @subheading Stay Informed
190 @subsubheading LilyPond Report
192 The easiest way to keep touch is by reading our community
193 newsletter, the LilyPond Report:
196 @uref{http://news.lilynet.net}
199 @subsubheading Releases mailing list: @code{info-lilypond@@gnu.org}
201 This mailing list is a low-volume, read-only list which receives
202 notifications of new releases.
205 @uref{http://lists.gnu.org/mailman/listinfo/info-lilypond,
206 info-lilypond subscribe and info}
208 @uref{http://lists.gnu.org/archive/html/info-lilypond/,
210 @uref{http://www.mail-archive.com/info-lilypond@@gnu.org/,
212 @uref{http://dir.gmane.org/gmane.comp.gnu.lilypond.announce,
215 @c don't include gmane posting here. -gp
222 @divClass{column-right-bottom}
223 @subheading Developer Discussion
225 @subsubheading Developer mailing list: @code{lilypond-devel@@gnu.org}
227 Most developer discussion takes place on this list. Patches
231 @uref{http://lists.gnu.org/mailman/listinfo/lilypond-devel,
232 lilypond-devel subscribe and info}
234 @uref{http://lists.gnu.org/archive/html/lilypond-devel/,
236 @uref{http://www.mail-archive.com/lilypond-devel@@gnu.org/,
238 @uref{http://dir.gmane.org/gmane.comp.gnu.lilypond.devel,
241 @uref{http://post.gmane.org/post.php?group=gmane.comp.gnu.lilypond.devel,
242 send to lilypond-devel with gmane}
246 @subsubheading Bug mailing list: @code{bug-lilypond@@gnu.org}
248 Bug-specific discussion takes place here.
251 @uref{http://lists.gnu.org/mailman/listinfo/bug-lilypond,
252 bug-lilypond subscribe and info}
254 @uref{http://lists.gnu.org/archive/html/bug-lilypond/,
256 @uref{http://www.mail-archive.com/bug-lilypond@@gnu.org/,
258 @uref{http://dir.gmane.org/gmane.comp.gnu.lilypond.bugs,
261 @c don't include gmane posting here. -gp
264 @warning{Before sending a message to the bug list, please read our
265 guidelines for @ref{Bug reports}.}
269 @divClass{column-right-bottom}
270 @subheading Sensitive emails
272 Private matters should be sent to Graham Percival (project
273 manager), who will discuss it with those concerned.
279 @unnumberedsec Tiny examples
281 @divClass{column-center-top}
282 @subheading What are @qq{Tiny examples}?
284 A tiny example is an example from which @strong{nothing} can be removed.
287 @divClass{column-left-bottom}
288 @subheading Why create them?
290 @divClass{keep-bullets}
294 The simpler the example is, the quicker potential helpers can
295 understand it and help you.
298 A tiny example demonstrates that you have put effort towards
299 solving the problem yourself. When people send huge portions of
300 input, it looks like they don't care if we help them or not.
303 Creating a tiny example helps you to understand what is
304 happening. Many false problem reports can be avoided by
305 attempting to create a tiny example; if you cannot replicate a
306 @qq{bug} in a tiny example, then the problem was probably an
307 insufficient understanding of LilyPond, not an actual bug!
315 @divClass{column-right-bottom}
316 @subheading How to create them?
318 @divClass{keep-bullets}
322 Include the @code{\version} number.
325 Make it small! Examples about spacing or page layout might
326 require many bars of music, but most issues can be reproduced
327 using less than a single measure.
330 When trying to create an example, try commenting out @w{(@code{%}
331 or @code{%@{ @dots{} %@}})} sections of your file. If you
332 can comment something while still demonstrating the main idea,
333 then remove the commented-material.
336 Avoid using complicated notes, keys or time signatures, unless
337 the bug is about the behavior of those items.
340 Do not use @code{\override} or @code{\set} commands unless the bug
341 is about those specific commands.
344 Optionally, attach an image showing the desired graphical output.
351 @divClass{column-center-bottom}
352 @subheading How tiny should they be?
354 Is the code below a minimal example?
358 \include "english.ly"
363 \numericTimeSignature
365 <cs' d'' b''>16 <cs' d'' b''>8.
366 %% Here: the tie on the D's looks funny
367 %% Too tall? Left-hand endpoint is not aligned with the B tie?
369 <cs' d'' b''>8 [ <b d'' a''> ]
374 Well, it is not very big, but a truly minimal example is here:
379 % middle tie looks funny here:
380 <c' d'' b''>8. ~ <c' d'' b''>8
384 Very few tiny examples exceed 10 lines of code -
385 quite often 4 lines are enough to demonstrate the problem!
391 @unnumberedsec Bug reports
394 @divClass{heading-center}
395 If you have input that results in a crash or wrong output,
399 @divClass{column-center-top}
400 @subheading Step 1: Known bugs
402 We may already know about this bug. Check here:
405 @uref{http://code.google.com/p/lilypond/issues/list}
408 @warning{Please @strong{DO NOT} add bug reports to the
409 bug tracker yourself.}
414 @divClass{column-left-bottom}
415 @subheading Step 2: Creating a bug report
417 If you have discovered a bug which is not listed,
418 please help us by creating a bug report.
420 @warning{We only accept reports in the form of
421 @ref{Tiny examples}. We have very limited resources,
422 so any non-minimal example will be rejected. Almost
423 every bug can be demonstrated in four notes or less!}
425 Here is an example of a good bug report:
428 % Accidentals should be printed for only
429 % the first note in a tie, but this version
430 % prints flats on both notes.
441 @divClass{column-right-bottom}
442 @subheading Step 3: Sending a bug report
444 Once you have verified that the issue is not already known and
445 created a bug report, please send it to us!
447 @divClass{keep-bullets}
451 If you are subscribed to the @uref{mailto:bug-lilypond@@gnu.org,
452 bug-lilypond@@gnu.org} mailing list, send an email like normal.
455 If you are not subscribed, you can still post a bug report with
457 @uref{http://post.gmane.org/post.php?group=gmane.comp.gnu.lilypond.bugs,
458 gmane lilypond.bugs web interface}.
460 However, there is a strict @qq{no top-posting} check on the gmane
461 interface, which is often incorrectly triggered by lilypond files.
462 To avoid this, please add:
465 > I'm not top posting.
469 (you @emph{must} include the @code{>} ) to the top of your bug
476 @divClass{column-center-bottom}
477 @subheading Step 4: Wait for a response
479 Once your bug report has been sent to the list, our Bug Squad will
480 examine it; they may ask you for more information. You will be notified
481 when the report will be added to the bug tracker. Please allow up to 4 days,
482 as we have a limited number of volunteers for this task.
484 Once a bug has been added to the tracker, you can comment it to add
485 more information about it.
486 You may also mark the bug so that you automatically receive emails when
487 any activity on the bug occurs. This requires you have a google
491 @divClass{column-center-bottom}
492 @subheading Optional help: show the desired behavior
494 Once an issue has been added to the tracker, it can be very
495 helpful if we can see the desired output. Feel free to add input
496 code and/or images (possibly created with other tools) which
497 demonstrate what you think it should look like!
504 @unnumberedsec Help us
506 @divClass{column-center-top}
511 @divClass{column-left-top}
512 @divClass{keep-bullets}
518 @divClass{column-right-top}
525 @unnumberedsec Sponsoring
527 @divClass{keep-bullets}
528 @divClass{column-left-top}
534 @item some users have paid for new features
535 @item some developers have added new features for hire
538 The LilyPond project does not organize such efforts; we neither
539 endorse nor discourage such agreements. Any contracts between
540 private individuals is the business of those individuals, not
545 @divClass{column-right-top}
546 @subheading Guidelines
548 Any user wanting to offer money in exchange for work should bear
549 in mind the following points:
553 LilyPond developers may advertise their services on the lilypond
554 email lists from time to time.
557 Any agreements between private individuals should include the
558 normal precautions when conducting business: who pays, how much do
559 they pay, with what method of payment, and upon what set of
560 conditions. We suggest that any ambiguity or uncertainty in these
561 questions should be resolved before any work begins.
567 @divClass{column-center-bottom}
568 @subheading Interested developers
570 Here is a list of people who have expressed an interest in
571 bounties. Note that the amount of work done by individuals varies
572 quite a bit throughout the years. We do not guarantee that this
573 list is up-to-date, nor do we guarantee that the people listed
574 here have any ability. The only criteria is "XYZ asked to be
575 listed on this page".
577 Looking at the git history is a good way to determine who the most
578 active and experienced developers are. Statistics up to version
581 @multitable @columnfractions .3 .3 .3
582 @item @uref{http://lilypond.org/~graham/gitstats-all/, overall history}
583 @tab @uref{http://lilypond.org/~graham/gitstats-1year/, past year}
584 @tab @uref{http://lilypond.org/~graham/gitstats-3months/, past three months}
587 Interested developers:
589 @item @email{dak@@gnu.org, David Kastrup}
590 Donations are required to let me continue my current fulltime work on
591 LilyPond. I focus on user and programmer interface design, coherence,
592 implementation, simplification, documentation, and debugging.
595 @c @item @email{name@@adress.domain, Name}
596 @c area of interest (256 chars max)
605 @unnumberedsec Development
607 @divClass{heading-center}
609 @heading Development for LilyPond @version
612 @heading Development for LilyPond @versionDevel
616 @c we normally don't allow named references, but in this case
617 @c it's good to emphasize the "stable" part. -gp
618 @warning{These are @emph{unstable development} versions. If you
619 have the slightest doubt about how to use or install LilyPond, we
620 urge you to use the @ref{Download, stable Download}, and read the
621 @ref{Manuals, stable Manuals}.}
625 @divClass{column-center-top}
626 @subheading Release numbers
628 There are two sets of releases for LilyPond: stable releases, and
629 unstable development releases. Stable versions have an
630 even-numbered @q{minor} version number (e.g., 2.8, 2.10, 2.12).
631 Development versions have an odd-numbered @q{minor} version number
632 (e.g., 2.7, 2.9, 2.11).
637 @divClass{column-left-top}
640 Instructions for git and compiling are in the Contributor's Guide.
643 @uref{http://git.sv.gnu.org/gitweb/?p=lilypond.git, lilypond git repository}
646 Documentation writers and testers will generally want to download
651 @downloadDevelLinuxNormal
653 @downloadDevelLinuxBig
655 @downloadDevelLinuxPPC
657 @downloadDevelFreeBSDNormal
659 @downloadDevelFreeBSDBig
661 @downloadDevelDarwinNormal
663 @downloadDevelDarwinPPC
665 @downloadDevelWindows
674 @divClass{column-right-top}
675 @subheading Contributor's Guide
677 LilyPond development is a fairly complicated matter. In order to
678 help new contributors, and to keep the whole system (mostly)
679 stable, we have written a manual for development tasks.
681 @docLinksBare{Contributor's Guide, contributor,
682 @rcontribnamed{Top,Contributor's Guide},
683 @manualDevelContributorSplit,
684 @manualDevelContributorBig, 500 kB,
685 @manualDevelContributorPdf, 2.8 MB}
690 @divClass{column-center-top}
691 @subheading Regression tests
693 @divClass{keep-bullets}
699 @uref{../../input/regression/collated-files.html, Regression tests}:
700 This release's regtests.
701 (@uref{../../input/regression/collated-files.pdf, pdf version})
704 @uref{../../input/regression/musicxml/collated-files.html, MusicXML tests}:
705 This release's musicXML tests.
706 (@uref{../../input/regression/musicxml/collated-files.pdf, pdf version})
709 @uref{../../input/regression/abc2ly/collated-files.html, abc2ly tests}:
710 This release's abc2ly tests.
711 (@uref{../../input/regression/abc2ly/collated-files.pdf, pdf version})
714 @uref{../../input/regression/lilypond-book/collated-files.html, lilypond-book tests}:
715 This release's lilypond-book tests.
716 (@uref{../../input/regression/lilypond-book/collated-files.pdf, pdf version})
722 @subsubheading Development version
725 @item @regtestDevel (@regtestDevelPdf{})
727 @item @regtestDevelXml (@regtestDevelXmlPdf{})
729 @item @regtestDevelAbc (@regtestDevelAbcPdf{})
731 @item @regtestDevelLilypondBook (@regtestDevelLilypondBookPdf{})
734 @subsubheading Stable version
737 @item @regtestStable (@regtestStablePdf{})
739 @item @regtestStableXml (@regtestStableXmlPdf{})
741 @item @regtestStableAbc (@regtestStableAbcPdf{})
743 @item @regtestStableLilypondBook (@regtestStableLilypondBookPdf{})
748 @subsubheading All versions
751 @item @uref{http://lilypond.org/test, Comparisons between regression tests}
753 @item @uref{http://lilypond.org/download/binaries/test-output/,
754 Archive of all regression tests}
763 @divClass{column-center-bottom}
767 @warning{These manuals are for LilyPond @version{}; the latest
768 manuals can be found at @url{http://lilypond.org}}
771 @divClass{normal-table}
772 @multitable @columnfractions .3 .3 .3
773 @headitem Introduction
775 @docLinkSplit{Learning,learning,@manualDevelLearningSplit}
777 @docLinkBig{Learning,learning,@manualDevelLearningBig}
779 @docLinkPdf{Learning,learning,@manualDevelLearningPdf}
782 @docLinkSplit{Glossary,music-glossary,@manualDevelGlossarySplit}
784 @docLinkBig{Glossary,music-glossary,@manualDevelGlossaryBig}
786 @docLinkPdf{Glossary,music-glossary,@manualDevelGlossaryPdf}
789 @docLinkSplit{Essay,essay,@manualDevelEssaySplit}
791 @docLinkBig{Essay,essay,@manualDevelEssayBig}
793 @docLinkPdf{Essay,essay,@manualDevelEssayPdf}
798 @docLinkSplit{Notation,notation,@manualDevelNotationSplit}
800 @docLinkBig{Notation,notation,@manualDevelNotationBig}
802 @docLinkPdf{Notation,notation,@manualDevelNotationPdf}
805 @docLinkSplit{Usage,usage,@manualDevelUsageSplit}
807 @docLinkBig{Usage,usage,@manualDevelUsageBig}
809 @docLinkPdf{Usage,usage,@manualDevelUsagePdf}
812 @docLinkSplit{Snippets,snippets,@manualDevelSnippetsSplit}
814 @docLinkBig{Snippets,snippets,@manualDevelSnippetsBig}
816 @docLinkPdf{Snippets,snippets,@manualDevelSnippetsPdf}
821 @docLinkSplit{Web,web,@manualDevelWebSplit}
823 @docLinkBig{Web,web,@manualDevelWebBig}
825 @docLinkPdf{Web,web,@manualDevelWebPdf}
828 @docLinkSplit{Changes,changes,@manualDevelChangesSplit}
830 @docLinkBig{Changes,changes,@manualDevelChangesBig}
832 @docLinkPdf{Changes,changes,@manualDevelChangesPdf}
835 @docLinkSplit{Extending,extending,@manualDevelExtendingSplit}
837 @docLinkBig{Extending,extending,@manualDevelExtendingBig}
839 @docLinkPdf{Extending,extending,@manualDevelExtendingPdf}
842 @docLinkSplit{Internals,internals,@manualDevelInternalsSplit}
844 @docLinkBig{Internals,internals,@manualDevelInternalsBig}
846 @docLinkPdf{Internals,internals,@manualDevelInternalsPdf}
849 @headitem Downloadable
864 @unnumberedsec Authors
866 @divClass{column-left-top}
867 @subheading Current Development Team
869 @divClass{keep-bullets}
874 @divClass{column-right-top}
875 @subheading Previous Development Team
877 @divClass{keep-bullets}
883 @divClass{column-center-top}
884 @subheading Current Contributors
886 @divClass{keep-bullets}
887 @subsubheading Programming
895 @subsubheading Documentation
899 @subsubheading Bug squad
903 @subsubheading Support
907 @subsubheading Translation
915 @divClass{column-center-bottom}
916 @subheading Previous Contributors
918 @divClass{keep-bullets}
919 @subsubheading Programming
927 @subsubheading Documentation
931 @c uncomment when we have any previous members -gp
932 @c @subsubheading Bug squad
936 @subsubheading Support
940 @subsubheading Translation
942 @translationsPrevious
950 @unnumberedsec Publications
952 @divClass{column-center-top}
953 @subheading What we wrote about LilyPond
955 @divClass{keep-bullets}
957 @include we-wrote.itexi
962 @divClass{column-center-bottom}
964 @subheading What people did with LilyPond
967 @divClass{keep-bullets}
969 @include others-did.itexi
974 @contactUsAbout{academic papers}
978 @unnumberedsec Old news
980 @include web/news-front.itexi
982 @include web/news.itexi