Documentation/user/macros.itexi

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