Documentation/user/macros.itexi

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