Documentation/common-macros.itexi

   1 @c -*- coding: utf-8; mode: texinfo; -*-
   2
   3
   4 @c Don't replace quotes with directed quotes.
   5
   6 @set txicodequoteundirected
   7 @set txicodequotebacktick
   8
   9
  10 @c   ***** Displaying text *****
  11
  12 @c We need this since @q{\} doesn't work with makeinfo 4.11 --
  13 @c say @q{@bs{}} instead.
  14
  15 @macro bs
  16 \\
  17 @end macro
  18
  19
  20 @ifnotinfo
  21
  22 @macro notation{TEXT}
  23 @var{\TEXT\}
  24 @end macro
  25
  26 @end ifnotinfo
  27
  28 @ifinfo
  29
  30 @macro notation{TEXT}
  31 \TEXT\
  32 @end macro
  33
  34 @end ifinfo
  35
  36
  37 @macro smallspace
  38 @sp 1
  39 @end macro
  40
  41
  42 @c   ***** Displaying images not generated by lilypond-book *****
  43
  44 @c Current installation setup of Info docs requires that all images are
  45 @c expected to be found in the `lilypond/' subdirectory.  `lilypond-book'
  46 @c already generates proper @image commands for images of music; these
  47 @c macro definitions do the same for other images.
  48
  49 @c can't scale images in tex
  50 @ifnotinfo
  51
  52 @macro sourceimage{FILENAME}
  53 @image{pictures/\FILENAME\}
  54 @end macro
  55
  56 @end ifnotinfo
  57
  58 @ifinfo
  59
  60 @macro sourceimage{FILENAME}
  61 @image{lilypond/pictures/\FILENAME\}
  62 @end macro
  63
  64 @end ifinfo
  65
  66
  67 @c   ***** Headers *****
  68
  69 @ifclear snippets-sections
  70 @macro lydoctitle {TEXT}
  71 @need 600
  72 @emph{\TEXT\}
  73 @end macro
  74 @end ifclear
  75
  76 @c   ***** Indexing *****
  77
  78 @c Don't remove the `@c' within the macro definition!  See section 19.3,
  79 @c `Macro Details and Caveats', in the texinfo info file for explanation.
  80
  81 @macro funindex {TEXT}
  82 @findex \TEXT\
  83 @kindex \TEXT\
  84 @c
  85 @end macro
  86
  87
  88 @c   ***** Macros specific to translated docs *****
  89
  90 @c ugh, cannot set/define global variable 'translationof' in any way :-(
  91
  92 @iftex
  93
  94 @macro translationof{TEXT}
  95 @end macro
  96
  97 @end iftex
  98
  99 @ifinfo
 100
 101 @macro translationof{TEXT}
 102 @set translationof \TEXT\
 103 @end macro
 104
 105 @end ifinfo
 106
 107 @ifhtml
 108
 109 @ifset bigpage
 110 @macro untranslated
 111 @end macro
 112 @end ifset
 113
 114 @ifclear bigpage
 115 @macro untranslated
 116 UNTRANSLATED NODE: IGNORE ME
 117 @end macro
 118 @end ifclear
 119
 120 @end ifhtml
 121
 122 @ifnothtml
 123
 124 @macro untranslated
 125 @end macro
 126
 127 @end ifnothtml
 128
 129
 130 @c  ***** Macros specific to the web site *****
 131
 132 @ifset web
 133
 134 @macro help{TEXT}
 135 @html
 136 <div class="help">
 137 <strong>
 138   <span style="text-decoration:blink">Help wanted:</span>
 139 </strong> \TEXT\
 140 </div>
 141 @end html
 142 @end macro
 143
 144 @macro divId {ID}
 145 @html
 146 <div id="\ID\">
 147 @end html
 148 @end macro
 149
 150 @macro divClass {CLASS}
 151 @html
 152 <div class="\CLASS\">
 153 @end html
 154 @end macro
 155
 156 @macro divEnd
 157 @c keep the space for proper nesting of </p>
 158
 159 @html
 160 </div>
 161 @end html
 162 @end macro
 163
 164
 165 @c not strictly necessary, but it makes things easier for updating news
 166 @macro newsItem
 167 @html
 168 <div class="news-item">
 169 @end html
 170 @end macro
 171
 172 @macro newsEnd
 173 @c keep the space for proper nesting of </p>
 174
 175 @html
 176 </div>
 177 @end html
 178 @end macro
 179
 180
 181
 182 @macro imageClickable{IMAGE-FILE, MORE-TEXT, CLICK-FILE, POSITION}
 183 @html
 184 <div class="float-\POSITION\">
 185   <a class="clickable" href="\CLICK-FILE\">
 186     <img src="\IMAGE-FILE\" alt="\IMAGE-FILE\">
 187   </a>
 188   <p style="text-align: center">
 189     \MORE-TEXT\
 190   </p>
 191 </div>
 192 @end html
 193 @ifnothtml
 194 FIXME: broken image
 195 @c @image{\IMAGE-FILE\}
 196 @end ifnothtml
 197 @end macro
 198
 199 @macro imageFloat{IMAGE-FILE, POSITION}
 200 @html
 201 <img class="float-\POSITION\" src="pictures/\IMAGE-FILE\" alt="\IMAGE-FILE\">
 202 @end html
 203 @ifnothtml
 204 FIXME: broken image
 205 @c @image{\IMAGE-FILE\}
 206 @end ifnothtml
 207 @end macro
 208
 209 @macro imageId{ID, IMAGE-FILE, ALT}
 210 @html
 211 <div id="\ID\">
 212   <img src="pictures/\IMAGE-FILE\" alt="\ALT\">
 213 </div>
 214 @end html
 215 @ifnothtml
 216 FIXME: broken image
 217 @c @image{\IMAGE-FILE\}
 218 @end ifnothtml
 219 @end macro
 220
 221 @end ifset