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
  70
  71
  72 @c   **** Headings in a doc subsection ****
  73
  74 @c not really a heading, but...
  75 @macro smallspace
  76 @sp 1
  77 @end macro
  78
  79 @c absolete; being removed.
  80 @macro refcommands
  81 @noindent
  82 @subsubheading Predefined commands
  83
  84 @end macro
  85
  86 @macro commonprop
  87 @noindent
  88 @subsubheading Commonly tweaked properties
  89
  90 @end macro
  91
  92 @macro seealso
  93 @noindent
  94 @subsubheading See also
  95
  96 @end macro
  97
  98 @macro refbugs
  99 @noindent
 100 @subsubheading Known issues and warnings
 101
 102 @end macro
 103
 104
 105 @macro context{TEXT}
 106 @vindex \TEXT\
 107 @code{\TEXT\}@c should use internalsref
 108 @end macro
 109
 110 @macro refcommand{TEXT}
 111 @vindex \TEXT\
 112 @code{\TEXT\}
 113 @end macro
 114
 115 @macro funindex {TEXT}
 116 @findex \TEXT\
 117 @kindex \TEXT\
 118 @end macro
 119
 120
 121
 122 @c   **** Links and references ****
 123
 124 @c usage: @lsr{ancient,custodes.ly}
 125 @macro lsr{DIR,TEXT}
 126 @ifhtml
 127 @uref{source/input/lsr/\DIR\/collated-files.html#\TEXT\,@file{\DIR\/\TEXT\}}
 128 @end ifhtml
 129 @ifnothtml
 130 @file{\DIR\/\TEXT\}
 131 @end ifnothtml
 132 @end macro
 133
 134 @macro lsrdir{DIR}
 135 @ifhtml
 136 @uref{source/input/lsr/\DIR\/collated-files.html,@file{\DIR\}/}
 137 @end ifhtml
 138 @ifnothtml
 139 @file{\DIR\}
 140 @end ifnothtml
 141 @end macro
 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 rprogram{TEXT}
 264 @vindex \TEXT\
 265 @ref{\TEXT\,,,lilypond-program}
 266 @end macro
 267
 268 @macro ruser{TEXT}
 269 @vindex \TEXT\
 270 @ref{\TEXT\,,,lilypond}
 271 @end macro
 272
 273 @macro rlearning{TEXT}
 274 @vindex \TEXT\
 275 @ref{\TEXT\,,,lilypond-learning}
 276 @end macro
 277
 278 @end ifinfo
 279
 280
 281 @c **** TEX ****
 282 @iftex
 283
 284 @macro internalsref{TEXT}
 285 @vindex \TEXT\
 286 @code{\TEXT\}
 287 @end macro
 288
 289 @macro rglos {TEXT}
 290 @vindex \TEXT\
 291 @code{\TEXT\}
 292 @end macro
 293
 294 @macro rprogram{TEXT}
 295 program usage manual, @internalsref{\TEXT\}
 296 @end macro
 297
 298 @macro ruser{TEXT}
 299 user manual, @internalsref{\TEXT\}
 300 @end macro
 301
 302 @macro rlearning{TEXT}
 303 learning manual, @internalsref{\TEXT\}
 304 @end macro
 305
 306 @end iftex
 307
 308
 309 @c EOF