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