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 rglos{NAME}
 188 @vindex \NAME\
 189 @ref{\NAME\,,,music-glossary}
 190 @end macro
 191
 192 @macro rprogram{NAME}
 193 @vindex \NAME\
 194 @ref{\NAME\,,,lilypond-program}
 195 @end macro
 196
 197 @macro ruser{NAME}
 198 @vindex \NAME\
 199 @ref{\NAME\,,,lilypond}
 200 @end macro
 201
 202 @c to get decent quotes in `foo'
 203 @macro q{TEXT}
 204 @xml
 205 &lsquo;\TEXT\&rsquo;
 206 @end xml
 207 @end macro
 208
 209 @c to get decent quotes in ``foo''
 210 @macro qq{TEXT}
 211 @xml
 212 &ldquo;\TEXT\&rdquo;
 213 @end xml
 214 @end macro
 215
 216 @end ifdocbook
 217
 218
 219 @ifinfo
 220 @c **** INFO ****
 221
 222 @macro internalsref{NAME}
 223 @vindex \NAME\
 224 @inforef{\NAME\,,lilypond-internals}
 225 @end macro
 226
 227 @macro rglos{NAME}
 228 @vindex \NAME\
 229 @inforef{\NAME\,,music-glossary}
 230 @end macro
 231
 232 @macro usermanref{NAME}
 233 @inforef{\NAME\}
 234 @end macro
 235
 236 @macro rprogram{NAME}
 237 @vindex \NAME\
 238 @ref{\NAME\,,,lilypond-program}
 239 @end macro
 240
 241 @macro ruser{NAME}
 242 @vindex \NAME\
 243 @ref{\NAME\,,,lilypond}
 244 @end macro
 245
 246 @c to get decent quotes in `foo'
 247 @macro q{TEXT}
 248 `\TEXT\'
 249 @end macro
 250
 251 @c to get decent quotes in ``foo''
 252 @macro qq{TEXT}
 253 ``\TEXT\''
 254 @end macro
 255
 256 @end ifinfo
 257
 258
 259 @c **** TEX ****
 260 @iftex
 261
 262 @macro internalsref{NAME}
 263 @vindex \NAME\
 264 @code{\NAME\}
 265 @end macro
 266
 267 @macro rglos {NAME}
 268 @vindex \NAME\
 269 @code{\NAME\}
 270 @end macro
 271
 272 @macro seeinternals{NAME}
 273 internals document, @internalsref{\NAME\}
 274 @end macro
 275
 276 @macro usermanref{NAME}
 277 user manual, @internalsref{\NAME\}
 278 @end macro
 279
 280 @macro rprogram{NAME}
 281 program usage manual, @internalsref{\NAME\}
 282 @end macro
 283
 284 @alias ruser=usermanref
 285
 286 @c to get decent quotes in `foo'
 287 @macro q{TEXT}
 288 `\TEXT\'
 289 @end macro
 290
 291 @c to get decent quotes in ``foo''
 292 @macro qq{TEXT}
 293 ``\TEXT\''
 294 @end macro
 295
 296 @end iftex
 297
 298
 299 @ifnottex
 300 @c **** not TEX ****
 301
 302 @macro seeinternals{NAME}
 303 @internalsref{\NAME\}
 304 @end macro
 305
 306 @ifnotinfo
 307 @macro usermanref{NAME}
 308 @ref{\NAME\}
 309 @end macro
 310 @end ifnotinfo
 311
 312 @end ifnottex
 313
 314
 315 @c EOF