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 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 simple 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 how if we help them or not.
292 Creating a tiny example forces 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 do I create them?
307 @divClass{keep-bullets}
311 Include the \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 only 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 can
321 comment something while still demonstrating the main idea, then
322 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 particular commands.
341 @unnumberedsec Bug reports
343 @divClass{column-center-top}
344 @subheading Step 1: Known bugs
346 If you have input that results in a crash or an erroneous output,
347 then that is a bug. There is a list of current bugs on our google
351 @uref{http://code.google.com/p/lilypond/issues/list}
354 @warning{Please @strong{DO NOT} add bug reports directly to the
355 bug tracker. Once an issue has been added to the tracker, feel
356 free to add more information to that report.}
361 @divClass{column-left-bottom}
362 @subheading Step 2: Creating a bug report
364 If you have discovered a bug which is not listed, please help us
365 by creating a bug report.
367 @warning{We only accept bug reports in the form of
368 @ref{Tiny examples}. We have very limited resources to deal with
369 bug reports, so any non-minimal example will be rejected. Almost
370 every bug can be demonstrated in four notes or less!}
372 Here is an example of a good bug report:
375 %% the octavation command doesn't
376 %% change the output at all!
388 @divClass{column-right-bottom}
389 @subheading Step 3: Sending a bug report
391 Once you have verified that the issue is not already known and
392 created a bug report, please send it to us!
394 @divClass{keep-bullets}
398 If you are subscribed to the @uref{mailto:bug-lilypond@@gnu.org,
399 bug-lilypond@@gnu.org} mailing list, send an email like normal.
402 If you are not subscribed, you can still post a bug report with
404 @uref{http://post.gmane.org/post.php?group=gmane.comp.gnu.lilypond.bugs,
405 gmane lilypond.bugs web interface}.
407 However, there is a strict @qq{no top-posting} check on the gmane
408 interface, which is often incorrectly triggered by lilypond files.
409 To avoid this, please add:
412 > I'm not top posting.
416 (you @emph{must} include the @code{>} ) to the top of your bug
423 @divClass{column-center-bottom}
424 @subheading Step 4: Wait for a response
426 Once your bug has been sent to the list, our Bug Squad will
427 examine the report. Please allow up to 24 hours, as we have a
428 limited number of volunteers for this task. They may ask you for
429 more information, or may add the report to the tracker and let you
430 know what the issue number is.
432 You may mark the bug so that you automatically receive emails when
433 any activity on the bug occurs. This requires you have a google
437 @divClass{column-center-bottom}
438 @subheading Optional help: show the desired behavior
440 Once an issue has been added to the tracker, it can be very
441 helpful if we can see the desired output. Feel free to add input
442 code and/or images (possibly created with other tools) which
443 demonstrate what you think it should look like!
450 @unnumberedsec Help us
452 @divClass{column-center-top}
457 @divClass{column-left-top}
458 @divClass{keep-bullets}
464 @divClass{column-right-top}
471 @unnumberedsec Development
473 @divClass{heading-center}
475 @heading Development for LilyPond @version
478 @heading Development for LilyPond @versionDevel
482 @c we normally don't allow named references, but in this case
483 @c it's good to emphasize the "stable" part. -gp
484 @warning{These are @emph{unstable development} versions. If you
485 have the slightest doubt about how to use or install LilyPond, we
486 urge you to use the @ref{Download, stable Download}, and read the
487 @ref{Manuals, stable Manuals}.}
491 @divClass{column-center-top}
492 @subheading Release numbers
494 There are two sets of releases for LilyPond: stable releases, and
495 unstable development releases. Stable versions have an
496 even-numbered @q{minor} version number (e.g., 2.8, 2.10, 2.12).
497 Development versions have an odd-numbered @q{minor} version number
498 (e.g., 2.7, 2.9, 2.11).
503 @divClass{column-left-top}
506 Instructions for git and compiling are in the Contributor's Guide.
509 @uref{http://git.sv.gnu.org/gitweb/?p=lilypond.git, lilypond git repository}
512 Documentation writers and testers will generally want to download
517 @downloadDevelLinuxNormal
519 @downloadDevelLinuxBig
521 @downloadDevelLinuxPPC
523 @downloadDevelFreeBSDNormal
525 @downloadDevelFreeBSDBig
527 @downloadDevelDarwinNormal
529 @downloadDevelDarwinPPC
531 @downloadDevelWindows
540 @divClass{column-right-top}
541 @subheading Contributor's Guide
543 LilyPond development is a fairly complicated matter. In order to
544 help new contributors, and to keep the whole system (mostly)
545 stable, we have written a manual for development tasks.
547 @docLinksBare{Contributor's Guide, contributor,
548 @rcontribnamed{Top,Contributor's Guide},
549 @manualDevelContributorSplit,
550 @manualDevelContributorBig, 500 kB,
551 @manualDevelContributorPdf, 2.8 MB}
556 @divClass{column-center-top}
557 @subheading Regression tests
559 @divClass{keep-bullets}
565 @uref{../../input/regression/collated-files.html, Regression tests}:
566 This release's regtests.
567 (@uref{../../input/regression/collated-files.pdf, pdf version})
570 @uref{../../input/regression/musicxml/collated-files.html, MusicXML tests}:
571 This release's musicXML tests.
572 (@uref{../../input/regression/musicxml/collated-files.pdf, pdf version})
575 @uref{../../input/regression/abc2ly/collated-files.html, abc2ly tests}:
576 This release's abc2ly tests.
577 (@uref{../../input/regression/abc2ly/collated-files.pdf, pdf version})
580 @uref{../../input/regression/lilypond-book/collated-files.html, lilypond-book tests}:
581 This release's lilypond-book tests.
582 (@uref{../../input/regression/lilypond-book/collated-files.pdf, pdf version})
588 @subsubheading Development version
591 @item @regtestDevel (@regtestDevelPdf{})
593 @item @regtestDevelXml (@regtestDevelXmlPdf{})
595 @item @regtestDevelAbc (@regtestDevelAbcPdf{})
597 @item @regtestDevelLilypondBook (@regtestDevelLilypondBookPdf{})
600 @subsubheading Stable version
603 @item @regtestStable (@regtestStablePdf{})
605 @item @regtestStableXml (@regtestStableXmlPdf{})
607 @item @regtestStableAbc (@regtestStableAbcPdf{})
609 @item @regtestStableLilypondBook (@regtestStableLilypondBookPdf{})
614 @subsubheading All versions
617 @item @uref{http://lilypond.org/test, Comparisons between regression tests}
619 @item @uref{http://lilypond.org/download/binaries/test-output/,
620 Archive of all regression tests}
629 @divClass{column-center-bottom}
633 @warning{These manuals are for LilyPond @version{}; the latest
634 manuals can be found at @url{http://lilypond.org}}
637 @divClass{normal-table}
638 @multitable @columnfractions .3 .3 .3
639 @headitem Introduction
641 @docLinkSplit{Learning,learning,@manualDevelLearningSplit}
643 @docLinkBig{Learning,learning,@manualDevelLearningBig}
645 @docLinkPdf{Learning,learning,@manualDevelLearningPdf}
648 @docLinkSplit{Glossary,music-glossary,@manualDevelGlossarySplit}
650 @docLinkBig{Glossary,music-glossary,@manualDevelGlossaryBig}
652 @docLinkPdf{Glossary,music-glossary,@manualDevelGlossaryPdf}
655 @docLinkSplit{Essay,essay,@manualDevelEssaySplit}
657 @docLinkBig{Essay,essay,@manualDevelEssayBig}
659 @docLinkPdf{Essay,essay,@manualDevelEssayPdf}
664 @docLinkSplit{Notation,notation,@manualDevelNotationSplit}
666 @docLinkBig{Notation,notation,@manualDevelNotationBig}
668 @docLinkPdf{Notation,notation,@manualDevelNotationPdf}
671 @docLinkSplit{Usage,usage,@manualDevelUsageSplit}
673 @docLinkBig{Usage,usage,@manualDevelUsageBig}
675 @docLinkPdf{Usage,usage,@manualDevelUsagePdf}
678 @docLinkSplit{Snippets,snippets,@manualDevelSnippetsSplit}
680 @docLinkBig{Snippets,snippets,@manualDevelSnippetsBig}
682 @docLinkPdf{Snippets,snippets,@manualDevelSnippetsPdf}
687 @docLinkSplit{Web,web,@manualDevelWebSplit}
689 @docLinkBig{Web,web,@manualDevelWebBig}
691 @docLinkPdf{Web,web,@manualDevelWebPdf}
694 @docLinkSplit{Changes,changes,@manualDevelChangesSplit}
696 @docLinkBig{Changes,changes,@manualDevelChangesBig}
698 @docLinkPdf{Changes,changes,@manualDevelChangesPdf}
701 @docLinkSplit{Extending,extending,@manualDevelExtendingSplit}
703 @docLinkBig{Extending,extending,@manualDevelExtendingBig}
705 @docLinkPdf{Extending,extending,@manualDevelExtendingPdf}
708 @docLinkSplit{Internals,internals,@manualDevelInternalsSplit}
710 @docLinkBig{Internals,internals,@manualDevelInternalsBig}
712 @docLinkPdf{Internals,internals,@manualDevelInternalsPdf}
715 @headitem Downloadable
730 @unnumberedsec Authors
732 @divClass{column-left-top}
733 @subheading Current Development Team
735 @divClass{keep-bullets}
740 @divClass{column-right-top}
741 @subheading Previous Development Team
743 @divClass{keep-bullets}
749 @divClass{column-center-top}
750 @subheading Current Contributors
752 @divClass{keep-bullets}
753 @subsubheading Programming
761 @subsubheading Documentation
765 @subsubheading Bug squad
769 @subsubheading Support
773 @subsubheading Translation
781 @divClass{column-center-bottom}
782 @subheading Previous Contributors
784 @divClass{keep-bullets}
785 @subsubheading Programming
793 @subsubheading Documentation
797 @c uncomment when we have any previous members -gp
798 @c @subsubheading Bug squad
802 @subsubheading Support
806 @subsubheading Translation
808 @translationsPrevious
816 @unnumberedsec Publications
818 @divClass{column-center-top}
819 @subheading What we wrote about LilyPond
821 @divClass{keep-bullets}
823 @include we-wrote.itexi
828 @divClass{column-center-bottom}
830 @subheading What people did with LilyPond
833 @divClass{keep-bullets}
835 @include others-did.itexi
840 @contactUsAbout{academic papers}
844 @unnumberedsec Old news
846 @include web/news-front.itexi
848 @include web/news.itexi