]> git.donarmstrong.com Git - lilypond.git/blob - Documentation/web/community.itexi
Merge branch 'master' into lilypond/translation
[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 @divClass{column-right-bottom}
266 @subheading Sensitive emails
267
268 Private matters should be sent to Graham Percival (project
269 manager), who will discuss it with those concerned.
270
271 @divEnd
272
273
274 @node Tiny examples
275 @unnumberedsec Tiny examples
276
277 @divClass{column-center-top}
278 @subheading What are @qq{Tiny examples}?
279
280 A tiny example is an example from which @strong{nothing} can be removed.
281 @divEnd
282
283 @divClass{column-left-bottom}
284 @subheading Why create them?
285
286 @divClass{keep-bullets}
287 @itemize
288
289 @item
290 The simpler the example is, the quicker potential helpers can
291 understand it and help you.
292
293 @item
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.
297
298 @item
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!
304
305 @end itemize
306 @divEnd
307
308 @divEnd
309
310
311 @divClass{column-right-bottom}
312 @subheading How to create them?
313
314 @divClass{keep-bullets}
315 @itemize
316
317 @item
318 Include the @code{\version} number.
319
320 @item
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.
324
325 @item
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.
330
331 @item
332 Avoid using complicated notes, keys or time signatures, unless
333 the bug is about the behavior of those items.
334
335 @item
336 Do not use @code{\override} or @code{\set} commands unless the bug
337 is about those specific commands.
338
339 @item
340 Optionally, attach an image showing the desired graphical output.
341
342 @end itemize
343 @divEnd
344
345 @divEnd
346
347 @divClass{column-center-bottom}
348 @subheading How tiny should they be?
349
350 Is the code below a minimal example?
351
352 @example
353 \version "2.14.1"
354 \include "english.ly"
355
356 \score @{
357   \new Staff @{
358     \key d \major
359     \numericTimeSignature
360     \time 2/4
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?
364     ~
365     <cs' d'' b''>8 [ <b d'' a''> ]
366   @}
367 @}
368 @end example
369
370 Well, it is not very big, but a truly minimal example is here:
371
372 @example
373 \version "2.14.1"
374 @{
375   % middle tie looks funny here:
376   <c' d'' b''>8. ~ <c' d'' b''>8
377 @}
378 @end example
379
380 Very few tiny examples exceed 10 lines of code -
381 quite often 4 lines are enough to demonstrate the problem!
382
383 @divEnd
384
385
386 @node Bug reports
387 @unnumberedsec Bug reports
388
389 @divClass{column-center-top}
390 @subheading Step 1: Known bugs
391
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
394 bug tracker,
395
396 @example
397 @uref{http://code.google.com/p/lilypond/issues/list}
398 @end example
399
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.}
403
404 @divEnd
405
406
407 @divClass{column-left-bottom}
408 @subheading Step 2: Creating a bug report
409
410 If you have discovered a bug which is not listed, please help us
411 by creating a bug report.
412
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!}
417
418 Here is an example of a good bug report:
419
420 @example
421 % Accidentals should be printed for only
422 % the first note in a tie, but this version
423 % prints flats on both notes.
424 \version "2.10.1"
425
426 \relative c'' @{
427  bes1 ~
428  bes1
429 @}
430 @end example
431
432 @divEnd
433
434 @divClass{column-right-bottom}
435 @subheading Step 3: Sending a bug report
436
437 Once you have verified that the issue is not already known and
438 created a bug report, please send it to us!
439
440 @divClass{keep-bullets}
441 @itemize
442
443 @item
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.
446
447 @item
448 If you are not subscribed, you can still post a bug report with
449 the
450 @uref{http://post.gmane.org/post.php?group=gmane.comp.gnu.lilypond.bugs,
451 gmane lilypond.bugs web interface}.
452
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:
456
457 @example
458 > I'm not top posting.
459 @end example
460
461 @noindent
462 (you @emph{must} include the @code{>} ) to the top of your bug
463 report.
464
465 @end itemize
466 @divEnd
467 @divEnd
468
469 @divClass{column-center-bottom}
470 @subheading Step 4: Wait for a response
471
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.
477
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
480 account.
481 @divEnd
482
483 @divClass{column-center-bottom}
484 @subheading Optional help: show the desired behavior
485
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!
490
491 @divEnd
492
493
494
495 @node Help us
496 @unnumberedsec Help us
497
498 @divClass{column-center-top}
499 @helpusNeed
500
501 @divEnd
502
503 @divClass{column-left-top}
504 @divClass{keep-bullets}
505 @helpusTasks
506
507 @divEnd
508 @divEnd
509
510 @divClass{column-right-top}
511 @helpusProjects
512
513 @divEnd
514
515
516 @node Development
517 @unnumberedsec Development
518
519 @divClass{heading-center}
520 @ifclear web_version
521   @heading Development for LilyPond @version
522 @end ifclear
523 @ifset web_version
524   @heading Development for LilyPond @versionDevel
525 @end ifset
526
527
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}.}
534
535 @divEnd
536
537 @divClass{column-center-top}
538 @subheading Release numbers
539
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).
545
546 @divEnd
547
548
549 @divClass{column-left-top}
550 @subheading Download
551
552 Instructions for git and compiling are in the Contributor's Guide.
553
554 @quotation
555 @uref{http://git.sv.gnu.org/gitweb/?p=lilypond.git, lilypond git repository}
556 @end quotation
557
558 Documentation writers and testers will generally want to download
559 the latest binary:
560
561 @quotation
562
563 @downloadDevelLinuxNormal
564
565 @downloadDevelLinuxBig
566
567 @downloadDevelLinuxPPC
568
569 @downloadDevelFreeBSDNormal
570
571 @downloadDevelFreeBSDBig
572
573 @downloadDevelDarwinNormal
574
575 @downloadDevelDarwinPPC
576
577 @downloadDevelWindows
578
579 @downloadDevelSource
580
581 @end quotation
582
583 @divEnd
584
585
586 @divClass{column-right-top}
587 @subheading Contributor's Guide
588
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.
592
593 @docLinksBare{Contributor's Guide, contributor,
594   @rcontribnamed{Top,Contributor's Guide},
595   @manualDevelContributorSplit,
596   @manualDevelContributorBig, 500 kB,
597   @manualDevelContributorPdf, 2.8 MB}
598
599 @divEnd
600
601
602 @divClass{column-center-top}
603 @subheading Regression tests
604
605 @divClass{keep-bullets}
606
607 @ifclear web_version
608
609 @itemize
610 @item
611 @uref{../../input/regression/collated-files.html, Regression tests}:
612 This release's regtests.
613 (@uref{../../input/regression/collated-files.pdf, pdf version})
614
615 @item
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})
619
620 @item
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})
624
625 @item
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})
629 @end itemize
630
631 @end ifclear
632
633 @ifset web_version
634 @subsubheading Development version
635
636 @itemize
637 @item @regtestDevel (@regtestDevelPdf{})
638
639 @item @regtestDevelXml (@regtestDevelXmlPdf{})
640
641 @item @regtestDevelAbc (@regtestDevelAbcPdf{})
642
643 @item @regtestDevelLilypondBook (@regtestDevelLilypondBookPdf{})
644 @end itemize
645
646 @subsubheading Stable version
647
648 @itemize
649 @item @regtestStable (@regtestStablePdf{})
650
651 @item @regtestStableXml (@regtestStableXmlPdf{})
652
653 @item @regtestStableAbc (@regtestStableAbcPdf{})
654
655 @item @regtestStableLilypondBook (@regtestStableLilypondBookPdf{})
656 @end itemize
657 @end ifset
658
659
660 @subsubheading All versions
661
662 @itemize
663 @item @uref{http://lilypond.org/test, Comparisons between regression tests}
664
665 @item @uref{http://lilypond.org/download/binaries/test-output/,
666 Archive of all regression tests}
667
668 @end itemize
669
670 @divEnd
671 @divEnd
672
673
674
675 @divClass{column-center-bottom}
676 @subheading Manuals
677
678 @ifclear web_version
679 @warning{These manuals are for LilyPond @version{}; the latest
680 manuals can be found at @url{http://lilypond.org}}
681 @end ifclear
682
683 @divClass{normal-table}
684 @multitable @columnfractions .3 .3 .3
685 @headitem Introduction
686 @item
687 @docLinkSplit{Learning,learning,@manualDevelLearningSplit}
688 @tab
689 @docLinkBig{Learning,learning,@manualDevelLearningBig}
690 @tab
691 @docLinkPdf{Learning,learning,@manualDevelLearningPdf}
692
693 @item
694 @docLinkSplit{Glossary,music-glossary,@manualDevelGlossarySplit}
695 @tab
696 @docLinkBig{Glossary,music-glossary,@manualDevelGlossaryBig}
697 @tab
698 @docLinkPdf{Glossary,music-glossary,@manualDevelGlossaryPdf}
699
700 @item
701 @docLinkSplit{Essay,essay,@manualDevelEssaySplit}
702 @tab
703 @docLinkBig{Essay,essay,@manualDevelEssayBig}
704 @tab
705 @docLinkPdf{Essay,essay,@manualDevelEssayPdf}
706
707 @headitem Regular
708
709 @item
710 @docLinkSplit{Notation,notation,@manualDevelNotationSplit}
711 @tab
712 @docLinkBig{Notation,notation,@manualDevelNotationBig}
713 @tab
714 @docLinkPdf{Notation,notation,@manualDevelNotationPdf}
715
716 @item
717 @docLinkSplit{Usage,usage,@manualDevelUsageSplit}
718 @tab
719 @docLinkBig{Usage,usage,@manualDevelUsageBig}
720 @tab
721 @docLinkPdf{Usage,usage,@manualDevelUsagePdf}
722
723 @item
724 @docLinkSplit{Snippets,snippets,@manualDevelSnippetsSplit}
725 @tab
726 @docLinkBig{Snippets,snippets,@manualDevelSnippetsBig}
727 @tab
728 @docLinkPdf{Snippets,snippets,@manualDevelSnippetsPdf}
729
730 @headitem Infrequent
731
732 @item
733 @docLinkSplit{Web,web,@manualDevelWebSplit}
734 @tab
735 @docLinkBig{Web,web,@manualDevelWebBig}
736 @tab
737 @docLinkPdf{Web,web,@manualDevelWebPdf}
738
739 @item
740 @docLinkSplit{Changes,changes,@manualDevelChangesSplit}
741 @tab
742 @docLinkBig{Changes,changes,@manualDevelChangesBig}
743 @tab
744 @docLinkPdf{Changes,changes,@manualDevelChangesPdf}
745
746 @item
747 @docLinkSplit{Extending,extending,@manualDevelExtendingSplit}
748 @tab
749 @docLinkBig{Extending,extending,@manualDevelExtendingBig}
750 @tab
751 @docLinkPdf{Extending,extending,@manualDevelExtendingPdf}
752
753 @item
754 @docLinkSplit{Internals,internals,@manualDevelInternalsSplit}
755 @tab
756 @docLinkBig{Internals,internals,@manualDevelInternalsBig}
757 @tab
758 @docLinkPdf{Internals,internals,@manualDevelInternalsPdf}
759
760 @ifset web_version
761 @headitem Downloadable
762
763 @item
764 @doctarballDevel
765 @end ifset
766
767 @end multitable
768
769 @divEnd
770 @divEnd
771
772
773
774
775 @node Authors
776 @unnumberedsec Authors
777
778 @divClass{column-left-top}
779 @subheading Current Development Team
780
781 @divClass{keep-bullets}
782 @developersCurrent
783 @divEnd
784 @divEnd
785
786 @divClass{column-right-top}
787 @subheading Previous Development Team
788
789 @divClass{keep-bullets}
790 @developersPrevious
791 @divEnd
792 @divEnd
793
794
795 @divClass{column-center-top}
796 @subheading Current Contributors
797
798 @divClass{keep-bullets}
799 @subsubheading Programming
800
801 @coreCurrent
802
803 @subsubheading Font
804
805 @fontCurrent
806
807 @subsubheading Documentation
808
809 @docCurrent
810
811 @subsubheading Bug squad
812
813 @bugsquadCurrent
814
815 @subsubheading Support
816
817 @supportCurrent
818
819 @subsubheading Translation
820
821 @translationsCurrent
822
823 @divEnd
824 @divEnd
825
826
827 @divClass{column-center-bottom}
828 @subheading Previous Contributors
829
830 @divClass{keep-bullets}
831 @subsubheading Programming
832
833 @corePrevious
834
835 @subsubheading Font
836
837 @fontPrevious
838
839 @subsubheading Documentation
840
841 @docPrevious
842
843 @c    uncomment when we have any previous members -gp
844 @c @subsubheading Bug squad
845
846 @c @bugsquadCurrent
847
848 @subsubheading Support
849
850 @supportPrevious
851
852 @subsubheading Translation
853
854 @translationsPrevious
855
856 @divEnd
857 @divEnd
858
859
860
861 @node Publications
862 @unnumberedsec Publications
863
864 @divClass{column-center-top}
865 @subheading What we wrote about LilyPond
866
867 @divClass{keep-bullets}
868
869 @include we-wrote.itexi
870
871 @divEnd
872 @divEnd
873
874 @divClass{column-center-bottom}
875
876 @subheading What people did with LilyPond
877
878
879 @divClass{keep-bullets}
880
881 @include others-did.itexi
882
883 @divEnd
884 @divEnd
885
886 @contactUsAbout{academic papers}
887
888
889 @node Old news
890 @unnumberedsec Old news
891
892 @include web/news-front.itexi
893
894 @include web/news.itexi