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
 115 @c  All these also have a @...named version which allows to specify the
 116 @c  displayed text for the reference as second argument.
 117 @c
 118 @c ***** HTML + bigpage is a special case (other manual names); all other
 119 @c formats are treated similarly.
 120
 121
 122 @c *** not TeX ***
 123
 124 @ifnottex
 125
 126 @c ** bigpage **
 127
 128 @ifset bigpage
 129
 130 @macro rglos{TEXT}
 131 @vindex \TEXT\
 132 @ref{\TEXT\,,,music-glossary-big-page,Music Glossary}
 133 @end macro
 134
 135 @macro rglosnamed{TEXT,DISPLAY}
 136 @vindex \TEXT\
 137 @ref{\TEXT\,,\DISPLAY\,music-glossary-big-page,Music Glossary}
 138 @end macro
 139
 140 @macro rlearning{TEXT}
 141 @vindex \TEXT\
 142 @ref{\TEXT\,,,learning-big-page,Learning Manual}
 143 @end macro
 144
 145 @macro rlearningnamed{TEXT,DISPLAY}
 146 @vindex \TEXT\
 147 @ref{\TEXT\,,\DISPLAY\,learning-big-page,Learning Manual}
 148 @end macro
 149
 150 @macro ruser{TEXT}
 151 @vindex \TEXT\
 152 @ref{\TEXT\,,,notation-big-page,Notation Reference}
 153 @end macro
 154
 155 @macro rusernamed{TEXT,DISPLAY}
 156 @vindex \TEXT\
 157 @ref{\TEXT\,,\DISPLAY\,notation-big-page,Notation Reference}
 158 @end macro
 159
 160 @macro rgeneral{TEXT}
 161 @vindex \TEXT\
 162 @ref{\TEXT\,,,general-big-page,General Information}
 163 @end macro
 164
 165 @macro rgeneralnamed{TEXT,DISPLAY}
 166 @vindex \TEXT\
 167 @ref{\TEXT\,,\DISPLAY\,general-big-page,General Information}
 168 @end macro
 169
 170 @macro ressay{TEXT}
 171 @vindex \TEXT\
 172 @ref{\TEXT\,,,essay-big-page,Essay}
 173 @end macro
 174
 175 @macro ressaynamed{TEXT,DISPLAY}
 176 @vindex \TEXT\
 177 @ref{\TEXT\,,\DISPLAY\,essay-big-page,Essay}
 178 @end macro
 179
 180 @macro rprogram{TEXT}
 181 @vindex \TEXT\
 182 @ref{\TEXT\,,,application-big-page,Application Usage}
 183 @end macro
 184
 185 @macro rprogramnamed{TEXT,DISPLAY}
 186 @vindex \TEXT\
 187 @ref{\TEXT\,,\DISPLAY\,application-big-page,Application Usage}
 188 @end macro
 189
 190 @macro rlsr{TEXT}
 191 @ref{\TEXT\,,,snippets-big-page,Snippets}
 192 @end macro
 193
 194 @macro rlsrnamed{TEXT,DISPLAY}
 195 @ref{\TEXT\,,\DISPLAY\,snippets-big-page,Snippets}
 196 @end macro
 197
 198 @macro rinternals{TEXT}
 199 @vindex \TEXT\
 200 @ref{\TEXT\,,,internals-big-page,Internals Reference}
 201 @end macro
 202
 203 @macro rinternalsnamed{TEXT,DISPLAY}
 204 @vindex \TEXT\
 205 @ref{\TEXT\,,\DISPLAY\,internals-big-page,Internals Reference}
 206 @end macro
 207
 208 @end ifset
 209
 210
 211 @c ** not bigpage **
 212
 213 @ifclear bigpage
 214
 215 @ifnotinfo
 216
 217 @macro rglos{TEXT}
 218 @vindex \TEXT\
 219 @ref{\TEXT\,,,music-glossary,Music Glossary}
 220 @end macro
 221
 222 @macro rglosnamed{TEXT,DISPLAY}
 223 @vindex \TEXT\
 224 @ref{\TEXT\,,\DISPLAY\,music-glossary,Music Glossary}
 225 @end macro
 226
 227 @macro rlearning{TEXT}
 228 @vindex \TEXT\
 229 @ref{\TEXT\,,,learning,Learning Manual}
 230 @end macro
 231
 232 @macro rlearningnamed{TEXT,DISPLAY}
 233 @vindex \TEXT\
 234 @ref{\TEXT\,,,learning,Learning Manual}
 235 @end macro
 236
 237 @macro ruser{TEXT}
 238 @vindex \TEXT\
 239 @ref{\TEXT\,,,notation,Notation Reference}
 240 @end macro
 241
 242 @macro rusernamed{TEXT,DISPLAY}
 243 @vindex \TEXT\
 244 @ref{\TEXT\,,\DISPLAY\,notation,Notation Reference}
 245 @end macro
 246
 247 @macro rgeneral{TEXT}
 248 @vindex \TEXT\
 249 @ref{\TEXT\,,,general,General Information}
 250 @end macro
 251
 252 @macro rgeneralnamed{TEXT,DISPLAY}
 253 @vindex \TEXT\
 254 @ref{\TEXT\,,\DISPLAY\,general,General Information}
 255 @end macro
 256
 257 @macro ressay{TEXT}
 258 @vindex \TEXT\
 259 @ref{\TEXT\,,,essay,Essay}
 260 @end macro
 261
 262 @macro ressaynamed{TEXT,DISPLAY}
 263 @vindex \TEXT\
 264 @ref{\TEXT\,,\DISPLAY\,essay,Essay}
 265 @end macro
 266
 267 @macro rprogram{TEXT}
 268 @vindex \TEXT\
 269 @ref{\TEXT\,,,application,Application Usage}
 270 @end macro
 271
 272 @macro rprogramnamed{TEXT,DISPLAY}
 273 @vindex \TEXT\
 274 @ref{\TEXT\,,\DISPLAY\,application,Application Usage}
 275 @end macro
 276
 277 @macro rlsr{TEXT}
 278 @ref{\TEXT\,,,snippets,Snippets}
 279 @end macro
 280
 281 @macro rlsrnamed{TEXT,DISPLAY}
 282 @ref{\TEXT\,,\DISPLAY\,snippets,Snippets}
 283 @end macro
 284
 285 @macro rinternals{TEXT}
 286 @vindex \TEXT\
 287 @ref{\TEXT\,,,internals,Internals Reference}
 288 @end macro
 289
 290 @macro rinternalsnamed{TEXT,DISPLAY}
 291 @vindex \TEXT\
 292 @ref{\TEXT\,,\DISPLAY\,internals,Internals Reference}
 293 @end macro
 294
 295 @end ifnotinfo
 296
 297 @ifinfo
 298
 299 @macro rglos{TEXT}
 300 @vindex \TEXT\
 301 @ref{\TEXT\,,,music-glossary,Music Glossary}
 302 @end macro
 303
 304 @macro rglosnamed{TEXT,DISPLAY}
 305 @vindex \TEXT\
 306 @ref{\TEXT\,,\DISPLAY\,music-glossary,Music Glossary}
 307 @end macro
 308
 309 @macro rlearning{TEXT}
 310 @vindex \TEXT\
 311 @ref{\TEXT\,,,lilypond-learning,Learning Manual}
 312 @end macro
 313
 314 @macro rlearningnamed{TEXT,DISPLAY}
 315 @vindex \TEXT\
 316 @ref{\TEXT\,,,lilypond-learning,Learning Manual}
 317 @end macro
 318
 319 @macro ruser{TEXT}
 320 @vindex \TEXT\
 321 @ref{\TEXT\,,,lilypond-notation,Notation Reference}
 322 @end macro
 323
 324 @macro rusernamed{TEXT,DISPLAY}
 325 @vindex \TEXT\
 326 @ref{\TEXT\,,\DISPLAY\,lilypond-notation,Notation Reference}
 327 @end macro
 328
 329 @macro rgeneral{TEXT}
 330 @vindex \TEXT\
 331 @ref{\TEXT\,,,lilypond-general,General Information}
 332 @end macro
 333
 334 @macro rgeneralnamed{TEXT,DISPLAY}
 335 @vindex \TEXT\
 336 @ref{\TEXT\,,\DISPLAY\,lilypond-general, General Information}
 337 @end macro
 338
 339 @macro ressay{TEXT}
 340 @vindex \TEXT\
 341 @ref{\TEXT\,,,lilypond-essay,Essay}
 342 @end macro
 343
 344 @macro ressaynamed{TEXT,DISPLAY}
 345 @vindex \TEXT\
 346 @ref{\TEXT\,,\DISPLAY\,lilypond-essay,Essay}
 347 @end macro
 348
 349 @macro rprogram{TEXT}
 350 @vindex \TEXT\
 351 @ref{\TEXT\,,,lilypond-application,Application Usage}
 352 @end macro
 353
 354 @macro rprogramnamed{TEXT,DISPLAY}
 355 @vindex \TEXT\
 356 @ref{\TEXT\,,\DISPLAY\,lilypond-application,Application Usage}
 357 @end macro
 358
 359 @macro rlsr{TEXT}
 360 @ref{\TEXT\,,,lilypond-snippets,Snippets}
 361 @end macro
 362
 363 @macro rlsrnamed{TEXT,DISPLAY}
 364 @ref{\TEXT\,,\DISPLAY\,lilypond-snippets,Snippets}
 365 @end macro
 366
 367 @macro rinternals{TEXT}
 368 @vindex \TEXT\
 369 @ref{\TEXT\,,,lilypond-internals,Internals Reference}
 370 @end macro
 371
 372 @macro rinternalsnamed{TEXT,DISPLAY}
 373 @vindex \TEXT\
 374 @ref{\TEXT\,,\DISPLAY\,lilypond-internals,Internals Reference}
 375 @end macro
 376
 377 @end ifinfo
 378
 379 @end ifclear
 380
 381 @end ifnottex
 382
 383
 384 @c *** TeX ***
 385
 386 @iftex
 387
 388 @c All commands below should work in the middle of the line;
 389 @c we thus must not use @vindex directly since it works only if placed
 390 @c on a line of its own.  To overcome this problem, we define a
 391 @c replacement macro using the internal definition of @vindex which
 392 @c delimits arguments in the standard way (i.e., with braces).
 393
 394 @tex
 395 \gdef\lilyvindex#1{\doind{vr}{\code #1}\ignorespaces}
 396 @end tex
 397
 398 @macro rglos{TEXT}
 399 @lilyvindex{\TEXT\}
 400 @ref{\TEXT\,,,music-glossary,Music Glossary}
 401 @end macro
 402
 403 @macro rglosnamed{TEXT,DISPLAY}
 404 @lilyvindex{\TEXT\}
 405 @ref{\TEXT\,,\DISPLAY\,music-glossary,Music Glossary}
 406 @end macro
 407
 408 @macro rlearning{TEXT}
 409 @lilyvindex{\TEXT\}
 410 @ref{\TEXT\,,,learning,Learning Manual}
 411 @end macro
 412
 413 @macro rlearningnamed{TEXT,DISPLAY}
 414 @lilyvindex{\TEXT\}
 415 @ref{\TEXT\,,\DISPLAY\,learning,Learning Manual}
 416 @end macro
 417
 418 @macro ruser{TEXT}
 419 @lilyvindex{\TEXT\}
 420 @ref{\TEXT\,,,notation,Notation Reference}
 421 @end macro
 422
 423 @macro rusernamed{TEXT,DISPLAY}
 424 @lilyvindex{\TEXT\}
 425 @ref{\TEXT\,,\DISPLAY\,notation,Notation Reference}
 426 @end macro
 427
 428 @macro rgeneral{TEXT}
 429 @lilyvindex{\TEXT\}
 430 @ref{\TEXT\,,,general,General Information}
 431 @end macro
 432
 433 @macro rgeneralnamed{TEXT,DISPLAY}
 434 @lilyvindex{\TEXT\}
 435 @ref{\TEXT\,,\DISPLAY\,general,General Information}
 436 @end macro
 437
 438 @macro ressay{TEXT}
 439 @lilyvindex{\TEXT\}
 440 @ref{\TEXT\,,,essay,Essay}
 441 @end macro
 442
 443 @macro ressaynamed{TEXT,DISPLAY}
 444 @lilyvindex{\TEXT\}
 445 @ref{\TEXT\,,\DISPLAY\,essay,Essay}
 446 @end macro
 447
 448 @macro rprogram{TEXT}
 449 @lilyvindex{\TEXT\}
 450 @ref{\TEXT\,,,application,Application Usage}
 451 @end macro
 452
 453 @macro rprogramnamed{TEXT,DISPLAY}
 454 @lilyvindex{\TEXT\}
 455 @ref{\TEXT\,,\DISPLAY\,application,Application Usage}
 456 @end macro
 457
 458 @macro rlsr{TEXT}
 459 @lilyvindex{\TEXT\}
 460 @ref{\TEXT\,,,snippets,Snippets}
 461 @end macro
 462
 463 @macro rlsrnamed{TEXT,DISPLAY}
 464 @lilyvindex{\TEXT\}
 465 @ref{\TEXT\,,\DISPLAY\,snippets,Snippets}
 466 @end macro
 467
 468 @macro rinternals{TEXT}
 469 @lilyvindex{\TEXT\}
 470 @ref{\TEXT\,,,internals,Internals Reference}
 471 @end macro
 472
 473 @macro rinternalsnamed{TEXT,DISPLAY}
 474 @lilyvindex{\TEXT\}
 475 @ref{\TEXT\,,\DISPLAY\,internals,Internals Reference}
 476 @end macro
 477
 478 @end iftex
 479
 480 @c  ***** Macros specific to the web site *****
 481
 482 @ifset web
 483
 484 @c LEGALESE
 485
 486 @macro logoLegalLinux
 487 Tux the Linux Penguin was created by
 488 @uref{mailto:lewing@@isc.tamu.edu, lewing@@isc.tamu.edu} with
 489 @uref{http://www.isc.tamu.edu/~lewing/gimp/, the Gnu Image
 490 Manipulation Program}.
 491
 492 @end macro
 493
 494 @macro logoLegalFreeBSD
 495 The FreeBSD logo is a registered trademark of
 496 @uref{http://www.freebsd.org/, The FreeBSD Foundation}.
 497
 498 @end macro
 499
 500 @macro logoLegalMacOSX
 501 The @qq{X image} is not a registered trademark.  It was created by
 502 @uref{http://en.wikipedia.org/wiki/User:Nihonjoe, Nihonjoe} and
 503 @uref{http://en.wikipedia.org/wiki/User:CyberSkull, CyberSkull}, and
 504 placed under the GNU Free Documentation License version 1.2 or later.
 505 We found the image on
 506 @uref{http://commons.wikimedia.org/wiki/File:Mac_OS_X_Userbox_X.png,
 507 this Wikipedia Commons page}.
 508
 509 @end macro
 510
 511 @macro logoLegalWindows
 512 The @qq{four colored rectangles image} is not a registered
 513 trademark.  It was created by
 514 @uref{http://en.wikipedia.org/wiki/User:Rohitbd, Rohitbd} and
 515 placed under the GNU Free Documentation License version 1.2.  We
 516 found the image on
 517 @uref{http://commons.wikimedia.org/wiki/Category:Microsoft_Windows_logos,
 518 this Wikipedia Commons page}.
 519
 520 @end macro
 521
 522 @end ifset