-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1
Am Donnerstag, 14. August 2008 schrieb Patrick McCarty:
> On Thu, Aug 14, 2008, Carl D. Sorensen <[EMAIL PROTECTED]> wrote:
> > I think it is to take the backslash off the node, isn't it?
>
> The issue is with getting the @ref{...} calls to work with
> backslashes. I believe Reinhold is trying to figure out a solution.
The only solution I can think of right now is the attached patch: It adds a
two-parameter macro @rusernamed in addition to @ruser (and similar commands
for all other ref macros), which allows to give a displayed link text for
those nodes, where the node name is not allowed to contain some characters or
where the node name is not desired (like "Top").
Does anyone know a better solution or can I apply this patch to master?
Cheers,
Reinhold
- --
- ------------------------------------------------------------------
Reinhold Kainhofer, Vienna University of Technology, Austria
email: [EMAIL PROTECTED], http://reinhold.kainhofer.com/
* Financial and Actuarial Mathematics, TU Wien, http://www.fam.tuwien.ac.at/
* K Desktop Environment, http://www.kde.org, KOrganizer maintainer
* Chorvereinigung "Jung-Wien", http://www.jung-wien.at/
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.6 (GNU/Linux)
iD8DBQFIpIh2TqjEwhXvPN0RAtGiAKCoRHdvGyiLp3m/L5yzNMSQV8odvgCeILxY
qsPawU6qywD2h0J+Nfu0ba8=
=+wEe
-----END PGP SIGNATURE-----
From 9332dd082328cd1d5f67c4e6aae9b99a77e37686 Mon Sep 17 00:00:00 2001
From: Reinhold Kainhofer <[EMAIL PROTECTED]>
Date: Thu, 14 Aug 2008 15:21:16 +0200
Subject: [PATCH 1/1] Add two-parameter versions of @ruser etc. to allow specifying the displayed text
Sometimes node named cannot contain special characters, which you would like
to be displayed in the link text. Thus, the third argument of @ref needs to be
used. Unfortunately, Texinfo (or rather texi2pdf) does not support optional
arguments to macros, so we have to add new two-parameter versions of all our
xref macros.
I als streamlined the definitions in macros.itely a little bit (distinguish only bigpage, not bigpage and tex).
This also allows us to link to the Top node of any manual with displaying the
manual title instead of "Top".
---
Documentation/user/introduction.itely | 6 +-
Documentation/user/macros.itexi | 147 ++++++++++++++++++--------------
2 files changed, 86 insertions(+), 67 deletions(-)
diff --git a/Documentation/user/introduction.itely b/Documentation/user/introduction.itely
index 32e425a..198d103 100644
--- a/Documentation/user/introduction.itely
+++ b/Documentation/user/introduction.itely
@@ -870,7 +870,7 @@ all.
@cindex foreign languages
@cindex language
[EMAIL PROTECTED],Music glossary,,music-glossary}:
[EMAIL PROTECTED],Music glossary}
this explains musical terms, and includes translations to various
languages. If you are not familiar with music notation or music
terminology (especially if you are a non-native English speaker),
@@ -993,7 +993,7 @@ formats to the @code{.ly} format.
@cindex snippets
@cindex LSR
[EMAIL PROTECTED],LilyPond Snippet List,,lilypond-snippets}: this shows a
[EMAIL PROTECTED],LilyPond Snippet List}: this shows a
selected set of LilyPond snippets from the
@uref{http://lsr@/.dsi@/.unimi@/.it,LilyPond Snippet Repository}
(LSR). All the snippets are in the public domain.
@@ -1011,7 +1011,7 @@ The list of snippets for each subsection of the Notation Reference
@node About the Internals Reference (IR)
@unnumberedsubsec About the Internals Reference (IR)
[EMAIL PROTECTED],Internals Reference,,lilypond-internals}: this is a set
[EMAIL PROTECTED],Internals Reference}: this is a set
of heavily cross linked HTML pages which document the nitty-gritty
details of each and every LilyPond class, object, and function.
It is produced directly from the formatting definitions in the
diff --git a/Documentation/user/macros.itexi b/Documentation/user/macros.itexi
index fb4e0e7..639cd02 100644
--- a/Documentation/user/macros.itexi
+++ b/Documentation/user/macros.itexi
@@ -127,9 +127,13 @@
@c @rprogram
@c @rsnippets
@c @rinternals
[EMAIL PROTECTED] all these also have a @...named version, which allows to specify the
[EMAIL PROTECTED] displayed text for the reference as second argument
[EMAIL PROTECTED]
[EMAIL PROTECTED] ***** HTML *****
[EMAIL PROTECTED] ***** HTML + bigpage is a special case (other manual names), all other
[EMAIL PROTECTED] formats are treated similarly
+
[EMAIL PROTECTED]
@ifset bigpage
@@ -138,30 +142,59 @@
@ref{\TEXT\,,,music-glossary-big-page,Music Glossary}
@end macro
[EMAIL PROTECTED] rglosnamed{TEXT,DISPLAY}
[EMAIL PROTECTED] \TEXT\
[EMAIL PROTECTED],,\DISPLAY\,music-glossary-big-page,Music Glossary}
[EMAIL PROTECTED] macro
+
@macro rlearning{TEXT}
@vindex \TEXT\
@ref{\TEXT\,,,lilypond-learning-big-page,Learning Manual}
@end macro
[EMAIL PROTECTED] rlearningnamed{TEXT,DISPLAY}
[EMAIL PROTECTED] \TEXT\
[EMAIL PROTECTED],,\DISPLAY\,lilypond-learning-big-page,Learning Manual}
[EMAIL PROTECTED] macro
+
@macro ruser{TEXT}
@vindex \TEXT\
@ref{\TEXT\,,,lilypond-big-page,Notation Reference}
@end macro
[EMAIL PROTECTED] rusernamed{TEXT,DISPLAY}
[EMAIL PROTECTED] \TEXT\
[EMAIL PROTECTED],,\DISPLAY\,lilypond-big-page,Notation Reference}
[EMAIL PROTECTED] macro
+
@macro rprogram{TEXT}
@vindex \TEXT\
@ref{\TEXT\,,,lilypond-program-big-page,Application Usage}
@end macro
[EMAIL PROTECTED] rprogramnamed{TEXT,DISPLAY}
[EMAIL PROTECTED] \TEXT\
[EMAIL PROTECTED],,\DISPLAY\,lilypond-program-big-page,Application Usage}
[EMAIL PROTECTED] macro
+
@macro rlsr{TEXT}
@ref{\TEXT\,,,lilypond-snippets-big-page,Snippets}
@end macro
[EMAIL PROTECTED] rlsrnamed{TEXT,DISPLAY}
[EMAIL PROTECTED],,\DISPLAY\,lilypond-snippets-big-page,Snippets}
[EMAIL PROTECTED] macro
+
@macro rinternals{TEXT}
@vindex \TEXT\
@ref{\TEXT\,,,lilypond-internals-big-page,Internals Reference}
@end macro
[EMAIL PROTECTED] rinternalsnamed{TEXT,DISPLAY}
[EMAIL PROTECTED] \TEXT\
[EMAIL PROTECTED],,,lilypond-internals-big-page,Internals Reference}
[EMAIL PROTECTED] macro
+
@end ifset
@@ -172,44 +205,17 @@
@ref{\TEXT\,,,music-glossary,Music Glossary}
@end macro
[EMAIL PROTECTED] rlearning{TEXT}
[EMAIL PROTECTED] rglosnamed{TEXT,DISPLAY}
@vindex \TEXT\
[EMAIL PROTECTED],,,lilypond-learning,Learning Manual}
[EMAIL PROTECTED],,\DISPLAY\,music-glossary,Music Glossary}
@end macro
[EMAIL PROTECTED] ruser{TEXT}
[EMAIL PROTECTED] \TEXT\
[EMAIL PROTECTED],,,lilypond,Notation Reference}
[EMAIL PROTECTED] macro
-
[EMAIL PROTECTED] rprogram{TEXT}
[EMAIL PROTECTED] \TEXT\
[EMAIL PROTECTED],,,lilypond-program,Application Usage}
[EMAIL PROTECTED] macro
-
[EMAIL PROTECTED] rlsr{TEXT}
[EMAIL PROTECTED],,,lilypond-snippets,Snippets}
[EMAIL PROTECTED] macro
-
[EMAIL PROTECTED] rinternals{TEXT}
[EMAIL PROTECTED] \TEXT\
[EMAIL PROTECTED],,,lilypond-internals,Internals Reference}
[EMAIL PROTECTED] macro
-
[EMAIL PROTECTED] ifclear
-
[EMAIL PROTECTED] ifhtml
-
-
[EMAIL PROTECTED]
[EMAIL PROTECTED] ***** DOCBOOK-XML *****
-
[EMAIL PROTECTED] rglos{TEXT}
[EMAIL PROTECTED] rlearning{TEXT}
@vindex \TEXT\
[EMAIL PROTECTED],,,music-glossary,Music Glossary}
[EMAIL PROTECTED],,,lilypond-learning,Learning Manual}
@end macro
[EMAIL PROTECTED] rlearning{TEXT}
[EMAIL PROTECTED] rlearningnamed{TEXT,DISPLAY}
@vindex \TEXT\
@ref{\TEXT\,,,lilypond-learning,Learning Manual}
@end macro
@@ -219,56 +225,43 @@
@ref{\TEXT\,,,lilypond,Notation Reference}
@end macro
[EMAIL PROTECTED] rprogram{TEXT}
[EMAIL PROTECTED] rusernamed{TEXT,DISPLAY}
@vindex \TEXT\
[EMAIL PROTECTED],,,lilypond-program,Application Usage}
[EMAIL PROTECTED],,\DISPLAY\,lilypond,Notation Reference}
@end macro
[EMAIL PROTECTED] rlsr{TEXT}
[EMAIL PROTECTED],,,lilypond-snippets,Snippets}
[EMAIL PROTECTED] rprogram{TEXT}
[EMAIL PROTECTED] \TEXT\
[EMAIL PROTECTED],,,lilypond-program,Application Usage}
@end macro
[EMAIL PROTECTED] rinternals{TEXT}
[EMAIL PROTECTED] rprogramnamed{TEXT,DISPLAY}
@vindex \TEXT\
[EMAIL PROTECTED],,,lilypond-internals,Internals Reference}
[EMAIL PROTECTED],,\DISPLAY\,lilypond-program,Application Usage}
@end macro
[EMAIL PROTECTED] ifdocbook
-
-
[EMAIL PROTECTED]
[EMAIL PROTECTED] **** INFO ****
-
[EMAIL PROTECTED] rglos{TEXT}
[EMAIL PROTECTED] \TEXT\
[EMAIL PROTECTED],,,music-glossary,Music Glossary}
[EMAIL PROTECTED] rlsr{TEXT}
[EMAIL PROTECTED],,,lilypond-snippets,Snippets}
@end macro
[EMAIL PROTECTED] rlearning{TEXT}
[EMAIL PROTECTED] \TEXT\
[EMAIL PROTECTED],,,lilypond-learning,Learning Manual}
[EMAIL PROTECTED] rlsrnamed{TEXT,DISPLAY}
[EMAIL PROTECTED],,\DISPLAY\,lilypond-snippets,Snippets}
@end macro
[EMAIL PROTECTED] ruser{TEXT}
[EMAIL PROTECTED] rinternals{TEXT}
@vindex \TEXT\
[EMAIL PROTECTED],,,lilypond,Notation Reference}
[EMAIL PROTECTED],,,lilypond-internals,Internals Reference}
@end macro
[EMAIL PROTECTED] rprogram{TEXT}
[EMAIL PROTECTED] rinternalsnamed{TEXT,DISPLAY}
@vindex \TEXT\
[EMAIL PROTECTED],,,lilypond-program,Application Usage}
[EMAIL PROTECTED],,\DISPLAY\,lilypond-internals,Internals Reference}
@end macro
[EMAIL PROTECTED] rlsr{TEXT}
[EMAIL PROTECTED],,,lilypond-snippets,Snippets}
[EMAIL PROTECTED] macro
[EMAIL PROTECTED] ifclear
[EMAIL PROTECTED] rinternals{TEXT}
[EMAIL PROTECTED] \TEXT\
[EMAIL PROTECTED],,,lilypond-internals,Internals Reference}
[EMAIL PROTECTED] macro
[EMAIL PROTECTED] ifnottex
[EMAIL PROTECTED] ifinfo
@c **** TEX ****
@@ -279,26 +272,52 @@
@ref{\TEXT\,,,music-glossary,Music Glossary}
@end macro
[EMAIL PROTECTED] rglosnamed{TEXT,DISPLAY}
[EMAIL PROTECTED] \TEXT\
[EMAIL PROTECTED],,\DISPLAY\,music-glossary,Music Glossary}
[EMAIL PROTECTED] macro
+
@macro rlearning{TEXT}
learning manual, @ref{\TEXT\,,,lilypond-learning,Learning Manual}
@end macro
[EMAIL PROTECTED] rlearningnamed{TEXT,DISPLAY}
+learning manual, @ref{\TEXT\,,\DISPLAY\,lilypond-learning,Learning Manual}
[EMAIL PROTECTED] macro
+
@macro ruser{TEXT}
notation reference, @ref{\TEXT\,,,lilypond,Notation Reference}
@end macro
[EMAIL PROTECTED] rusernamed{TEXT,DISPLAY,DISPLAY}
+notation reference, @ref{\TEXT\,,\DISPLAY\,lilypond,Notation Reference}
[EMAIL PROTECTED] macro
+
@macro rprogram{TEXT}
program usage manual, @ref{\TEXT\,,,lilypond-program,Application Usage}
@end macro
[EMAIL PROTECTED] rprogramnamed{TEXT,DISPLAY}
+program usage manual, @ref{\TEXT\,,\DISPLAY\,lilypond-program,Application Usage}
[EMAIL PROTECTED] macro
+
@macro rlsr{TEXT}
@ref{\TEXT\,,,lilypond-snippets,Snippets}
@end macro
[EMAIL PROTECTED] rlsrnamed{TEXT,DISPLAY}
[EMAIL PROTECTED],,\DISPLAY\,lilypond-snippets,Snippets}
[EMAIL PROTECTED] macro
+
@macro rinternals{TEXT}
@vindex \TEXT\
@code{\TEXT\}
@end macro
[EMAIL PROTECTED] rinternalsnamed{TEXT,DISPLAY}
[EMAIL PROTECTED] \TEXT\
[EMAIL PROTECTED]
[EMAIL PROTECTED] macro
+
@end iftex
--
1.5.4.3
_______________________________________________
lilypond-devel mailing list
lilypond-devel@gnu.org
http://lists.gnu.org/mailman/listinfo/lilypond-devel
