]> git.donarmstrong.com Git - lilypond.git/blobdiff - Documentation/fr/user/macros.itexi
lilypond-book robustness: ensure EOL at the end of @verbatim
[lilypond.git] / Documentation / fr / user / macros.itexi
index 06f0974a96ef86829203c08a439e4084a6827ae6..1e4e7c74083716c7703cf2b1cc538be06e499467 100644 (file)
@@ -1,22 +1,23 @@
 @c -*- coding: utf-8; mode: texinfo; -*-
 @ignore
-    Translation of GIT committish: d30aabb4adc9e13c7a5a99a22230e97a0f164255
+    Translation of GIT committish: 8135382760aa0adfac5aed987a272c394e59dbdb
 
     When revising a translation, copy the HEAD committish of the
     version that you are working on.  See TRANSLATION for details.
 @end ignore
 
+
 @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 FIXME: Use thin spaces for @qq.
+
+@ifnotinfo
 
-@c to get decent quotes in `foo' and ``foo''
-@c  these need to be split up so that "@qq{foo}." looks nice.  :(
-@iftex
 @macro q{TEXT}
 @quoteleft{}\TEXT\@quoteright{}
 @end macro
 @macro qq{TEXT}
 @guillemetleft{}@tie{}\TEXT\@tie{}@guillemetright{}
 @end macro
-@end iftex
 
+@end ifnotinfo
 
 @ifinfo
+
 @macro q{TEXT}
 `\TEXT\'
 @end macro
 @macro qq{TEXT}
 « \TEXT\ »
 @end macro
+
 @end ifinfo
 
 
 @ifhtml
-@macro q{TEXT}
-@html
-‘\TEXT\’
-@end html
-@end macro
 
-@macro qq{TEXT}
-@html
-&laquo;<font size="-4">&nbsp;</font>\TEXT\<font size="-4">&nbsp;</font>&raquo;
-@end html
+@macro warning{TEXT}
+@cartouche
+@b{Note :} \TEXT\
+@end cartouche
 @end macro
-@end ifhtml
-
 
-@ifdocbook
-@macro q{TEXT}
-@xml
-&lsquo;\TEXT\&rsquo;
-@end xml
-@end macro
+@end ifhtml
 
-@macro qq{TEXT}
-@xml
-&laquo;<font size="-4">&nbsp;</font>\TEXT\<font size="-4">&nbsp;</font>&raquo;
-@end xml
-@end macro
-@end ifdocbook
+@ifnothtml
 
 @macro warning{TEXT}
 @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
-
-@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.
-
-@ifnotinfo
-@macro sourceimage{FILENAME,WIDTH,HEIGHT,ALTTEXT}
-@image{\FILENAME\,\WIDTH\,\HEIGHT\,\ALTTEXT\}
-@end macro
-@end ifnotinfo
+@end ifnothtml
 
-@ifinfo
-@macro sourceimage{FILENAME,WIDTH,HEIGHT,ALTTEXT}
-@image{lilypond/\FILENAME\,\WIDTH\,\HEIGHT\,\ALTTEXT\}
-@end macro
-@end ifinfo
 
 
+@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
-
-@c obsolete, remove when translation is fully updated
-@macro refcommand{TEXT}
-@vindex \TEXT\
-@code{\TEXT\}
-@end macro
-
-@macro funindex {TEXT}
-@findex \TEXT\
-@kindex \TEXT\
-@end macro
-
-
-
-@c   **** Links and references ****
-
-@c WARNING: new @lsr macro in English docs takes 3 arguments
-@c and new @lsrdir takes two arguments
-
-@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
-
-@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
 
 
 
+@c   ***** Links and references *****
 
 @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 *****
+
+@c *** not TeX ***
+
+@ifnottex
+
+@c ** bigpage **
 
 @ifset bigpage
 
-@macro internalsref{TEXT}
+@macro rglos{TEXT}
 @vindex \TEXT\
-@ref{\TEXT\,,,lilypond-internals-big-page,Référence des propriétés internes}
+@ref{\TEXT\,,,music-glossary-big-page,Glossaire}
 @end macro
 
-@macro rglos{TEXT}
+@macro rglosnamed{TEXT,DISPLAY}
 @vindex \TEXT\
-@ref{\TEXT\,,,music-glossary-big-page,Glossaire}
+@ref{\TEXT\,,\DISPLAY\,music-glossary-big-page,Glossaire}
 @end macro
 
-@macro rprogram{TEXT}
+@macro rlearning{TEXT}
 @vindex \TEXT\
