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