db-derby-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Jeff Levitt (JIRA)" <derby-...@db.apache.org>
Subject [jira] Commented: (DERBY-79) Provide Derby Documentation in PDF format and improve navigation
Date Thu, 21 Apr 2005 04:16:35 GMT
     [ http://issues.apache.org/jira/browse/DERBY-79?page=comments#action_63359 ]
     
Jeff Levitt commented on DERBY-79:
----------------------------------

Updated status on this issue

Of the requirements first listed in this issue:

* Provide manuals in a PDF format (one manual per PDF file, not PDF files for every page...)
- This is complete, as the Manuals page of the Derby website now links to nightly PDF builds
of the docs, and includes a process for users to create their own PDF's from the source. 
While the PDF's are still not perfect, there will always be ways to improve them, so this
is a neverending task.

* Improve navigation in HTML format. For example, have left hand frame with table of contents
and less pages to navigate...
-  This is complete, as the Manuals page of the Derby website now links to nightly html builds
of the docs, complete with a navigation page.

* Provide hyperlinks across manuals
-  Not yet complete.  These will have to be hard-coded in...

* 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.

- This is complete (see first two bullets above)

So the one remaining item on this list is the links between Manuals.

> Provide Derby Documentation in PDF format and improve navigation
> ----------------------------------------------------------------
>
>          Key: DERBY-79
>          URL: http://issues.apache.org/jira/browse/DERBY-79
>      Project: Derby
>         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/ReadMsg?listName=derby-user@db.apache.org&msgNo=199
> http://nagoya.apache.org/eyebrowse/BrowseList?listName=derby-dev@db.apache.org&by=subject&from=651389&to=651389&first=1&count=15

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
   http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see:
   http://www.atlassian.com/software/jira


Mime
View raw message