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