Documentation/user/macros.itexi

   1 @c -*- coding: us-ascii; mode: texinfo; -*-
   2 @ignore
   3     Translation of GIT committish: FILL-IN-HEAD-COMMITTISH
   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 @c @value{version}
  10 @macro version
  11 2.11.41
  12 @end macro
  13
  14 @c   ***** Displaying text *****
  15
  16 @c we need this since @q{\} doesn't work with makeinfo 4.8 --
  17 @c say @q{@value{backslash}} instead
  18 @set backslash \
  19
  20 @c to get decent quotes in `foo' and ``foo''
  21 @macro q{TEXT}
  22 @quoteleft{}\TEXT\@quoteright{}
  23 @end macro
  24
  25 @macro qq{TEXT}
  26 @quotedblleft{}\TEXT\@quotedblright{}
  27 @end macro
  28
  29 @macro warning{TEXT}
  30 @ifhtml
  31 @cartouche
  32 @b{Note:} \TEXT\
  33 @end cartouche
  34 @end ifhtml
  35 @ifnothtml
  36 @quotation
  37 @quotation
  38 @cartouche
  39 @b{Note:} \TEXT\
  40 @end cartouche
  41 @end quotation
  42 @end quotation
  43 @end ifnothtml
  44 @end macro
  45
  46 @ifnotinfo
  47 @macro notation{TEXT}
  48 @var{\TEXT\}
  49 @end macro
  50 @end ifnotinfo
  51
  52 @ifinfo
  53 @macro notation{TEXT}
  54 \TEXT\
  55 @end macro
  56 @end ifinfo
  57
  58 @macro smallspace
  59 @sp 1
  60 @end macro
  61
  62
  63 @c   **** Displaying images not generated by lilypond-book
  64
  65 @c current installation setup of Info docs requires that all images are
  66 @c expected to be found in lilypond/ subdirectory.  lilypond-book already
  67 @c generates proper @image commands for images of music; these macros
  68 @c definitions do the same for other images.
  69
  70 @ifnotinfo
  71 @macro sourceimage{FILENAME,WIDTH,HEIGHT,ALTTEXT}
  72 @image{\FILENAME\,\WIDTH\,\HEIGHT\,\ALTTEXT\}
  73 @end macro
  74 @end ifnotinfo
  75
  76 @ifinfo
  77 @macro sourceimage{FILENAME,WIDTH,HEIGHT,ALTTEXT}
  78 @image{lilypond/\FILENAME\,\WIDTH\,\HEIGHT\,\ALTTEXT\}
  79 @end macro
  80 @end ifinfo
  81
  82
  83 @c   **** Headings in a doc subsection ****
  84
  85 @macro predefined
  86 @noindent
  87 @subsubheading Predefined commands
  88
  89 @end macro
  90
  91 @macro snippets
  92 @noindent
  93 @subsubheading Selected Snippets
  94
  95 @end macro
  96
  97 @macro seealso
  98 @noindent
  99 @subsubheading See also
 100
 101 @indent
 102 @end macro
 103
 104 @macro knownissues
 105 @noindent
 106 @subsubheading Known issues and warnings
 107
 108 @end macro
 109
 110 @macro funindex {TEXT}
 111 @findex \TEXT\
 112 @kindex \TEXT\
 113 @end macro
 114
 115
 116
 117 @c   **** Links and references ****
 118
 119 @c  Possibly deprecated; under discussion.
 120 @c usage: @lsr{ancient,Ancient-notation,custodes.ly}
 121 @macro lsr{SECTION,DIR,TEXT}
 122 @ifhtml
 123 @uref{source/input/lsr/snippets/\DIR\.html#\TEXT\,@file{\SECTION\/\TEXT\}}
 124 @end ifhtml
 125 @ifnothtml
 126 @file{\SECTION\/\TEXT\}
 127 @end ifnothtml
 128 @end macro
 129
 130 @c usage: @lsrdir{ancient,Ancient-notation}
 131 @macro lsrdir{SECTION,DIR}
 132 @ifhtml
 133 @uref{source/input/lsr/snippets/\DIR\.html,\SECTION\}
 134 @end ifhtml
 135 @ifnothtml
 136 \DIR\
 137 @end ifnothtml
 138 @end macro
 139
 140
 141 @c  Definitions for references:
 142 @c     @internalsref
 143 @c     @rglos
 144 @c     @rprogram
 145 @c     @ruser
 146 @c     @rlearning
 147
 148 @ifhtml
 149 @c ***** HTML *****
 150
 151 @ifset bigpage
 152
 153 @macro internalsref{TEXT}
 154 @vindex \TEXT\
 155 @ref{\TEXT\,,,lilypond-internals-big-page}
 156 @end macro
 157
 158 @macro rglos{TEXT}
 159 @vindex \TEXT\
 160 @ref{\TEXT\,,,music-glossary-big-page}
 161 @end macro
 162
 163 @macro rprogram{TEXT}
 164 @vindex \TEXT\
 165 @ref{\TEXT\,,,lilypond-program-big-page}
 166 @end macro
 167
 168 @macro ruser{TEXT}
 169 @vindex \TEXT\
 170 @ref{\TEXT\,,,lilypond-big-page}
 171 @end macro
 172
 173 @macro rlearning{TEXT}
 174 @vindex \TEXT\
 175 @ref{\TEXT\,,,lilypond-learning-big-page}
 176 @end macro
 177
 178 @macro rlsr{TEXT}
 179 @ref{\TEXT\,,,lilypond-snippets-big-page}
 180 @end macro
 181
 182 @end ifset
 183
 184
 185 @ifclear bigpage
 186
 187 @macro internalsref{TEXT}
 188 @vindex \TEXT\
 189 @ref{\TEXT\,,,lilypond-internals}
 190 @end macro
 191
 192 @macro rglos{TEXT}
 193 @vindex \TEXT\
 194 @ref{\TEXT\,,,music-glossary}
 195 @end macro
 196
 197 @macro rprogram{TEXT}
 198 @vindex \TEXT\
 199 @ref{\TEXT\,,,lilypond-program}
 200 @end macro
 201
 202 @macro ruser{TEXT}
 203 @vindex \TEXT\
 204 @ref{\TEXT\,,,lilypond}
 205 @end macro
 206
 207 @macro rlearning{TEXT}
 208 @vindex \TEXT\
 209 @ref{\TEXT\,,,lilypond-learning}
 210 @end macro
 211
 212 @macro rlsr{TEXT}
 213 @ref{\TEXT\,,,lilypond-snippets}
 214 @end macro
 215
 216 @end ifclear
 217
 218 @end ifhtml
 219
 220
 221 @ifdocbook
 222 @c ***** DOCBOOK-XML *****
 223
 224 @macro internalsref{TEXT}
 225 @vindex \TEXT\
 226 @ref{\TEXT\,,,lilypond-internals}
 227 @end macro
 228
 229 @macro rglos{TEXT}
 230 @vindex \TEXT\
 231 @ref{\TEXT\,,,music-glossary}
 232 @end macro
 233
 234 @macro rprogram{TEXT}
 235 @vindex \TEXT\
 236 @ref{\TEXT\,,,lilypond-program}
 237 @end macro
 238
 239 @macro ruser{TEXT}
 240 @vindex \TEXT\
 241 @ref{\TEXT\,,,lilypond}
 242 @end macro
 243
 244 @macro rlearning{TEXT}
 245 @vindex \TEXT\
 246 @ref{\TEXT\,,,lilypond-learning}
 247 @end macro
 248
 249 @macro rlsr{TEXT}
 250 @ref{\TEXT\,,,lilypond-snippets}
 251 @end macro
 252
 253 @end ifdocbook
 254
 255
 256 @ifinfo
 257 @c **** INFO ****
 258
 259 @macro internalsref{TEXT}
 260 @vindex \TEXT\
 261 @inforef{\TEXT\,,lilypond-internals}
 262 @end macro
 263
 264 @macro rglos{TEXT}
 265 @vindex \TEXT\
 266 @inforef{\TEXT\,,music-glossary}
 267 @end macro
 268
 269 @macro rprogram{TEXT}
 270 @vindex \TEXT\
 271 @ref{\TEXT\,,,lilypond-program}
 272 @end macro
 273
 274 @macro ruser{TEXT}
 275 @vindex \TEXT\
 276 @ref{\TEXT\,,,lilypond}
 277 @end macro
 278
 279 @macro rlearning{TEXT}
 280 @vindex \TEXT\
 281 @ref{\TEXT\,,,lilypond-learning}
 282 @end macro
 283
 284 @macro rlsr{TEXT}
 285 @ref{\TEXT\,,,lilypond-snippets}
 286 @end macro
 287
 288 @end ifinfo
 289
 290
 291 @c **** TEX ****
 292 @iftex
 293
 294 @macro internalsref{TEXT}
 295 @vindex \TEXT\
 296 @code{\TEXT\}
 297 @end macro
 298
 299 @macro rglos {TEXT}
 300 @vindex \TEXT\
 301 @ref{\TEXT\,,,music-glossary}
 302 @end macro
 303
 304 @macro rprogram{TEXT}
 305 program usage manual, @ref{\TEXT\,,,lilypond-program}
 306 @end macro
 307
 308 @macro ruser{TEXT}
 309 notation reference, @ref{\TEXT\,,,lilypond}
 310 @end macro
 311
 312 @macro rlearning{TEXT}
 313 learning manual, @ref{\TEXT\,,,lilypond-learning}
 314 @end macro
 315
 316 @macro rlsr{TEXT}
 317 @ref{\TEXT\,,,lilypond-snippets}
 318 @end macro
 319
 320 @end iftex
 321
 322
 323 @c EOF