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 obsolete, remove when translation is fully updated
 144 @macro commonprop
 145 @noindent
 146 @subsubheading Commonly tweaked properties
 147 @end macro
 148
 149
 150 @c Don't insert an empty line after @seealso!  Otherwise we get
 151 @c unwanted extra vertical space in the PDF output.
 152
 153 @macro seealso
 154 @noindent
 155 @subsubheading See also
 156 @indent
 157 @end macro
 158
 159
 160 @macro knownissues
 161 @noindent
 162 @subsubheading Known issues and warnings
 163 @end macro
 164
 165
 166 @macro lydoctitle {TEXT}
 167 @emph{\TEXT\}
 168 @end macro
 169
 170
 171 @c Don't remove the `@c' within the macro definition!  See section 19.3,
 172 @c `Macro Details and Caveats', in the texinfo info file for explanation.
 173
 174 @macro funindex {TEXT}
 175 @findex \TEXT\
 176 @kindex \TEXT\
 177 @c
 178 @end macro
 179
 180
 181
 182 @c   ***** Links and references *****
 183
 184 @c obsolete
 185 @c usage: @lsr{ancient,custodes.ly}
 186 @macro lsr{DIR,TEXT}
 187 @ifhtml
 188 @uref{source/input/lsr/\DIR\/collated-files.html#\TEXT\,@file{\DIR\/\TEXT\}}
 189 @end ifhtml
 190 @ifnothtml
 191 @file{\DIR\/\TEXT\}
 192 @end ifnothtml
 193 @end macro
 194
 195 @c don't update until this macro is correctly set up in English docs
 196 @macro lsrdir{DIR}
 197 @ifhtml
 198 @uref{source/input/lsr/\DIR\/collated-files.html,@file{\DIR\}/}
 199 @end ifhtml
 200 @ifnothtml
 201 @file{\DIR\}
 202 @end ifnothtml
 203 @end macro
 204
 205
 206 @c  Definitions for references:
 207 @c
 208 @c     @rglos
 209 @c     @rlearning
 210 @c     @ruser
 211 @c     @rprogram
 212 @c     @rlsr
 213 @c     @rinternals
 214 @c
 215 @c  All these also have a @...named version which allows to specify the
 216 @c  displayed text for the reference as second argument.
 217 @c
 218 @c ***** HTML + bigpage is a special case (other manual names); all other
 219 @c formats are treated similarly.
 220
 221
 222 @c *** not TeX ***
 223
 224 @ifnottex
 225
 226 @c ** bigpage **
 227
 228 @ifset bigpage
 229
 230 @macro rglos{TEXT}
 231 @vindex \TEXT\
 232 @ref{\TEXT\,,,music-glossary-big-page,Glossar}
 233 @end macro
 234
 235 @macro rglosnamed{TEXT,DISPLAY}
 236 @vindex \TEXT\
 237 @ref{\TEXT\,,\DISPLAY\,music-glossary-big-page,Glossar}
 238 @end macro
 239
 240 @macro rlearning{TEXT}
 241 @vindex \TEXT\
 242 @ref{\TEXT\,,,lilypond-learning-big-page,Handbuch zum Lernen}
 243 @end macro
 244
 245 @macro rlearningnamed{TEXT,DISPLAY}
 246 @vindex \TEXT\
 247 @ref{\TEXT\,,\DISPLAY\,lilypond-learning-big-page,Handbuch zum Lernen}
 248 @end macro
 249
 250 @macro ruser{TEXT}
 251 @vindex \TEXT\
 252 @ref{\TEXT\,,,lilypond-big-page,Notationsreferenz}
 253 @end macro
 254
 255 @macro rusernamed{TEXT,DISPLAY}
 256 @vindex \TEXT\
 257 @ref{\TEXT\,,\DISPLAY\,lilypond-big-page,Notationsreferenz}
 258 @end macro
 259
 260 @macro rprogram{TEXT}
 261 @vindex \TEXT\
 262 @ref{\TEXT\,,,lilypond-program-big-page,Anwendungsbenutzung}
 263 @end macro
 264
 265 @macro rprogramnamed{TEXT,DISPLAY}
 266 @vindex \TEXT\
 267 @ref{\TEXT\,,\DISPLAY\,lilypond-program-big-page,Anwendungsbenutzung}
 268 @end macro
 269
 270 @macro rlsr{TEXT}
 271 @ref{\TEXT\,,,lilypond-snippets-big-page,Schnipsel}
 272 @end macro
 273
 274 @macro rlsrnamed{TEXT,DISPLAY}
 275 @ref{\TEXT\,,\DISPLAY\,lilypond-snippets-big-page,Schnipsel}
 276 @end macro
 277
 278 @macro rinternals{TEXT}
 279 @vindex \TEXT\
 280 @ref{\TEXT\,,,lilypond-internals-big-page,Referenz der Interna}
 281 @end macro
 282
 283 @macro rinternalsnamed{TEXT,DISPLAY}
 284 @vindex \TEXT\
 285 @ref{\TEXT\,,\DISPLAY\,lilypond-internals-big-page,Referenz der Interna}
 286 @end macro
 287
 288 @end ifset
 289
 290
 291 @c ** not bigpage **
 292
 293 @ifclear bigpage
 294
 295 @macro rglos{TEXT}
 296 @vindex \TEXT\
 297 @ref{\TEXT\,,,music-glossary,Glossar}
 298 @end macro
 299
 300 @macro rglosnamed{TEXT,DISPLAY}
 301 @vindex \TEXT\
 302 @ref{\TEXT\,,\DISPLAY\,music-glossary,Glossar}
 303 @end macro
 304
 305 @macro rlearning{TEXT}
 306 @vindex \TEXT\
 307 @ref{\TEXT\,,,lilypond-learning,Handbuch zum Lernen}
 308 @end macro
 309
 310 @macro rlearningnamed{TEXT,DISPLAY}
 311 @vindex \TEXT\
 312 @ref{\TEXT\,,\DISPLAY\,lilypond-learning,Handbuch zum Lernen}
 313 @end macro
 314
 315 @macro ruser{TEXT}
 316 @vindex \TEXT\
 317 @ref{\TEXT\,,,lilypond,Notationsreferenz}
 318 @end macro
 319
 320 @macro rusernamed{TEXT,DISPLAY}
 321 @vindex \TEXT\
 322 @ref{\TEXT\,,\DISPLAY\,lilypond,Notationsreferenz}
 323 @end macro
 324
 325 @macro rprogram{TEXT}
 326 @vindex \TEXT\
 327 @ref{\TEXT\,,,lilypond-program,Anwendungsbenutzung}
 328 @end macro
 329
 330 @macro rprogramnamed{TEXT,DISPLAY}
 331 @vindex \TEXT\
 332 @ref{\TEXT\,,\DISPLAY\,lilypond-program,Anwendungsbenutzung}
 333 @end macro
 334
 335 @macro rlsr{TEXT}
 336 @ref{\TEXT\,,,lilypond-snippets,Schnipsel}
 337 @end macro
 338
 339 @macro rlsrnamed{TEXT,DISPLAY}
 340 @ref{\TEXT\,,\DISPLAY\,lilypond-snippets,Schnipsel}
 341 @end macro
 342
 343 @macro rinternals{TEXT}
 344 @vindex \TEXT\
 345 @ref{\TEXT\,,,lilypond-internals,Referenz der Interna}
 346 @end macro
 347
 348 @macro rinternalsnamed{TEXT,DISPLAY}
 349 @vindex \TEXT\
 350 @ref{\TEXT\,,\DISPLAY\,lilypond-internals,Referenz der Interna}
 351 @end macro
 352
 353 @end ifclear
 354
 355 @end ifnottex
 356
 357
 358 @c *** TeX ***
 359
 360 @iftex
 361
 362 @c All commands below should work in the middle of the line;
 363 @c we thus must not use @vindex directly since it works only if placed
 364 @c on a line of its own.  To overcome this problem, we define a
 365 @c replacement macro using the internal definition of @vindex which
 366 @c delimits arguments in the standard way (i.e., with braces).
 367
 368 @tex
 369 \gdef\lilyvindex#1{\doind{vr}{\code #1}\ignorespaces}
 370 @end tex
 371
 372 @macro rglos{TEXT}
 373 @lilyvindex{\TEXT\}
 374 @ref{\TEXT\,,,music-glossary,Glossar}
 375 @end macro
 376
 377 @macro rglosnamed{TEXT,DISPLAY}
 378 @lilyvindex{\TEXT\}
 379 @ref{\TEXT\,,\DISPLAY\,music-glossary,Glossar}
 380 @end macro
 381
 382 @macro rlearning{TEXT}
 383 @lilyvindex{\TEXT\}
 384 @ref{\TEXT\,,,lilypond-learning.de,Handbuch zum Lernen}
 385 @end macro
 386
 387 @macro rlearningnamed{TEXT,DISPLAY}
 388 @lilyvindex{\TEXT\}
 389 @ref{\TEXT\,,\DISPLAY\,lilypond-learning.de,Handbuch zum Lernen}
 390 @end macro
 391
 392 @macro ruser{TEXT}
 393 @lilyvindex{\TEXT\}
 394 @ref{\TEXT\,,,lilypond.de,Notationsreferenz}
 395 @end macro
 396
 397 @macro rusernamed{TEXT,DISPLAY}
 398 @lilyvindex{\TEXT\}
 399 @ref{\TEXT\,,\DISPLAY\,lilypond.de,Notationsreferenz}
 400 @end macro
 401
 402 @macro rprogram{TEXT}
 403 @lilyvindex{\TEXT\}
 404 @ref{\TEXT\,,,lilypond-program.de,Anwendungsbenutzung}
 405 @end macro
 406
 407 @macro rprogramnamed{TEXT,DISPLAY}
 408 @lilyvindex{\TEXT\}
 409 @ref{\TEXT\,,\DISPLAY\,lilypond-program.de,Anwendungsbenutzung}
 410 @end macro
 411
 412 @macro rlsr{TEXT}
 413 @lilyvindex{\TEXT\}
 414 @ref{\TEXT\,,,lilypond-snippets,Schnipsel}
 415 @end macro
 416
 417 @macro rlsrnamed{TEXT,DISPLAY}
 418 @lilyvindex{\TEXT\}
 419 @ref{\TEXT\,,\DISPLAY\,lilypond-snippets,Schnipsel}
 420 @end macro
 421
 422 @macro rinternals{TEXT}
 423 @lilyvindex{\TEXT\}
 424 @ref{\TEXT\,,,lilypond-internals,Referenz der Interna}
 425 @end macro
 426
 427 @macro rinternalsnamed{TEXT,DISPLAY}
 428 @lilyvindex{\TEXT\}
 429 @ref{\TEXT\,,\DISPLAY\,lilypond-internals,Referenz der Interna}
 430 @end macro
 431
 432 @end iftex
 433
 434
 435
 436 @c   ***** Macros specific to translated docs *****
 437
 438 @c ugh, cannot set/define global variable 'translationof' in some way?
 439
 440 @iftex
 441
 442 @macro translationof{TEXT}
 443 @end macro
 444
 445 @end iftex
 446
 447 @ifinfo
 448
 449 @macro
 450 @macro translationof{TEXT}
 451 @set translationof \TEXT\
 452 @end macro
 453
 454 @end ifinfo
 455
 456
 457 @c TODO: If @translationof is used in translated docs
 458 @c see whether it is feasible to say @value{translationof}.
 459
 460 @macro englishref
 461 Dieser Abschnitt wurde noch nicht übersetzt.  Bitte lesen Sie den
 462 Abschnitt im englischen Benutzerhandbuch.
 463 @end macro
 464
 465
 466 @ifhtml
 467
 468 @ifset bigpage
 469 @macro untranslated
 470 @end macro
 471 @end ifset
 472
 473 @ifclear bigpage
 474 @macro untranslated
 475 UNTRANSLATED NODE: IGNORE ME
 476 @end macro
 477 @end ifclear
 478
 479 @end ifhtml
 480
 481 @ifnothtml
 482 @macro untranslated
 483 @end macro
 484 @end ifnothtml