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{Development}: for contributors and testers.
48 @ref{Authors}: the people who made LilyPond what it is today.
53 @divClass{column-right-bottom}
54 @subheading Miscellaneous
59 @ref{Publications}: what we wrote, and have had written about us.
62 @ref{Old news}: an archive.
84 @unnumberedsec Contact
87 @divClass{column-left-bottom}
88 @subheading User Discussions and Help
90 @subsubheading User mailing list: @code{lilypond-user@@gnu.org}
92 This mailing list is the main place for users to discuss and help
96 @uref{http://lists.gnu.org/mailman/listinfo/lilypond-user,
97 lilypond-user subscribe and info}
99 @uref{http://lists.gnu.org/archive/html/lilypond-user/,
101 @uref{http://www.mail-archive.com/lilypond-user@@gnu.org/,
103 @uref{http://dir.gmane.org/gmane.comp.gnu.lilypond.general,
106 @uref{http://post.gmane.org/post.php?group=gmane.comp.gnu.lilypond.general,
107 send to lilypond-user with gmane}
110 @warning{When asking questions, please use @ref{Tiny examples}!}
112 @subsubheading LilyPond Snippet Repository
114 The LilyPond Snippet Repository is a large collection of
115 user-submitted examples, which can freely be copied and used
116 in your own works. See what other people have written,
120 @uref{http://lsr.dsi.unimi.it}
123 Particularly instructive examples from LSR are included in our
124 official documentation, in @ref{Snippets}.
129 Some level of support is provided on our IRC channel,
132 @uref{irc://irc.freenode.net/lilypond, #lilypond@@irc.freenode.net}
135 This channel has no public archive, so any question that may
136 be useful for others would better be posted to one of the mailing lists.
139 <form action="http://webchat.freenode.net"
143 <input name="nick" type="text" size="15" value="">
145 <input name="channels" type="hidden" value="lilypond">
146 <input type="submit" value="Join #lilypond IRC Chat">
149 <script language="JavaScript" type="text/javascript">
150 var username = "web";
151 var lang = window.navigator.userLanguage ? window.navigator.userLanguage
152 : window.navigator.language;
153 username += '-' + lang.substr(0, 2);
154 username += '-' + navigator.appName.substr(0, 2);
155 username += navigator.appCodeName.replace (" ", "").substr(0, 2);
156 username += navigator.platform.replace (" ", "").replace("nux", "").replace("n32", "");
157 document.forms["f_lily_irc"].nick.value = username;
161 @subsubheading Other languages
164 @uref{http://lists.gnu.org/mailman/listinfo/lilypond-es,
165 Spanish mailing list}
167 @uref{http://www.lilypondforum.de/,
170 @uref{http://groups.google.com/group/lilypond-brasil,
173 @uref{http://lists.gnu.org/mailman/listinfo/lilypond-user-fr,
176 @uref{http://www.lilypondforum.nl/,
183 @divClass{column-right-top}
184 @subheading Stay Informed
186 @subsubheading LilyPond Report
188 The easiest way to keep touch is by reading our community
189 newsletter, the LilyPond Report:
192 @uref{http://news.lilynet.net}
195 @subsubheading Releases mailing list: @code{info-lilypond@@gnu.org}
197 This mailing list is a low-volume, read-only list which receives
198 notifications of new releases.
201 @uref{http://lists.gnu.org/mailman/listinfo/info-lilypond,
202 info-lilypond subscribe and info}
204 @uref{http://lists.gnu.org/archive/html/info-lilypond/,
206 @uref{http://www.mail-archive.com/info-lilypond@@gnu.org/,
208 @uref{http://dir.gmane.org/gmane.comp.gnu.lilypond.announce,
211 @c don't include gmane posting here. -gp
218 @divClass{column-right-bottom}
219 @subheading Developer Discussion
221 @subsubheading Developer mailing list: @code{lilypond-devel@@gnu.org}
223 Most developer discussion takes place on this list. Patches
227 @uref{http://lists.gnu.org/mailman/listinfo/lilypond-devel,
228 lilypond-devel subscribe and info}
230 @uref{http://lists.gnu.org/archive/html/lilypond-devel/,
232 @uref{http://www.mail-archive.com/lilypond-devel@@gnu.org/,
234 @uref{http://dir.gmane.org/gmane.comp.gnu.lilypond.devel,
237 @uref{http://post.gmane.org/post.php?group=gmane.comp.gnu.lilypond.devel,
238 send to lilypond-devel with gmane}
242 @subsubheading Bug mailing list: @code{bug-lilypond@@gnu.org}
244 Bug-specific discussion takes place here.
247 @uref{http://lists.gnu.org/mailman/listinfo/bug-lilypond,
248 bug-lilypond subscribe and info}
250 @uref{http://lists.gnu.org/archive/html/bug-lilypond/,
252 @uref{http://www.mail-archive.com/bug-lilypond@@gnu.org/,
254 @uref{http://dir.gmane.org/gmane.comp.gnu.lilypond.bugs,
257 @c don't include gmane posting here. -gp
260 @warning{Before sending a message to the bug list, please read our
261 guidelines for @ref{Bug reports}.}
268 @unnumberedsec Tiny examples
270 @divClass{column-center-top}
271 @subheading What are @qq{Tiny examples}?
273 A tiny example is an example from which @strong{nothing} can be removed.
276 @divClass{column-left-bottom}
277 @subheading Why create them?
279 @divClass{keep-bullets}
283 The simpler the example is, the quicker potential helpers can
284 understand it and help you.
287 A tiny example demonstrates that you have put effort towards
288 solving the problem yourself. When people send huge portions of
289 input, it looks like they don't care if we help them or not.
292 Creating a tiny example helps you to understand what is
293 happening. Many false problem reports can be avoided by
294 attempting to create a tiny example; if you cannot replicate a
295 @qq{bug} in a tiny example, then the problem was probably an
296 insufficient understanding of LilyPond, not an actual bug!
304 @divClass{column-right-bottom}
305 @subheading How to create them?
307 @divClass{keep-bullets}
311 Include the @code{\version} number.
314 Make it small! Examples about spacing or page layout might
315 require many bars of music, but most issues can be reproduced
316 using less than a single measure.
319 When trying to create an example, try commenting out @w{(@code{%}
320 or @code{%@{ @dots{} %@}})} sections of your file. If you
321 can comment something while still demonstrating the main idea,
322 then remove the commented-material.
325 Avoid using complicated notes, keys or time signatures, unless
326 the bug is about the behavior of those items.
329 Do not use @code{\override} or @code{\set} commands unless the bug
330 is about those specific commands.
333 Optionally, attach an image showing the desired graphical output.
340 @divClass{column-center-bottom}
341 @subheading How tiny should they be?
343 Is the code below a minimal example?
347 \include "english.ly"
352 \numericTimeSignature
354 <cs' d'' b''>16 <cs' d'' b''>8.
355 %% Here: the tie on the D's looks funny
356 %% Too tall? Left-hand endpoint is not aligned with the B tie?
358 <cs' d'' b''>8 [ <b d'' a''> ]
363 Well, it is not very big, but a truly minimal example is here:
368 % middle tie looks funny here:
369 <c' d'' b''>8. ~ <c' d'' b''>8
373 Very few tiny examples exceed 10 lines of code -
374 quite often 4 lines are enough to demonstrate the problem!
380 @unnumberedsec Bug reports
382 @divClass{column-center-top}
383 @subheading Step 1: Known bugs
385 If you have input that results in a crash or an erroneous output,
386 then that is a bug. There is a list of current bugs on our google
390 @uref{http://code.google.com/p/lilypond/issues/list}
393 @warning{Please @strong{DO NOT} add bug reports directly to the
394 bug tracker. Once an issue has been added to the tracker, feel
395 free to add more information to that report.}
400 @divClass{column-left-bottom}
401 @subheading Step 2: Creating a bug report
403 If you have discovered a bug which is not listed, please help us
404 by creating a bug report.
406 @warning{We only accept bug reports in the form of
407 @ref{Tiny examples}. We have very limited resources to deal with
408 bug reports, so any non-minimal example will be rejected. Almost
409 every bug can be demonstrated in four notes or less!}
411 Here is an example of a good bug report:
414 % Accidentals should be printed for only
415 % the first note in a tie, but this version
416 % prints flats on both notes.
427 @divClass{column-right-bottom}
428 @subheading Step 3: Sending a bug report
430 Once you have verified that the issue is not already known and
431 created a bug report, please send it to us!
433 @divClass{keep-bullets}
437 If you are subscribed to the @uref{mailto:bug-lilypond@@gnu.org,
438 bug-lilypond@@gnu.org} mailing list, send an email like normal.
441 If you are not subscribed, you can still post a bug report with
443 @uref{http://post.gmane.org/post.php?group=gmane.comp.gnu.lilypond.bugs,
444 gmane lilypond.bugs web interface}.
446 However, there is a strict @qq{no top-posting} check on the gmane
447 interface, which is often incorrectly triggered by lilypond files.
448 To avoid this, please add:
451 > I'm not top posting.
455 (you @emph{must} include the @code{>} ) to the top of your bug
462 @divClass{column-center-bottom}
463 @subheading Step 4: Wait for a response
465 Once your bug has been sent to the list, our Bug Squad will
466 examine the report. Please allow up to 24 hours, as we have a
467 limited number of volunteers for this task. They may ask you for
468 more information, or may add the report to the tracker and let you
469 know what the issue number is.
471 You may mark the bug so that you automatically receive emails when
472 any activity on the bug occurs. This requires you have a google
476 @divClass{column-center-bottom}
477 @subheading Optional help: show the desired behavior
479 Once an issue has been added to the tracker, it can be very
480 helpful if we can see the desired output. Feel free to add input
481 code and/or images (possibly created with other tools) which
482 demonstrate what you think it should look like!
489 @unnumberedsec Help us
491 @divClass{column-center-top}
496 @divClass{column-left-top}
497 @divClass{keep-bullets}
503 @divClass{column-right-top}
510 @unnumberedsec Development
512 @divClass{heading-center}
514 @heading Development for LilyPond @version
517 @heading Development for LilyPond @versionDevel
521 @c we normally don't allow named references, but in this case
522 @c it's good to emphasize the "stable" part. -gp
523 @warning{These are @emph{unstable development} versions. If you
524 have the slightest doubt about how to use or install LilyPond, we
525 urge you to use the @ref{Download, stable Download}, and read the
526 @ref{Manuals, stable Manuals}.}
530 @divClass{column-center-top}
531 @subheading Release numbers
533 There are two sets of releases for LilyPond: stable releases, and
534 unstable development releases. Stable versions have an
535 even-numbered @q{minor} version number (e.g., 2.8, 2.10, 2.12).
536 Development versions have an odd-numbered @q{minor} version number
537 (e.g., 2.7, 2.9, 2.11).
542 @divClass{column-left-top}
545 Instructions for git and compiling are in the Contributor's Guide.
548 @uref{http://git.sv.gnu.org/gitweb/?p=lilypond.git, lilypond git repository}
551 Documentation writers and testers will generally want to download
556 @downloadDevelLinuxNormal
558 @downloadDevelLinuxBig
560 @downloadDevelLinuxPPC
562 @downloadDevelFreeBSDNormal
564 @downloadDevelFreeBSDBig
566 @downloadDevelDarwinNormal
568 @downloadDevelDarwinPPC
570 @downloadDevelWindows
579 @divClass{column-right-top}
580 @subheading Contributor's Guide
582 LilyPond development is a fairly complicated matter. In order to
583 help new contributors, and to keep the whole system (mostly)
584 stable, we have written a manual for development tasks.
586 @docLinksBare{Contributor's Guide, contributor,
587 @rcontribnamed{Top,Contributor's Guide},
588 @manualDevelContributorSplit,
589 @manualDevelContributorBig, 500 kB,
590 @manualDevelContributorPdf, 2.8 MB}
595 @divClass{column-center-top}
596 @subheading Regression tests
598 @divClass{keep-bullets}
604 @uref{../../input/regression/collated-files.html, Regression tests}:
605 This release's regtests.
606 (@uref{../../input/regression/collated-files.pdf, pdf version})
609 @uref{../../input/regression/musicxml/collated-files.html, MusicXML tests}:
610 This release's musicXML tests.
611 (@uref{../../input/regression/musicxml/collated-files.pdf, pdf version})
614 @uref{../../input/regression/abc2ly/collated-files.html, abc2ly tests}:
615 This release's abc2ly tests.
616 (@uref{../../input/regression/abc2ly/collated-files.pdf, pdf version})
619 @uref{../../input/regression/lilypond-book/collated-files.html, lilypond-book tests}:
620 This release's lilypond-book tests.
621 (@uref{../../input/regression/lilypond-book/collated-files.pdf, pdf version})
627 @subsubheading Development version
630 @item @regtestDevel (@regtestDevelPdf{})
632 @item @regtestDevelXml (@regtestDevelXmlPdf{})
634 @item @regtestDevelAbc (@regtestDevelAbcPdf{})
636 @item @regtestDevelLilypondBook (@regtestDevelLilypondBookPdf{})
639 @subsubheading Stable version
642 @item @regtestStable (@regtestStablePdf{})
644 @item @regtestStableXml (@regtestStableXmlPdf{})
646 @item @regtestStableAbc (@regtestStableAbcPdf{})
648 @item @regtestStableLilypondBook (@regtestStableLilypondBookPdf{})
653 @subsubheading All versions
656 @item @uref{http://lilypond.org/test, Comparisons between regression tests}
658 @item @uref{http://lilypond.org/download/binaries/test-output/,
659 Archive of all regression tests}
668 @divClass{column-center-bottom}
672 @warning{These manuals are for LilyPond @version{}; the latest
673 manuals can be found at @url{http://lilypond.org}}
676 @divClass{normal-table}
677 @multitable @columnfractions .3 .3 .3
678 @headitem Introduction
680 @docLinkSplit{Learning,learning,@manualDevelLearningSplit}
682 @docLinkBig{Learning,learning,@manualDevelLearningBig}
684 @docLinkPdf{Learning,learning,@manualDevelLearningPdf}
687 @docLinkSplit{Glossary,music-glossary,@manualDevelGlossarySplit}
689 @docLinkBig{Glossary,music-glossary,@manualDevelGlossaryBig}
691 @docLinkPdf{Glossary,music-glossary,@manualDevelGlossaryPdf}
694 @docLinkSplit{Essay,essay,@manualDevelEssaySplit}
696 @docLinkBig{Essay,essay,@manualDevelEssayBig}
698 @docLinkPdf{Essay,essay,@manualDevelEssayPdf}
703 @docLinkSplit{Notation,notation,@manualDevelNotationSplit}
705 @docLinkBig{Notation,notation,@manualDevelNotationBig}
707 @docLinkPdf{Notation,notation,@manualDevelNotationPdf}
710 @docLinkSplit{Usage,usage,@manualDevelUsageSplit}
712 @docLinkBig{Usage,usage,@manualDevelUsageBig}
714 @docLinkPdf{Usage,usage,@manualDevelUsagePdf}
717 @docLinkSplit{Snippets,snippets,@manualDevelSnippetsSplit}
719 @docLinkBig{Snippets,snippets,@manualDevelSnippetsBig}
721 @docLinkPdf{Snippets,snippets,@manualDevelSnippetsPdf}
726 @docLinkSplit{Web,web,@manualDevelWebSplit}
728 @docLinkBig{Web,web,@manualDevelWebBig}
730 @docLinkPdf{Web,web,@manualDevelWebPdf}
733 @docLinkSplit{Changes,changes,@manualDevelChangesSplit}
735 @docLinkBig{Changes,changes,@manualDevelChangesBig}
737 @docLinkPdf{Changes,changes,@manualDevelChangesPdf}
740 @docLinkSplit{Extending,extending,@manualDevelExtendingSplit}
742 @docLinkBig{Extending,extending,@manualDevelExtendingBig}
744 @docLinkPdf{Extending,extending,@manualDevelExtendingPdf}
747 @docLinkSplit{Internals,internals,@manualDevelInternalsSplit}
749 @docLinkBig{Internals,internals,@manualDevelInternalsBig}
751 @docLinkPdf{Internals,internals,@manualDevelInternalsPdf}
754 @headitem Downloadable
769 @unnumberedsec Authors
771 @divClass{column-left-top}
772 @subheading Current Development Team
774 @divClass{keep-bullets}
779 @divClass{column-right-top}
780 @subheading Previous Development Team
782 @divClass{keep-bullets}
788 @divClass{column-center-top}
789 @subheading Current Contributors
791 @divClass{keep-bullets}
792 @subsubheading Programming
800 @subsubheading Documentation
804 @subsubheading Bug squad
808 @subsubheading Support
812 @subsubheading Translation
820 @divClass{column-center-bottom}
821 @subheading Previous Contributors
823 @divClass{keep-bullets}
824 @subsubheading Programming
832 @subsubheading Documentation
836 @c uncomment when we have any previous members -gp
837 @c @subsubheading Bug squad
841 @subsubheading Support
845 @subsubheading Translation
847 @translationsPrevious
855 @unnumberedsec Publications
857 @divClass{column-center-top}
858 @subheading What we wrote about LilyPond
860 @divClass{keep-bullets}
862 @include we-wrote.itexi
867 @divClass{column-center-bottom}
869 @subheading What people did with LilyPond
872 @divClass{keep-bullets}
874 @include others-did.itexi
879 @contactUsAbout{academic papers}
883 @unnumberedsec Old news
885 @include web/news-front.itexi
887 @include web/news.itexi