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