アクティビティー・サポート

org.eclipse.help.base.activitySupport

3.1

この拡張ポイントは、アクティビティー使用時のヘルプ・システムの動作を構成するために、製品のプラグインが使用します。以下に関する構成情報を提供します。

この拡張ポイントは実験的なもので、アクティビティー・サポートが発展した場合は、将来のリリースで変更される可能性があります。

<!ELEMENT extension (support+)>

<!ATTLIST extension

point CDATA #REQUIRED

id    CDATA #IMPLIED

name  CDATA #IMPLIED>


<!ELEMENT support (localScopeCheckbox , documentMessage , showAllMessage)>

<!ATTLIST support

productId CDATA #REQUIRED>


<!ELEMENT showAllMessage (#PCDATA)>

アクティビティー・フィルタリングがオフの場合に、ダイアログに表示されるプレーン・テキスト・メッセージ。メッセージの意図は、フィルターを使用しない場合、表示されないユーザー・インターフェース・エレメントを参照する文書が存在する可能性があることを警告することです。



<!ELEMENT localScopeCheckbox (#PCDATA)>

ローカルの検索範囲の設定ページ内のチェック・ボックスのラベル。このチェック・ボックスが選択されている場合は、使用不可にされているアクティビティーに属する文書内での検索でヒットしたものは、検索結果に含まれます。



<!ELEMENT documentMessage EMPTY>

<!ATTLIST documentMessage

class    CDATA #IMPLIED

pluginId CDATA #REQUIRED>

無効なアクティビティーに関するヘルプ・トピックの上部に表示される HTML 断片。メッセージの意図は、表示されない UI エレメントへの参照がトピックに含まれている可能性があることをユーザーに通知することです。メッセージ・テキストは XML ファイル内にあるため、特殊文字については、標準 XML エンティティーを使用して HTML タグをエスケープする必要があります。

メッセージに、アクティビティーの使用可能性の状態を変更するアクティビティー・エディターへのハイパーリンクを含めることができます。その場合には、属性 class を使用する必要があります。



アクティビティー・サポート拡張ポイントの使用例を以下に示します。

 

<extension point=

"org.eclipse.help.base.activitySupport"

>

<support productId=

"com.example.xyzProduct"

>

<showAllMessage>

このアクションはすべてのトピックを目次に表示します。

</showAllMessage>

<documentMessage class=

"com.example.xyz.OpenRolePreference"

>

このトピックは、現在無効な役割に関するものです。 &lt;p&gt; この役割を使用可能にするには、&lt;a href="ACTIVITY_EDITOR"&gt;Role Preference Page.&lt;/a&gt; を開きます。

</documentMessage>

</support>

</extension>

エレメント documentMessage の属性 class は、org.eclipse.help.ILiveHelpAction インターフェースを実装する必要があります。

Eclipse SDK は、「機能」という用語を使用して、無効なトピック内のハイパーリンクから機能設定ページを開く、デフォルト・アクティビティー・サポートを提供します。指定変更する場合には、変更点および用語がプラットフォーム UI の変更点や用語と一致することを確認してください。