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 @include version.itexi
  10
  11 @c   ***** Displaying text *****
  12
  13 @c we need this since @q{\} doesn't work with makeinfo 4.8 --
  14 @c say @q{@bs{}} instead
  15 @macro bs
  16 \\
  17 @end macro
  18
  19 @c to get decent quotes in `foo' and ``foo''
  20 @macro q{TEXT}
  21 @quoteleft{}\TEXT\@quoteright{}
  22 @end macro
  23
  24 @macro qq{TEXT}
  25 @quotedblleft{}\TEXT\@quotedblright{}
  26 @end macro
  27
  28 @macro warning{TEXT}
  29 @ifhtml
  30 @cartouche
  31 @b{Note:} \TEXT\
  32 @end cartouche
  33 @end ifhtml
  34 @ifnothtml
  35 @quotation
  36 @quotation
  37 @cartouche
  38 @b{Note:} \TEXT\
  39 @end cartouche
  40 @end quotation
  41 @end quotation
  42 @end ifnothtml
  43 @end macro
  44
  45 @ifnotinfo
  46 @macro notation{TEXT}
  47 @var{\TEXT\}
  48 @end macro
  49 @end ifnotinfo
  50
  51 @ifinfo
  52 @macro notation{TEXT}
  53 \TEXT\
  54 @end macro
  55 @end ifinfo
  56
  57 @macro smallspace
  58 @sp 1
  59 @end macro
  60
  61
  62 @c   **** Displaying images not generated by lilypond-book
  63
  64 @c current installation setup of Info docs requires that all images are
  65 @c expected to be found in lilypond/ subdirectory.  lilypond-book already
  66 @c generates proper @image commands for images of music; these macros
  67 @c definitions do the same for other images.
  68
  69 @ifnotinfo
  70 @macro sourceimage{FILENAME,WIDTH,HEIGHT,ALTTEXT}
  71 @image{\FILENAME\,\WIDTH\,\HEIGHT\,\ALTTEXT\}
  72 @end macro
  73 @end ifnotinfo
  74
  75 @ifinfo
  76 @macro sourceimage{FILENAME,WIDTH,HEIGHT,ALTTEXT}
  77 @image{lilypond/\FILENAME\,\WIDTH\,\HEIGHT\,\ALTTEXT\}
  78 @end macro
  79 @end ifinfo
  80
  81
  82 @c   **** Headings in a doc subsection ****
  83
  84 @macro predefined
  85 @noindent
  86 @subsubheading Predefined commands
  87
  88 @end macro
  89
  90 @macro snippets
  91 @noindent
  92 @subsubheading Selected Snippets
  93
  94 @end macro
  95
  96 @macro seealso
  97 @noindent
  98 @subsubheading See also
  99
 100 @indent
 101 @end macro
 102
 103 @macro knownissues
 104 @noindent
 105 @subsubheading Known issues and warnings
 106
 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  Possibly deprecated; under discussion.
 119 @c usage: @lsr{ancient,Ancient-notation,custodes.ly}
 120 @macro lsr{SECTION,DIR,TEXT}
 121 @ifhtml
 122 @uref{source/input/lsr/lilypond-snippets/\DIR\.html#\TEXT\,@file{\SECTION\/\TEXT\}}
 123 @end ifhtml
 124 @ifnothtml
 125 @file{\SECTION\/\TEXT\}
 126 @end ifnothtml
 127 @end macro
 128
 129 @c usage: @lsrdir{ancient,Ancient-notation}
 130 @macro lsrdir{SECTION,DIR}
 131 @ifhtml
 132 @uref{source/input/lsr/lilypond-snippets/\DIR\.html,\SECTION\}
 133 @end ifhtml
 134 @ifnothtml
 135 \DIR\
 136 @end ifnothtml
 137 @end macro
 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 @ifset bigpage
 151
 152 @macro internalsref{TEXT}
 153 @vindex \TEXT\
 154 @ref{\TEXT\,,,lilypond-internals-big-page,Internals Reference}
 155 @end macro
 156
 157 @macro rglos{TEXT}
 158 @vindex \TEXT\
 159 @ref{\TEXT\,,,music-glossary-big-page,Music Glossary}
 160 @end macro
 161
 162 @macro rprogram{TEXT}
 163 @vindex \TEXT\
 164 @ref{\TEXT\,,,lilypond-program-big-page,Application Usage}
 165 @end macro
 166
 167 @macro ruser{TEXT}
 168 @vindex \TEXT\
 169 @ref{\TEXT\,,,lilypond-big-page,Notation Reference}
 170 @end macro
 171
 172 @macro rlearning{TEXT}
 173 @vindex \TEXT\
 174 @ref{\TEXT\,,,lilypond-learning-big-page,Learning Manual}
 175 @end macro
 176
 177 @macro rlsr{TEXT}
 178 @ref{\TEXT\,,,lilypond-snippets-big-page,Snippets}
 179 @end macro
 180
 181 @end ifset
 182
 183
 184 @ifclear bigpage
 185
 186 @macro internalsref{TEXT}
 187 @vindex \TEXT\
 188 @ref{\TEXT\,,,lilypond-internals,Internals Reference}
 189 @end macro
 190
 191 @macro rglos{TEXT}
 192 @vindex \TEXT\
 193 @ref{\TEXT\,,,music-glossary,Music Glossary}
 194 @end macro
 195
 196 @macro rprogram{TEXT}
 197 @vindex \TEXT\
 198 @ref{\TEXT\,,,lilypond-program,Application Usage}
 199 @end macro
 200
 201 @macro ruser{TEXT}
 202 @vindex \TEXT\
 203 @ref{\TEXT\,,,lilypond,Notation Reference}
 204 @end macro
 205
 206 @macro rlearning{TEXT}
 207 @vindex \TEXT\
 208 @ref{\TEXT\,,,lilypond-learning,Learning Manual}
 209 @end macro
 210
 211 @macro rlsr{TEXT}
 212 @ref{\TEXT\,,,lilypond-snippets,Snippets}
 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,Internals Reference}
 226 @end macro
 227
 228 @macro rglos{TEXT}
 229 @vindex \TEXT\
 230 @ref{\TEXT\,,,music-glossary,Music Glossary}
 231 @end macro
 232
 233 @macro rprogram{TEXT}
 234 @vindex \TEXT\
 235 @ref{\TEXT\,,,lilypond-program,Application Usage}
 236 @end macro
 237
 238 @macro ruser{TEXT}
 239 @vindex \TEXT\
 240 @ref{\TEXT\,,,lilypond,Notation Reference}
 241 @end macro
 242
 243 @macro rlearning{TEXT}
 244 @vindex \TEXT\
 245 @ref{\TEXT\,,,lilypond-learning,Learning Manual}
 246 @end macro
 247
 248 @macro rlsr{TEXT}
 249 @ref{\TEXT\,,,lilypond-snippets,Snippets}
 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,Internals Reference}
 261 @end macro
 262
 263 @macro rglos{TEXT}
 264 @vindex \TEXT\
 265 @inforef{\TEXT\,,music-glossary,Music Glossary}
 266 @end macro
 267
 268 @macro rprogram{TEXT}
 269 @vindex \TEXT\
 270 @ref{\TEXT\,,,lilypond-program,Application Usage}
 271 @end macro
 272
 273 @macro ruser{TEXT}
 274 @vindex \TEXT\
 275 @ref{\TEXT\,,,lilypond,Notation Reference}
 276 @end macro
 277
 278 @macro rlearning{TEXT}
 279 @vindex \TEXT\
 280 @ref{\TEXT\,,,lilypond-learning,Learning Manual}
 281 @end macro
 282
 283 @macro rlsr{TEXT}
 284 @ref{\TEXT\,,,lilypond-snippets,Snippets}
 285 @end macro
 286
 287 @end ifinfo
 288
 289
 290 @c **** TEX ****
 291 @iftex
 292
 293 @macro internalsref{TEXT}
 294 @vindex \TEXT\
 295 @code{\TEXT\}
 296 @end macro
 297
 298 @macro rglos {TEXT}
 299 @vindex \TEXT\
 300 @ref{\TEXT\,,,music-glossary,Music Glossary}
 301 @end macro
 302
 303 @macro rprogram{TEXT}
 304 program usage manual, @ref{\TEXT\,,,lilypond-program,Application Usage}
 305 @end macro
 306
 307 @macro ruser{TEXT}
 308 notation reference, @ref{\TEXT\,,,lilypond,Notation Reference}
 309 @end macro
 310
 311 @macro rlearning{TEXT}
 312 learning manual, @ref{\TEXT\,,,lilypond-learning,Learning Manual}
 313 @end macro
 314
 315 @macro rlsr{TEXT}
 316 @ref{\TEXT\,,,lilypond-snippets,Snippets}
 317 @end macro
 318
 319 @end iftex
 320
 321
 322 @c EOF