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