]> git.donarmstrong.com Git - lilypond.git/blob - Documentation/web/community.itexi
Doc-de: fixing linkage
[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 @strong{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 tiny 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 if we help them or not.
290
291 @item
292 Creating a tiny example helps 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 to create them?
306
307 @divClass{keep-bullets}
308 @itemize
309
310 @item
311 Include the @code{\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 less than 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
321 can comment something while still demonstrating the main idea,
322 then 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 specific commands.
331
332 @item
333 Optionally, attach an image showing the desired graphical output.
334
335 @end itemize
336 @divEnd
337
338 @divEnd
339
340 @divClass{column-center-bottom}
341 @subheading How tiny should they be?
342
343 Is the code below a minimal example?
344
345 @example
346 \version "2.14.1"
347 \include "english.ly"
348
349 \score @{
350   \new Staff @{
351     \key d \major
352     \numericTimeSignature
353     \time 2/4
354     <cs' d'' b''>16 <cs' d'' b''>8.
355     %% Here: the tie on the D's looks funny
356     %% Too tall? Left-hand endpoint is not aligned with the B tie?
357     ~
358     <cs' d'' b''>8 [ <b d'' a''> ]
359   @}
360 @}
361 @end example
362
363 Well, it is not very big, but a truly minimal example is here:
364
365 @example
366 \version "2.14.1"
367 @{
368   % middle tie looks funny here:
369   <c' d'' b''>8. ~ <c' d'' b''>8
370 @}
371 @end example
372
373 Very few tiny examples exceed 10 lines of code -
374 quite often 4 lines are enough to demonstrate the problem!
375
376 @divEnd
377
378
379 @node Bug reports
380 @unnumberedsec Bug reports
381
382 @divClass{column-center-top}
383 @subheading Step 1: Known bugs
384
385 If you have input that results in a crash or an erroneous output,
386 then that is a bug.  There is a list of current bugs on our google
387 bug tracker,
388
389 @example
390 @uref{http://code.google.com/p/lilypond/issues/list}
391 @end example
392
393 @warning{Please @strong{DO NOT} add bug reports directly to the
394 bug tracker.  Once an issue has been added to the tracker, feel
395 free to add more information to that report.}
396
397 @divEnd
398
399
400 @divClass{column-left-bottom}
401 @subheading Step 2: Creating a bug report
402
403 If you have discovered a bug which is not listed, please help us
404 by creating a bug report.
405
406 @warning{We only accept bug reports in the form of
407 @ref{Tiny examples}.  We have very limited resources to deal with
408 bug reports, so any non-minimal example will be rejected.  Almost
409 every bug can be demonstrated in four notes or less!}
410
411 Here is an example of a good bug report:
412
413 @example
414 % Accidentals should be printed for only
415 % the first note in a tie, but this version
416 % prints flats on both notes.
417 \version "2.10.1"
418
419 \relative c'' @{
420  bes1 ~
421  bes1
422 @}
423 @end example
424
425 @divEnd
426
427 @divClass{column-right-bottom}
428 @subheading Step 3: Sending a bug report
429
430 Once you have verified that the issue is not already known and
431 created a bug report, please send it to us!
432
433 @divClass{keep-bullets}
434 @itemize
435
436 @item
437 If you are subscribed to the @uref{mailto:bug-lilypond@@gnu.org,
438 bug-lilypond@@gnu.org} mailing list, send an email like normal.
439
440 @item
441 If you are not subscribed, you can still post a bug report with
442 the
443 @uref{http://post.gmane.org/post.php?group=gmane.comp.gnu.lilypond.bugs,
444 gmane lilypond.bugs web interface}.
445
446 However, there is a strict @qq{no top-posting} check on the gmane
447 interface, which is often incorrectly triggered by lilypond files.
448 To avoid this, please add:
449
450 @example
451 > I'm not top posting.
452 @end example
453
454 @noindent
455 (you @emph{must} include the @code{>} ) to the top of your bug
456 report.
457
458 @end itemize
459 @divEnd
460 @divEnd
461
462 @divClass{column-center-bottom}
463 @subheading Step 4: Wait for a response
464
465 Once your bug has been sent to the list, our Bug Squad will
466 examine the report.  Please allow up to 24 hours, as we have a
467 limited number of volunteers for this task.  They may ask you for
468 more information, or may add the report to the tracker and let you
469 know what the issue number is.
470
471 You may mark the bug so that you automatically receive emails when
472 any activity on the bug occurs.  This requires you have a google
473 account.
474 @divEnd
475
476 @divClass{column-center-bottom}
477 @subheading Optional help: show the desired behavior
478
479 Once an issue has been added to the tracker, it can be very
480 helpful if we can see the desired output.  Feel free to add input
481 code and/or images (possibly created with other tools) which
482 demonstrate what you think it should look like!
483
484 @divEnd
485
486
487
488 @node Help us
489 @unnumberedsec Help us
490
491 @divClass{column-center-top}
492 @helpusNeed
493
494 @divEnd
495
496 @divClass{column-left-top}
497 @divClass{keep-bullets}
498 @helpusTasks
499
500 @divEnd
501 @divEnd
502
503 @divClass{column-right-top}
504 @helpusProjects
505
506 @divEnd
507
508
509 @node Development
510 @unnumberedsec Development
511
512 @divClass{heading-center}
513 @ifclear web_version
514   @heading Development for LilyPond @version
515 @end ifclear
516 @ifset web_version
517   @heading Development for LilyPond @versionDevel
518 @end ifset
519
520
521 @c we normally don't allow named references, but in this case
522 @c it's good to emphasize the "stable" part.  -gp
523 @warning{These are @emph{unstable development} versions.  If you
524 have the slightest doubt about how to use or install LilyPond, we
525 urge you to use the @ref{Download, stable Download}, and read the
526 @ref{Manuals, stable Manuals}.}
527
528 @divEnd
529
530 @divClass{column-center-top}
531 @subheading Release numbers
532
533 There are two sets of releases for LilyPond: stable releases, and
534 unstable development releases.  Stable versions have an
535 even-numbered @q{minor} version number (e.g., 2.8, 2.10, 2.12).
536 Development versions have an odd-numbered @q{minor} version number
537 (e.g., 2.7, 2.9, 2.11).
538
539 @divEnd
540
541
542 @divClass{column-left-top}
543 @subheading Download
544
545 Instructions for git and compiling are in the Contributor's Guide.
546
547 @quotation
548 @uref{http://git.sv.gnu.org/gitweb/?p=lilypond.git, lilypond git repository}
549 @end quotation
550
551 Documentation writers and testers will generally want to download
552 the latest binary:
553
554 @quotation
555
556 @downloadDevelLinuxNormal
557
558 @downloadDevelLinuxBig
559
560 @downloadDevelLinuxPPC
561
562 @downloadDevelFreeBSDNormal
563
564 @downloadDevelFreeBSDBig
565
566 @downloadDevelDarwinNormal
567
568 @downloadDevelDarwinPPC
569
570 @downloadDevelWindows
571
572 @downloadDevelSource
573
574 @end quotation
575
576 @divEnd
577
578
579 @divClass{column-right-top}
580 @subheading Contributor's Guide
581
582 LilyPond development is a fairly complicated matter.  In order to
583 help new contributors, and to keep the whole system (mostly)
584 stable, we have written a manual for development tasks.
585
586 @docLinksBare{Contributor's Guide, contributor,
587   @rcontribnamed{Top,Contributor's Guide},
588   @manualDevelContributorSplit,
589   @manualDevelContributorBig, 500 kB,
590   @manualDevelContributorPdf, 2.8 MB}
591
592 @divEnd
593
594
595 @divClass{column-center-top}
596 @subheading Regression tests
597
598 @divClass{keep-bullets}
599
600 @ifclear web_version
601
602 @itemize
603 @item
604 @uref{../../input/regression/collated-files.html, Regression tests}:
605 This release's regtests.
606 (@uref{../../input/regression/collated-files.pdf, pdf version})
607
608 @item
609 @uref{../../input/regression/musicxml/collated-files.html, MusicXML tests}:
610 This release's musicXML tests.
611 (@uref{../../input/regression/musicxml/collated-files.pdf, pdf version})
612
613 @item
614 @uref{../../input/regression/abc2ly/collated-files.html, abc2ly tests}:
615 This release's abc2ly tests.
616 (@uref{../../input/regression/abc2ly/collated-files.pdf, pdf version})
617
618 @item
619 @uref{../../input/regression/lilypond-book/collated-files.html, lilypond-book tests}:
620 This release's lilypond-book tests.
621 (@uref{../../input/regression/lilypond-book/collated-files.pdf, pdf version})
622 @end itemize
623
624 @end ifclear
625
626 @ifset web_version
627 @subsubheading Development version
628
629 @itemize
630 @item @regtestDevel (@regtestDevelPdf{})
631
632 @item @regtestDevelXml (@regtestDevelXmlPdf{})
633
634 @item @regtestDevelAbc (@regtestDevelAbcPdf{})
635
636 @item @regtestDevelLilypondBook (@regtestDevelLilypondBookPdf{})
637 @end itemize
638
639 @subsubheading Stable version
640
641 @itemize
642 @item @regtestStable (@regtestStablePdf{})
643
644 @item @regtestStableXml (@regtestStableXmlPdf{})
645
646 @item @regtestStableAbc (@regtestStableAbcPdf{})
647
648 @item @regtestStableLilypondBook (@regtestStableLilypondBookPdf{})
649 @end itemize
650 @end ifset
651
652
653 @subsubheading All versions
654
655 @itemize
656 @item @uref{http://lilypond.org/test, Comparisons between regression tests}
657
658 @item @uref{http://lilypond.org/download/binaries/test-output/,
659 Archive of all regression tests}
660
661 @end itemize
662
663 @divEnd
664 @divEnd
665
666
667
668 @divClass{column-center-bottom}
669 @subheading Manuals
670
671 @ifclear web_version
672 @warning{These manuals are for LilyPond @version{}; the latest
673 manuals can be found at @url{http://lilypond.org}}
674 @end ifclear
675
676 @divClass{normal-table}
677 @multitable @columnfractions .3 .3 .3
678 @headitem Introduction
679 @item
680 @docLinkSplit{Learning,learning,@manualDevelLearningSplit}
681 @tab
682 @docLinkBig{Learning,learning,@manualDevelLearningBig}
683 @tab
684 @docLinkPdf{Learning,learning,@manualDevelLearningPdf}
685
686 @item
687 @docLinkSplit{Glossary,music-glossary,@manualDevelGlossarySplit}
688 @tab
689 @docLinkBig{Glossary,music-glossary,@manualDevelGlossaryBig}
690 @tab
691 @docLinkPdf{Glossary,music-glossary,@manualDevelGlossaryPdf}
692
693 @item
694 @docLinkSplit{Essay,essay,@manualDevelEssaySplit}
695 @tab
696 @docLinkBig{Essay,essay,@manualDevelEssayBig}
697 @tab
698 @docLinkPdf{Essay,essay,@manualDevelEssayPdf}
699
700 @headitem Regular
701
702 @item
703 @docLinkSplit{Notation,notation,@manualDevelNotationSplit}
704 @tab
705 @docLinkBig{Notation,notation,@manualDevelNotationBig}
706 @tab
707 @docLinkPdf{Notation,notation,@manualDevelNotationPdf}
708
709 @item
710 @docLinkSplit{Usage,usage,@manualDevelUsageSplit}
711 @tab
712 @docLinkBig{Usage,usage,@manualDevelUsageBig}
713 @tab
714 @docLinkPdf{Usage,usage,@manualDevelUsagePdf}
715
716 @item
717 @docLinkSplit{Snippets,snippets,@manualDevelSnippetsSplit}
718 @tab
719 @docLinkBig{Snippets,snippets,@manualDevelSnippetsBig}
720 @tab
721 @docLinkPdf{Snippets,snippets,@manualDevelSnippetsPdf}
722
723 @headitem Infrequent
724
725 @item
726 @docLinkSplit{Web,web,@manualDevelWebSplit}
727 @tab
728 @docLinkBig{Web,web,@manualDevelWebBig}
729 @tab
730 @docLinkPdf{Web,web,@manualDevelWebPdf}
731
732 @item
733 @docLinkSplit{Changes,changes,@manualDevelChangesSplit}
734 @tab
735 @docLinkBig{Changes,changes,@manualDevelChangesBig}
736 @tab
737 @docLinkPdf{Changes,changes,@manualDevelChangesPdf}
738
739 @item
740 @docLinkSplit{Extending,extending,@manualDevelExtendingSplit}
741 @tab
742 @docLinkBig{Extending,extending,@manualDevelExtendingBig}
743 @tab
744 @docLinkPdf{Extending,extending,@manualDevelExtendingPdf}
745
746 @item
747 @docLinkSplit{Internals,internals,@manualDevelInternalsSplit}
748 @tab
749 @docLinkBig{Internals,internals,@manualDevelInternalsBig}
750 @tab
751 @docLinkPdf{Internals,internals,@manualDevelInternalsPdf}
752
753 @ifset web_version
754 @headitem Downloadable
755
756 @item
757 @doctarballDevel
758 @end ifset
759
760 @end multitable
761
762 @divEnd
763 @divEnd
764
765
766
767
768 @node Authors
769 @unnumberedsec Authors
770
771 @divClass{column-left-top}
772 @subheading Current Development Team
773
774 @divClass{keep-bullets}
775 @developersCurrent
776 @divEnd
777 @divEnd
778
779 @divClass{column-right-top}
780 @subheading Previous Development Team
781
782 @divClass{keep-bullets}
783 @developersPrevious
784 @divEnd
785 @divEnd
786
787
788 @divClass{column-center-top}
789 @subheading Current Contributors
790
791 @divClass{keep-bullets}
792 @subsubheading Programming
793
794 @coreCurrent
795
796 @subsubheading Font
797
798 @fontCurrent
799
800 @subsubheading Documentation
801
802 @docCurrent
803
804 @subsubheading Bug squad
805
806 @bugsquadCurrent
807
808 @subsubheading Support
809
810 @supportCurrent
811
812 @subsubheading Translation
813
814 @translationsCurrent
815
816 @divEnd
817 @divEnd
818
819
820 @divClass{column-center-bottom}
821 @subheading Previous Contributors
822
823 @divClass{keep-bullets}
824 @subsubheading Programming
825
826 @corePrevious
827
828 @subsubheading Font
829
830 @fontPrevious
831
832 @subsubheading Documentation
833
834 @docPrevious
835
836 @c    uncomment when we have any previous members -gp
837 @c @subsubheading Bug squad
838
839 @c @bugsquadCurrent
840
841 @subsubheading Support
842
843 @supportPrevious
844
845 @subsubheading Translation
846
847 @translationsPrevious
848
849 @divEnd
850 @divEnd
851
852
853
854 @node Publications
855 @unnumberedsec Publications
856
857 @divClass{column-center-top}
858 @subheading What we wrote about LilyPond
859
860 @divClass{keep-bullets}
861
862 @include we-wrote.itexi
863
864 @divEnd
865 @divEnd
866
867 @divClass{column-center-bottom}
868
869 @subheading What people did with LilyPond
870
871
872 @divClass{keep-bullets}
873
874 @include others-did.itexi
875
876 @divEnd
877 @divEnd
878
879 @contactUsAbout{academic papers}
880
881
882 @node Old news
883 @unnumberedsec Old news
884
885 @include web/news-front.itexi
886
887 @include web/news.itexi