]> git.donarmstrong.com Git - lilypond.git/blob - Documentation/macros.itexi
Downcase two instances of Manuals. Hopefully fixes
[lilypond.git] / 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 @html
31 <div class="warning">
32 @end html
33 @strong{Note:} \TEXT\
34 @c keep the space for proper nesting of </p>
35
36 @html
37 </div>
38 @end html
39 @end macro
40
41 @end ifhtml
42
43 @ifnothtml
44
45 @macro warning{TEXT}
46 @quotation
47 @quotation
48 @cartouche
49 @b{Note:} \TEXT\
50 @end cartouche
51 @end quotation
52 @end quotation
53 @end macro
54
55 @end ifnothtml
56
57
58 @macro docMain
59 @cartouche
60 For more information about how this manual fits with the other
61 documentation, or to read this manual in other formats, see
62 @rgeneral{manuals}.
63
64 If you are missing any manuals, the complete documentation can be
65 found at @w{@uref{http://@/www@/.lilypond@/.org/}}.
66 @end cartouche
67 @end macro
68
69
70 @macro lilyTitlePage{TITLE}
71 @c  This produces the unified index
72 @syncodeindex fn cp
73 @syncodeindex vr cp
74
75
76 @c   ***** Copyright stuff *****
77 @ifset FDL
78 @copying
79 @copyrightDeclare
80
81 @quotation
82 Permission is granted to copy, distribute and/or modify this document
83 under the terms of the GNU Free Documentation License, Version 1.1
84 or any later version published by the Free Software Foundation;
85 with no Invariant Sections.
86 A copy of the license is included in the section entitled ``GNU
87 Free Documentation License''.
88 @end quotation
89 @end copying
90 @end ifset
91
92 @ifclear FDL
93 @copying
94 This document has been placed in the public domain.
95 @end copying
96 @end ifclear
97
98
99
100 @c   ***** Title page *****
101 @ifnottex
102 @node Top
103 @top LilyPond --- \TITLE\
104
105 @cartouche
106 @manualIntro{}
107 @end cartouche
108 @end ifnottex
109
110 @finalout
111
112 @titlepage
113 @title LilyPond
114 @subtitle The music typesetter
115 @titlefont{\TITLE\}
116 @author The LilyPond development team
117
118 @vskip 60pt
119
120 @cartouche
121 @manualIntro{}
122 @end cartouche
123
124 @vskip 40pt
125
126 @docMain{}
127
128 @vskip 0pt plus 1filll
129
130 @insertcopying{}
131
132 For LilyPond version @version{}
133 @end titlepage
134
135 @end macro
136
137
138 @c   ***** Headings in a doc subsection *****
139
140 @c The next macro is a dummy currently since texinfo doesn't
141 @c provide a real ragged-right environment yet.
142 @c
143 @c Don't insert an empty line after @predefined!  Right now
144 @c it doesn't matter, but a future implementation will probably
145 @c add some code which needs this restriction.
146
147 @macro predefined
148 @noindent
149 @subsubheading Predefined commands
150 @end macro
151
152 @c Due to a bug in texi2html (texi2html.pl CVS versions <= 1.245)
153 @c the next macro must not be empty.
154
155 @macro endpredefined
156 @c
157 @end macro
158
159
160 @macro snippets
161 @noindent
162 @subsubheading Selected Snippets
163 @end macro
164
165
166 @c Don't insert an empty line after @seealso!  Otherwise we get
167 @c unwanted extra vertical space in the PDF output.
168
169 @macro seealso
170 @noindent
171 @subsubheading See also
172 @indent
173 @end macro
174
175
176 @macro knownissues
177 @noindent
178 @subsubheading Known issues and warnings
179 @end macro
180
181
182
183 @c   ***** Links and references *****
184
185 @c  Definitions for references:
186 @c
187 @c     @rgeneral
188 @c     @ressay
189 @c     @rglos
190 @c     @rinternals
191 @c     @rlearning
192 @c     @rlsr
193 @c     @rprogram
194 @c     @ruser
195 @c     @rchanges
196 @c     @rextend
197 @c     @rcontrib
198 @c
199 @c  All these also have a @...named version which allows to specify the
200 @c  displayed text for the reference as second argument.
201 @c
202 @c ***** HTML + bigpage is a special case (other manual names); all other
203 @c formats are treated similarly.
204
205
206 @c *** not TeX ***
207
208 @ifnottex
209
210 @c ** bigpage **
211
212 @ifset bigpage
213
214 @macro rglos{TEXT}
215 @vindex \TEXT\
216 @ref{\TEXT\,,,music-glossary-big-page,Music Glossary}
217 @end macro
218
219 @macro rglosnamed{TEXT,DISPLAY}
220 @vindex \TEXT\
221 @ref{\TEXT\,,\DISPLAY\,music-glossary-big-page,Music Glossary}
222 @end macro
223
224 @macro rlearning{TEXT}
225 @vindex \TEXT\
226 @ref{\TEXT\,,,learning-big-page,Learning Manual}
227 @end macro
228
229 @macro rlearningnamed{TEXT,DISPLAY}
230 @vindex \TEXT\
231 @ref{\TEXT\,,\DISPLAY\,learning-big-page,Learning Manual}
232 @end macro
233
234 @macro ruser{TEXT}
235 @vindex \TEXT\
236 @ref{\TEXT\,,,notation-big-page,Notation Reference}
237 @end macro
238
239 @macro rusernamed{TEXT,DISPLAY}
240 @vindex \TEXT\
241 @ref{\TEXT\,,\DISPLAY\,notation-big-page,Notation Reference}
242 @end macro
243
244 @macro rextend{TEXT}
245 @vindex \TEXT\
246 @ref{\TEXT\,,,extending-big-page,Extending}
247 @end macro
248
249 @macro rextendnamed{TEXT,DISPLAY}
250 @vindex \TEXT\
251 @ref{\TEXT\,,\DISPLAY\,extending-big-page,Extending}
252 @end macro
253
254 @macro rchanges{TEXT}
255 @vindex \TEXT\
256 @ref{\TEXT\,,,changes-big-page,Changes}
257 @end macro
258
259 @macro rchangesnamed{TEXT,DISPLAY}
260 @vindex \TEXT\
261 @ref{\TEXT\,,\DISPLAY\,changes-big-page,Changes}
262 @end macro
263
264 @macro rcontrib{TEXT}
265 @vindex \TEXT\
266 @ref{\TEXT\,,,contributor-big-page,Contributor's Guide}
267 @end macro
268
269 @macro rcontribnamed{TEXT,DISPLAY}
270 @vindex \TEXT\
271 @ref{\TEXT\,,\DISPLAY\,contributor-big-page,Contributor's Guide}
272 @end macro
273
274 @macro rgeneral{TEXT}
275 @vindex \TEXT\
276 @ref{\TEXT\,,,general-big-page,General Information}
277 @end macro
278
279 @macro rgeneralnamed{TEXT,DISPLAY}
280 @vindex \TEXT\
281 @ref{\TEXT\,,\DISPLAY\,general-big-page,General Information}
282 @end macro
283
284 @macro ressay{TEXT}
285 @vindex \TEXT\
286 @ref{\TEXT\,,,essay-big-page,Essay}
287 @end macro
288
289 @macro ressaynamed{TEXT,DISPLAY}
290 @vindex \TEXT\
291 @ref{\TEXT\,,\DISPLAY\,essay-big-page,Essay}
292 @end macro
293
294 @macro rprogram{TEXT}
295 @vindex \TEXT\
296 @ref{\TEXT\,,,usage-big-page,Application Usage}
297 @end macro
298
299 @macro rprogramnamed{TEXT,DISPLAY}
300 @vindex \TEXT\
301 @ref{\TEXT\,,\DISPLAY\,usage-big-page,Application Usage}
302 @end macro
303
304 @macro rlsr{TEXT}
305 @ref{\TEXT\,,,snippets-big-page,Snippets}
306 @end macro
307
308 @macro rlsrnamed{TEXT,DISPLAY}
309 @ref{\TEXT\,,\DISPLAY\,snippets-big-page,Snippets}
310 @end macro
311
312 @macro rinternals{TEXT}
313 @vindex \TEXT\
314 @ref{\TEXT\,,,internals-big-page,Internals Reference}
315 @end macro
316
317 @macro rinternalsnamed{TEXT,DISPLAY}
318 @vindex \TEXT\
319 @ref{\TEXT\,,\DISPLAY\,internals-big-page,Internals Reference}
320 @end macro
321
322 @end ifset
323
324
325 @c ** not bigpage **
326
327 @ifclear bigpage
328
329 @ifnotinfo
330
331 @macro rglos{TEXT}
332 @vindex \TEXT\
333 @ref{\TEXT\,,,music-glossary,Music Glossary}
334 @end macro
335
336 @macro rglosnamed{TEXT,DISPLAY}
337 @vindex \TEXT\
338 @ref{\TEXT\,,\DISPLAY\,music-glossary,Music Glossary}
339 @end macro
340
341 @macro rlearning{TEXT}
342 @vindex \TEXT\
343 @ref{\TEXT\,,,learning,Learning Manual}
344 @end macro
345
346 @macro rlearningnamed{TEXT,DISPLAY}
347 @vindex \TEXT\
348 @ref{\TEXT\,,,learning,Learning Manual}
349 @end macro
350
351 @macro ruser{TEXT}
352 @vindex \TEXT\
353 @ref{\TEXT\,,,notation,Notation Reference}
354 @end macro
355
356 @macro rusernamed{TEXT,DISPLAY}
357 @vindex \TEXT\
358 @ref{\TEXT\,,\DISPLAY\,notation,Notation Reference}
359 @end macro
360
361 @macro rchanges{TEXT}
362 @vindex \TEXT\
363 @ref{\TEXT\,,,changes,Changes}
364 @end macro
365
366 @macro rchangesnamed{TEXT,DISPLAY}
367 @vindex \TEXT\
368 @ref{\TEXT\,,\DISPLAY\,changes,Changes}
369 @end macro
370
371 @macro rextend{TEXT}
372 @vindex \TEXT\
373 @ref{\TEXT\,,,extending,Extending}
374 @end macro
375
376 @macro rextendnamed{TEXT,DISPLAY}
377 @vindex \TEXT\
378 @ref{\TEXT\,,\DISPLAY\,extending,Extending}
379 @end macro
380
381 @macro rcontrib{TEXT}
382 @vindex \TEXT\
383 @ref{\TEXT\,,,contributor,Contributor's Guide}
384 @end macro
385
386 @macro rcontribnamed{TEXT,DISPLAY}
387 @vindex \TEXT\
388 @ref{\TEXT\,,\DISPLAY\,contributor,Contributor's Guide}
389 @end macro
390
391 @macro rgeneral{TEXT}
392 @vindex \TEXT\
393 @ref{\TEXT\,,,general,General Information}
394 @end macro
395
396 @macro rgeneralnamed{TEXT,DISPLAY}
397 @vindex \TEXT\
398 @ref{\TEXT\,,\DISPLAY\,general,General Information}
399 @end macro
400
401 @macro ressay{TEXT}
402 @vindex \TEXT\
403 @ref{\TEXT\,,,essay,Essay}
404 @end macro
405
406 @macro ressaynamed{TEXT,DISPLAY}
407 @vindex \TEXT\
408 @ref{\TEXT\,,\DISPLAY\,essay,Essay}
409 @end macro
410
411 @macro rprogram{TEXT}
412 @vindex \TEXT\
413 @ref{\TEXT\,,,usage,Application Usage}
414 @end macro
415
416 @macro rprogramnamed{TEXT,DISPLAY}
417 @vindex \TEXT\
418 @ref{\TEXT\,,\DISPLAY\,usage,Application Usage}
419 @end macro
420
421 @macro rlsr{TEXT}
422 @ref{\TEXT\,,,snippets,Snippets}
423 @end macro
424
425 @macro rlsrnamed{TEXT,DISPLAY}
426 @ref{\TEXT\,,\DISPLAY\,snippets,Snippets}
427 @end macro
428
429 @macro rinternals{TEXT}
430 @vindex \TEXT\
431 @ref{\TEXT\,,,internals,Internals Reference}
432 @end macro
433
434 @macro rinternalsnamed{TEXT,DISPLAY}
435 @vindex \TEXT\
436 @ref{\TEXT\,,\DISPLAY\,internals,Internals Reference}
437 @end macro
438
439 @end ifnotinfo
440
441 @ifinfo
442
443 @macro rglos{TEXT}
444 @vindex \TEXT\
445 @ref{\TEXT\,,,music-glossary,Music Glossary}
446 @end macro
447
448 @macro rglosnamed{TEXT,DISPLAY}
449 @vindex \TEXT\
450 @ref{\TEXT\,,\DISPLAY\,music-glossary,Music Glossary}
451 @end macro
452
453 @macro rlearning{TEXT}
454 @vindex \TEXT\
455 @ref{\TEXT\,,,lilypond-learning,Learning Manual}
456 @end macro
457
458 @macro rlearningnamed{TEXT,DISPLAY}
459 @vindex \TEXT\
460 @ref{\TEXT\,,,lilypond-learning,Learning Manual}
461 @end macro
462
463 @macro ruser{TEXT}
464 @vindex \TEXT\
465 @ref{\TEXT\,,,lilypond-notation,Notation Reference}
466 @end macro
467
468 @macro rusernamed{TEXT,DISPLAY}
469 @vindex \TEXT\
470 @ref{\TEXT\,,\DISPLAY\,lilypond-notation,Notation Reference}
471 @end macro
472
473 @macro rchanges{TEXT}
474 @vindex \TEXT\
475 @ref{\TEXT\,,,lilypond-changes,Changes}
476 @end macro
477
478 @macro rchangesnamed{TEXT,DISPLAY}
479 @vindex \TEXT\
480 @ref{\TEXT\,,\DISPLAY\,lilypond-changes,Changes}
481 @end macro
482
483 @macro rextend{TEXT}
484 @vindex \TEXT\
485 @ref{\TEXT\,,,lilypond-extending,Extending}
486 @end macro
487
488 @macro rextendnamed{TEXT,DISPLAY}
489 @vindex \TEXT\
490 @ref{\TEXT\,,\DISPLAY\,lilypond-extending,Extending}
491 @end macro
492
493 @macro rcontrib{TEXT}
494 @vindex \TEXT\
495 @ref{\TEXT\,,,lilypond-contributor,Contributor's Guide}
496 @end macro
497
498 @macro rcontribnamed{TEXT,DISPLAY}
499 @vindex \TEXT\
500 @ref{\TEXT\,,\DISPLAY\,lilypond-contributor,Contributor's Guide}
501 @end macro
502
503 @macro rgeneral{TEXT}
504 @vindex \TEXT\
505 @ref{\TEXT\,,,lilypond-general,General Information}
506 @end macro
507
508 @macro rgeneralnamed{TEXT,DISPLAY}
509 @vindex \TEXT\
510 @ref{\TEXT\,,\DISPLAY\,lilypond-general, General Information}
511 @end macro
512
513 @macro ressay{TEXT}
514 @vindex \TEXT\
515 @ref{\TEXT\,,,lilypond-essay,Essay}
516 @end macro
517
518 @macro ressaynamed{TEXT,DISPLAY}
519 @vindex \TEXT\
520 @ref{\TEXT\,,\DISPLAY\,lilypond-essay,Essay}
521 @end macro
522
523 @macro rprogram{TEXT}
524 @vindex \TEXT\
525 @ref{\TEXT\,,,lilypond-usage,Application Usage}
526 @end macro
527
528 @macro rprogramnamed{TEXT,DISPLAY}
529 @vindex \TEXT\
530 @ref{\TEXT\,,\DISPLAY\,lilypond-usage,Application Usage}
531 @end macro
532
533 @macro rlsr{TEXT}
534 @ref{\TEXT\,,,lilypond-snippets,Snippets}
535 @end macro
536
537 @macro rlsrnamed{TEXT,DISPLAY}
538 @ref{\TEXT\,,\DISPLAY\,lilypond-snippets,Snippets}
539 @end macro
540
541 @macro rinternals{TEXT}
542 @vindex \TEXT\
543 @ref{\TEXT\,,,lilypond-internals,Internals Reference}
544 @end macro
545
546 @macro rinternalsnamed{TEXT,DISPLAY}
547 @vindex \TEXT\
548 @ref{\TEXT\,,\DISPLAY\,lilypond-internals,Internals Reference}
549 @end macro
550
551 @end ifinfo
552
553 @end ifclear
554
555 @end ifnottex
556
557
558 @c *** TeX ***
559
560 @iftex
561
562 @c All commands below should work in the middle of the line;
563 @c we thus must not use @vindex directly since it works only if placed
564 @c on a line of its own.  To overcome this problem, we define a
565 @c replacement macro using the internal definition of @vindex which
566 @c delimits arguments in the standard way (i.e., with braces).
567
568 @tex
569 \gdef\lilyvindex#1{\doind{vr}{\code{#1}}\ignorespaces}
570 @end tex
571
572 @macro rglos{TEXT}
573 @lilyvindex{\TEXT\}
574 @ref{\TEXT\,,,music-glossary,Music Glossary}
575 @end macro
576
577 @macro rglosnamed{TEXT,DISPLAY}
578 @lilyvindex{\TEXT\}
579 @ref{\TEXT\,,\DISPLAY\,music-glossary,Music Glossary}
580 @end macro
581
582 @macro rlearning{TEXT}
583 @lilyvindex{\TEXT\}
584 @ref{\TEXT\,,,learning,Learning Manual}
585 @end macro
586
587 @macro rlearningnamed{TEXT,DISPLAY}
588 @lilyvindex{\TEXT\}
589 @ref{\TEXT\,,\DISPLAY\,learning,Learning Manual}
590 @end macro
591
592 @macro ruser{TEXT}
593 @lilyvindex{\TEXT\}
594 @ref{\TEXT\,,,notation,Notation Reference}
595 @end macro
596
597 @macro rusernamed{TEXT,DISPLAY}
598 @lilyvindex{\TEXT\}
599 @ref{\TEXT\,,\DISPLAY\,notation,Notation Reference}
600 @end macro
601
602 @macro rchanges{TEXT}
603 @lilyvindex{\TEXT\}
604 @ref{\TEXT\,,,changes,Changes}
605 @end macro
606
607 @macro rchangesnamed{TEXT,DISPLAY}
608 @lilyvindex{\TEXT\}
609 @ref{\TEXT\,,\DISPLAY\,changes,Changes}
610 @end macro
611
612 @macro rextend{TEXT}
613 @lilyvindex{\TEXT\}
614 @ref{\TEXT\,,,extending,Extending}
615 @end macro
616
617 @macro rextendnamed{TEXT,DISPLAY}
618 @lilyvindex{\TEXT\}
619 @ref{\TEXT\,,\DISPLAY\,extending,Extending}
620 @end macro
621
622 @macro rcontrib{TEXT}
623 @lilyvindex{\TEXT\}
624 @ref{\TEXT\,,,contributor,Contributor's Guide}
625 @end macro
626
627 @macro rcontribnamed{TEXT,DISPLAY}
628 @lilyvindex{\TEXT\}
629 @ref{\TEXT\,,\DISPLAY\,contributor,Contributor's Guide}
630 @end macro
631
632 @macro rgeneral{TEXT}
633 @lilyvindex{\TEXT\}
634 @ref{\TEXT\,,,general,General Information}
635 @end macro
636
637 @macro rgeneralnamed{TEXT,DISPLAY}
638 @lilyvindex{\TEXT\}
639 @ref{\TEXT\,,\DISPLAY\,general,General Information}
640 @end macro
641
642 @macro ressay{TEXT}
643 @lilyvindex{\TEXT\}
644 @ref{\TEXT\,,,essay,Essay}
645 @end macro
646
647 @macro ressaynamed{TEXT,DISPLAY}
648 @lilyvindex{\TEXT\}
649 @ref{\TEXT\,,\DISPLAY\,essay,Essay}
650 @end macro
651
652 @macro rprogram{TEXT}
653 @lilyvindex{\TEXT\}
654 @ref{\TEXT\,,,usage,Application Usage}
655 @end macro
656
657 @macro rprogramnamed{TEXT,DISPLAY}
658 @lilyvindex{\TEXT\}
659 @ref{\TEXT\,,\DISPLAY\,usage,Application Usage}
660 @end macro
661
662 @macro rlsr{TEXT}
663 @lilyvindex{\TEXT\}
664 @ref{\TEXT\,,,snippets,Snippets}
665 @end macro
666
667 @macro rlsrnamed{TEXT,DISPLAY}
668 @lilyvindex{\TEXT\}
669 @ref{\TEXT\,,\DISPLAY\,snippets,Snippets}
670 @end macro
671
672 @macro rinternals{TEXT}
673 @lilyvindex{\TEXT\}
674 @ref{\TEXT\,,,internals,Internals Reference}
675 @end macro
676
677 @macro rinternalsnamed{TEXT,DISPLAY}
678 @lilyvindex{\TEXT\}
679 @ref{\TEXT\,,\DISPLAY\,internals,Internals Reference}
680 @end macro
681
682 @end iftex
683
684 @c  ***** Macros specific to the web site *****
685
686 @ifset web
687
688 @c LEGALESE
689
690 @macro logoLegalLinux
691 Tux the Linux Penguin was created by
692 @uref{mailto:lewing@@isc.tamu.edu, lewing@@isc.tamu.edu} with
693 @uref{http://www.isc.tamu.edu/~lewing/gimp/, the Gnu Image
694 Manipulation Program}.
695
696 @end macro
697
698 @macro logoLegalFreeBSD
699 The FreeBSD logo is a registered trademark of
700 @uref{http://www.freebsd.org/, The FreeBSD Foundation}.
701
702 @end macro
703
704 @macro logoLegalMacOSX
705 The @qq{X image} is not a registered trademark.  It was created by
706 @uref{http://en.wikipedia.org/wiki/User:Nihonjoe, Nihonjoe} and
707 @uref{http://en.wikipedia.org/wiki/User:CyberSkull, CyberSkull}, and
708 placed under the GNU Free Documentation License version 1.2 or later.
709 We found the image on
710 @uref{http://commons.wikimedia.org/wiki/File:Mac_OS_X_Userbox_X.png,
711 this Wikipedia Commons page}.
712
713 @end macro
714
715 @macro logoLegalWindows
716 The @qq{four colored rectangles image} is not a registered
717 trademark.  It was created by
718 @uref{http://en.wikipedia.org/wiki/User:Rohitbd, Rohitbd} and
719 placed under the GNU Free Documentation License version 1.2.  We
720 found the image on
721 @uref{http://commons.wikimedia.org/wiki/Category:Microsoft_Windows_logos,
722 this Wikipedia Commons page}.
723
724 @end macro
725
726 @end ifset