Documentation/user/macros.itexi

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