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 lydoctitle {TEXT}
 110 @emph{\TEXT\}
 111
 112 @end macro
 113
 114 @macro funindex {TEXT}
 115 @findex \TEXT\
 116 @kindex \TEXT\
 117 @end macro
 118
 119
 120
 121 @c   **** Links and references ****
 122
 123 @c  TO BE DEPRECATED
 124 @c usage: @lsrdir{ancient,Ancient-notation}
 125 @macro lsrdir{SECTION,DIR}
 126 @ifhtml
 127 @uref{source/input/lsr/lilypond-snippets/\DIR\.html,\SECTION\}
 128 @end ifhtml
 129 @ifnothtml
 130 \DIR\
 131 @end ifnothtml
 132 @end macro
 133
 134
 135 @c  Definitions for references:
 136 @c     @rglos
 137 @c     @rlearning
 138 @c     @ruser
 139 @c     @rprogram
 140 @c     @rsnippets
 141 @c     @rinternals
 142
 143 @ifhtml
 144 @c ***** HTML *****
 145
 146 @ifset bigpage
 147
 148 @c TO BE DEPRECATED
 149 @macro internalsref{TEXT}
 150 @vindex \TEXT\
 151 @ref{\TEXT\,,,lilypond-internals-big-page,Internals Reference}
 152 @end macro
 153
 154
 155 @macro rglos{TEXT}
 156 @vindex \TEXT\
 157 @ref{\TEXT\,,,music-glossary-big-page,Music Glossary}
 158 @end macro
 159
 160 @macro rlearning{TEXT}
 161 @vindex \TEXT\
 162 @ref{\TEXT\,,,lilypond-learning-big-page,Learning Manual}
 163 @end macro
 164
 165 @macro ruser{TEXT}
 166 @vindex \TEXT\
 167 @ref{\TEXT\,,,lilypond-big-page,Notation Reference}
 168 @end macro
 169
 170 @macro rprogram{TEXT}
 171 @vindex \TEXT\
 172 @ref{\TEXT\,,,lilypond-program-big-page,Application Usage}
 173 @end macro
 174
 175 @macro rlsr{TEXT}
 176 @ref{\TEXT\,,,lilypond-snippets-big-page,Snippets}
 177 @end macro
 178
 179 @macro rinternals{TEXT}
 180 @vindex \TEXT\
 181 @ref{\TEXT\,,,lilypond-internals-big-page,Internals Reference}
 182 @end macro
 183
 184 @end ifset
 185
 186
 187 @ifclear bigpage
 188
 189 @c  DEPRECATED
 190 @macro internalsref{TEXT}
 191 @vindex \TEXT\
 192 @ref{\TEXT\,,,lilypond-internals,Internals Reference}
 193 @end macro
 194
 195
 196 @macro rglos{TEXT}
 197 @vindex \TEXT\
 198 @ref{\TEXT\,,,music-glossary,Music Glossary}
 199 @end macro
 200
 201 @macro rlearning{TEXT}
 202 @vindex \TEXT\
 203 @ref{\TEXT\,,,lilypond-learning,Learning Manual}
 204 @end macro
 205
 206 @macro ruser{TEXT}
 207 @vindex \TEXT\
 208 @ref{\TEXT\,,,lilypond,Notation Reference}
 209 @end macro
 210
 211 @macro rprogram{TEXT}
 212 @vindex \TEXT\
 213 @ref{\TEXT\,,,lilypond-program,Application Usage}
 214 @end macro
 215
 216 @macro rlsr{TEXT}
 217 @ref{\TEXT\,,,lilypond-snippets,Snippets}
 218 @end macro
 219
 220 @macro rinternals{TEXT}
 221 @vindex \TEXT\
 222 @ref{\TEXT\,,,lilypond-internals,Internals Reference}
 223 @end macro
 224
 225 @end ifclear
 226
 227 @end ifhtml
 228
 229
 230 @ifdocbook
 231 @c ***** DOCBOOK-XML *****
 232
 233 @c  DEPRECATED
 234 @macro internalsref{TEXT}
 235 @vindex \TEXT\
 236 @ref{\TEXT\,,,lilypond-internals,Internals Reference}
 237 @end macro
 238
 239
 240
 241 @macro rglos{TEXT}
 242 @vindex \TEXT\
 243 @ref{\TEXT\,,,music-glossary,Music Glossary}
 244 @end macro
 245
 246 @macro rlearning{TEXT}
 247 @vindex \TEXT\
 248 @ref{\TEXT\,,,lilypond-learning,Learning Manual}
 249 @end macro
 250
 251 @macro ruser{TEXT}
 252 @vindex \TEXT\
 253 @ref{\TEXT\,,,lilypond,Notation Reference}
 254 @end macro
 255
 256 @macro rprogram{TEXT}
 257 @vindex \TEXT\
 258 @ref{\TEXT\,,,lilypond-program,Application Usage}
 259 @end macro
 260
 261 @macro rlsr{TEXT}
 262 @ref{\TEXT\,,,lilypond-snippets,Snippets}
 263 @end macro
 264
 265 @macro rinternals{TEXT}
 266 @vindex \TEXT\
 267 @ref{\TEXT\,,,lilypond-internals,Internals Reference}
 268 @end macro
 269
 270 @end ifdocbook
 271
 272
 273 @ifinfo
 274 @c **** INFO ****
 275
 276 @c DEPRECATED
 277 @macro internalsref{TEXT}
 278 @vindex \TEXT\
 279 @inforef{\TEXT\,,lilypond-internals,Internals Reference}
 280 @end macro
 281
 282
 283
 284 @macro rglos{TEXT}
 285 @vindex \TEXT\
 286 @inforef{\TEXT\,,music-glossary,Music Glossary}
 287 @end macro
 288
 289 @macro rlearning{TEXT}
 290 @vindex \TEXT\
 291 @ref{\TEXT\,,,lilypond-learning,Learning Manual}
 292 @end macro
 293
 294 @macro ruser{TEXT}
 295 @vindex \TEXT\
 296 @ref{\TEXT\,,,lilypond,Notation Reference}
 297 @end macro
 298
 299 @macro rprogram{TEXT}
 300 @vindex \TEXT\
 301 @ref{\TEXT\,,,lilypond-program,Application Usage}
 302 @end macro
 303
 304 @macro rlsr{TEXT}
 305 @ref{\TEXT\,,,lilypond-snippets,Snippets}
 306 @end macro
 307
 308 @macro rinternals{TEXT}
 309 @vindex \TEXT\
 310 @inforef{\TEXT\,,lilypond-internals,Internals Reference}
 311 @end macro
 312
 313 @end ifinfo
 314
 315
 316 @c **** TEX ****
 317 @iftex
 318
 319 @c DEPRECATED
 320 @macro internalsref{TEXT}
 321 @vindex \TEXT\
 322 @code{\TEXT\}
 323 @end macro
 324
 325
 326
 327 @macro rglos{TEXT}
 328 @vindex \TEXT\
 329 @ref{\TEXT\,,,music-glossary,Music Glossary}
 330 @end macro
 331
 332 @macro rlearning{TEXT}
 333 learning manual, @ref{\TEXT\,,,lilypond-learning,Learning Manual}
 334 @end macro
 335
 336 @macro ruser{TEXT}
 337 notation reference, @ref{\TEXT\,,,lilypond,Notation Reference}
 338 @end macro
 339
 340 @macro rprogram{TEXT}
 341 program usage manual, @ref{\TEXT\,,,lilypond-program,Application Usage}
 342 @end macro
 343
 344 @macro rlsr{TEXT}
 345 @ref{\TEXT\,,,lilypond-snippets,Snippets}
 346 @end macro
 347
 348 @macro rinternals{TEXT}
 349 @vindex \TEXT\
 350 @code{\TEXT\}
 351 @end macro
 352
 353 @end iftex
 354