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   ***** Displaying text *****
  10
  11 @c we need this since @q{\} doesn't work with makeinfo 4.8 --
  12 @c say @q{@value{backslash}} instead
  13 @set backslash \
  14
  15 @c to get decent quotes in `foo' and ``foo''
  16 @macro q{TEXT}
  17 @quoteleft{}\TEXT\@quoteright{}
  18 @end macro
  19
  20 @macro qq{TEXT}
  21 @quotedblleft{}\TEXT\@quotedblright{}
  22 @end macro
  23
  24 @macro warning{TEXT}
  25 @quotation
  26 @quotation
  27 @cartouche
  28 @b{Note:} \TEXT\
  29 @end cartouche
  30 @end quotation
  31 @end quotation
  32 @end macro
  33
  34 @ifnotinfo
  35 @macro notation{TEXT}
  36 @var{\TEXT\}
  37 @end macro
  38 @end ifnotinfo
  39
  40 @ifinfo
  41 @macro notation{TEXT}
  42 \TEXT\
  43 @end macro
  44 @end ifinfo
  45
  46 @macro smallspace
  47 @sp 1
  48 @end macro
  49
  50
  51 @c   **** Displaying images not generated by lilypond-book
  52
  53 @c current installation setup of Info docs requires that all images are
  54 @c expected to be found in lilypond/ subdirectory.  lilypond-book already
  55 @c generates proper @image commands for images of music; these macros
  56 @c definitions do the same for other images.
  57
  58 @ifnotinfo
  59 @macro sourceimage{FILENAME,WIDTH,HEIGHT,ALTTEXT}
  60 @image{\FILENAME\,\WIDTH\,\HEIGHT\,\ALTTEXT\}
  61 @end macro
  62 @end ifnotinfo
  63
  64 @ifinfo
  65 @macro sourceimage{FILENAME,WIDTH,HEIGHT,ALTTEXT}
  66 @image{lilypond/\FILENAME\,\WIDTH\,\HEIGHT\,\ALTTEXT\}
  67 @end macro
  68 @end ifinfo
  69
  70
  71 @c   **** Headings in a doc subsection ****
  72
  73 @macro predefined
  74 @noindent
  75 @subsubheading Predefined commands
  76
  77 @end macro
  78
  79 @macro snippets
  80 @noindent
  81 @subsubheading Selected Snippets
  82
  83 @end macro
  84
  85 @macro seealso
  86 @noindent
  87 @subsubheading See also
  88
  89 @indent
  90 @end macro
  91
  92 @macro knownissues
  93 @noindent
  94 @subsubheading Known issues and warnings
  95
  96 @end macro
  97
  98 @macro funindex {TEXT}
  99 @findex \TEXT\
 100 @kindex \TEXT\
 101 @end macro
 102
 103
 104
 105 @c   **** Links and references ****
 106
 107 @c  Possibly deprecated; under discussion.
 108 @c usage: @lsr{ancient,Ancient-notation,custodes.ly}
 109 @macro lsr{SECTION,DIR,TEXT}
 110 @ifhtml
 111 @uref{source/input/lsr/snippets/\DIR\.html#\TEXT\,@file{\SECTION\/\TEXT\}}
 112 @end ifhtml
 113 @ifnothtml
 114 @file{\SECTION\/\TEXT\}
 115 @end ifnothtml
 116 @end macro
 117
 118 @c usage: @lsrdir{ancient,Ancient-notation}
 119 @macro lsrdir{SECTION,DIR}
 120 @ifhtml
 121 @uref{source/input/lsr/snippets/\DIR\.html,\SECTION\}
 122 @end ifhtml
 123 @ifnothtml
 124 \DIR\
 125 @end ifnothtml
 126 @end macro
 127
 128
 129 @c  Definitions for references:
 130 @c     @internalsref
 131 @c     @rglos
 132 @c     @rprogram
 133 @c     @ruser
 134 @c     @rlearning
 135
 136 @ifhtml
 137 @c ***** HTML *****
 138
 139 @ifset bigpage
 140
 141 @macro internalsref{TEXT}
 142 @vindex \TEXT\
 143 @ref{\TEXT\,,,lilypond-internals-big-page}
 144 @end macro
 145
 146 @macro rglos{TEXT}
 147 @vindex \TEXT\
 148 @ref{\TEXT\,,,music-glossary-big-page}
 149 @end macro
 150
 151 @macro rprogram{TEXT}
 152 @vindex \TEXT\
 153 @ref{\TEXT\,,,lilypond-program-big-page}
 154 @end macro
 155
 156 @macro ruser{TEXT}
 157 @vindex \TEXT\
 158 @ref{\TEXT\,,,lilypond-big-page}
 159 @end macro
 160
 161 @macro rlearning{TEXT}
 162 @vindex \TEXT\
 163 @ref{\TEXT\,,,lilypond-learning-big-page}
 164 @end macro
 165
 166 @end ifset
 167
 168
 169 @ifclear bigpage
 170
 171 @macro internalsref{TEXT}
 172 @vindex \TEXT\
 173 @ref{\TEXT\,,,lilypond-internals}
 174 @end macro
 175
 176 @macro rglos{TEXT}
 177 @vindex \TEXT\
 178 @ref{\TEXT\,,,music-glossary}
 179 @end macro
 180
 181 @macro rprogram{TEXT}
 182 @vindex \TEXT\
 183 @ref{\TEXT\,,,lilypond-program}
 184 @end macro
 185
 186 @macro ruser{TEXT}
 187 @vindex \TEXT\
 188 @ref{\TEXT\,,,lilypond}
 189 @end macro
 190
 191 @macro rlearning{TEXT}
 192 @vindex \TEXT\
 193 @ref{\TEXT\,,,lilypond-learning}
 194 @end macro
 195
 196 @end ifclear
 197
 198 @end ifhtml
 199
 200
 201 @ifdocbook
 202 @c ***** DOCBOOK-XML *****
 203
 204 @macro internalsref{TEXT}
 205 @vindex \TEXT\
 206 @ref{\TEXT\,,,lilypond-internals}
 207 @end macro
 208
 209 @macro rglos{TEXT}
 210 @vindex \TEXT\
 211 @ref{\TEXT\,,,music-glossary}
 212 @end macro
 213
 214 @macro rprogram{TEXT}
 215 @vindex \TEXT\
 216 @ref{\TEXT\,,,lilypond-program}
 217 @end macro
 218
 219 @macro ruser{TEXT}
 220 @vindex \TEXT\
 221 @ref{\TEXT\,,,lilypond}
 222 @end macro
 223
 224 @macro rlearning{TEXT}
 225 @vindex \TEXT\
 226 @ref{\TEXT\,,,lilypond-learning}
 227 @end macro
 228
 229 @end ifdocbook
 230
 231
 232 @ifinfo
 233 @c **** INFO ****
 234
 235 @macro internalsref{TEXT}
 236 @vindex \TEXT\
 237 @inforef{\TEXT\,,lilypond-internals}
 238 @end macro
 239
 240 @macro rglos{TEXT}
 241 @vindex \TEXT\
 242 @inforef{\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 ifinfo
 261
 262
 263 @c **** TEX ****
 264 @iftex
 265
 266 @macro internalsref{TEXT}
 267 @vindex \TEXT\
 268 @code{\TEXT\}
 269 @end macro
 270
 271 @macro rglos {TEXT}
 272 @vindex \TEXT\
 273 @ref{\TEXT\,,,music-glossary}
 274 @end macro
 275
 276 @macro rprogram{TEXT}
 277 program usage manual, @ref{\TEXT\,,,lilypond-program}
 278 @c @internalsref{\TEXT\}
 279 @end macro
 280
 281 @macro ruser{TEXT}
 282 notation reference, @ref{\TEXT\,,,lilypond}
 283 @c @internalsref{\TEXT\}
 284 @end macro
 285
 286 @macro rlearning{TEXT}
 287 learning manual, @ref{\TEXT\,,,lilypond-learning}
 288 @c @internalsref{\TEXT\}
 289 @end macro
 290
 291 @end iftex
 292
 293
 294 @c EOF