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