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