]> git.donarmstrong.com Git - lilypond.git/blobdiff - Documentation/de/user/macros.itexi
lilypond-book robustness: ensure EOL at the end of @verbatim
[lilypond.git] / Documentation / de / user / macros.itexi
index c76439b9dff7cb39b3f6fea45ebdb018e5ac1aa5..9d47c007b14792076f53b1ce37b6baf5ccba8822 100644 (file)
@@ -1,6 +1,6 @@
 @c -*- coding: utf-8; mode: texinfo; -*-
 @ignore
-    Translation of GIT committish: db57f02c46305a587071dfb73a51bd8250df2482
+    Translation of GIT committish: 01361d46dc9d514a79683d003eeea5f4fbf2b746
 
     When revising a translation, copy the HEAD committish of the
     version that you are working on.  See TRANSLATION for details.
@@ -8,16 +8,14 @@
 
 
 @include version.itexi
+@include common-macros.itexi
 
 
 @c   ***** Displaying text *****
 
-@c we need this since @q{\} doesn't work with makeinfo 4.8 --
-@c say @q{@value{backslash}} instead
-@set backslash \
+@c To get decent quotes in ,foo' and ,,foo''.
+@c These need to be split up so that "@qq{foo}." looks nice.  :(
 
-@c to get decent quotes in `foo' and ``foo''
-@c  these need to be split up so that "@qq{foo}." looks nice.  :(
 @macro q{TEXT}
 @quotesinglbase{}\TEXT\@quoteleft{}
 @end macro
 @quotedblbase{}\TEXT\@quotedblleft{}
 @end macro
 
+
+@ifhtml
+
 @macro warning{TEXT}
-@quotation
-@quotation
 @cartouche
 @b{Achtung:} \TEXT\
 @end cartouche
-@end quotation
-@end quotation
-@end macro
-
-@ifnotinfo
-@macro notation{TEXT}
-@var{\TEXT\}
 @end macro
-@end ifnotinfo
 
-@ifinfo
-@macro notation{TEXT}
-\TEXT\
-@end macro
-@end ifinfo
-
-@macro smallspace
-@sp 1
-@end macro
-
-
-@c   **** Displaying images not generated by lilypond-book
+@end ifhtml
 
-@c current installation setup of Info docs requires that all images are
-@c expected to be found in lilypond/ subdirectory.  lilypond-book already
-@c generates proper @image commands for images of music; these macros
-@c definitions do the same for other images.
+@ifnothtml
 
-@ifnotinfo
-@macro sourceimage{FILENAME,WIDTH,HEIGHT,ALTTEXT}
-@image{\FILENAME\,\WIDTH\,\HEIGHT\,\ALTTEXT\}
+@macro warning{TEXT}
+@quotation
+@quotation
+@cartouche
+@b{Achtung:} \TEXT\
+@end cartouche
+@end quotation
+@end quotation
 @end macro
-@end ifnotinfo
 
-@ifinfo
-@macro sourceimage{FILENAME,WIDTH,HEIGHT,ALTTEXT}
-@image{lilypond/\FILENAME\,\WIDTH\,\HEIGHT\,\ALTTEXT\}
-@end macro
-@end ifinfo
+@end ifnothtml
 
 
+@c   ***** Headings in a doc subsection *****
 
-@c   **** Headings in a doc subsection ****
+@c Don't insert an empty line after @predefined!  Right now
+@c it doesn't matter, but a future implementation will probably
+@c add some code which needs this restriction.
 
 @macro predefined
 @noindent
 @subsubheading Predefined commands
+@end macro
 
+@c The next macro is a dummy currently since texinfo doesn't
+@c provide a real ragged-right environment yet.
+@c
+@c Due to a bug in texi2html (texi2html.pl CVS versions <= 1.245)
+@c the macro must not be empty.
+
+@macro endpredefined
+@c
 @end macro
 
+
 @macro snippets
 @noindent
 @subsubheading Selected Snippets
-
 @end macro
 
+
 @c obsolete, remove when translation is fully updated
 @macro commonprop
 @noindent
 @subsubheading Commonly tweaked properties
-
 @end macro
 
+
+@c Don't insert an empty line after @seealso!  Otherwise we get
+@c unwanted extra vertical space in the PDF output.
+
 @macro seealso
 @noindent
 @subsubheading See also
-
+@indent
 @end macro
 
+
 @macro knownissues
 @noindent
 @subsubheading Known issues and warnings
-
-@end macro
-
-@c obsolete, remove when translation is fully updated
-@macro context{TEXT}
-@vindex \TEXT\
-@code{\TEXT\}@c should use internalsref
-@end macro
-
-@macro lydoctitle {TEXT}
-@emph{\TEXT\}
-
-@end macro
-
-@macro funindex {TEXT}
-@findex \TEXT\
-@kindex \TEXT\
 @end macro
 
 
 
-@c   **** Links and references ****
+@c   ***** Links and references *****
 
 @c obsolete
 @c usage: @lsr{ancient,custodes.ly}
 @end macro
 
 
-
-
 @c  Definitions for references:
-@c     @internalsref
+@c
 @c     @rglos
-@c     @rprogram
-@c     @ruser
 @c     @rlearning
+@c     @ruser
+@c     @rprogram
+@c     @rlsr
+@c     @rinternals
+@c
+@c  All these also have a @...named version which allows to specify the
+@c  displayed text for the reference as second argument.
+@c
+@c ***** HTML + bigpage is a special case (other manual names); all other
+@c formats are treated similarly.
 
-@ifhtml
-@c ***** HTML *****
 
-@ifset bigpage
+@c *** not TeX ***
 
-@macro internalsref{TEXT}
-@vindex \TEXT\
-@ref{\TEXT\,,,lilypond-internals-big-page,Programmreferenz}
-@end macro
+@ifnottex
+
+@c ** bigpage **
+
+@ifset bigpage
 
 @macro rglos{TEXT}
 @vindex \TEXT\
 @ref{\TEXT\,,,music-glossary-big-page,Glossar}
 @end macro
 
-@macro rprogram{TEXT}
+@macro rglosnamed{TEXT,DISPLAY}
 @vindex \TEXT\
-@ref{\TEXT\,,,lilypond-program-big-page,Programmbenutzung}
-@end macro
-
-@macro ruser{TEXT}
-@vindex \TEXT\
-@ref{\TEXT\,,,lilypond-big-page,Benutzerhandbuch}
+@ref{\TEXT\,,\DISPLAY\,music-glossary-big-page,Glossar}
 @end macro
 
 @macro rlearning{TEXT}
 @ref{\TEXT\,,,lilypond-learning-big-page,Handbuch zum Lernen}
 @end macro
 
-@end ifset
-
-
-@ifclear bigpage
+@macro rlearningnamed{TEXT,DISPLAY}
+@vindex \TEXT\
+@ref{\TEXT\,,\DISPLAY\,lilypond-learning-big-page,Handbuch zum Lernen}
+@end macro
 
-@macro internalsref{TEXT}
+@macro ruser{TEXT}
 @vindex \TEXT\
-@ref{\TEXT\,,,lilypond-internals,Programmreferenz}
+@ref{\TEXT\,,,lilypond-big-page,Notationsreferenz}
 @end macro
 
-@macro rglos{TEXT}
+@macro rusernamed{TEXT,DISPLAY}
 @vindex \TEXT\
-@ref{\TEXT\,,,music-glossary,Glossar}
+@ref{\TEXT\,,\DISPLAY\,lilypond-big-page,Notationsreferenz}
 @end macro
 
 @macro rprogram{TEXT}
 @vindex \TEXT\
-@ref{\TEXT\,,,lilypond-program,Programmbenutzung}
+@ref{\TEXT\,,,lilypond-program-big-page,Anwendungsbenutzung}
 @end macro
 
-@macro ruser{TEXT}
+@macro rprogramnamed{TEXT,DISPLAY}
 @vindex \TEXT\
-@ref{\TEXT\,,,lilypond,Benutzerhandbuch}
+@ref{\TEXT\,,\DISPLAY\,lilypond-program-big-page,Anwendungsbenutzung}
 @end macro
 
-@macro rlearning{TEXT}
+@macro rlsr{TEXT}
+@ref{\TEXT\,,,lilypond-snippets-big-page,Schnipsel}
+@end macro
+
+@macro rlsrnamed{TEXT,DISPLAY}
+@ref{\TEXT\,,\DISPLAY\,lilypond-snippets-big-page,Schnipsel}
+@end macro
+
+@macro rinternals{TEXT}
 @vindex \TEXT\
-@ref{\TEXT\,,,lilypond-learning,Handbuch zum Lernen}
+@ref{\TEXT\,,,lilypond-internals-big-page,Referenz der Interna}
 @end macro
 
-@end ifclear
+@macro rinternalsnamed{TEXT,DISPLAY}
+@vindex \TEXT\
+@ref{\TEXT\,,\DISPLAY\,lilypond-internals-big-page,Referenz der Interna}
+@end macro
 
-@end ifhtml
+@end ifset
 
 
-@ifdocbook
-@c ***** DOCBOOK-XML *****
+@c ** not bigpage **
 
-@macro internalsref{TEXT}
-@vindex \TEXT\
-@ref{\TEXT\,,,lilypond-internals,Programmreferenz}
-@end macro
+@ifclear bigpage
 
 @macro rglos{TEXT}
 @vindex \TEXT\
 @ref{\TEXT\,,,music-glossary,Glossar}
 @end macro
 
-@macro rprogram{TEXT}
+@macro rglosnamed{TEXT,DISPLAY}
 @vindex \TEXT\
-@ref{\TEXT\,,,lilypond-program,Programmbenutzung}
+@ref{\TEXT\,,\DISPLAY\,music-glossary,Glossar}
 @end macro
 
-@macro ruser{TEXT}
+@macro rlearning{TEXT}
 @vindex \TEXT\
-@ref{\TEXT\,,,lilypond,Benutzerhandbuch}
+@ref{\TEXT\,,,lilypond-learning,Handbuch zum Lernen}
 @end macro
 
-@macro rlearning{TEXT}
+@macro rlearningnamed{TEXT,DISPLAY}
 @vindex \TEXT\
-@ref{\TEXT\,,,lilypond-learning,Handbuch zum Lernen}
+@ref{\TEXT\,,\DISPLAY\,lilypond-learning,Handbuch zum Lernen}
 @end macro
 
-@end ifdocbook
+@macro ruser{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond,Notationsreferenz}
+@end macro
 
+@macro rusernamed{TEXT,DISPLAY}
+@vindex \TEXT\
+@ref{\TEXT\,,\DISPLAY\,lilypond,Notationsreferenz}
+@end macro
 
-@ifinfo
-@c **** INFO ****
+@macro rprogram{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-program,Anwendungsbenutzung}
+@end macro
 
-@macro internalsref{NAME}
-@vindex \NAME\
-@inforef{\NAME\,,lilypond-internals,Programmreferenz}
+@macro rprogramnamed{TEXT,DISPLAY}
+@vindex \TEXT\
+@ref{\TEXT\,,\DISPLAY\,lilypond-program,Anwendungsbenutzung}
 @end macro
 
-@macro rglos{NAME}
-@vindex \NAME\
-@inforef{\NAME\,,music-glossary,Glossar}
+@macro rlsr{TEXT}
+@ref{\TEXT\,,,lilypond-snippets,Schnipsel}
 @end macro
 
-@macro rprogram{TEXT}
-@vindex \TEXT\
-@ref{\TEXT\,,,lilypond-program,Programmbenutzung}
+@macro rlsrnamed{TEXT,DISPLAY}
+@ref{\TEXT\,,\DISPLAY\,lilypond-snippets,Schnipsel}
 @end macro
 
-@macro ruser{TEXT}
+@macro rinternals{TEXT}
 @vindex \TEXT\
-@ref{\TEXT\,,,lilypond,Benutzerhandbuch}
+@ref{\TEXT\,,,lilypond-internals,Referenz der Interna}
 @end macro
 
-@macro rlearning{TEXT}
+@macro rinternalsnamed{TEXT,DISPLAY}
 @vindex \TEXT\
-@ref{\TEXT\,,,lilypond-learning,Handbuch zum Lernen}
+@ref{\TEXT\,,\DISPLAY\,lilypond-internals,Referenz der Interna}
 @end macro
 
-@end ifinfo
+@end ifclear
+
+@end ifnottex
+
 
+@c *** TeX ***
 
-@c **** TEX ****
 @iftex
 
-@macro internalsref{TEXT}
-@vindex \TEXT\
-@code{\TEXT\}
-@end macro
+@c All commands below should work in the middle of the line;
+@c we thus must not use @vindex directly since it works only if placed
+@c on a line of its own.  To overcome this problem, we define a
+@c replacement macro using the internal definition of @vindex which
+@c delimits arguments in the standard way (i.e., with braces).
 
-@macro rglos {TEXT}
-@vindex \TEXT\
+@tex
+\gdef\lilyvindex#1{\doind{vr}{\code #1}\ignorespaces}
+@end tex
+
+@macro rglos{TEXT}
+@lilyvindex{\TEXT\}
 @ref{\TEXT\,,,music-glossary,Glossar}
 @end macro
 
-@macro rprogram{TEXT}
-@ref{\TEXT\,,,lilypond-program.de,Programmbenutzung}
+@macro rglosnamed{TEXT,DISPLAY}
+@lilyvindex{\TEXT\}
+@ref{\TEXT\,,\DISPLAY\,music-glossary,Glossar}
+@end macro
+
+@macro rlearning{TEXT}
+@lilyvindex{\TEXT\}
+@ref{\TEXT\,,,lilypond-learning.de,Handbuch zum Lernen}
+@end macro
+
+@macro rlearningnamed{TEXT,DISPLAY}
+@lilyvindex{\TEXT\}
+@ref{\TEXT\,,\DISPLAY\,lilypond-learning.de,Handbuch zum Lernen}
 @end macro
 
 @macro ruser{TEXT}
-@ref{\TEXT\,,,lilypond.de,Benutzerhandbuch}
+@lilyvindex{\TEXT\}
+@ref{\TEXT\,,,lilypond.de,Notationsreferenz}
 @end macro
 
-@macro rlearning{TEXT}
-@ref{\TEXT\,,,lilypond-learning.de,Handbuch zum Lernen}
+@macro rusernamed{TEXT,DISPLAY}
+@lilyvindex{\TEXT\}
+@ref{\TEXT\,,\DISPLAY\,lilypond.de,Notationsreferenz}
 @end macro
 
-@end iftex
+@macro rprogram{TEXT}
+@lilyvindex{\TEXT\}
+@ref{\TEXT\,,,lilypond-program.de,Anwendungsbenutzung}
+@end macro
 
-@c Commands specific to translated docs
+@macro rprogramnamed{TEXT,DISPLAY}
+@lilyvindex{\TEXT\}
+@ref{\TEXT\,,\DISPLAY\,lilypond-program.de,Anwendungsbenutzung}
+@end macro
 
-@c ugh, cannot set/define global variable 'translationof' in some way?
-@iftex
-@macro translationof{TEXT}
+@macro rlsr{TEXT}
+@lilyvindex{\TEXT\}
+@ref{\TEXT\,,,lilypond-snippets,Schnipsel}
+@end macro
+
+@macro rlsrnamed{TEXT,DISPLAY}
+@lilyvindex{\TEXT\}
+@ref{\TEXT\,,\DISPLAY\,lilypond-snippets,Schnipsel}
 @end macro
-@end iftex
 
-@ifinfo
-@macro
-@macro translationof{TEXT}
-@set translationof \TEXT\
+@macro rinternals{TEXT}
+@lilyvindex{\TEXT\}
+@ref{\TEXT\,,,lilypond-internals,Referenz der Interna}
 @end macro
-@end ifinfo
 
-@c TODO when @translationof is used in translated docs
-@c see if it's feasible to say @value{translationof}
+@macro rinternalsnamed{TEXT,DISPLAY}
+@lilyvindex{\TEXT\}
+@ref{\TEXT\,,\DISPLAY\,lilypond-internals,Referenz der Interna}
+@end macro
+
+@end iftex
+
+
+
+@c   ***** Macros specific to translated docs *****
+
+
 @macro englishref
-Dieser Abschnitt wurde noch nicht übersetzt, bitte lesen Sie den
+Dieser Abschnitt wurde noch nicht übersetzt.  Bitte lesen Sie den
 Abschnitt im englischen Benutzerhandbuch.
 @end macro