Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.

Bug 254757

Summary: Eclipse HTML documentation doesn't consistently have next-page links
Product: Community Reporter: Daniel B. <dsb>
Component: Cross-ProjectAssignee: Cross-Project issues <cross-project.inbox>
Status: RESOLVED WONTFIX QA Contact:
Severity: normal    
Priority: P3 CC: david_williams, denis.roy
Version: unspecified   
Target Milestone: ---   
Hardware: PC   
OS: Windows XP   
Whiteboard:

Description Daniel B. CLA 2008-11-10 11:32:12 EST
Build ID: N/A

In Eclipse HTML documentation (e.g., rooted at 
http://help.eclipse.org/ganymede/index.jsp), it seems that
in many sections the pages don't have a next-page link. 
This omission makes it unnecessarily inconvenient for the 
reader, who must jump back and forth between the tree pane
(frame) and the page pane and must manually implement the 
in-order tree-traversal algorithm when reading through 
the documentation pages in order.

In contrast, for sections that do have next-page links,
such as the Java user development guide . Getting Started
. Basic tutorial section (at
http://help.eclipse.org/stable/index.jsp?topic=/org.eclipse.jdt.doc.user/gettingStarted/qs-BasicTutorial.htm
), when done reading the each page, the reader can simply
click on the "Next Section: ..." link at the bottom of each
page to get to the next page (defined as next in the sense 
of in-order tree traversal, and frequently the logically
next text to read).


Steps To Reproduce:
1. Start at 
   http://help.eclipse.org/stable/index.jsp?topic=/org.eclipse.jdt.doc.user/gettingStarted/qs-BasicTutorial.htm
   (a page in a section _with_ next-page links).
2. Scroll to the bottom of the page (as if finished reading
   it).
3. Click on the "Next Section: ..." link.
4. Repeat steps 2 and 3 several times.
5. Notice how conveniently the Next Sections links take 
   you through the sections. 

6. Start at 
   
http://help.eclipse.org/stable/index.jsp?topic=/org.eclipse.jdt.doc.user/gettingStarted/qs-BasicTutorial.htm
   (a page in a section _without_ next-page links).
7. Note that going to the next page requires either 
   first figuring out which link in the "Related Concepts"
   section is for the next page before clicking on it 
   (which doesn't work when at a leaf not with no
   following sibling), or:
   - going to the tree view pane
   - sometimes first finding the current page's node 
     in the tree (or clicking on the Synchronize icon)
   - sometimes opening a tree node (sometimes also having
     to scroll horizontally to get to the +/- icon
   - clicking on the next node's link
8. Repeat several times, noting the variation when 
   traversing up and down levels in the tree.



More information:
Comment 1 Denis Roy CLA 2008-11-10 13:30:19 EST
This is quite tricky.  Because each project is responsible for their own doc plugins, I'm moving to cross-project for consideration.
Comment 2 David Williams CLA 2010-06-14 02:17:17 EDT
Sorry to not be more responsive. If you see in Helios help (available in a week or two) please open a new bug and maybe it'll get attention then, if still broken.