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 @end ifset
 119
 120
 121 @ifclear bigpage
 122
 123 @c annoying parentheses stripped by add-html-footer.py
 124 @macro internalsref{NAME}
 125 @vindex \NAME\
 126 @ref{\NAME\,,,lilypond-internals}
 127 @end macro
 128
 129 @c annoying parentheses stripped by add-html-footer.py
 130 @macro rglos{NAME}
 131 @vindex \NAME\
 132 @ref{\NAME\,,,music-glossary}
 133 @end macro
 134
 135 @end ifclear
 136
 137
 138 @c usage: @inputfileref{input@/regression,FILE@/-NAME.ly}
 139 @macro inputfileref{DIR,NAME}
 140 @uref{source/\DIR\/collated-files.html#\NAME\,@file{\DIR\/\NAME\}}@c
 141 @end macro
 142
 143 @c to get decent quotes in `foo'
 144 @macro q{TEXT}
 145 @html
 146 &lsquo;\TEXT\&rsquo;
 147 @end html
 148 @end macro
 149
 150 @c to get decent quotes in ``foo''
 151 @macro qq{TEXT}
 152 @html
 153 &ldquo;\TEXT\&rdquo;
 154 @end html
 155 @end macro
 156
 157 @end ifhtml
 158
 159
 160 @ifdocbook
 161 @c ***** DOCBOOK-XML *****
 162
 163 @macro internalsref{NAME}
 164 @vindex \NAME\
 165 @ref{\NAME\,,,lilypond-internals}
 166 @end macro
 167
 168 @macro inputfileref{DIR,NAME}
 169 @uref{source/\DIR\/collated-files.html#\NAME\,@file{\DIR\/\NAME\}}
 170 @end macro
 171
 172 @macro rglos{NAME}
 173 @vindex \NAME\
 174 @ref{\NAME\,,,music-glossary}
 175 @end macro
 176
 177 @c to get decent quotes in `foo'
 178 @macro q{TEXT}
 179 @xml
 180 &lsquo;\TEXT\&rsquo;
 181 @end xml
 182 @end macro
 183
 184 @c to get decent quotes in ``foo''
 185 @macro qq{TEXT}
 186 @xml
 187 &ldquo;\TEXT\&rdquo;
 188 @end xml
 189 @end macro
 190
 191 @end ifdocbook
 192
 193
 194 @ifinfo
 195 @c **** INFO ****
 196
 197 @macro internalsref{NAME}
 198 @vindex \NAME\
 199 @inforef{\NAME\,,lilypond-internals}
 200 @end macro
 201
 202 @macro inputfileref{DIR,NAME}
 203 @file{\DIR\/\NAME\}
 204 @end macro
 205
 206 @macro rglos{NAME}@c
 207 @vindex \NAME\
 208 @inforef{\NAME\,,,music-glossary}
 209 @end macro
 210
 211 @macro usermanref{NAME}
 212 @inforef{\NAME\}
 213 @end macro
 214
 215 @c to get decent quotes in `foo'
 216 @macro q{TEXT}
 217 `\TEXT\'
 218 @end macro
 219
 220 @c to get decent quotes in ``foo''
 221 @macro qq{TEXT}
 222 ``\TEXT\''
 223 @end macro
 224
 225 @end ifinfo
 226
 227
 228 @c **** TEX ****
 229 @iftex
 230
 231 @macro internalsref{NAME}
 232 @vindex \NAME\
 233 @code{\NAME\}
 234 @end macro
 235
 236 @macro inputfileref{DIR,NAME}
 237 @file{\DIR\/@/\NAME\}
 238 @end macro
 239
 240 @macro rglos {NAME}
 241 @vindex \NAME\
 242 @code{\NAME\}
 243 @end macro
 244
 245 @macro seeinternals{NAME}
 246 internals document, @internalsref{\NAME\}
 247 @end macro
 248
 249 @macro usermanref{NAME}
 250 user manual, @internalsref{\NAME\}
 251 @end macro
 252
 253 @c to get decent quotes in `foo'
 254 @macro q{TEXT}
 255 `\TEXT\'
 256 @end macro
 257
 258 @c to get decent quotes in ``foo''
 259 @macro qq{TEXT}
 260 ``\TEXT\''
 261 @end macro
 262
 263 @end iftex
 264
 265
 266 @ifnottex
 267 @c **** not TEX ****
 268
 269 @macro seeinternals{NAME}
 270 @internalsref{\NAME\}
 271 @end macro
 272
 273 @ifnotinfo
 274 @macro usermanref{NAME}
 275 @ref{\NAME\}
 276 @end macro
 277 @end ifnotinfo
 278
 279 @end ifnottex
 280
 281
 282 @c EOF