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