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 @c annoying parentheses stripped by add-html-footer.py
  74 @macro internalsref{NAME}
  75 @vindex \NAME\
  76 @ref{\NAME\,,,lilypond-internals}
  77 @end macro
  78
  79 @c usage: @inputfileref{input@/regression,FILE@/-NAME.ly}
  80 @macro inputfileref{DIR,NAME}
  81 @uref{source/\DIR\/collated-files.html#\NAME\,@file{\DIR\/\NAME\}}@c
  82 @end macro
  83
  84 @c annoying parentheses stripped by add-html-footer.py
  85 @macro rglos{NAME}
  86 @vindex \NAME\
  87 @ref{\NAME\,,,music-glossary}
  88 @end macro
  89
  90 @c to get decent quotes in `foo'
  91 @macro q{TEXT}
  92 @html
  93 &lsquo;\TEXT\&rsquo;
  94 @end html
  95 @end macro
  96
  97 @c to get decent quotes in ``foo''
  98 @macro qq{TEXT}
  99 @html
 100 &ldquo;\TEXT\&rdquo;
 101 @end html
 102 @end macro
 103
 104 @end ifhtml
 105
 106
 107 @ifdocbook
 108 @c ***** DOCBOOK-XML *****
 109
 110 @macro internalsref{NAME}
 111 @vindex \NAME\
 112 @ref{\NAME\,,,lilypond-internals}
 113 @end macro
 114
 115 @macro inputfileref{DIR,NAME}
 116 @uref{source/\DIR\/collated-files.html#\NAME\,@file{\DIR\/\NAME\}}
 117 @end macro
 118
 119 @macro rglos{NAME}
 120 @vindex \NAME\
 121 @ref{\NAME\,,,music-glossary}
 122 @end macro
 123
 124 @c to get decent quotes in `foo'
 125 @macro q{TEXT}
 126 @xml
 127 &lsquo;\TEXT\&rsquo;
 128 @end xml
 129 @end macro
 130
 131 @c to get decent quotes in ``foo''
 132 @macro qq{TEXT}
 133 @xml
 134 &ldquo;\TEXT\&rdquo;
 135 @end xml
 136 @end macro
 137
 138 @end ifdocbook
 139
 140
 141 @ifinfo
 142 @c **** INFO ****
 143
 144 @macro internalsref{NAME}
 145 @vindex \NAME\
 146 @inforef{\NAME\,,lilypond-internals}
 147 @end macro
 148
 149 @macro inputfileref{DIR,NAME}
 150 @file{\DIR\/\NAME\}
 151 @end macro
 152
 153 @macro rglos{NAME}@c
 154 @vindex \NAME\
 155 @inforef{\NAME\,,,music-glossary}
 156 @end macro
 157
 158 @macro usermanref{NAME}
 159 @inforef{\NAME\}
 160 @end macro
 161
 162 @c to get decent quotes in `foo'
 163 @macro q{TEXT}
 164 `\TEXT\'
 165 @end macro
 166
 167 @c to get decent quotes in ``foo''
 168 @macro qq{TEXT}
 169 ``\TEXT\''
 170 @end macro
 171
 172 @end ifinfo
 173
 174
 175 @c **** TEX ****
 176 @iftex
 177
 178 @macro internalsref{NAME}
 179 @vindex \NAME\
 180 @code{\NAME\}
 181 @end macro
 182
 183 @macro inputfileref{DIR,NAME}
 184 @file{\DIR\/@/\NAME\}
 185 @end macro
 186
 187 @macro rglos {NAME}
 188 @vindex \NAME\
 189 @code{\NAME\}
 190 @end macro
 191
 192 @macro seeinternals{NAME}
 193 internals document, @internalsref{\NAME\}
 194 @end macro
 195
 196 @macro usermanref{NAME}
 197 user manual, @internalsref{\NAME\}
 198 @end macro
 199
 200 @c to get decent quotes in `foo'
 201 @macro q{TEXT}
 202 `\TEXT\'
 203 @end macro
 204
 205 @c to get decent quotes in ``foo''
 206 @macro qq{TEXT}
 207 ``\TEXT\''
 208 @end macro
 209
 210 @end iftex
 211
 212
 213 @ifnottex
 214 @c **** not TEX ****
 215
 216 @macro seeinternals{NAME}
 217 @internalsref{\NAME\}
 218 @end macro
 219
 220 @ifnotinfo
 221 @macro usermanref{NAME}
 222 @ref{\NAME\}
 223 @end macro
 224 @end ifnotinfo
 225
 226 @end ifnottex
 227
 228
 229 @c **** ALL ****
 230
 231 @macro refbugs
 232 @noindent
 233 @subsubheading Bugs
 234
 235 @end macro
 236
 237 @macro moreinfo
 238 @subheading More information
 239
 240 @end macro
 241
 242 @macro seealso
 243 @noindent
 244 @subsubheading See also
 245
 246 @end macro
 247
 248 @macro refcommands
 249 @noindent
 250 @subsubheading Predefined commands
 251
 252 @end macro
 253
 254 @macro context{NAME}
 255 @vindex \NAME\
 256 @code{\NAME\}@c should use internalsref
 257 @end macro
 258
 259 @macro refcommand{WHAT}
 260 @vindex \WHAT\
 261 @code{\WHAT\}
 262 @end macro
 263
 264 @macro commonprop
 265 @noindent
 266 @subsubheading Commonly tweaked properties
 267
 268 @end macro
 269
 270 @macro funindex {WORD}
 271 @findex \WORD\
 272 @kindex \WORD\
 273 @end macro
 274
 275 @c EOF