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