Bug 469233 - Support alternative URL for cross-plugin references pointing to optional bundles
Summary: Support alternative URL for cross-plugin references pointing to optional bundles
Status: NEW
Alias: None
Product: Platform
Classification: Eclipse Project
Component: User Assistance (show other bugs)
Version: 4.5   Edit
Hardware: All All
: P4 enhancement (vote)
Target Milestone: ---   Edit
Assignee: Platform UI Triaged CLA
QA Contact:
URL:
Whiteboard:
Keywords: helpwanted
Depends on:
Blocks: 467060
  Show dependency tree
 
Reported: 2015-06-03 04:05 EDT by Alexander Nyßen CLA
Modified: 2015-07-25 05:26 EDT (History)
1 user (show)

See Also:

Attachments
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 Alexander Nyßen CLA 2015-06-03 04:05:51 EDT 
While references to help that is provided by other plug-ins is already supported by means of the "PLUGINS_ROOT/another_plugin_id" notation, it would be nice to have support for providing an alternative url in case the other plug-in is not installed (an the link would thus be broken). 

There may be cases where it is not desired to ensure (by means of a bundle dependency) that the other plugin referenced in the help is actually installed. However, if the plugin is present, it would be preferable to use a local link rather than an absolute URL that points to a server (which is possible via the PLUGINS_ROOT support). 

To support such scenarios, it would be nice if an alternative url could be provided, either by encoding it into the PLUGINS_ROOT-href (which would IMHO be more flexible), or by simply using the alt tag for this purpose (which would probably be easier to realize).
Comment 1 Brian de Alwis CLA 2015-06-03 09:56:23 EDT 
Perhaps we could support a separate look-up table that would map plugin ids to a backup server?  That way the original help files aren't cluttered with external server names, plus older documentation can benefit with no change required.