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