[ 
https://issues.apache.org/jira/browse/DERBY-79?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_12519041
 ] 

Kim Haase commented on DERBY-79:
--------------------------------

I would like to close this longstanding issue. Three of the four requests have 
been completed. The last request -- providing hyperlinks across manuals -- is 
not practicable with the existing tools, for the following reasons:

1) In the HTML Pages version, the linked-to topic opens in the right-hand 
frame, replacing the current topic. However, the TOC remains that of the manual 
containing the link, not the manual linked to. This makes navigation extremely 
confusing. I don't see any way to correct this, given the way HTML frames work.

2) In the PDF and the HTML one-page versions, the links do not work at all. In 
the HTML one-page version, if the link in, for example, the Getting Started 
manual is to  "../adminguide/cadminnetservsecurity.dita#cadminnetservsecurity", 
the tools truncate it to "#cadminnetservsecurity" -- a link within the current 
manual, not the one linked to, and therefore a bad link. This could possibly be 
fixed in the tools, but it would be a separate issue.

> Provide Derby Documentation in PDF format and improve navigation
> ----------------------------------------------------------------
>
>                 Key: DERBY-79
>                 URL: https://issues.apache.org/jira/browse/DERBY-79
>             Project: Derby
>          Issue Type: Task
>          Components: Documentation
>            Reporter: John Sisson
>
> Since the format of the documentation is a recurring theme, this issue should 
> be tracked in JIRA.
> Summary of requirements from a user's perspective:
> * Provide manuals in a PDF format (one manual per PDF file, not PDF files for 
> every page, see mail thread in derby-dev below)
> * Improve navigation in HTML format.  For example, have left hand frame with 
> table of contents and less pages to navigate (see mail thread in derby-user 
> below)
> * Provide hyperlinks across manuals
> * Make it easier to search the manual (on the user's PC, not refering to the 
> Google search on the Derby web site).  PDFs will address this.  Having less 
> HTML pages would also help here.
> See the following email threads:
> http://nagoya.apache.org/eyebrowse/[EMAIL PROTECTED]&msgNo=199
> http://nagoya.apache.org/eyebrowse/[EMAIL 
> PROTECTED]&by=subject&from=651389&to=651389&first=1&count=15

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.

Reply via email to