]> git.donarmstrong.com Git - lilypond.git/blobdiff - Documentation/fr/user/macros.itexi
Merge master into nested-bookparts
[lilypond.git] / Documentation / fr / user / macros.itexi
index 3ba23dd91435877992fd5547356d3582c0b0ea1f..6b86871839a63de798f5bcebafb4a93df229308a 100644 (file)
 @c -*- coding: utf-8; mode: texinfo; -*-
 @ignore
-    Translation of GIT committish: 6ffead15d2e3dffd294c8e030938facef896d861
+    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
 
-@c **** all formats ****
+@include version.itexi
 
-@macro refbugs
-@noindent
-@subsubheading Bugs
+@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
 
-@macro moreinfo
-@subheading More information
+@c to get decent quotes in `foo' and ``foo''
+@c FIXME: use thin spaces for @qq
+@ifnotinfo
+@macro q{TEXT}
+@quoteleft{}\TEXT\@quoteright{}
+@end macro
 
+@macro qq{TEXT}
+@guillemetleft{}@tie{}\TEXT\@tie{}@guillemetright{}
 @end macro
+@end ifnotinfo
 
-@macro seealso
-@noindent
-@subsubheading See also
+@ifinfo
+@macro q{TEXT}
+`\TEXT\'
+@end macro
 
+@macro qq{TEXT}
+« \TEXT\ »
 @end macro
+@end ifinfo
 
-@macro refcommands
-@noindent
-@subsubheading Predefined commands
 
+@ifhtml
+@macro warning{TEXT}
+@cartouche
+@b{Note :} \TEXT\
+@end cartouche
 @end macro
+@end ifhtml
 
-@macro context{NAME}
-@vindex \NAME\
-@code{\NAME\}@c should use internalsref
+@ifnothtml
+@macro warning{TEXT}
+@quotation
+@quotation
+@cartouche
+@b{Note :} \TEXT\
+@end cartouche
+@end quotation
+@end quotation
 @end macro
+@end ifnothtml
 
-@macro refcommand{WHAT}
-@vindex \WHAT\
-@code{\WHAT\}
+@ifnotinfo
+@macro notation{TEXT}
+@var{\TEXT\}
 @end macro
+@end ifnotinfo
 
-@macro commonprop
-@noindent
-@subsubheading Commonly tweaked properties
-
+@ifinfo
+@macro notation{TEXT}
+\TEXT\
 @end macro
+@end ifinfo
 
-@macro funindex {WORD}
-@findex \WORD\
-@kindex \WORD\
+@macro smallspace
+@sp 1
 @end macro
 
 
+@c   **** Displaying images not generated by lilypond-book
 
-@c  *** Macros with variable output ***
+@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.
 
