ヘルプ・システム設定

Eclipse ヘルプ・システムを製品に合わせて構成し、ブランド化するには、多数のヘルプ設定にカスタム・デフォルトを指定します。

ヘルプ・システム自体は、いくつか別個のプラグインに分割されています。 以下の表は、使用可能な設定とその設定を定義するプラグインを示しています。  これらの設定のオーバーライドについては、『製品のカスタマイズ』を参照してください。
 

org.eclipse.help プラグイン:

設定キー 使用法
デフォルト
baseTOCS TOC の配列。 ブックシェルフに表示されるヘルプ TOC (ブック) の順序リスト。 その他すべての TOC がこのブックに続きます。 このリストに存在しない TOC は無視されます。 各 TOC のロケーションを /pluginId/path/to/toc.xml として使用してください。 /org.eclipse.platform.doc.user/toc.xml、
/org.eclipse.jdt.doc.user/toc.xml、
/org.eclipse.platform.doc.isv/toc.xml、
/org.eclipse.jdt.doc.isv/toc.xml、
/org.eclipse.pde.doc.user/toc.xml
ignoredTOCS TOC を使用不可にします。  ヘルプ・システムでは無視されるヘルプ TOC (ブック) のリストです。使用不可にされた TOC は、 ブックのリストには表示されず、リンクすることはできません。使用不可にされた TOC により定義されたトピックは、 検索で使用されません。 このリストに存在しない TOC は無視されます。 各 TOC のロケーションを /pluginId/path/to/toc.xml として使用してください。

org.eclipse.help.base プラグイン:

設定キー 使用法
デフォルト
banner トップ・フレームに表示するバナー・ページのロケーション
例: banner=/org.eclipse.help.webapp/advanced/banner.html

banner_height バナー・フレームの高さ
例: banner_height=60

help_home ヘルプを開いたときに、コンテンツ領域に表示されるページ。 HTML ページを /pluginId/path/to/home.html と指定します。 /org.eclipse.help.base/doc/help_home.html
linksView true または false に設定し、関連するリンク・ビューの可視性を制御します。
注: このオプションは、InfoCenter では無効です。
true
bookmarksView true または false に設定し、「ブックマーク」ビューの可視性を制御します。
注: このオプションは、InfoCenter では無効です。
true
windowTitlePrefix true または false に設定し、ブラウザー・ウィンドウのタイトルを制御します。 true に設定すると、タイトルの書式は「ヘルプ - <PRODUCT_NAME>」になり、false に設定すると、タイトルは「<PRODUCT_NAME>」になります。 ここで、<PRODUCT_NAME> は、1 次フィーチャーに設定されている Eclipse 製品の名前です。 true
loadBookAtOnceLimit ブックに含めることができるトピックの最大数。ブラウザーによって、ナビゲーション用に 1 つの文書としてロードされます。より大きいブックのナビゲーションは、一度に数レベルずつ動的にロードされます。 ブランチが展開されている場合は、必要に応じて、さらに多くのトピックがダウンロードされます。 1000
dynamicLoadDepthsHint 大きいブックのブラウザーにダウンロードされるトピック・ナビゲーションで想定されるレベル数。 この値は、0 よりも大きくなければなりません。 想定されるレベル数に数多くのトピックが含まれている場合、実際のレベル数は、広いツリーでは異なります。
3
imagesDirectory ヘルプ・ビューで使用されるイメージが入っているディレクトリー。 イメージの名前は、org.eclipse.help.webapp プラグインでのイメージの名前と同じでなければなりません。 フォーマット /pluginID/directory を使用してください。 images
advanced.toolbarBackground ツールバーの CSS 背景。値は、拡張ヘルプ UI を表示するブラウザーで使用されます。 ButtonFace
advanced.viewBackground ナビゲーション・ビューの CSS 背景。値は、拡張ヘルプ UI を表示するブラウザーで使用されます。 Window
advanced.toolbarFont ツールバーの CSS フォント。値は、拡張ヘルプ UI を表示するブラウザーで使用されます。 icon
advanced.viewFont ナビゲーション・ビューの CSS フォント。値は、拡張ヘルプ UI を表示するブラウザーで使用されます。 icon
basic.toolbarBackground ツールバーの背景色。値は、基本ヘルプ UI を表示するブラウザーで使用されます。 #D4D0C8
basic.viewBackground ナビゲーション・ビューの背景色。値は、基本ヘルプ UI を表示するブラウザーで使用されます。 #FFFFFF
locales InfoCenter が認識し、カスタマイズされたコンテンツを提供するロケールのリスト。 クライアント・ブラウザーが受け入れるロケール (または言語) がこのリスト内のロケールと一致しない場合、ブラウザーでは、デフォルトのロケール (サーバー・ロケール、または eclipse -nl コマンド行オプションで指定されたロケール) のコンテンツが提供されます。リストが指定されていない場合、ブラウザーの設定によるロケールのコンテンツが提供されます。 注: このオプションを指定しない場合、InfoCenter にアクセスするブラウザー間の設定済みロケールごとに、ナビゲーションとインデックスが作成されるため、大きなメモリーとディスク・スペースが必要になることがあります。
例: locales=en ja zh_CN zh_TW

