Documentation/user/macros.itexi

   1 @c -*- coding: latin-1; mode: texinfo; -*-
   2
   3 @c **** all formats ****
   4
   5 @macro refbugs
   6 @noindent
   7 @subsubheading Bugs
   8
   9 @end macro
  10
  11 @macro moreinfo
  12 @subheading More information
  13
  14 @end macro
  15
  16 @macro seealso
  17 @noindent
  18 @subsubheading See also
  19
  20 @end macro
  21
  22 @macro refcommands
  23 @noindent
  24 @subsubheading Predefined commands
  25
  26 @end macro
  27
  28 @macro context{NAME}
  29 @vindex \NAME\
  30 @code{\NAME\}@c should use internalsref
  31 @end macro
  32
  33 @macro refcommand{WHAT}
  34 @vindex \WHAT\
  35 @code{\WHAT\}
  36 @end macro
  37
  38 @macro commonprop
  39 @noindent
  40 @subsubheading Commonly tweaked properties
  41
  42 @end macro
  43
  44 @macro funindex {WORD}
  45 @findex \WORD\
  46 @kindex \WORD\
  47 @end macro
  48
  49
  50
  51 @c  *** Macros with variable output ***
  52
  53 @c usage: @lsr{ancient,custodes.ly}
  54 @macro lsr{DIR,NAME}
  55 @ifhtml
  56   @uref{source/input/lsr/\DIR\/collated-files.html#\NAME\,@file{\DIR\/\NAME\}}
  57 @end ifhtml
  58 @ifnothtml
  59   @file{\DIR\/\NAME\}
  60 @end ifnothtml
  61 @end macro
  62
  63 @macro lsrdir{DIR}
  64 @ifhtml
  65   @uref{source/input/lsr/\DIR\/collated-files.html,@file{\DIR\}/}
  66 @end ifhtml
  67 @ifnothtml
  68   @file{\DIR\}
  69 @end ifnothtml
  70 @end macro
  71
  72
  73
  74
  75 @macro arrow{}
  76 @iftex
  77 @tex $\\Rightarrow$ @end tex@c
  78 @end iftex
  79 @ifhtml
  80 @html
  81 &rarr;
  82 @end html
  83 @end ifhtml
  84 @ifinfo
  85 -->
  86 @end ifinfo
  87 @end macro
  88
  89
  90 @c we need this since @q{\} doesn't work with makeinfo 4.8 --
  91 @c say @q{@value{backslash}} instead
  92 @set backslash \
  93
  94
  95 @ifhtml
  96 @c ***** HTML *****
  97
  98 @c makeinfo-4.7 encodes html names, which means that nodes that
  99 @c contain nonalphanum characters will be broken links on the website.
 100 @c @uref{../lilypond-internals/\NAME\.html,\NAME\}@c
 101 @c @inforef{} adds ``See'' to the sentence, which is annoying, but
 102 @c better than a broken link.
 103 @c @inforef{\NAME\,,lilypond-internals}@c
 104 @c using @ref without punctuation is OK without for formats other than info
 105
 106 @ifset bigpage
 107
 108 @macro internalsref{NAME}
 109 @vindex \NAME\
 110 @ref{\NAME\,,,lilypond-internals-big-page}
 111 @end macro
 112
 113 @macro rglos{NAME}
 114 @vindex \NAME\
 115 @ref{\NAME\,,,music-glossary-big-page}
 116 @end macro
 117
 118 @macro rprogram{NAME}
 119 @vindex \NAME\
 120 @ref{\NAME\,,,lilypond-program-big-page}
 121 @end macro
 122
 123 @macro rprogram{NAME}
 124 @vindex \NAME\
 125 @ref{\NAME\,,,lilypond-program}
 126 @end macro
 127
 128 @macro ruser{NAME}
 129 @vindex \NAME\
 130 @ref{\NAME\,,,lilypond-big-page}
 131 @end macro
 132
 133 @end ifset
 134
 135
 136 @ifclear bigpage
 137
 138 @macro internalsref{NAME}
 139 @vindex \NAME\
 140 @ref{\NAME\,,,lilypond-internals}
 141 @end macro
 142
 143 @macro rglos{NAME}
 144 @vindex \NAME\
 145 @ref{\NAME\,,,music-glossary}
 146 @end macro
 147
 148 @macro rprogram{NAME}
 149 @vindex \NAME\
 150 @ref{\NAME\,,,lilypond-program}
 151 @end macro
 152
 153 @macro ruser{NAME}
 154 @vindex \NAME\
 155 @ref{\NAME\,,,lilypond}
 156 @end macro
 157
 158 @end ifclear
 159
 160
 161 @c to get decent quotes in `foo'
 162 @macro q{TEXT}
 163 @html
 164 &lsquo;\TEXT\&rsquo;
 165 @end html
 166 @end macro
 167
 168 @c to get decent quotes in ``foo''
 169 @macro qq{TEXT}
 170 @html
 171 &ldquo;\TEXT\&rdquo;
 172 @end html
 173 @end macro
 174
 175 @end ifhtml
 176
 177
 178 @ifdocbook
 179 @c ***** DOCBOOK-XML *****
 180
 181 @macro internalsref{NAME}
 182 @vindex \NAME\
 183 @ref{\NAME\,,,lilypond-internals}
 184 @end macro
 185
 186 @macro inputfileref{DIR,NAME}
 187 @uref{source/\DIR\/collated-files.html#\NAME\,@file{\DIR\/\NAME\}}
 188 @end macro
 189
 190 @macro rglos{NAME}
 191 @vindex \NAME\
 192 @ref{\NAME\,,,music-glossary}
 193 @end macro
 194
 195 @macro rprogram{NAME}
 196 @vindex \NAME\
 197 @ref{\NAME\,,,lilypond-program}
 198 @end macro
 199
 200 @macro ruser{NAME}
 201 @vindex \NAME\
 202 @ref{\NAME\,,,lilypond}
 203 @end macro
 204
 205 @c to get decent quotes in `foo'
 206 @macro q{TEXT}
 207 @xml
 208 &lsquo;\TEXT\&rsquo;
 209 @end xml
 210 @end macro
 211
 212 @c to get decent quotes in ``foo''
 213 @macro qq{TEXT}
 214 @xml
 215 &ldquo;\TEXT\&rdquo;
 216 @end xml
 217 @end macro
 218
 219 @end ifdocbook
 220
 221
 222 @ifinfo
 223 @c **** INFO ****
 224
 225 @macro internalsref{NAME}
 226 @vindex \NAME\
 227 @inforef{\NAME\,,lilypond-internals}
 228 @end macro
 229
 230 @macro inputfileref{DIR,NAME}
 231 @file{\DIR\/\NAME\}
 232 @end macro
 233
 234 @macro rglos{NAME}
 235 @vindex \NAME\
 236 @inforef{\NAME\,,,music-glossary}
 237 @end macro
 238
 239 @macro usermanref{NAME}
 240 @inforef{\NAME\}
 241 @end macro
 242
 243 @macro rprogram{NAME}
 244 @vindex \NAME\
 245 @ref{\NAME\,,,lilypond-program}
 246 @end macro
 247
 248 @macro ruser{NAME}
 249 @vindex \NAME\
 250 @ref{\NAME\,,,lilypond}
 251 @end macro
 252
 253 @c to get decent quotes in `foo'
 254 @macro q{TEXT}
 255 `\TEXT\'
 256 @end macro
 257
 258 @c to get decent quotes in ``foo''
 259 @macro qq{TEXT}
 260 ``\TEXT\''
 261 @end macro
 262
 263 @end ifinfo
 264
 265
 266 @c **** TEX ****
 267 @iftex
 268
 269 @macro internalsref{NAME}
 270 @vindex \NAME\
 271 @code{\NAME\}
 272 @end macro
 273
 274 @macro inputfileref{DIR,NAME}
 275 @file{\DIR\/@/\NAME\}
 276 @end macro
 277
 278 @macro rglos {NAME}
 279 @vindex \NAME\
 280 @code{\NAME\}
 281 @end macro
 282
 283 @macro seeinternals{NAME}
 284 internals document, @internalsref{\NAME\}
 285 @end macro
 286
 287 @macro usermanref{NAME}
 288 user manual, @internalsref{\NAME\}
 289 @end macro
 290
 291 @macro rprogram{NAME}
 292 program usage manual, @internalsref{\NAME\}
 293 @end macro
 294
 295 @alias ruser=usermanref
 296
 297 @c to get decent quotes in `foo'
 298 @macro q{TEXT}
 299 `\TEXT\'
 300 @end macro
 301
 302 @c to get decent quotes in ``foo''
 303 @macro qq{TEXT}
 304 ``\TEXT\''
 305 @end macro
 306
 307 @end iftex
 308
 309
 310 @ifnottex
 311 @c **** not TEX ****
 312
 313 @macro seeinternals{NAME}
 314 @internalsref{\NAME\}
 315 @end macro
 316
 317 @ifnotinfo
 318 @macro usermanref{NAME}
 319 @ref{\NAME\}
 320 @end macro
 321 @end ifnotinfo
 322
 323 @end ifnottex
 324
 325
 326 @c EOF