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 context{TEXT}
  75 @vindex \TEXT\
  76 @code{\TEXT\}@c should use internalsref
  77 @end macro
  78
  79 @macro funindex {TEXT}
  80 @findex \TEXT\
  81 @kindex \TEXT\
  82 @end macro
  83
  84
  85
  86 @c   **** Links and references ****
  87
  88 @c usage: @lsr{ancient,custodes.ly}
  89 @macro lsr{DIR,TEXT}
  90 @ifhtml
  91 @uref{source/input/lsr/\DIR\/collated-files.html#\TEXT\,@file{\DIR\/\TEXT\}}
  92 @end ifhtml
  93 @ifnothtml
  94 @file{\DIR\/\TEXT\}
  95 @end ifnothtml
  96 @end macro
  97
  98 @macro lsrdir{DIR}
  99 @ifhtml
 100 @uref{source/input/lsr/\DIR\/collated-files.html,@file{\DIR\}/}
 101 @end ifhtml
 102 @ifnothtml
 103 @file{\DIR\}
 104 @end ifnothtml
 105 @end macro
 106
 107
 108 @c  Definitions for references:
 109 @c     @internalsref
 110 @c     @rglos
 111 @c     @rprogram
 112 @c     @ruser
 113 @c     @rlearning
 114
 115 @ifhtml
 116 @c ***** HTML *****
 117
 118 @c makeinfo-4.7 encodes html names, which means that nodes that
 119 @c contain nonalphanum characters will be broken links on the website.
 120 @c @uref{../lilypond-internals/\TEXT\.html,\TEXT\}@c
 121 @c @inforef{} adds ``See'' to the sentence, which is annoying, but
 122 @c better than a broken link.
 123 @c @inforef{\TEXT\,,lilypond-internals}@c
 124 @c using @ref without punctuation is OK without for formats other than info
 125
 126 @ifset bigpage
 127
 128 @macro internalsref{TEXT}
 129 @vindex \TEXT\
 130 @ref{\TEXT\,,,lilypond-internals-big-page}
 131 @end macro
 132
 133 @macro rglos{TEXT}
 134 @vindex \TEXT\
 135 @ref{\TEXT\,,,music-glossary-big-page}
 136 @end macro
 137
 138 @macro rprogram{TEXT}
 139 @vindex \TEXT\
 140 @ref{\TEXT\,,,lilypond-program-big-page}
 141 @end macro
 142
 143 @macro ruser{TEXT}
 144 @vindex \TEXT\
 145 @ref{\TEXT\,,,lilypond-big-page}
 146 @end macro
 147
 148 @macro rlearning{TEXT}
 149 @vindex \TEXT\
 150 @ref{\TEXT\,,,lilypond-learning-big-page}
 151 @end macro
 152
 153 @end ifset
 154
 155
 156 @ifclear bigpage
 157
 158 @macro internalsref{TEXT}
 159 @vindex \TEXT\
 160 @ref{\TEXT\,,,lilypond-internals}
 161 @end macro
 162
 163 @macro rglos{TEXT}
 164 @vindex \TEXT\
 165 @ref{\TEXT\,,,music-glossary}
 166 @end macro
 167
 168 @macro rprogram{TEXT}
 169 @vindex \TEXT\
 170 @ref{\TEXT\,,,lilypond-program}
 171 @end macro
 172
 173 @macro ruser{TEXT}
 174 @vindex \TEXT\
 175 @ref{\TEXT\,,,lilypond}
 176 @end macro
 177
 178 @macro rlearning{TEXT}
 179 @vindex \TEXT\
 180 @ref{\TEXT\,,,lilypond-learning}
 181 @end macro
 182
 183 @end ifclear
 184
 185 @end ifhtml
 186
 187
 188 @ifdocbook
 189 @c ***** DOCBOOK-XML *****
 190
 191 @macro internalsref{TEXT}
 192 @vindex \TEXT\
 193 @ref{\TEXT\,,,lilypond-internals}
 194 @end macro
 195
 196 @macro rglos{TEXT}
 197 @vindex \TEXT\
 198 @ref{\TEXT\,,,music-glossary}
 199 @end macro
 200
 201 @macro rprogram{TEXT}
 202 @vindex \TEXT\
 203 @ref{\TEXT\,,,lilypond-program}
 204 @end macro
 205
 206 @macro ruser{TEXT}
 207 @vindex \TEXT\
 208 @ref{\TEXT\,,,lilypond}
 209 @end macro
 210
 211 @macro rlearning{TEXT}
 212 @vindex \TEXT\
 213 @ref{\TEXT\,,,lilypond-learning}
 214 @end macro
 215
 216 @end ifdocbook
 217
 218
 219 @ifinfo
 220 @c **** INFO ****
 221
 222 @macro internalsref{TEXT}
 223 @vindex \TEXT\
 224 @inforef{\TEXT\,,lilypond-internals}
 225 @end macro
 226
 227 @macro rglos{TEXT}
 228 @vindex \TEXT\
 229 @inforef{\TEXT\,,music-glossary}
 230 @end macro
 231
 232 @macro rprogram{TEXT}
 233 @vindex \TEXT\
 234 @ref{\TEXT\,,,lilypond-program}
 235 @end macro
 236
 237 @macro ruser{TEXT}
 238 @vindex \TEXT\
 239 @ref{\TEXT\,,,lilypond}
 240 @end macro
 241
 242 @macro rlearning{TEXT}
 243 @vindex \TEXT\
 244 @ref{\TEXT\,,,lilypond-learning}
 245 @end macro
 246
 247 @end ifinfo
 248
 249
 250 @c **** TEX ****
 251 @iftex
 252
 253 @macro internalsref{TEXT}
 254 @vindex \TEXT\
 255 @code{\TEXT\}
 256 @end macro
 257
 258 @macro rglos {TEXT}
 259 @vindex \TEXT\
 260 @ref{\TEXT\,,,music-glossary}
 261 @end macro
 262
 263 @macro rprogram{TEXT}
 264 program usage manual, @ref{\TEXT\,,,lilypond-program}
 265 @c @internalsref{\TEXT\}
 266 @end macro
 267
 268 @macro ruser{TEXT}
 269 user manual, @ref{\TEXT\,,,lilypond}
 270 @c @internalsref{\TEXT\}
 271 @end macro
 272
 273 @macro rlearning{TEXT}
 274 learning manual, @ref{\TEXT\,,,lilypond-learning}
 275 @c @internalsref{\TEXT\}
 276 @end macro
 277
 278 @end iftex
 279
 280
 281 @c EOF