-@ref{\TEXT\,,,lilypond-program-big-page,Manuel d'utilisation du programme}
+@ref{\TEXT\,,,lilypond-learning-big-page,Manuel d'initiation}
+@end macro
+
+@macro rlearningnamed{TEXT,DISPLAY}
+@vindex \TEXT\
+@ref{\TEXT\,,\DISPLAY\,lilypond-learning-big-page,Manuel d'initiation}
 @end macro
 
 @macro ruser{TEXT}
 @ref{\TEXT\,,,lilypond-big-page,Manuel de notation}
 @end macro
 
-@macro rlearning{TEXT}
+@macro rusernamed{TEXT,DISPLAY}
 @vindex \TEXT\
-@ref{\TEXT\,,,lilypond-learning-big-page,Manuel d'initiation}
+@ref{\TEXT\,,\DISPLAY\,lilypond-big-page,Manuel de notation}
 @end macro
 
-@end ifset
-
-
-@ifclear bigpage
-
-@macro internalsref{TEXT}
+@macro rprogram{TEXT}
 @vindex \TEXT\
-@ref{\TEXT\,,,lilypond-internals,Référence des propriétés internes}
+@ref{\TEXT\,,,lilypond-program-big-page,Manuel d'utilisation du programme}
 @end macro
 
-@macro rglos{TEXT}
+@macro rprogramnamed{TEXT,DISPLAY}
 @vindex \TEXT\
-@ref{\TEXT\,,,music-glossary,Glossaire}
+@ref{\TEXT\,,\DISPLAY\,lilypond-program-big-page,Manuel d'utilisation du programme}
 @end macro
 
-@macro rprogram{TEXT}
+@macro rlsr{TEXT}
 @vindex \TEXT\
-@ref{\TEXT\,,,lilypond-program,Manuel d'utilisation du programme}
+@ref{\TEXT\,,,lilypond-snippets-big-page,Exemples de code}
 @end macro
 
-@macro ruser{TEXT}
+@macro rlsrnamed{TEXT,DISPLAY}
+@ref{\TEXT\,,\DISPLAY\,lilypond-snippets-big-page,Exemples de code}
+@end macro
+
+@macro rinternals{TEXT}
 @vindex \TEXT\
-@ref{\TEXT\,,,lilypond,Manuel de notation}
+@ref{\TEXT\,,,lilypond-internals-big-page,Référence des propriétés internes}
 @end macro
 
-@macro rlearning{TEXT}
+@macro rinternalsnamed{TEXT,DISPLAY}
 @vindex \TEXT\
-@ref{\TEXT\,,,lilypond-learning,Manuel d'initiation}
+@ref{\TEXT\,,,lilypond-internals-big-page,Référence des propriétés internes}
 @end macro
 
-@end ifclear
+@end ifset
 
-@end ifhtml
 
+@c ** not bigpage **
 
-@ifdocbook
-@c ***** DOCBOOK-XML *****
+@ifclear bigpage
 
-@macro internalsref{TEXT}
+@macro rglos{TEXT}
 @vindex \TEXT\
-@ref{\TEXT\,,,lilypond-internals,Référence des propriétés internes}
+@ref{\TEXT\,,,music-glossary,Glossaire}
 @end macro
 
-@macro rglos{TEXT}
+@macro rglosnamed{TEXT,DISPLAY}
 @vindex \TEXT\
-@ref{\TEXT\,,,music-glossary,Glossaire}
+@ref{\TEXT\,,\DISPLAY\,music-glossary,Glossaire}
 @end macro
 
-@macro rprogram{TEXT}
+@macro rlearning{TEXT}
 @vindex \TEXT\
-@ref{\TEXT\,,,lilypond-program,Manuel d'utilisation du programme}
+@ref{\TEXT\,,,lilypond-learning,Manuel d'initiation}
+@end macro
+
+@macro rlearningnamed{TEXT,DISPLAY}
+@vindex \TEXT\
+@ref{\TEXT\,,\DISPLAY\,lilypond-learning,Manuel d'initiation}
 @end macro
 
 @macro ruser{TEXT}
 @ref{\TEXT\,,,lilypond,Manuel de notation}
 @end macro
 
-@macro rlearning{TEXT}
+@macro rusernamed{TEXT,DISPLAY}
 @vindex \TEXT\
-@ref{\TEXT\,,,lilypond-learning,Manuel d'initiation}
+@ref{\TEXT\,,\DISPLAY\,lilypond,Manuel de notation}
 @end macro
 
-@end ifdocbook
-
-
-@ifinfo
-@c **** INFO ****
-
-@macro internalsref{NAME}
-@vindex \NAME\
-@inforef{\NAME\,,lilypond-internals,Référence des propriétés internes}
+@macro rprogram{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-program,Manuel d'utilisation du programme}
 @end macro
 
-@macro rglos{NAME}
-@vindex \NAME\
-@inforef{\NAME\,,music-glossary,Glossaire}
+@macro rprogramnamed{TEXT,DISPLAY}
+@vindex \TEXT\
+@ref{\TEXT\,,\DISPLAY\,lilypond-program,Manuel d'utilisation du programme}
 @end macro
 
-@macro rprogram{TEXT}
+@macro rlsr{TEXT}
 @vindex \TEXT\
-@ref{\TEXT\,,,lilypond-program,Manuel d'utilisation du programme}
+@ref{\TEXT\,,,lilypond-snippets,Exemples de code}
 @end macro
 
-@macro ruser{TEXT}
+@macro rlsrnamed{TEXT,DISPLAY}
+@ref{\TEXT\,,\DISPLAY\,lilypond-snippets,Exemples de code}
+@end macro
+
+@macro rinternals{TEXT}
 @vindex \TEXT\
-@ref{\TEXT\,,,lilypond,Manuel de notation}
+@ref{\TEXT\,,,lilypond-internals,Référence des propriétés internes}
 @end macro
 
-@macro rlearning{TEXT}
+@macro rinternalsnamed{TEXT,DISPLAY}
 @vindex \TEXT\
-@ref{\TEXT\,,,lilypond-learning,Manuel d'initiation}
+@ref{\TEXT\,,,lilypond-internals,Référence des propriétés internes}
 @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,Glossaire}
 @end macro
 
-@macro rprogram{TEXT}
-@ref{\TEXT\,,,lilypond-program.fr,Manuel d'utilisation du programme}
+@macro rglosnamed{TEXT,DISPLAY}
+@lilyvindex{\TEXT\}
+@ref{\TEXT\,,\DISPLAY\,music-glossary,Glossaire}
+@end macro
+
+@macro rlearning{TEXT}
+@lilyvindex{\TEXT\}
+@ref{\TEXT\,,,lilypond-learning.fr,Manuel d'initiation}
+@end macro
+
+@macro rlearningnamed{TEXT,DISPLAY}
+@lilyvindex{\TEXT\}
+@ref{\TEXT\,,\DISPLAY\,lilypond-learning.fr,Manuel d'initiation}
 @end macro
 
 @macro ruser{TEXT}
+@lilyvindex{\TEXT\}
 @ref{\TEXT\,,,lilypond.fr,Manuel de notation}
 @end macro
 
-@macro rlearning{TEXT}
-@ref{\TEXT\,,,lilypond-learning.fr,Manuel d'initiation}
+@macro rusernamed{TEXT,DISPLAY}
+@lilyvindex{\TEXT\}
+@ref{\TEXT\,,\DISPLAY\,lilypond.fr,Manuel de notation}
 @end macro
 
-@end iftex
+@macro rprogram{TEXT}
+@lilyvindex{\TEXT\}
+@ref{\TEXT\,,,lilypond-program.fr,Manuel d'utilisation du programme}
+@end macro
+
+@macro rprogramnamed{TEXT,DISPLAY}
+@lilyvindex{\TEXT\}
+@ref{\TEXT\,,\DISPLAY\,lilypond-program.fr,Manuel d'utilisation du programme}
+@end macro
 
+@macro rlsr{TEXT}
+@lilyvindex{\TEXT\}
+@ref{\TEXT\,,,lilypond-snippets,Exemples de code}
+@end macro
 
-@c Commands specific to translated docs
+@macro rlsrnamed{TEXT,DISPLAY}
+@lilyvindex{\TEXT\}
+@ref{\TEXT\,,\DISPLAY\,lilypond-snippets,Exemples de code}
+@end macro
 
-@c ugh, cannot set/define global variable 'translationof' in some way?
-@iftex
-@macro translationof{TEXT}
+@macro rinternals{TEXT}
+@lilyvindex{\TEXT\}
+@ref{\TEXT\,,,lilypond-internals,Référence des propriétés internes}
 @end macro
-@end iftex
 
-@ifinfo
-@macro
-@macro translationof{TEXT}
-@set translationof \TEXT\
+@macro rinternalsnamed{TEXT,DISPLAY}
+@lilyvindex{\TEXT\}
+@ref{\TEXT\,,,lilypond-internals,Référence des propriétés internes}
 @end macro
-@end ifinfo
 
-@c TODO when @translationof is used in translated docs
-@c see if it's feasible to say @value{translationof}
+@end iftex
+
+
+@c   ***** Macros specific to translated docs *****
+
 @macro englishref
 Cette section n'est pas encore encore traduite, veuillez
 vous reporter à la documentation correspondante en anglais.