]> git.donarmstrong.com Git - lilypond.git/blob - Documentation/web/community.itexi
Website: added Academia items
[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
17 @divClass{column-center-top}
18 @subheading Interacting with the community
19
20 @itemize
21
22 @item
23 @ref{Contact}: get help, discuss, and keep in touch!
24
25 @item
26 @ref{Tiny examples}: these are @emph{highly} recommended when
27 discussing LilyPond.
28
29 @item
30 @ref{Bug reports}: something went wrong.
31
32 @end itemize
33 @divEnd
34
35 @divClass{column-left-bottom}
36 @subheading Making LilyPond better
37
38 @itemize
39
40 @item
41 @ref{Help us}: your assistance is requested.
42
43 @item
44 @ref{Development}: for contributors and testers.
45
46 @item
47 @ref{Authors}: the people who made LilyPond what it is today.
48
49 @end itemize
50 @divEnd
51
52 @divClass{column-right-bottom}
53 @subheading Miscellaneous
54
55 @itemize
56
57 @item
58 @ref{Publications}: what we wrote, and have had written about us.
59
60 @item
61 @ref{Old news}: an archive.
62
63 @end itemize
64 @divEnd
65
66
67 @divClass{hide}
68 @menu
69 * Contact::
70 * Tiny examples::
71 * Bug reports::
72 * Help us::
73 * Development::
74 * Authors::
75 * Publications::
76 * Old news::
77 @end menu
78 @divEnd
79
80
81 @node Contact
82 @unnumberedsec Contact
83
84
85 @divClass{column-left-bottom}
86 @subheading User Discussions and Help
87
88 @subsubheading User mailing list: @code{lilypond-user@@gnu.org}
89
90 This mailing list is the main place for users to discuss and help
91 each other.
92
93 @quotation
94 @uref{http://lists.gnu.org/mailman/listinfo/lilypond-user,
95 lilypond-user subscribe and info}
96
97 @uref{http://lists.gnu.org/archive/html/lilypond-user/,
98 user archive1}
99 @uref{http://www.mail-archive.com/lilypond-user@@gnu.org/,
100 archive2}
101 @uref{http://dir.gmane.org/gmane.comp.gnu.lilypond.general,
102 archive3}
103
104 @uref{http://post.gmane.org/post.php?group=gmane.comp.gnu.lilypond.general,
105 send to lilypond-user with gmane}
106 @end quotation
107
108 @warning{When asking questions, please use @ref{Tiny examples}!}
109
110 @subsubheading LilyPond Snippet Repository
111
112 The LilyPond Snippet Repository is a large collection of
113 user-submitted examples, which can freely be copied and used
114 in your owm works.  See what other people have written,
115 and add your own!
116
117 @example
118 @uref{http://lsr.dsi.unimi.it}
119 @end example
120
121 Particularly instructive examples from LSR are included in our
122 official documentation, in @ref{Snippets}.
123
124
125 @subsubheading IRC
126
127 Some level of support is provided on our IRC channel,
128
129 @example
130 @uref{irc://irc.freenode.net/lilypond, #lilypond@@irc.freenode.net}
131 @end example
132
133 This channel has no public archive, so any question that may
134 be useful for others would better be posted to one of the mailing lists.
135
136 @html
137 <form action="http://webchat.freenode.net"
138       method="get"
139       name="f_lily_irc"
140   <label>irc name:
141     <input name="nick" type="text" size="15" value="">
142   </label>
143   <input name="channels" type="hidden" value="lilypond">
144   <input type="submit" value="Join #lilypond IRC Chat">
145 </form>
146
147 <script language="JavaScript" type="text/javascript">
148   var username = "web";
149   var lang = window.navigator.userLanguage ? window.navigator.userLanguage
150   : window.navigator.language;
151   username += '-' + lang.substr(0, 2);
152   username += '-' + navigator.appName.substr(0, 2);
153   username += navigator.appCodeName.replace (" ", "").substr(0, 2);
154   username += navigator.platform.replace (" ", "").replace("nux", "").replace("n32", "");
155   document.forms["f_lily_irc"].nick.value = username;
156 </script>
157 @end html
158
159 @subsubheading Other languages
160
161 @quotation
162 @uref{http://lists.gnu.org/mailman/listinfo/lilypond-es,
163 Spanish mailing list}
164
165 @uref{http://www.lilypondforum.de/,
166 German forum}
167
168 @uref{http://groups.google.com/group/lilypond-brasil,
169 Portugese group}
170
171 @uref{http://lists.gnu.org/mailman/listinfo/lilypond-user-fr,
172 French mailing list}
173
174 @uref{http://www.lilypondforum.nl/,
175 Dutch forum}
176 @end quotation
177
178 @divEnd
179
180
181 @divClass{column-right-top}
182 @subheading Stay Informed
183
184 @subsubheading LilyPond Report
185
186 The easiest way to keep touch is by reading our community
187 newsletter, the LilyPond Report:
188
189 @example
190 @uref{http://news.lilynet.net}
191 @end example
192
193 @subsubheading Releases mailing list: @code{info-lilypond@@gnu.org}
194
195 This mailing list is a low-volume, read-only list which receives
196 notifications of new releases.
197
198 @quotation
199 @uref{http://lists.gnu.org/mailman/listinfo/info-lilypond,
200 info-lilypond subscribe and info}
201
202 @uref{http://lists.gnu.org/archive/html/info-lilypond/,
203 info archive1}
204 @uref{http://www.mail-archive.com/info-lilypond@@gnu.org/,
205 archive2}
206 @uref{http://dir.gmane.org/gmane.comp.gnu.lilypond.announce,
207 archive3}
208
209 @c don't include gmane posting here.  -gp
210 @end quotation
211
212
213 @divEnd
214
215
216 @divClass{column-right-bottom}
217 @subheading Developer Discussion
218
219 @subsubheading Developer mailing list: @code{lilypond-devel@@gnu.org}
220
221 Most developer discussion takes place on this list.  Patches
222 should be sent here.
223
224 @quotation
225 @uref{http://lists.gnu.org/mailman/listinfo/lilypond-devel,
226 lilypond-devel subscribe and info}
227
228 @uref{http://lists.gnu.org/archive/html/lilypond-devel/,
229 devel archive1}
230 @uref{http://www.mail-archive.com/lilypond-devel@@gnu.org/,
231 archive2}
232 @uref{http://dir.gmane.org/gmane.comp.gnu.lilypond.devel,
233 archive3}
234
235 @uref{http://post.gmane.org/post.php?group=gmane.comp.gnu.lilypond.devel,
236 send to lilypond-devel with gmane}
237 @end quotation
238
239
240 @subsubheading Bug mailing list: @code{bug-lilypond@@gnu.org}
241
242 Bug-specific discussion takes place here.
243
244 @quotation
245 @uref{http://lists.gnu.org/mailman/listinfo/bug-lilypond,
246 bug-lilypond subscribe and info}
247
248 @uref{http://lists.gnu.org/archive/html/bug-lilypond/,
249 bug archive1}
250 @uref{http://www.mail-archive.com/bug-lilypond@@gnu.org/,
251 archive2}
252 @uref{http://dir.gmane.org/gmane.comp.gnu.lilypond.bugs,
253 archive3}
254
255 @c don't include gmane posting here.  -gp
256 @end quotation
257
258 @warning{Before sending a message to the bug list, please read our
259 guidelines for @ref{Bug reports}.}
260
261 @divEnd
262
263
264
265 @node Tiny examples
266 @unnumberedsec Tiny examples
267
268 @divClass{column-center-top}
269 @subheading What are @qq{Tiny examples}?
270
271 A tiny example is an example from which nothing can be removed.
272 @divEnd
273
274 @divClass{column-left-bottom}
275 @subheading Why create them?
276
277 @divClass{keep-bullets}
278 @itemize
279
280 @item
281 The simpler the example is, the quicker potential helpers can
282 understand it and help you.
283
284 @item
285 A simple example demonstrates that you have put effort towards
286 solving the problem yourself.  When people send huge portions of
287 input, it looks like they don't care how if we help them or not.
288
289 @item
290 Creating a tiny example forces you to understand what is
291 happening.  Many false problem reports can be avoided by
292 attempting to create a tiny example; if you cannot replicate a
293 @qq{bug} in a tiny example, then the problem was probably an
294 insufficient understanding of LilyPond, not an actual bug!
295
296 @end itemize
297 @divEnd
298
299 @divEnd
300
301
302 @divClass{column-right-bottom}
303 @subheading How do I create them?
304
305 @divClass{keep-bullets}
306 @itemize
307
308 @item
309 Include the \version number.
310
311 @item
312 Make it small!  Examples about spacing or page layout might
313 require many bars of music, but most issues can be reproduced
314 using only a single measure.
315
316 @item
317 When trying to create an example, try commenting out @w{(@code{%}
318 or @code{%@{ @dots{} %@}})} sections of your file.  If you can
319 comment something while still demonstrating the main idea, then
320 remove the commented-material!
321
322 @item
323 Avoid using complicated notes, keys, or time signatures, unless
324 the bug is about the behavior of those items.
325
326 @item
327 Do not use @code{\override} or @code{\set} commands unless the bug
328 is about those particular commands.
329
330 @end itemize
331 @divEnd
332
333 @divEnd
334
335
336
337
338 @node Bug reports
339 @unnumberedsec Bug reports
340
341 @divClass{column-center-top}
342 @subheading Step 1: Known bugs
343
344 If you have input that results in a crash or an erroneous output,
345 then that is a bug.  There is a list of current bugs on our google
346 bug tracker,
347
348 @example
349 @uref{http://code.google.com/p/lilypond/issues/list}
350 @end example
351
352 @warning{Please @strong{DO NOT} add bug reports directly to the
353 bug tracker.  Once an issue has been added to the tracker, feel
354 free to add more information to that report.}
355
356 @divEnd
357
358
359 @divClass{column-left-bottom}
360 @subheading Step 2: Creating a bug report
361
362 If you have discovered a bug which is not listed, please help us
363 by creating a bug report.
364
365 @warning{We only accept bug reports in the form of
366 @ref{Tiny examples}.  We have very limited resources to deal with
367 bug reports, so any non-minimal example will be rejected.  Almost
368 every bug can be demonstrated in four notes or less!}
369
370 Here is an example of a good bug report:
371
372 @example
373 %% the octavation command doesn't
374 %% change the output at all!
375
376 \version "2.10.0"
377 \relative c''' @{
378   c1
379   #(set-octavation 1)
380   c1
381 @}
382 @end example
383
384 @divEnd
385
386 @divClass{column-right-bottom}
387 @subheading Step 3: Sending a bug report
388
389 Once you have verified that the issue is not already known and
390 created a bug report, please send it to us!
391
392 Unfortunately there is a strict @qq{no top-posting} check on the
393 bug list, which is often incorrectly triggered by lilypond files.
394 To avoid this, please add
395
396 @example
397 > I'm not top posting.
398 @end example
399
400 @noindent
401 (you must include the @code{>} ) to the top of your bug report.
402
403 @uref{http://post.gmane.org/post.php?group=gmane.comp.gnu.lilypond.bugs,
404 Post with the gmane lilypond.bugs interface}, or send an email to
405 @uref{mailto:bug-lilypond@@gnu.org, bug-lilypond@@gnu.org}.
406
407 Once your bug has been sent to the list, our Bug Squad will
408 examine the report.  Please allow up to 24 hours, as we have a
409 limited number of volunteers for this task.  They may ask you for
410 more information, or may add the report to the tracker and let you
411 know what the issue number is.
412
413 You may mark the bug so that you automatically receive emails when
414 any activity on the bug occurs.  This requires you have a google
415 account.
416 @divEnd
417
418
419 @node Help us
420 @unnumberedsec Help us
421
422 @divClass{column-center-top}
423 @helpusNeed
424
425 @divEnd
426
427 @divClass{column-left-top}
428 @divClass{keep-bullets}
429 @helpusTasks
430
431 @divEnd
432 @divEnd
433
434 @divClass{column-right-top}
435 @helpusProjects
436
437 @divEnd
438
439
440 @node Development
441 @unnumberedsec Development
442
443 @divClass{heading-center}
444 @ifclear web_version
445   @heading Development for LilyPond @version
446 @end ifclear
447 @ifset web_version
448   @heading Development for LilyPond @versionDevel
449 @end ifset
450
451
452 @warning{These are @emph{unstable development} versions.  If you
453 have the slightest doubt about how to use or install LilyPond, we
454 urge you to use the stable @ref{Download}, and read the stable
455 @ref{Manuals}.}
456
457 @divEnd
458
459 @divClass{column-center-top}
460 @subheading Release numbers
461
462 There are two sets of releases for LilyPond: stable releases, and
463 unstable development releases.  Stable versions have an
464 even-numbered @q{minor} version number (e.g., 2.8, 2.10, 2.12).
465 Development versions have an odd-numbered @q{minor} version number
466 (e.g., 2.7, 2.9, 2.11).
467
468 @divEnd
469
470
471 @divClass{column-left-top}
472 @subheading Download
473
474 Instructions for git and compiling are in the Contributor's Guide.
475
476 @quotation
477 @uref{http://git.sv.gnu.org/gitweb/?p=lilypond.git, lilypond git repository}
478 @end quotation
479
480 Documentation writers and testers will generally want to download
481 the latest binary:
482
483 @quotation
484
485 @downloadDevelLinuxNormal
486
487 @downloadDevelLinuxBig
488
489 @downloadDevelLinuxPPC
490
491 @downloadDevelFreeBSDNormal
492
493 @downloadDevelFreeBSDBig
494
495 @downloadDevelDarwinNormal
496
497 @downloadDevelDarwinPPC
498
499 @downloadDevelWindows
500
501 @downloadDevelSource
502
503 @end quotation
504
505 @divEnd
506
507
508 @divClass{column-right-top}
509 @subheading Contributor's Guide
510
511 LilyPond development is a fairly complicated matter.  In order to
512 help new contributors, and to keep the whole system (mostly)
513 stable, we have written a manual for development tasks.
514
515 @docLinksBare{Contributor's Guide, contributor,
516   @rcontribnamed{Top,Contributor's Guide},
517   @manualDevelContributorSplit,
518   @manualDevelContributorBig, 500 kB,
519   @manualDevelContributorPdf, 2.8 MB}
520
521 @divEnd
522
523
524 @divClass{column-center-top}
525 @subheading Regression tests
526
527 @divClass{keep-bullets}
528 @itemize
529
530 @ifclear web_version
531
532 @item
533 @uref{../../input/regression/collated-files.html, Regression tests}:
534 This release's regtests.
535 (@uref{../../input/regression/collated-files.pdf, pdf version})
536
537 @item
538 @uref{../../input/regression/musicxml/collated-files.html, MusicXML tests}:
539 This release's musicXML tests.
540 (@uref{../../input/regression/musicxml/collated-files.pdf, pdf version})
541 @end ifclear
542
543 @ifset web_version
544 @item @regtestDevel (@regtestDevelPdf{})
545
546 @item @regtestDevelXml (@regtestDevelXmlPdf{})
547
548 @item @regtestStable (@regtestStablePdf{})
549
550 @item @regtestStableXml (@regtestStableXmlPdf{})
551 @end ifset
552
553
554 @item @uref{http://lilypond.org/test, Archive of regression tests}:
555 Comparisons between versions.
556
557 @end itemize
558 @divEnd
559 @divEnd
560
561
562
563 @divClass{column-center-bottom}
564 @subheading Manuals
565
566 @ifclear web_version
567 @warning{These manuals are for LilyPond @version{}; the latest
568 manuals can be found at @url{http://lilypond.org}}
569 @end ifclear
570
571 @divClass{normal-table}
572 @multitable @columnfractions .3 .3 .3
573 @headitem Introduction
574 @item
575 @docLinkSplit{Learning,learning,@manualDevelLearningSplit}
576 @tab
577 @docLinkBig{Learning,learning,@manualDevelLearningBig}
578 @tab
579 @docLinkPdf{Learning,learning,@manualDevelLearningPdf}
580
581 @item
582 @docLinkSplit{Glossary,music-glossary,@manualDevelGlossarySplit}
583 @tab
584 @docLinkBig{Glossary,music-glossary,@manualDevelGlossaryBig}
585 @tab
586 @docLinkPdf{Glossary,music-glossary,@manualDevelGlossaryPdf}
587
588 @item
589 @docLinkSplit{Essay,essay,@manualDevelEssaySplit}
590 @tab
591 @docLinkBig{Essay,essay,@manualDevelEssayBig}
592 @tab
593 @docLinkPdf{Essay,essay,@manualDevelEssayPdf}
594
595 @headitem Regular
596
597 @item
598 @docLinkSplit{Notation,notation,@manualDevelNotationSplit}
599 @tab
600 @docLinkBig{Notation,notation,@manualDevelNotationBig}
601 @tab
602 @docLinkPdf{Notation,notation,@manualDevelNotationPdf}
603
604 @item
605 @docLinkSplit{Usage,usage,@manualDevelUsageSplit}
606 @tab
607 @docLinkBig{Usage,usage,@manualDevelUsageBig}
608 @tab
609 @docLinkPdf{Usage,usage,@manualDevelUsagePdf}
610
611 @item
612 @docLinkSplit{Snippets,snippets,@manualDevelSnippetsSplit}
613 @tab
614 @docLinkBig{Snippets,snippets,@manualDevelSnippetsBig}
615 @tab
616 @docLinkPdf{Snippets,snippets,@manualDevelSnippetsPdf}
617
618 @headitem Infrequent
619
620 @item
621 @docLinkSplit{Web,web,@manualDevelWebSplit}
622 @tab
623 @docLinkBig{Web,web,@manualDevelWebBig}
624 @tab
625 @docLinkPdf{Web,web,@manualDevelWebPdf}
626
627 @item
628 @docLinkSplit{Changes,changes,@manualDevelChangesSplit}
629 @tab
630 @docLinkBig{Changes,changes,@manualDevelChangesBig}
631 @tab
632 @docLinkPdf{Changes,changes,@manualDevelChangesPdf}
633
634 @item
635 @docLinkSplit{Extending,extending,@manualDevelExtendingSplit}
636 @tab
637 @docLinkBig{Extending,extending,@manualDevelExtendingBig}
638 @tab
639 @docLinkPdf{Extending,extending,@manualDevelExtendingPdf}
640
641 @item
642 @docLinkSplit{Internals,internals,@manualDevelInternalsSplit}
643 @tab
644 @docLinkBig{Internals,internals,@manualDevelInternalsBig}
645 @tab
646 @docLinkPdf{Internals,internals,@manualDevelInternalsPdf}
647
648 @ifset web_version
649 @headitem Downloadable
650
651 @item
652 @doctarballDevel
653 @end ifset
654
655 @end multitable
656
657 @divEnd
658 @divEnd
659
660
661
662
663 @node Authors
664 @unnumberedsec Authors
665
666 @divClass{column-left-top}
667 @subheading Current Development Team
668
669 @divClass{keep-bullets}
670 @developersCurrent
671 @divEnd
672 @divEnd
673
674 @divClass{column-right-top}
675 @subheading Previous Development Team
676
677 @divClass{keep-bullets}
678 @developersPrevious
679 @divEnd
680 @divEnd
681
682
683 @divClass{column-center-top}
684 @subheading Current Contributors
685
686 @divClass{keep-bullets}
687 @subsubheading Programming
688
689 @coreCurrent
690
691 @subsubheading Font
692
693 @fontCurrent
694
695 @subsubheading Documentation
696
697 @docCurrent
698
699 @subsubheading Bug squad
700
701 @bugsquadCurrent
702
703 @subsubheading Support
704
705 @supportCurrent
706
707 @subsubheading Translation
708
709 @translationsCurrent
710
711 @divEnd
712 @divEnd
713
714
715 @divClass{column-center-bottom}
716 @subheading Previous Contributors
717
718 @divClass{keep-bullets}
719 @subsubheading Programming
720
721 @corePrevious
722
723 @subsubheading Font
724
725 @fontPrevious
726
727 @subsubheading Documentation
728
729 @docPrevious
730
731 @c    uncomment when we have any previous members -gp
732 @c @subsubheading Bug squad
733
734 @c @bugsquadCurrent
735
736 @subsubheading Support
737
738 @supportPrevious
739
740 @subsubheading Translation
741
742 @translationsPrevious
743
744 @divEnd
745 @divEnd
746
747
748
749 @node Publications
750 @unnumberedsec Publications
751
752 @divClass{column-center-top}
753 @subheading What we wrote about LilyPond
754
755 @divClass{keep-bullets}
756 @itemize
757
758 @item
759 Han-Wen Nienhuys, @emph{LilyPond, Automated music formatting and
760 the Art of Shipping}.  Forum Internacional Software Livre 2006
761 (FISL7.0) (@uref{http://lilypond.org/web/images/FISL7-slides.pdf,
762 PDF 1095k})
763
764 @item
765 Erik Sandberg, @emph{Separating input language and formatter in
766 GNU LilyPond}. Master's Thesis, Uppsala University, Department of
767 Information Technology March 2006.
768 (@uref{http://lilypond.org/web/images/thesis-erik-sandberg.pdf,
769 PDF 750k})
770
771 @item
772 Han-Wen Nienhuys and Jan Nieuwenhuizen, @emph{LilyPond, a system
773 for automated music engraving}.  Proceedings of the XIV Colloquium
774 on Musical Informatics (XIV CIM 2003), Firenze, Italy, May 2003.
775 (@uref{ http://lilypond.org/web/images/xivcim.pdf, PDF 95k})
776
777 @end itemize
778
779 @divEnd
780 @divEnd
781
782
783 @divClass{column-center-bottom}
784
785 @subheading What people did with LilyPond
786
787
788 @divClass{keep-bullets}
789 @itemize
790
791 @item
792 Graham Percival, Tosten Anders, and George Tzanetakis,
793 @emph{Generating Targeted Rhythmic Exercises for Music Students
794 with Constraint Satisfaction Programming}, International Computer
795 Music Conference 2008.
796
797 @item
798 A. Passos, M. Silva, P. Kroger, and G. Cidra,
799 @emph{Functional Harmonic Analysis and Computational Musicology
800 in Rameau}, Proceedings of the 12th Brazilian Symposium on Compute
801 Music, 2009, pp. 207-210.
802
803 @item
804 Alberto Simões, Anália Lourenço and José João Almeida,
805 @emph{Using Text Mining Techniques for Classical Music Scores Analysis},
806 New Trends in Artificial Intelligence, 2007 J. Neves et al ed.
807
808 @item
809
810 Kevin C. Baird 2005.
811 @emph{Real-time generation of music notation via audience interaction using
812 python and GNU lilypond}. Proceedings of the 2005 Conference on New interfaces
813 For Musical Expression (Vancouver, Canada, May 26 - 28, 2005).
814 New Interfaces For Musical Expression. National University of Singapore, Singapore, 240-241.
815
816 @end itemize
817
818 @divEnd
819 @divEnd
820
821
822 @node Old news
823 @unnumberedsec Old news
824
825 @include web/news-front.itexi
826
827 @include web/news.itexi
828
829