Eclipse/プラグイン開発のTIPS集/ヘルプを実装するのバックアップ(No.2)

Top / Eclipse / プラグイン開発のTIPS集 / ヘルプを実装する

Eclipseのヘルプはワークベンチのメニューの

ヘルプ >> ヘルプ目次

にありますが、このhtmlベースのヘルプも拡張して好きなヘルプを載せることができます。そして拡張するための拡張ポイントがorg.eclipse.help.toc拡張ポイントです。

この拡張ポイントで目次となるファイル(xml形式)を指定し、そのxmlファイルで目次に対応するhtmlファイルを指定します。

拡張ポイント †

org.eclipse.help.toc

↑

plugin.xmlのサンプル †

<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(ここではtoc.xml)のサンプル †

<?xml version="1.0" encoding="UTF-8"?>
<?NLS TYPE="org.eclipse.help.toc"?>

<toc label="Sample Table of Contents" topic="html/toc.html">
   <topic label="Getting Started">
      <anchor id="gettingstarted"/>
   </topic>
   <topic label="Concepts">
      <anchor id="concepts"/>
   </topic>
   <topic label="Tasks">
      <anchor id="tasks"/>
   </topic>
   <topic label="Reference">
      <anchor id="reference"/>
   </topic>
   <topic label="Samples">
      <anchor id="samples"/>
   </topic>
</toc>

↑

<anchor id="concepts"/> でリンクされるtocconcepts.xml †

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

↑

選択肢	投票
おもしろかった	0
そうでもない	0

Eclipse/プラグイン開発のTIPS集/ヘルプを実装する のバックアップ(No.2)

拡張ポイント †

plugin.xmlのサンプル †

目次となるxml(ここではtoc.xml)のサンプル †

<anchor id="concepts"/> でリンクされるtocconcepts.xml †

ポイント †

htmlファイル群は圧縮できる。 †

目次ファイル内で別の目次ファイルを指定できる †

関連リンク †

Eclipse/プラグイン開発のTIPS集/ヘルプを実装するのバックアップ(No.2)