]> git.donarmstrong.com Git - lilypond.git/blobdiff - Documentation/user/macros.itexi
* Documentation/user/macros.itexi: Use @ref instead of @inforef
[lilypond.git] / Documentation / user / macros.itexi
index 887837466f784a570c38da5d49e14fe4468be3f3..6b531fc814bb38b69a4936e956ae9133a7f9ded2 100644 (file)
 
 
 @c dup?
-
 @ifhtml
 
  @c ***** HTML *****
 
+@macro internalsref{NAME}@c
+@c makeinfo-4.7 encodes html names, which means that nodes that
+@c contain nonalphanum characters will be broken links on the website.
+@c @uref{../lilypond-internals/\NAME\.html,\NAME\}@c
+@c @inforef{} adds ``See'' to the sentence, which is annoying, but
+@c better than a broken link.
+@c @inforef{\NAME\,,lilypond-internals}@c
+@c using @ref without punctuation is OK without for formats other than info
+@ref{\NAME\,,,lilypond-internals}@c
+@c should we do this? 
+@cindex @code{\NAME\}
+@end macro
+
+ @c what is this? -- jcn
+ @macro hyphenatedinternalsref{NAME,NODENAME}
+ @c @uref{../lilypond-internals/\NODENAME\.html,\NAME\}@c
+ @c @inforef{\NODENAME\,,lilypond-internals}@c
+ @c should we do this? 
+ @c using @ref without punctuation is OK without for formats other than info
+ @ref{\NODENAME\,,\NAME\,lilypond-internals}@c
+ @cindex @code{\NAME\}
+ @end macro
+
+ @macro inputfileref{DIR,NAME}
+ @uref{../../../../\DIR\/out-www/collated-files.html#\NAME\,@file{\DIR\/\NAME\}}@c
+ @end macro
+
+@end ifhtml
+
+@c dup?
+@ifdocbook
+
+ @c ***** DOCBOOK-XML *****
+
  @macro internalsref{NAME}
- @uref{../lilypond-internals/\NAME\.html,\NAME\}@c
+ @c makeinfo-4.7 encodes html names
+ @c @uref{../lilypond-internals/\NAME\.html,\NAME\}@c
+ @inforef{\NAME\,,lilypond-internals}@c
  @c should we do this? 
  @cindex @code{\NAME\}
  @end macro
 
  @macro hyphenatedinternalsref{NAME,NODENAME}
- @uref{../lilypond-internals/\NODENAME\.html,\NAME\}@c
+ @c @uref{../lilypond-internals/\NODENAME\.html,\NAME\}@c
+ @inforef{\NODENAME\,,lilypond-internals}@c
  @c should we do this? 
  @cindex @code{\NAME\}
  @end macro
  @uref{../../../../\DIR\/out-www/collated-files.html#\NAME\,@file{\DIR\/\NAME\}}@c
  @end macro
 
-@end ifhtml
+@end ifdocbook
 
 @ifinfo
 
 @end macro
 
 @macro hyphenatedinternalsref{NAME,NODENAME}
+@c FIXME: suspicious info file name?
 @inforef{\NODENAME\,,lilypond-internals}@c
 @c should we do this? 
 @cindex @code{\NAME\}