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