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