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