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