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
  66 @c I don't understand why this is necessary, but it is with 4.8. :/
  67 @ifnotdocbook
  68 @macro q{TEXT}
  69 @ifinfo
  70 `\TEXT\'
  71 @end ifinfo
  72 @iftex
  73 `\TEXT\'
  74 @end iftex
  75 @ifhtml
  76 @html
  77 &lsquo;\TEXT\&rsquo;
  78 @end html
  79 @end ifhtml
  80 @end macro
  81 @end ifnotdocbook
  82
  83 @ifdocbook
  84 @macro q{TEXT}
  85 @xml
  86 &lsquo;\TEXT\&rsquo;
  87 @end xml
  88 @end macro
  89 @end ifdocbook
  90
  91
  92 @c to get decent quotes in ``foo''
  93 @c I don't understand why this is necessary, but it is with 4.8. :/
  94 @ifnotdocbook
  95 @macro qq{TEXT}
  96 @ifinfo
  97 ``\TEXT\''
  98 @end ifinfo
  99 @iftex
 100 ``\TEXT\''
 101 @end iftex
 102 @ifhtml
 103 @html
 104 &ldquo;\TEXT\&rdquo;
 105 @end html
 106 @end ifhtml
 107 @end macro
 108 @end ifnotdocbook
 109
 110 @ifdocbook
 111 @macro qq{TEXT}
 112 @xml
 113 &ldquo;\TEXT\&rdquo;
 114 @end xml
 115 @end macro
 116 @end ifdocbook
 117
 118
 119
 120
 121
 122 @c usage: @lsr{ancient,custodes.ly}
 123 @macro lsr{DIR,TEXT}
 124 @ifhtml
 125 @uref{source/input/lsr/\DIR\/collated-files.html#\TEXT\,@file{\DIR\/\TEXT\}}
 126 @end ifhtml
 127 @ifnothtml
 128 @file{\DIR\/\TEXT\}
 129 @end ifnothtml
 130 @end macro
 131
 132 @macro lsrdir{DIR}
 133 @ifhtml
 134 @uref{source/input/lsr/\DIR\/collated-files.html,@file{\DIR\}/}
 135 @end ifhtml
 136 @ifnothtml
 137 @file{\DIR\}
 138 @end ifnothtml
 139 @end macro
 140
 141
 142
 143
 144 @c  Definitions for references:
 145 @c     @internalsref
 146 @c     @rglos
 147 @c     @rprogram
 148 @c     @ruser
 149 @c     @rlearning
 150
 151 @ifhtml
 152 @c ***** HTML *****
 153
 154 @c makeinfo-4.7 encodes html names, which means that nodes that
 155 @c contain nonalphanum characters will be broken links on the website.
 156 @c @uref{../lilypond-internals/\TEXT\.html,\TEXT\}@c
 157 @c @inforef{} adds ``See'' to the sentence, which is annoying, but
 158 @c better than a broken link.
 159 @c @inforef{\TEXT\,,lilypond-internals}@c
 160 @c using @ref without punctuation is OK without for formats other than info
 161
 162 @ifset bigpage
 163
 164 @macro internalsref{TEXT}
 165 @vindex \TEXT\
 166 @ref{\TEXT\,,,lilypond-internals-big-page}
 167 @end macro
 168
 169 @macro rglos{TEXT}
 170 @vindex \TEXT\
 171 @ref{\TEXT\,,,music-glossary-big-page}
 172 @end macro
 173
 174 @macro rprogram{TEXT}
 175 @vindex \TEXT\
 176 @ref{\TEXT\,,,lilypond-program-big-page}
 177 @end macro
 178
 179 @macro ruser{TEXT}
 180 @vindex \TEXT\
 181 @ref{\TEXT\,,,lilypond-big-page}
 182 @end macro
 183
 184 @macro rlearning{TEXT}
 185 @vindex \TEXT\
 186 @ref{\TEXT\,,,lilypond-learning-big-page}
 187 @end macro
 188
 189 @end ifset
 190
 191
 192 @ifclear bigpage
 193
 194 @macro internalsref{TEXT}
 195 @vindex \TEXT\
 196 @ref{\TEXT\,,,lilypond-internals}
 197 @end macro
 198
 199 @macro rglos{TEXT}
 200 @vindex \TEXT\
 201 @ref{\TEXT\,,,music-glossary}
 202 @end macro
 203
 204 @macro rprogram{TEXT}
 205 @vindex \TEXT\
 206 @ref{\TEXT\,,,lilypond-program}
 207 @end macro
 208
 209 @macro ruser{TEXT}
 210 @vindex \TEXT\
 211 @ref{\TEXT\,,,lilypond}
 212 @end macro
 213
 214 @macro rlearning{TEXT}
 215 @vindex \TEXT\
 216 @ref{\TEXT\,,,lilypond-learning}
 217 @end macro
 218
 219 @end ifclear
 220
 221 @end ifhtml
 222
 223
 224 @ifdocbook
 225 @c ***** DOCBOOK-XML *****
 226
 227 @macro internalsref{TEXT}
 228 @vindex \TEXT\
 229 @ref{\TEXT\,,,lilypond-internals}
 230 @end macro
 231
 232 @macro rglos{TEXT}
 233 @vindex \TEXT\
 234 @ref{\TEXT\,,,music-glossary}
 235 @end macro
 236
 237 @macro rprogram{TEXT}
 238 @vindex \TEXT\
 239 @ref{\TEXT\,,,lilypond-program}
 240 @end macro
 241
 242 @macro ruser{TEXT}
 243 @vindex \TEXT\
 244 @ref{\TEXT\,,,lilypond}
 245 @end macro
 246
 247 @macro rlearning{TEXT}
 248 @vindex \TEXT\
 249 @ref{\TEXT\,,,lilypond-learning}
 250 @end macro
 251
 252 @end ifdocbook
 253
 254
 255 @ifinfo
 256 @c **** INFO ****
 257
 258 @macro internalsref{TEXT}
 259 @vindex \TEXT\
 260 @inforef{\TEXT\,,lilypond-internals}
 261 @end macro
 262
 263 @macro rglos{TEXT}
 264 @vindex \TEXT\
 265 @inforef{\TEXT\,,,music-glossary}
 266 @end macro
 267
 268 @macro rprogram{TEXT}
 269 @vindex \TEXT\
 270 @ref{\TEXT\,,,lilypond-program}
 271 @end macro
 272
 273 @macro ruser{TEXT}
 274 @vindex \TEXT\
 275 @ref{\TEXT\,,,lilypond}
 276 @end macro
 277
 278 @macro rlearning{TEXT}
 279 @vindex \TEXT\
 280 @ref{\TEXT\,,,lilypond-learning}
 281 @end macro
 282
 283 @end ifinfo
 284
 285
 286 @c **** TEX ****
 287 @iftex
 288
 289 @macro internalsref{TEXT}
 290 @vindex \TEXT\
 291 @code{\TEXT\}
 292 @end macro
 293
 294 @macro rglos {TEXT}
 295 @vindex \TEXT\
 296 @code{\TEXT\}
 297 @end macro
 298
 299 @macro rprogram{TEXT}
 300 program usage manual, @internalsref{\TEXT\}
 301 @end macro
 302
 303 @macro ruser{TEXT}
 304 user manual, @internalsref{\TEXT\}
 305 @end macro
 306
 307 @macro rlearning{TEXT}
 308 learning manual, @internalsref{\TEXT\}
 309 @end macro
 310
 311 @end iftex
 312
 313
 314 @c EOF