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