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