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
 139
 140 @c  Definitions for references:
 141 @c     @internalsref
 142 @c     @rglos
 143 @c     @rprogram
 144 @c     @ruser
 145 @c     @rlearning
 146
 147 @ifhtml
 148 @c ***** HTML *****
 149
 150 @c makeinfo-4.7 encodes html names, which means that nodes that
 151 @c contain nonalphanum characters will be broken links on the website.
 152 @c @uref{../lilypond-internals/\TEXT\.html,\TEXT\}@c
 153 @c @inforef{} adds ``See'' to the sentence, which is annoying, but
 154 @c better than a broken link.
 155 @c @inforef{\TEXT\,,lilypond-internals}@c
 156 @c using @ref without punctuation is OK without for formats other than info
 157
 158 @ifset bigpage
 159
 160 @macro internalsref{TEXT}
 161 @vindex \TEXT\
 162 @ref{\TEXT\,,,lilypond-internals-big-page}
 163 @end macro
 164
 165 @macro rglos{TEXT}
 166 @vindex \TEXT\
 167 @ref{\TEXT\,,,music-glossary-big-page}
 168 @end macro
 169
 170 @macro rprogram{TEXT}
 171 @vindex \TEXT\
 172 @ref{\TEXT\,,,lilypond-program-big-page}
 173 @end macro
 174
 175 @macro ruser{TEXT}
 176 @vindex \TEXT\
 177 @ref{\TEXT\,,,lilypond-big-page}
 178 @end macro
 179
 180 @macro rlearning{TEXT}
 181 @vindex \TEXT\
 182 @ref{\TEXT\,,,lilypond-learning-big-page}
 183 @end macro
 184
 185 @end ifset
 186
 187
 188 @ifclear bigpage
 189
 190 @macro internalsref{TEXT}
 191 @vindex \TEXT\
 192 @ref{\TEXT\,,,lilypond-internals}
 193 @end macro
 194
 195 @macro rglos{TEXT}
 196 @vindex \TEXT\
 197 @ref{\TEXT\,,,music-glossary}
 198 @end macro
 199
 200 @macro rprogram{TEXT}
 201 @vindex \TEXT\
 202 @ref{\TEXT\,,,lilypond-program}
 203 @end macro
 204
 205 @macro ruser{TEXT}
 206 @vindex \TEXT\
 207 @ref{\TEXT\,,,lilypond}
 208 @end macro
 209
 210 @macro rlearning{TEXT}
 211 @vindex \TEXT\
 212 @ref{\TEXT\,,,lilypond-learning}
 213 @end macro
 214
 215 @end ifclear
 216
 217 @end ifhtml
 218
 219
 220 @ifdocbook
 221 @c ***** DOCBOOK-XML *****
 222
 223 @macro internalsref{TEXT}
 224 @vindex \TEXT\
 225 @ref{\TEXT\,,,lilypond-internals}
 226 @end macro
 227
 228 @macro rglos{TEXT}
 229 @vindex \TEXT\
 230 @ref{\TEXT\,,,music-glossary}
 231 @end macro
 232
 233 @macro rprogram{TEXT}
 234 @vindex \TEXT\
 235 @ref{\TEXT\,,,lilypond-program}
 236 @end macro
 237
 238 @macro ruser{TEXT}
 239 @vindex \TEXT\
 240 @ref{\TEXT\,,,lilypond}
 241 @end macro
 242
 243 @macro rlearning{TEXT}
 244 @vindex \TEXT\
 245 @ref{\TEXT\,,,lilypond-learning}
 246 @end macro
 247
 248 @end ifdocbook
 249
 250
 251 @ifinfo
 252 @c **** INFO ****
 253
 254 @macro internalsref{TEXT}
 255 @vindex \TEXT\
 256 @inforef{\TEXT\,,lilypond-internals}
 257 @end macro
 258
 259 @macro rglos{TEXT}
 260 @vindex \TEXT\
 261 @inforef{\TEXT\,,music-glossary}
 262 @end macro
 263
 264 @macro rprogram{TEXT}
 265 @vindex \TEXT\
 266 @ref{\TEXT\,,,lilypond-program}
 267 @end macro
 268
 269 @macro ruser{TEXT}
 270 @vindex \TEXT\
 271 @ref{\TEXT\,,,lilypond}
 272 @end macro
 273
 274 @macro rlearning{TEXT}
 275 @vindex \TEXT\
 276 @ref{\TEXT\,,,lilypond-learning}
 277 @end macro
 278
 279 @end ifinfo
 280
 281
 282 @c **** TEX ****
 283 @iftex
 284
 285 @macro internalsref{TEXT}
 286 @vindex \TEXT\
 287 @code{\TEXT\}
 288 @end macro
 289
 290 @macro rglos {TEXT}
 291 @vindex \TEXT\
 292 @code{\TEXT\}
 293 @end macro
 294
 295 @macro rprogram{TEXT}
 296 program usage manual, @internalsref{\TEXT\}
 297 @end macro
 298
 299 @macro ruser{TEXT}
 300 user manual, @internalsref{\TEXT\}
 301 @end macro
 302
 303 @macro rlearning{TEXT}
 304 learning manual, @internalsref{\TEXT\}
 305 @end macro
 306
 307 @end iftex
 308
 309
 310 @c EOF