X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=Documentation%2Fde%2Fuser%2Fmacros.itexi;h=512a1b66d7b74ac7c8854b828cb2b64fffde17f3;hb=b97565a9af1c13369ac7e7e9ea80c2638dbc0e51;hp=2bce6691ae07d1eae1c2301c0bfb5ca54d05416d;hpb=7a0ad7f198d8c99cd2172c1506e78f8f93b82f27;p=lilypond.git diff --git a/Documentation/de/user/macros.itexi b/Documentation/de/user/macros.itexi index 2bce6691ae..fb62b01494 100644 --- a/Documentation/de/user/macros.itexi +++ b/Documentation/de/user/macros.itexi @@ -1,326 +1,455 @@ @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\}} -@end macro -@macro lsrdir{DIR} -@uref{source/input/lsr/\DIR\/collated-files.html,@file{\DIR\}} +@include version.itexi + + +@c Don't replace quotes with directed quotes. + +@set txicodequoteundirected +@set txicodequotebacktick + + + +@c ***** Displaying text ***** + +@c We need this since @q{\} doesn't work with makeinfo 4.11 -- +@c say @q{@bs{}} instead. + +@macro bs +\\ @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 +@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 qq{TEXT} +@quotedblbase{}\TEXT\@quotedblleft{} +@end macro -@macro arrow{} -@iftex -@tex $\\Rightarrow$ @end tex@c -@end iftex @ifhtml -@html -→ -@end html + +@macro warning{TEXT} +@cartouche +@b{Achtung:} \TEXT\ +@end cartouche +@end macro + @end ifhtml + +@ifnothtml + +@macro warning{TEXT} +@quotation +@quotation +@cartouche +@b{Achtung:} \TEXT\ +@end cartouche +@end quotation +@end quotation +@end macro + +@end ifnothtml + + +@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 we need this since @q{\} doesn't work with makeinfo 4.8 -- -@c say @q{@value{backslash}} instead -@set backslash \ +@c ***** Displaying images not generated by lilypond-book ***** -@ifhtml -@c ***** HTML ***** +@c Current installation setup of Info docs requires that all images are +@c expected to be found in the `lilypond/' subdirectory. `lilypond-book' +@c already generates proper @image commands for images of music; these +@c macro definitions do the same for other images. -@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 +@ifnotinfo -@c annoying parentheses stripped by add-html-footer.py -@macro internalsref{NAME} -@vindex \NAME\ -@ref{\NAME\,,,lilypond-internals} +@macro sourceimage{FILENAME,WIDTH,HEIGHT,ALTTEXT} +@image{\FILENAME\,\WIDTH\,\HEIGHT\,\ALTTEXT\} @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 +@end ifnotinfo + +@ifinfo + +@macro sourceimage{FILENAME,WIDTH,HEIGHT,ALTTEXT} +@image{lilypond/\FILENAME\,\WIDTH\,\HEIGHT\,\ALTTEXT\} @end macro -@c annoying parentheses stripped by add-html-footer.py -@macro rglos{NAME} -@vindex \NAME\ -@ref{\NAME\,,,music-glossary} +@end ifinfo + + + +@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 to get decent German quotes in `foo' -@macro q{TEXT} -@html -‚\TEXT\‘ -@end html +@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 to get decent German quotes in ``foo'' -@macro qq{TEXT} -@html -„\TEXT\“ -@end html + +@macro snippets +@noindent +@subsubheading Selected Snippets @end macro -@end ifhtml +@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 -@ifdocbook -@c ***** DOCBOOK-XML ***** -@macro internalsref{NAME} -@vindex \NAME\ -@ref{\NAME\,,,lilypond-internals} +@macro knownissues +@noindent +@subsubheading Known issues and warnings @end macro -@macro inputfileref{DIR,NAME} -@uref{source/\DIR\/collated-files.html#\NAME\,@file{\DIR\/\NAME\}} + +@macro lydoctitle {TEXT} +@emph{\TEXT\} @end macro -@macro rglos{NAME} -@vindex \NAME\ -@ref{\NAME\,,,music-glossary} + +@c Don't remove the `@c' within the macro definition! See section 19.3, +@c `Macro Details and Caveats', in the texinfo info file for explanation. + +@macro funindex {TEXT} +@findex \TEXT\ +@kindex \TEXT\ +@c @end macro -@c to get decent German quotes in `foo' -@macro q{TEXT} -@xml -‚\TEXT\‘ -@end xml + + +@c ***** Links and references ***** + +@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 qq{TEXT} -@xml -„\TEXT\“ -@end xml +@macro rglosnamed{TEXT,DISPLAY} +@vindex \TEXT\ +@ref{\TEXT\,,\DISPLAY\,music-glossary-big-page,Glossar} @end macro -@end ifdocbook +@macro rlearning{TEXT} +@vindex \TEXT\ +@ref{\TEXT\,,,lilypond-learning-big-page,Handbuch zum Lernen} +@end macro +@macro rlearningnamed{TEXT,DISPLAY} +@vindex \TEXT\ +@ref{\TEXT\,,\DISPLAY\,lilypond-learning-big-page,Handbuch zum Lernen} +@end macro -@ifinfo -@c **** INFO **** +@macro ruser{TEXT} +@vindex \TEXT\ +@ref{\TEXT\,,,lilypond-big-page,Notationsreferenz} +@end macro -@macro internalsref{NAME} -@vindex \NAME\ -@inforef{\NAME\,,lilypond-internals} +@macro rusernamed{TEXT,DISPLAY} +@vindex \TEXT\ +@ref{\TEXT\,,\DISPLAY\,lilypond-big-page,Notationsreferenz} @end macro -@macro inputfileref{DIR,NAME} -@file{\DIR\/\NAME\} +@macro rprogram{TEXT} +@vindex \TEXT\ +@ref{\TEXT\,,,lilypond-program-big-page,Anwendungsbenutzung} @end macro -@macro rglos{NAME}@c -@vindex \NAME\ -@inforef{\NAME\,,,music-glossary} +@macro rprogramnamed{TEXT,DISPLAY} +@vindex \TEXT\ +@ref{\TEXT\,,\DISPLAY\,lilypond-program-big-page,Anwendungsbenutzung} @end macro -@macro usermanref{NAME} -@inforef{\NAME\} +@macro rlsr{TEXT} +@ref{\TEXT\,,,lilypond-snippets-big-page,Schnipsel} @end macro -@c to get decent quotes in `foo' -@macro q{TEXT} -‚\TEXT\‘ +@macro rlsrnamed{TEXT,DISPLAY} +@ref{\TEXT\,,\DISPLAY\,lilypond-snippets-big-page,Schnipsel} @end macro -@c to get decent quotes in ``foo'' -@macro qq{TEXT} -„\TEXT\“ +@macro rinternals{TEXT} +@vindex \TEXT\ +@ref{\TEXT\,,,lilypond-internals-big-page,Referenz der Interna} @end macro -@end ifinfo +@macro rinternalsnamed{TEXT,DISPLAY} +@vindex \TEXT\ +@ref{\TEXT\,,\DISPLAY\,lilypond-internals-big-page,Referenz der Interna} +@end macro +@end ifset -@c **** TEX **** -@iftex -@macro internalsref{NAME} -@vindex \NAME\ -@code{\NAME\} -@end macro +@c ** not bigpage ** -@macro inputfileref{DIR,NAME} -@file{\DIR\/@/\NAME\} +@ifclear bigpage + +@macro rglos{TEXT} +@vindex \TEXT\ +@ref{\TEXT\,,,music-glossary,Glossar} @end macro -@macro rglos {NAME} -@vindex \NAME\ -@code{\NAME\} +@macro rglosnamed{TEXT,DISPLAY} +@vindex \TEXT\ +@ref{\TEXT\,,\DISPLAY\,music-glossary,Glossar} @end macro -@macro seeinternals{NAME} -internals document, @internalsref{\NAME\} +@macro rlearning{TEXT} +@vindex \TEXT\ +@ref{\TEXT\,,,lilypond-learning,Handbuch zum Lernen} @end macro -@macro usermanref{NAME} -user manual, @internalsref{\NAME\} +@macro rlearningnamed{TEXT,DISPLAY} +@vindex \TEXT\ +@ref{\TEXT\,,\DISPLAY\,lilypond-learning,Handbuch zum Lernen} @end macro -@tex -% from german.sty -\def\allowhyphens{% - \penalty\@M - \hskip\z@skip} - -\gdef\set@low@box#1{% - \setbox\tw@\hbox{,}% - \setbox\z@\hbox{#1}% - \setbox\z@\hbox{% - \dimen@\ht\z@ - \advance\dimen@ -\ht\tw@ - \lower\dimen@\box\z@}% - \ht\z@\ht\tw@ - \dp\z@\dp\tw@} - -\gdef\save@sf@q#1{% - {\ifhmode - \edef\@SF{\spacefactor\the\spacefactor}% - \else - \let\@SF\empty - \fi - \leavevmode #1 - \@SF}} - -\gdef\glq{% - \save@sf@q{% - \set@low@box{'\/}% - \box\z@ - \kern-.04em - \allowhyphens}} -\gdef\grq{% - \save@sf@q{% - \kern-.0125em - `% - \kern.07em}} -\gdef\glqq{% - \save@sf@q{% - \set@low@box{''\/}% - \box\z@ - \kern-.04em - \allowhyphens}} -\gdef\grqq{% - \save@sf@q{% - \kern-.07em - ``% - \kern.07em}} -@end tex +@macro ruser{TEXT} +@vindex \TEXT\ +@ref{\TEXT\,,,lilypond,Notationsreferenz} +@end macro -@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\@grqq +@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 + +@end iftex + + + +@c ***** Macros specific to translated docs ***** + +@c ugh, cannot set/define global variable 'translationof' in some way? + +@iftex + +@macro translationof{TEXT} +@end macro + +@end iftex + +@ifinfo +@macro +@macro translationof{TEXT} +@set translationof \TEXT\ @end macro -@macro funindex {WORD} -@findex \WORD\ -@kindex \WORD\ +@end ifinfo + + +@c TODO: If @translationof is used in translated docs +@c see whether it is feasible to say @value{translationof}. + +@macro englishref +Dieser Abschnitt wurde noch nicht übersetzt. Bitte lesen Sie den +Abschnitt im englischen Benutzerhandbuch. @end macro -@c EOF + +@ifhtml + +@ifset bigpage +@macro untranslated +@end macro +@end ifset + +@ifclear bigpage +@macro untranslated +UNTRANSLATED NODE: IGNORE ME +@end macro +@end ifclear + +@end ifhtml + +@ifnothtml +@macro untranslated +@end macro +@end ifnothtml