概要部分構成

org.eclipse.ui.intro.config

3.0

この拡張ポイントは、概要構成を登録する場合に使用します。 この構成には、所定の概要構成用の表示実装およびコンテンツが用意されています。 概要は、ワークベンチを最初に起動するときに、「ヘルプ」メニューの選択項目として表示されます。 概要は、通常、Eclipse 上にビルドされている製品をユーザーに紹介する場合に使用します。

通常、概要は、概要資料の特定のカテゴリーを反映するページ別に編成されています。 例えば、「新機能」ページには、以前のバージョンから追加された新規の概念または機能についての紹介が記載されています。 1 つの概要構成で定義されているコンテンツは、 org.eclipse.ui.intro.configExtension 拡張ポイントを 使用する他のプラグインから参照および拡張できます。

<!ELEMENT extension (config+)>

<!ATTLIST extension

point CDATA #REQUIRED

id    CDATA #IMPLIED

name  CDATA #IMPLIED>


<!ELEMENT config (presentation)>

<!ATTLIST config

introId CDATA #REQUIRED

id      CDATA #REQUIRED

content CDATA #REQUIRED>

config エレメントは、カスタマイズ可能な概要部分を構成する場合に使用します。 config エレメントでは、id、introId、およびコンテンツ・ファイルを指定する必要があります。 概要コンテンツ・ファイルは、概要に含まれているページ、グループ、およびリンクを記述した XML ファイルです。



<!ELEMENT presentation (implementation+)>

<!ATTLIST presentation

home-page-id    CDATA #REQUIRED

standby-page-id CDATA #IMPLIED>

presentation エレメントは、概要部分の表示におけるすべての実行可能な実装を定義します。 このエレメントでは、1 つ以上の実装を定義できます。 始動時には、実装の os/ws 属性に基づいて実装が 1 つのみ選択されます。 それ以外の場合は、os/ws 属性が定義されていない最初の実装が選択されます。



<!ELEMENT implementation (head?)>

<!ATTLIST implementation

kind  (swt|html)

style CDATA #IMPLIED

os    CDATA #IMPLIED

ws    CDATA #IMPLIED>

プラットフォームにおける創造的な表示方法には 2 つの実装があります。 1 つの表示は SWT ブラウザー・ベースの表示で、もう 1 つは UI フォーム・ベースの表示です。 カスタマイズ可能な概要部分を構成し、現在の OS および WS に基づいてこれら 2 つの表示のうちの 1 つを選択できます。 実装の型は swt または html です。



構成拡張ポイントの使用例を以下に示します。

<extension id=

"intro"

point=

"org.eclipse.ui.intro.config"

>

<config introId=

"com.org.xyz.intro"

id=

"com.org.xyz.introConfig"

content=

"introContent.xml"

>

<presentation home-page-id=

"root"

title=

"%intro.title"

>

<implementation ws=

"win32"

style=

"css/shared.css"

kind=

"html"

os=

"win32"

>

</implementation>

<implementation style=

"css/shared_swt.properties"

kind=

"swt"

>

</implementation>

</presentation>

</config>

</extension>

詳しくは、org.eclipse.ui.intro.config API パッケージの仕様を参照してください。

org.eclipse.platform プラグインによってコントリビュート される概要が、Eclipse 内の唯一の実装です。