db-derby-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Kim Haase <Camilla.Ha...@Sun.COM>
Subject Re: What is the syntax for cross-manual references in the docs?
Date Mon, 11 May 2009 14:33:03 GMT
Hi, Bryan,

We use <xref> for cross-references within a manual, but for 
cross-references between manuals we just say

   See "section title" in Book Title.

Or something like that -- to make it as clear as possible where to look.

The problem is that <xref> tags that refer to other books appear to work 
okay in the HTML pages versions of the books -- but what happens is that 
the linked-to topic appears in the right frame, but the left frame still 
contains the TOC of the book from which the link was made -- very 
disorienting. And the links don't work at all in the PDF versions or the 
one-page HTML versions -- they appear to be active, but they don't go 

This is a longstanding issue with the manuals for which there appears to 
be no solution.


On 05/08/09 19:16, Bryan Pendleton wrote:
> I'm working on fine tuning some of the new XPLAIN table docs,
> and one of the suggestions was:
>   [in the Tuning guide] in this topic you might want to point people to
>   the Reference Manual for info about the tables
> I think this is a great idea, but I'm not sure what the proper syntax
> is to pull this off. Is this where I use a <xref> tag?
> Specifically, if I want to change a page in the *Tuning* guide to
> have a reference to the rref_xplain_tables.dita#rref_xplain_tables 
> reference
> topic in the *Reference* guide, what syntax do I need? Is it something 
> like:
>   <xref href="../ref/rref_xplain_tables.dita#rref_xplain_tables">See the
>   XPLAIN tables section in the Reference guide for more detail.</xref>
> thanks,
> bryan

View raw message