]> 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 fc8754b43e16c1091c8c8792133e8d6a7f6df3bf..9d47c007b14792076f53b1ce37b6baf5ccba8822 100644 (file)
 @c -*- coding: utf-8; mode: texinfo; -*-
+@ignore
+    Translation of GIT committish: 01361d46dc9d514a79683d003eeea5f4fbf2b746
 
-@c FIXME: rearranged this file; macros that don't depend on the output
-@c format should go at the beginning.  -gp
+    When revising a translation, copy the HEAD committish of the
+    version that you are working on.  See TRANSLATION for details.
+@end ignore
 
-@c in retrospect this is _not_ one of the output-insensitive macros.
-@c I'll fix it soon.
-@c usage: @lsr{ancient,custodes.ly}
-@macro lsr{DIR,NAME}
-@uref{source/input/lsr/\DIR\/collated-files.html#\NAME\,@file{\DIR\/\NAME\}}
+
+@include version.itexi
+@include common-macros.itexi
+
+
+@c   ***** Displaying text *****
+
+@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
 
-@macro lsrdir{DIR}
-@uref{source/input/lsr/\DIR\/collated-files.html,@file{\DIR\}}
+@macro qq{TEXT}
+@quotedblbase{}\TEXT\@quotedblleft{}
 @end macro
 
-@ifnottex
-  @macro texisharp {word}
-  #
-  @end macro
-  @macro texiflat {word}
-  b
-  @end macro
-@end ifnottex
 
-@c FIXME, use \fetaaccidentalsXMC?
-@c \\kern0.15em\\fetachar\\fetaflat
-@iftex
- @macro texiflat {word}
- @tex
- FIXME: fetaflat
- @end tex
- @end macro
-@c FIXME, use \fetaaccidentalsXC?
-@c  \\raise0.5ex\\fetachar\\fetasharp
- @macro texisharp {word}
-  @tex
-  FIXME: fetasharp
-  @end tex
-  @end macro
-@end iftex
+@ifhtml
 
+@macro warning{TEXT}
+@cartouche
+@b{Achtung:} \TEXT\
+@end cartouche
+@end macro
 
-@macro arrow{}
-@iftex
-@tex $\\Rightarrow$ @end tex@c
-@end iftex
-@ifhtml
-@html
-→
-@end html
 @end ifhtml
-@ifinfo
--->
-@end ifinfo
+
+@ifnothtml
+
+@macro warning{TEXT}
+@quotation
+@quotation
+@cartouche
+@b{Achtung:} \TEXT\
+@end cartouche
+@end quotation
+@end quotation
 @end macro
 
+@end ifnothtml
 
-@ifhtml
-@c ***** HTML *****
 
-@c makeinfo-4.7 encodes html names, which means that nodes that
-@c contain nonalphanum characters will be broken links on the website.
-@c @uref{../lilypond-internals/\NAME\.html,\NAME\}@c
-@c @inforef{} adds ``See'' to the sentence, which is annoying, but
-@c better than a broken link.
-@c @inforef{\NAME\,,lilypond-internals}@c
-@c using @ref without punctuation is OK without for formats other than info
+@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.
 
-@c annoying parentheses stripped by add-html-footer.py
-@macro internalsref{NAME}
-@vindex \NAME\
-@ref{\NAME\,,,lilypond-internals}
+@macro predefined
+@noindent
+@subsubheading Predefined commands
 @end macro
 
-@c usage: @inputfileref{input@/regression,FILE@/-NAME.ly}
-@macro inputfileref{DIR,NAME}
-@uref{source/\DIR\/collated-files.html#\NAME\,@file{\DIR\/\NAME\}}@c
+@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
 
-@c annoying parentheses stripped by add-html-footer.py
-@macro rglos{NAME}
-@vindex \NAME\
-@ref{\NAME\,,,music-glossary}
+
+@macro snippets
+@noindent
+@subsubheading Selected Snippets
 @end macro
 
-@c to get decent German quotes in `foo'
-@macro q{TEXT}
-@html
-&sbquo;\TEXT\&rsquo;
-@end html
+
+@c obsolete, remove when translation is fully updated
+@macro commonprop
+@noindent
+@subsubheading Commonly tweaked properties
 @end macro
 
-@c to get decent German quotes in ``foo''
-@macro qq{TEXT}
-@html
-&bdquo;\TEXT\&ldquo;
-@end html
+
+@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
 
-@end ifhtml
 
 
-@ifdocbook
-@c ***** DOCBOOK-XML *****
+@c   ***** Links and references *****
 
-@macro internalsref{NAME}
-@vindex \NAME\
-@ref{\NAME\,,,lilypond-internals}
+@c obsolete
+@c usage: @lsr{ancient,custodes.ly}
+@macro lsr{DIR,TEXT}
+@ifhtml
+@uref{source/input/lsr/\DIR\/collated-files.html#\TEXT\,@file{\DIR\/\TEXT\}}
+@end ifhtml
+@ifnothtml
+@file{\DIR\/\TEXT\}
+@end ifnothtml
 @end macro
 
-@macro inputfileref{DIR,NAME}
-@uref{source/\DIR\/collated-files.html#\NAME\,@file{\DIR\/\NAME\}}
+@c don't update until this macro is correctly set up in English docs
+@macro lsrdir{DIR}
+@ifhtml
+@uref{source/input/lsr/\DIR\/collated-files.html,@file{\DIR\}/}
+@end ifhtml
+@ifnothtml
+@file{\DIR\}
+@end ifnothtml
 @end macro
 
-@macro rglos{NAME}
-@vindex \NAME\
-@ref{\NAME\,,,music-glossary}
+
+@c  Definitions for references:
+@c
+@c     @rglos
+@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.
+
+
+@c *** not TeX ***
+
+@ifnottex
+
+@c ** bigpage **
+
+@ifset bigpage
+
+@macro rglos{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,music-glossary-big-page,Glossar}
 @end macro
 
-@c to get decent German quotes in `foo'
-@macro q{TEXT}
-@xml
-&sbquo;\TEXT\&lsquo;
-@end xml
+@macro rglosnamed{TEXT,DISPLAY}
+@vindex \TEXT\
+@ref{\TEXT\,,\DISPLAY\,music-glossary-big-page,Glossar}
 @end macro
 
-@c to get decent German quotes in ``foo''
-@macro qq{TEXT}
-@xml
-&bdquo;\TEXT\&ldquo;
-@end xml
+@macro rlearning{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-learning-big-page,Handbuch zum Lernen}
 @end macro
 
-@end ifdocbook
+@macro rlearningnamed{TEXT,DISPLAY}
+@vindex \TEXT\
+@ref{\TEXT\,,\DISPLAY\,lilypond-learning-big-page,Handbuch zum Lernen}
+@end macro
 
+@macro ruser{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-big-page,Notationsreferenz}
+@end macro
 
-@ifinfo
-@c **** INFO ****
+@macro rusernamed{TEXT,DISPLAY}
+@vindex \TEXT\
+@ref{\TEXT\,,\DISPLAY\,lilypond-big-page,Notationsreferenz}
+@end macro
 
-@macro internalsref{NAME}
-@vindex \NAME\
-@inforef{\NAME\,,lilypond-internals}
+@macro rprogram{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-program-big-page,Anwendungsbenutzung}
 @end macro
 
-@macro inputfileref{DIR,NAME}
-@file{\DIR\/\NAME\}
+@macro rprogramnamed{TEXT,DISPLAY}
+@vindex \TEXT\
+@ref{\TEXT\,,\DISPLAY\,lilypond-program-big-page,Anwendungsbenutzung}
 @end macro
 
-@macro rglos{NAME}@c
-@vindex \NAME\
-@inforef{\NAME\,,,music-glossary}
+@macro rlsr{TEXT}
+@ref{\TEXT\,,,lilypond-snippets-big-page,Schnipsel}
 @end macro
 
-@macro usermanref{NAME}
-@inforef{\NAME\}
+@macro rlsrnamed{TEXT,DISPLAY}
+@ref{\TEXT\,,\DISPLAY\,lilypond-snippets-big-page,Schnipsel}
 @end macro
 
-@c to get decent quotes in `foo'
-@macro q{TEXT}
-‚\TEXT\‘
+@macro rinternals{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-internals-big-page,Referenz der Interna}
 @end macro
 
-@c to get decent quotes in ``foo''
-@macro qq{TEXT}
-„\TEXT\“
+@macro rinternalsnamed{TEXT,DISPLAY}
+@vindex \TEXT\
+@ref{\TEXT\,,\DISPLAY\,lilypond-internals-big-page,Referenz der Interna}
 @end macro
 
-@end ifinfo
+@end ifset
 
 
-@c **** TEX ****
-@iftex
+@c ** not bigpage **
 
-@macro internalsref{NAME}
-@vindex \NAME\
-@code{\NAME\}
+@ifclear bigpage
+
+@macro rglos{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,music-glossary,Glossar}
 @end macro
 
-@macro inputfileref{DIR,NAME}
-@file{\DIR\/@/\NAME\}
+@macro rglosnamed{TEXT,DISPLAY}
+@vindex \TEXT\
+@ref{\TEXT\,,\DISPLAY\,music-glossary,Glossar}
 @end macro
 
-@macro rglos {NAME}
-@vindex \NAME\
-@code{\NAME\}
+@macro rlearning{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-learning,Handbuch zum Lernen}
 @end macro
 
-@macro seeinternals{NAME}
-internals document, @internalsref{\NAME\}
+@macro rlearningnamed{TEXT,DISPLAY}
+@vindex \TEXT\
+@ref{\TEXT\,,\DISPLAY\,lilypond-learning,Handbuch zum Lernen}
 @end macro
 
-@macro usermanref{NAME}
-user manual, @internalsref{\NAME\}
+@macro ruser{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond,Notationsreferenz}
 @end macro
 
-@c they are actually for LaTeX, do they work?
-@c to get decent quotes in `foo'
-@macro q{TEXT}
- \glq\TEXT\\grq
+@macro rusernamed{TEXT,DISPLAY}
+@vindex \TEXT\
+@ref{\TEXT\,,\DISPLAY\,lilypond,Notationsreferenz}
 @end macro
 
-@c to get decent quotes in ``foo''
-@macro qq{TEXT}
- \glqq\TEXT\\glqq
+@macro rprogram{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-program,Anwendungsbenutzung}
 @end macro
 
-@end iftex
+@macro rprogramnamed{TEXT,DISPLAY}
+@vindex \TEXT\
+@ref{\TEXT\,,\DISPLAY\,lilypond-program,Anwendungsbenutzung}
+@end macro
 
+@macro rlsr{TEXT}
+@ref{\TEXT\,,,lilypond-snippets,Schnipsel}
+@end macro
 
-@ifnottex
-@c **** not TEX ****
+@macro rlsrnamed{TEXT,DISPLAY}
+@ref{\TEXT\,,\DISPLAY\,lilypond-snippets,Schnipsel}
+@end macro
 
-@macro seeinternals{NAME}
-@internalsref{\NAME\}
+@macro rinternals{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-internals,Referenz der Interna}
 @end macro
 
-@ifnotinfo
-@macro usermanref{NAME}
-@ref{\NAME\}
+@macro rinternalsnamed{TEXT,DISPLAY}
+@vindex \TEXT\
+@ref{\TEXT\,,\DISPLAY\,lilypond-internals,Referenz der Interna}
 @end macro
-@end ifnotinfo
+
+@end ifclear
 
 @end ifnottex
 
 
-@c **** ALL ****
+@c *** TeX ***
 
-@macro refbugs
-@noindent
-@subsubheading Bugs
+@iftex
+
+@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).
 
+@tex
+\gdef\lilyvindex#1{\doind{vr}{\code #1}\ignorespaces}
+@end tex
+
+@macro rglos{TEXT}
+@lilyvindex{\TEXT\}
+@ref{\TEXT\,,,music-glossary,Glossar}
 @end macro
 
-@macro moreinfo
-@subheading More information
+@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 seealso
-@noindent
-@subsubheading See also
+@macro rlearningnamed{TEXT,DISPLAY}
+@lilyvindex{\TEXT\}
+@ref{\TEXT\,,\DISPLAY\,lilypond-learning.de,Handbuch zum Lernen}
+@end macro
 
+@macro ruser{TEXT}
+@lilyvindex{\TEXT\}
+@ref{\TEXT\,,,lilypond.de,Notationsreferenz}
 @end macro
 
-@macro refcommands
-@noindent
-@subsubheading Predefined commands
+@macro rusernamed{TEXT,DISPLAY}
+@lilyvindex{\TEXT\}
+@ref{\TEXT\,,\DISPLAY\,lilypond.de,Notationsreferenz}
+@end macro
 
+@macro rprogram{TEXT}
+@lilyvindex{\TEXT\}
+@ref{\TEXT\,,,lilypond-program.de,Anwendungsbenutzung}
 @end macro
 
-@macro context{NAME}
-@vindex \NAME\
-@code{\NAME\}@c should use internalsref
+@macro rprogramnamed{TEXT,DISPLAY}
+@lilyvindex{\TEXT\}
+@ref{\TEXT\,,\DISPLAY\,lilypond-program.de,Anwendungsbenutzung}
 @end macro
 
-@macro refcommand{WHAT}
-@vindex \WHAT\
-@code{\WHAT\}
+@macro rlsr{TEXT}
+@lilyvindex{\TEXT\}
+@ref{\TEXT\,,,lilypond-snippets,Schnipsel}
 @end macro
 
-@macro commonprop
-@noindent
-@subsubheading Commonly tweaked properties
+@macro rlsrnamed{TEXT,DISPLAY}
+@lilyvindex{\TEXT\}
+@ref{\TEXT\,,\DISPLAY\,lilypond-snippets,Schnipsel}
+@end macro
+
+@macro rinternals{TEXT}
+@lilyvindex{\TEXT\}
+@ref{\TEXT\,,,lilypond-internals,Referenz der Interna}
+@end macro
 
+@macro rinternalsnamed{TEXT,DISPLAY}
+@lilyvindex{\TEXT\}
+@ref{\TEXT\,,\DISPLAY\,lilypond-internals,Referenz der Interna}
 @end macro
 
-@macro funindex {WORD}
-@findex \WORD\
-@kindex \WORD\
+@end iftex
+
+
+
+@c   ***** Macros specific to translated docs *****
+
+
+@macro englishref
+Dieser Abschnitt wurde noch nicht übersetzt.  Bitte lesen Sie den
+Abschnitt im englischen Benutzerhandbuch.
 @end macro
 
-@c EOF