Documentation/general/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.  See TRANSLATION for details.
   7 @end ignore
   8
   9 @node Community
  10 @unnumbered Community
  11
  12
  13 @divClass{column-center-top}
  14 @subheading Interacting with the community
  15
  16 @itemize
  17
  18 @item
  19 @ref{Contact}: get help, discuss, and keep in touch!
  20
  21 @item
  22 @ref{Tiny examples}: these are @emph{highly} recommended when
  23 discussing LilyPond.
  24
  25 @item
  26 @ref{Bug reports}: something went wrong.
  27
  28 @end itemize
  29 @divEnd
  30
  31 @divClass{column-left-bottom}
  32 @subheading Making LilyPond better
  33
  34 @itemize
  35
  36 @item
  37 @ref{Help us}: your assistance is requested.
  38
  39 @item
  40 @ref{Development}: for contributors and testers.
  41
  42 @item
  43 @ref{Authors}: the people who made LilyPond what it is today.
  44
  45 @end itemize
  46 @divEnd
  47
  48 @divClass{column-right-bottom}
  49 @subheading Miscellaneous
  50
  51 @itemize
  52
  53 @item
  54 @ref{Publications}: what we wrote, and have had written about us.
  55
  56 @item
  57 @ref{Old news}: an archive.
  58
  59 @end itemize
  60 @divEnd
  61
  62
  63 @divClass{hide}
  64 @menu
  65 * Contact::
  66 * Tiny examples::
  67 * Bug reports::
  68 * Help us::
  69 * Development::
  70 * Authors::
  71 * Publications::
  72 * Old news::
  73 @end menu
  74 @divEnd
  75
  76
  77 @node Contact
  78 @unnumberedsec Contact
  79
  80
  81 @divClass{column-left-bottom}
  82 @subheading User Discussions and Help
  83
  84 @subsubheading User mailist: @code{lilypond-user@@gnu.org}
  85
  86 This mailist is the main place for users to discuss and help each
  87 other.
  88
  89 @quotation
  90 @uref{http://mail.gnu.org/mailman/listinfo/lilypond-user,
  91 lilypond-user subscribe and info}
  92
  93 @uref{http://mail.gnu.org/archive/html/lilypond-user/,
  94 user archive1}
  95 @uref{http://www.mail-archive.com/lilypond-user@@gnu.org/,
  96 archive2}
  97 @uref{http://dir.gmane.org/gmane.comp.gnu.lilypond.general,
  98 archive3}
  99
 100 @uref{http://post.gmane.org/post.php?group=gmane.comp.gnu.lilypond.general,
 101 send to lilypond-user with gmane}
 102 @end quotation
 103
 104 @warning{When asking questions, please use @ref{Tiny examples}!}
 105
 106
 107 @subsubheading IRC
 108
 109 Some level of support is provided on our IRC channel,
 110
 111 @example
 112 @uref{irc://irc.freenode.net/lilypond, #lilypond@@irc.freenode.net}
 113 @end example
 114
 115 This channel has no public archive, so any question that may
 116 be useful for others would better be posted to one of the mailing lists.
 117
 118
 119 @subsubheading Other languages
 120
 121 @uref{http://es.groups.yahoo.com/group/lilypond-es,
 122 Spanish yahoo group}
 123
 124 @uref{http://www.lilypondforum.de/,
 125 German forum}
 126
 127 @uref{http://groups.google.com/group/lilypond-brasil,
 128 Portugese group}
 129
 130 @uref{http://lists.gnu.org/mailman/listinfo/lilypond-user-fr,
 131 French mailist}
 132
 133 @uref{http://www.lilypondforum.nl/,
 134 Dutch forum}
 135
 136 @divEnd
 137
 138
 139 @divClass{column-right-top}
 140 @subheading Stay Informed
 141
 142 @subsubheading LilyPond Report
 143
 144 The easiest way to keep touch is by reading our community
 145 newsletter, the @uref{http://news.lilynet.net/, LilyPond Report}.
 146
 147 @subsubheading Releases mailist: @code{info-lilypond@@gnu.org}
 148
 149 This mailist is a low-volume, read-only list which receives
 150 notifications of new releases.
 151
 152 @quotation
 153 @uref{http://lists.gnu.org/mailman/listinfo/info-lilypond,
 154 info-lilypond subscribe and info}
 155
 156 @uref{http://mail.gnu.org/archive/html/info-lilypond/,
 157 info archive1}
 158 @uref{http://www.mail-archive.com/info-lilypond@@gnu.org/,
 159 archive2}
 160 @uref{http://dir.gmane.org/gmane.comp.gnu.lilypond.announce,
 161 archive3}
 162
 163 @c don't include gmane posting here.  -gp
 164 @end quotation
 165
 166
 167 @divEnd
 168
 169
 170 @divClass{column-right-bottom}
 171 @subheading Developer Discussion
 172
 173 @subsubheading Developer mailist: @code{lilypond-devel@@gnu.org}
 174
 175 Most developer discussion takes place on this list.  Patches
 176 should be sent here.
 177
 178 @quotation
 179 @uref{http://mail.gnu.org/mailman/listinfo/lilypond-devel,
 180 lilypond-devel subscribe and info}
 181
 182 @uref{http://mail.gnu.org/archive/html/lilypond-devel/,
 183 devel archive1}
 184 @uref{http://www.mail-archive.com/lilypond-devel@@gnu.org/,
 185 archive2}
 186 @uref{http://dir.gmane.org/gmane.comp.gnu.lilypond.devel,
 187 archive3}
 188
 189 @uref{http://post.gmane.org/post.php?group=gmane.comp.gnu.lilypond.devel,
 190 send to lilypond-devel with gmane}
 191 @end quotation
 192
 193
 194 @subsubheading Bug mailist: @code{bug-lilypond@@gnu.org}
 195
 196 Bug-specific discussion takes place here.
 197
 198 @quotation
 199 @uref{http://mail.gnu.org/mailman/listinfo/bug-lilypond,
 200 bug-lilypond subscribe and info}
 201
 202 @uref{http://mail.gnu.org/archive/html/bug-lilypond/,
 203 bug archive1}
 204 @uref{http://www.mail-archive.com/bug-lilypond@@gnu.org/,
 205 archive2}
 206 @uref{http://dir.gmane.org/gmane.comp.gnu.lilypond.bugs,
 207 archive3}
 208
 209 @c don't include gmane posting here.  -gp
 210 @end quotation
 211
 212 @warning{Before sending a message to the bug list, please read our
 213 guidelines for @ref{Bug reports}.}
 214
 215 @divEnd
 216
 217
 218
 219
 220
 221 @node Tiny examples
 222 @unnumberedsec Tiny examples
 223
 224 @divClass{column-center-top}
 225 @subheading What are @qq{Tiny examples}?
 226
 227 A tiny example is an example from which nothing can be removed.
 228
 229 These used to be called @qq{minimal examples}.
 230 @divEnd
 231
 232 @divClass{column-left-bottom}
 233 @subheading Why create them?
 234
 235 @divClass{keep-bullets}
 236 @itemize
 237
 238 @item
 239 The simpler the example is, the quicker potential helpers can
 240 understand it and help you.
 241
 242 @item
 243 A simple example demonstrates that you have put effort towards
 244 solving the problem yourself.  When people send huge portions of
 245 input, it looks like they don't care how if we help them or not.
 246
 247 @item
 248 Creating a tiny example forces you to understand what is
 249 happening.  Many false problem reports can be avoided by
 250 attempting to create a tiny example; if you cannot replicate a
 251 @qq{bug} in a tiny example, then the problem was probably an
 252 insufficient understanding of LilyPond, not an actual bug!
 253
 254 @end itemize
 255 @divEnd
 256
 257 @divEnd
 258
 259
 260 @divClass{column-right-bottom}
 261 @subheading How do I create them?
 262
 263 @divClass{keep-bullets}
 264 @itemize
 265
 266 @item
 267 Include the \version number.
 268
 269 @item
 270 Make it small!  Examples about spacing or page layout might
 271 require many bars of music, but most issues can be reproduced
 272 using only a single measure.
 273
 274 @item
 275 When trying to create an example, try commenting out @w{(@code{%}
 276 or @code{%@{ @dots{} %@}})} sections of your file.  If you can
 277 comment something while still demonstrating the main idea, then
 278 remove the commented-material!
 279
 280 @item
 281 Avoid using complicated notes, keys, or time signatures, unless
 282 the bug is about the behavior of those items.
 283
 284 @item
 285 Do not use @code{\override} or @code{\set} commands unless the bug
 286 is about those particular commands.
 287
 288 @end itemize
 289 @divEnd
 290
 291 @divEnd
 292
 293
 294
 295
 296 @node Bug reports
 297 @unnumberedsec Bug reports
 298
 299 @divClass{column-center-top}
 300 @subheading Step 1: Known bugs
 301
 302 If you have input that results in a crash or an erroneous output,
 303 then that is a bug.  There is a list of current bugs on our google
 304 bug tracker,
 305
 306 @example
 307 @uref{http://code.google.com/p/lilypond/issues/list}
 308 @end example
 309
 310 @warning{Please @strong{DO NOT} add bug reports directly to the
 311 bug tracker.  Once an issue has been added to the tracker, feel
 312 free to add more information to that report.}
 313
 314 @divEnd
 315
 316
 317 @divClass{column-left-bottom}
 318 @subheading Step 2: Creating a bug report
 319
 320 If you have discovered a bug which is not listed, please help us
 321 by creating a bug report.
 322
 323 @warning{We only accept bug reports in the form of @ref{Tiny
 324 examples}.  We have very limited resources to deal with bug
 325 reports, so any non-minimal example will be rejected.  Almost
 326 every bug can be demonstrated in four notes or less!}
 327
 328 Here is an example of a good bug report:
 329
 330 @example
 331 %% the octavation command doesn't
 332 %% change the output at all!
 333
 334 \version "2.10.0"
 335 \paper@{ ragged-right=##t @}
 336 \relative c''' @{
 337   c1
 338   #(set-octavation 1)
 339   c1
 340 @}
 341 @end example
 342
 343 @divEnd
 344
 345 @divClass{column-right-bottom}
 346 @subheading Step 3: Sending a bug report
 347
 348 Once you have verified that the issue is not already known and
 349 created a bug report, please send it to us!
 350
 351 Unfortunately there is a strict @qq{no top-posting} check on the
 352 bug list, which is often incorrectly triggered by lilypond files.
 353 To avoid this, please add
 354
 355 @example
 356 > I'm not top posting.
 357 @end example
 358
 359 @noindent
 360 (you must include the @code{>} ) to the top of your bug report.
 361
 362 @uref{http://post.gmane.org/post.php?group=gmane.comp.gnu.lilypond.bugs,
 363 Post with the gmane lilypond.bugs interface}, or send an email to
 364 @uref{mailto:bug-lilypond@@gnu.prg, bug-lilypond@@gnu.org}.
 365
 366 Once your bug has been sent to the list, our Bug Meister will
 367 examine the report.  He may ask you for more information, or may
 368 add the report to the tracker and let you know what the issue
 369 number is.
 370
 371 You may mark the bug so that you automatically receive emails when
 372 any activity on the bug occurs.  This requires you have a google
 373 account.
 374 @divEnd
 375
 376
 377 @node Help us
 378 @unnumberedsec Help us
 379
 380 FIXME: before going live, rewrite this to apply to lilypond
 381 generally.  Right now it's (deliberately) website-specific.
 382
 383 @subheading This document
 384
 385 @subsubheading High priority / blocks release
 386
 387 - Features page.
 388
 389 - python: automatically insert latest version numbers into these
 390   pages.  Script already exists for the old website, but might
 391   (or might not!) require tweaking.
 392
 393 - translation infrastructure.
 394
 395 @subsubheading Low priority / may never
 396
 397 - perl: web-texi2html.pl needs to be un-hacked; I did things
 398   really messily.  Possibly even merge/share functions with
 399   the doc init.pl file?
 400
 401 - somebody to implement/work on a media=handheld CSS sheet
 402
 403 - remove the attributes from the <body> tag.  In general, clean up
 404   the HTML produced by texi2html
 405
 406
 407
 408 @node Development
 409 @unnumberedsec Development
 410
 411
 412 @divClass{heading-center}
 413 @heading Development materials for LilyPond 2.13.3
 414
 415 @warning{These are @emph{unstable development} versions.  If you
 416 have the slighest doubt about how to use or install LilyPond, we
 417 urge you to use the stable @ref{Download}, and read the stable
 418 @ref{Manuals}.}
 419
 420 @divEnd
 421
 422 @divClass{column-left-bottom}
 423 @subheading Download
 424
 425 @uref{http://download.linuxaudio.org/lilypond/binaries/linux-x86/lilypond-2.13.3-1.linux-x86.sh,
 426 lilypond-2.13.3-1.linux-x86.sh}
 427
 428 @uref{http://download.linuxaudio.org/lilypond/binaries/linux-64/lilypond-2.13.3-1.linux-64.sh,
 429 lilypond-2.13.3-1.linux-64.sh}
 430
 431 @uref{http://download.linuxaudio.org/lilypond/binaries/linux-ppc/lilypond-2.13.3-1.linux-ppc.sh,
 432 lilypond-2.13.3-1.linux-ppc.sh}
 433
 434 @uref{http://download.linuxaudio.org/lilypond/binaries/freebsd-x86/lilypond-2.13.3-1.freebsd-x86.sh,
 435 lilypond-2.13.3-1.freebsd-x86.sh}
 436
 437 @uref{http://download.linuxaudio.org/lilypond/binaries/freebsd-64/lilypond-2.13.3-1.freebsd-64.sh,
 438 lilypond-2.13.3-1.freebsd-64.sh}
 439
 440 @uref{
 441 http://download.linuxaudio.org/lilypond/binaries/darwin-x86/lilypond-2.13.3-1.darwin-x86.tar.bz2,
 442 lilypond-2.13.3-1.darwin-x86.tar.bz2}
 443
 444 @uref{
 445 http://download.linuxaudio.org/lilypond/binaries/darwin-x86/lilypond-2.13.3-1.darwin-ppc.tar.bz2,
 446 lilypond-2.13.3-1.darwin-ppc.tar.bz2}
 447
 448 @uref{
 449 http://download.linuxaudio.org/lilypond/binaries/mingw/lilypond-2.13.3-1.mingw.exe,
 450 lilypond-2.13.3-1.mingw-exe}
 451
 452
 453 @subheading Manuals
 454
 455 LM:
 456 @uref{lm-html, html}
 457 @uref{lm-pdf, pdf}
 458
 459 MG:
 460 @uref{mg-html, html}
 461 @uref{mg-pdf, pdf}
 462
 463 AE:
 464 @uref{ae-html, html}
 465 @uref{ae-pdf, pdf}
 466
 467 @smallspace
 468
 469 NR:
 470 @uref{nr-html, html}
 471 @uref{nr-pdf, pdf}
 472
 473 ...etc...
 474 SL-link
 475 AU-link
 476
 477 FAQ-link  (? maybe?)
 478 Changes-link
 479 IR-link
 480
 481 @divEnd
 482
 483
 484 @divClass{column-right-bottom}
 485 @subheading Contributors' Guide
 486
 487 FIXME write CG intro + links.
 488
 489 @divEnd
 490
 491
 492
 493 @node Authors
 494 @unnumberedsec Authors
 495
 496 combo of:
 497
 498 http://lilypond.org/web/about/thanks
 499
 500 Documentation/topdocs/AUTHORS.texi
 501
 502 and maybe:
 503 http://lilypond.org/web/switch/
 504
 505
 506
 507
 508 @node Publications
 509 @unnumberedsec Publications
 510
 511 @divClass{column-center-top}
 512
 513 @subheading What we wrote
 514
 515 @divClass{keep-bullets}
 516 @itemize
 517
 518 @item
 519 Han-Wen Nienhuys and Jan Nieuwenhuizen, @emph{LilyPond, a system
 520 for automated music engraving}.  Proceedings of the XIV Colloquium
 521 on Musical Informatics (XIV CIM 2003), Firenze, Italy, May 2003.
 522 (@uref{ http://lilypond.org/web/images/xivcim.pdf, PDF 95k})
 523
 524 @item
 525 Han-Wen Nienhuys, @emph{LilyPond, Automated music formatting and
 526 the Art of Shipping}.  Forum Internacional Software Livre 2006
 527 (FISL7.0) (@uref{http://lilypond.org/web/images/FISL7-slides.pdf,
 528 PDF 1095k})
 529
 530 @item
 531 Erik Sandberg, @emph{Separating input language and formatter in
 532 GNU Lilypond}. Master's Thesis, Uppsala University, Department of
 533 Information Technology March 2006.
 534 (@uref{http://lilypond.org/web/images/thesis-erik-sandberg.pdf,
 535 PDF 750k})
 536
 537 @end itemize
 538
 539 @divEnd
 540 @divEnd
 541
 542
 543 @divClass{column-center-bottom}
 544
 545 @subheading What others wrote
 546
 547 @divClass{keep-bullets}
 548 @itemize
 549
 550 @item
 551 February 2008
 552
 553 In @uref{http://www.musicbyandrew.ca/finale-lilypond-1.html,
 554 articles on his personal site}, Andrew Hawryluk compares Finale
 555 and LilyPond in general terms, and evaluates in detail engraving
 556 capabilities of both pieces of software.  The second article is an
 557 instructive analysis of Rachmaninoff's Piano Prelude 6 engraving,
 558 including comparisons with a reference hand-engraved edition.
 559
 560 @item
 561 December 2005
 562
 563 linux journal cover Linux Journal publishes an article titled
 564 @uref{http://www.linuxjournal.com/article/8364, Make Stunning
 565 Schenker Graphs with GNU LilyPond}.  It is a in-depth but hands-on
 566 feature article with crisp LilyPond graphics.  Author Kris Shaffer
 567 remarks “GNU Lilypond generates beautiful graphics that make
 568 commercial alternatives seem second-rate.”
 569
 570 @item
 571 August 20, 2005
 572
 573 The Belgian newspaper De Standaard investigates what drives Free
 574 Software authors in an article titled
 575 @uref{http://www.standaard.be/Artikel/Detail.aspx?artikelId=G42H5GD6,
 576 Delen van KENNIS zonder WINSTBEJAG} (Non-profit sharing of
 577 knowlegde) in its `DS2 bijlage'.  LilyPond is used as an example
 578 and the article is interspersed with quotes from an `email
 579 interview' with Jan Nieuwenhuizen. This marks LilyPond's first
 580 appearance in mainstream printed press.
 581
 582 @item
 583 June 2005
 584
 585 A French article on the LilyPond 2.6 release appeared on
 586 @uref{http://linuxfr.org/2005/06/27/19210.html, linuxfr.org}.
 587
 588 @item
 589 October 2004
 590
 591 The editors of Computer!Totaal, a Dutch computer magazine,
 592 @uref{http://lilypond.org/web/images/computer-totaal.jpeg,
 593 describe LilyPond} in the October 2004 issue as: @qq{Wonderful
 594 free (open source) software [..] The sheet music produced by
 595 LilyPond is exceptionally pretty [..] a very powerful system that
 596 can do almost anything.}
 597
 598 @item
 599 July, August 2004
 600
 601 Dave Phillips wrote an introductory article for Linux Journal At
 602 the sounding edge: LilyPond, parts
 603 @uref{http://www.linuxjournal.com/article/7657, one} and
 604 @uref{http://www.linuxjournal.com/article/7719, two}.
 605
 606 @item
 607 March 2004
 608
 609 Chris Cannam interviewed Han-Wen Nienhuys and Jan Nieuwenhuizen on
 610 linuxmusician.com (site now defunct). This interview was also
 611 reviewed in a
 612 @uref{http://slashdot.org/article.pl?sid=04/03/13/2054227&tid=,
 613 slashdot story}.
 614
 615 @item
 616 February 2004
 617
 618 Jazz singer Gail Selkirk writes about
 619 @uref{http://www.songbirdofswing.com/editorial_page/lilypond/,
 620 Diving into LilyPond}.  @qq{... you can make lead sheets or full
 621 orchestral parts, and the results can be stunning.}
 622 @uref{http://www.computermusic.co.uk/, Computer Music Special},
 623 issue CMS06.
 624
 625 @end itemize
 626
 627 @divEnd
 628 @divEnd
 629
 630
 631 @node Old news
 632 @unnumberedsec Old news
 633
 634 @include general/news.itexi