ヘルプ・サーバーおよびファイル・ロケーション

プラットフォームは、独自のドキュメンテーション・サーバーを使用して、プラグインのドキュメンテーション用の実際の Web ページを提供します。  カスタム・サーバーを使用すると、プラットフォームが、ブラウザーに依存しない方法で HTML コンテンツを処理し、プラグインに対応したサポートを提供することが可能になります。  プラグイン開発者にとっての主な違いは、より柔軟な方法でファイルの構造化とリンクの指定を行うことができるところにあります。

ドキュメンテーションを ZIP ファイルで配布することが可能であるため、多数のファイルが存在している場合に発生する可能性のある問題が回避されます。 この例のプラグインでは、html というサブディレクトリーを作成しました。  あるいは別の方法として、html ファイルを doc.zip という ZIP ファイルに挿入することもできたでしょう。 この ZIP ファイルには、プラグイン・ディレクトリーの下のファイル構造をそのまま持ち込まなければなりません。  この例では、ZIP ファイルに、サブディレクトリー html と、html の下のすべての内容が含まれていなければなりません。  

ヘルプ・サーバーは、ファイル名を解決するときに、doc.zip を調べて文書を探してから、プラグイン・ディレクトリー自体を調べます。  href 内の引き数は、リンクとして使用した場合、現在のプラグインを基準にしたものと想定されます。  次のリンクについて考えてみましょう。

   <topic label="Ref1" href="html/ref/ref1.html"/>

ヘルプ・プラグインは、このファイルを以下のようにして探します。

Web 上のコンテンツを参照するためには、完全修飾リンクを使用できます。 

   <topic label="Ref1" href="http://www.example.com/myReference.html"/>

各国語および翻訳済みドキュメンテーション

プラットフォーム・ヘルプ・システムは、翻訳済みファイルを検索するため、 プラットフォームのその他の部分によって使用されるものと同じ各国語ディレクトリー・ルックアップ方式を使用します。  (このディレクトリー構造の説明については、ロケール特定ファイルを参照してください。)  doc.zip ファイルを使用する場合、ロケールごとに doc.zip ファイルを生成して、それを正しいロケール・ディレクトリーに置かなければなりません。  (ZIP ファイル内に nl ロケール・ディレクトリー構造を複製することはできません。)

プラグイン間参照

href 引き数も、別のプラグインのコンテンツを参照できます。  これは、ヘルプ・サーバーによって解決される次のような特殊なプラグイン間参照表記を使用して行われます。

   <topic label="Ref1" href="../"another_plugin_id"/ref/ref1.html"/>

例えば、プログラマーズ・ガイドのこの章には、次のトピックを使用してリンクできます。

   <topic label="Help Chapter in Platform Doc" href="../org.eclipse.platform.doc.isv/guide/help.html"/>

注:  別のプラグインのコンテンツを参照する場合、ディレクトリー名ではなく、plugin.xml ファイルに宣言してあるとおりのプラグインの ID を必ず使用してください。  実際にはこれらが同じであることが多いのですが、ディレクトリー名ではなく ID を使用しているかを確認することが重要です。

 

Copyright IBM Corporation and others 2000, 2003.