Documentation/common-macros.itexi

   1 @c -*- coding: utf-8; mode: texinfo; -*-
   2
   3
   4
   5 @c Don't replace quotes with directed quotes.
   6
   7 @set txicodequoteundirected
   8 @set txicodequotebacktick
   9
  10
  11 @c   ***** Displaying text *****
  12
  13 @c We need this since @q{\} doesn't work with makeinfo 4.11 --
  14 @c say @q{@bs{}} instead.
  15
  16 @macro bs
  17 \\
  18 @end macro
  19
  20
  21 @ifnotinfo
  22
  23 @macro notation{TEXT}
  24 @var{\TEXT\}
  25 @end macro
  26
  27 @end ifnotinfo
  28
  29 @ifinfo
  30
  31 @macro notation{TEXT}
  32 \TEXT\
  33 @end macro
  34
  35 @end ifinfo
  36
  37
  38 @macro smallspace
  39 @sp 1
  40 @end macro
  41
  42
  43 @c   ***** Displaying images not generated by lilypond-book *****
  44
  45 @c Current installation setup of Info docs requires that all images are
  46 @c expected to be found in the `lilypond/' subdirectory.  `lilypond-book'
  47 @c already generates proper @image commands for images of music; these
  48 @c macro definitions do the same for other images.
  49
  50 @ifnotinfo
  51
  52 @macro sourceimage{FILENAME,WIDTH,HEIGHT,ALTTEXT}
  53 @image{\FILENAME\,\WIDTH\,\HEIGHT\,\ALTTEXT\}
  54 @end macro
  55
  56 @end ifnotinfo
  57
  58 @ifinfo
  59
  60 @macro sourceimage{FILENAME,WIDTH,HEIGHT,ALTTEXT}
  61 @image{lilypond/\FILENAME\,\WIDTH\,\HEIGHT\,\ALTTEXT\}
  62 @end macro
  63
  64 @end ifinfo
  65
  66
  67 @c   ***** Headers *****
  68
  69 @macro lydoctitle {TEXT}
  70 @emph{\TEXT\}
  71 @end macro
  72
  73
  74 @c   ***** Indexing *****
  75
  76 @c Don't remove the `@c' within the macro definition!  See section 19.3,
  77 @c `Macro Details and Caveats', in the texinfo info file for explanation.
  78
  79 @macro funindex {TEXT}
  80 @findex \TEXT\
  81 @kindex \TEXT\
  82 @c
  83 @end macro
  84
  85
  86 @c   ***** Macros specific to translated docs *****
  87
  88 @c ugh, cannot set/define global variable 'translationof' in any way :-(
  89
  90 @iftex
  91
  92 @macro translationof{TEXT}
  93 @end macro
  94
  95 @end iftex
  96
  97 @ifinfo
  98
  99 @macro translationof{TEXT}
 100 @set translationof \TEXT\
 101 @end macro
 102
 103 @end ifinfo
 104
 105 @ifhtml
 106
 107 @ifset bigpage
 108 @macro untranslated
 109 @end macro
 110 @end ifset
 111
 112 @ifclear bigpage
 113 @macro untranslated
 114 UNTRANSLATED NODE: IGNORE ME
 115 @end macro
 116 @end ifclear
 117
 118 @end ifhtml
 119
 120 @ifnothtml
 121
 122 @macro untranslated
 123 @end macro
 124
 125 @end ifnothtml