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   ***** Displaying text *****
  12
  13 @c we need this since @q{\} doesn't work with makeinfo 4.11 --
  14 @c say @q{@bs{}} instead
  15 @macro bs
  16 \\
  17 @end macro
  18
  19 @c to get decent quotes in `foo' and ``foo''
  20 @macro q{TEXT}
  21 @quoteleft{}\TEXT\@quoteright{}
  22 @end macro
  23
  24 @macro qq{TEXT}
  25 @quotedblleft{}\TEXT\@quotedblright{}
  26 @end macro
  27
  28 @ifhtml
  29 @macro warning{TEXT}
  30 @cartouche
  31 @b{Note:} \TEXT\
  32 @end cartouche
  33 @end macro
  34 @end ifhtml
  35
  36 @ifnothtml
  37 @macro warning{TEXT}
  38 @quotation
  39 @quotation
  40 @cartouche
  41 @b{Note:} \TEXT\
  42 @end cartouche
  43 @end quotation
  44 @end quotation
  45 @end macro
  46 @end ifnothtml
  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 lydoctitle {TEXT}
 113 @emph{\TEXT\}
 114
 115 @end macro
 116
 117 @macro funindex {TEXT}
 118 @findex \TEXT\
 119 @kindex \TEXT\
 120 @end macro
 121
 122
 123
 124 @c   **** Links and references ****
 125
 126 @c  Definitions for references:
 127 @c     @rglos
 128 @c     @rlearning
 129 @c     @ruser
 130 @c     @rprogram
 131 @c     @rlsr
 132 @c     @rinternals
 133 @c  all these also have a @...named version, which allows to specify the
 134 @c  displayed text for the reference as second argument
 135
 136 @c ***** HTML + bigpage is a special case (other manual names), all other
 137 @c formats are treated similarly
 138
 139 @ifnottex
 140
 141 @ifset bigpage
 142
 143 @macro rglos{TEXT}
 144 @vindex \TEXT\
 145 @ref{\TEXT\,,,music-glossary-big-page,Music Glossary}
 146 @end macro
 147
 148 @macro rglosnamed{TEXT,DISPLAY}
 149 @vindex \TEXT\
 150 @ref{\TEXT\,,\DISPLAY\,music-glossary-big-page,Music Glossary}
 151 @end macro
 152
 153 @macro rlearning{TEXT}
 154 @vindex \TEXT\
 155 @ref{\TEXT\,,,lilypond-learning-big-page,Learning Manual}
 156 @end macro
 157
 158 @macro rlearningnamed{TEXT,DISPLAY}
 159 @vindex \TEXT\
 160 @ref{\TEXT\,,\DISPLAY\,lilypond-learning-big-page,Learning Manual}
 161 @end macro
 162
 163 @macro ruser{TEXT}
 164 @vindex \TEXT\
 165 @ref{\TEXT\,,,lilypond-big-page,Notation Reference}
 166 @end macro
 167
 168 @macro rusernamed{TEXT,DISPLAY}
 169 @vindex \TEXT\
 170 @ref{\TEXT\,,\DISPLAY\,lilypond-big-page,Notation Reference}
 171 @end macro
 172
 173 @macro rprogram{TEXT}
 174 @vindex \TEXT\
 175 @ref{\TEXT\,,,lilypond-program-big-page,Application Usage}
 176 @end macro
 177
 178 @macro rprogramnamed{TEXT,DISPLAY}
 179 @vindex \TEXT\
 180 @ref{\TEXT\,,\DISPLAY\,lilypond-program-big-page,Application Usage}
 181 @end macro
 182
 183 @macro rlsr{TEXT}
 184 @ref{\TEXT\,,,lilypond-snippets-big-page,Snippets}
 185 @end macro
 186
 187 @macro rlsrnamed{TEXT,DISPLAY}
 188 @ref{\TEXT\,,\DISPLAY\,lilypond-snippets-big-page,Snippets}
 189 @end macro
 190
 191 @macro rinternals{TEXT}
 192 @vindex \TEXT\
 193 @ref{\TEXT\,,,lilypond-internals-big-page,Internals Reference}
 194 @end macro
 195
 196 @macro rinternalsnamed{TEXT,DISPLAY}
 197 @vindex \TEXT\
 198 @ref{\TEXT\,,\DISPLAY\,lilypond-internals-big-page,Internals Reference}
 199 @end macro
 200
 201 @end ifset
 202
 203
 204 @ifclear bigpage
 205
 206 @macro rglos{TEXT}
 207 @vindex \TEXT\
 208 @ref{\TEXT\,,,music-glossary,Music Glossary}
 209 @end macro
 210
 211 @macro rglosnamed{TEXT,DISPLAY}
 212 @vindex \TEXT\
 213 @ref{\TEXT\,,\DISPLAY\,music-glossary,Music Glossary}
 214 @end macro
 215
 216 @macro rlearning{TEXT}
 217 @vindex \TEXT\
 218 @ref{\TEXT\,,,lilypond-learning,Learning Manual}
 219 @end macro
 220
 221 @macro rlearningnamed{TEXT,DISPLAY}
 222 @vindex \TEXT\
 223 @ref{\TEXT\,,,lilypond-learning,Learning Manual}
 224 @end macro
 225
 226 @macro ruser{TEXT}
 227 @vindex \TEXT\
 228 @ref{\TEXT\,,,lilypond,Notation Reference}
 229 @end macro
 230
 231 @macro rusernamed{TEXT,DISPLAY}
 232 @vindex \TEXT\
 233 @ref{\TEXT\,,\DISPLAY\,lilypond,Notation Reference}
 234 @end macro
 235
 236 @macro rprogram{TEXT}
 237 @vindex \TEXT\
 238 @ref{\TEXT\,,,lilypond-program,Application Usage}
 239 @end macro
 240
 241 @macro rprogramnamed{TEXT,DISPLAY}
 242 @vindex \TEXT\
 243 @ref{\TEXT\,,\DISPLAY\,lilypond-program,Application Usage}
 244 @end macro
 245
 246 @macro rlsr{TEXT}
 247 @ref{\TEXT\,,,lilypond-snippets,Snippets}
 248 @end macro
 249
 250 @macro rlsrnamed{TEXT,DISPLAY}
 251 @ref{\TEXT\,,\DISPLAY\,lilypond-snippets,Snippets}
 252 @end macro
 253
 254 @macro rinternals{TEXT}
 255 @vindex \TEXT\
 256 @ref{\TEXT\,,,lilypond-internals,Internals Reference}
 257 @end macro
 258
 259 @macro rinternalsnamed{TEXT,DISPLAY}
 260 @vindex \TEXT\
 261 @ref{\TEXT\,,\DISPLAY\,lilypond-internals,Internals Reference}
 262 @end macro
 263
 264 @end ifclear
 265
 266 @end ifnottex
 267
 268
 269
 270 @c **** TEX ****
 271 @iftex
 272
 273 @macro rglos{TEXT}
 274 @vindex \TEXT\
 275 @ref{\TEXT\,,,music-glossary,Music Glossary}
 276 @end macro
 277
 278 @macro rglosnamed{TEXT,DISPLAY}
 279 @vindex \TEXT\
 280 @ref{\TEXT\,,\DISPLAY\,music-glossary,Music Glossary}
 281 @end macro
 282
 283 @macro rlearning{TEXT}
 284 @ref{\TEXT\,,,lilypond-learning,Learning Manual}
 285 @end macro
 286
 287 @macro rlearningnamed{TEXT,DISPLAY}
 288 @ref{\TEXT\,,\DISPLAY\,lilypond-learning,Learning Manual}
 289 @end macro
 290
 291 @macro ruser{TEXT}
 292 @ref{\TEXT\,,,lilypond,Notation Reference}
 293 @end macro
 294
 295 @macro rusernamed{TEXT,DISPLAY}
 296 @ref{\TEXT\,,\DISPLAY\,lilypond,Notation Reference}
 297 @end macro
 298
 299 @macro rprogram{TEXT}
 300 @ref{\TEXT\,,,lilypond-program,Application Usage}
 301 @end macro
 302
 303 @macro rprogramnamed{TEXT,DISPLAY}
 304 @ref{\TEXT\,,\DISPLAY\,lilypond-program,Application Usage}
 305 @end macro
 306
 307 @macro rlsr{TEXT}
 308 @ref{\TEXT\,,,lilypond-snippets,Snippets}
 309 @end macro
 310
 311 @macro rlsrnamed{TEXT,DISPLAY}
 312 @ref{\TEXT\,,\DISPLAY\,lilypond-snippets,Snippets}
 313 @end macro
 314
 315 @macro rinternals{TEXT}
 316 @vindex \TEXT\
 317 @ref{\TEXT\,,,lilypond-internals,Internals Reference}
 318 @end macro
 319
 320 @macro rinternalsnamed{TEXT,DISPLAY}
 321 @vindex \TEXT\
 322 @ref{\TEXT\,,\DISPLAY\,lilypond-internals,Internals Reference}
 323 @end macro
 324
 325 @end iftex