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