Documentation/user/macros.itexi

   1 @c -*- coding: us-ascii; mode: texinfo; -*-
   2 @ignore
   3     Translation of GIT committish: FILL-IN-HEAD-COMMITTISH
   4
   5     When revising a translation, copy the HEAD committish of the
   6     version that you are working on.  See TRANSLATION for details.
   7 @end ignore
   8
   9 @c @value{version}
  10 @macro version
  11 2.11.43
  12 @end macro
  13
  14 @c   ***** Displaying text *****
  15
  16 @c we need this since @q{\} doesn't work with makeinfo 4.8 --
  17 @c say @q{@bs{}} instead
  18 @macro bs
  19 \\
  20 @end macro
  21
  22 @c to get decent quotes in `foo' and ``foo''
  23 @macro q{TEXT}
  24 @quoteleft{}\TEXT\@quoteright{}
  25 @end macro
  26
  27 @macro qq{TEXT}
  28 @quotedblleft{}\TEXT\@quotedblright{}
  29 @end macro
  30
  31 @macro warning{TEXT}
  32 @ifhtml
  33 @cartouche
  34 @b{Note:} \TEXT\
  35 @end cartouche
  36 @end ifhtml
  37 @ifnothtml
  38 @quotation
  39 @quotation
  40 @cartouche
  41 @b{Note:} \TEXT\
  42 @end cartouche
  43 @end quotation
  44 @end quotation
  45 @end ifnothtml
  46 @end macro
  47
  48 @ifnotinfo
  49 @macro notation{TEXT}
  50 @var{\TEXT\}
  51 @end macro
  52 @end ifnotinfo
  53
  54 @ifinfo
  55 @macro notation{TEXT}
  56 \TEXT\
  57 @end macro
  58 @end ifinfo
  59
  60 @macro smallspace
  61 @sp 1
  62 @end macro
  63
  64
  65 @c   **** Displaying images not generated by lilypond-book
  66
  67 @c current installation setup of Info docs requires that all images are
  68 @c expected to be found in lilypond/ subdirectory.  lilypond-book already
  69 @c generates proper @image commands for images of music; these macros
  70 @c definitions do the same for other images.
  71
  72 @ifnotinfo
  73 @macro sourceimage{FILENAME,WIDTH,HEIGHT,ALTTEXT}
  74 @image{\FILENAME\,\WIDTH\,\HEIGHT\,\ALTTEXT\}
  75 @end macro
  76 @end ifnotinfo
  77
  78 @ifinfo
  79 @macro sourceimage{FILENAME,WIDTH,HEIGHT,ALTTEXT}
  80 @image{lilypond/\FILENAME\,\WIDTH\,\HEIGHT\,\ALTTEXT\}
  81 @end macro
  82 @end ifinfo
  83
  84
  85 @c   **** Headings in a doc subsection ****
  86
  87 @macro predefined
  88 @noindent
  89 @subsubheading Predefined commands
  90
  91 @end macro
  92
  93 @macro snippets
  94 @noindent
  95 @subsubheading Selected Snippets
  96
  97 @end macro
  98
  99 @macro seealso
 100 @noindent
 101 @subsubheading See also
 102
 103 @indent
 104 @end macro
 105
 106 @macro knownissues
 107 @noindent
 108 @subsubheading Known issues and warnings
 109
 110 @end macro
 111
 112 @macro funindex {TEXT}
 113 @findex \TEXT\
 114 @kindex \TEXT\
 115 @end macro
 116
 117
 118
 119 @c   **** Links and references ****
 120
 121 @c  Possibly deprecated; under discussion.
 122 @c usage: @lsr{ancient,Ancient-notation,custodes.ly}
 123 @macro lsr{SECTION,DIR,TEXT}
 124 @ifhtml
 125 @uref{source/input/lsr/lilypond-snippets/\DIR\.html#\TEXT\,@file{\SECTION\/\TEXT\}}
 126 @end ifhtml
 127 @ifnothtml
 128 @file{\SECTION\/\TEXT\}
 129 @end ifnothtml
 130 @end macro
 131
 132 @c usage: @lsrdir{ancient,Ancient-notation}
 133 @macro lsrdir{SECTION,DIR}
 134 @ifhtml
 135 @uref{source/input/lsr/lilypond-snippets/\DIR\.html,\SECTION\}
 136 @end ifhtml
 137 @ifnothtml
 138 \DIR\
 139 @end ifnothtml
 140 @end macro
 141
 142
 143 @c  Definitions for references:
 144 @c     @internalsref
 145 @c     @rglos
 146 @c     @rprogram
 147 @c     @ruser
 148 @c     @rlearning
 149
 150 @ifhtml
 151 @c ***** HTML *****
 152
 153 @ifset bigpage
 154
 155 @macro internalsref{TEXT}
 156 @vindex \TEXT\
 157 @ref{\TEXT\,,,lilypond-internals-big-page,Internals Reference}
 158 @end macro
 159
 160 @macro rglos{TEXT}
 161 @vindex \TEXT\
 162 @ref{\TEXT\,,,music-glossary-big-page,Music Glossary}
 163 @end macro
 164
 165 @macro rprogram{TEXT}
 166 @vindex \TEXT\
 167 @ref{\TEXT\,,,lilypond-program-big-page,Application Usage}
 168 @end macro
 169
 170 @macro ruser{TEXT}
 171 @vindex \TEXT\
 172 @ref{\TEXT\,,,lilypond-big-page,Notation Reference}
 173 @end macro
 174
 175 @macro rlearning{TEXT}
 176 @vindex \TEXT\
 177 @ref{\TEXT\,,,lilypond-learning-big-page,Learning Manual}
 178 @end macro
 179
 180 @macro rlsr{TEXT}
 181 @ref{\TEXT\,,,lilypond-snippets-big-page,Snippets}
 182 @end macro
 183
 184 @end ifset
 185
 186
 187 @ifclear bigpage
 188
 189 @macro internalsref{TEXT}
 190 @vindex \TEXT\
 191 @ref{\TEXT\,,,lilypond-internals,Internals Reference}
 192 @end macro
 193
 194 @macro rglos{TEXT}
 195 @vindex \TEXT\
 196 @ref{\TEXT\,,,music-glossary,Music Glossary}
 197 @end macro
 198
 199 @macro rprogram{TEXT}
 200 @vindex \TEXT\
 201 @ref{\TEXT\,,,lilypond-program,Application Usage}
 202 @end macro
 203
 204 @macro ruser{TEXT}
 205 @vindex \TEXT\
 206 @ref{\TEXT\,,,lilypond,Notation Reference}
 207 @end macro
 208
 209 @macro rlearning{TEXT}
 210 @vindex \TEXT\
 211 @ref{\TEXT\,,,lilypond-learning,Learning Manual}
 212 @end macro
 213
 214 @macro rlsr{TEXT}
 215 @ref{\TEXT\,,,lilypond-snippets,Snippets}
 216 @end macro
 217
 218 @end ifclear
 219
 220 @end ifhtml
 221
 222
 223 @ifdocbook
 224 @c ***** DOCBOOK-XML *****
 225
 226 @macro internalsref{TEXT}
 227 @vindex \TEXT\
 228 @ref{\TEXT\,,,lilypond-internals,Internals Reference}
 229 @end macro
 230
 231 @macro rglos{TEXT}
 232 @vindex \TEXT\
 233 @ref{\TEXT\,,,music-glossary,Music Glossary}
 234 @end macro
 235
 236 @macro rprogram{TEXT}
 237 @vindex \TEXT\
 238 @ref{\TEXT\,,,lilypond-program,Application Usage}
 239 @end macro
 240
 241 @macro ruser{TEXT}
 242 @vindex \TEXT\
 243 @ref{\TEXT\,,,lilypond,Notation Reference}
 244 @end macro
 245
 246 @macro rlearning{TEXT}
 247 @vindex \TEXT\
 248 @ref{\TEXT\,,,lilypond-learning,Learning Manual}
 249 @end macro
 250
 251 @macro rlsr{TEXT}
 252 @ref{\TEXT\,,,lilypond-snippets,Snippets}
 253 @end macro
 254
 255 @end ifdocbook
 256
 257
 258 @ifinfo
 259 @c **** INFO ****
 260
 261 @macro internalsref{TEXT}
 262 @vindex \TEXT\
 263 @inforef{\TEXT\,,lilypond-internals,Internals Reference}
 264 @end macro
 265
 266 @macro rglos{TEXT}
 267 @vindex \TEXT\
 268 @inforef{\TEXT\,,music-glossary,Music Glossary}
 269 @end macro
 270
 271 @macro rprogram{TEXT}
 272 @vindex \TEXT\
 273 @ref{\TEXT\,,,lilypond-program,Application Usage}
 274 @end macro
 275
 276 @macro ruser{TEXT}
 277 @vindex \TEXT\
 278 @ref{\TEXT\,,,lilypond,Notation Reference}
 279 @end macro
 280
 281 @macro rlearning{TEXT}
 282 @vindex \TEXT\
 283 @ref{\TEXT\,,,lilypond-learning,Learning Manual}
 284 @end macro
 285
 286 @macro rlsr{TEXT}
 287 @ref{\TEXT\,,,lilypond-snippets,Snippets}
 288 @end macro
 289
 290 @end ifinfo
 291
 292
 293 @c **** TEX ****
 294 @iftex
 295
 296 @macro internalsref{TEXT}
 297 @vindex \TEXT\
 298 @code{\TEXT\}
 299 @end macro
 300
 301 @macro rglos {TEXT}
 302 @vindex \TEXT\
 303 @ref{\TEXT\,,,music-glossary,Music Glossary}
 304 @end macro
 305
 306 @macro rprogram{TEXT}
 307 program usage manual, @ref{\TEXT\,,,lilypond-program,Application Usage}
 308 @end macro
 309
 310 @macro ruser{TEXT}
 311 notation reference, @ref{\TEXT\,,,lilypond,Notation Reference}
 312 @end macro
 313
 314 @macro rlearning{TEXT}
 315 learning manual, @ref{\TEXT\,,,lilypond-learning,Learning Manual}
 316 @end macro
 317
 318 @macro rlsr{TEXT}
 319 @ref{\TEXT\,,,lilypond-snippets,Snippets}
 320 @end macro
 321
 322 @end iftex
 323
 324
 325 @c EOF