]> git.donarmstrong.com Git - lilypond.git/blob - Documentation/web/community.itexi
Imported Upstream version 2.14.2
[lilypond.git] / Documentation / web / community.itexi
1 @c -*- coding: utf-8; mode: texinfo; -*-
2 @ignore
3     Translation of GIT committish: FILL-IN-HEAD-COMMITTISH
4
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..
8 @end ignore
9
10 @include included/authors.itexi
11 @include included/helpus.itexi
12
13 @node Community
14 @unnumbered Community
15
16 @divClass{link-headings}
17
18 @divClass{column-center-top}
19 @subheading Interacting with the community
20
21 @itemize
22
23 @item
24 @ref{Contact}: get help, discuss, and keep in touch!
25
26 @item
27 @ref{Tiny examples}: these are @emph{highly} recommended when
28 discussing LilyPond.
29
30 @item
31 @ref{Bug reports}: something went wrong.
32
33 @end itemize
34 @divEnd
35
36 @divClass{column-left-bottom}
37 @subheading Making LilyPond better
38
39 @itemize
40
41 @item
42 @ref{Help us}: your assistance is requested.
43
44 @item
45 @ref{Development}: for contributors and testers.
46
47 @item
48 @ref{Authors}: the people who made LilyPond what it is today.
49
50 @end itemize
51 @divEnd
52
53 @divClass{column-right-bottom}
54 @subheading Miscellaneous
55
56 @itemize
57
58 @item
59 @ref{Publications}: what we wrote, and have had written about us.
60
61 @item
62 @ref{Old news}: an archive.
63
64 @end itemize
65 @divEnd
66
67 @divEnd
68
69 @divClass{hide}
70 @menu
71 * Contact::
72 * Tiny examples::
73 * Bug reports::
74 * Help us::
75 * Development::
76 * Authors::
77 * Publications::
78 * Old news::
79 @end menu
80 @divEnd
81
82
83 @node Contact
84 @unnumberedsec Contact
85
86
87 @divClass{column-left-bottom}
88 @subheading User Discussions and Help
89
90 @subsubheading User mailing list: @code{lilypond-user@@gnu.org}
91
92 This mailing list is the main place for users to discuss and help
93 each other.
94
95 @quotation
96 @uref{http://lists.gnu.org/mailman/listinfo/lilypond-user,
97 lilypond-user subscribe and info}
98
99 @uref{http://lists.gnu.org/archive/html/lilypond-user/,
100 user archive1}
101 @uref{http://www.mail-archive.com/lilypond-user@@gnu.org/,
102 archive2}
103 @uref{http://dir.gmane.org/gmane.comp.gnu.lilypond.general,
104 archive3}
105
106 @uref{http://post.gmane.org/post.php?group=gmane.comp.gnu.lilypond.general,
107 send to lilypond-user with gmane}
108 @end quotation
109
110 @warning{When asking questions, please use @ref{Tiny examples}!}
111
112 @subsubheading LilyPond Snippet Repository
113
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,
117 and add your own!
118
119 @example
120 @uref{http://lsr.dsi.unimi.it}
121 @end example
122
123 Particularly instructive examples from LSR are included in our
124 official documentation, in @ref{Snippets}.
125
126
127 @subsubheading IRC
128
129 Some level of support is provided on our IRC channel,
130
131 @example
132 @uref{irc://irc.freenode.net/lilypond, #lilypond@@irc.freenode.net}
133 @end example
134
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.
137
138 @html
139 <form action="http://webchat.freenode.net"
140       method="get"
141       name="f_lily_irc"
142   <label>irc name:
143     <input name="nick" type="text" size="15" value="">
144   </label>
145   <input name="channels" type="hidden" value="lilypond">
146   <input type="submit" value="Join #lilypond IRC Chat">
147 </form>
148
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;
158 </script>
159 @end html
160
161 @subsubheading Other languages
162
163 @quotation
164 @uref{http://lists.gnu.org/mailman/listinfo/lilypond-es,
165 Spanish mailing list}
166
167 @uref{http://www.lilypondforum.de/,
168 German forum}
169
170 @uref{http://groups.google.com/group/lilypond-brasil,
171 Portuguese group}
172
173 @uref{http://lists.gnu.org/mailman/listinfo/lilypond-user-fr,
174 French mailing list}
175
176 @uref{http://www.lilypondforum.nl/,
177 Dutch forum}
178 @end quotation
179
180 @divEnd
181
182
183 @divClass{column-right-top}
184 @subheading Stay Informed
185
186 @subsubheading LilyPond Report
187
188 The easiest way to keep touch is by reading our community
189 newsletter, the LilyPond Report:
190
191 @example
192 @uref{http://news.lilynet.net}
193 @end example
194
195 @subsubheading Releases mailing list: @code{info-lilypond@@gnu.org}
196
197 This mailing list is a low-volume, read-only list which receives
198 notifications of new releases.
199
200 @quotation
201 @uref{http://lists.gnu.org/mailman/listinfo/info-lilypond,
202 info-lilypond subscribe and info}
203
204 @uref{http://lists.gnu.org/archive/html/info-lilypond/,
205 info archive1}
206 @uref{http://www.mail-archive.com/info-lilypond@@gnu.org/,
207 archive2}
208 @uref{http://dir.gmane.org/gmane.comp.gnu.lilypond.announce,
209 archive3}
210
211 @c don't include gmane posting here.  -gp
212 @end quotation
213
214
215 @divEnd
216
217
218 @divClass{column-right-bottom}
219 @subheading Developer Discussion
220
221 @subsubheading Developer mailing list: @code{lilypond-devel@@gnu.org}
222
223 Most developer discussion takes place on this list.  Patches
224 should be sent here.
225
226 @quotation
227 @uref{http://lists.gnu.org/mailman/listinfo/lilypond-devel,
228 lilypond-devel subscribe and info}
229
230 @uref{http://lists.gnu.org/archive/html/lilypond-devel/,
231 devel archive1}
232 @uref{http://www.mail-archive.com/lilypond-devel@@gnu.org/,
233 archive2}
234 @uref{http://dir.gmane.org/gmane.comp.gnu.lilypond.devel,
235 archive3}
236
237 @uref{http://post.gmane.org/post.php?group=gmane.comp.gnu.lilypond.devel,
238 send to lilypond-devel with gmane}
239 @end quotation
240
241
242 @subsubheading Bug mailing list: @code{bug-lilypond@@gnu.org}
243
244 Bug-specific discussion takes place here.
245
246 @quotation
247 @uref{http://lists.gnu.org/mailman/listinfo/bug-lilypond,
248 bug-lilypond subscribe and info}
249
250 @uref{http://lists.gnu.org/archive/html/bug-lilypond/,
251 bug archive1}
252 @uref{http://www.mail-archive.com/bug-lilypond@@gnu.org/,
253 archive2}
254 @uref{http://dir.gmane.org/gmane.comp.gnu.lilypond.bugs,
255 archive3}
256
257 @c don't include gmane posting here.  -gp
258 @end quotation
259
260 @warning{Before sending a message to the bug list, please read our
261 guidelines for @ref{Bug reports}.}
262
263 @divEnd
264
265
266
267 @node Tiny examples
268 @unnumberedsec Tiny examples
269
270 @divClass{column-center-top}
271 @subheading What are @qq{Tiny examples}?
272
273 A tiny example is an example from which nothing can be removed.
274 @divEnd
275
276 @divClass{column-left-bottom}
277 @subheading Why create them?
278
279 @divClass{keep-bullets}
280 @itemize
281
282 @item
283 The simpler the example is, the quicker potential helpers can
284 understand it and help you.
285
286 @item
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.
290
291 @item
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!
297
298 @end itemize
299 @divEnd
300
301 @divEnd
302
303
304 @divClass{column-right-bottom}
305 @subheading How do I create them?
306
307 @divClass{keep-bullets}
308 @itemize
309
310 @item
311 Include the \version number.
312
313 @item
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.
317
318 @item
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!
323
324 @item
325 Avoid using complicated notes, keys, or time signatures, unless
326 the bug is about the behavior of those items.
327
328 @item
329 Do not use @code{\override} or @code{\set} commands unless the bug
330 is about those particular commands.
331
332 @end itemize
333 @divEnd
334
335 @divEnd
336
337
338
339
340 @node Bug reports
341 @unnumberedsec Bug reports
342
343 @divClass{column-center-top}
344 @subheading Step 1: Known bugs
345
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
348 bug tracker,
349
350 @example
351 @uref{http://code.google.com/p/lilypond/issues/list}
352 @end example
353
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.}
357
358 @divEnd
359
360
361 @divClass{column-left-bottom}
362 @subheading Step 2: Creating a bug report
363
364 If you have discovered a bug which is not listed, please help us
365 by creating a bug report.
366
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!}
371
372 Here is an example of a good bug report:
373
374 @example
375 % Accidentals should be printed for only
376 % the first note in a tie, but this version
377 % prints flats on both notes.
378 \version "2.10.1"
379
380 \relative c'' @{
381  bes1 ~
382  bes1
383 @}
384 @end example
385
386 @divEnd
387
388 @divClass{column-right-bottom}
389 @subheading Step 3: Sending a bug report
390
391 Once you have verified that the issue is not already known and
392 created a bug report, please send it to us!
393
394 @divClass{keep-bullets}
395 @itemize
396
397 @item
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.
400
401 @item
402 If you are not subscribed, you can still post a bug report with
403 the
404 @uref{http://post.gmane.org/post.php?group=gmane.comp.gnu.lilypond.bugs,
405 gmane lilypond.bugs web interface}.
406
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:
410
411 @example
412 > I'm not top posting.
413 @end example
414
415 @noindent
416 (you @emph{must} include the @code{>} ) to the top of your bug
417 report.
418
419 @end itemize
420 @divEnd
421 @divEnd
422
423 @divClass{column-center-bottom}
424 @subheading Step 4: Wait for a response
425
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.
431
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
434 account.
435 @divEnd
436
437 @divClass{column-center-bottom}
438 @subheading Optional help: show the desired behavior
439
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!
444
445 @divEnd
446
447
448
449 @node Help us
450 @unnumberedsec Help us
451
452 @divClass{column-center-top}
453 @helpusNeed
454
455 @divEnd
456
457 @divClass{column-left-top}
458 @divClass{keep-bullets}
459 @helpusTasks
460
461 @divEnd
462 @divEnd
463
464 @divClass{column-right-top}
465 @helpusProjects
466
467 @divEnd
468
469
470 @node Development
471 @unnumberedsec Development
472
473 @divClass{heading-center}
474 @ifclear web_version
475   @heading Development for LilyPond @version
476 @end ifclear
477 @ifset web_version
478   @heading Development for LilyPond @versionDevel
479 @end ifset
480
481
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}.}
488
489 @divEnd
490
491 @divClass{column-center-top}
492 @subheading Release numbers
493
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).
499
500 @divEnd
501
502
503 @divClass{column-left-top}
504 @subheading Download
505
506 Instructions for git and compiling are in the Contributor's Guide.
507
508 @quotation
509 @uref{http://git.sv.gnu.org/gitweb/?p=lilypond.git, lilypond git repository}
510 @end quotation
511
512 Documentation writers and testers will generally want to download
513 the latest binary:
514
515 @quotation
516
517 @downloadDevelLinuxNormal
518
519 @downloadDevelLinuxBig
520
521 @downloadDevelLinuxPPC
522
523 @downloadDevelFreeBSDNormal
524
525 @downloadDevelFreeBSDBig
526
527 @downloadDevelDarwinNormal
528
529 @downloadDevelDarwinPPC
530
531 @downloadDevelWindows
532
533 @downloadDevelSource
534
535 @end quotation
536
537 @divEnd
538
539
540 @divClass{column-right-top}
541 @subheading Contributor's Guide
542
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.
546
547 @docLinksBare{Contributor's Guide, contributor,
548   @rcontribnamed{Top,Contributor's Guide},
549   @manualDevelContributorSplit,
550   @manualDevelContributorBig, 500 kB,
551   @manualDevelContributorPdf, 2.8 MB}
552
553 @divEnd
554
555
556 @divClass{column-center-top}
557 @subheading Regression tests
558
559 @divClass{keep-bullets}
560
561 @ifclear web_version
562
563 @itemize
564 @item
565 @uref{../../input/regression/collated-files.html, Regression tests}:
566 This release's regtests.
567 (@uref{../../input/regression/collated-files.pdf, pdf version})
568
569 @item
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})
573
574 @item
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})
578
579 @item
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})
583 @end itemize
584
585 @end ifclear
586
587 @ifset web_version
588 @subsubheading Development version
589
590 @itemize
591 @item @regtestDevel (@regtestDevelPdf{})
592
593 @item @regtestDevelXml (@regtestDevelXmlPdf{})
594
595 @item @regtestDevelAbc (@regtestDevelAbcPdf{})
596
597 @item @regtestDevelLilypondBook (@regtestDevelLilypondBookPdf{})
598 @end itemize
599
600 @subsubheading Stable version
601
602 @itemize
603 @item @regtestStable (@regtestStablePdf{})
604
605 @item @regtestStableXml (@regtestStableXmlPdf{})
606
607 @item @regtestStableAbc (@regtestStableAbcPdf{})
608
609 @item @regtestStableLilypondBook (@regtestStableLilypondBookPdf{})
610 @end itemize
611 @end ifset
612
613
614 @subsubheading All versions
615
616 @itemize
617 @item @uref{http://lilypond.org/test, Comparisons between regression tests}
618
619 @item @uref{http://lilypond.org/download/binaries/test-output/,
620 Archive of all regression tests}
621
622 @end itemize
623
624 @divEnd
625 @divEnd
626
627
628
629 @divClass{column-center-bottom}
630 @subheading Manuals
631
632 @ifclear web_version
633 @warning{These manuals are for LilyPond @version{}; the latest
634 manuals can be found at @url{http://lilypond.org}}
635 @end ifclear
636
637 @divClass{normal-table}
638 @multitable @columnfractions .3 .3 .3
639 @headitem Introduction
640 @item
641 @docLinkSplit{Learning,learning,@manualDevelLearningSplit}
642 @tab
643 @docLinkBig{Learning,learning,@manualDevelLearningBig}
644 @tab
645 @docLinkPdf{Learning,learning,@manualDevelLearningPdf}
646
647 @item
648 @docLinkSplit{Glossary,music-glossary,@manualDevelGlossarySplit}
649 @tab
650 @docLinkBig{Glossary,music-glossary,@manualDevelGlossaryBig}
651 @tab
652 @docLinkPdf{Glossary,music-glossary,@manualDevelGlossaryPdf}
653
654 @item
655 @docLinkSplit{Essay,essay,@manualDevelEssaySplit}
656 @tab
657 @docLinkBig{Essay,essay,@manualDevelEssayBig}
658 @tab
659 @docLinkPdf{Essay,essay,@manualDevelEssayPdf}
660
661 @headitem Regular
662
663 @item
664 @docLinkSplit{Notation,notation,@manualDevelNotationSplit}
665 @tab
666 @docLinkBig{Notation,notation,@manualDevelNotationBig}
667 @tab
668 @docLinkPdf{Notation,notation,@manualDevelNotationPdf}
669
670 @item
671 @docLinkSplit{Usage,usage,@manualDevelUsageSplit}
672 @tab
673 @docLinkBig{Usage,usage,@manualDevelUsageBig}
674 @tab
675 @docLinkPdf{Usage,usage,@manualDevelUsagePdf}
676
677 @item
678 @docLinkSplit{Snippets,snippets,@manualDevelSnippetsSplit}
679 @tab
680 @docLinkBig{Snippets,snippets,@manualDevelSnippetsBig}
681 @tab
682 @docLinkPdf{Snippets,snippets,@manualDevelSnippetsPdf}
683
684 @headitem Infrequent
685
686 @item
687 @docLinkSplit{Web,web,@manualDevelWebSplit}
688 @tab
689 @docLinkBig{Web,web,@manualDevelWebBig}
690 @tab
691 @docLinkPdf{Web,web,@manualDevelWebPdf}
692
693 @item
694 @docLinkSplit{Changes,changes,@manualDevelChangesSplit}
695 @tab
696 @docLinkBig{Changes,changes,@manualDevelChangesBig}
697 @tab
698 @docLinkPdf{Changes,changes,@manualDevelChangesPdf}
699
700 @item
701 @docLinkSplit{Extending,extending,@manualDevelExtendingSplit}
702 @tab
703 @docLinkBig{Extending,extending,@manualDevelExtendingBig}
704 @tab
705 @docLinkPdf{Extending,extending,@manualDevelExtendingPdf}
706
707 @item
708 @docLinkSplit{Internals,internals,@manualDevelInternalsSplit}
709 @tab
710 @docLinkBig{Internals,internals,@manualDevelInternalsBig}
711 @tab
712 @docLinkPdf{Internals,internals,@manualDevelInternalsPdf}
713
714 @ifset web_version
715 @headitem Downloadable
716
717 @item
718 @doctarballDevel
719 @end ifset
720
721 @end multitable
722
723 @divEnd
724 @divEnd
725
726
727
728
729 @node Authors
730 @unnumberedsec Authors
731
732 @divClass{column-left-top}
733 @subheading Current Development Team
734
735 @divClass{keep-bullets}
736 @developersCurrent
737 @divEnd
738 @divEnd
739
740 @divClass{column-right-top}
741 @subheading Previous Development Team
742
743 @divClass{keep-bullets}
744 @developersPrevious
745 @divEnd
746 @divEnd
747
748
749 @divClass{column-center-top}
750 @subheading Current Contributors
751
752 @divClass{keep-bullets}
753 @subsubheading Programming
754
755 @coreCurrent
756
757 @subsubheading Font
758
759 @fontCurrent
760
761 @subsubheading Documentation
762
763 @docCurrent
764
765 @subsubheading Bug squad
766
767 @bugsquadCurrent
768
769 @subsubheading Support
770
771 @supportCurrent
772
773 @subsubheading Translation
774
775 @translationsCurrent
776
777 @divEnd
778 @divEnd
779
780
781 @divClass{column-center-bottom}
782 @subheading Previous Contributors
783
784 @divClass{keep-bullets}
785 @subsubheading Programming
786
787 @corePrevious
788
789 @subsubheading Font
790
791 @fontPrevious
792
793 @subsubheading Documentation
794
795 @docPrevious
796
797 @c    uncomment when we have any previous members -gp
798 @c @subsubheading Bug squad
799
800 @c @bugsquadCurrent
801
802 @subsubheading Support
803
804 @supportPrevious
805
806 @subsubheading Translation
807
808 @translationsPrevious
809
810 @divEnd
811 @divEnd
812
813
814
815 @node Publications
816 @unnumberedsec Publications
817
818 @divClass{column-center-top}
819 @subheading What we wrote about LilyPond
820
821 @divClass{keep-bullets}
822
823 @include we-wrote.itexi
824
825 @divEnd
826 @divEnd
827
828 @divClass{column-center-bottom}
829
830 @subheading What people did with LilyPond
831
832
833 @divClass{keep-bullets}
834
835 @include others-did.itexi
836
837 @divEnd
838 @divEnd
839
840 @contactUsAbout{academic papers}
841
842
843 @node Old news
844 @unnumberedsec Old news
845
846 @include web/news-front.itexi
847
848 @include web/news.itexi