Documentation/fr/user/macros.itexi

   1 @c -*- coding: utf-8; mode: texinfo; -*-
   2
   3 @c FIXME: rearranged this file; macros that don't depend on the output
   4 @c format should go at the beginning.  -gp
   5
   6 @c in retrospect this is _not_ one of the output-insensitive macros.
   7 @c I'll fix it soon.
   8 @c usage: @lsr{ancient,custodes.ly}
   9 @macro lsr{DIR,NAME}
  10 @uref{source/input/lsr/\DIR\/collated-files.html#\NAME\,@file{\DIR\/\NAME\}}
  11 @end macro
  12
  13 @macro lsrdir{DIR}
  14 @uref{source/input/lsr/\DIR\/collated-files.html,@file{\DIR\}}
  15 @end macro
  16
  17 @ifnottex
  18   @macro texisharp {word}
  19   #
  20   @end macro
  21   @macro texiflat {word}
  22   b
  23   @end macro
  24 @end ifnottex
  25
  26 @c FIXME, use \fetaaccidentalsXMC?
  27 @c \\kern0.15em\\fetachar\\fetaflat
  28 @iftex
  29  @macro texiflat {word}
  30  @tex
  31  FIXME: fetaflat
  32  @end tex
  33  @end macro
  34 @c FIXME, use \fetaaccidentalsXC?
  35 @c  \\raise0.5ex\\fetachar\\fetasharp
  36  @macro texisharp {word}
  37   @tex
  38   FIXME: fetasharp
  39   @end tex
  40   @end macro
  41 @end iftex
  42
  43
  44 @macro arrow{}
  45 @iftex
  46 @tex $\\Rightarrow$ @end tex@c
  47 @end iftex
  48 @ifhtml
  49 @html
  50 &rarr;
  51 @end html
  52 @end ifhtml
  53 @ifinfo
  54 -->
  55 @end ifinfo
  56 @end macro
  57
  58
  59 @c we need this since @q{\} doesn't work with makeinfo 4.8 --
  60 @c say @q{@value{backslash}} instead
  61 @set backslash \
  62
  63
  64 @ifhtml
  65 @c ***** HTML *****
  66
  67 @c makeinfo-4.7 encodes html names, which means that nodes that
  68 @c contain nonalphanum characters will be broken links on the website.
  69 @c @uref{../lilypond-internals/\NAME\.html,\NAME\}@c
  70 @c @inforef{} adds ``See'' to the sentence, which is annoying, but
  71 @c better than a broken link.
  72 @c @inforef{\NAME\,,lilypond-internals}@c
  73 @c using @ref without punctuation is OK without for formats other than info
  74
  75 @c annoying parentheses stripped by add-html-footer.py
  76 @macro internalsref{NAME}
  77 @vindex \NAME\
  78 @ref{\NAME\,,,lilypond-internals}
  79 @end macro
  80
  81 @c usage: @inputfileref{input@/regression,FILE@/-NAME.ly}
  82 @macro inputfileref{DIR,NAME}
  83 @uref{source/\DIR\/collated-files.html#\NAME\,@file{\DIR\/\NAME\}}@c
  84 @end macro
  85
  86 @c annoying parentheses stripped by add-html-footer.py
  87 @macro rglos{NAME}
  88 @vindex \NAME\
  89 @ref{\NAME\,,,music-glossary}
  90 @end macro
  91
  92 @c to get decent quotes in `foo'
  93 @macro q{TEXT}
  94 @html
  95 &lsquo;\TEXT\&rsquo;
  96 @end html
  97 @end macro
  98
  99 @c to get decent French quotes in ``foo''
 100 @macro qq{TEXT}
 101 @html
 102 &laquo;&thinsp;\TEXT\&thinsp;&raquo;
 103 @end html
 104 @end macro
 105
 106 @end ifhtml
 107
 108
 109 @ifdocbook
 110 @c ***** DOCBOOK-XML *****
 111
 112 @macro internalsref{NAME}
 113 @vindex \NAME\
 114 @ref{\NAME\,,,lilypond-internals}
 115 @end macro
 116
 117 @macro inputfileref{DIR,NAME}
 118 @uref{source/\DIR\/collated-files.html#\NAME\,@file{\DIR\/\NAME\}}
 119 @end macro
 120
 121 @macro rglos{NAME}
 122 @vindex \NAME\
 123 @ref{\NAME\,,,music-glossary}
 124 @end macro
 125
 126 @c to get decent quotes in `foo'
 127 @macro q{TEXT}
 128 @xml
 129 &lsquo;\TEXT\&rsquo;
 130 @end xml
 131 @end macro
 132
 133 @c to get decent quotes in ``foo''
 134 @macro qq{TEXT}
 135 @xml
 136 &laquo;&thinsp;\TEXT\&thinsp;&raquo;
 137 @end xml
 138 @end macro
 139
 140 @end ifdocbook
 141
 142
 143 @ifinfo
 144 @c **** INFO ****
 145
 146 @macro internalsref{NAME}
 147 @vindex \NAME\
 148 @inforef{\NAME\,,lilypond-internals}
 149 @end macro
 150
 151 @macro inputfileref{DIR,NAME}
 152 @file{\DIR\/\NAME\}
 153 @end macro
 154
 155 @macro rglos{NAME}@c
 156 @vindex \NAME\
 157 @inforef{\NAME\,,,music-glossary}
 158 @end macro
 159
 160 @macro usermanref{NAME}
 161 @inforef{\NAME\}
 162 @end macro
 163
 164 @c to get decent quotes in `foo'
 165 @macro q{TEXT}
 166 `\TEXT\'
 167 @end macro
 168
 169 @c to get decent quotes in ``foo''
 170 @macro qq{TEXT}
 171 « \TEXT\ »
 172 @end macro
 173
 174 @end ifinfo
 175
 176
 177 @c **** TEX ****
 178 @iftex
 179
 180 @macro internalsref{NAME}
 181 @vindex \NAME\
 182 @code{\NAME\}
 183 @end macro
 184
 185 @macro inputfileref{DIR,NAME}
 186 @file{\DIR\/@/\NAME\}
 187 @end macro
 188
 189 @macro rglos {NAME}
 190 @vindex \NAME\
 191 @code{\NAME\}
 192 @end macro
 193
 194 @macro seeinternals{NAME}
 195 internals document, @internalsref{\NAME\}
 196 @end macro
 197
 198 @macro usermanref{NAME}
 199 user manual, @internalsref{\NAME\}
 200 @end macro
 201
 202 @c to get decent quotes in `foo'
 203 @macro q{TEXT}
 204 `\TEXT\'
 205 @end macro
 206
 207 @c to get decent quotes in ``foo''
 208 @macro qq{TEXT}
 209 << \TEXT\ >>
 210 @end macro
 211
 212 @end iftex
 213
 214
 215 @ifnottex
 216 @c **** not TEX ****
 217
 218 @macro seeinternals{NAME}
 219 @internalsref{\NAME\}
 220 @end macro
 221
 222 @ifnotinfo
 223 @macro usermanref{NAME}
 224 @ref{\NAME\}
 225 @end macro
 226 @end ifnotinfo
 227
 228 @end ifnottex
 229
 230
 231 @c **** ALL ****
 232
 233 @macro refbugs
 234 @noindent
 235 @subsubheading Bugs
 236
 237 @end macro
 238
 239 @macro moreinfo
 240 @subheading More information
 241
 242 @end macro
 243
 244 @macro seealso
 245 @noindent
 246 @subsubheading See also
 247
 248 @end macro
 249
 250 @macro refcommands
 251 @noindent
 252 @subsubheading Predefined commands
 253
 254 @end macro
 255
 256 @macro context{NAME}
 257 @vindex \NAME\
 258 @code{\NAME\}@c should use internalsref
 259 @end macro
 260
 261 @macro refcommand{WHAT}
 262 @vindex \WHAT\
 263 @code{\WHAT\}
 264 @end macro
 265
 266 @macro commonprop
 267 @noindent
 268 @subsubheading Commonly tweaked properties
 269
 270 @end macro
 271
 272 @macro funindex {WORD}
 273 @findex \WORD\
 274 @kindex \WORD\
 275 @end macro
 276
 277 @c EOF