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