Documentation/user/macros.itexi

   1 @c -*- coding: us-ascii; mode: texinfo; -*-
   2 @ignore
   3     Translation of GIT committish: FILL-IN-HEAD-COMMITTISH
   4
   5     When revising a translation, copy the HEAD committish of the
   6     version that you are working on.  See TRANSLATION for details.
   7 @end ignore
   8
   9 @c **** all formats ****
  10
  11 @macro refbugs
  12 @noindent
  13 @subsubheading Bugs
  14
  15 @end macro
  16
  17 @macro moreinfo
  18 @subheading More information
  19
  20 @end macro
  21
  22 @macro seealso
  23 @noindent
  24 @subsubheading See also
  25
  26 @end macro
  27
  28 @macro refcommands
  29 @noindent
  30 @subsubheading Predefined commands
  31
  32 @end macro
  33
  34 @macro context{NAME}
  35 @vindex \NAME\
  36 @code{\NAME\}@c should use internalsref
  37 @end macro
  38
  39 @macro refcommand{WHAT}
  40 @vindex \WHAT\
  41 @code{\WHAT\}
  42 @end macro
  43
  44 @macro commonprop
  45 @noindent
  46 @subsubheading Commonly tweaked properties
  47
  48 @end macro
  49
  50 @macro funindex {WORD}
  51 @findex \WORD\
  52 @kindex \WORD\
  53 @end macro
  54
  55
  56
  57 @c  *** Macros with variable output ***
  58
  59 @c usage: @lsr{ancient,custodes.ly}
  60 @macro lsr{DIR,NAME}
  61 @ifhtml
  62   @uref{source/input/lsr/\DIR\/collated-files.html#\NAME\,@file{\DIR\/\NAME\}}
  63 @end ifhtml
  64 @ifnothtml
  65   @file{\DIR\/\NAME\}
  66 @end ifnothtml
  67 @end macro
  68
  69 @macro lsrdir{DIR}
  70 @ifhtml
  71   @uref{source/input/lsr/\DIR\/collated-files.html,@file{\DIR\}/}
  72 @end ifhtml
  73 @ifnothtml
  74   @file{\DIR\}
  75 @end ifnothtml
  76 @end macro
  77
  78
  79
  80
  81 @macro arrow{}
  82 @iftex
  83 @tex $\\Rightarrow$ @end tex@c
  84 @end iftex
  85 @ifhtml
  86 @html
  87 &rarr;
  88 @end html
  89 @end ifhtml
  90 @ifinfo
  91 -->
  92 @end ifinfo
  93 @end macro
  94
  95
  96 @c we need this since @q{\} doesn't work with makeinfo 4.8 --
  97 @c say @q{@value{backslash}} instead
  98 @set backslash \
  99
 100
 101 @ifhtml
 102 @c ***** HTML *****
 103
 104 @c makeinfo-4.7 encodes html names, which means that nodes that
 105 @c contain nonalphanum characters will be broken links on the website.
 106 @c @uref{../lilypond-internals/\NAME\.html,\NAME\}@c
 107 @c @inforef{} adds ``See'' to the sentence, which is annoying, but
 108 @c better than a broken link.
 109 @c @inforef{\NAME\,,lilypond-internals}@c
 110 @c using @ref without punctuation is OK without for formats other than info
 111
 112 @ifset bigpage
 113
 114 @macro internalsref{NAME}
 115 @vindex \NAME\
 116 @ref{\NAME\,,,lilypond-internals-big-page}
 117 @end macro
 118
 119 @macro rglos{NAME}
 120 @vindex \NAME\
 121 @ref{\NAME\,,,music-glossary-big-page}
 122 @end macro
 123
 124 @macro rprogram{NAME}
 125 @vindex \NAME\
 126 @ref{\NAME\,,,lilypond-program-big-page}
 127 @end macro
 128
 129 @macro ruser{NAME}
 130 @vindex \NAME\
 131 @ref{\NAME\,,,lilypond-big-page}
 132 @end macro
 133
 134 @end ifset
 135
 136
 137 @ifclear bigpage
 138
 139 @macro internalsref{NAME}
 140 @vindex \NAME\
 141 @ref{\NAME\,,,lilypond-internals}
 142 @end macro
 143
 144 @macro rglos{NAME}
 145 @vindex \NAME\
 146 @ref{\NAME\,,,music-glossary}
 147 @end macro
 148
 149 @macro rprogram{NAME}
 150 @vindex \NAME\
 151 @ref{\NAME\,,,lilypond-program}
 152 @end macro
 153
 154 @macro ruser{NAME}
 155 @vindex \NAME\
 156 @ref{\NAME\,,,lilypond}
 157 @end macro
 158
 159 @end ifclear
 160
 161
 162 @c to get decent quotes in `foo'
 163 @macro q{TEXT}
 164 @html
 165 &lsquo;\TEXT\&rsquo;
 166 @end html
 167 @end macro
 168
 169 @c to get decent quotes in ``foo''
 170 @macro qq{TEXT}
 171 @html
 172 &ldquo;\TEXT\&rdquo;
 173 @end html
 174 @end macro
 175
 176 @end ifhtml
 177
 178
 179 @ifdocbook
 180 @c ***** DOCBOOK-XML *****
 181
 182 @macro internalsref{NAME}
 183 @vindex \NAME\
 184 @ref{\NAME\,,,lilypond-internals}
 185 @end macro
 186
 187 @macro inputfileref{DIR,NAME}
 188 @uref{source/\DIR\/collated-files.html#\NAME\,@file{\DIR\/\NAME\}}
 189 @end macro
 190
 191 @macro rglos{NAME}
 192 @vindex \NAME\
 193 @ref{\NAME\,,,music-glossary}
 194 @end macro
 195
 196 @macro rprogram{NAME}
 197 @vindex \NAME\
 198 @ref{\NAME\,,,lilypond-program}
 199 @end macro
 200
 201 @macro ruser{NAME}
 202 @vindex \NAME\
 203 @ref{\NAME\,,,lilypond}
 204 @end macro
 205
 206 @c to get decent quotes in `foo'
 207 @macro q{TEXT}
 208 @xml
 209 &lsquo;\TEXT\&rsquo;
 210 @end xml
 211 @end macro
 212
 213 @c to get decent quotes in ``foo''
 214 @macro qq{TEXT}
 215 @xml
 216 &ldquo;\TEXT\&rdquo;
 217 @end xml
 218 @end macro
 219
 220 @end ifdocbook
 221
 222
 223 @ifinfo
 224 @c **** INFO ****
 225
 226 @macro internalsref{NAME}
 227 @vindex \NAME\
 228 @inforef{\NAME\,,lilypond-internals}
 229 @end macro
 230
 231 @macro inputfileref{DIR,NAME}
 232 @file{\DIR\/\NAME\}
 233 @end macro
 234
 235 @macro rglos{NAME}
 236 @vindex \NAME\
 237 @inforef{\NAME\,,,music-glossary}
 238 @end macro
 239
 240 @macro usermanref{NAME}
 241 @inforef{\NAME\}
 242 @end macro
 243
 244 @macro rprogram{NAME}
 245 @vindex \NAME\
 246 @ref{\NAME\,,,lilypond-program}
 247 @end macro
 248
 249 @macro ruser{NAME}
 250 @vindex \NAME\
 251 @ref{\NAME\,,,lilypond}
 252 @end macro
 253
 254 @c to get decent quotes in `foo'
 255 @macro q{TEXT}
 256 `\TEXT\'
 257 @end macro
 258
 259 @c to get decent quotes in ``foo''
 260 @macro qq{TEXT}
 261 ``\TEXT\''
 262 @end macro
 263
 264 @end ifinfo
 265
 266
 267 @c **** TEX ****
 268 @iftex
 269
 270 @macro internalsref{NAME}
 271 @vindex \NAME\
 272 @code{\NAME\}
 273 @end macro
 274
 275 @macro inputfileref{DIR,NAME}
 276 @file{\DIR\/@/\NAME\}
 277 @end macro
 278
 279 @macro rglos {NAME}
 280 @vindex \NAME\
 281 @code{\NAME\}
 282 @end macro
 283
 284 @macro seeinternals{NAME}
 285 internals document, @internalsref{\NAME\}
 286 @end macro
 287
 288 @macro usermanref{NAME}
 289 user manual, @internalsref{\NAME\}
 290 @end macro
 291
 292 @macro rprogram{NAME}
 293 program usage manual, @internalsref{\NAME\}
 294 @end macro
 295
 296 @alias ruser=usermanref
 297
 298 @c to get decent quotes in `foo'
 299 @macro q{TEXT}
 300 `\TEXT\'
 301 @end macro
 302
 303 @c to get decent quotes in ``foo''
 304 @macro qq{TEXT}
 305 ``\TEXT\''
 306 @end macro
 307
 308 @end iftex
 309
 310
 311 @ifnottex
 312 @c **** not TEX ****
 313
 314 @macro seeinternals{NAME}
 315 @internalsref{\NAME\}
 316 @end macro
 317
 318 @ifnotinfo
 319 @macro usermanref{NAME}
 320 @ref{\NAME\}
 321 @end macro
 322 @end ifnotinfo
 323
 324 @end ifnottex
 325
 326
 327 @c EOF