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