Documentation/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 @include version.itexi
  11 @include common-macros.itexi
  12
  13
  14 @c   ***** Displaying text *****
  15
  16 @c To get decent quotes in `foo' and ``foo''.
  17
  18 @macro q{TEXT}
  19 @quoteleft{}\TEXT\@quoteright{}
  20 @end macro
  21
  22 @macro qq{TEXT}
  23 @quotedblleft{}\TEXT\@quotedblright{}
  24 @end macro
  25
  26
  27 @ifhtml
  28
  29 @macro warning{TEXT}
  30 @cartouche
  31 @b{Note:} \TEXT\
  32 @end cartouche
  33 @end macro
  34
  35 @end ifhtml
  36
  37 @ifnothtml
  38
  39 @macro warning{TEXT}
  40 @quotation
  41 @quotation
  42 @cartouche
  43 @b{Note:} \TEXT\
  44 @end cartouche
  45 @end quotation
  46 @end quotation
  47 @end macro
  48
  49 @end ifnothtml
  50
  51
  52
  53 @c   ***** Headings in a doc subsection *****
  54
  55 @c Don't insert an empty line after @predefined!  Right now
  56 @c it doesn't matter, but a future implementation will probably
  57 @c add some code which needs this restriction.
  58
  59 @macro predefined
  60 @noindent
  61 @subsubheading Predefined commands
  62 @end macro
  63
  64 @c The next macro is a dummy currently since texinfo doesn't
  65 @c provide a real ragged-right environment yet.
  66 @c
  67 @c Due to a bug in texi2html (texi2html.pl CVS versions <= 1.245)
  68 @c the macro must not be empty.
  69
  70 @macro endpredefined
  71 @c
  72 @end macro
  73
  74
  75 @macro snippets
  76 @noindent
  77 @subsubheading Selected Snippets
  78 @end macro
  79
  80
  81 @c Don't insert an empty line after @seealso!  Otherwise we get
  82 @c unwanted extra vertical space in the PDF output.
  83
  84 @macro seealso
  85 @noindent
  86 @subsubheading See also
  87 @indent
  88 @end macro
  89
  90
  91 @macro knownissues
  92 @noindent
  93 @subsubheading Known issues and warnings
  94 @end macro
  95
  96
  97
  98 @c   ***** Links and references *****
  99
 100 @c  Definitions for references:
 101 @c
 102 @c     @rglos
 103 @c     @rlearning
 104 @c     @ruser
 105 @c     @rprogram
 106 @c     @rlsr
 107 @c     @rinternals
 108 @c
 109 @c  All these also have a @...named version which allows to specify the
 110 @c  displayed text for the reference as second argument.
 111 @c
 112 @c ***** HTML + bigpage is a special case (other manual names); all other
 113 @c formats are treated similarly.
 114
 115
 116 @c *** not TeX ***
 117
 118 @ifnottex
 119
 120 @c ** bigpage **
 121
 122 @ifset bigpage
 123
 124 @macro rglos{TEXT}
 125 @vindex \TEXT\
 126 @ref{\TEXT\,,,music-glossary-big-page,Music Glossary}
 127 @end macro
 128
 129 @macro rglosnamed{TEXT,DISPLAY}
 130 @vindex \TEXT\
 131 @ref{\TEXT\,,\DISPLAY\,music-glossary-big-page,Music Glossary}
 132 @end macro
 133
 134 @macro rlearning{TEXT}
 135 @vindex \TEXT\
 136 @ref{\TEXT\,,,lilypond-learning-big-page,Learning Manual}
 137 @end macro
 138
 139 @macro rlearningnamed{TEXT,DISPLAY}
 140 @vindex \TEXT\
 141 @ref{\TEXT\,,\DISPLAY\,lilypond-learning-big-page,Learning Manual}
 142 @end macro
 143
 144 @macro ruser{TEXT}
 145 @vindex \TEXT\
 146 @ref{\TEXT\,,,lilypond-big-page,Notation Reference}
 147 @end macro
 148
 149 @macro rusernamed{TEXT,DISPLAY}
 150 @vindex \TEXT\
 151 @ref{\TEXT\,,\DISPLAY\,lilypond-big-page,Notation Reference}
 152 @end macro
 153
 154 @macro rprogram{TEXT}
 155 @vindex \TEXT\
 156 @ref{\TEXT\,,,lilypond-program-big-page,Application Usage}
 157 @end macro
 158
 159 @macro rprogramnamed{TEXT,DISPLAY}
 160 @vindex \TEXT\
 161 @ref{\TEXT\,,\DISPLAY\,lilypond-program-big-page,Application Usage}
 162 @end macro
 163
 164 @macro rlsr{TEXT}
 165 @ref{\TEXT\,,,lilypond-snippets-big-page,Snippets}
 166 @end macro
 167
 168 @macro rlsrnamed{TEXT,DISPLAY}
 169 @ref{\TEXT\,,\DISPLAY\,lilypond-snippets-big-page,Snippets}
 170 @end macro
 171
 172 @macro rinternals{TEXT}
 173 @vindex \TEXT\
 174 @ref{\TEXT\,,,lilypond-internals-big-page,Internals Reference}
 175 @end macro
 176
 177 @macro rinternalsnamed{TEXT,DISPLAY}
 178 @vindex \TEXT\
 179 @ref{\TEXT\,,\DISPLAY\,lilypond-internals-big-page,Internals Reference}
 180 @end macro
 181
 182 @end ifset
 183
 184
 185 @c ** not bigpage **
 186
 187 @ifclear bigpage
 188
 189 @macro rglos{TEXT}
 190 @vindex \TEXT\
 191 @ref{\TEXT\,,,music-glossary,Music Glossary}
 192 @end macro
 193
 194 @macro rglosnamed{TEXT,DISPLAY}
 195 @vindex \TEXT\
 196 @ref{\TEXT\,,\DISPLAY\,music-glossary,Music Glossary}
 197 @end macro
 198
 199 @macro rlearning{TEXT}
 200 @vindex \TEXT\
 201 @ref{\TEXT\,,,lilypond-learning,Learning Manual}
 202 @end macro
 203
 204 @macro rlearningnamed{TEXT,DISPLAY}
 205 @vindex \TEXT\
 206 @ref{\TEXT\,,,lilypond-learning,Learning Manual}
 207 @end macro
 208
 209 @macro ruser{TEXT}
 210 @vindex \TEXT\
 211 @ref{\TEXT\,,,lilypond,Notation Reference}
 212 @end macro
 213
 214 @macro rusernamed{TEXT,DISPLAY}
 215 @vindex \TEXT\
 216 @ref{\TEXT\,,\DISPLAY\,lilypond,Notation Reference}
 217 @end macro
 218
 219 @macro rprogram{TEXT}
 220 @vindex \TEXT\
 221 @ref{\TEXT\,,,lilypond-program,Application Usage}
 222 @end macro
 223
 224 @macro rprogramnamed{TEXT,DISPLAY}
 225 @vindex \TEXT\
 226 @ref{\TEXT\,,\DISPLAY\,lilypond-program,Application Usage}
 227 @end macro
 228
 229 @macro rlsr{TEXT}
 230 @ref{\TEXT\,,,lilypond-snippets,Snippets}
 231 @end macro
 232
 233 @macro rlsrnamed{TEXT,DISPLAY}
 234 @ref{\TEXT\,,\DISPLAY\,lilypond-snippets,Snippets}
 235 @end macro
 236
 237 @macro rinternals{TEXT}
 238 @vindex \TEXT\
 239 @ref{\TEXT\,,,lilypond-internals,Internals Reference}
 240 @end macro
 241
 242 @macro rinternalsnamed{TEXT,DISPLAY}
 243 @vindex \TEXT\
 244 @ref{\TEXT\,,\DISPLAY\,lilypond-internals,Internals Reference}
 245 @end macro
 246
 247 @end ifclear
 248
 249 @end ifnottex
 250
 251
 252 @c *** TeX ***
 253
 254 @iftex
 255
 256 @c All commands below should work in the middle of the line;
 257 @c we thus must not use @vindex directly since it works only if placed
 258 @c on a line of its own.  To overcome this problem, we define a
 259 @c replacement macro using the internal definition of @vindex which
 260 @c delimits arguments in the standard way (i.e., with braces).
 261
 262 @tex
 263 \gdef\lilyvindex#1{\doind{vr}{\code #1}\ignorespaces}
 264 @end tex
 265
 266 @macro rglos{TEXT}
 267 @lilyvindex{\TEXT\}
 268 @ref{\TEXT\,,,music-glossary,Music Glossary}
 269 @end macro
 270
 271 @macro rglosnamed{TEXT,DISPLAY}
 272 @lilyvindex{\TEXT\}
 273 @ref{\TEXT\,,\DISPLAY\,music-glossary,Music Glossary}
 274 @end macro
 275
 276 @macro rlearning{TEXT}
 277 @lilyvindex{\TEXT\}
 278 @ref{\TEXT\,,,lilypond-learning,Learning Manual}
 279 @end macro
 280
 281 @macro rlearningnamed{TEXT,DISPLAY}
 282 @lilyvindex{\TEXT\}
 283 @ref{\TEXT\,,\DISPLAY\,lilypond-learning,Learning Manual}
 284 @end macro
 285
 286 @macro ruser{TEXT}
 287 @lilyvindex{\TEXT\}
 288 @ref{\TEXT\,,,lilypond,Notation Reference}
 289 @end macro
 290
 291 @macro rusernamed{TEXT,DISPLAY}
 292 @lilyvindex{\TEXT\}
 293 @ref{\TEXT\,,\DISPLAY\,lilypond,Notation Reference}
 294 @end macro
 295
 296 @macro rprogram{TEXT}
 297 @lilyvindex{\TEXT\}
 298 @ref{\TEXT\,,,lilypond-program,Application Usage}
 299 @end macro
 300
 301 @macro rprogramnamed{TEXT,DISPLAY}
 302 @lilyvindex{\TEXT\}
 303 @ref{\TEXT\,,\DISPLAY\,lilypond-program,Application Usage}
 304 @end macro
 305
 306 @macro rlsr{TEXT}
 307 @lilyvindex{\TEXT\}
 308 @ref{\TEXT\,,,lilypond-snippets,Snippets}
 309 @end macro
 310
 311 @macro rlsrnamed{TEXT,DISPLAY}
 312 @lilyvindex{\TEXT\}
 313 @ref{\TEXT\,,\DISPLAY\,lilypond-snippets,Snippets}
 314 @end macro
 315
 316 @macro rinternals{TEXT}
 317 @lilyvindex{\TEXT\}
 318 @ref{\TEXT\,,,lilypond-internals,Internals Reference}
 319 @end macro
 320
 321 @macro rinternalsnamed{TEXT,DISPLAY}
 322 @lilyvindex{\TEXT\}
 323 @ref{\TEXT\,,\DISPLAY\,lilypond-internals,Internals Reference}
 324 @end macro
 325
 326 @end iftex