productIndex 製品ごとに、事前に作成された文書の索引がある場合は、その索引を配信するプラグインの ID を ヘルプ・システムに指定する必要があります。
always_external_browser
可能な場合は組み込みブラウザーを使用する (Windows または Linux) か、 または常時外部ブラウザーを使用します。 true に設定すると、外部ブラウザーの使用が強制されます。  指定されたプラットフォームに組み込みブラウザーがない場合、オプションは無効となります。
false
default_browser

デフォルトの外部ブラウザー。  ヘルプ・システムで使用される org.eclipse.help.base.browser 拡張ポイントに提供されている外部 Web ブラウザーのうち、1 つのブラウザーの ID。 このブラウザーのアダプター available() メソッドは、現行システムで true を戻す必要があります。

スタンドアロンのヘルプ・モードでは、この設定は外部ブラウザーを制御します。 ワークベンチ・モードでは、ヘルプはワークベンチ・ブラウザーのサポートによって提供されるブラウザーを使用します。

指定されたシステムで使用可能なブラウザーに基づき、動的に設定されたデフォルト
custom_browser_path

カスタム・ブラウザーの実行可能パス

スタンドアロンのヘルプ・モードでは、この設定は外部ブラウザーを制御します。 ワークベンチ・モードでは、ヘルプはワークベンチ・ブラウザーのサポートによって提供されるブラウザーを使用します。

C:¥Program Files¥Internet Explorer¥IEXPLORE.EXE" %1 - Windows、
"konqueror %1" - Linux
"mozilla %1" - その他のプラットフォーム
showDisabledActivityTopics ヘルプ・システムは、使用不可の機能のトピックをフィルタリングします。  このオプションは、この動作および「すべてのトピックを表示」ボタンの有無を制御します。 
有効な値: neveroffonalways
 never - 使用不可の機能のトピックは表示されません。
 off - ユーザーは、使用不可のトピックを最初は非表示にして、すべてのトピックを表示することを選択できます。
 on - ユーザーは、すべてのトピックを最初から表示して、すべてのトピックを表示することを選択できます。
 always - 使用不可の機能のトピックが表示されます (フィルタリングは無効)。
off
activeHelp アクティブ・ヘルプの実行を使用可能および使用不可にできます。 このオプションは、アクティブ・ヘルプが無効な InfoCenter セットアップでは無効です。
有効な値は、以下のとおりです。
 true - デフォルトのアクティブ・ヘルプ・アクションを使用可能にする
 false - アクティブ・ヘルプ・フレームワークを使用不可にする
true
window_infopop ワークベンチ・ウィンドウでヘルプ・キーが押されたときに、 旧式の infopop を使用可能化します。false の場合、 新規ダイナミック・ヘルプ・ビューが代わりに開きます。 false
dialog_infopop
ダイアログでヘルプ・キーが押されたときに、 旧式の infopop を使用可能化します。false の場合、 新規ダイナミック・ヘルプ・ウィンドウが代わりに開きます。
false

org.eclipse.help.appserver プラグイン:

設定キー 使用法
デフォルト
port サーバーが http 要求を listen するポート番号。ポートが与えられていない場合、システムは任意のポートを選択します。  
host

サーバーに接続するために使用するホスト・アドレスまたはホスト名。デフォルトは存在せず、 使用可能なローカル・アドレスを Eclipse が選出します。

ローカル・モードでヘルプを使用している製品 (InfoCenter ではなく、ワークベンチまたはスタンドアロン) では、この設定を "127.0.0.1" に設定することにより、ヘルプ・サーバーがネットワーク上の他のユーザーに公開されないようにすることができます。


org.eclipse.tomcat プラグイン:

設定キー 使用法
デフォルト
acceptCount スレッドを処理する可能な要求がすべて使用中の場合の着信接続要求に対するキューの最大長。 キューがいっぱいの場合、受信した要求は拒否されます。 100
maxProcessors
このコネクターで作成されるスレッドを処理する要求の最大数。 これにより、同時に処理される要求の最大数が決定されます。
75
minProcessors
このコネクターが最初に開始されたときに作成されるスレッドを処理する要求の数。 この属性は、maxProcessors よりも小さい値に設定する必要があります。
5