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
 131 @ifhtml
 132 @c ***** HTML *****
 133
 134 @ifset bigpage
 135
 136 @macro rglos{TEXT}
 137 @vindex \TEXT\
 138 @ref{\TEXT\,,,music-glossary-big-page,Music Glossary}
 139 @end macro
 140
 141 @macro rlearning{TEXT}
 142 @vindex \TEXT\
 143 @ref{\TEXT\,,,lilypond-learning-big-page,Learning Manual}
 144 @end macro
 145
 146 @macro ruser{TEXT}
 147 @vindex \TEXT\
 148 @ref{\TEXT\,,,lilypond-big-page,Notation Reference}
 149 @end macro
 150
 151 @macro rprogram{TEXT}
 152 @vindex \TEXT\
 153 @ref{\TEXT\,,,lilypond-program-big-page,Application Usage}
 154 @end macro
 155
 156 @macro rlsr{TEXT}
 157 @ref{\TEXT\,,,lilypond-snippets-big-page,Snippets}
 158 @end macro
 159
 160 @macro rinternals{TEXT}
 161 @vindex \TEXT\
 162 @ref{\TEXT\,,,lilypond-internals-big-page,Internals Reference}
 163 @end macro
 164
 165 @end ifset
 166
 167
 168 @ifclear bigpage
 169
 170 @macro rglos{TEXT}
 171 @vindex \TEXT\
 172 @ref{\TEXT\,,,music-glossary,Music Glossary}
 173 @end macro
 174
 175 @macro rlearning{TEXT}
 176 @vindex \TEXT\
 177 @ref{\TEXT\,,,lilypond-learning,Learning Manual}
 178 @end macro
 179
 180 @macro ruser{TEXT}
 181 @vindex \TEXT\
 182 @ref{\TEXT\,,,lilypond,Notation Reference}
 183 @end macro
 184
 185 @macro rprogram{TEXT}
 186 @vindex \TEXT\
 187 @ref{\TEXT\,,,lilypond-program,Application Usage}
 188 @end macro
 189
 190 @macro rlsr{TEXT}
 191 @ref{\TEXT\,,,lilypond-snippets,Snippets}
 192 @end macro
 193
 194 @macro rinternals{TEXT}
 195 @vindex \TEXT\
 196 @ref{\TEXT\,,,lilypond-internals,Internals Reference}
 197 @end macro
 198
 199 @end ifclear
 200
 201 @end ifhtml
 202
 203
 204 @ifdocbook
 205 @c ***** DOCBOOK-XML *****
 206
 207 @macro rglos{TEXT}
 208 @vindex \TEXT\
 209 @ref{\TEXT\,,,music-glossary,Music Glossary}
 210 @end macro
 211
 212 @macro rlearning{TEXT}
 213 @vindex \TEXT\
 214 @ref{\TEXT\,,,lilypond-learning,Learning Manual}
 215 @end macro
 216
 217 @macro ruser{TEXT}
 218 @vindex \TEXT\
 219 @ref{\TEXT\,,,lilypond,Notation Reference}
 220 @end macro
 221
 222 @macro rprogram{TEXT}
 223 @vindex \TEXT\
 224 @ref{\TEXT\,,,lilypond-program,Application Usage}
 225 @end macro
 226
 227 @macro rlsr{TEXT}
 228 @ref{\TEXT\,,,lilypond-snippets,Snippets}
 229 @end macro
 230
 231 @macro rinternals{TEXT}
 232 @vindex \TEXT\
 233 @ref{\TEXT\,,,lilypond-internals,Internals Reference}
 234 @end macro
 235
 236 @end ifdocbook
 237
 238
 239 @ifinfo
 240 @c **** INFO ****
 241
 242 @macro rglos{TEXT}
 243 @vindex \TEXT\
 244 @ref{\TEXT\,,,music-glossary,Music Glossary}
 245 @end macro
 246
 247 @macro rlearning{TEXT}
 248 @vindex \TEXT\
 249 @ref{\TEXT\,,,lilypond-learning,Learning Manual}
 250 @end macro
 251
 252 @macro ruser{TEXT}
 253 @vindex \TEXT\
 254 @ref{\TEXT\,,,lilypond,Notation Reference}
 255 @end macro
 256
 257 @macro rprogram{TEXT}
 258 @vindex \TEXT\
 259 @ref{\TEXT\,,,lilypond-program,Application Usage}
 260 @end macro
 261
 262 @macro rlsr{TEXT}
 263 @ref{\TEXT\,,,lilypond-snippets,Snippets}
 264 @end macro
 265
 266 @macro rinternals{TEXT}
 267 @vindex \TEXT\
 268 @ref{\TEXT\,,,lilypond-internals,Internals Reference}
 269 @end macro
 270
 271 @end ifinfo
 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 rlearning{TEXT}
 283 learning manual, @ref{\TEXT\,,,lilypond-learning,Learning Manual}
 284 @end macro
 285
 286 @macro ruser{TEXT}
 287 notation reference, @ref{\TEXT\,,,lilypond,Notation Reference}
 288 @end macro
 289
 290 @macro rprogram{TEXT}
 291 program usage manual, @ref{\TEXT\,,,lilypond-program,Application Usage}
 292 @end macro
 293
 294 @macro rlsr{TEXT}
 295 @ref{\TEXT\,,,lilypond-snippets,Snippets}
 296 @end macro
 297
 298 @macro rinternals{TEXT}
 299 @vindex \TEXT\
 300 @code{\TEXT\}
 301 @end macro
 302
 303 @end iftex
 304