-@c usage: @lsr{ancient,custodes.ly}
-@macro lsr{DIR,NAME}
-@ifhtml
-  @uref{source/input/lsr/\DIR\/collated-files.html#\NAME\,@file{\DIR\/\NAME\}}
-@end ifhtml
-@ifnothtml
-  @file{\DIR\/\NAME\}
-@end ifnothtml
+@ifnotinfo
+@macro sourceimage{FILENAME,WIDTH,HEIGHT,ALTTEXT}
+@image{\FILENAME\,\WIDTH\,\HEIGHT\,\ALTTEXT\}
 @end macro
+@end ifnotinfo
 
-@macro lsrdir{DIR}
-@ifhtml
-  @uref{source/input/lsr/\DIR\/collated-files.html,@file{\DIR\}/}
-@end ifhtml
-@ifnothtml
-  @file{\DIR\}
-@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 ****
 
-@macro arrow{}
-@iftex
-@tex $\\Rightarrow$ @end tex@c
-@end iftex
-@ifhtml
-@html
-→
-@end html
-@end ifhtml
-@ifinfo
--->
-@end ifinfo
-@end macro
+@macro predefined
+@noindent
+@subsubheading Predefined commands
 
+@end macro
 
-@c we need this since @q{\} doesn't work with makeinfo 4.8 --
-@c say @q{@value{backslash}} instead
-@set backslash \
+@macro snippets
+@noindent
+@subsubheading Selected Snippets
 
+@end macro
 
-@ifhtml
-@c ***** HTML *****
+@c obsolete, remove when translation is fully updated
+@macro commonprop
+@noindent
+@subsubheading Commonly tweaked properties
 
-@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
+@end macro
 
-@ifset bigpage
+@macro seealso
+@noindent
+@subsubheading See also
 
-@macro internalsref{NAME}
-@vindex \NAME\
-@ref{\NAME\,,,lilypond-internals-big-page}
 @end macro
 
-@macro rglos{NAME}
-@vindex \NAME\
-@ref{\NAME\,,,music-glossary-big-page}
+@macro knownissues
+@noindent
+@subsubheading Known issues and warnings
+
 @end macro
 
-@macro rprogram{NAME}
-@vindex \NAME\
-@ref{\NAME\,,,lilypond-program-big-page}
+@macro lydoctitle {TEXT}
+@emph{\TEXT\}
+
 @end macro
 
-@macro ruser{NAME}
-@vindex \NAME\
-@ref{\NAME\,,,lilypond-big-page}
+@macro funindex {TEXT}
+@findex \TEXT\
+@kindex \TEXT\
 @end macro
 
-@end ifset
 
 
-@ifclear bigpage
+@c   **** Links and references ****
 
-@macro internalsref{NAME}
-@vindex \NAME\
-@ref{\NAME\,,,lilypond-internals}
-@end macro
+@c  Definitions for references:
+@c     @rglos
+@c     @rlearning
+@c     @ruser
+@c     @rprogram
+@c     @rlsr
+@c     @rinternals
+@c  all these also have a @...named version, which allows to specify the
+@c  displayed text for the reference as second argument
 
-@macro rglos{NAME}
-@vindex \NAME\
-@ref{\NAME\,,,music-glossary}
-@end macro
 
-@macro rprogram{NAME}
-@vindex \NAME\
-@ref{\NAME\,,,lilypond-program}
-@end macro
+@c ***** HTML + bigpage is a special case (other manual names), all other
+@c formats are treated similarly
+
+@ifnottex
 
-@macro ruser{NAME}
-@vindex \NAME\
-@ref{\NAME\,,,lilypond}
+@ifset bigpage
+
+@macro rglos{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,music-glossary-big-page,Glossaire}
 @end macro
 
-@end ifclear
+@macro rglosnamed{TEXT,DISPLAY}
+@vindex \TEXT\
+@ref{\TEXT\,,\DISPLAY\,music-glossary-big-page,Glossaire}
+@end macro
 
+@macro rlearning{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-learning-big-page,Manuel d'initiation}
+@end macro
 
-@c to get decent quotes in `foo'
-@macro q{TEXT}
-@html
-‘\TEXT\’
-@end html
+@macro rlearningnamed{TEXT,DISPLAY}
+@vindex \TEXT\
+@ref{\TEXT\,,\DISPLAY\,lilypond-learning-big-page,Manuel d'initiation}
 @end macro
 
-@c to get decent French quotes in ``foo''
-@macro qq{TEXT}
-@html
-« \TEXT\ »
-@end html
+@macro ruser{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-big-page,Manuel de notation}
 @end macro
 
-@end ifhtml
+@macro rusernamed{TEXT,DISPLAY}
+@vindex \TEXT\
+@ref{\TEXT\,,\DISPLAY\,lilypond-big-page,Manuel de notation}
+@end macro
 
+@macro rprogram{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-program-big-page,Manuel d'utilisation du programme}
+@end macro
 
-@ifdocbook
-@c ***** DOCBOOK-XML *****
+@macro rprogramnamed{TEXT,DISPLAY}
+@vindex \TEXT\
+@ref{\TEXT\,,\DISPLAY\,lilypond-program-big-page,Manuel d'utilisation du programme}
+@end macro
 
-@macro internalsref{NAME}
-@vindex \NAME\
-@ref{\NAME\,,,lilypond-internals}
+@macro rlsr{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-snippets-big-page,Exemples de code}
 @end macro
 
-@macro rglos{NAME}
-@vindex \NAME\
-@ref{\NAME\,,,music-glossary}
+@macro rlsrnamed{TEXT,DISPLAY}
+@ref{\TEXT\,,\DISPLAY\,lilypond-snippets-big-page,Exemples de code}
 @end macro
 
-@macro rprogram{NAME}
-@vindex \NAME\
-@ref{\NAME\,,,lilypond-program}
+@macro rinternals{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-internals-big-page,Référence des propriétés internes}
 @end macro
 
-@macro ruser{NAME}
-@vindex \NAME\
-@ref{\NAME\,,,lilypond}
+@macro rinternalsnamed{TEXT,DISPLAY}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-internals-big-page,Référence des propriétés internes}
 @end macro
 
-@c to get decent quotes in `foo'
-@macro q{TEXT}
-@html
-‘\TEXT\’
-@end html
+@end ifset
+
+
+@ifclear bigpage
+
+@macro rglos{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,music-glossary,Glossaire}
 @end macro
 
-@c to get decent French quotes in ``foo''
-@macro qq{TEXT}
-@html
-« \TEXT\ »
-@end html
+@macro rglosnamed{TEXT,DISPLAY}
+@vindex \TEXT\
+@ref{\TEXT\,,\DISPLAY\,music-glossary,Glossaire}
 @end macro
 
-@end ifdocbook
+@macro rlearning{TEXT}
+@vindex \TEXT\
+@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
 
-@ifinfo
-@c **** INFO ****
+@macro ruser{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond,Manuel de notation}
+@end macro
 
-@macro internalsref{NAME}
-@vindex \NAME\
-@inforef{\NAME\,,lilypond-internals}
+@macro rusernamed{TEXT,DISPLAY}
+@vindex \TEXT\
+@ref{\TEXT\,,\DISPLAY\,lilypond,Manuel de notation}
 @end macro
 
-@macro rglos{NAME}
-@vindex \NAME\
-@inforef{\NAME\,,,music-glossary}
+@macro rprogram{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-program,Manuel d'utilisation du programme}
 @end macro
 
-@macro usermanref{NAME}
-@inforef{\NAME\}
+@macro rprogramnamed{TEXT,DISPLAY}
+@vindex \TEXT\
+@ref{\TEXT\,,\DISPLAY\,lilypond-program,Manuel d'utilisation du programme}
 @end macro
 
-@macro rprogram{NAME}
-@vindex \NAME\
-@ref{\NAME\,,,lilypond-program}
+@macro rlsr{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-snippets,Exemples de code}
 @end macro
 
-@macro ruser{NAME}
-@vindex \NAME\
-@ref{\NAME\,,,lilypond}
+@macro rlsrnamed{TEXT,DISPLAY}
+@ref{\TEXT\,,\DISPLAY\,lilypond-snippets,Exemples de code}
 @end macro
 
-@c to get decent quotes in `foo'
-@macro q{TEXT}
-`\TEXT\'
+@macro rinternals{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-internals,Référence des propriétés internes}
 @end macro
 
-@c to get decent French quotes in ``foo''
-@macro qq{TEXT}
-« \TEXT\ »
+@macro rinternalsnamed{TEXT,DISPLAY}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-internals,Référence des propriétés internes}
 @end macro
 
-@end ifinfo
+@end ifclear
+
+@end ifnottex
 
 
 @c **** TEX ****
 @iftex
 
-@macro internalsref{NAME}
-@vindex \NAME\
-@code{\NAME\}
+@macro rglos{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,music-glossary,Glossaire}
 @end macro
 
-@macro rglos {NAME}
-@vindex \NAME\
-@code{\NAME\}
+@macro rglosnamed{TEXT,DISPLAY}
+@vindex \TEXT\
+@ref{\TEXT\,,\DISPLAY\,music-glossary,Glossaire}
 @end macro
 
-@macro seeinternals{NAME}
-@emph{Référence du programme}, @internalsref{\NAME\}
+@macro rlearning{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-learning.fr,Manuel d'initiation}
 @end macro
 
-@macro usermanref{NAME}
-@emph{Manuel de l'utilisateur, \NAME\}
+@macro rlearningnamed{TEXT,DISPLAY}
+@vindex \TEXT\
+@ref{\TEXT\,,\DISPLAY\,lilypond-learning.fr,Manuel d'initiation}
 @end macro
 
-@macro rprogram{NAME}
-@emph{Manuel d'utilisation du programme, \NAME\}
+@macro ruser{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond.fr,Manuel de notation}
 @end macro
 
-@alias ruser=usermanref
+@macro rusernamed{TEXT,DISPLAY}
+@vindex \TEXT\
+@ref{\TEXT\,,\DISPLAY\,lilypond.fr,Manuel de notation}
+@end macro
 
-@c to get decent French quotes in `foo'
-@macro q{TEXT}
-`\TEXT\'
+@macro rprogram{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-program.fr,Manuel d'utilisation du programme}
 @end macro
 
-@c to get decent French quotes in ``foo''
-@macro qq{TEXT}
-@guillemetleft{}@tie{}\TEXT\@tie{}@guillemetright{}
+@macro rprogramnamed{TEXT,DISPLAY}
+@vindex \TEXT\
+@ref{\TEXT\,,\DISPLAY\,lilypond-program.fr,Manuel d'utilisation du programme}
+@end macro
+
+@macro rlsr{TEXT}
+@ref{\TEXT\,,,lilypond-snippets,Exemples de code}
+@end macro
+
+@macro rlsrnamed{TEXT,DISPLAY}
+@ref{\TEXT\,,\DISPLAY\,lilypond-snippets,Exemples de code}
+@end macro
+
+@macro rinternals{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-internals,Référence des propriétés internes}
+@end macro
+
+@macro rinternalsnamed{TEXT,DISPLAY}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-internals,Référence des propriétés internes}
 @end macro
 
 @end iftex
 
 
-@ifnottex
-@c **** not TEX ****
+@c **** Macros specific to translated docs ****
 
-@macro seeinternals{NAME}
-@internalsref{\NAME\}
+@c ugh, cannot set/define global variable 'translationof' in some way?
+@iftex
+@macro translationof{TEXT}
 @end macro
+@end iftex
 
-@ifnotinfo
-@macro usermanref{NAME}
-@ref{\NAME\}
+@ifinfo
+@macro
+@macro translationof{TEXT}
+@set translationof \TEXT\
 @end macro
-@end ifnotinfo
+@end ifinfo
 
-@end ifnottex
+@c TODO when @translationof is used in translated docs
+@c see if it's feasible to say @value{translationof}
+@macro englishref
+Cette section n'est pas encore encore traduite, veuillez
+vous reporter à la documentation correspondante en anglais.
+@end macro
 
+@ifhtml
+@macro untranslated
+UNTRANSLATED NODE: IGNORE ME
+@end macro
+@end ifhtml
 
-@c EOF
+@ifnothtml
+@macro untranslated
+@end macro
+@end ifnothtml