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