[jbosstools-issues] [JBoss JIRA] (JBIDE-2032) Help button works not in all wizards.

[Denis Golovin (JIRA)]

    [ https://issues.jboss.org/browse/JBIDE-2032?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12947052#comment-12947052 ] 

Denis Golovin commented on JBIDE-2032:
--------------------------------------

It looks like we can finally get decent help for all JBossTools/JBDS related features. It could be done by installing documentation features from p2 repo or by connecting local help information center to remote one:
1. We should deploy remote Information Center with JBT/JBDS documentation in eclipse format (I hope it cold be generated out of current documentation).
2. Every JBoss Tools UI Element like: New Wizard, Editor, Dialog, View should have set help context through call
{code}PlatformUI.getWorkbench().getHelpSystem().setHelp(container, "plugin.id.<uielementname>_<name>");{code}
where: 
* <uielementname> could be one of: newwizard, dialog, editor, view and e.t.c
* <name> is readable feature name

For example for new JSF Project Wizard it would be "org.jboss.tools.jsf.ui.newwizard_jsfproject

If no context help requires then default context id should be used for example "org.jboss.tools.foundation.help.default"

3. org.jboss.tools.foundation.help registers so called Global Help Context Provider which process requested help context if itis not found by other context providers: 
* RemoteContextProvider (loads context from remote Info Center server(s) registered in preferences Help->Content)
* FileContextProvider (load conext help form xml files defined through org.eclipse.help.bas.contexts extension point, which is usually done in documentation bundles)

So if doc plugins (which usually defines context help) are not installed or not available from remote info center then control gets int global provider and it generates default page for context help with:
* short description
* link to external site 
* command to call documentation feature installation out of JBoss Central
* command to register remote info center with JBoss Tools documentation

Default context help by default is generated for JBoss Tools, but could be overriden in JBDS or other JBoss Tools Based product.

Tested this approach on local build with local info center and it works as expected.

                
> Help button works not in all wizards.
> -------------------------------------
>
>                 Key: JBIDE-2032
>                 URL: https://issues.jboss.org/browse/JBIDE-2032
>             Project: Tools (JBoss Tools)
>          Issue Type: Bug
>          Components: help
>    Affects Versions: 2.1.0.beta1
>            Reporter: Anton Klimkovich
>            Assignee: Denis Golovin
>            Priority: Minor
>             Fix For: 4.2.x
>
>         Attachments: CreateJSFLibrary.PNG, DriverDefinitions.PNG, EditDriverDefinitions.PNG, InstallNewServerAdapter.PNG, JSFImplementationLibrary.PNG, NewConnectionProfile.PNG, NewDriverDefinitions.PNG, NewSeamRuntime.PNG, NewServer.PNG, Resource - Eclipse Platform _028.png
>
>
> Wizards with non-working help button attached.

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira