イントロ・パーツ構成

org.eclipse.ui.intro.config

3.0

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

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

<!ELEMENT extension (handle? , 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+ , launchBar?)>

<!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 です。



<!ELEMENT launchBar (handle? , shortcut*)>

<!ATTLIST launchBar

location (left|bottom|right|fastview) "fastview"

bg       CDATA #IMPLIED

fg       CDATA #IMPLIED>

起動バーは、「switchToLaunchBar」コマンドとともに機能します。このコマンドが実行されると、 イントロが閉じられ、メイン・ウィンドウのトリム・エリアの 1 つに起動バーが作成されます。起動バーには、 ユーザーが最後のイントロ・ページへ戻ることができるボタンが少なくとも 1 つ含まれます。 オプションとして、shortcut エレメントを使用して、定義されるボタンを追加できます。これらのボタンを使用することにより、 特定のイントロ・ページへ迅速にジャンプすることができます。3.1 以降。



<!ELEMENT shortcut EMPTY>

<!ATTLIST shortcut

tooltip CDATA #IMPLIED

icon    CDATA #REQUIRED

url     CDATA #REQUIRED>

shortcut エレメントごとに、1 つのボタンがイントロ起動バーに作成されます。ショートカットに定義された URL は、 ボタンが押されたときに実行されます。3.1 以降。



<!ELEMENT handle EMPTY>

<!ATTLIST handle

close (true | false) "true"

image CDATA #IMPLIED>

起動バー・ハンドルがレンダリングされる方法を制御するオプションのエレメント。3.1 以降。



<!ELEMENT introContent (page+ , group* , extensionContent*)>

introContent エレメントは、概要コンテンツ・ファイルの本体を定義します。 コンテンツ・ファイルは、ページ、複数のページに組み込むことのできる共用グループ、および他の構成で定義されているアンカー・ポイント への拡張で構成されています。



<!ELEMENT page (group* | link* | text* | head* | img* | include* | html* | title? | anchor* | contentProvider*)>

<!ATTLIST page

url          CDATA #IMPLIED

id           CDATA #REQUIRED

style        CDATA #IMPLIED

alt-style    CDATA #IMPLIED

filteredFrom (swt|html)

content      CDATA #IMPLIED

style-id     CDATA #IMPLIED

shared-style (true | false) >

このエレメントを使用して、表示されるページを記述します。 概要は、動的ページおよび静的ページの両方を表示します。
動的ページのコンテンツは、後述するページのサブエレメントから生成されます。 表示に応じて、style または alt-style が適用されます。 スタイルは、id または class-id を参照することによってさらに拡張できます。
静的ページでは、あるユーザーの概要内の既存の HTML 文書を再利用でき、静的ページ または動的ページからリンクできます。 静的ページは、ページ・エレメントで定義されているのではなく、他のページからリンクすることができる単純な HTML ファイルです。
概要構成拡張ポイントの表示エレメントで id が指定されているホーム・ページには、 このページが静的ページであることを示す URL を指定することができます。 URL が指定されていない場合、ホーム・ページは動的であると見なされます。 ページ・エレメントを使用して記述されている他のすべてのページは動的になります。
また、SWT 表示が使用され、静的ページを表示する場合、外部ブラウザーが起動され、 現行ページが可視のままになることに注意してください。
動的ページで使用されるサブエレメントは、以下のとおりです。 group サブエレメントは、関連コンテンツをグループ化し、グループ化されたコンテンツにスタイルを適用する場合に使用します。 link サブエレメントは、静的または動的ページにリンクする場合に使用できるリンクを定義し、概要アクション/コマンドを実行します。 通常、リンクはページ・レベルで定義され、メイン・ページとページ内のリンクとの間を移動します。 text サブエレメントは、ページ・レベルでテキスト・コンテンツを定義します。 head サブエレメントは Web ベースの表示にのみ 適用でき、HTML head セクションに追加の HTML を追加できるようにします。 これは、Java スクリプトまたは追加スタイル・シートを追加する場合に便利です。 img サブエレメントは、ページ・レベルでイメージ・コンテンツを定義します。 include サブエレメントは、ページ以外の任意のエレメントの再利用を可能にします。 html サブエレメントは Web ベースの表示にのみ 適用でき、HTML をページ・コンテンツに埋め込んだり、組み込んだりできるようにします。 埋め込みでは、完全に定義された HTML ファイルを参照することにより、 その HTML ファイルが HTML object に埋め込まれます。 組み込みでは、HTML ファイルから直接 HTML の断片が組み込まれます。 title サブエレメントは、ページのタイトルを定義します。 anchor サブエレメントは、<extensionContent> エレメントが外部コントリビューションを実行できるポイントを定義します。



<!ELEMENT group (group* | link* | text* | img* | include* | html* | anchor* | contentProvider*)>

<!ATTLIST group

id           CDATA #REQUIRED

label        CDATA #IMPLIED

style-id     CDATA #IMPLIED

filteredFrom (swt|html) >

関連コンテンツ、類似したスタイルを適用するコンテンツ、または他のページに一緒に組み込まれるコンテンツをグループ化する場合に使用されます。



<!ELEMENT head EMPTY>

<!ATTLIST head

src      CDATA #REQUIRED

