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 @include version.itexi
  11
  12
  13 @c Don't replace quotes with directed quotes.
  14
  15 @set txicodequoteundirected
  16 @set txicodequotebacktick
  17
  18
  19
  20 @c   ***** Displaying text *****
  21
  22 @c We need this since @q{\} doesn't work with makeinfo 4.11 --
  23 @c say @q{@bs{}} instead.
  24
  25 @macro bs
  26 \\
  27 @end macro
  28
  29
  30 @c To get decent quotes in `foo' and ``foo''.
  31
  32 @macro q{TEXT}
  33 @quoteleft{}\TEXT\@quoteright{}
  34 @end macro
  35
  36 @macro qq{TEXT}
  37 @quotedblleft{}\TEXT\@quotedblright{}
  38 @end macro
  39
  40
  41 @ifhtml
  42
  43 @macro warning{TEXT}
  44 @cartouche
  45 @b{Note:} \TEXT\
  46 @end cartouche
  47 @end macro
  48
  49 @end ifhtml
  50
  51 @ifnothtml
  52
  53 @macro warning{TEXT}
  54 @quotation
  55 @quotation
  56 @cartouche
  57 @b{Note:} \TEXT\
  58 @end cartouche
  59 @end quotation
  60 @end quotation
  61 @end macro
  62
  63 @end ifnothtml
  64
  65
  66 @ifnotinfo
  67
  68 @macro notation{TEXT}
  69 @var{\TEXT\}
  70 @end macro
  71
  72 @end ifnotinfo
  73
  74 @ifinfo
  75
  76 @macro notation{TEXT}
  77 \TEXT\
  78 @end macro
  79
  80 @end ifinfo
  81
  82
  83 @macro smallspace
  84 @sp 1
  85 @end macro
  86
  87
  88
  89 @c   ***** Displaying images not generated by lilypond-book *****
  90
  91 @c Current installation setup of Info docs requires that all images are
  92 @c expected to be found in the `lilypond/' subdirectory.  `lilypond-book'
  93 @c already generates proper @image commands for images of music; these
  94 @c macro definitions do the same for other images.
  95
  96 @ifnotinfo
  97
  98 @macro sourceimage{FILENAME,WIDTH,HEIGHT,ALTTEXT}
  99 @image{\FILENAME\,\WIDTH\,\HEIGHT\,\ALTTEXT\}
 100 @end macro
 101
 102 @end ifnotinfo
 103
 104 @ifinfo
 105
 106 @macro sourceimage{FILENAME,WIDTH,HEIGHT,ALTTEXT}
 107 @image{lilypond/\FILENAME\,\WIDTH\,\HEIGHT\,\ALTTEXT\}
 108 @end macro
 109
 110 @end ifinfo
 111
 112
 113
 114 @c   ***** Headings in a doc subsection *****
 115
 116 @c Don't insert an empty line after @predefined!  Right now
 117 @c it doesn't matter, but a future implementation will probably
 118 @c add some code which needs this restriction.
 119
 120 @macro predefined
 121 @noindent
 122 @subsubheading Predefined commands
 123 @end macro
 124
 125 @c The next macro is a dummy currently since texinfo doesn't
 126 @c provide a real ragged-right environment yet.
 127 @c
 128 @c Due to a bug in texi2html (texi2html.pl CVS versions <= 1.245)
 129 @c the macro must not be empty.
 130
 131 @macro endpredefined
 132 @c
 133 @end macro
 134
 135
 136 @macro snippets
 137 @noindent
 138 @subsubheading Selected Snippets
 139 @end macro
 140
 141
 142 @c Don't insert an empty line after @seealso!  Otherwise we get
 143 @c unwanted extra vertical space in the PDF output.
 144
 145 @macro seealso
 146 @noindent
 147 @subsubheading See also
 148 @indent
 149 @end macro
 150
 151
 152 @macro knownissues
 153 @noindent
 154 @subsubheading Known issues and warnings
 155 @end macro
 156
 157
 158 @macro lydoctitle {TEXT}
 159 @emph{\TEXT\}
 160 @end macro
 161
 162
 163 @c Don't remove the `@c' within the macro definition!  See section 19.3,
 164 @c `Macro Details and Caveats', in the texinfo info file for explanation.
 165
 166 @macro funindex {TEXT}
 167 @findex \TEXT\
 168 @kindex \TEXT\
 169 @c
 170 @end macro
 171
 172
 173
 174 @c   ***** Links and references *****
 175
 176 @c  Definitions for references:
 177 @c
 178 @c     @rglos
 179 @c     @rlearning
 180 @c     @ruser
 181 @c     @rprogram
 182 @c     @rlsr
 183 @c     @rinternals
 184 @c
 185 @c  All these also have a @...named version which allows to specify the
 186 @c  displayed text for the reference as second argument.
 187 @c
 188 @c ***** HTML + bigpage is a special case (other manual names); all other
 189 @c formats are treated similarly.
 190
 191
 192 @c *** not TeX ***
 193
 194 @ifnottex
 195
 196 @c ** bigpage **
 197
 198 @ifset bigpage
 199
 200 @macro rglos{TEXT}
 201 @vindex \TEXT\
 202 @ref{\TEXT\,,,music-glossary-big-page,Music Glossary}
 203 @end macro
 204
 205 @macro rglosnamed{TEXT,DISPLAY}
 206 @vindex \TEXT\
 207 @ref{\TEXT\,,\DISPLAY\,music-glossary-big-page,Music Glossary}
 208 @end macro
 209
 210 @macro rlearning{TEXT}
 211 @vindex \TEXT\
 212 @ref{\TEXT\,,,lilypond-learning-big-page,Learning Manual}
 213 @end macro
 214
 215 @macro rlearningnamed{TEXT,DISPLAY}
 216 @vindex \TEXT\
 217 @ref{\TEXT\,,\DISPLAY\,lilypond-learning-big-page,Learning Manual}
 218 @end macro
 219
 220 @macro ruser{TEXT}
 221 @vindex \TEXT\
 222 @ref{\TEXT\,,,lilypond-big-page,Notation Reference}
 223 @end macro
 224
 225 @macro rusernamed{TEXT,DISPLAY}
 226 @vindex \TEXT\
 227 @ref{\TEXT\,,\DISPLAY\,lilypond-big-page,Notation Reference}
 228 @end macro
 229
 230 @macro rprogram{TEXT}
 231 @vindex \TEXT\
 232 @ref{\TEXT\,,,lilypond-program-big-page,Application Usage}
 233 @end macro
 234
 235 @macro rprogramnamed{TEXT,DISPLAY}
 236 @vindex \TEXT\
 237 @ref{\TEXT\,,\DISPLAY\,lilypond-program-big-page,Application Usage}
 238 @end macro
 239
 240 @macro rlsr{TEXT}
 241 @ref{\TEXT\,,,lilypond-snippets-big-page,Snippets}
 242 @end macro
 243
 244 @macro rlsrnamed{TEXT,DISPLAY}
 245 @ref{\TEXT\,,\DISPLAY\,lilypond-snippets-big-page,Snippets}
 246 @end macro
 247
 248 @macro rinternals{TEXT}
 249 @vindex \TEXT\
 250 @ref{\TEXT\,,,lilypond-internals-big-page,Internals Reference}
 251 @end macro
 252
 253 @macro rinternalsnamed{TEXT,DISPLAY}
 254 @vindex \TEXT\
 255 @ref{\TEXT\,,\DISPLAY\,lilypond-internals-big-page,Internals Reference}
 256 @end macro
 257
 258 @end ifset
 259
 260
 261 @c ** not bigpage **
 262
 263 @ifclear bigpage
 264
 265 @macro rglos{TEXT}
 266 @vindex \TEXT\
 267 @ref{\TEXT\,,,music-glossary,Music Glossary}
 268 @end macro
 269
 270 @macro rglosnamed{TEXT,DISPLAY}
 271 @vindex \TEXT\
 272 @ref{\TEXT\,,\DISPLAY\,music-glossary,Music Glossary}
 273 @end macro
 274
 275 @macro rlearning{TEXT}
 276 @vindex \TEXT\
 277 @ref{\TEXT\,,,lilypond-learning,Learning Manual}
 278 @end macro
 279
 280 @macro rlearningnamed{TEXT,DISPLAY}
 281 @vindex \TEXT\
 282 @ref{\TEXT\,,,lilypond-learning,Learning Manual}
 283 @end macro
 284
 285 @macro ruser{TEXT}
 286 @vindex \TEXT\
 287 @ref{\TEXT\,,,lilypond,Notation Reference}
 288 @end macro
 289
 290 @macro rusernamed{TEXT,DISPLAY}
 291 @vindex \TEXT\
 292 @ref{\TEXT\,,\DISPLAY\,lilypond,Notation Reference}
 293 @end macro
 294
 295 @macro rprogram{TEXT}
 296 @vindex \TEXT\
 297 @ref{\TEXT\,,,lilypond-program,Application Usage}
 298 @end macro
 299
 300 @macro rprogramnamed{TEXT,DISPLAY}
 301 @vindex \TEXT\
 302 @ref{\TEXT\,,\DISPLAY\,lilypond-program,Application Usage}
 303 @end macro
 304
 305 @macro rlsr{TEXT}
 306 @ref{\TEXT\,,,lilypond-snippets,Snippets}
 307 @end macro
 308
 309 @macro rlsrnamed{TEXT,DISPLAY}
 310 @ref{\TEXT\,,\DISPLAY\,lilypond-snippets,Snippets}
 311 @end macro
 312
 313 @macro rinternals{TEXT}
 314 @vindex \TEXT\
 315 @ref{\TEXT\,,,lilypond-internals,Internals Reference}
 316 @end macro
 317
 318 @macro rinternalsnamed{TEXT,DISPLAY}
 319 @vindex \TEXT\
 320 @ref{\TEXT\,,\DISPLAY\,lilypond-internals,Internals Reference}
 321 @end macro
 322
 323 @end ifclear
 324
 325 @end ifnottex
 326
 327
 328 @c *** TeX ***
 329
 330 @iftex
 331
 332 @c All commands below should work in the middle of the line;
 333 @c we thus must not use @vindex directly since it works only if placed
 334 @c on a line of its own.  To overcome this problem, we define a
 335 @c replacement macro using the internal definition of @vindex which
 336 @c delimits arguments in the standard way (i.e., with braces).
 337
 338 @tex
 339 \gdef\lilyvindex#1{\doind{vr}{\code #1}\ignorespaces}
 340 @end tex
 341
 342 @macro rglos{TEXT}
 343 @lilyvindex{\TEXT\}
 344 @ref{\TEXT\,,,music-glossary,Music Glossary}
 345 @end macro
 346
 347 @macro rglosnamed{TEXT,DISPLAY}
 348 @lilyvindex{\TEXT\}
 349 @ref{\TEXT\,,\DISPLAY\,music-glossary,Music Glossary}
 350 @end macro
 351
 352 @macro rlearning{TEXT}
 353 @lilyvindex{\TEXT\}
 354 @ref{\TEXT\,,,lilypond-learning,Learning Manual}
 355 @end macro
 356
 357 @macro rlearningnamed{TEXT,DISPLAY}
 358 @lilyvindex{\TEXT\}
 359 @ref{\TEXT\,,\DISPLAY\,lilypond-learning,Learning Manual}
 360 @end macro
 361
 362 @macro ruser{TEXT}
 363 @lilyvindex{\TEXT\}
 364 @ref{\TEXT\,,,lilypond,Notation Reference}
 365 @end macro
 366
 367 @macro rusernamed{TEXT,DISPLAY}
 368 @lilyvindex{\TEXT\}
 369 @ref{\TEXT\,,\DISPLAY\,lilypond,Notation Reference}
 370 @end macro
 371
 372 @macro rprogram{TEXT}
 373 @lilyvindex{\TEXT\}
 374 @ref{\TEXT\,,,lilypond-program,Application Usage}
 375 @end macro
 376
 377 @macro rprogramnamed{TEXT,DISPLAY}
 378 @lilyvindex{\TEXT\}
 379 @ref{\TEXT\,,\DISPLAY\,lilypond-program,Application Usage}
 380 @end macro
 381
 382 @macro rlsr{TEXT}
 383 @lilyvindex{\TEXT\}
 384 @ref{\TEXT\,,,lilypond-snippets,Snippets}
 385 @end macro
 386
 387 @macro rlsrnamed{TEXT,DISPLAY}
 388 @lilyvindex{\TEXT\}
 389 @ref{\TEXT\,,\DISPLAY\,lilypond-snippets,Snippets}
 390 @end macro
 391
 392 @macro rinternals{TEXT}
 393 @lilyvindex{\TEXT\}
 394 @ref{\TEXT\,,,lilypond-internals,Internals Reference}
 395 @end macro
 396
 397 @macro rinternalsnamed{TEXT,DISPLAY}
 398 @lilyvindex{\TEXT\}
 399 @ref{\TEXT\,,\DISPLAY\,lilypond-internals,Internals Reference}
 400 @end macro
 401
 402 @end iftex