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