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.
9 @include web/basic-authors.itexi
15 @divClass{column-center-top}
16 @subheading Interacting with the community
21 @ref{Contact}: get help, discuss, and keep in touch!
24 @ref{Tiny examples}: these are @emph{highly} recommended when
28 @ref{Bug reports}: something went wrong.
33 @divClass{column-left-bottom}
34 @subheading Making LilyPond better
39 @ref{Help us}: your assistance is requested.
42 @ref{Development}: for contributors and testers.
45 @ref{Authors}: the people who made LilyPond what it is today.
50 @divClass{column-right-bottom}
51 @subheading Miscellaneous
56 @ref{Publications}: what we wrote, and have had written about us.
59 @ref{Old news}: an archive.
80 @unnumberedsec Contact
83 @divClass{column-left-bottom}
84 @subheading User Discussions and Help
86 @subsubheading User mailing list: @code{lilypond-user@@gnu.org}
88 This mailing list is the main place for users to discuss and help
92 @uref{http://mail.gnu.org/mailman/listinfo/lilypond-user,
93 lilypond-user subscribe and info}
95 @uref{http://mail.gnu.org/archive/html/lilypond-user/,
97 @uref{http://www.mail-archive.com/lilypond-user@@gnu.org/,
99 @uref{http://dir.gmane.org/gmane.comp.gnu.lilypond.general,
102 @uref{http://post.gmane.org/post.php?group=gmane.comp.gnu.lilypond.general,
103 send to lilypond-user with gmane}
106 @warning{When asking questions, please use @ref{Tiny examples}!}
111 Some level of support is provided on our IRC channel,
114 @uref{irc://irc.freenode.net/lilypond, #lilypond@@irc.freenode.net}
117 This channel has no public archive, so any question that may
118 be useful for others would better be posted to one of the mailing lists.
121 <form action="http://webchat.freenode.net"
125 <input name="nick" type="text" size="15" value="">
127 <input name="channels" type="hidden" value="lilypond">
128 <input type="submit" value="Join #lilypond IRC Chat">
131 <script language="JavaScript" type="text/javascript">
132 var username = "web";
133 var lang = window.navigator.userLanguage ? window.navigator.userLanguage
134 : window.navigator.language;
135 username += '-' + lang.substr(0, 2);
136 username += '-' + navigator.appName.substr(0, 2);
137 username += navigator.appCodeName.replace (" ", "").substr(0, 2);
138 username += navigator.platform.replace (" ", "").replace("nux", "").replace("n32", "");
139 document.forms["f_lily_irc"].nick.value = username;
143 @subsubheading Other languages
146 @uref{http://es.groups.yahoo.com/group/lilypond-es,
149 @uref{http://www.lilypondforum.de/,
152 @uref{http://groups.google.com/group/lilypond-brasil,
155 @uref{http://lists.gnu.org/mailman/listinfo/lilypond-user-fr,
158 @uref{http://www.lilypondforum.nl/,
165 @divClass{column-right-top}
166 @subheading Stay Informed
168 @subsubheading LilyPond Report
170 The easiest way to keep touch is by reading our community
171 newsletter, the @uref{http://news.lilynet.net/, LilyPond Report}.
173 @subsubheading Releases mailing list: @code{info-lilypond@@gnu.org}
175 This mailing list is a low-volume, read-only list which receives
176 notifications of new releases.
179 @uref{http://lists.gnu.org/mailman/listinfo/info-lilypond,
180 info-lilypond subscribe and info}
182 @uref{http://mail.gnu.org/archive/html/info-lilypond/,
184 @uref{http://www.mail-archive.com/info-lilypond@@gnu.org/,
186 @uref{http://dir.gmane.org/gmane.comp.gnu.lilypond.announce,
189 @c don't include gmane posting here. -gp
196 @divClass{column-right-bottom}
197 @subheading Developer Discussion
199 @subsubheading Developer mailing list: @code{lilypond-devel@@gnu.org}
201 Most developer discussion takes place on this list. Patches
205 @uref{http://mail.gnu.org/mailman/listinfo/lilypond-devel,
206 lilypond-devel subscribe and info}
208 @uref{http://mail.gnu.org/archive/html/lilypond-devel/,
210 @uref{http://www.mail-archive.com/lilypond-devel@@gnu.org/,
212 @uref{http://dir.gmane.org/gmane.comp.gnu.lilypond.devel,
215 @uref{http://post.gmane.org/post.php?group=gmane.comp.gnu.lilypond.devel,
216 send to lilypond-devel with gmane}
220 @subsubheading Bug mailing list: @code{bug-lilypond@@gnu.org}
222 Bug-specific discussion takes place here.
225 @uref{http://mail.gnu.org/mailman/listinfo/bug-lilypond,
226 bug-lilypond subscribe and info}
228 @uref{http://mail.gnu.org/archive/html/bug-lilypond/,
230 @uref{http://www.mail-archive.com/bug-lilypond@@gnu.org/,
232 @uref{http://dir.gmane.org/gmane.comp.gnu.lilypond.bugs,
235 @c don't include gmane posting here. -gp
238 @warning{Before sending a message to the bug list, please read our
239 guidelines for @ref{Bug reports}.}
246 @unnumberedsec Tiny examples
248 @divClass{column-center-top}
249 @subheading What are @qq{Tiny examples}?
251 A tiny example is an example from which nothing can be removed.
254 @divClass{column-left-bottom}
255 @subheading Why create them?
257 @divClass{keep-bullets}
261 The simpler the example is, the quicker potential helpers can
262 understand it and help you.
265 A simple example demonstrates that you have put effort towards
266 solving the problem yourself. When people send huge portions of
267 input, it looks like they don't care how if we help them or not.
270 Creating a tiny example forces you to understand what is
271 happening. Many false problem reports can be avoided by
272 attempting to create a tiny example; if you cannot replicate a
273 @qq{bug} in a tiny example, then the problem was probably an
274 insufficient understanding of LilyPond, not an actual bug!
282 @divClass{column-right-bottom}
283 @subheading How do I create them?
285 @divClass{keep-bullets}
289 Include the \version number.
292 Make it small! Examples about spacing or page layout might
293 require many bars of music, but most issues can be reproduced
294 using only a single measure.
297 When trying to create an example, try commenting out @w{(@code{%}
298 or @code{%@{ @dots{} %@}})} sections of your file. If you can
299 comment something while still demonstrating the main idea, then
300 remove the commented-material!
303 Avoid using complicated notes, keys, or time signatures, unless
304 the bug is about the behavior of those items.
307 Do not use @code{\override} or @code{\set} commands unless the bug
308 is about those particular commands.
319 @unnumberedsec Bug reports
321 @divClass{column-center-top}
322 @subheading Step 1: Known bugs
324 If you have input that results in a crash or an erroneous output,
325 then that is a bug. There is a list of current bugs on our google
329 @uref{http://code.google.com/p/lilypond/issues/list}
332 @warning{Please @strong{DO NOT} add bug reports directly to the
333 bug tracker. Once an issue has been added to the tracker, feel
334 free to add more information to that report.}
339 @divClass{column-left-bottom}
340 @subheading Step 2: Creating a bug report
342 If you have discovered a bug which is not listed, please help us
343 by creating a bug report.
345 @warning{We only accept bug reports in the form of @ref{Tiny
346 examples}. We have very limited resources to deal with bug
347 reports, so any non-minimal example will be rejected. Almost
348 every bug can be demonstrated in four notes or less!}
350 Here is an example of a good bug report:
353 %% the octavation command doesn't
354 %% change the output at all!
357 \paper@{ ragged-right=##t @}
367 @divClass{column-right-bottom}
368 @subheading Step 3: Sending a bug report
370 Once you have verified that the issue is not already known and
371 created a bug report, please send it to us!
373 Unfortunately there is a strict @qq{no top-posting} check on the
374 bug list, which is often incorrectly triggered by lilypond files.
375 To avoid this, please add
378 > I'm not top posting.
382 (you must include the @code{>} ) to the top of your bug report.
384 @uref{http://post.gmane.org/post.php?group=gmane.comp.gnu.lilypond.bugs,
385 Post with the gmane lilypond.bugs interface}, or send an email to
386 @uref{mailto:bug-lilypond@@gnu.prg, bug-lilypond@@gnu.org}.
388 Once your bug has been sent to the list, our Bug Meister will
389 examine the report. He may ask you for more information, or may
390 add the report to the tracker and let you know what the issue
393 You may mark the bug so that you automatically receive emails when
394 any activity on the bug occurs. This requires you have a google
400 @unnumberedsec Help us
402 TODO: talk about the Frogs, document suggestions, encourage getting
403 @divClass{heading-center}
404 @heading We need you!
406 The LilyPond development team is quite small; we really want to
407 get more people involved. Please consider helping us, even with
408 small tasks -- anything that you do will allow an experienced
409 developer to work on advanced tasks.
414 @divClass{column-left-top}
415 @subheading Ways of contributing
417 Many users ask @qq{I can't program; how can I help?}
419 @divClass{keep-bullets}
420 @subsubheading No source, no programming
422 @sourceimage{logo-linux,,,}
423 @sourceimage{logo-freebsd,,,}
424 @sourceimage{logo-macosx,,,}
425 @sourceimage{logo-windows,,,}
429 Mailist support: we have many users asking for him.
432 LilyPond Snippet Repository (LSR): create and fix snippets. See
433 @rcontrib{Adding and editing snippets}.
436 Bug reporting: our infrastructure for organizing bug reports only
437 requires a web browser. Please do not add bugs directly unless
438 you have learned how we like to handle such reports. See
442 Discussions, reviews, and testing: the developers often ask for
443 feedback about new documentation, potential syntax changes, and
444 testing new features. We rarely receive as much feedback as we
445 would like; please consider responding to these requests! (even
446 if your only contribution is @qq{wow, looks great!})
450 @subsubheading With source, no programming
452 @sourceimage{logo-linux,,,}
453 @sourceimage{logo-freebsd,,,}
454 @sourceimage{logo-macosx,,,}
455 @sourceimage{logo-windows,,,}
457 To get the source code, see @rcontrib{Starting with git}.
462 @rcontrib{Building documentation without compiling LilyPond}.
465 Website: the website is built from the normal documentation
466 source. See the info about documentation, and also
467 @rcontrib{Website work}.
470 Translations: see @rcontrib{Translating the documentation}, and
471 @rcontrib{Translating the website}.
475 @subsubheading Programming
477 @sourceimage{logo-linux,,,}
478 @sourceimage{logo-freebsd,,,}
479 @sourceimage{logo-macosx,,,}
481 To the best of our knowledge, nobody has compiled LilyPond on
482 Windows. We have therefore created @emph{lilybuntu}, a custom
483 @emph{Ubuntu} variant configured for LilyPond development. This
484 runs inside a virtual machine, without disturbing the Windows
485 operating system. For more information, see
486 @rcontrib{Using a Virtual Machine to Compile LilyPond}.
490 Bugfixes, new features: the best way to begin is to join the
499 @divClass{column-right-top}
504 Website and mailist: @uref{http://frogs.lilynet.net}
506 The Frogs are simple LilyPond users who have chosen to get
507 involved in their favorite software's development. Fixing bugs,
508 implementing new features, documenting the source code: there's a
509 lot to be done, but most importantly: this is a chance for
510 everyone to learn more about LilyPond, about Free Software, about
511 programming... and to have fun. If you're curious about any of
512 it, then the word is: @emph{Join the Frogs!}
516 @help{not active yet; either comment out or begin these projects
519 @subsubheading Grand LilyPond Input Syntax Standardization
521 Website and mailist: TODO
523 GLISS will stabilize the (non-tweak) input syntax for the upcoming
524 LilyPond 3.0. After updating to 3.0, the input syntax for
525 untweaked music will remain stable for the foreseeable future.
527 We will have an extensive discussion period to determine the final
530 @subsubheading Grand Organizing Project
532 Website and mailist: TODO
534 GOP is our big recruiting drive for new contributors.
538 @divClass{column-center-bottom}
542 All logos and product images are copyright and trademark
558 @unnumberedsec Development
561 @divClass{heading-center}
562 @heading Development materials for LilyPond @versionDevel{}
564 @warning{These are @emph{unstable development} versions. If you
565 have the slightest doubt about how to use or install LilyPond, we
566 urge you to use the stable @ref{Download}, and read the stable
571 @divClass{column-center-top}
572 @subheading Release numbers
574 There are two sets of releases for LilyPond: stable releases, and
575 unstable development releases. Stable versions have an
576 even-numbered @q{minor} version number (e.g., 2.8, 2.10, 2.12).
577 Development versions have an odd-numbered @q{minor} version number
578 (e.g., 2.7, 2.9, 2.11).
583 @divClass{column-left-bottom}
586 Instructions for git and compiling are in the Contributor's Guide.
589 @uref{http://git.sv.gnu.org/gitweb/?p=lilypond.git, lilypond git repository}
592 Documentation writers and testers will generally want to download
597 @downloadDevelLinuxNormal
599 @downloadDevelLinuxBig
601 @downloadDevelLinuxPPC
603 @downloadDevelFreeBSDNormal
605 @downloadDevelFreeBSDBig
607 @downloadDevelDarwinNormal
609 @downloadDevelDarwinPPC
611 @downloadDevelWindows
620 @help {these need the automatic symlinks or something. Maybe even
621 a hard-coded url to lilypond.org/docs/2.13 or something??}
625 @uref{lm-big-html, big html}
630 @uref{mg-big-html, big html}
634 @uref{essay-html, html}
635 @uref{essay-big-html, big html}
636 @uref{essay-pdf, pdf}
639 @uref{notation-html, html}
640 @uref{notation-big-html, big html}
641 @uref{notation-pdf, pdf}
644 @uref{usage-html, html}
645 @uref{usage-big-html, big html}
646 @uref{usage-pdf, pdf}
649 @uref{snippets-html, html}
650 @uref{snippets-big-html, big html}
651 @uref{snippets-pdf, pdf}
654 @uref{changes-html, html}
655 @uref{changes-big-html, big html}
656 @uref{changes-pdf, pdf}
659 @uref{internals-html, html}
660 @uref{internals-big-html, big html}
661 @uref{internals-pdf, pdf}
666 @divClass{column-right-top}
667 @subheading Contributors' Guide
669 LilyPond development is a fairly complicated matter. LilyPond is
670 a large, (mostly) stable project. At any point in time, we have
671 between 5 and 25 active contributors. In order to help new
672 contributors, and to keep the whole system (mostly) stable, we
673 have written a manual for contributors.
675 @divClass{keep-bullets}
678 @item @uref{../contributor/index.html, Contributor's guide (split HTML)}:
679 the manual is split between many HTML pages.
680 @emph{(small download for each page)}
682 @item @uref{../contributor-big-page.html, Contributor's guide (big HTML)}:
683 read this manual as one huge HTML page.
684 @emph{(large single download, around 10? Mb)}
686 @item @uref{../contributor.pdf, contributor.pdf}:
687 download as a PDF file.
688 @emph{(large single download, 2.8 Mb)}
690 @c @item @uref{TODO, contributor.info}:
691 @c GNU info format for documentation. TODO, link broken.
697 @divClass{column-right-bottom}
698 @subheading Regression tests
700 @divClass{keep-bullets}
703 @item @uref{../../input/regression/collated-files.html, Regression tests}:
704 This releases' tests. (also in
705 @uref{../input/regression/collated-files.pdf, pdf})
707 @item @uref{../../input/regression/musicxml/collated-files.html,
708 MusicXML Regression tests}:
709 This releases' MusicXML tests. (also in
710 @uref{../input/regression/musicxml/collated-files.pdf, pdf})
712 @item @uref{http://lilypond.org/test, Archive of regression tests}:
713 Comparisons beteween versions.
720 @unnumberedsec Authors
722 @help{Under construction; this is not an accurate list!}
726 http://lilypond.org/web/about/thanks
728 Documentation/topdocs/AUTHORS.texi
731 http://lilypond.org/web/switch/
734 @divClass{column-left-top}
735 @subheading Current Development Team
737 @divClass{keep-bullets}
742 @divClass{column-right-top}
743 @subheading Previous Development Team Positions
745 @divClass{keep-bullets}
751 @divClass{column-center-bottom}
752 @subheading Programming contributors
754 @divClass{keep-bullets}
757 @subheading Font contributors
761 @subheading Documentation contributors
765 @subheading Support contributors
769 @subheading Translation contributors
771 @contributorsTranslations
779 @unnumberedsec Publications
781 @divClass{column-center-top}
782 @subheading What we wrote
784 @divClass{keep-bullets}
788 Han-Wen Nienhuys, @emph{LilyPond, Automated music formatting and
789 the Art of Shipping}. Forum Internacional Software Livre 2006
790 (FISL7.0) (@uref{http://lilypond.org/web/images/FISL7-slides.pdf,
794 Erik Sandberg, @emph{Separating input language and formatter in
795 GNU Lilypond}. Master's Thesis, Uppsala University, Department of
796 Information Technology March 2006.
797 (@uref{http://lilypond.org/web/images/thesis-erik-sandberg.pdf,
801 Han-Wen Nienhuys and Jan Nieuwenhuizen, @emph{LilyPond, a system
802 for automated music engraving}. Proceedings of the XIV Colloquium
803 on Musical Informatics (XIV CIM 2003), Firenze, Italy, May 2003.
804 (@uref{ http://lilypond.org/web/images/xivcim.pdf, PDF 95k})
812 @divClass{column-center-bottom}
814 @subheading What others wrote
816 @divClass{keep-bullets}
822 The German LinuxUser magazine wrote an
823 @uref{http://www.linux-community.de/Internal/Artikel/Print-Artikel/LinuxUser/2009/10/Digitaler-Notenschluessel,
824 article about lilypond}.
830 In @uref{http://www.musicbyandrew.ca/finale-lilypond-1.html,
831 articles on his personal site}, Andrew Hawryluk compares Finale
832 and LilyPond in general terms, and evaluates in detail engraving
833 capabilities of both pieces of software. The second article is an
834 instructive analysis of Rachmaninoff's Piano Prelude 6 engraving,
835 including comparisons with a reference hand-engraved edition.
840 Linux journal cover Linux Journal publishes an article titled
841 @uref{http://www.linuxjournal.com/article/8364, Make Stunning
842 Schenker Graphs with GNU LilyPond}. It is a in-depth but hands-on
843 feature article with crisp LilyPond graphics. Author Kris Shaffer
844 remarks “GNU Lilypond generates beautiful graphics that make
845 commercial alternatives seem second-rate.”
850 The Belgian newspaper De Standaard investigates what drives Free
851 Software authors in an article titled
852 @uref{http://www.standaard.be/Artikel/Detail.aspx?artikelId=G42H5GD6,
853 Delen van KENNIS zonder WINSTBEJAG} (Non-profit sharing of
854 knowlegde) in its `DS2 bijlage'. LilyPond is used as an example
855 and the article is interspersed with quotes from an `email
856 interview' with Jan Nieuwenhuizen. This marks LilyPond's first
857 appearance in mainstream printed press.
862 A French article on the LilyPond 2.6 release appeared on
863 @uref{http://linuxfr.org/2005/06/27/19210.html, linuxfr.org}.
868 The editors of Computer!Totaal, a Dutch computer magazine,
869 @uref{http://lilypond.org/web/images/computer-totaal.jpeg,
870 describe LilyPond} in the October 2004 issue as: @qq{Wonderful
871 free (open source) software [..] The sheet music produced by
872 LilyPond is exceptionally pretty [..] a very powerful system that
873 can do almost anything.}
878 Dave Phillips wrote an introductory article for Linux Journal At
879 the sounding edge: LilyPond, parts
880 @uref{http://www.linuxjournal.com/article/7657, one} and
881 @uref{http://www.linuxjournal.com/article/7719, two}.
886 Chris Cannam interviewed Han-Wen Nienhuys and Jan Nieuwenhuizen on
887 linuxmusician.com (site now defunct). This interview was also
889 @uref{http://slashdot.org/article.pl?sid=04/03/13/2054227&tid=,
895 Jazz singer Gail Selkirk writes about
896 @uref{http://www.songbirdofswing.com/editorial_page/lilypond/,
897 Diving into LilyPond}. @qq{... you can make lead sheets or full
898 orchestral parts, and the results can be stunning.}
899 @uref{http://www.computermusic.co.uk/, Computer Music Special},
909 @unnumberedsec Old news
911 @include web/news.itexi