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