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