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