encoding CDATA #IMPLIED>

ページの HEAD コンテンツ・エリアに組み込むよう HTML に指示します。 これにより、HTML HEAD セクションに追加の HTML を追加できます。 これは、Java スクリプトまたは追加スタイル・シートを追加する場合に便利です。 このマークアップは、HTML ベースの概要部分の実装にのみ使用します。UI フォームの実装の場合は、無視されます。 ページには、複数の head エレメントがある場合があります。 ただし、実装できる head エレメントは 1 つのみです (head エレメントはすべてのページで共用されるため)。



<!ELEMENT title EMPTY>

<!ATTLIST title

id           CDATA #IMPLIED

style-id     CDATA #IMPLIED

filteredFrom (swt|html) >

エスケープされた HTML タグを含むことのあるテキストの断片です。 ページ・タイトルとしてのみ使用されるため、指定したページが持つことができるタイトル・エレメントは最大 1 つです。



<!ELEMENT link (text? , img?)>

<!ATTLIST link

id           CDATA #IMPLIED

label        CDATA #IMPLIED

url          CDATA #REQUIRED

style-id     CDATA #IMPLIED

filteredFrom (swt|html) >

静的 HTML ファイル、外部 Web サイトにリンクしたり、概要 URL アクションを実行したりできます。



<!ELEMENT text EMPTY>

<!ATTLIST text

id           CDATA #IMPLIED

style-id     CDATA #IMPLIED

filteredFrom (swt|html) >

エスケープされた HTML タグを含むことのあるテキストの断片です。 b および li タグを組み込むことができます。 また、URL のアンカーを組み込むこともできます。 複数の段落が必要な場合、p タグで開始され、p タグで終了する複数のセクションにテキストを分割できます。



<!ELEMENT img EMPTY>

<!ATTLIST img

id           CDATA #REQUIRED

src          CDATA #REQUIRED

alt          CDATA #IMPLIED

style-id     CDATA #IMPLIED

filteredFrom (swt|html) >

表示ではなく、概要コンテンツを表すイメージです (スタイルで定義されている文字飾りイメージとは異なる)。



<!ELEMENT html (img | text)>

<!ATTLIST html

id           CDATA #REQUIRED

src          CDATA #REQUIRED

type         (inline|embed)

style-id     CDATA #IMPLIED

filteredFrom (swt|html)

encoding     CDATA #IMPLIED>

文書全体を埋め込むか、または HTML in-place の断片をインライン化してページに組み込むように HTML に指示します。 代替 SWT 表示のレンダリング用に、フォールバック・イメージまたはテキストが定義されている必要があります。
埋め込みでは、完全に定義された HTML ファイルが動的ページのコンテンツに埋め込まれます。 HTML ファイルを参照する HTML object エレメントが作成されます。
組み込みでは、動的 HTML ページから直接 HTML の断片が組み込まれます。



<!ELEMENT include EMPTY>

<!ATTLIST include

configId    CDATA #IMPLIED

path        CDATA #REQUIRED

merge-style (true | false) >

指定のパスまたは configId 属性 (オプション) のターゲットとなるエレメントを拡張します。 パスは、指定された構成内で 1 つのエレメントを一意的にアドレス指定する必要があります。 これは、構成レベルで定義された 1 つの共用グループ、またはページ内の任意のエレメントを指すことがあります。



<!ELEMENT anchor EMPTY>

<!ATTLIST anchor

id CDATA #REQUIRED>

アンカーとは、拡張性を宣言する場合に使用されるエレメントのことです。 アンカーは、構成内の、外部からのコントリビューションが可能なロケーションです。 extensionContent のパス属性では、アンカーのみが有効なターゲット値です。



<!ELEMENT extensionContent (text | group | link | html | include)>

<!ATTLIST extensionContent

style     CDATA #IMPLIED

alt-style CDATA #IMPLIED

path      CDATA #REQUIRED

content   CDATA #IMPLIED>

ターゲット・アンカーに追加されるコンテンツです。 拡張が解決できない場合は (構成が見つからないか、ターゲット・アンカー・エレメントが見つからない場合)、 拡張内のページおよび/またはグループは無視される必要があるため、指定された configExtension に 許可される extensionContent は 1 つのみになります。



<!ELEMENT contentProvider (text?)>

<!ATTLIST contentProvider

id       CDATA #REQUIRED

pluginId CDATA #IMPLIED

class    CDATA #REQUIRED>

概要コンテンツ・プロバイダーのプロキシー。これにより、概要ページで各ソース (Web、Eclipse など) のデータを動的に取得し、この動的データに基づいてランタイムでコンテンツを提供することができます。 クラス属性で指定されている IIntroContentProvider クラスをロードできない場合、text エレメントのコンテンツが代わりにレンダリングされます。 これは HTML 概要タグの動的バージョンです。HTML タグを使用すると、静的な HTML コンテンツを生成済みの HTML 概要ページに組み込んだり、インライン化することができますが、contentProvider タグを使用すると、このコンテンツをランタイムで動的に作成できます。 また、HTML タグは HTML 表示の場合のみサポートされますが、contentProvider タグは HTML 表示および SWT 表示の両方でサポートされます 3.0.1 以降。



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

<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 内の唯一の実装です。