Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.
Bug 286177 - [Webapp] Allow additional views to be added to the help webapp
Summary: [Webapp] Allow additional views to be added to the help webapp
Status: VERIFIED FIXED
Alias: None
Product: Platform
Classification: Eclipse Project
Component: User Assistance (show other bugs)
Version: 3.5   Edit
Hardware: PC Windows XP
: P3 enhancement (vote)
Target Milestone: 3.6 M2   Edit
Assignee: Chris Goldthorpe CLA
QA Contact:
URL:
Whiteboard:
Keywords:
: 107672 (view as bug list)
Depends on:
Blocks: 288558
  Show dependency tree
 
Reported: 2009-08-10 16:54 EDT by Chris Goldthorpe CLA
Modified: 2009-10-14 23:48 EDT (History)
2 users (show)

See Also:

Attachments
Patch to create extension point for extra views (6.97 KB, patch)
2009-08-10 16:55 EDT, Chris Goldthorpe CLA 		no flags Details | Diff
Patch, August 25 2009 (25.91 KB, patch)
2009-08-25 17:11 EDT, Chris Goldthorpe CLA 		no flags Details | Diff
Test bundle (10.37 KB, application/x-zip-compressed)
2009-08-25 17:14 EDT, Chris Goldthorpe CLA 		no flags Details
Patch as committed (28.25 KB, patch)
2009-09-08 15:48 EDT, Chris Goldthorpe CLA 		no flags Details | Diff
Changes to org.eclipse.ua.tests (11.21 KB, patch)
2009-09-08 15:59 EDT, Chris Goldthorpe CLA 		no flags Details | Diff
Show Obsolete (2) 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 Chris Goldthorpe CLA 2009-08-10 16:54:08 EDT 
Currently the help webapp displays tabs for contents, search, index and bookmarks. An IBM team has a contribution which I will attach which allows additional views to be created.
Comment 1 Chris Goldthorpe CLA 2009-08-10 16:55:11 EDT 
Created attachment 143965 [details]
Patch to create extension point for extra views
Comment 2 Lee Anne Kowalski CLA 2009-08-10 20:57:21 EDT 
*** Bug 107672 has been marked as a duplicate of this bug. ***
Comment 3 Chris Goldthorpe CLA 2009-08-25 17:11:05 EDT 
Created attachment 145596 [details]
Patch, August 25 2009

The original patch did not handle all the cases it needed to. In particular the name of the tab cannot be a static attribute in the extension point because it needs to be translatable into different languages. The solution to this is to define the extension point in terms of a class (AbstractView) which contains methods to get the different presentations.

Because AbstractView class is an API class it needs to be in a non-internal package and the use of AbstractView has required the jsp files which deal with views to reference AbstractView instead of View. Additionally I have made some modifications so that a different presentation can be used in the Basic/Advanced modes. Other changes I have made are:
1. Change the extension point name from "tab" to "view" to be consistent with existing terminology.
2. Modify the image handling code to not insert an 'e' character in the image path.
3. Remove the preference "infocenterContext" which the previous patch added.

There may be more methods we want to add to AbstractView. It may be useful to add a test for enablement. There are two other strings which are localized for existing tabs, these are the frame titles for the View and the ViewToolbar. These do not appear to be user visible but may be readable by a screenreader.
Comment 4 Chris Goldthorpe CLA 2009-08-25 17:14:58 EDT 
Created attachment 145601 [details]
Test bundle

This bundle works with the previous patch.
Comment 5 Chris Goldthorpe CLA 2009-09-08 15:48:14 EDT 
Created attachment 146699 [details]
Patch as committed

I added isEnabled functions for both the basic and advanced presentations.
Comment 6 Chris Goldthorpe CLA 2009-09-08 15:59:10 EDT 
Created attachment 146700 [details]
Changes to org.eclipse.ua.tests

I thought it was important to test this feature using a realistic example so I created an extra view in org.eclipse.ua.tests. This view allows for searching of text in topic titles.
Comment 7 Chris Goldthorpe CLA 2009-09-08 16:01:58 EDT 
Changes committed to HEAD, fixed.
Comment 8 Hao Zhang CLA 2009-10-14 22:06:21 EDT 
Verified in N20091012-2000.