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