Bug 99695 - We need dedicated topics to link from the Welcome's Overview page
Summary: We need dedicated topics to link from the Welcome's Overview page
Status: VERIFIED FIXED
Alias: None
Product: JDT
Classification: Eclipse Project
Component: Doc (show other bugs)
Version: 3.1   Edit
Hardware: PC Linux-GTK
: P1 normal (vote)
Target Milestone: 3.1 RC4   Edit
Assignee: JDT-Doc-Inbox CLA
QA Contact:
URL:
Whiteboard:
Keywords: Documentation
: 89770 100774 (view as bug list)
Depends on:
Blocks:
 
Reported: 2005-06-13 11:30 EDT by Douglas Pollock CLA
Modified: 2005-06-27 05:17 EDT (History)
5 users (show)

See Also:

Attachments
Screenshot showing the problem (109.68 KB, image/png)
2005-06-13 11:31 EDT, Douglas Pollock CLA 		no flags Details
A draft overivew topic (2.22 KB, patch)
2005-06-21 17:43 EDT, Dejan Glozic CLA 		no flags Details | Diff
An enhanced draft (2.80 KB, patch)
2005-06-22 12:14 EDT, Dejan Glozic CLA 		no flags Details | Diff
JDT overview page with dynamic related links. (2.22 KB, patch)
2005-06-22 19:49 EDT, Dejan Glozic CLA 		no flags Details | Diff
Show Obsolete (1) View All Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
Description Douglas Pollock CLA 2005-06-13 11:30:40 EDT 
3.1 RC2, GTK+ 2.6.7, Mozilla 1.7.8, KDE 3.3.2, X.org 6.8.2, Linux 2.6.11

The "Overview" of "Java Development" consists of one sentence pointing you at a
tutorial for which there is no link.
Comment 1 Douglas Pollock CLA 2005-06-13 11:31:32 EDT 
Created attachment 22938 [details]
Screenshot showing the problem
Comment 2 Billy Biggs CLA 2005-06-13 11:36:26 EDT 
I tried this in Eclipse 3.0.2 on Linux.  When I clicked on "Java development",
it opened a Help window which had the full navigation sidebar.
Comment 3 Dejan Glozic CLA 2005-06-13 11:37:24 EDT 
It is on my list to produce topics created specifically for linking from 
the 'Overview' page. Right now none of the links point at the page that is 
fully suitable for this role, but JDT one is tragic.
Comment 4 Dejan Glozic CLA 2005-06-21 17:31:57 EDT 
Added dedicated PDE topic. Platform topic is good enough.

I am attaching a patch with a dummy overview page for JDT. I hooked it where 
needed and pointed Welcome at it. All you need to do is fill a few paragraph 
of text to highlight main JDT features to new users and add links to related 
concepts and tasks.

Moving.
Comment 5 Dejan Glozic CLA 2005-06-21 17:43:52 EDT 
Created attachment 23674 [details]
A draft overivew topic
Comment 6 Dejan Glozic CLA 2005-06-22 11:50:01 EDT 
I have found a better way to do overview that will also allow related links in 
the document to open in the help window (and therefore have the benefit of the 
TOC). I will attach a replacement patch.
Comment 7 Dejan Glozic CLA 2005-06-22 12:14:30 EDT 
Created attachment 23749 [details]
An enhanced draft

With this draft, Overview will still show up in the search but will not show in
TOC. In addition, all the related links will open into a separate help window,
ensuring context for topics.
Comment 8 Dejan Glozic CLA 2005-06-22 19:48:05 EDT 
We have identified a scenario where the related links in the overview document 
do not work. It will happen on platform where Forms-based intro is used 
(because embedded browser cannot be used).

We devised a solution whereby we open links using Java Script and pick the URL 
depending on whether the page is embedded in the Welcome container or is part 
of the Help window.

Please apply the attached patch (I already updated platform and PDE overview 
documents).
Comment 9 Dejan Glozic CLA 2005-06-22 19:49:18 EDT 
Created attachment 23799 [details]
JDT overview page with dynamic related links.

This patch should be applied to the latest code from HEAD (as of 7:52PM).
Comment 10 Dirk Baeumer CLA 2005-06-23 11:10:56 EDT 
This got added for N20050623-0010. The page has a shor description of JDT with
links to the relevant documents in the help section.
Comment 11 Martin Aeschlimann CLA 2005-06-23 11:13:46 EDT 
verified in 20050623-0010
Comment 12 Dirk Baeumer CLA 2005-06-26 03:39:43 EDT 
*** Bug 89770 has been marked as a duplicate of this bug. ***
Comment 13 Martin Aeschlimann CLA 2005-06-27 05:17:43 EDT 
*** Bug 100774 has been marked as a duplicate of this bug. ***