Eclipse Contextual Help - PullRequest
Новая
       9

Eclipse Contextual Help

5 голосов
/ 18 июня 2009

Теперь я могу зарегистрировать контекстную справку в Eclipse WizardDialog / Editor.

1) Я создал файл 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) Я ссылался на этот файл в моем plugin.xml 

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

3) Я добавил строку в свой build.properties, чтобы включить этот файл в каталог bin (bin.includes = help_contexts.xml, ...)

4) При запуске моего плагина на основе GEF в динамической справке отображается «Не найдено совпадений для« my.plugin.MainEditor »».

Я знаю, что мне нужно где-то создать что-то подобное, но я не знаю, где это настроить для моего WizardDialog или, по крайней мере, для всего моего редактора: 

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

Примечание. Этот вопрос изначально содержал два вопроса. Я удалил первую (оставшуюся без ответа часть) для публикации в другом месте.

Ответы [ 2 ]

10 голосов
/ 20 июня 2009

Вот как вы это делаете: 1) Я создал файл help_contexts.xml. Не иметь периодов в контекстном идентификаторе. Не включайте там имя вашего плагина. 

<?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) Я ссылался на этот файл в моем plugin.xml Не включайте идентификатор плагина, если вы ссылаетесь на свой собственный плагин. 

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

3) Я добавил строку в свой build.properties, чтобы включить этот файл в каталог bin (bin.includes = help_contexts.xml, ...). Запишите свое Bundle-SymbolicName в вашем Manifest.MF (также видимом в вашем редакторе plugin.xml). Пример: my.plugin

4) Установите идентификатор контекста в WizardPage (кредит переходит на @VonC) 

public class MyWizardPage extends WizardPage
    public void createControl(Composite parent) {
        PlatformUI.getWorkbench.getHelpSystem.setHelp(parent, "my.plugin.help_general");
    }
}
3 голосов
/ 18 июня 2009

По основному вопросу, я не уверен насчет вашего второго параметра setHelp. См. эту тему :

В вызове метода 

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

вторым параметром является contextID.
Он должен начинаться с префикса pluginID, например: "pluginID.contextID".
Теперь я не был уверен, где найти идентификатор плагина для моего плагина.
Поэтому я использовал значение этого свойства: Bundle-Name Bundle-Symbolic-Name из MANIFEST.MF в качестве идентификатора плагина.
Теперь это работает.

Для sidenote (справка для WizardDialog), эта ветка может помочь (от Дэвида Кайла и его блог " Eclipse RCP "):

Мы устанавливаем идентификатор контекста на нашей странице мастера. 

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

и мы устанавливаем справку для диалогового окна мастера. 

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

Мы не отменяем performHelp().

Что касается идентификатора контекста справки. Определите контекстный XML-файл в вашем плагине. 

<?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>

в вашем плагине 

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

Распространенная проблема - испортить плагины и идентификаторы контекстной помощи. Вы можете установить пара точек останова, чтобы увидеть, какой идентификатор контекста запрашивается.

...