Ayuda contextual de Eclipse

Question

Ahora puedo registrar ayuda contextual en un Eclipse WizardDialog/Editor.

1) Creé un archivo help_contexts.xml.

<?xml version="1.0" encoding="UTF-8"?> 
<?NLS TYPE="org.eclipse.help.contexts"?> 
<contexts> 
    <context id="my.plugin.help.general" > 
     <description>test</description> 
     <topic label="test" href="http://domain.com/help.html"/> 
    </context> 
</contexts> 

2) hice referencia a este archivo en mi plugin.xml

<extension 
     point="org.eclipse.help.contexts"> 
     <contexts file="help_contexts.xml" plugin="my.plugin.MainEditor"> 
     </contexts> 
    </extension> 

3) he añadido una línea en mis build.properties para incluir este archivo en el directorio bin (bin.includes = help_contexts .xml, ...)

4) Cuando ejecuto mi complemento basado en GEF, veo "No se encontraron coincidencias para" my.plugin.MainEditor "" en la ayuda dinámica.

Sé que necesito para crear algo como esto en alguna parte, pero no saben dónde instalar esto para mi WizardDialog o al menos para toda mi editor:

public void createPartControl(Composite parent) { 
     ... 
     PlatformUI.getWorkbench().getHelpSystem().setHelp(parent, 
     "my.plugin.help.general"); 
    } 

Nota: Esta pregunta contenida originalmente Dos preguntas. He eliminado la primera (parte no respondida) que se publicará en otro lugar.

Answer 1

Así es como lo haces: 1) Creé un archivo help_contexts.xml. No tiene puntos en el ID de contexto. No incluya su nombre de complemento allí.

<?xml version="1.0" encoding="UTF-8"?> 
<?NLS TYPE="org.eclipse.help.contexts"?> 
<contexts> 
    <context id="help_general" > 
     <description>test</description> 
     <topic label="test" href="http://domain.com/help.html"/> 
    </context> 
</contexts> 

2) que hace referencia este archivo en mi plugin.xml No incluya el plugin-id si se hace referencia a su propio plugin.

<extension 
     point="org.eclipse.help.contexts"> 
     <contexts file="help_contexts.xml"> 
     </contexts> 
    </extension> 

3) que añade una línea en mis build.properties para incluir este archivo en el directorio bin (bin.includes = help_contexts.xml, ...). Tenga en cuenta su Bundle-SymbolicName en su Manifest.MF (también visible en su editor plugin.xml). Ejemplo: my.plugin

4) Ajuste el ID de contexto en el wizardpage (mérito es de @VonC)

public class MyWizardPage extends WizardPage 
    public void createControl(Composite parent) { 
     PlatformUI.getWorkbench.getHelpSystem.setHelp(parent, "my.plugin.help_general"); 
    } 
} 

Answer 2

Para la pregunta principal, no estoy seguro acerca de su segundo parámetro setHelp. Ver this thread:

En la llamada al método

PlatformUI.getWorkbench().getHelpSystem().setHelp() 

segundo parámetro es el contextID.
Debe tener el prefijo pluginID como: "pluginID.contextID".
Ahora no estaba seguro de dónde encontrar el ID de complemento para mi complemento.
Así que utilicé el valor de esta propiedad: Bundle-NameBundle-Symbolic-Name de MANIFEST.MF como la identificación del plug-in.
Ahora funciona.

---

Para la anotación al margen (ayuda para WizardDialog), this thread podría ayudar (de David Kyle y su blog "Eclipse RCP"):

Hemos establecido el ID de contexto en nuestra página del asistente.

public class MyWizardPage extends WizardPage 
    public void createControl(Composite parent) { 
     PlatformUI.getWorkbench.getHelpSystem.setHelp(parent, 
MyPluginActivator.ID + ".mycontexthelpid"); 
    } 
} 

y conjunto de ayudas para el diálogo del asistente.

WizardDialog dialog = new WizardDialog(.....); 
PlatformUI.getWorkbench().getHelpSystem().setHelp(dialog.getShell(), 
"mycontexthelp.id"); 

Nosotros no anulan performHelp().

En cuanto a la ayuda contexto id. Define un archivo xml de contexto en tu complemento.

<?xml version="1.0" encoding="UTF-8"?> 
<?NLS TYPE="org.eclipse.help.contexts"?> 
<contexts> 
    <context id="mycontexthelpid" > 
     <description>My wizard help.</description> 
     <topic label="Wizard help" href="reference/wizard/help.xhtml"/> 
    </context> 
</contexts> 

en su plugin

<plugin> 
    <extension point="org.eclipse.help.contexts"> 
     <contexts file="mywizard.xml" plugin="com.mypluginid"/> 
    </extension> 
</plugin> 

Un problema común es echar a perder los identificadores de plugin y ayuda contextual. Puede establecer un par de puntos de interrupción para ver qué ID de contexto se solicita.