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