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 ruser{NAME}
 124 @vindex \NAME\
 125 @ref{\NAME\,,,lilypond-big-page}
 126 @end macro
 127
 128 @end ifset
 129
 130
 131 @ifclear bigpage
 132
 133 @macro internalsref{NAME}
 134 @vindex \NAME\
 135 @ref{\NAME\,,,lilypond-internals}
 136 @end macro
 137
 138 @macro rglos{NAME}
 139 @vindex \NAME\
 140 @ref{\NAME\,,,music-glossary}
 141 @end macro
 142
 143 @macro rprogram{NAME}
 144 @vindex \NAME\
 145 @ref{\NAME\,,,lilypond-program}
 146 @end macro
 147
 148 @macro ruser{NAME}
 149 @vindex \NAME\
 150 @ref{\NAME\,,,lilypond}
 151 @end macro
 152
 153 @end ifclear
 154
 155
 156 @c to get decent quotes in `foo'
 157 @macro q{TEXT}
 158 @html
 159 &lsquo;\TEXT\&rsquo;
 160 @end html
 161 @end macro
 162
 163 @c to get decent quotes in ``foo''
 164 @macro qq{TEXT}
 165 @html
 166 &ldquo;\TEXT\&rdquo;
 167 @end html
 168 @end macro
 169
 170 @end ifhtml
 171
 172
 173 @ifdocbook
 174 @c ***** DOCBOOK-XML *****
 175
 176 @macro internalsref{NAME}
 177 @vindex \NAME\
 178 @ref{\NAME\,,,lilypond-internals}
 179 @end macro
 180
 181 @macro inputfileref{DIR,NAME}
 182 @uref{source/\DIR\/collated-files.html#\NAME\,@file{\DIR\/\NAME\}}
 183 @end macro
 184
 185 @macro rglos{NAME}
 186 @vindex \NAME\
 187 @ref{\NAME\,,,music-glossary}
 188 @end macro
 189
 190 @macro rprogram{NAME}
 191 @vindex \NAME\
 192 @ref{\NAME\,,,lilypond-program}
 193 @end macro
 194
 195 @macro ruser{NAME}
 196 @vindex \NAME\
 197 @ref{\NAME\,,,lilypond}
 198 @end macro
 199
 200 @c to get decent quotes in `foo'
 201 @macro q{TEXT}
 202 @xml
 203 &lsquo;\TEXT\&rsquo;
 204 @end xml
 205 @end macro
 206
 207 @c to get decent quotes in ``foo''
 208 @macro qq{TEXT}
 209 @xml
 210 &ldquo;\TEXT\&rdquo;
 211 @end xml
 212 @end macro
 213
 214 @end ifdocbook
 215
 216
 217 @ifinfo
 218 @c **** INFO ****
 219
 220 @macro internalsref{NAME}
 221 @vindex \NAME\
 222 @inforef{\NAME\,,lilypond-internals}
 223 @end macro
 224
 225 @macro inputfileref{DIR,NAME}
 226 @file{\DIR\/\NAME\}
 227 @end macro
 228
 229 @macro rglos{NAME}
 230 @vindex \NAME\
 231 @inforef{\NAME\,,,music-glossary}
 232 @end macro
 233
 234 @macro usermanref{NAME}
 235 @inforef{\NAME\}
 236 @end macro
 237
 238 @macro rprogram{NAME}
 239 @vindex \NAME\
 240 @ref{\NAME\,,,lilypond-program}
 241 @end macro
 242
 243 @macro ruser{NAME}
 244 @vindex \NAME\
 245 @ref{\NAME\,,,lilypond}
 246 @end macro
 247
 248 @c to get decent quotes in `foo'
 249 @macro q{TEXT}
 250 `\TEXT\'
 251 @end macro
 252
 253 @c to get decent quotes in ``foo''
 254 @macro qq{TEXT}
 255 ``\TEXT\''
 256 @end macro
 257
 258 @end ifinfo
 259
 260
 261 @c **** TEX ****
 262 @iftex
 263
 264 @macro internalsref{NAME}
 265 @vindex \NAME\
 266 @code{\NAME\}
 267 @end macro
 268
 269 @macro inputfileref{DIR,NAME}
 270 @file{\DIR\/@/\NAME\}
 271 @end macro
 272
 273 @macro rglos {NAME}
 274 @vindex \NAME\
 275 @code{\NAME\}
 276 @end macro
 277
 278 @macro seeinternals{NAME}
 279 internals document, @internalsref{\NAME\}
 280 @end macro
 281
 282 @macro usermanref{NAME}
 283 user manual, @internalsref{\NAME\}
 284 @end macro
 285
 286 @macro rprogram{NAME}
 287 program usage manual, @internalsref{\NAME\}
 288 @end macro
 289
 290 @alias ruser=usermanref
 291
 292 @c to get decent quotes in `foo'
 293 @macro q{TEXT}
 294 `\TEXT\'
 295 @end macro
 296
 297 @c to get decent quotes in ``foo''
 298 @macro qq{TEXT}
 299 ``\TEXT\''
 300 @end macro
 301
 302 @end iftex
 303
 304
 305 @ifnottex
 306 @c **** not TEX ****
 307
 308 @macro seeinternals{NAME}
 309 @internalsref{\NAME\}
 310 @end macro
 311
 312 @ifnotinfo
 313 @macro usermanref{NAME}
 314 @ref{\NAME\}
 315 @end macro
 316 @end ifnotinfo
 317
 318 @end ifnottex
 319
 320
 321 @c EOF