Documentation/macros.itexi

   1 @c -*- coding: us-ascii; 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
  10 @include version.itexi
  11 @include common-macros.itexi
  12
  13
  14 @c   ***** Displaying text *****
  15
  16 @c To get decent quotes in `foo' and ``foo''.
  17
  18 @macro q{TEXT}
  19 @quoteleft{}\TEXT\@quoteright{}
  20 @end macro
  21
  22 @macro qq{TEXT}
  23 @quotedblleft{}\TEXT\@quotedblright{}
  24 @end macro
  25
  26
  27 @ifhtml
  28
  29 @macro warning{TEXT}
  30 @html
  31 <div class="warning">
  32 @end html
  33 @strong{Note:} \TEXT\
  34 @html
  35 </div>
  36 @end html
  37 @end macro
  38
  39 @end ifhtml
  40
  41 @ifnothtml
  42
  43 @macro warning{TEXT}
  44 @quotation
  45 @quotation
  46 @cartouche
  47 @b{Note:} \TEXT\
  48 @end cartouche
  49 @end quotation
  50 @end quotation
  51 @end macro
  52
  53 @end ifnothtml
  54
  55
  56 @macro docMain
  57 @cartouche
  58 For more information about how this manual fits with the other
  59 documentation, or to read this manual in other formats, see
  60 @rgeneral{Manuals}.
  61
  62 If you are missing any manuals, the complete documentation can be
  63 found at @w{@uref{http://@/www@/.lilypond@/.org/}}.
  64 @end cartouche
  65 @end macro
  66
  67
  68 @macro lilyTitlePage{TITLE}
  69 @c  This produces the unified index
  70 @syncodeindex fn cp
  71 @syncodeindex vr cp
  72
  73 @afourpaper
  74
  75 @copying
  76 Copyright @copyright{} 1999, 2000, 2001, 2002, 2003, 2004, 2005,
  77 2006, 2007, 2008, 2009 by the authors.
  78
  79 @quotation
  80 Permission is granted to copy, distribute and/or modify this document
  81 under the terms of the GNU Free Documentation License, Version 1.1
  82 or any later version published by the Free Software Foundation;
  83 with no Invariant Sections.
  84 A copy of the license is included in the section entitled ``GNU
  85 Free Documentation License''.
  86 @end quotation
  87 @end copying
  88
  89
  90 @c TITLE PAGE
  91 @ifnottex
  92 @node Top
  93 @top LilyPond --- \TITLE\
  94
  95 @cartouche
  96 @manualIntro{}
  97 @end cartouche
  98 @end ifnottex
  99
 100 @finalout
 101
 102 @titlepage
 103 @title LilyPond
 104 @subtitle The music typesetter
 105 @titlefont{\TITLE\}
 106 @author The LilyPond development team
 107
 108 @vskip 60pt
 109
 110 @cartouche
 111 @manualIntro{}
 112 @end cartouche
 113
 114 @vskip 40pt
 115
 116 @docMain{}
 117
 118 @vskip 0pt plus 1filll
 119
 120 @insertcopying{}
 121
 122 For LilyPond version @version{}
 123 @end titlepage
 124
 125 @end macro
 126
 127
 128 @c   ***** Headings in a doc subsection *****
 129
 130 @c The next macro is a dummy currently since texinfo doesn't
 131 @c provide a real ragged-right environment yet.
 132 @c
 133 @c Don't insert an empty line after @predefined!  Right now
 134 @c it doesn't matter, but a future implementation will probably
 135 @c add some code which needs this restriction.
 136
 137 @macro predefined
 138 @noindent
 139 @subsubheading Predefined commands
 140 @end macro
 141
 142 @c Due to a bug in texi2html (texi2html.pl CVS versions <= 1.245)
 143 @c the next macro must not be empty.
 144
 145 @macro endpredefined
 146 @c
 147 @end macro
 148
 149
 150 @macro snippets
 151 @noindent
 152 @subsubheading Selected Snippets
 153 @end macro
 154
 155
 156 @c Don't insert an empty line after @seealso!  Otherwise we get
 157 @c unwanted extra vertical space in the PDF output.
 158
 159 @macro seealso
 160 @noindent
 161 @subsubheading See also
 162 @indent
 163 @end macro
 164
 165
 166 @macro knownissues
 167 @noindent
 168 @subsubheading Known issues and warnings
 169 @end macro
 170
 171
 172
 173 @c   ***** Links and references *****
 174
 175 @c  Definitions for references:
 176 @c
 177 @c     @rgeneral
 178 @c     @ressay
 179 @c     @rglos
 180 @c     @rinternals
 181 @c     @rlearning
 182 @c     @rlsr
 183 @c     @rprogram
 184 @c     @ruser
 185 @c     @rchanges
 186 @c     @rcontrib
 187 @c
 188 @c  All these also have a @...named version which allows to specify the
 189 @c  displayed text for the reference as second argument.
 190 @c
 191 @c ***** HTML + bigpage is a special case (other manual names); all other
 192 @c formats are treated similarly.
 193
 194
 195 @c *** not TeX ***
 196
 197 @ifnottex
 198
 199 @c ** bigpage **
 200
 201 @ifset bigpage
 202
 203 @macro rglos{TEXT}
 204 @vindex \TEXT\
 205 @ref{\TEXT\,,,music-glossary-big-page,Music Glossary}
 206 @end macro
 207
 208 @macro rglosnamed{TEXT,DISPLAY}
 209 @vindex \TEXT\
 210 @ref{\TEXT\,,\DISPLAY\,music-glossary-big-page,Music Glossary}
 211 @end macro
 212
 213 @macro rlearning{TEXT}
 214 @vindex \TEXT\
 215 @ref{\TEXT\,,,learning-big-page,Learning Manual}
 216 @end macro
 217
 218 @macro rlearningnamed{TEXT,DISPLAY}
 219 @vindex \TEXT\
 220 @ref{\TEXT\,,\DISPLAY\,learning-big-page,Learning Manual}
 221 @end macro
 222
 223 @macro ruser{TEXT}
 224 @vindex \TEXT\
 225 @ref{\TEXT\,,,notation-big-page,Notation Reference}
 226 @end macro
 227
 228 @macro rusernamed{TEXT,DISPLAY}
 229 @vindex \TEXT\
 230 @ref{\TEXT\,,\DISPLAY\,notation-big-page,Notation Reference}
 231 @end macro
 232
 233 @macro rchanges{TEXT}
 234 @vindex \TEXT\
 235 @ref{\TEXT\,,,changes-big-page,Changes}
 236 @end macro
 237
 238 @macro rchangesnamed{TEXT,DISPLAY}
 239 @vindex \TEXT\
 240 @ref{\TEXT\,,\DISPLAY\,changes-big-page,Changes}
 241 @end macro
 242
 243 @macro rcontrib{TEXT}
 244 @vindex \TEXT\
 245 @ref{\TEXT\,,,contributor-big-page,Contributor's Guide}
 246 @end macro
 247
 248 @macro rcontribnamed{TEXT,DISPLAY}
 249 @vindex \TEXT\
 250 @ref{\TEXT\,,\DISPLAY\,contributor-big-page,Contributor's Guide}
 251 @end macro
 252
 253 @macro rgeneral{TEXT}
 254 @vindex \TEXT\
 255 @ref{\TEXT\,,,general-big-page,General Information}
 256 @end macro
 257
 258 @macro rgeneralnamed{TEXT,DISPLAY}
 259 @vindex \TEXT\
 260 @ref{\TEXT\,,\DISPLAY\,general-big-page,General Information}
 261 @end macro
 262
 263 @macro ressay{TEXT}
 264 @vindex \TEXT\
 265 @ref{\TEXT\,,,essay-big-page,Essay}
 266 @end macro
 267
 268 @macro ressaynamed{TEXT,DISPLAY}
 269 @vindex \TEXT\
 270 @ref{\TEXT\,,\DISPLAY\,essay-big-page,Essay}
 271 @end macro
 272
 273 @macro rprogram{TEXT}
 274 @vindex \TEXT\
 275 @ref{\TEXT\,,,application-big-page,Application Usage}
 276 @end macro
 277
 278 @macro rprogramnamed{TEXT,DISPLAY}
 279 @vindex \TEXT\
 280 @ref{\TEXT\,,\DISPLAY\,application-big-page,Application Usage}
 281 @end macro
 282
 283 @macro rlsr{TEXT}
 284 @ref{\TEXT\,,,snippets-big-page,Snippets}
 285 @end macro
 286
 287 @macro rlsrnamed{TEXT,DISPLAY}
 288 @ref{\TEXT\,,\DISPLAY\,snippets-big-page,Snippets}
 289 @end macro
 290
 291 @macro rinternals{TEXT}
 292 @vindex \TEXT\
 293 @ref{\TEXT\,,,internals-big-page,Internals Reference}
 294 @end macro
 295
 296 @macro rinternalsnamed{TEXT,DISPLAY}
 297 @vindex \TEXT\
 298 @ref{\TEXT\,,\DISPLAY\,internals-big-page,Internals Reference}
 299 @end macro
 300
 301 @end ifset
 302
 303
 304 @c ** not bigpage **
 305
 306 @ifclear bigpage
 307
 308 @ifnotinfo
 309
 310 @macro rglos{TEXT}
 311 @vindex \TEXT\
 312 @ref{\TEXT\,,,music-glossary,Music Glossary}
 313 @end macro
 314
 315 @macro rglosnamed{TEXT,DISPLAY}
 316 @vindex \TEXT\
 317 @ref{\TEXT\,,\DISPLAY\,music-glossary,Music Glossary}
 318 @end macro
 319
 320 @macro rlearning{TEXT}
 321 @vindex \TEXT\
 322 @ref{\TEXT\,,,learning,Learning Manual}
 323 @end macro
 324
 325 @macro rlearningnamed{TEXT,DISPLAY}
 326 @vindex \TEXT\
 327 @ref{\TEXT\,,,learning,Learning Manual}
 328 @end macro
 329
 330 @macro ruser{TEXT}
 331 @vindex \TEXT\
 332 @ref{\TEXT\,,,notation,Notation Reference}
 333 @end macro
 334
 335 @macro rusernamed{TEXT,DISPLAY}
 336 @vindex \TEXT\
 337 @ref{\TEXT\,,\DISPLAY\,notation,Notation Reference}
 338 @end macro
 339
 340 @macro rchanges{TEXT}
 341 @vindex \TEXT\
 342 @ref{\TEXT\,,,changes,Changes}
 343 @end macro
 344
 345 @macro rchangesnamed{TEXT,DISPLAY}
 346 @vindex \TEXT\
 347 @ref{\TEXT\,,\DISPLAY\,changes,Changes}
 348 @end macro
 349
 350 @macro rcontrib{TEXT}
 351 @vindex \TEXT\
 352 @ref{\TEXT\,,,contributor,Contributor's Guide}
 353 @end macro
 354
 355 @macro rcontribnamed{TEXT,DISPLAY}
 356 @vindex \TEXT\
 357 @ref{\TEXT\,,\DISPLAY\,contributor,Contributor's Guide}
 358 @end macro
 359
 360 @macro rgeneral{TEXT}
 361 @vindex \TEXT\
 362 @ref{\TEXT\,,,general,General Information}
 363 @end macro
 364
 365 @macro rgeneralnamed{TEXT,DISPLAY}
 366 @vindex \TEXT\
 367 @ref{\TEXT\,,\DISPLAY\,general,General Information}
 368 @end macro
 369
 370 @macro ressay{TEXT}
 371 @vindex \TEXT\
 372 @ref{\TEXT\,,,essay,Essay}
 373 @end macro
 374
 375 @macro ressaynamed{TEXT,DISPLAY}
 376 @vindex \TEXT\
 377 @ref{\TEXT\,,\DISPLAY\,essay,Essay}
 378 @end macro
 379
 380 @macro rprogram{TEXT}
 381 @vindex \TEXT\
 382 @ref{\TEXT\,,,application,Application Usage}
 383 @end macro
 384
 385 @macro rprogramnamed{TEXT,DISPLAY}
 386 @vindex \TEXT\
 387 @ref{\TEXT\,,\DISPLAY\,application,Application Usage}
 388 @end macro
 389
 390 @macro rlsr{TEXT}
 391 @ref{\TEXT\,,,snippets,Snippets}
 392 @end macro
 393
 394 @macro rlsrnamed{TEXT,DISPLAY}
 395 @ref{\TEXT\,,\DISPLAY\,snippets,Snippets}
 396 @end macro
 397
 398 @macro rinternals{TEXT}
 399 @vindex \TEXT\
 400 @ref{\TEXT\,,,internals,Internals Reference}
 401 @end macro
 402
 403 @macro rinternalsnamed{TEXT,DISPLAY}
 404 @vindex \TEXT\
 405 @ref{\TEXT\,,\DISPLAY\,internals,Internals Reference}
 406 @end macro
 407
 408 @end ifnotinfo
 409
 410 @ifinfo
 411
 412 @macro rglos{TEXT}
 413 @vindex \TEXT\
 414 @ref{\TEXT\,,,music-glossary,Music Glossary}
 415 @end macro
 416
 417 @macro rglosnamed{TEXT,DISPLAY}
 418 @vindex \TEXT\
 419 @ref{\TEXT\,,\DISPLAY\,music-glossary,Music Glossary}
 420 @end macro
 421
 422 @macro rlearning{TEXT}
 423 @vindex \TEXT\
 424 @ref{\TEXT\,,,lilypond-learning,Learning Manual}
 425 @end macro
 426
 427 @macro rlearningnamed{TEXT,DISPLAY}
 428 @vindex \TEXT\
 429 @ref{\TEXT\,,,lilypond-learning,Learning Manual}
 430 @end macro
 431
 432 @macro ruser{TEXT}
 433 @vindex \TEXT\
 434 @ref{\TEXT\,,,lilypond-notation,Notation Reference}
 435 @end macro
 436
 437 @macro rusernamed{TEXT,DISPLAY}
 438 @vindex \TEXT\
 439 @ref{\TEXT\,,\DISPLAY\,lilypond-notation,Notation Reference}
 440 @end macro
 441
 442 @macro rchanges{TEXT}
 443 @vindex \TEXT\
 444 @ref{\TEXT\,,,lilypond-changes,Changes}
 445 @end macro
 446
 447 @macro rchangesnamed{TEXT,DISPLAY}
 448 @vindex \TEXT\
 449 @ref{\TEXT\,,\DISPLAY\,lilypond-changes,Changes}
 450 @end macro
 451
 452 @macro rcontrib{TEXT}
 453 @vindex \TEXT\
 454 @ref{\TEXT\,,,lilypond-contributor,Contributor's Guide}
 455 @end macro
 456
 457 @macro rcontribnamed{TEXT,DISPLAY}
 458 @vindex \TEXT\
 459 @ref{\TEXT\,,\DISPLAY\,lilypond-contributor,Contributor's Guide}
 460 @end macro
 461
 462 @macro rgeneral{TEXT}
 463 @vindex \TEXT\
 464 @ref{\TEXT\,,,lilypond-general,General Information}
 465 @end macro
 466
 467 @macro rgeneralnamed{TEXT,DISPLAY}
 468 @vindex \TEXT\
 469 @ref{\TEXT\,,\DISPLAY\,lilypond-general, General Information}
 470 @end macro
 471
 472 @macro ressay{TEXT}
 473 @vindex \TEXT\
 474 @ref{\TEXT\,,,lilypond-essay,Essay}
 475 @end macro
 476
 477 @macro ressaynamed{TEXT,DISPLAY}
 478 @vindex \TEXT\
 479 @ref{\TEXT\,,\DISPLAY\,lilypond-essay,Essay}
 480 @end macro
 481
 482 @macro rprogram{TEXT}
 483 @vindex \TEXT\
 484 @ref{\TEXT\,,,lilypond-application,Application Usage}
 485 @end macro
 486
 487 @macro rprogramnamed{TEXT,DISPLAY}
 488 @vindex \TEXT\
 489 @ref{\TEXT\,,\DISPLAY\,lilypond-application,Application Usage}
 490 @end macro
 491
 492 @macro rlsr{TEXT}
 493 @ref{\TEXT\,,,lilypond-snippets,Snippets}
 494 @end macro
 495
 496 @macro rlsrnamed{TEXT,DISPLAY}
 497 @ref{\TEXT\,,\DISPLAY\,lilypond-snippets,Snippets}
 498 @end macro
 499
 500 @macro rinternals{TEXT}
 501 @vindex \TEXT\
 502 @ref{\TEXT\,,,lilypond-internals,Internals Reference}
 503 @end macro
 504
 505 @macro rinternalsnamed{TEXT,DISPLAY}
 506 @vindex \TEXT\
 507 @ref{\TEXT\,,\DISPLAY\,lilypond-internals,Internals Reference}
 508 @end macro
 509
 510 @end ifinfo
 511
 512 @end ifclear
 513
 514 @end ifnottex
 515
 516
 517 @c *** TeX ***
 518
 519 @iftex
 520
 521 @c All commands below should work in the middle of the line;
 522 @c we thus must not use @vindex directly since it works only if placed
 523 @c on a line of its own.  To overcome this problem, we define a
 524 @c replacement macro using the internal definition of @vindex which
 525 @c delimits arguments in the standard way (i.e., with braces).
 526
 527 @tex
 528 \gdef\lilyvindex#1{\doind{vr}{\code #1}\ignorespaces}
 529 @end tex
 530
 531 @macro rglos{TEXT}
 532 @lilyvindex{\TEXT\}
 533 @ref{\TEXT\,,,music-glossary,Music Glossary}
 534 @end macro
 535
 536 @macro rglosnamed{TEXT,DISPLAY}
 537 @lilyvindex{\TEXT\}
 538 @ref{\TEXT\,,\DISPLAY\,music-glossary,Music Glossary}
 539 @end macro
 540
 541 @macro rlearning{TEXT}
 542 @lilyvindex{\TEXT\}
 543 @ref{\TEXT\,,,learning,Learning Manual}
 544 @end macro
 545
 546 @macro rlearningnamed{TEXT,DISPLAY}
 547 @lilyvindex{\TEXT\}
 548 @ref{\TEXT\,,\DISPLAY\,learning,Learning Manual}
 549 @end macro
 550
 551 @macro ruser{TEXT}
 552 @lilyvindex{\TEXT\}
 553 @ref{\TEXT\,,,notation,Notation Reference}
 554 @end macro
 555
 556 @macro rusernamed{TEXT,DISPLAY}
 557 @lilyvindex{\TEXT\}
 558 @ref{\TEXT\,,\DISPLAY\,notation,Notation Reference}
 559 @end macro
 560
 561 @macro rchanges{TEXT}
 562 @lilyvindex{\TEXT\}
 563 @ref{\TEXT\,,,changes,Changes}
 564 @end macro
 565
 566 @macro rchangesnamed{TEXT,DISPLAY}
 567 @lilyvindex{\TEXT\}
 568 @ref{\TEXT\,,\DISPLAY\,changes,Changes}
 569 @end macro
 570
 571 @macro rcontrib{TEXT}
 572 @lilyvindex{\TEXT\}
 573 @ref{\TEXT\,,,contributor,Contributor's Guide}
 574 @end macro
 575
 576 @macro rcontribnamed{TEXT,DISPLAY}
 577 @lilyvindex{\TEXT\}
 578 @ref{\TEXT\,,\DISPLAY\,contributor,Contributor's Guide}
 579 @end macro
 580
 581 @macro rgeneral{TEXT}
 582 @lilyvindex{\TEXT\}
 583 @ref{\TEXT\,,,general,General Information}
 584 @end macro
 585
 586 @macro rgeneralnamed{TEXT,DISPLAY}
 587 @lilyvindex{\TEXT\}
 588 @ref{\TEXT\,,\DISPLAY\,general,General Information}
 589 @end macro
 590
 591 @macro ressay{TEXT}
 592 @lilyvindex{\TEXT\}
 593 @ref{\TEXT\,,,essay,Essay}
 594 @end macro
 595
 596 @macro ressaynamed{TEXT,DISPLAY}
 597 @lilyvindex{\TEXT\}
 598 @ref{\TEXT\,,\DISPLAY\,essay,Essay}
 599 @end macro
 600
 601 @macro rprogram{TEXT}
 602 @lilyvindex{\TEXT\}
 603 @ref{\TEXT\,,,application,Application Usage}
 604 @end macro
 605
 606 @macro rprogramnamed{TEXT,DISPLAY}
 607 @lilyvindex{\TEXT\}
 608 @ref{\TEXT\,,\DISPLAY\,application,Application Usage}
 609 @end macro
 610
 611 @macro rlsr{TEXT}
 612 @lilyvindex{\TEXT\}
 613 @ref{\TEXT\,,,snippets,Snippets}
 614 @end macro
 615
 616 @macro rlsrnamed{TEXT,DISPLAY}
 617 @lilyvindex{\TEXT\}
 618 @ref{\TEXT\,,\DISPLAY\,snippets,Snippets}
 619 @end macro
 620
 621 @macro rinternals{TEXT}
 622 @lilyvindex{\TEXT\}
 623 @ref{\TEXT\,,,internals,Internals Reference}
 624 @end macro
 625
 626 @macro rinternalsnamed{TEXT,DISPLAY}
 627 @lilyvindex{\TEXT\}
 628 @ref{\TEXT\,,\DISPLAY\,internals,Internals Reference}
 629 @end macro
 630
 631 @end iftex
 632
 633 @c  ***** Macros specific to the web site *****
 634
 635 @ifset web
 636
 637 @c LEGALESE
 638
 639 @macro logoLegalLinux
 640 Tux the Linux Penguin was created by
 641 @uref{mailto:lewing@@isc.tamu.edu, lewing@@isc.tamu.edu} with
 642 @uref{http://www.isc.tamu.edu/~lewing/gimp/, the Gnu Image
 643 Manipulation Program}.
 644
 645 @end macro
 646
 647 @macro logoLegalFreeBSD
 648 The FreeBSD logo is a registered trademark of
 649 @uref{http://www.freebsd.org/, The FreeBSD Foundation}.
 650
 651 @end macro
 652
 653 @macro logoLegalMacOSX
 654 The @qq{X image} is not a registered trademark.  It was created by
 655 @uref{http://en.wikipedia.org/wiki/User:Nihonjoe, Nihonjoe} and
 656 @uref{http://en.wikipedia.org/wiki/User:CyberSkull, CyberSkull}, and
 657 placed under the GNU Free Documentation License version 1.2 or later.
 658 We found the image on
 659 @uref{http://commons.wikimedia.org/wiki/File:Mac_OS_X_Userbox_X.png,
 660 this Wikipedia Commons page}.
 661
 662 @end macro
 663
 664 @macro logoLegalWindows
 665 The @qq{four colored rectangles image} is not a registered
 666 trademark.  It was created by
 667 @uref{http://en.wikipedia.org/wiki/User:Rohitbd, Rohitbd} and
 668 placed under the GNU Free Documentation License version 1.2.  We
 669 found the image on
 670 @uref{http://commons.wikimedia.org/wiki/Category:Microsoft_Windows_logos,
 671 this Wikipedia Commons page}.
 672
 673 @end macro
 674
 675 @end ifset