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