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
393 @divClass{column-center-top}
394 @subheading Step 1: Known bugs
396 If you have input that results in a crash or an erroneous output,
397 then that is a bug. There is a list of current bugs on our google
401 @uref{http://code.google.com/p/lilypond/issues/list}
404 @warning{Please @strong{DO NOT} add bug reports directly to the
405 bug tracker. Once an issue has been added to the tracker, feel
406 free to add more information to that report.}
411 @divClass{column-left-bottom}
412 @subheading Step 2: Creating a bug report
414 If you have discovered a bug which is not listed, please help us
415 by creating a bug report.
417 @warning{We only accept bug reports in the form of
418 @ref{Tiny examples}. We have very limited resources to deal with
419 bug reports, so any non-minimal example will be rejected. Almost
420 every bug can be demonstrated in four notes or less!}
422 Here is an example of a good bug report:
425 % Accidentals should be printed for only
426 % the first note in a tie, but this version
427 % prints flats on both notes.
438 @divClass{column-right-bottom}
439 @subheading Step 3: Sending a bug report
441 Once you have verified that the issue is not already known and
442 created a bug report, please send it to us!
444 @divClass{keep-bullets}
448 If you are subscribed to the @uref{mailto:bug-lilypond@@gnu.org,
449 bug-lilypond@@gnu.org} mailing list, send an email like normal.
452 If you are not subscribed, you can still post a bug report with
454 @uref{http://post.gmane.org/post.php?group=gmane.comp.gnu.lilypond.bugs,
455 gmane lilypond.bugs web interface}.
457 However, there is a strict @qq{no top-posting} check on the gmane
458 interface, which is often incorrectly triggered by lilypond files.
459 To avoid this, please add:
462 > I'm not top posting.
466 (you @emph{must} include the @code{>} ) to the top of your bug
473 @divClass{column-center-bottom}
474 @subheading Step 4: Wait for a response
476 Once your bug has been sent to the list, our Bug Squad will
477 examine the report. Please allow up to 24 hours, as we have a
478 limited number of volunteers for this task. They may ask you for
479 more information, or may add the report to the tracker and let you
480 know what the issue number is.
482 You may mark the bug so that you automatically receive emails when
483 any activity on the bug occurs. This requires you have a google
487 @divClass{column-center-bottom}
488 @subheading Optional help: show the desired behavior
490 Once an issue has been added to the tracker, it can be very
491 helpful if we can see the desired output. Feel free to add input
492 code and/or images (possibly created with other tools) which
493 demonstrate what you think it should look like!
500 @unnumberedsec Help us
502 @divClass{column-center-top}
507 @divClass{column-left-top}
508 @divClass{keep-bullets}
514 @divClass{column-right-top}
521 @unnumberedsec Sponsoring
523 @divClass{keep-bullets}
524 @divClass{column-left-top}
530 @item some users have paid for new features
531 @item some developers have added new features for hire
534 The LilyPond project does not organize such efforts; we neither
535 endorse nor discourage such agreements. Any contracts between
536 private individuals is the business of those individuals, not
541 @divClass{column-right-top}
542 @subheading Guidelines
544 Any user wanting to offer money in exchange for work should bear
545 in mind the following points:
549 LilyPond developers may advertise their services on the lilypnod
550 email lists from time to time.
553 Any agreements between private individuals should include the
554 normal precautions when conducting business: who pays, how much do
555 they pay, with what method of payment, and upon what set of
556 conditions. We suggest that any ambiguity or uncertainty in these
557 questions should be resolved before any work begins.
563 @divClass{column-center-bottom}
564 @subheading Interested developers
566 Here is a list of people who have expressed an interest in
567 bounties. Note that the amount of work done by individuals varies
568 quite a bit throughout the years. We do not guarantee that this
569 list is up-to-date, nor do we guarantee that the people listed
570 here have any ability. The only criteria is "XYZ asked to be
571 listed on this page".
573 Looking at the git history is a good way to determine who the most
574 active and experienced developers are. Statistics up to version
577 @multitable @columnfractions .3 .3 .3
578 @item @uref{http://lilypond.org/~graham/gitstats-all/, overall history}
579 @tab @uref{http://lilypond.org/~graham/gitstats-1year/, past year}
580 @tab @uref{http://lilypond.org/~graham/gitstats-3months/, past three months}
583 Interested developers:
585 @item @email{dak@@gnu.org, David Kastrup}
586 Donations are required to let me continue my current fulltime work on
587 LilyPond. I focus on user and programmer interface design, coherence,
588 implementation, simplification, documentation, and debugging.
591 @c @item @email{name@@adress.domain, Name}
592 @c area of interest (256 chars max)
601 @unnumberedsec Development
603 @divClass{heading-center}
605 @heading Development for LilyPond @version
608 @heading Development for LilyPond @versionDevel
612 @c we normally don't allow named references, but in this case
613 @c it's good to emphasize the "stable" part. -gp
614 @warning{These are @emph{unstable development} versions. If you
615 have the slightest doubt about how to use or install LilyPond, we
616 urge you to use the @ref{Download, stable Download}, and read the
617 @ref{Manuals, stable Manuals}.}
621 @divClass{column-center-top}
622 @subheading Release numbers
624 There are two sets of releases for LilyPond: stable releases, and
625 unstable development releases. Stable versions have an
626 even-numbered @q{minor} version number (e.g., 2.8, 2.10, 2.12).
627 Development versions have an odd-numbered @q{minor} version number
628 (e.g., 2.7, 2.9, 2.11).
633 @divClass{column-left-top}
636 Instructions for git and compiling are in the Contributor's Guide.
639 @uref{http://git.sv.gnu.org/gitweb/?p=lilypond.git, lilypond git repository}
642 Documentation writers and testers will generally want to download
647 @downloadDevelLinuxNormal
649 @downloadDevelLinuxBig
651 @downloadDevelLinuxPPC
653 @downloadDevelFreeBSDNormal
655 @downloadDevelFreeBSDBig
657 @downloadDevelDarwinNormal
659 @downloadDevelDarwinPPC
661 @downloadDevelWindows
670 @divClass{column-right-top}
671 @subheading Contributor's Guide
673 LilyPond development is a fairly complicated matter. In order to
674 help new contributors, and to keep the whole system (mostly)
675 stable, we have written a manual for development tasks.
677 @docLinksBare{Contributor's Guide, contributor,
678 @rcontribnamed{Top,Contributor's Guide},
679 @manualDevelContributorSplit,
680 @manualDevelContributorBig, 500 kB,
681 @manualDevelContributorPdf, 2.8 MB}
686 @divClass{column-center-top}
687 @subheading Regression tests
689 @divClass{keep-bullets}
695 @uref{../../input/regression/collated-files.html, Regression tests}:
696 This release's regtests.
697 (@uref{../../input/regression/collated-files.pdf, pdf version})
700 @uref{../../input/regression/musicxml/collated-files.html, MusicXML tests}:
701 This release's musicXML tests.
702 (@uref{../../input/regression/musicxml/collated-files.pdf, pdf version})
705 @uref{../../input/regression/abc2ly/collated-files.html, abc2ly tests}:
706 This release's abc2ly tests.
707 (@uref{../../input/regression/abc2ly/collated-files.pdf, pdf version})
710 @uref{../../input/regression/lilypond-book/collated-files.html, lilypond-book tests}:
711 This release's lilypond-book tests.
712 (@uref{../../input/regression/lilypond-book/collated-files.pdf, pdf version})
718 @subsubheading Development version
721 @item @regtestDevel (@regtestDevelPdf{})
723 @item @regtestDevelXml (@regtestDevelXmlPdf{})
725 @item @regtestDevelAbc (@regtestDevelAbcPdf{})
727 @item @regtestDevelLilypondBook (@regtestDevelLilypondBookPdf{})
730 @subsubheading Stable version
733 @item @regtestStable (@regtestStablePdf{})
735 @item @regtestStableXml (@regtestStableXmlPdf{})
737 @item @regtestStableAbc (@regtestStableAbcPdf{})
739 @item @regtestStableLilypondBook (@regtestStableLilypondBookPdf{})
744 @subsubheading All versions
747 @item @uref{http://lilypond.org/test, Comparisons between regression tests}
749 @item @uref{http://lilypond.org/download/binaries/test-output/,
750 Archive of all regression tests}
759 @divClass{column-center-bottom}
763 @warning{These manuals are for LilyPond @version{}; the latest
764 manuals can be found at @url{http://lilypond.org}}
767 @divClass{normal-table}
768 @multitable @columnfractions .3 .3 .3
769 @headitem Introduction
771 @docLinkSplit{Learning,learning,@manualDevelLearningSplit}
773 @docLinkBig{Learning,learning,@manualDevelLearningBig}
775 @docLinkPdf{Learning,learning,@manualDevelLearningPdf}
778 @docLinkSplit{Glossary,music-glossary,@manualDevelGlossarySplit}
780 @docLinkBig{Glossary,music-glossary,@manualDevelGlossaryBig}
782 @docLinkPdf{Glossary,music-glossary,@manualDevelGlossaryPdf}
785 @docLinkSplit{Essay,essay,@manualDevelEssaySplit}
787 @docLinkBig{Essay,essay,@manualDevelEssayBig}
789 @docLinkPdf{Essay,essay,@manualDevelEssayPdf}
794 @docLinkSplit{Notation,notation,@manualDevelNotationSplit}
796 @docLinkBig{Notation,notation,@manualDevelNotationBig}
798 @docLinkPdf{Notation,notation,@manualDevelNotationPdf}
801 @docLinkSplit{Usage,usage,@manualDevelUsageSplit}
803 @docLinkBig{Usage,usage,@manualDevelUsageBig}
805 @docLinkPdf{Usage,usage,@manualDevelUsagePdf}
808 @docLinkSplit{Snippets,snippets,@manualDevelSnippetsSplit}
810 @docLinkBig{Snippets,snippets,@manualDevelSnippetsBig}
812 @docLinkPdf{Snippets,snippets,@manualDevelSnippetsPdf}
817 @docLinkSplit{Web,web,@manualDevelWebSplit}
819 @docLinkBig{Web,web,@manualDevelWebBig}
821 @docLinkPdf{Web,web,@manualDevelWebPdf}
824 @docLinkSplit{Changes,changes,@manualDevelChangesSplit}
826 @docLinkBig{Changes,changes,@manualDevelChangesBig}
828 @docLinkPdf{Changes,changes,@manualDevelChangesPdf}
831 @docLinkSplit{Extending,extending,@manualDevelExtendingSplit}
833 @docLinkBig{Extending,extending,@manualDevelExtendingBig}
835 @docLinkPdf{Extending,extending,@manualDevelExtendingPdf}
838 @docLinkSplit{Internals,internals,@manualDevelInternalsSplit}
840 @docLinkBig{Internals,internals,@manualDevelInternalsBig}
842 @docLinkPdf{Internals,internals,@manualDevelInternalsPdf}
845 @headitem Downloadable
860 @unnumberedsec Authors
862 @divClass{column-left-top}
863 @subheading Current Development Team
865 @divClass{keep-bullets}
870 @divClass{column-right-top}
871 @subheading Previous Development Team
873 @divClass{keep-bullets}
879 @divClass{column-center-top}
880 @subheading Current Contributors
882 @divClass{keep-bullets}
883 @subsubheading Programming
891 @subsubheading Documentation
895 @subsubheading Bug squad
899 @subsubheading Support
903 @subsubheading Translation
911 @divClass{column-center-bottom}
912 @subheading Previous Contributors
914 @divClass{keep-bullets}
915 @subsubheading Programming
923 @subsubheading Documentation
927 @c uncomment when we have any previous members -gp
928 @c @subsubheading Bug squad
932 @subsubheading Support
936 @subsubheading Translation
938 @translationsPrevious
946 @unnumberedsec Publications
948 @divClass{column-center-top}
949 @subheading What we wrote about LilyPond
951 @divClass{keep-bullets}
953 @include we-wrote.itexi
958 @divClass{column-center-bottom}
960 @subheading What people did with LilyPond
963 @divClass{keep-bullets}
965 @include others-did.itexi
970 @contactUsAbout{academic papers}
974 @unnumberedsec Old news
976 @include web/news-front.itexi
978 @include web/news.itexi