Documentation/de/user/macros.itexi

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