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 @macro internalsref{NAME}@c
  57 @c annoying parentheses stripped by add-html-footer.py
  58 @ref{\NAME\,,,lilypond-internals}@c
  59 @findex \NAME\
  60 @end macro
  61
  62 @c usage: @inputfileref{input@/regression,FILE@/-NAME.ly}
  63 @macro inputfileref{DIR,NAME}
  64 @c @uref{../../../../\DIR\/out-www/collated-files.html#\NAME\,@file{\DIR\/\NAME\}}@c
  65 @uref{\DIR\/out-www/collated-files.html#\NAME\,@file{\DIR\/\NAME\}}@c
  66 @end macro
  67
  68 @macro rglos{NAME}@c
  69 @c annoying parentheses stripped by add-html-footer.py
  70 @ref{\NAME\,,,music-glossary}@c
  71 @findex \NAME\
  72 @end macro
  73
  74 @end ifhtml
  75
  76
  77 @ifdocbook
  78 @c ***** DOCBOOK-XML *****
  79
  80 @macro internalsref{NAME}
  81 @ref{\NAME\,,,lilypond-internals}@c
  82 @findex @code{\NAME\}
  83 @end macro
  84
  85 @macro inputfileref{DIR,NAME}
  86 @uref{source/\DIR\/out-www/collated-files.html#\NAME\,@file{\DIR\/\NAME\}}@c
  87 @end macro
  88
  89 @macro rglos{NAME}@c
  90 @ref{\NAME\,,,music-glossary}@c
  91 @findex \NAME\
  92 @end macro
  93
  94 @end ifdocbook
  95
  96
  97 @ifinfo
  98 @c **** INFO ****
  99
 100 @macro internalsref{NAME}
 101 @inforef{\NAME\,,lilypond-internals}@c
 102 @findex \NAME\@c
 103 @end macro
 104
 105 @macro inputfileref{DIR,NAME}
 106 @file{\DIR\/\NAME\}
 107 @end macro
 108
 109 @macro rglos{NAME}@c
 110 @inforef{\NAME\,,,music-glossary}@c
 111 @findex \NAME\
 112 @end macro
 113
 114 @macro usermanref{NAME}
 115 @inforef{\NAME\,,lilypond}@c
 116 @end macro
 117
 118 @end ifinfo
 119
 120
 121 @c **** TEX ****
 122 @iftex
 123
 124 @macro internalsref{NAME}@c
 125 @findex \NAME\ @c
 126 @code{\NAME\}@c
 127 @end macro
 128
 129 @macro inputfileref{DIR,NAME}@c
 130 @file{\DIR\/@/\NAME\}@c
 131 @end macro
 132
 133 @macro rglos {NAME}
 134 @findex \NAME\ @c
 135 @code{\NAME\}@c
 136 @end macro
 137
 138 @macro seeinternals{NAME}
 139 internals document, @internalsref{\NAME\}
 140 @end macro
 141
 142 @macro usermanref{NAME}
 143 user manual, @internalsref{\NAME\}
 144 @end macro
 145
 146 @end iftex
 147
 148 @ifnottex
 149 @c **** not TEX ****
 150
 151 @macro seeinternals{NAME}
 152 @internalsref{\NAME\}
 153 @end macro
 154
 155 @ifnotinfo
 156 @macro usermanref{NAME}
 157 @ref{\NAME\}@c
 158 @end macro
 159 @end ifnotinfo
 160
 161 @end ifnottex
 162
 163 @macro refbugs
 164 @noindent
 165 @subsubheading Bugs
 166
 167 @end macro
 168
 169 @macro seealso
 170 @noindent
 171 @subsubheading See also
 172
 173 @end macro
 174
 175 @macro refcommands
 176 @noindent
 177 @subsubheading Predefined commands
 178
 179 @end macro
 180
 181 @macro context{NAME}@c
 182 @code{\NAME\}@c should use internalsref
 183 @findex \NAME\@c
 184 @end macro
 185
 186 @macro refcommand{WHAT}
 187 @findex \WHAT\
 188 @code{\WHAT\}
 189 @end macro
 190