280354 – [Help] Action for doc plugins that reside locally and remotely

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

Bug 280354 - [Help] Action for doc plugins that reside locally and remotely

Summary: [Help] Action for doc plugins that reside locally and remotely

Status:	RESOLVED FIXED

Alias:	None

Product:	Platform
Classification:	Eclipse Project
Component:	User Assistance (show other bugs)
Version:	3.5
Hardware:	PC Windows XP

Importance:	P3 normal (vote)
Target Milestone:	3.6 M4
Assignee:	Jim Perry
QA Contact:

URL:
Whiteboard:
Keywords:

Depends on:
Blocks:

Reported:	2009-06-15 17:00 EDT by Chris Austin
Modified:	2009-11-30 16:23 EST (History)
CC List:	2 users (show)

See Also:

Attachments
Patch for org.eclipse.help.base (8.46 KB, patch) 2009-11-30 14:21 EST, Jim Perry	no flags	Details \| Diff
Patch for org.eclipse.help (5.83 KB, text/plain) 2009-11-30 14:22 EST, Jim Perry	no flags	Details
Patch for org.eclipse.help.ui (16.19 KB, patch) 2009-11-30 14:22 EST, Jim Perry	no flags	Details \| Diff
Patch for org.eclipse.ua.tests (16.47 KB, patch) 2009-11-30 14:24 EST, Jim Perry	no flags	Details \| Diff
Patch for remote ordering (46.89 KB, patch) 2009-11-30 14:46 EST, Jim Perry	cgold: iplog+	Details \| Diff
Show Obsolete (4) 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 Austin

2009-06-15 17:00:40 EDT

Build ID: 3.5

When a documentation plugin exists locally and can also be found on a remote help server, we need to decide what action to take.  Should we take the most up to date help information, or allow the user to specify an option?

Comment 1 Chris Goldthorpe

2009-06-15 17:36:18 EDT

Interesting question. This affects not only the table of contents but also search, index and content. It seems to me that usually the most recent version of a document will be the most useful but only if it does not contain description of features which have been added in later versions of the product which the user does not have. I don't particularly like the idea of adding a preference as a way out of the problem because then we are just punting the problem back to the user, who is also unlikely to know which choice to make.

Comment 2 Jim Perry

2009-11-30 14:21:37 EST

Created attachment 153380 [details]
Patch for org.eclipse.help.base

Comment 3 Jim Perry

2009-11-30 14:22:01 EST

Created attachment 153381 [details]
Patch for org.eclipse.help

Comment 4 Jim Perry

2009-11-30 14:22:24 EST

Created attachment 153382 [details]
Patch for org.eclipse.help.ui

Comment 5 Jim Perry

2009-11-30 14:24:01 EST

Created attachment 153383 [details]
Patch for org.eclipse.ua.tests

Comment 6 Jim Perry

2009-11-30 14:24:59 EST

The patches included include fixes for:

- UI for determining whether to use local/remote as prioity
- TocManager changes for handling duplicate TocContributions
- JUnit tests for all scenarios

Comment 7 Jim Perry

2009-11-30 14:46:10 EST

Created attachment 153388 [details]
Patch for remote ordering

Comment 8 Chris Goldthorpe

2009-11-30 16:23:24 EST

Patch applied with the few minor changes listed below:

Fixed copyrights in:

AbstractTocProvider.java
RemoteTocProvider.java
HelpContentPreferencePage.java
RemoteICViewer.java

in Messages.properties delete the unused resource
HelpContentPreferencePage_remote=&Include help content from a remote infocenter