Documentation/de/user/macros.itexi

   1 @c -*- coding: utf-8; mode: texinfo; -*-
   2 @ignore
   3     Translation of GIT committish: 01361d46dc9d514a79683d003eeea5f4fbf2b746
   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
  12
  13 @c Don't replace quotes with directed quotes.
  14
  15 @set txicodequoteundirected
  16 @set txicodequotebacktick
  17
  18
  19
  20 @c   ***** Displaying text *****
  21
  22 @c We need this since @q{\} doesn't work with makeinfo 4.11 --
  23 @c say @q{@bs{}} instead.
  24
  25 @macro bs
  26 \\
  27 @end macro
  28
  29
  30 @c To get decent quotes in ,foo' and ,,foo''.
  31 @c These need to be split up so that "@qq{foo}." looks nice.  :(
  32
  33 @macro q{TEXT}
  34 @quotesinglbase{}\TEXT\@quoteleft{}
  35 @end macro
  36
  37 @macro qq{TEXT}
  38 @quotedblbase{}\TEXT\@quotedblleft{}
  39 @end macro
  40
  41
  42 @ifhtml
  43
  44 @macro warning{TEXT}
  45 @cartouche
  46 @b{Achtung:} \TEXT\
  47 @end cartouche
  48 @end macro
  49
  50 @end ifhtml
  51
  52 @ifnothtml
  53
  54 @macro warning{TEXT}
  55 @quotation
  56 @quotation
  57 @cartouche
  58 @b{Achtung:} \TEXT\
  59 @end cartouche
  60 @end quotation
  61 @end quotation
  62 @end macro
  63
  64 @end ifnothtml
  65
  66
  67 @ifnotinfo
  68
  69 @macro notation{TEXT}
  70 @var{\TEXT\}
  71 @end macro
  72
  73 @end ifnotinfo
  74
  75 @ifinfo
  76
  77 @macro notation{TEXT}
  78 \TEXT\
  79 @end macro
  80
  81 @end ifinfo
  82
  83
  84 @macro smallspace
  85 @sp 1
  86 @end macro
  87
  88
  89
  90 @c   ***** Displaying images not generated by lilypond-book *****
  91
  92 @c Current installation setup of Info docs requires that all images are
  93 @c expected to be found in the `lilypond/' subdirectory.  `lilypond-book'
  94 @c already generates proper @image commands for images of music; these
  95 @c macro definitions do the same for other images.
  96
  97 @ifnotinfo
  98
  99 @macro sourceimage{FILENAME,WIDTH,HEIGHT,ALTTEXT}
 100 @image{\FILENAME\,\WIDTH\,\HEIGHT\,\ALTTEXT\}
 101 @end macro
 102
 103 @end ifnotinfo
 104
 105 @ifinfo
 106
 107 @macro sourceimage{FILENAME,WIDTH,HEIGHT,ALTTEXT}
 108 @image{lilypond/\FILENAME\,\WIDTH\,\HEIGHT\,\ALTTEXT\}
 109 @end macro
 110
 111 @end ifinfo
 112
 113
 114
 115 @c   ***** Headings in a doc subsection *****
 116
 117 @c Don't insert an empty line after @predefined!  Right now
 118 @c it doesn't matter, but a future implementation will probably
 119 @c add some code which needs this restriction.
 120
 121 @macro predefined
 122 @noindent
 123 @subsubheading Predefined commands
 124 @end macro
 125
 126 @c The next macro is a dummy currently since texinfo doesn't
 127 @c provide a real ragged-right environment yet.
 128 @c
 129 @c Due to a bug in texi2html (texi2html.pl CVS versions <= 1.245)
 130 @c the macro must not be empty.
 131
 132 @macro endpredefined
 133 @c
 134 @end macro
 135
 136
 137 @macro snippets
 138 @noindent
 139 @subsubheading Selected Snippets
 140 @end macro
 141
 142
 143 @c Don't insert an empty line after @seealso!  Otherwise we get
 144 @c unwanted extra vertical space in the PDF output.
 145
 146 @macro seealso
 147 @noindent
 148 @subsubheading See also
 149 @indent
 150 @end macro
 151
 152
 153 @macro knownissues
 154 @noindent
 155 @subsubheading Known issues and warnings
 156 @end macro
 157
 158
 159 @macro lydoctitle {TEXT}
 160 @emph{\TEXT\}
 161 @end macro
 162
 163
 164 @c Don't remove the `@c' within the macro definition!  See section 19.3,
 165 @c `Macro Details and Caveats', in the texinfo info file for explanation.
 166
 167 @macro funindex {TEXT}
 168 @findex \TEXT\
 169 @kindex \TEXT\
 170 @c
 171 @end macro
 172
 173
 174
 175 @c   ***** Links and references *****
 176
 177 @c  Definitions for references:
 178 @c
 179 @c     @rglos
 180 @c     @rlearning
 181 @c     @ruser
 182 @c     @rprogram
 183 @c     @rlsr
 184 @c     @rinternals
 185 @c
 186 @c  All these also have a @...named version which allows to specify the
 187 @c  displayed text for the reference as second argument.
 188 @c
 189 @c ***** HTML + bigpage is a special case (other manual names); all other
 190 @c formats are treated similarly.
 191
 192
 193 @c *** not TeX ***
 194
 195 @ifnottex
 196
 197 @c ** bigpage **
 198
 199 @ifset bigpage
 200
 201 @macro rglos{TEXT}
 202 @vindex \TEXT\
 203 @ref{\TEXT\,,,music-glossary-big-page,Glossar}
 204 @end macro
 205
 206 @macro rglosnamed{TEXT,DISPLAY}
 207 @vindex \TEXT\
 208 @ref{\TEXT\,,\DISPLAY\,music-glossary-big-page,Glossar}
 209 @end macro
 210
 211 @macro rlearning{TEXT}
 212 @vindex \TEXT\
 213 @ref{\TEXT\,,,lilypond-learning-big-page,Handbuch zum Lernen}
 214 @end macro
 215
 216 @macro rlearningnamed{TEXT,DISPLAY}
 217 @vindex \TEXT\
 218 @ref{\TEXT\,,\DISPLAY\,lilypond-learning-big-page,Handbuch zum Lernen}
 219 @end macro
 220
 221 @macro ruser{TEXT}
 222 @vindex \TEXT\
 223 @ref{\TEXT\,,,lilypond-big-page,Notationsreferenz}
 224 @end macro
 225
 226 @macro rusernamed{TEXT,DISPLAY}
 227 @vindex \TEXT\
 228 @ref{\TEXT\,,\DISPLAY\,lilypond-big-page,Notationsreferenz}
 229 @end macro
 230
 231 @macro rprogram{TEXT}
 232 @vindex \TEXT\
 233 @ref{\TEXT\,,,lilypond-program-big-page,Anwendungsbenutzung}
 234 @end macro
 235
 236 @macro rprogramnamed{TEXT,DISPLAY}
 237 @vindex \TEXT\
 238 @ref{\TEXT\,,\DISPLAY\,lilypond-program-big-page,Anwendungsbenutzung}
 239 @end macro
 240
 241 @macro rlsr{TEXT}
 242 @ref{\TEXT\,,,lilypond-snippets-big-page,Schnipsel}
 243 @end macro
 244
 245 @macro rlsrnamed{TEXT,DISPLAY}
 246 @ref{\TEXT\,,\DISPLAY\,lilypond-snippets-big-page,Schnipsel}
 247 @end macro
 248
 249 @macro rinternals{TEXT}
 250 @vindex \TEXT\
 251 @ref{\TEXT\,,,lilypond-internals-big-page,Referenz der Interna}
 252 @end macro
 253
 254 @macro rinternalsnamed{TEXT,DISPLAY}
 255 @vindex \TEXT\
 256 @ref{\TEXT\,,\DISPLAY\,lilypond-internals-big-page,Referenz der Interna}
 257 @end macro
 258
 259 @end ifset
 260
 261
 262 @c ** not bigpage **
 263
 264 @ifclear bigpage
 265
 266 @macro rglos{TEXT}
 267 @vindex \TEXT\
 268 @ref{\TEXT\,,,music-glossary,Glossar}
 269 @end macro
 270
 271 @macro rglosnamed{TEXT,DISPLAY}
 272 @vindex \TEXT\
 273 @ref{\TEXT\,,\DISPLAY\,music-glossary,Glossar}
 274 @end macro
 275
 276 @macro rlearning{TEXT}
 277 @vindex \TEXT\
 278 @ref{\TEXT\,,,lilypond-learning,Handbuch zum Lernen}
 279 @end macro
 280
 281 @macro rlearningnamed{TEXT,DISPLAY}
 282 @vindex \TEXT\
 283 @ref{\TEXT\,,\DISPLAY\,lilypond-learning,Handbuch zum Lernen}
 284 @end macro
 285
 286 @macro ruser{TEXT}
 287 @vindex \TEXT\
 288 @ref{\TEXT\,,,lilypond,Notationsreferenz}
 289 @end macro
 290
 291 @macro rusernamed{TEXT,DISPLAY}
 292 @vindex \TEXT\
 293 @ref{\TEXT\,,\DISPLAY\,lilypond,Notationsreferenz}
 294 @end macro
 295
 296 @macro rprogram{TEXT}
 297 @vindex \TEXT\
 298 @ref{\TEXT\,,,lilypond-program,Anwendungsbenutzung}
 299 @end macro
 300
 301 @macro rprogramnamed{TEXT,DISPLAY}
 302 @vindex \TEXT\
 303 @ref{\TEXT\,,\DISPLAY\,lilypond-program,Anwendungsbenutzung}
 304 @end macro
 305
 306 @macro rlsr{TEXT}
 307 @ref{\TEXT\,,,lilypond-snippets,Schnipsel}
 308 @end macro
 309
 310 @macro rlsrnamed{TEXT,DISPLAY}
 311 @ref{\TEXT\,,\DISPLAY\,lilypond-snippets,Schnipsel}
 312 @end macro
 313
 314 @macro rinternals{TEXT}
 315 @vindex \TEXT\
 316 @ref{\TEXT\,,,lilypond-internals,Referenz der Interna}
 317 @end macro
 318
 319 @macro rinternalsnamed{TEXT,DISPLAY}
 320 @vindex \TEXT\
 321 @ref{\TEXT\,,\DISPLAY\,lilypond-internals,Referenz der Interna}
 322 @end macro
 323
 324 @end ifclear
 325
 326 @end ifnottex
 327
 328
 329 @c *** TeX ***
 330
 331 @iftex
 332
 333 @c All commands below should work in the middle of the line;
 334 @c we thus must not use @vindex directly since it works only if placed
 335 @c on a line of its own.  To overcome this problem, we define a
 336 @c replacement macro using the internal definition of @vindex which
 337 @c delimits arguments in the standard way (i.e., with braces).
 338
 339 @tex
 340 \gdef\lilyvindex#1{\doind{vr}{\code #1}\ignorespaces}
 341 @end tex
 342
 343 @macro rglos{TEXT}
 344 @lilyvindex{\TEXT\}
 345 @ref{\TEXT\,,,music-glossary,Glossar}
 346 @end macro
 347
 348 @macro rglosnamed{TEXT,DISPLAY}
 349 @lilyvindex{\TEXT\}
 350 @ref{\TEXT\,,\DISPLAY\,music-glossary,Glossar}
 351 @end macro
 352
 353 @macro rlearning{TEXT}
 354 @lilyvindex{\TEXT\}
 355 @ref{\TEXT\,,,lilypond-learning.de,Handbuch zum Lernen}
 356 @end macro
 357
 358 @macro rlearningnamed{TEXT,DISPLAY}
 359 @lilyvindex{\TEXT\}
 360 @ref{\TEXT\,,\DISPLAY\,lilypond-learning.de,Handbuch zum Lernen}
 361 @end macro
 362
 363 @macro ruser{TEXT}
 364 @lilyvindex{\TEXT\}
 365 @ref{\TEXT\,,,lilypond.de,Notationsreferenz}
 366 @end macro
 367
 368 @macro rusernamed{TEXT,DISPLAY}
 369 @lilyvindex{\TEXT\}
 370 @ref{\TEXT\,,\DISPLAY\,lilypond.de,Notationsreferenz}
 371 @end macro
 372
 373 @macro rprogram{TEXT}
 374 @lilyvindex{\TEXT\}
 375 @ref{\TEXT\,,,lilypond-program.de,Anwendungsbenutzung}
 376 @end macro
 377
 378 @macro rprogramnamed{TEXT,DISPLAY}
 379 @lilyvindex{\TEXT\}
 380 @ref{\TEXT\,,\DISPLAY\,lilypond-program.de,Anwendungsbenutzung}
 381 @end macro
 382
 383 @macro rlsr{TEXT}
 384 @lilyvindex{\TEXT\}
 385 @ref{\TEXT\,,,lilypond-snippets,Schnipsel}
 386 @end macro
 387
 388 @macro rlsrnamed{TEXT,DISPLAY}
 389 @lilyvindex{\TEXT\}
 390 @ref{\TEXT\,,\DISPLAY\,lilypond-snippets,Schnipsel}
 391 @end macro
 392
 393 @macro rinternals{TEXT}
 394 @lilyvindex{\TEXT\}
 395 @ref{\TEXT\,,,lilypond-internals,Referenz der Interna}
 396 @end macro
 397
 398 @macro rinternalsnamed{TEXT,DISPLAY}
 399 @lilyvindex{\TEXT\}
 400 @ref{\TEXT\,,\DISPLAY\,lilypond-internals,Referenz der Interna}
 401 @end macro
 402
 403 @end iftex
 404
 405
 406
 407 @c   ***** Macros specific to translated docs *****
 408
 409 @c ugh, cannot set/define global variable 'translationof' in some way?
 410
 411 @iftex
 412
 413 @macro translationof{TEXT}
 414 @end macro
 415
 416 @end iftex
 417
 418 @ifinfo
 419
 420 @macro
 421 @macro translationof{TEXT}
 422 @set translationof \TEXT\
 423 @end macro
 424
 425 @end ifinfo
 426
 427
 428 @c TODO: If @translationof is used in translated docs
 429 @c see whether it is feasible to say @value{translationof}.
 430
 431 @macro englishref
 432 Dieser Abschnitt wurde noch nicht übersetzt.  Bitte lesen Sie den
 433 Abschnitt im englischen Benutzerhandbuch.
 434 @end macro
 435
 436
 437 @ifhtml
 438
 439 @ifset bigpage
 440 @macro untranslated
 441 @end macro
 442 @end ifset
 443
 444 @ifclear bigpage
 445 @macro untranslated
 446 UNTRANSLATED NODE: IGNORE ME
 447 @end macro
 448 @end ifclear
 449
 450 @end ifhtml
 451
 452 @ifnothtml
 453 @macro untranslated
 454 @end macro
 455 @end ifnothtml