Documentation/user/macros.itexi

   1 @c -*- coding: latin-1; mode: texinfo; -*-
   2
   3 @ifnottex
   4   @macro texisharp {word}
   5   #
   6   @end macro
   7   @macro texiflat {word}
   8   b
   9   @end macro
  10 @end ifnottex
  11
  12 @c FIXME, use \fetaaccidentalsXMC?
  13 @c \\kern0.15em\\fetachar\\fetaflat
  14 @iftex
  15  @macro texiflat {word}
  16  @tex
  17  FIXME: fetaflat
  18  @end tex
  19  @end macro
  20 @c FIXME, use \fetaaccidentalsXC?
  21 @c  \\raise0.5ex\\fetachar\\fetasharp
  22  @macro texisharp {word}
  23   @tex
  24   FIXME: fetasharp
  25   @end tex
  26   @end macro
  27 @end iftex
  28
  29
  30 @macro arrow{}
  31 @iftex
  32 @tex $\\Rightarrow$ @end tex@c
  33 @end iftex
  34 @ifhtml
  35 @html
  36 &rarr;
  37 @end html
  38 @end ifhtml
  39 @ifinfo
  40 -->
  41 @end ifinfo
  42 @end macro
  43
  44
  45 @ifhtml
  46 @c ***** HTML *****
  47
  48 @c makeinfo-4.7 encodes html names, which means that nodes that
  49 @c contain nonalphanum characters will be broken links on the website.
  50 @c @uref{../lilypond-internals/\NAME\.html,\NAME\}@c
  51 @c @inforef{} adds ``See'' to the sentence, which is annoying, but
  52 @c better than a broken link.
  53 @c @inforef{\NAME\,,lilypond-internals}@c
  54 @c using @ref without punctuation is OK without for formats other than info
  55
  56 @c annoying parentheses stripped by add-html-footer.py
  57 @macro internalsref{NAME}
  58 @vindex \NAME\
  59 @ref{\NAME\,,,lilypond-internals}
  60 @end macro
  61
  62 @c usage: @inputfileref{input@/regression,FILE@/-NAME.ly}
  63 @macro inputfileref{DIR,NAME}
  64 @uref{source/\DIR\/collated-files.html#\NAME\,@file{\DIR\/\NAME\}}@c
  65 @end macro
  66
  67 @c annoying parentheses stripped by add-html-footer.py
  68 @macro rglos{NAME}
  69 @vindex \NAME\
  70 @ref{\NAME\,,,music-glossary}
  71 @end macro
  72
  73 @end ifhtml
  74
  75
  76 @ifdocbook
  77 @c ***** DOCBOOK-XML *****
  78
  79 @macro internalsref{NAME}
  80 @vindex \NAME\
  81 @ref{\NAME\,,,lilypond-internals}
  82 @end macro
  83
  84 @macro inputfileref{DIR,NAME}
  85 @uref{source/\DIR\/collated-files.html#\NAME\,@file{\DIR\/\NAME\}}
  86 @end macro
  87
  88 @macro rglos{NAME}
  89 @vindex \NAME\
  90 @ref{\NAME\,,,music-glossary}
  91 @end macro
  92
  93 @end ifdocbook
  94
  95
  96 @ifinfo
  97 @c **** INFO ****
  98
  99 @macro internalsref{NAME}
 100 @vindex \NAME\
 101 @inforef{\NAME\,,lilypond-internals}
 102 @end macro
 103
 104 @macro inputfileref{DIR,NAME}
 105 @file{\DIR\/\NAME\}
 106 @end macro
 107
 108 @macro rglos{NAME}@c
 109 @vindex \NAME\
 110 @inforef{\NAME\,,,music-glossary}
 111 @end macro
 112
 113 @macro usermanref{NAME}
 114 @inforef{\NAME\}
 115 @end macro
 116
 117 @end ifinfo
 118
 119
 120 @c **** TEX ****
 121 @iftex
 122
 123 @macro internalsref{NAME}
 124 @vindex \NAME\
 125 @code{\NAME\}
 126 @end macro
 127
 128 @macro inputfileref{DIR,NAME}
 129 @file{\DIR\/@/\NAME\}
 130 @end macro
 131
 132 @macro rglos {NAME}
 133 @vindex \NAME\
 134 @code{\NAME\}
 135 @end macro
 136
 137 @macro seeinternals{NAME}
 138 internals document, @internalsref{\NAME\}
 139 @end macro
 140
 141 @macro usermanref{NAME}
 142 user manual, @internalsref{\NAME\}
 143 @end macro
 144
 145 @end iftex
 146
 147 @ifnottex
 148 @c **** not TEX ****
 149
 150 @macro seeinternals{NAME}
 151 @internalsref{\NAME\}
 152 @end macro
 153
 154 @ifnotinfo
 155 @macro usermanref{NAME}
 156 @ref{\NAME\}
 157 @end macro
 158 @end ifnotinfo
 159
 160 @end ifnottex
 161
 162
 163 @c **** ALL ****
 164
 165 @macro refbugs
 166 @noindent
 167 @subsubheading Bugs
 168
 169 @end macro
 170
 171 @macro seealso
 172 @noindent
 173 @subsubheading See also
 174
 175 @end macro
 176
 177 @macro refcommands
 178 @noindent
 179 @subsubheading Predefined commands
 180
 181 @end macro
 182
 183 @macro context{NAME}
 184 @vindex \NAME\
 185 @code{\NAME\}@c should use internalsref
 186 @end macro
 187
 188 @macro refcommand{WHAT}
 189 @vindex \WHAT\
 190 @code{\WHAT\}
 191 @end macro
 192
 193 @macro commonprop
 194 @noindent
 195 @subsubheading Commonly tweaked properties
 196
 197 @end macro
 198
 199 @macro funindex {WORD}
 200 @findex \WORD\
 201 @kindex \WORD\
 202 @end macro
 203
 204