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