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 @c TODO: define different output for info
  35 @macro notation{TEXT}
  36 @var{\TEXT\}
  37 @end macro
  38
  39
  40
  41 @c   **** Headings in a doc subsection ****
  42
  43 @c not really a heading, but...
  44 @macro smallspace
  45 @sp 1
  46 @end macro
  47
  48 @c obsolete; being removed.
  49 @macro refcommands
  50 @noindent
  51 @subsubheading Predefined commands
  52
  53 @end macro
  54
  55 @macro commonprop
  56 @noindent
  57 @subsubheading Commonly tweaked properties
  58
  59 @end macro
  60
  61 @macro seealso
  62 @noindent
  63 @subsubheading See also
  64
  65 @end macro
  66
  67 @macro refbugs
  68 @noindent
  69 @subsubheading Known issues and warnings
  70
  71 @end macro
  72
  73
  74 @macro funindex {TEXT}
  75 @findex \TEXT\
  76 @kindex \TEXT\
  77 @end macro
  78
  79
  80
  81 @c   **** Links and references ****
  82
  83 @c usage: @lsr{ancient,custodes.ly}
  84 @macro lsr{DIR,TEXT}
  85 @ifhtml
  86 @uref{source/input/lsr/snippets/\DIR\.html#\TEXT\,@file{\DIR\/\TEXT\}}
  87 @end ifhtml
  88 @ifnothtml
  89 @file{\DIR\/\TEXT\}
  90 @end ifnothtml
  91 @end macro
  92
  93 @macro lsrdir{DIR}
  94 @ifhtml
  95 @uref{source/input/lsr/snippets\DIR\.html,\DIR\}
  96 @end ifhtml
  97 @ifnothtml
  98 \DIR\
  99 @end ifnothtml
 100 @end macro
 101
 102
 103 @c  Definitions for references:
 104 @c     @internalsref
 105 @c     @rglos
 106 @c     @rprogram
 107 @c     @ruser
 108 @c     @rlearning
 109
 110 @ifhtml
 111 @c ***** HTML *****
 112
 113 @c makeinfo-4.7 encodes html names, which means that nodes that
 114 @c contain nonalphanum characters will be broken links on the website.
 115 @c @uref{../lilypond-internals/\TEXT\.html,\TEXT\}@c
 116 @c @inforef{} adds ``See'' to the sentence, which is annoying, but
 117 @c better than a broken link.
 118 @c @inforef{\TEXT\,,lilypond-internals}@c
 119 @c using @ref without punctuation is OK without for formats other than info
 120
 121 @ifset bigpage
 122
 123 @macro internalsref{TEXT}
 124 @vindex \TEXT\
 125 @ref{\TEXT\,,,lilypond-internals-big-page}
 126 @end macro
 127
 128 @macro rglos{TEXT}
 129 @vindex \TEXT\
 130 @ref{\TEXT\,,,music-glossary-big-page}
 131 @end macro
 132
 133 @macro rprogram{TEXT}
 134 @vindex \TEXT\
 135 @ref{\TEXT\,,,lilypond-program-big-page}
 136 @end macro
 137
 138 @macro ruser{TEXT}
 139 @vindex \TEXT\
 140 @ref{\TEXT\,,,lilypond-big-page}
 141 @end macro
 142
 143 @macro rlearning{TEXT}
 144 @vindex \TEXT\
 145 @ref{\TEXT\,,,lilypond-learning-big-page}
 146 @end macro
 147
 148 @end ifset
 149
 150
 151 @ifclear bigpage
 152
 153 @macro internalsref{TEXT}
 154 @vindex \TEXT\
 155 @ref{\TEXT\,,,lilypond-internals}
 156 @end macro
 157
 158 @macro rglos{TEXT}
 159 @vindex \TEXT\
 160 @ref{\TEXT\,,,music-glossary}
 161 @end macro
 162
 163 @macro rprogram{TEXT}
 164 @vindex \TEXT\
 165 @ref{\TEXT\,,,lilypond-program}
 166 @end macro
 167
 168 @macro ruser{TEXT}
 169 @vindex \TEXT\
 170 @ref{\TEXT\,,,lilypond}
 171 @end macro
 172
 173 @macro rlearning{TEXT}
 174 @vindex \TEXT\
 175 @ref{\TEXT\,,,lilypond-learning}
 176 @end macro
 177
 178 @end ifclear
 179
 180 @end ifhtml
 181
 182
 183 @ifdocbook
 184 @c ***** DOCBOOK-XML *****
 185
 186 @macro internalsref{TEXT}
 187 @vindex \TEXT\
 188 @ref{\TEXT\,,,lilypond-internals}
 189 @end macro
 190
 191 @macro rglos{TEXT}
 192 @vindex \TEXT\
 193 @ref{\TEXT\,,,music-glossary}
 194 @end macro
 195
 196 @macro rprogram{TEXT}
 197 @vindex \TEXT\
 198 @ref{\TEXT\,,,lilypond-program}
 199 @end macro
 200
 201 @macro ruser{TEXT}
 202 @vindex \TEXT\
 203 @ref{\TEXT\,,,lilypond}
 204 @end macro
 205
 206 @macro rlearning{TEXT}
 207 @vindex \TEXT\
 208 @ref{\TEXT\,,,lilypond-learning}
 209 @end macro
 210
 211 @end ifdocbook
 212
 213
 214 @ifinfo
 215 @c **** INFO ****
 216
 217 @macro internalsref{TEXT}
 218 @vindex \TEXT\
 219 @inforef{\TEXT\,,lilypond-internals}
 220 @end macro
 221
 222 @macro rglos{TEXT}
 223 @vindex \TEXT\
 224 @inforef{\TEXT\,,music-glossary}
 225 @end macro
 226
 227 @macro rprogram{TEXT}
 228 @vindex \TEXT\
 229 @ref{\TEXT\,,,lilypond-program}
 230 @end macro
 231
 232 @macro ruser{TEXT}
 233 @vindex \TEXT\
 234 @ref{\TEXT\,,,lilypond}
 235 @end macro
 236
 237 @macro rlearning{TEXT}
 238 @vindex \TEXT\
 239 @ref{\TEXT\,,,lilypond-learning}
 240 @end macro
 241
 242 @end ifinfo
 243
 244
 245 @c **** TEX ****
 246 @iftex
 247
 248 @macro internalsref{TEXT}
 249 @vindex \TEXT\
 250 @code{\TEXT\}
 251 @end macro
 252
 253 @macro rglos {TEXT}
 254 @vindex \TEXT\
 255 @ref{\TEXT\,,,music-glossary}
 256 @end macro
 257
 258 @macro rprogram{TEXT}
 259 program usage manual, @ref{\TEXT\,,,lilypond-program}
 260 @c @internalsref{\TEXT\}
 261 @end macro
 262
 263 @macro ruser{TEXT}
 264 notation reference, @ref{\TEXT\,,,lilypond}
 265 @c @internalsref{\TEXT\}
 266 @end macro
 267
 268 @macro rlearning{TEXT}
 269 learning manual, @ref{\TEXT\,,,lilypond-learning}
 270 @c @internalsref{\TEXT\}
 271 @end macro
 272
 273 @end iftex
 274
 275
 276 @c EOF