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