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}.}
265 @divClass{column-right-bottom}
266 @subheading Sensitive emails
268 Private matters should be sent to Graham Percival (project
269 manager), who will discuss it with those concerned.
275 @unnumberedsec Tiny examples
277 @divClass{column-center-top}
278 @subheading What are @qq{Tiny examples}?
280 A tiny example is an example from which @strong{nothing} can be removed.
283 @divClass{column-left-bottom}
284 @subheading Why create them?
286 @divClass{keep-bullets}
290 The simpler the example is, the quicker potential helpers can
291 understand it and help you.
294 A tiny example demonstrates that you have put effort towards
295 solving the problem yourself. When people send huge portions of
296 input, it looks like they don't care if we help them or not.
299 Creating a tiny example helps you to understand what is
300 happening. Many false problem reports can be avoided by
301 attempting to create a tiny example; if you cannot replicate a
302 @qq{bug} in a tiny example, then the problem was probably an
303 insufficient understanding of LilyPond, not an actual bug!
311 @divClass{column-right-bottom}
312 @subheading How to create them?
314 @divClass{keep-bullets}
318 Include the @code{\version} number.
321 Make it small! Examples about spacing or page layout might
322 require many bars of music, but most issues can be reproduced
323 using less than a single measure.
326 When trying to create an example, try commenting out @w{(@code{%}
327 or @code{%@{ @dots{} %@}})} sections of your file. If you
328 can comment something while still demonstrating the main idea,
329 then remove the commented-material.
332 Avoid using complicated notes, keys or time signatures, unless
333 the bug is about the behavior of those items.
336 Do not use @code{\override} or @code{\set} commands unless the bug
337 is about those specific commands.
340 Optionally, attach an image showing the desired graphical output.
347 @divClass{column-center-bottom}
348 @subheading How tiny should they be?
350 Is the code below a minimal example?
354 \include "english.ly"
359 \numericTimeSignature
361 <cs' d'' b''>16 <cs' d'' b''>8.
362 %% Here: the tie on the D's looks funny
363 %% Too tall? Left-hand endpoint is not aligned with the B tie?
365 <cs' d'' b''>8 [ <b d'' a''> ]
370 Well, it is not very big, but a truly minimal example is here:
375 % middle tie looks funny here:
376 <c' d'' b''>8. ~ <c' d'' b''>8
380 Very few tiny examples exceed 10 lines of code -
381 quite often 4 lines are enough to demonstrate the problem!
387 @unnumberedsec Bug reports
389 @divClass{column-center-top}
390 @subheading Step 1: Known bugs
392 If you have input that results in a crash or an erroneous output,
393 then that is a bug. There is a list of current bugs on our google
397 @uref{http://code.google.com/p/lilypond/issues/list}
400 @warning{Please @strong{DO NOT} add bug reports directly to the
401 bug tracker. Once an issue has been added to the tracker, feel
402 free to add more information to that report.}
407 @divClass{column-left-bottom}
408 @subheading Step 2: Creating a bug report
410 If you have discovered a bug which is not listed, please help us
411 by creating a bug report.
413 @warning{We only accept bug reports in the form of
414 @ref{Tiny examples}. We have very limited resources to deal with
415 bug reports, so any non-minimal example will be rejected. Almost
416 every bug can be demonstrated in four notes or less!}
418 Here is an example of a good bug report:
421 % Accidentals should be printed for only
422 % the first note in a tie, but this version
423 % prints flats on both notes.
434 @divClass{column-right-bottom}
435 @subheading Step 3: Sending a bug report
437 Once you have verified that the issue is not already known and
438 created a bug report, please send it to us!
440 @divClass{keep-bullets}
444 If you are subscribed to the @uref{mailto:bug-lilypond@@gnu.org,
445 bug-lilypond@@gnu.org} mailing list, send an email like normal.
448 If you are not subscribed, you can still post a bug report with
450 @uref{http://post.gmane.org/post.php?group=gmane.comp.gnu.lilypond.bugs,
451 gmane lilypond.bugs web interface}.
453 However, there is a strict @qq{no top-posting} check on the gmane
454 interface, which is often incorrectly triggered by lilypond files.
455 To avoid this, please add:
458 > I'm not top posting.
462 (you @emph{must} include the @code{>} ) to the top of your bug
469 @divClass{column-center-bottom}
470 @subheading Step 4: Wait for a response
472 Once your bug has been sent to the list, our Bug Squad will
473 examine the report. Please allow up to 24 hours, as we have a
474 limited number of volunteers for this task. They may ask you for
475 more information, or may add the report to the tracker and let you
476 know what the issue number is.
478 You may mark the bug so that you automatically receive emails when
479 any activity on the bug occurs. This requires you have a google
483 @divClass{column-center-bottom}
484 @subheading Optional help: show the desired behavior
486 Once an issue has been added to the tracker, it can be very
487 helpful if we can see the desired output. Feel free to add input
488 code and/or images (possibly created with other tools) which
489 demonstrate what you think it should look like!
496 @unnumberedsec Help us
498 @divClass{column-center-top}
503 @divClass{column-left-top}
504 @divClass{keep-bullets}
510 @divClass{column-right-top}
517 @unnumberedsec Development
519 @divClass{heading-center}
521 @heading Development for LilyPond @version
524 @heading Development for LilyPond @versionDevel
528 @c we normally don't allow named references, but in this case
529 @c it's good to emphasize the "stable" part. -gp
530 @warning{These are @emph{unstable development} versions. If you
531 have the slightest doubt about how to use or install LilyPond, we
532 urge you to use the @ref{Download, stable Download}, and read the
533 @ref{Manuals, stable Manuals}.}
537 @divClass{column-center-top}
538 @subheading Release numbers
540 There are two sets of releases for LilyPond: stable releases, and
541 unstable development releases. Stable versions have an
542 even-numbered @q{minor} version number (e.g., 2.8, 2.10, 2.12).
543 Development versions have an odd-numbered @q{minor} version number
544 (e.g., 2.7, 2.9, 2.11).
549 @divClass{column-left-top}
552 Instructions for git and compiling are in the Contributor's Guide.
555 @uref{http://git.sv.gnu.org/gitweb/?p=lilypond.git, lilypond git repository}
558 Documentation writers and testers will generally want to download
563 @downloadDevelLinuxNormal
565 @downloadDevelLinuxBig
567 @downloadDevelLinuxPPC
569 @downloadDevelFreeBSDNormal
571 @downloadDevelFreeBSDBig
573 @downloadDevelDarwinNormal
575 @downloadDevelDarwinPPC
577 @downloadDevelWindows
586 @divClass{column-right-top}
587 @subheading Contributor's Guide
589 LilyPond development is a fairly complicated matter. In order to
590 help new contributors, and to keep the whole system (mostly)
591 stable, we have written a manual for development tasks.
593 @docLinksBare{Contributor's Guide, contributor,
594 @rcontribnamed{Top,Contributor's Guide},
595 @manualDevelContributorSplit,
596 @manualDevelContributorBig, 500 kB,
597 @manualDevelContributorPdf, 2.8 MB}
602 @divClass{column-center-top}
603 @subheading Regression tests
605 @divClass{keep-bullets}
611 @uref{../../input/regression/collated-files.html, Regression tests}:
612 This release's regtests.
613 (@uref{../../input/regression/collated-files.pdf, pdf version})
616 @uref{../../input/regression/musicxml/collated-files.html, MusicXML tests}:
617 This release's musicXML tests.
618 (@uref{../../input/regression/musicxml/collated-files.pdf, pdf version})
621 @uref{../../input/regression/abc2ly/collated-files.html, abc2ly tests}:
622 This release's abc2ly tests.
623 (@uref{../../input/regression/abc2ly/collated-files.pdf, pdf version})
626 @uref{../../input/regression/lilypond-book/collated-files.html, lilypond-book tests}:
627 This release's lilypond-book tests.
628 (@uref{../../input/regression/lilypond-book/collated-files.pdf, pdf version})
634 @subsubheading Development version
637 @item @regtestDevel (@regtestDevelPdf{})
639 @item @regtestDevelXml (@regtestDevelXmlPdf{})
641 @item @regtestDevelAbc (@regtestDevelAbcPdf{})
643 @item @regtestDevelLilypondBook (@regtestDevelLilypondBookPdf{})
646 @subsubheading Stable version
649 @item @regtestStable (@regtestStablePdf{})
651 @item @regtestStableXml (@regtestStableXmlPdf{})
653 @item @regtestStableAbc (@regtestStableAbcPdf{})
655 @item @regtestStableLilypondBook (@regtestStableLilypondBookPdf{})
660 @subsubheading All versions
663 @item @uref{http://lilypond.org/test, Comparisons between regression tests}
665 @item @uref{http://lilypond.org/download/binaries/test-output/,
666 Archive of all regression tests}
675 @divClass{column-center-bottom}
679 @warning{These manuals are for LilyPond @version{}; the latest
680 manuals can be found at @url{http://lilypond.org}}
683 @divClass{normal-table}
684 @multitable @columnfractions .3 .3 .3
685 @headitem Introduction
687 @docLinkSplit{Learning,learning,@manualDevelLearningSplit}
689 @docLinkBig{Learning,learning,@manualDevelLearningBig}
691 @docLinkPdf{Learning,learning,@manualDevelLearningPdf}
694 @docLinkSplit{Glossary,music-glossary,@manualDevelGlossarySplit}
696 @docLinkBig{Glossary,music-glossary,@manualDevelGlossaryBig}
698 @docLinkPdf{Glossary,music-glossary,@manualDevelGlossaryPdf}
701 @docLinkSplit{Essay,essay,@manualDevelEssaySplit}
703 @docLinkBig{Essay,essay,@manualDevelEssayBig}
705 @docLinkPdf{Essay,essay,@manualDevelEssayPdf}
710 @docLinkSplit{Notation,notation,@manualDevelNotationSplit}
712 @docLinkBig{Notation,notation,@manualDevelNotationBig}
714 @docLinkPdf{Notation,notation,@manualDevelNotationPdf}
717 @docLinkSplit{Usage,usage,@manualDevelUsageSplit}
719 @docLinkBig{Usage,usage,@manualDevelUsageBig}
721 @docLinkPdf{Usage,usage,@manualDevelUsagePdf}
724 @docLinkSplit{Snippets,snippets,@manualDevelSnippetsSplit}
726 @docLinkBig{Snippets,snippets,@manualDevelSnippetsBig}
728 @docLinkPdf{Snippets,snippets,@manualDevelSnippetsPdf}
733 @docLinkSplit{Web,web,@manualDevelWebSplit}
735 @docLinkBig{Web,web,@manualDevelWebBig}
737 @docLinkPdf{Web,web,@manualDevelWebPdf}
740 @docLinkSplit{Changes,changes,@manualDevelChangesSplit}
742 @docLinkBig{Changes,changes,@manualDevelChangesBig}
744 @docLinkPdf{Changes,changes,@manualDevelChangesPdf}
747 @docLinkSplit{Extending,extending,@manualDevelExtendingSplit}
749 @docLinkBig{Extending,extending,@manualDevelExtendingBig}
751 @docLinkPdf{Extending,extending,@manualDevelExtendingPdf}
754 @docLinkSplit{Internals,internals,@manualDevelInternalsSplit}
756 @docLinkBig{Internals,internals,@manualDevelInternalsBig}
758 @docLinkPdf{Internals,internals,@manualDevelInternalsPdf}
761 @headitem Downloadable
776 @unnumberedsec Authors
778 @divClass{column-left-top}
779 @subheading Current Development Team
781 @divClass{keep-bullets}
786 @divClass{column-right-top}
787 @subheading Previous Development Team
789 @divClass{keep-bullets}
795 @divClass{column-center-top}
796 @subheading Current Contributors
798 @divClass{keep-bullets}
799 @subsubheading Programming
807 @subsubheading Documentation
811 @subsubheading Bug squad
815 @subsubheading Support
819 @subsubheading Translation
827 @divClass{column-center-bottom}
828 @subheading Previous Contributors
830 @divClass{keep-bullets}
831 @subsubheading Programming
839 @subsubheading Documentation
843 @c uncomment when we have any previous members -gp
844 @c @subsubheading Bug squad
848 @subsubheading Support
852 @subsubheading Translation
854 @translationsPrevious
862 @unnumberedsec Publications
864 @divClass{column-center-top}
865 @subheading What we wrote about LilyPond
867 @divClass{keep-bullets}
869 @include we-wrote.itexi
874 @divClass{column-center-bottom}
876 @subheading What people did with LilyPond
879 @divClass{keep-bullets}
881 @include others-did.itexi
886 @contactUsAbout{academic papers}
890 @unnumberedsec Old news
892 @include web/news-front.itexi
894 @include web/news.itexi