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