Documentation/common-macros.itexi

   1 @c -*- coding: utf-8; mode: texinfo; -*-
   2
   3
   4 @c ***********************************************
   5 @c SEE MACRO DEFINITION GUIDELINES IN macros.itexi
   6 @c ***********************************************
   7
   8 @c Don't replace quotes with directed quotes.
   9
  10 @set txicodequoteundirected
  11 @set txicodequotebacktick
  12
  13 @include cyrillic.itexi
  14
  15 @c   ***** Displaying text *****
  16
  17 @c We need this since @q{\} doesn't work with makeinfo 4.11 --
  18 @c say @q{@bs{}} instead.
  19
  20 @macro bs
  21 \\
  22 @end macro
  23
  24
  25 @ifnotinfo
  26
  27 @macro notation{TEXT}
  28 @var{\TEXT\}
  29 @end macro
  30
  31 @end ifnotinfo
  32
  33 @ifinfo
  34
  35 @macro notation{TEXT}
  36 \TEXT\
  37 @end macro
  38
  39 @end ifinfo
  40
  41
  42 @macro smallspace
  43 @sp 1
  44 @end macro
  45
  46
  47 @c   ***** Displaying images not generated by lilypond-book *****
  48
  49 @c Current installation setup of Info docs requires that all images are
  50 @c expected to be found in the `lilypond/' subdirectory.  `lilypond-book'
  51 @c already generates proper @image commands for images of music; these
  52 @c macro definitions do the same for other images.
  53
  54 @ifnotinfo
  55
  56 @macro sourceimage{FILENAME,WIDTH,HEIGHT,ALTTEXT}
  57 @image{pictures/\FILENAME\,\WIDTH\,\HEIGHT\,\ALTTEXT\}
  58 @end macro
  59
  60 @end ifnotinfo
  61
  62 @ifinfo
  63
  64 @macro sourceimage{FILENAME,WIDTH,HEIGHT,ALTTEXT}
  65 @image{lilypond/pictures/\FILENAME\,\WIDTH\,\HEIGHT\,\ALTTEXT\}
  66 @end macro
  67
  68 @end ifinfo
  69
  70
  71 @c   ***** Headers *****
  72
  73 @c For use as the Level 5 header
  74 @macro subsubsubheading {TEXT}
  75 @subsubheading @i{\TEXT\}
  76 @end macro
  77
  78 @ifclear snippets-sections
  79 @macro lydoctitle {TEXT}
  80 @need 600
  81 @emph{\TEXT\}
  82 @end macro
  83 @end ifclear
  84
  85 @c   ***** Indexing *****
  86
  87 @c Don't remove the `@c' within the macro definition!  See section 19.3,
  88 @c `Macro Details and Caveats', in the texinfo info file for explanation.
  89
  90 @macro funindex {TEXT}
  91 @findex \TEXT\
  92 @kindex \TEXT\
  93 @c
  94 @end macro
  95
  96
  97 @c   ***** Macros specific to translated docs *****
  98
  99 @c ugh, cannot set/define global variable 'translationof' in any way :-(
 100
 101 @iftex
 102
 103 @macro translationof{TEXT}
 104 @end macro
 105
 106 @end iftex
 107
 108 @ifinfo
 109
 110 @macro translationof{TEXT}
 111 @set translationof \TEXT\
 112 @end macro
 113
 114 @end ifinfo
 115
 116 @ifhtml
 117
 118 @ifset bigpage
 119 @macro untranslated
 120 @end macro
 121 @end ifset
 122
 123 @ifclear bigpage
 124 @macro untranslated
 125 UNTRANSLATED NODE: IGNORE ME
 126 @end macro
 127 @end ifclear
 128
 129 @end ifhtml
 130
 131 @ifnothtml
 132
 133 @macro untranslated
 134 @end macro
 135
 136 @end ifnothtml
 137
 138
 139 @c  ***** Macros specific to the web site *****
 140
 141 @ifset web
 142
 143 @c make link to bugfixes for news.itexi
 144 @c use underscores for version: @bugfixes{2_13_13,}
 145 @c use specifier arg when listing multiple versions
 146 @c (see September 20, 2007 post for an example)
 147 @macro bugfixes{version,specifier}
 148 @uref{http://code.google.com/p/lilypond/issues/list?can=1&q=fixed_\version\&colspec=ID+Type+Status+Priority+Milestone+Owner+Summary,Bugfixes
 149 \specifier\}
 150 @end macro
 151
 152 @macro divId {ID}
 153 @html
 154 <div id="\ID\">
 155 @end html
 156 @end macro
 157
 158 @macro divClass {CLASS}
 159 @html
 160 <div class="\CLASS\">
 161 @end html
 162 @end macro
 163
 164 @macro divEnd
 165 @c keep the space for proper nesting of </p>
 166
 167 @html
 168 </div>
 169 @end html
 170 @end macro
 171
 172 @ifclear web_version
 173   @ifclear bigpage
 174     @macro docLink{name,target,webLink}
 175       @uref{../\target\, \name\}
 176     @end macro
 177   @end ifclear
 178   @ifset bigpage
 179     @macro docLink{name,target,webLink}
 180       @uref{\target\, \name\}
 181     @end macro
 182   @end ifset
 183 @end ifclear
 184 @ifset web_version
 185   @macro docLink{name,target,webLink}
 186     \webLink\
 187   @end macro
 188 @end ifset
 189
 190 @macro miscLink{MISC-FILE,MISC-TEXT}
 191 @uref{http://lilypond.org/website/misc/\MISC-FILE\,\MISC-TEXT\}
 192 @end macro
 193
 194 @macro spanClass {CLASS}
 195 @html
 196 <span class="\CLASS\">
 197 @end html
 198 @end macro
 199
 200 @macro spanEnd
 201 @c keep the space for proper nesting of </p>
 202
 203 @html
 204 </span>
 205 @end html
 206 @end macro
 207
 208
 209 @c not strictly necessary, but it makes things easier for updating news
 210 @macro newsItem
 211 @html
 212 <div class="news-item">
 213 @end html
 214 @end macro
 215
 216 @macro newsEnd
 217 @c keep the space for proper nesting of </p>
 218
 219 @html
 220 </div>
 221 @end html
 222 @end macro
 223
 224
 225 @macro imageClickable{IMAGE-FILE, EXT, MORE-TEXT, CLICK-FILE, CLICK-EXT, POSITION}
 226 @html
 227 <div class="float-\POSITION\">
 228   <a class="clickable" href="pictures/\CLICK-FILE\.\CLICK-EXT\">
 229     <img src="pictures/\IMAGE-FILE\.\EXT\" alt="\IMAGE-FILE\">
 230   </a>
 231   <p style="text-align: center">
 232     \MORE-TEXT\
 233   </p>
 234 </div>
 235 @end html
 236 @iftex
 237 @image{pictures/\IMAGE-FILE\,,,\IMAGE-FILE\}
 238 @end iftex
 239 @ifinfo
 240 @image{lilypond/pictures/\IMAGE-FILE\,,,\IMAGE-FILE\}
 241 @end ifinfo
 242 @end macro
 243
 244 @macro imageFloat{IMAGE-FILE, EXT, POSITION}
 245 @html
 246 <img class="float-\POSITION\" src="pictures/\IMAGE-FILE\.\EXT\" alt="\IMAGE-FILE\">
 247 @end html
 248 @iftex
 249 @image{pictures/\IMAGE-FILE\,,,\IMAGE-FILE\,\EXT\}
 250 @end iftex
 251 @ifinfo
 252 @image{lilypond/pictures/\IMAGE-FILE\,,,\EXT\}
 253 @end ifinfo
 254 @end macro
 255
 256 @macro imageId{ID, IMAGE-FILE, EXT, ALT}
 257 @html
 258 <div id="\ID\">
 259   <img src="pictures/\IMAGE-FILE\.\EXT\" alt="\ALT\">
 260 </div>
 261 @end html
 262 @iftex
 263 @image{pictures/\IMAGE-FILE\,,,\ALT\}
 264 @end iftex
 265 @ifinfo
 266 @image{lilypond/pictures/\IMAGE-FILE\,,,\ALT\}
 267 @end ifinfo
 268 @end macro
 269
 270 @end ifset