![[きのさいと]](image/kinosite.png "[きのさいと]"){kind=small}
Eclipseのヘルプはワークベンチのメニューの
ヘルプ >> ヘルプ目次
にありますが、このhtmlベースのヘルプも拡張して好きなヘルプを載せることができます。そして拡張するための拡張ポイントがorg.eclipse.help.toc拡張ポイントです。
この拡張ポイントで目次となるファイル(xml形式)を指定し、そのxmlファイルで目次に対応するhtmlファイルを指定します。
org.eclipse.help.toc
org.eclipse.help.appserver org.eclipse.help.base org.eclipse.help.ui org.eclipse.help.webapp org.eclipse.tomcat
<extension
point="org.eclipse.help.toc">
<toc primary="true" file="toc.xml"/> <-トップの目次となるxmlファイル。
<toc file="tocconcepts.xml"/>
<toc file="tocgettingstarted.xml"/>
<toc file="tocreference.xml"/>
<toc file="tocsamples.xml"/>
<toc file="toctasks.xml"/>
</extension>
<?xml version="1.0" encoding="UTF-8"?>
<?NLS TYPE="org.eclipse.help.toc"?>
<toc label="Sample Table of Contents" topic="html/toc.html">
↑目次のSample Table of Contents をクリックしたときに
表示されるhtmlはhtml/toc.htmlです、の意味
<topic label="Getting Started">
<anchor id="gettingstarted"/>
</topic>
<topic label="Concepts"> <-目次にConceptsと表示
<anchor id="concepts"/> <-toc.xml#conceptsとなってる箇所をここに挿入
</topic>
<topic label="Tasks">
<anchor id="tasks"/>
</topic>
<topic label="Reference">
<anchor id="reference"/>
</topic>
<topic label="Samples">
<anchor id="samples"/>
</topic>
</toc>
<?xml version="1.0" encoding="UTF-8"?>
<?NLS TYPE="org.eclipse.help.toc"?>
<toc label="Concepts" link_to="toc.xml#concepts"> <-ここでリンクされてる
<topic label="Main Topic" href="html/concepts/maintopic.html">
<topic label="Sub Topic" href="html/concepts/subtopic.html" />
</topic>
<topic label="Main Topic 2">
<topic label="Sub Topic 2" href="html/concepts/subtopic2.html" />
</topic>
</toc>
ActionFactory.HELP_CONTENTS.create(window)
でアクションを取得できます。このクラスは実体は
org.eclipse.ui.internal.actions.HelpContentsAction
なのですが、このrunメソッドからヘルプの起動方法を拝借しました。なかでは以下のようなことをやってます。
final IWorkbenchWindow workbenchWindow = getSite().getWorkbenchWindow();
if (workbenchWindow == null) {
// action has been disposed
return;
}
// This may take a while, so use the busy indicator
BusyIndicator.showWhile(null, new Runnable() {
public void run() {
workbenchWindow.getWorkbench().getHelpSystem()
.displayHelp();
}
});
これでヘルプが起動できます。
org.eclipse.help.ILiveHelpAction クラスを使うと、ヘルプ上からプログラムを呼び出すことができます。例えば、ヘルプで「下のリンクをクリックするとパースペクティブを変更します」なんてリンクを作ることができるわけです。Eclipseのヘルプってようするにhtmlなわけですが、htmlからクライアントのプログラムが起動できるのって、レガシーなJ2EEを作ってきた私からすると、なんか衝撃的です。
やり方は、あらかじめヘルプドキュメント内で「アクション」を起動するJavaScriptを読み込んでおいて、そのJavaScriptを実行するだけです。そのJavaScriptを呼び出すと、指定された「アクション」クラスが実行される、という機構ですね。もちろんその「アクション」クラスはあるインタフェースの実装クラスとなっています。
あらかじめ、
<script language="JavaScript" src="../../../org.eclipse.help/livehelp.js"> </script>
としてJavaScriptを読み込んでおきます。srcのパスはそのhtmlファイルからorg.eclipse.helpプラグインへの相対パスになります。例えばあるプラグイン内にある、ルートから見て hoge/fuga.htm というドキュメントhtmlの場合、
<script language="JavaScript" src="../../org.eclipse.help/livehelp.js"> </script>
という指定、つまりプラグインのルートからさらに一つ上に上がってorg.eclipse.helpに入って...というパス指定になります。
次に通常のhtmlのリンクの様にJavaScriptを実行するリンクを作成します。呼び出すメソッドはliveActionです。使い方ですが、例えば
<a href='javascript:liveAction("nu.mine.kino.plugin.forms.proto.help",
"nu.mine.kino.plugin.forms.proto.help.actions.ActivehelpOpenDialogAction",
"")'>Click here for a Message.</a></p>
などとします。各引数の意味ですが、
となっています。
さて、上のnu.mine.kino.plugin.forms.proto.help.actions.ActivehelpOpenDialogAction クラスは
org.eclipse.help.ILiveHelpAction
をimplementsしています。インタフェースは
public void setInitializationString(String data); public void run();
です。run内に、実行させたい処理を記述します。例えば
Display.getDefault().syncExec(new Runnable() {
public void run() {
IWorkbenchWindow window = PlatformUI.getWorkbench()
.getActiveWorkbenchWindow();
if (window != null) {
Shell shell = window.getShell();
shell.setMinimized(false);
shell.forceActive();
MessageDialog.openInformation(window.getShell(),
"Hello World.", "Hello World. " + data);
}
}
});
とかですね。注意点としては、この処理は別スレッドで実行されるため、UIの処理をする場合は
Display.getDefault().syncExec(new Runnable() ...
でラップしないといけないところです。
ちょっとJavaScriptのはなし。苦手なので、スニペット。。
<script type="text/javascript">
<!--
function execute() {
liveAction("nu.mine.kino.plugin.forms.proto.help",
"nu.mine.kino.plugin.forms.proto.help.actions.ActivehelpOpenDialogAction",
document.form1.textfield.value);
}
// -->
</script>
......
......
<form name="form1" >
<p><input type="text" name="textfield"></p>
</form>
としておいて
<p><a href='javascript:execute()'>Click here for a execute.</a></p>
とかすれば、ヘルプ内で入力した文字をプログラムに渡すことができます。
この記事は
現在のアクセス:16826
capture.png