You are viewing a plain text version of this content. The canonical link for it is here.
Posted to derby-dev@db.apache.org by "John Sisson (JIRA)" <de...@db.apache.org> on 2004/11/23 06:48:18 UTC
[jira] Created: (DERBY-79) Provide Derby Documentation in PDF format and improve navigation
Provide Derby Documentation in PDF format and improve navigation
----------------------------------------------------------------
Key: DERBY-79
URL: http://nagoya.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://nagoya.apache.org/jira/secure/Administrators.jspa
-
If you want more information on JIRA, or have a bug to report see:
http://www.atlassian.com/software/jira
[jira] Commented: (DERBY-79) Provide Derby Documentation in PDF format and improve navigation
Posted by "John Sisson (JIRA)" <de...@db.apache.org>.
[ http://nagoya.apache.org/jira/browse/DERBY-79?page=comments#action_56246 ]
John Sisson commented on DERBY-79:
----------------------------------
Also see thread
http://nagoya.apache.org/eyebrowse/BrowseList?listName=derby-dev@db.apache.org&by=thread&from=950534
> Provide Derby Documentation in PDF format and improve navigation
> ----------------------------------------------------------------
>
> Key: DERBY-79
> URL: http://nagoya.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://nagoya.apache.org/jira/secure/Administrators.jspa
-
If you want more information on JIRA, or have a bug to report see:
http://www.atlassian.com/software/jira
[jira] Resolved: (DERBY-79) Provide Derby Documentation in PDF
format and improve navigation
Posted by "Kim Haase (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/DERBY-79?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Kim Haase resolved DERBY-79.
----------------------------
Resolution: Fixed
Fix Version/s: 10.1.1.0
Please reopen if you disagree with resolving it.
> 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
> Fix For: 10.1.1.0
>
>
> 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.
-
You can reply to this email to add a comment to the issue online.
[jira] Commented: (DERBY-79) Provide Derby Documentation in PDF
format and improve navigation
Posted by "Andrew McIntyre (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/DERBY-79?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_12519149 ]
Andrew McIntyre commented on DERBY-79:
--------------------------------------
Kim, issue #1 in your comment above, linking to other manuals, could be solved by having the links open in a new window by adding a target attribute to the link, e.g. <a target="derbymanual" href="../ref/rrefderby.html"/>
The DITA toolkit would need to be modified to add that attribute, and as such, should probably be handled as 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
> Fix For: 10.1.1.0
>
>
> 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.
-
You can reply to this email to add a comment to the issue online.
[jira] Commented: (DERBY-79) Provide Derby Documentation in PDF format and improve navigation
Posted by "Jeff Levitt (JIRA)" <de...@db.apache.org>.
[ 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
[jira] Closed: (DERBY-79) Provide Derby Documentation in PDF format
and improve navigation
Posted by "Kim Haase (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/DERBY-79?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Kim Haase closed DERBY-79.
--------------------------
Issue was resolved a long time ago; closing.
> 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
> Fix For: 10.1.1.0
>
>
> 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.
-
You can reply to this email to add a comment to the issue online.
[jira] Commented: (DERBY-79) Provide Derby Documentation in PDF
format and improve navigation
Posted by "Kim Haase (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/DERBY-79?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_12519711 ]
Kim Haase commented on DERBY-79:
--------------------------------
Thanks, Andrew, for this suggestion. I filed a new issue (DERBY-3006).
> 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
> Fix For: 10.1.1.0
>
>
> 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.
-
You can reply to this email to add a comment to the issue online.
[jira] Commented: (DERBY-79) Provide Derby Documentation in PDF
format and improve navigation
Posted by "Kim Haase (JIRA)" <ji...@apache.org>.
[ 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/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.
-
You can reply to this email to add a comment to the issue online.