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. See TRANSLATION for details.
13 @divClass{column-center-top}
14 @subheading Interacting with the community
19 @ref{Contact}: get help, discuss, and keep in touch!
22 @ref{Tiny examples}: these are @emph{highly} recommended when
26 @ref{Bug reports}: something went wrong.
31 @divClass{column-left-bottom}
32 @subheading Making LilyPond better
37 @ref{Help us}: your assistance is requested.
40 @ref{Development}: for contributors and testers.
43 @ref{Authors}: the people who made LilyPond what it is today.
48 @divClass{column-right-bottom}
49 @subheading Miscellaneous
54 @ref{Publications}: what we wrote, and have had written about us.
57 @ref{Old news}: an archive.
78 @unnumberedsec Contact
81 @divClass{column-left-bottom}
82 @subheading User Discussions and Help
84 @subsubheading User mailing list: @code{lilypond-user@@gnu.org}
86 This mailing list is the main place for users to discuss and help
90 @uref{http://mail.gnu.org/mailman/listinfo/lilypond-user,
91 lilypond-user subscribe and info}
93 @uref{http://mail.gnu.org/archive/html/lilypond-user/,
95 @uref{http://www.mail-archive.com/lilypond-user@@gnu.org/,
97 @uref{http://dir.gmane.org/gmane.comp.gnu.lilypond.general,
100 @uref{http://post.gmane.org/post.php?group=gmane.comp.gnu.lilypond.general,
101 send to lilypond-user with gmane}
104 @warning{When asking questions, please use @ref{Tiny examples}!}
109 Some level of support is provided on our IRC channel,
112 @uref{irc://irc.freenode.net/lilypond, #lilypond@@irc.freenode.net}
115 This channel has no public archive, so any question that may
116 be useful for others would better be posted to one of the mailing lists.
119 @subsubheading Other languages
122 @uref{http://es.groups.yahoo.com/group/lilypond-es,
125 @uref{http://www.lilypondforum.de/,
128 @uref{http://groups.google.com/group/lilypond-brasil,
131 @uref{http://lists.gnu.org/mailman/listinfo/lilypond-user-fr,
134 @uref{http://www.lilypondforum.nl/,
141 @divClass{column-right-top}
142 @subheading Stay Informed
144 @subsubheading LilyPond Report
146 The easiest way to keep touch is by reading our community
147 newsletter, the @uref{http://news.lilynet.net/, LilyPond Report}.
149 @subsubheading Releases mailing list: @code{info-lilypond@@gnu.org}
151 This mailing list is a low-volume, read-only list which receives
152 notifications of new releases.
155 @uref{http://lists.gnu.org/mailman/listinfo/info-lilypond,
156 info-lilypond subscribe and info}
158 @uref{http://mail.gnu.org/archive/html/info-lilypond/,
160 @uref{http://www.mail-archive.com/info-lilypond@@gnu.org/,
162 @uref{http://dir.gmane.org/gmane.comp.gnu.lilypond.announce,
165 @c don't include gmane posting here. -gp
172 @divClass{column-right-bottom}
173 @subheading Developer Discussion
175 @subsubheading Developer mailing list: @code{lilypond-devel@@gnu.org}
177 Most developer discussion takes place on this list. Patches
181 @uref{http://mail.gnu.org/mailman/listinfo/lilypond-devel,
182 lilypond-devel subscribe and info}
184 @uref{http://mail.gnu.org/archive/html/lilypond-devel/,
186 @uref{http://www.mail-archive.com/lilypond-devel@@gnu.org/,
188 @uref{http://dir.gmane.org/gmane.comp.gnu.lilypond.devel,
191 @uref{http://post.gmane.org/post.php?group=gmane.comp.gnu.lilypond.devel,
192 send to lilypond-devel with gmane}
196 @subsubheading Bug mailing list: @code{bug-lilypond@@gnu.org}
198 Bug-specific discussion takes place here.
201 @uref{http://mail.gnu.org/mailman/listinfo/bug-lilypond,
202 bug-lilypond subscribe and info}
204 @uref{http://mail.gnu.org/archive/html/bug-lilypond/,
206 @uref{http://www.mail-archive.com/bug-lilypond@@gnu.org/,
208 @uref{http://dir.gmane.org/gmane.comp.gnu.lilypond.bugs,
211 @c don't include gmane posting here. -gp
214 @warning{Before sending a message to the bug list, please read our
215 guidelines for @ref{Bug reports}.}
222 @unnumberedsec Tiny examples
224 @divClass{column-center-top}
225 @subheading What are @qq{Tiny examples}?
227 A tiny example is an example from which nothing can be removed.
230 @divClass{column-left-bottom}
231 @subheading Why create them?
233 @divClass{keep-bullets}
237 The simpler the example is, the quicker potential helpers can
238 understand it and help you.
241 A simple example demonstrates that you have put effort towards
242 solving the problem yourself. When people send huge portions of
243 input, it looks like they don't care how if we help them or not.
246 Creating a tiny example forces you to understand what is
247 happening. Many false problem reports can be avoided by
248 attempting to create a tiny example; if you cannot replicate a
249 @qq{bug} in a tiny example, then the problem was probably an
250 insufficient understanding of LilyPond, not an actual bug!
258 @divClass{column-right-bottom}
259 @subheading How do I create them?
261 @divClass{keep-bullets}
265 Include the \version number.
268 Make it small! Examples about spacing or page layout might
269 require many bars of music, but most issues can be reproduced
270 using only a single measure.
273 When trying to create an example, try commenting out @w{(@code{%}
274 or @code{%@{ @dots{} %@}})} sections of your file. If you can
275 comment something while still demonstrating the main idea, then
276 remove the commented-material!
279 Avoid using complicated notes, keys, or time signatures, unless
280 the bug is about the behavior of those items.
283 Do not use @code{\override} or @code{\set} commands unless the bug
284 is about those particular commands.
295 @unnumberedsec Bug reports
297 @divClass{column-center-top}
298 @subheading Step 1: Known bugs
300 If you have input that results in a crash or an erroneous output,
301 then that is a bug. There is a list of current bugs on our google
305 @uref{http://code.google.com/p/lilypond/issues/list}
308 @warning{Please @strong{DO NOT} add bug reports directly to the
309 bug tracker. Once an issue has been added to the tracker, feel
310 free to add more information to that report.}
315 @divClass{column-left-bottom}
316 @subheading Step 2: Creating a bug report
318 If you have discovered a bug which is not listed, please help us
319 by creating a bug report.
321 @warning{We only accept bug reports in the form of @ref{Tiny
322 examples}. We have very limited resources to deal with bug
323 reports, so any non-minimal example will be rejected. Almost
324 every bug can be demonstrated in four notes or less!}
326 Here is an example of a good bug report:
329 %% the octavation command doesn't
330 %% change the output at all!
333 \paper@{ ragged-right=##t @}
343 @divClass{column-right-bottom}
344 @subheading Step 3: Sending a bug report
346 Once you have verified that the issue is not already known and
347 created a bug report, please send it to us!
349 Unfortunately there is a strict @qq{no top-posting} check on the
350 bug list, which is often incorrectly triggered by lilypond files.
351 To avoid this, please add
354 > I'm not top posting.
358 (you must include the @code{>} ) to the top of your bug report.
360 @uref{http://post.gmane.org/post.php?group=gmane.comp.gnu.lilypond.bugs,
361 Post with the gmane lilypond.bugs interface}, or send an email to
362 @uref{mailto:bug-lilypond@@gnu.prg, bug-lilypond@@gnu.org}.
364 Once your bug has been sent to the list, our Bug Meister will
365 examine the report. He may ask you for more information, or may
366 add the report to the tracker and let you know what the issue
369 You may mark the bug so that you automatically receive emails when
370 any activity on the bug occurs. This requires you have a google
376 @unnumberedsec Help us
378 FIXME: before going live, rewrite this to apply to lilypond
379 generally. Right now it's (deliberately) website-specific.
381 @subheading This document
383 @subsubheading High priority / blocks release
387 - python: automatically insert latest version numbers into these
388 pages. Script already exists for the old website, but might
389 (or might not!) require tweaking.
391 - translation infrastructure.
393 @subsubheading Low priority / may never
395 - perl: web-texi2html.pl needs to be un-hacked; I did things
396 really messily. Possibly even merge/share functions with
397 the doc init.pl file?
399 - somebody to implement/work on a media=handheld CSS sheet
401 - remove the attributes from the <body> tag. In general, clean up
402 the HTML produced by texi2html
407 @unnumberedsec Development
410 @divClass{heading-center}
411 @heading Development materials for LilyPond 2.13.3
413 @warning{These are @emph{unstable development} versions. If you
414 have the slightest doubt about how to use or install LilyPond, we
415 urge you to use the stable @ref{Download}, and read the stable
420 @divClass{column-center-top}
421 @subheading Release numbers
423 There are two sets of releases for LilyPond: stable releases, and
424 unstable development releases. Stable versions have an
425 even-numbered @q{minor} version number (e.g., 2.8, 2.10, 2.12).
426 Development versions have an odd-numbered @q{minor} version number
427 (e.g., 2.7, 2.9, 2.11).
432 @divClass{column-left-bottom}
435 @uref{http://download.linuxaudio.org/lilypond/binaries/linux-x86/lilypond-2.13.3-1.linux-x86.sh,
436 lilypond-2.13.3-1.linux-x86.sh}
438 @uref{http://download.linuxaudio.org/lilypond/binaries/linux-64/lilypond-2.13.3-1.linux-64.sh,
439 lilypond-2.13.3-1.linux-64.sh}
441 @uref{http://download.linuxaudio.org/lilypond/binaries/linux-ppc/lilypond-2.13.3-1.linux-ppc.sh,
442 lilypond-2.13.3-1.linux-ppc.sh}
444 @uref{http://download.linuxaudio.org/lilypond/binaries/freebsd-x86/lilypond-2.13.3-1.freebsd-x86.sh,
445 lilypond-2.13.3-1.freebsd-x86.sh}
447 @uref{http://download.linuxaudio.org/lilypond/binaries/freebsd-64/lilypond-2.13.3-1.freebsd-64.sh,
448 lilypond-2.13.3-1.freebsd-64.sh}
451 http://download.linuxaudio.org/lilypond/binaries/darwin-x86/lilypond-2.13.3-1.darwin-x86.tar.bz2,
452 lilypond-2.13.3-1.darwin-x86.tar.bz2}
455 http://download.linuxaudio.org/lilypond/binaries/darwin-x86/lilypond-2.13.3-1.darwin-ppc.tar.bz2,
456 lilypond-2.13.3-1.darwin-ppc.tar.bz2}
459 http://download.linuxaudio.org/lilypond/binaries/mingw/lilypond-2.13.3-1.mingw.exe,
460 lilypond-2.13.3-1.mingw-exe}
465 FIXME: these need the automatic symlinks or something. Maybe even
466 a hard-coded url to lilypond.org/docs/2.13 or something??
470 @uref{lm-big-html, big html}
475 @uref{mg-big-html, big html}
479 @uref{essay-html, html}
480 @uref{essay-big-html, big html}
481 @uref{essay-pdf, pdf}
484 @uref{notation-html, html}
485 @uref{notation-big-html, big html}
486 @uref{notation-pdf, pdf}
489 @uref{usage-html, html}
490 @uref{usage-big-html, big html}
491 @uref{usage-pdf, pdf}
494 @uref{snippets-html, html}
495 @uref{snippets-big-html, big html}
496 @uref{snippets-pdf, pdf}
499 @uref{changes-html, html}
500 @uref{changes-big-html, big html}
501 @uref{changes-pdf, pdf}
504 @uref{internals-html, html}
505 @uref{internals-big-html, big html}
506 @uref{internals-pdf, pdf}
511 @divClass{column-right-top}
512 @subheading Contributors' Guide
514 LilyPond development is a fairly complicated matter. LilyPond is
515 a large, (mostly) stable project. At any point in time, we have
516 between 5 and 25 active contributors. In order to help new
517 contributors, and to keep the whole system (mostly) stable, we
518 have written a manual for contributors.
520 @divClass{keep-bullets}
523 @item @uref{../contributor/index.html, Contributor's guide (split HTML)}:
524 the manual is split between many HTML pages.
525 @emph{(small download for each page)}
527 @item @uref{../contributor-big-page.html, Contributor's guide (big HTML)}:
528 read this manual as one huge HTML page.
529 @emph{(large single download, around 10? Mb)}
531 @item @uref{../contributor.pdf, contributor.pdf}:
532 download as a PDF file.
533 @emph{(large single download, 2.8 Mb)}
535 @item @uref{FIXME, contributor.info}:
536 GNU info format for documentation. FIXME, link broken.
542 @divClass{column-right-bottom}
543 @subheading Regression tests
545 @divClass{keep-bullets}
548 @item @uref{../../input/regression/collated-files.html, Regression tests}:
549 This releases' tests. (also in
550 @uref{../../input/regression/collated-files.pdf, pdf})
552 @item @uref{../../input/regression/musicxml/collated-files.html,
553 MusicXML Regression tests}:
554 This releases' MusicXML tests. (also in
555 @uref{../../input/regression/musicxml/collated-files.pdf, pdf})
557 @item @uref{http://lilypond.org/test, Archive of regression tests}:
558 Comparisons beteween versions.
565 @unnumberedsec Authors
569 http://lilypond.org/web/about/thanks
571 Documentation/topdocs/AUTHORS.texi
574 http://lilypond.org/web/switch/
580 @unnumberedsec Publications
582 @divClass{column-center-top}
584 @subheading What we wrote
586 @divClass{keep-bullets}
590 Han-Wen Nienhuys and Jan Nieuwenhuizen, @emph{LilyPond, a system
591 for automated music engraving}. Proceedings of the XIV Colloquium
592 on Musical Informatics (XIV CIM 2003), Firenze, Italy, May 2003.
593 (@uref{ http://lilypond.org/web/images/xivcim.pdf, PDF 95k})
596 Han-Wen Nienhuys, @emph{LilyPond, Automated music formatting and
597 the Art of Shipping}. Forum Internacional Software Livre 2006
598 (FISL7.0) (@uref{http://lilypond.org/web/images/FISL7-slides.pdf,
602 Erik Sandberg, @emph{Separating input language and formatter in
603 GNU Lilypond}. Master's Thesis, Uppsala University, Department of
604 Information Technology March 2006.
605 (@uref{http://lilypond.org/web/images/thesis-erik-sandberg.pdf,
614 @divClass{column-center-bottom}
616 @subheading What others wrote
618 @divClass{keep-bullets}
624 In @uref{http://www.musicbyandrew.ca/finale-lilypond-1.html,
625 articles on his personal site}, Andrew Hawryluk compares Finale
626 and LilyPond in general terms, and evaluates in detail engraving
627 capabilities of both pieces of software. The second article is an
628 instructive analysis of Rachmaninoff's Piano Prelude 6 engraving,
629 including comparisons with a reference hand-engraved edition.
634 linux journal cover Linux Journal publishes an article titled
635 @uref{http://www.linuxjournal.com/article/8364, Make Stunning
636 Schenker Graphs with GNU LilyPond}. It is a in-depth but hands-on
637 feature article with crisp LilyPond graphics. Author Kris Shaffer
638 remarks “GNU Lilypond generates beautiful graphics that make
639 commercial alternatives seem second-rate.”
644 The Belgian newspaper De Standaard investigates what drives Free
645 Software authors in an article titled
646 @uref{http://www.standaard.be/Artikel/Detail.aspx?artikelId=G42H5GD6,
647 Delen van KENNIS zonder WINSTBEJAG} (Non-profit sharing of
648 knowlegde) in its `DS2 bijlage'. LilyPond is used as an example
649 and the article is interspersed with quotes from an `email
650 interview' with Jan Nieuwenhuizen. This marks LilyPond's first
651 appearance in mainstream printed press.
656 A French article on the LilyPond 2.6 release appeared on
657 @uref{http://linuxfr.org/2005/06/27/19210.html, linuxfr.org}.
662 The editors of Computer!Totaal, a Dutch computer magazine,
663 @uref{http://lilypond.org/web/images/computer-totaal.jpeg,
664 describe LilyPond} in the October 2004 issue as: @qq{Wonderful
665 free (open source) software [..] The sheet music produced by
666 LilyPond is exceptionally pretty [..] a very powerful system that
667 can do almost anything.}
672 Dave Phillips wrote an introductory article for Linux Journal At
673 the sounding edge: LilyPond, parts
674 @uref{http://www.linuxjournal.com/article/7657, one} and
675 @uref{http://www.linuxjournal.com/article/7719, two}.
680 Chris Cannam interviewed Han-Wen Nienhuys and Jan Nieuwenhuizen on
681 linuxmusician.com (site now defunct). This interview was also
683 @uref{http://slashdot.org/article.pl?sid=04/03/13/2054227&tid=,
689 Jazz singer Gail Selkirk writes about
690 @uref{http://www.songbirdofswing.com/editorial_page/lilypond/,
691 Diving into LilyPond}. @qq{... you can make lead sheets or full
692 orchestral parts, and the results can be stunning.}
693 @uref{http://www.computermusic.co.uk/, Computer Music Special},
703 @unnumberedsec Old news
705 @include general/news.itexi