Bug 330766 - Better navigation for sub-sections in 'Tips and Tricks' and 'What's new' documents
Summary: Better navigation for sub-sections in 'Tips and Tricks' and 'What's new' docu...
Status: VERIFIED FIXED
Alias: None
Product: JDT
Classification: Eclipse Project
Component: Doc (show other bugs)
Version: 3.7   Edit
Hardware: All All
: P3 enhancement (vote)
Target Milestone: 3.7 RC3   Edit
Assignee: Deepak Azad CLA
QA Contact:
URL:
Whiteboard:
Keywords: Documentation
Depends on:
Blocks:
 
Reported: 2010-11-21 22:50 EST by Deepak Azad CLA
Modified: 2011-05-25 03:10 EDT (History)
3 users (show)

See Also:


Attachments
proposed fix (2.17 KB, patch)
2011-05-10 10:56 EDT, Deepak Azad CLA
no flags Details | Diff
Picture showing the new look (46.40 KB, image/png)
2011-05-11 07:23 EDT, Dani Megert CLA
no flags Details

Note You need to log in before you can comment on or make changes to this bug.
Description Deepak Azad CLA 2010-11-21 22:50:30 EST
The Tips and Tricks document is huge
- To navigate to a different section in the document you have to scroll all the way up to click on a section link. 

- If you are reading a tip, it is not readily evident which section you are in. The 'back' and 'forward' buttons also do not work for intra-document navigation. Hence if you scroll somewhere in the document (e.g scroll up to go to a different section) it is extremely difficult to go back to the last tip you were reading.
Comment 1 Dani Megert CLA 2010-11-22 03:28:49 EST
Some clean up won't hurt here.
Comment 2 Dani Megert CLA 2010-11-22 03:29:30 EST
If we do this, then we must also do it for Platform and PDE.
Comment 3 Deepak Azad CLA 2010-11-22 03:57:22 EST
(In reply to comment #2)
> If we do this, then we must also do it for Platform and PDE.
For platform yes, but the PDE document is only about 2 pages long.
Comment 4 Dani Megert CLA 2010-11-22 04:05:09 EST
(In reply to comment #3)
> (In reply to comment #2)
> > If we do this, then we must also do it for Platform and PDE.
> For platform yes, but the PDE document is only about 2 pages long.
Might be. But if we introduce a new "format" for T&T and/or N&N then they should be in sync.
Comment 5 Deepak Azad CLA 2011-05-10 10:56:42 EDT
Created attachment 195229 [details]
proposed fix

Dani, how about this patch ?

I have kept the document as is and added the links for each section to the navigation tree on the left e.g. tips/jdt_tips.html#debugging_section

(In reply to comment #0)
> The Tips and Tricks document is huge
> - To navigate to a different section in the document you have to scroll all the
> way up to click on a section link. 
Navigating to a different section works nicely now.

> - If you are reading a tip, it is not readily evident which section you are in.
> The 'back' and 'forward' buttons also do not work for intra-document
> navigation. Hence if you scroll somewhere in the document (e.g scroll up to go
> to a different section) it is extremely difficult to go back to the last tip
> you were reading.
Back and forward buttons also work.. almost. If you scroll, then sometimes the buttons get confused :)

Often I use Ctrl+F to find a particular tip, if we stick to a single document I can continue to use Ctrl+F.

=> Overall I prefer this solution to splitting the document in sub-pages.
Comment 6 Dani Megert CLA 2011-05-11 07:22:20 EDT
Good idea! Markus and I like it too.

John, how do you like it? If we go ahead with this then I'd like to also do this for 'What's New' and of course also for Platform and PDE. Deepak could do the work ;-).
Comment 7 Dani Megert CLA 2011-05-11 07:23:55 EDT
Created attachment 195326 [details]
Picture showing the new look
Comment 8 John Arthorne CLA 2011-05-11 13:30:01 EDT
Yes, that looks good to me. Don't bother doing anything with the current What's new sections - those will all be completely replaced soon (starting to work on that this week).
Comment 9 Deepak Azad CLA 2011-05-12 09:02:15 EDT
Filed bug 345590 for platform, and attached the fix for tips and tricks document to that bug. 

There is nothing to do in PDE tips and tricks document as there are no sub-sections, opened bug 345592 for the What's new document.

(In reply to comment #5)
> Created attachment 195229 [details] [diff]
> proposed fix
Released this patch to HEAD.
Comment 10 Dani Megert CLA 2011-05-16 04:24:49 EDT
Verified Tips and Tricks for RC1. Keeping the bug open for the What's New part.
Comment 11 Deepak Azad CLA 2011-05-24 02:21:34 EDT
Added toc for What's new part as well.
Comment 12 Dani Megert CLA 2011-05-25 03:10:55 EDT
Verified in I20110524-0900.