]> git.donarmstrong.com Git - lilypond.git/blob - Documentation/web/community.itexi
Issue 4962: Web: home page: add example image, reduce news to headlines
[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/acknowledge.itexi
11 @include included/authors.itexi
12 @include included/helpus.itexi
13
14 @node Community
15 @unnumbered Community
16
17 @divClass{link-headings}
18
19 @divClass{column-center-top}
20 @subheading Interacting with the community
21
22 @itemize
23
24 @item
25 @ref{Contact}: get help, discuss, and keep in touch!
26
27 @item
28 @ref{Tiny examples}: these are @emph{highly} recommended when
29 discussing LilyPond.
30
31 @item
32 @ref{Bug reports}: something went wrong.
33
34 @end itemize
35 @divEnd
36
37 @divClass{column-left-bottom}
38 @subheading Making LilyPond better
39
40 @itemize
41
42 @item
43 @ref{Help us}: your assistance is requested.
44
45 @item
46 @ref{Sponsoring}: financial contributions.
47
48 @item
49 @ref{Development}: for contributors and testers.
50
51 @item
52 @ref{Google Summer of Code}: ideas for Google Summer of Code (GSoC).
53
54 @item
55 @ref{Authors}: the people who made LilyPond what it is today.
56
57 @item
58 @ref{Acknowledgements}: projects and institutions that support LilyPond
59
60 @end itemize
61 @divEnd
62
63 @divClass{column-right-bottom}
64 @subheading Miscellaneous
65
66 @itemize
67
68 @item
69 @ref{Publications}: what we wrote, and have had written about us.
70
71 @item
72 @ref{News}: news from the LilyPond project.
73
74 @item
75 @ref{Attic}: announcements and changelogs from past versions.
76
77 @end itemize
78 @divEnd
79
80 @divEnd
81
82 @divClass{hide}
83 @menu
84 * Contact::
85 * Tiny examples::
86 * Bug reports::
87 * Help us::
88 * Sponsoring::
89 * Development::
90 * Google Summer of Code::
91 * Authors::
92 * Acknowledgements::
93 * Publications::
94 * News::
95 * Attic::
96 @end menu
97 @divEnd
98
99
100 @node Contact
101 @unnumberedsec Contact
102
103
104 @divClass{column-left-bottom}
105 @subheading User Discussions and Help
106
107 @subsubheading User mailing list: @code{lilypond-user@@gnu.org}
108
109 This mailing list is the main place for users to discuss and help
110 each other.
111
112 @quotation
113 @uref{http://lists.gnu.org/mailman/listinfo/lilypond-user,
114 lilypond-user subscribe and info}
115
116 @uref{http://lists.gnu.org/archive/html/lilypond-user/,
117 user archive1}
118 @uref{http://www.mail-archive.com/lilypond-user@@gnu.org/,
119 archive2}
120 @uref{http://dir.gmane.org/gmane.comp.gnu.lilypond.general,
121 archive3}
122
123 @uref{http://post.gmane.org/post.php?group=gmane.comp.gnu.lilypond.general,
124 send to lilypond-user with gmane}
125 @end quotation
126
127 @warning{When asking questions, please use @ref{Tiny examples}!}
128
129 @subsubheading LilyPond Snippet Repository
130
131 The LilyPond Snippet Repository is a large collection of
132 user-submitted examples, which can freely be copied and used
133 in your own works.  See what other people have written,
134 and add your own!
135
136 @example
137 @uref{http://lsr.di.unimi.it}
138 @end example
139
140 Particularly instructive examples from LSR are included in our
141 official documentation, in @ref{Snippets}.
142
143
144 @subsubheading IRC
145
146 Some level of support is provided on our IRC channel,
147
148 @example
149 @uref{irc://irc.freenode.net/lilypond, #lilypond@@irc.freenode.net}
150 @end example
151
152 This channel has no public archive, so any question that may
153 be useful for others would better be posted to one of the mailing lists.
154
155 @html
156 <form action="http://webchat.freenode.net"
157       method="get"
158       name="f_lily_irc"
159   <label>irc name:
160     <input name="nick" type="text" size="15" value="">
161   </label>
162   <input name="channels" type="hidden" value="lilypond">
163   <input type="submit" value="Join #lilypond IRC Chat">
164 </form>
165
166 <script language="JavaScript" type="text/javascript">
167   var username = "web";
168   var lang = window.navigator.userLanguage ? window.navigator.userLanguage
169   : window.navigator.language;
170   username += '-' + lang.substr(0, 2);
171   username += '-' + navigator.appName.substr(0, 2);
172   username += navigator.appCodeName.replace (" ", "").substr(0, 2);
173   username += navigator.platform.replace (" ", "").replace("nux", "").replace("n32", "");
174   document.forms["f_lily_irc"].nick.value = username;
175 </script>
176 @end html
177
178 @subsubheading Other languages
179
180 @quotation
181 @uref{http://lists.gnu.org/mailman/listinfo/lilypond-user-fr,
182 French mailing list}
183
184 @uref{http://www.lilypondforum.de/,
185 German forum}
186
187 @uref{http://groups.google.com/group/lilypond-brasil,
188 Portuguese group}
189
190 @uref{http://lists.gnu.org/mailman/listinfo/lilypond-es,
191 Spanish mailing list}
192 @end quotation
193 @divEnd
194
195
196 @divClass{column-right-top}
197 @subheading The LilyPond Blog
198
199 Read our community blog, @q{Scores of Beauty}:
200
201 @example
202 @uref{http://lilypondblog.org}
203 @end example
204
205 @subsubheading Releases mailing list: @code{info-lilypond@@gnu.org}
206
207 This mailing list is a low-volume, read-only list which receives
208 notifications of new releases.
209
210 @quotation
211 @uref{http://lists.gnu.org/mailman/listinfo/info-lilypond,
212 info-lilypond subscribe and info}
213
214 @uref{http://lists.gnu.org/archive/html/info-lilypond/,
215 info archive1}
216 @uref{http://www.mail-archive.com/info-lilypond@@gnu.org/,
217 archive2}
218 @uref{http://dir.gmane.org/gmane.comp.gnu.lilypond.announce,
219 archive3}
220
221 @c don't include gmane posting here.  -gp
222 @end quotation
223
224
225 @divEnd
226
227
228 @divClass{column-right-bottom}
229 @subheading Developer Discussions and Translations
230
231 @subsubheading Developer mailing list: @code{lilypond-devel@@gnu.org}
232
233 Developer discussions take place on this list. Patches can also be sent
234 here.
235
236 @quotation
237 @uref{http://lists.gnu.org/mailman/listinfo/lilypond-devel,
238 lilypond-devel subscribe and info}
239
240 @uref{http://lists.gnu.org/archive/html/lilypond-devel/,
241 devel archive1}
242 @uref{http://www.mail-archive.com/lilypond-devel@@gnu.org/,
243 archive2}
244 @uref{http://dir.gmane.org/gmane.comp.gnu.lilypond.devel,
245 archive3}
246
247 @uref{http://post.gmane.org/post.php?group=gmane.comp.gnu.lilypond.devel,
248 send to lilypond-devel with gmane}
249 @end quotation
250
251
252 @subsubheading Bug mailing list: @code{bug-lilypond@@gnu.org}
253
254 Bug reports and discussions should be sent here.  Do not send patches
255 to this list.
256
257 @quotation
258 @uref{http://lists.gnu.org/mailman/listinfo/bug-lilypond,
259 bug-lilypond subscribe and info}
260
261 @uref{http://lists.gnu.org/archive/html/bug-lilypond/,
262 bug archive1}
263 @uref{http://www.mail-archive.com/bug-lilypond@@gnu.org/,
264 archive2}
265 @uref{http://dir.gmane.org/gmane.comp.gnu.lilypond.bugs,
266 archive3}
267
268 @c don't include gmane posting here.  -gp
269 @end quotation
270
271 @warning{Before sending a message to the bug list, please read our
272 guidelines for @ref{Bug reports}.}
273
274
275 @subsubheading Translation mailing list: @code{translations@@lilynet.org}
276
277 All discussions about translating LilyPond manuals should be sent here.
278 Do not send patches to this list.
279
280 @quotation
281 @uref{http://lilypond-translations.3384276.n2.nabble.com/,
282 Translation mailing list archive}
283 @end quotation
284
285 @divEnd
286
287
288 @node Tiny examples
289 @unnumberedsec Tiny examples
290
291 @divClass{column-center-top}
292 @subheading What are @qq{Tiny examples}?
293
294 A tiny example is an example from which @strong{nothing} can be removed.
295 @divEnd
296
297 @divClass{column-left-bottom}
298 @subheading Why create them?
299
300 @divClass{keep-bullets}
301 @itemize
302
303 @item
304 The simpler the example is, the quicker potential helpers can
305 understand it and help you.
306
307 @item
308 A tiny example demonstrates that you have put effort towards
309 solving the problem yourself.  When people send huge portions of
310 input, it looks like they don't care if we help them or not.
311
312 @item
313 Creating a tiny example helps you to understand what is
314 happening.  Many false problem reports can be avoided by
315 attempting to create a tiny example; if you cannot replicate a
316 @qq{bug} in a tiny example, then the problem was probably an
317 insufficient understanding of LilyPond, not an actual bug!
318
319 @end itemize
320 @divEnd
321
322 @divEnd
323
324
325 @divClass{column-right-bottom}
326 @subheading How to create them?
327
328 @divClass{keep-bullets}
329 @itemize
330
331 @item
332 Include the @code{\version} number.
333
334 @item
335 Make it small!  Examples about spacing or page layout might
336 require many bars of music, but most issues can be reproduced
337 using less than a single measure.
338
339 @item
340 When trying to create an example, try commenting out @w{(@code{%}
341 or @code{%@{ @dots{} %@}})} sections of your file.  If you
342 can comment something while still demonstrating the main idea,
343 then remove the commented-material.
344
345 @item
346 Avoid using complicated notes, keys or time signatures, unless
347 the bug is about the behavior of those items.
348
349 @item
350 Do not use @code{\override} or @code{\set} commands unless the bug
351 is about those specific commands.
352
353 @item
354 Optionally, attach an image showing the desired graphical output.
355
356 @end itemize
357 @divEnd
358
359 @divEnd
360
361 @divClass{column-center-bottom}
362 @subheading How tiny should they be?
363
364 Is the code below a minimal example?
365
366 @example
367 \version "2.14.1"
368 \include "english.ly"
369
370 \score @{
371   \new Staff @{
372     \key d \major
373     \numericTimeSignature
374     \time 2/4
375     <cs' d'' b''>16 <cs' d'' b''>8.
376     %% Here: the tie on the D's looks funny
377     %% Too tall? Left-hand endpoint is not aligned with the B tie?
378     ~
379     <cs' d'' b''>8 [ <b d'' a''> ]
380   @}
381 @}
382 @end example
383
384 Well, it is not very big, but a truly minimal example is here:
385
386 @example
387 \version "2.14.1"
388 @{
389   % middle tie looks funny here:
390   <c' d'' b''>8. ~ <c' d'' b''>8
391 @}
392 @end example
393
394 Very few tiny examples exceed 10 lines of code -
395 quite often 4 lines are enough to demonstrate the problem!
396
397 @divEnd
398
399
400 @node Bug reports
401 @unnumberedsec Bug reports
402
403
404 @divClass{heading-center}
405 If you have input that results in a crash or wrong output,
406 then that is a bug.
407 @divEnd
408
409 @divClass{column-center-top}
410 @subheading Step 1: Known bugs
411
412 We may already know about this bug.  Check here:
413
414 @example
415 @uref{http://sourceforge.net/p/testlilyissues/issues/}
416 @end example
417
418 @warning{Please @strong{DO NOT} add bug reports directly to the
419 bug tracker.  Once an issue has been added to the tracker, feel
420 free to add more information to that report.}
421
422 @divEnd
423
424
425 @divClass{column-left-bottom}
426 @subheading Step 2: Creating a bug report
427
428 If you have discovered a bug which is not listed,
429 please help us by creating a bug report.
430
431 @warning{We only accept reports in the form of
432 @ref{Tiny examples}.  We have very limited resources,
433 so any non-minimal example will be rejected.  Almost
434 every bug can be demonstrated in four notes or less!}
435
436 Here is an example of a good bug report:
437
438 @example
439 % Accidentals should be printed for only
440 % the first note in a tie, but this version
441 % prints flats on both notes.
442 \version "2.10.1"
443
444 \relative c'' @{
445  bes1 ~
446  bes1
447 @}
448 @end example
449
450 @divEnd
451
452 @divClass{column-right-bottom}
453 @subheading Step 3: Sending a bug report
454
455 Once you have verified that the issue is not already known and
456 created a bug report, please send it to us!
457
458 @divClass{keep-bullets}
459 @itemize
460
461 @item
462 If you are subscribed to the @uref{mailto:bug-lilypond@@gnu.org,
463 bug-lilypond@@gnu.org} mailing list, send an email like normal.
464
465 @item
466 If you are not subscribed, you can still post a bug report with
467 the
468 @uref{http://post.gmane.org/post.php?group=gmane.comp.gnu.lilypond.bugs,
469 gmane lilypond.bugs web interface}.
470
471 However, there is a strict @qq{no top-posting} check on the gmane
472 interface, which is often incorrectly triggered by lilypond files.
473 To avoid this, please add:
474
475 @example
476 > I'm not top posting.
477 @end example
478
479 @noindent
480 (you @emph{must} include the @code{>} ) to the top of your bug
481 report.
482
483 @end itemize
484 @divEnd
485 @divEnd
486
487 @divClass{column-center-bottom}
488 @subheading Step 4: Wait for a response
489
490 Once your bug report has been sent to the list, our Bug Squad will
491 examine it; they may ask you for more information.  You will be notified
492 when the report will be added to the bug tracker.  Please allow up to 4
493 days, as we have a limited number of volunteers for this task.
494
495 Once a bug has been added to the tracker, you can comment it to add
496 more information about it.
497 You may also mark the bug so that you automatically receive emails when
498 any activity on the bug occurs.  This requires you have a google account
499 login.
500 @divEnd
501
502 @divClass{column-center-bottom}
503 @subheading Optional help: show the desired behavior
504
505 Once an issue has been added to the tracker, it can be very
506 helpful if we can see the desired output.  Feel free to add input
507 code and/or images (possibly created with other tools) which
508 demonstrate what you think it should look like!
509
510 @divEnd
511
512
513
514 @node Help us
515 @unnumberedsec Help us
516
517 @divClass{column-center-top}
518 @helpusNeed
519
520 @divEnd
521
522 @divClass{column-left-top}
523 @divClass{keep-bullets}
524 @helpusSimple
525
526 @divEnd
527 @divEnd
528
529 @divClass{column-right-top}
530 @helpusAdvanced
531
532 @divEnd
533
534
535 @node Sponsoring
536 @unnumberedsec Sponsoring
537
538 @divClass{keep-bullets}
539 @divClass{column-left-top}
540 @subheading Bounties
541
542 In the past,
543
544 @itemize
545 @item some users have paid for new features
546 @item some developers have added new features for hire
547 @end itemize
548
549 The LilyPond project does not organize such efforts; we neither
550 endorse nor discourage such agreements.  Any contracts between
551 private individuals is the business of those individuals, not
552 ours.
553
554 @divEnd
555
556 @divClass{column-right-top}
557 @subheading Guidelines
558
559 Any user wanting to offer money in exchange for work should bear
560 in mind the following points:
561
562 @itemize
563 @item
564 LilyPond developers may advertise their services on the lilypond
565 email lists from time to time.
566
567 @item
568 Any agreements between private individuals should include the
569 normal precautions when conducting business: who pays, how much do
570 they pay, with what method of payment, and upon what set of
571 conditions.  We suggest that any ambiguity or uncertainty in these
572 questions should be resolved before any work begins.
573
574 @end itemize
575
576 @divEnd
577
578 @divClass{column-center-bottom}
579 @subheading Interested developers
580
581 Here is a list of people who have expressed an interest in
582 bounties.  Note that the amount of work done by individuals varies
583 quite a bit throughout the years.  We do not guarantee that this
584 list is up-to-date, nor do we guarantee that the people listed
585 here have any ability.  The only criteria is "XYZ asked to be
586 listed on this page".
587
588 Looking at the git history is a good way to determine who the most
589 active and experienced developers are.  Statistics up to version
590 @versionDevel{}:
591
592 @multitable @columnfractions .3 .3 .3
593 @item @uref{http://lilypond.org/~graham/gitstats-all/, overall history}
594 @tab @uref{http://lilypond.org/~graham/gitstats-1year/, past year}
595 @tab @uref{http://lilypond.org/~graham/gitstats-3months/, past three months}
596 @end multitable
597
598 Interested developers:
599 @table @asis
600 @item @email{dak@@gnu.org, David Kastrup}
601 Donations are required to let me continue my current fulltime work on
602 LilyPond.  I focus on user and programmer interface design, coherence,
603 implementation, simplification, documentation, and debugging.
604
605 @c Format
606 @c @item @email{name@@adress.domain, Name}
607 @c area of interest (256 chars max)
608
609 @end table
610
611 @divEnd
612 @divEnd
613
614
615 @node Development
616 @unnumberedsec Development
617
618 @divClass{heading-center}
619 @ifclear web_version
620   @heading Development for LilyPond @version
621 @end ifclear
622 @ifset web_version
623   @heading Development for LilyPond @versionDevel
624 @end ifset
625
626
627 @c we normally don't allow named references, but in this case
628 @c it's good to emphasize the "stable" part.  -gp
629 @warning{These are @emph{unstable development} versions.  If you
630 have the slightest doubt about how to use or install LilyPond, we
631 urge you to use the @ref{Download, stable Download}, and read the
632 @ref{Manuals, stable Manuals}.}
633
634 @divEnd
635
636 @divClass{column-center-top}
637 @subheading Release numbers
638
639 There are two sets of releases for LilyPond: stable releases, and
640 unstable development releases.  Stable versions have an
641 even-numbered @q{minor} version number (e.g., 2.8, 2.10, 2.12).
642 Development versions have an odd-numbered @q{minor} version number
643 (e.g., 2.7, 2.9, 2.11).
644
645 @divEnd
646
647
648 @divClass{column-left-top}
649 @subheading Download
650
651 Instructions for git and compiling are in the Contributor's Guide.
652
653 @quotation
654 @uref{http://git.sv.gnu.org/gitweb/?p=lilypond.git, lilypond git repository}
655 @end quotation
656
657 Documentation writers and testers will generally want to download
658 the latest binary:
659
660 @quotation
661
662 @downloadDevelLinuxNormal
663
664 @downloadDevelLinuxBig
665
666 @downloadDevelLinuxPPC
667
668 @downloadDevelFreeBSDNormal
669
670 @downloadDevelFreeBSDBig
671
672 @downloadDevelDarwinNormal
673
674 @downloadDevelDarwinPPC
675
676 @downloadDevelWindows
677
678 @downloadDevelSource
679
680 @end quotation
681
682 @divEnd
683
684
685 @divClass{column-right-top}
686 @subheading Contributor's Guide
687
688 LilyPond development is a fairly complicated matter.  In order to
689 help new contributors, and to keep the whole system (mostly)
690 stable, we have written a manual for development tasks.
691
692 @docLinksBare{Contributor's Guide, contributor,
693   @rcontribnamed{Top,Contributor's Guide},
694   @manualDevelContributorSplit,
695   @manualDevelContributorBig, 500 kB,
696   @manualDevelContributorPdf, 2.8 MB}
697
698 @divEnd
699
700
701 @divClass{column-center-top}
702 @subheading Regression tests
703
704 @divClass{keep-bullets}
705
706 @ifclear web_version
707
708 @itemize
709 @item
710 @uref{../../input/regression/collated-files.html, Regression tests}:
711 This release's regtests.
712 (@uref{../../input/regression/collated-files.pdf, pdf version})
713
714 @item
715 @uref{../../input/regression/musicxml/collated-files.html, MusicXML tests}:
716 This release's musicXML tests.
717 (@uref{../../input/regression/musicxml/collated-files.pdf, pdf version})
718
719 @item
720 @uref{../../input/regression/abc2ly/collated-files.html, abc2ly tests}:
721 This release's abc2ly tests.
722 (@uref{../../input/regression/abc2ly/collated-files.pdf, pdf version})
723
724 @item
725 @uref{../../input/regression/lilypond-book/collated-files.html, lilypond-book tests}:
726 This release's lilypond-book tests.
727 (@uref{../../input/regression/lilypond-book/collated-files.pdf, pdf version})
728 @end itemize
729
730 @end ifclear
731
732 @ifset web_version
733 @subsubheading Development version
734
735 @itemize
736 @item @regtestDevel (@regtestDevelPdf{})
737
738 @item @regtestDevelXml (@regtestDevelXmlPdf{})
739
740 @item @regtestDevelAbc (@regtestDevelAbcPdf{})
741
742 @item @regtestDevelLilypondBook (@regtestDevelLilypondBookPdf{})
743 @end itemize
744
745 @subsubheading Stable version
746
747 @itemize
748 @item @regtestStable (@regtestStablePdf{})
749
750 @item @regtestStableXml (@regtestStableXmlPdf{})
751
752 @item @regtestStableAbc (@regtestStableAbcPdf{})
753
754 @item @regtestStableLilypondBook (@regtestStableLilypondBookPdf{})
755 @end itemize
756 @end ifset
757
758
759 @subsubheading All versions
760
761 @itemize
762 @item @uref{http://lilypond.org/test, Comparisons between regression tests}
763
764 @item @uref{http://lilypond.org/downloads/binaries/test-output/,
765 Archive of all regression tests}
766
767 @end itemize
768
769 @divEnd
770 @divEnd
771
772
773
774 @divClass{column-center-bottom}
775 @subheading Manuals
776
777 @ifclear web_version
778 @warning{These manuals are for LilyPond @version{}; the latest
779 manuals can be found at @url{http://lilypond.org}}
780 @end ifclear
781
782 @divClass{normal-table}
783 @multitable @columnfractions .3 .3 .3
784 @headitem Introduction
785
786 @item
787 @docLinkSplit{Learning,learning,@manualDevelLearningSplit}
788 @tab
789 @docLinkBig{Learning,learning,@manualDevelLearningBig}
790 @tab
791 @docLinkPdf{Learning,learning,@manualDevelLearningPdf}
792
793 @item
794 @docLinkSplit{Glossary,music-glossary,@manualDevelGlossarySplit}
795 @tab
796 @docLinkBig{Glossary,music-glossary,@manualDevelGlossaryBig}
797 @tab
798 @docLinkPdf{Glossary,music-glossary,@manualDevelGlossaryPdf}
799
800 @item
801 @docLinkSplit{Essay,essay,@manualDevelEssaySplit}
802 @tab
803 @docLinkBig{Essay,essay,@manualDevelEssayBig}
804 @tab
805 @docLinkPdf{Essay,essay,@manualDevelEssayPdf}
806 @end multitable
807
808 @multitable @columnfractions .3 .3 .3
809 @headitem Regular
810
811 @item
812 @docLinkSplit{Notation,notation,@manualDevelNotationSplit}
813 @tab
814 @docLinkBig{Notation,notation,@manualDevelNotationBig}
815 @tab
816 @docLinkPdf{Notation,notation,@manualDevelNotationPdf}
817
818 @item
819 @docLinkSplit{Usage,usage,@manualDevelUsageSplit}
820 @tab
821 @docLinkBig{Usage,usage,@manualDevelUsageBig}
822 @tab
823 @docLinkPdf{Usage,usage,@manualDevelUsagePdf}
824
825 @item
826 @docLinkSplit{Snippets,snippets,@manualDevelSnippetsSplit}
827 @tab
828 @docLinkBig{Snippets,snippets,@manualDevelSnippetsBig}
829 @tab
830 @docLinkPdf{Snippets,snippets,@manualDevelSnippetsPdf}
831 @end multitable
832
833 @multitable @columnfractions .3 .3 .3
834 @headitem Infrequent
835
836 @item
837 @docLinkSplit{Web,web,@manualDevelWebSplit}
838 @tab
839 @docLinkBig{Web,web,@manualDevelWebBig}
840 @tab
841 @docLinkPdf{Web,web,@manualDevelWebPdf}
842
843 @item
844 @docLinkSplit{Changes,changes,@manualDevelChangesSplit}
845 @tab
846 @docLinkBig{Changes,changes,@manualDevelChangesBig}
847 @tab
848 @docLinkPdf{Changes,changes,@manualDevelChangesPdf}
849
850 @item
851 @docLinkSplit{Extending,extending,@manualDevelExtendingSplit}
852 @tab
853 @docLinkBig{Extending,extending,@manualDevelExtendingBig}
854 @tab
855 @docLinkPdf{Extending,extending,@manualDevelExtendingPdf}
856
857 @item
858 @docLinkSplit{Internals,internals,@manualDevelInternalsSplit}
859 @tab
860 @docLinkBig{Internals,internals,@manualDevelInternalsBig}
861 @tab
862 @docLinkPdf{Internals,internals,@manualDevelInternalsPdf}
863 @end multitable
864
865 @ifset web_version
866 @multitable @columnfractions .3
867 @headitem Downloadable
868
869 @item
870 @doctarballDevel
871 @end multitable
872 @end ifset
873
874
875 @divEnd
876 @divEnd
877
878
879
880
881 @node Google Summer of Code
882 @unnumberedsec Google Summer of Code
883
884 @divClass{column-center-top}
885 @subheading What is Google Summer of Code?
886
887 @uref{https://developers.google.com/open-source/gsoc/, GSoC} is a global
888 program that offers students stipends to write code for free software
889 and open source projects during the summer.  It is an excellent
890 opportunity for students to gain experience with real-world software
891 development and make a contribution that benefits everyone.  It brings
892 new contributors to LilyPond and enables students who are already
893 involved to become more involved.  LilyPond participates in GSoC as part
894 of the @uref{http://www.gnu.org/, GNU project}.
895
896 We have had GSoC participants in 2012 and 2015 and encourage students to
897 apply for future summers.
898
899 If you have questions or would like to apply, send us an email on our
900 developer mailing list (see @ref{Contact}).
901
902 @divEnd
903
904 @divClass{column-center-middle-color2}
905 @subheading Project Ideas List
906
907 Below is a list of suggested projects for GSoC or for anyone who is
908 interested in helping to improve LilyPond. (Last updated: February 2016)
909
910 Mentor availability varies from project to project and from year to year.
911 Send us an email on our developer mailing list (see @ref{Contact}), and
912 we will help you find a mentor for a project that fits your interests
913 and skills.
914
915 If you have ideas for a GSoC project that is not listed below you can
916 send us an email as well.  There are a number of areas where LilyPond
917 could be improved, and our development team is always willing to help
918 those who would like to tackle a project like those listed below.
919
920 A full list of all the current open issues can be found
921 @uref{http://sourceforge.net/p/testlilyissues/issues/, here}.
922
923 @divEnd
924
925 @divClass{column-center-middle-color3}
926 @subheading Improve internal chord structure
927
928 The internal representation of LilyPond chords is not powerful enough
929 to capture the nomenclature of jazz chords.  Currently the chord has
930 a root, a bass and an inversion.  It would be nice to be able to handle
931 stacked or polychords, minor/major, etc.  In order to do this, an
932 internal representation with the ability to capture the essence of
933 complex chords must be developed.  As a bonus, once the internal
934 representation is developed, the output formatting of chord names can
935 be improved.
936
937 @strong{Difficulty:} Easy/medium
938 @strong{Requirements:} Scheme (Guile), but the level necessary can be
939 easily learned
940 @strong{Recommended:} Chord theory and naming
941 @strong{Mentor:} Carl Sorensen
942
943 @divEnd
944
945 @divClass{column-center-middle-color3}
946 @subheading ScholarLY
947
948 ScholarLY is a library in
949 @uref{https://openlilylib.org, openLilyLib} that provides functionality
950 for annotating scores, making it possible to manage scholarly workflows
951 completely in the context of the score document.  So far it is possible
952 to enter annotations of different types, produce clickable messages in
953 the console output and export to text and LaTeX files.
954
955 There are numerous feature requests to turn this library into an
956 even more powerful and comprehensive tool.  Some examples: Inserting
957 music examples, producing footnotes, automatically applying styles
958 to the annotated item (e.g. dash a slur, parenthesize an accidental),
959 creating reports with point-and-click entries.  For a full description
960 of this project suggestion please visit
961 @uref{https://github.com/openlilylib/scholarly/wiki/GSoC, this Wiki page}.
962
963 @strong{Difficulty:} medium
964 @strong{Requirements:} Scheme, possibly LaTeX, (optionally Python)
965 @strong{Recommended:} Experience with or interest in scholarly
966 edition and collaborative workflows.
967 @strong{Mentor:} Urs Liska
968
969 @divEnd
970
971 @divClass{column-center-middle-color3}
972 @subheading Adding variants of font glyphs
973
974 @divClass{keep-bullets}
975 @itemize
976
977 @item
978 Adding @q{on} and @q{between} staff-line variants.
979
980 @item
981 Shorter and narrower variants of some glyphs for example, accidentals.
982 Another, more specific example could be an ancient notation breve
983 notehead coming in two variants one with a small or big @q{hole} within
984 it.
985
986 @end itemize
987 @divEnd
988
989 @strong{Difficulty:} easy
990 @strong{Requirements:} MetaFont, C++, good eye for details
991 @strong{Recommended knowledge:} basic LilyPond knowledge
992 @strong{Mentor:} Werner Lemberg
993
994 @divEnd
995
996 @divClass{column-center-middle-color3}
997 @subheading Grace notes
998
999 Fix problems with synchronization of grace notes.  Grace notes can
1000 interfere with LilyPond's timing and cause odd effects, especially when
1001 multiple staffs are used where some have grace notes and others don't.
1002 This is one of the longest-standing and one of the more embarrassing
1003 @uref{https://sourceforge.net/p/testlilyissues/issues/34/,bugs} in
1004 LilyPond.
1005
1006 @strong{Difficulty:} medium
1007 @strong{Requirements:} C++, MIDI
1008 @strong{Recommended:} familiarity with LilyPond internals
1009 @strong{Potential Mentors:} Mike Solomon (not available for GSoC 2016),
1010 Carl Sorensen
1011
1012 @divEnd
1013
1014 @divClass{column-center-middle-color3}
1015 @subheading Improve default beam positioning
1016
1017 For regular, cross-staff, broken and kneed beams.  Beaming should depend
1018 on context and neighbor notes (see section 2.2 of
1019 @uref{http://imslp.org/wiki/Repository_of_Music-Notation_Mistakes_%28Coulon%2C_Jean-Pierre%29,
1020 this book}).  If possible also reduce beaming-computation time.
1021
1022 @strong{Difficulty:} medium
1023 @strong{Requirements:} C++, experience with writing heuristics
1024 @strong{Recommended knowledge:} aesthetic sense
1025 @strong{Potential Mentors:} Mike Solomon (not available for GSoC 2016),
1026 Carl Sorensen
1027
1028 @divEnd
1029
1030 @divClass{column-center-middle-color3}
1031 @subheading Allow spanners to cross voices
1032
1033 Currently all sorts of spanners (ties, slurs, dynamics, text spanners,
1034 trills etc.) have to be ended in the context they were started.  However,
1035 this doesn't reflect the reality of notation in most polyphonic settings.
1036 Awkward workarounds with hidden voices are currently necessary to achieve
1037 cross-voice spanners.
1038
1039 New ways of addressing this issue should be explored, for example by
1040
1041 @divClass{keep-bullets}
1042 @itemize
1043
1044 @item specifying a â€œtarget context” where the end of the spanner is
1045 expected
1046
1047 @item explicitly specifying the ending object with an ID
1048
1049 @end itemize
1050 @divEnd
1051
1052 This feature would solve many problems that are commonly faced with
1053 piano music and combined parts. 
1054
1055 @strong{Difficulty:} medium (?)
1056 @strong{Requirements:} C++, Scheme
1057 @strong{Potential Mentor:} Urs Liska
1058 @divEnd
1059
1060 @divClass{column-center-middle-color3}
1061 @subheading Help improve compilation behavior
1062
1063 Automatic code analysis tools, like valgrind memory leak detection or
1064 callgrind code profilers, provide valuable information about possible
1065 flaws in our C++ code.  Cleaning up warnings would allow us to automate
1066 the rejection of any patch which introduced extra warnings.
1067
1068 @strong{Difficulty:} medium
1069 @strong{Requirements:} C++
1070 @strong{Potential Mentors:} Reinhold Kainhofer (not available for GSoC
1071 2016), Joe Neeman
1072
1073 @divEnd
1074
1075 @divClass{column-center-middle-color3}
1076 @subheading MusicXML
1077
1078 Improving MusicXML import and export functions:
1079
1080 @divClass{keep-bullets}
1081 @itemize
1082
1083 @item
1084 Handle basic musical content export like the MIDI export (i.e. using
1085 dedicated exporter classes, derived from the translator class).
1086
1087 @item
1088 Build the XML tree of the basic musical content, add a connection from
1089 music event to XML tag.
1090
1091 @item
1092 Let all LilyPond engravers do their job.
1093
1094 @item
1095 Link each output object (i.e. each stencil or group of stencils) to the
1096 music cause (and thus to the XML tag in the XML tree).
1097
1098 @item
1099 Add an XML output backend, which can then add layout information for
1100 each output object to the XML tags.
1101
1102 @end itemize
1103 @divEnd
1104
1105 There are several possibilities for this project, including building upon
1106 the MusicXML export project from GSoC 2015.
1107
1108 @strong{Difficulty:} medium
1109 @strong{Requirements:} MusicXML, Python, Scheme, basic LilyPond knowledge
1110 @strong{Potential Mentors:} Reinhold Kainhofer, Mike Solomon (both not
1111 available for GSoC 2016)
1112
1113 Familiarity with other scorewriters (for cross-testing) would also help.
1114
1115 @divEnd
1116
1117 @divClass{column-center-middle-color3}
1118 @subheading Improve slurs and ties
1119
1120 The engraving quality of slurs and ties is often unsatisfactory. Ties
1121 @q{broken} by clef or staff changes are not handled well.  The project
1122 could include collecting and sorting examples of bad output, deciding on
1123 the intended output and writing code to improve them.
1124
1125 @strong{Difficulty:} hard
1126 @strong{Requirements:} C++, experience with writing heuristics
1127 @strong{Recommended knowledge:} LilyPond knowledge, aesthetic sense
1128 @strong{Potential Mentors:} Mike Solomon, Janek WarchoĊ‚ (both not available for
1129 GSoC 2016)
1130
1131 @divEnd
1132
1133
1134 @node Authors
1135 @unnumberedsec Authors
1136
1137 @divClass{column-left-top}
1138 @subheading Current Development Team
1139
1140 @divClass{keep-bullets}
1141 @developersCurrent
1142 @divEnd
1143 @divEnd
1144
1145 @divClass{column-right-top}
1146 @subheading Previous Development Team
1147
1148 @divClass{keep-bullets}
1149 @developersPrevious
1150 @divEnd
1151 @divEnd
1152
1153
1154 @divClass{column-center-top}
1155 @subheading Current Contributors
1156
1157 @divClass{keep-bullets}
1158 @subsubheading Programming
1159
1160 @coreCurrent
1161
1162 @subsubheading Font
1163
1164 @fontCurrent
1165
1166 @subsubheading Documentation
1167
1168 @docCurrent
1169
1170 @subsubheading Bug squad
1171
1172 @bugsquadCurrent
1173
1174 @subsubheading Support
1175
1176 @supportCurrent
1177
1178 @subsubheading Translation
1179
1180 @translationsCurrent
1181
1182 @divEnd
1183 @divEnd
1184
1185
1186 @divClass{column-center-bottom}
1187 @subheading Previous Contributors
1188
1189 @divClass{keep-bullets}
1190 @subsubheading Programming
1191
1192 @corePrevious
1193
1194 @subsubheading Font
1195
1196 @fontPrevious
1197
1198 @subsubheading Documentation
1199
1200 @docPrevious
1201
1202 @c    uncomment when we have any previous members -gp
1203 @c @subsubheading Bug squad
1204
1205 @c @bugsquadCurrent
1206
1207 @subsubheading Support
1208
1209 @supportPrevious
1210
1211 @subsubheading Translation
1212
1213 @translationsPrevious
1214
1215 @divEnd
1216 @divEnd
1217
1218 @node Acknowledgements
1219 @unnumberedsec Acknowledgements
1220
1221 @divClass{column-center-top}
1222 @subheading Acknowledgements
1223
1224 @divClass{keep-bullets}
1225 @acknowledgementsCurrent
1226 @divEnd
1227 @divEnd
1228
1229
1230 @node Publications
1231 @unnumberedsec Publications
1232
1233 @divClass{column-center-top}
1234 @subheading What we wrote about LilyPond
1235
1236 @divClass{keep-bullets}
1237
1238 @include we-wrote.itexi
1239
1240 @divEnd
1241 @divEnd
1242
1243 @divClass{column-center-bottom}
1244 @subheading What people did with LilyPond
1245
1246 @divClass{keep-bullets}
1247
1248 @include others-did.itexi
1249
1250 @divEnd
1251 @divEnd
1252
1253 @contactUsAbout{academic papers}
1254
1255
1256 @node News
1257 @unnumberedsec News
1258
1259 @divClass{heading-center}
1260 @warning{Many old announcements and changelogs can be found in
1261 the @ref{Attic}}
1262 @divEnd
1263
1264 @include web/news-front.itexi
1265
1266 @include web/news.itexi
1267
1268
1269 @node Attic
1270 @unnumberedsec Attic
1271
1272 @divClass{column-center-top}
1273 @subheading Announcements
1274
1275 Announcements and news by version:
1276 @uref{http://lilypond.org/doc/v2.16/Documentation/web/index#Lilypond-2_002e16_002e0-released_0021-August-24_002c-2012-1,v2.16},
1277 @uref{http://lilypond.org/doc/v2.14/Documentation/web/index#LilyPond-2_002e14_002e0-released_0021-June-6_002c-2011,v2.14},
1278 @miscLink{announce-v2.12,v2.12},
1279 @miscLink{announce-v2.10,v2.10},
1280 @miscLink{announce-v2.8,v2.8},
1281 @miscLink{announce-v2.6,v2.6},
1282 @miscLink{announce-v2.4,v2.4},
1283 @miscLink{announce-v2.2,v2.2},
1284 @miscLink{announce-v2.0,v2.0},
1285 @miscLink{ANNOUNCE-1.2,v1.2},
1286 @miscLink{ANNOUNCE-1.0,v1.0},
1287 @miscLink{ANNOUNCE-0.1,v0.1}
1288
1289 Descriptive list of changes by version:
1290 @uref{http://lilypond.org/doc/v2.16/Documentation/changes/index.html,v2.16},
1291 @uref{http://lilypond.org/doc/v2.14/Documentation/changes/index.html,v2.14},
1292 @uref{http://lilypond.org/doc/v2.12/Documentation/topdocs/NEWS,v2.12},
1293 @uref{http://lilypond.org/doc/v2.10/Documentation/topdocs/NEWS,v2.10},
1294 @uref{http://lilypond.org/doc/v2.8/Documentation/topdocs/NEWS,v2.8},
1295 @uref{http://lilypond.org/doc/v2.6/Documentation/topdocs/NEWS,v2.6},
1296 @uref{http://lilypond.org/doc/v2.4/Documentation/topdocs/out-www/NEWS,v2.4},
1297 @uref{http://lilypond.org/doc/v2.2/Documentation/topdocs/out-www/NEWS,v2.2},
1298 @uref{http://lilypond.org/doc/v2.0/Documentation/topdocs/out-www/NEWS,v2.0},
1299 @uref{http://lilypond.org/doc/v1.8/Documentation/topdocs/out-www/NEWS,v1.8},
1300 @uref{http://lilypond.org/doc/v1.6/Documentation/out-www/NEWS,v1.6},
1301 @miscLink{NEWS-1.4,v1.4},
1302 @miscLink{NEWS-1.2,v1.2}
1303
1304 @divEnd
1305
1306 @divClass{column-center-bottom}
1307 @subheading Thanks
1308
1309 Thanks to developers, contributors, bug hunters and suggestions for
1310 @miscLink{THANKS-2.16,v2.16},
1311 @miscLink{THANKS-2.14,v2.14},
1312 @miscLink{THANKS-2.12,v2.12},
1313 @miscLink{THANKS-2.10,v2.10},
1314 @miscLink{THANKS-2.8,v2.8},
1315 @miscLink{THANKS-2.6,v2.6},
1316 @miscLink{THANKS-2.4,v2.4},
1317 @miscLink{THANKS-2.2,v2.2},
1318 @miscLink{THANKS-2.0,v2.0},
1319 @miscLink{THANKS-1.8,v1.8}
1320
1321 @divEnd
1322
1323 @divClass{column-center-bottom}
1324 @subheading Changelogs
1325
1326 Developers' changelogs by version:
1327 @miscLink{ChangeLog-2.10,v2.10},
1328 @miscLink{ChangeLog-2.3,v2.3},
1329 @miscLink{ChangeLog-2.1,v2.1},
1330 @miscLink{ChangeLog-1.5,v1.5 (1)},
1331 @miscLink{CHANGES-1.5,v1.5 (2)},
1332 @miscLink{CHANGES-1.4,v1.4},
1333 @miscLink{CHANGES-1.3,v1.3},
1334 @miscLink{CHANGES-1.2,v1.2},
1335 @miscLink{CHANGES-1.1,v1.1},
1336 @miscLink{CHANGES-1.0,v1.0},
1337 @miscLink{CHANGES-0.1,v0.1},
1338 @miscLink{CHANGES-0.0,v0.0}
1339
1340 @divEnd