バージョン 3.1.0
この文書では、概要コンテンツ・ファイルの構造を一連の DTD のフラグメントとして説明します。
introContent
<!ELEMENT introContent (page+ , group* , extensionContent*)>
introContent エレメントは、概要コンテンツ・ファイルの本体を定義します。 コンテンツ・ファイルは、ページ、複数のページに組み込むことのできる共用グループ、および他の構成で定義されているアンカー・ポイント への拡張で構成されています。
page
<!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>
このエレメントを使用して、表示されるページを記述します。
概要は、動的ページおよび静的ページの両方を表示します。
動的ページのコンテンツは、後述するページのサブエレメントから生成されます。
表示に応じて、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> エレメントが外部コントリビューションを実行できるポイントを定義します。
group
<!ELEMENT group (group* | link* | text* | img* | include* | html* | anchor*)>
<!ATTLIST group
id CDATA #REQUIRED
label CDATA #IMPLIED
style-id CDATA #IMPLIED
filteredFrom (swt|html) >
関連コンテンツ、類似したスタイルを適用するコンテンツ、または他のページに一緒に組み込まれるコンテンツをグループ化する場合に使用されます。
link
<!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 アクションを実行したりできます。
action name - アクション記述。
action parameter1 - パラメーターの記述。
action parameter2 (オプション) - パラメーターの記述。
action parameter3 (オプション) = ("true" | "false") "false" - パラメーターの記述。true または false の
いずれかを選択できます。デフォルトは「false」です。
close - イントロ・パーツを閉じる。
パラメーターは不要です。
navigate - 概要ページの指定方向に移動するか、ホーム・ページに戻る。
direction = ("backward" | "forward" | "home") - 移動する方向を指定する。
openBrowser - 外部ブラウザーで URL を開く。3.1 以降は、このアクションはワークベンチのブラウザーのサポートに依存します。つまり、ブラウザーに設定されたユーザー設定が適用されます。
url - 外部 Web サイトまたは静的 HTML ファイルの有効な URL。
pluginId (オプション) - 静的 HTML ファイルが指定されている場合にのみ必要となる。
これは、ファイルを含むプラグインの ID です。
openURL - ウェルカム・ページに組み込まれた URL を開く。SWT 表示の場合、URL は外部ブラウザーに表示されます (上記の openBrowser アクションと同様)。
3.1 以降。
url - 外部の Web サイトまたはローカルの HTML ファイルへの有効な URL。
pluginId (オプション) - 相対 URL の場合は、このファイルを含むプラグインの ID を指定します。
runAction - 指定されたアクションを実行する。
class - org.eclipse.ui.intro.config.IIntroAction
、org.eclipse.jface.action.IAction
、または org.eclipse.ui.IActionDelegate
の 1 つを実装する完全修飾クラス名。
pluginId - クラスを含むプラグインの ID。
standby (オプション) = ("true" | "false") "false" - アクションを実行した後に概要を待機モードに設定するかどうかを示す。
追加のパラメーター - 追加のパラメーターは、org.eclipse.ui.intro.config.IIntroAction
を実装するアクションに渡される。
setStandbyMode - 概要部分の状態を設定する。
standby = ("true" | "false") - true に設定すると概要部分は部分的に可視な待機モードとなり、false に
設定すると概要部分は完全に可視になる。
showHelp - ヘルプ・システムを開く。
パラメーターは不要です。
showHelpTopic - ヘルプ・トピックを開く。
id - ヘルプ・リソースの URL (org.eclipse.ui.help.WorkbenchHelp.displayHelpResource
の Javadoc を参照)。
embed (オプション) = ("true" | "false") "true" - ヘルプ・リソースをウェルカム・ページの一部として表示する必要があることを示す。デフォルトは false です。
SWT 表示の場合、このフラグは単に無視されます。3.1 以降。
embedTarget (オプション) - ヘルプ・トピックの内容を保持する、現在のウェルカム・ページ内の div へのパス。指定されている場合、embed はデフォルトでは true で、組み込み URL は指定されたパスとともに div 内に挿入されます。パスはページに相対しているため、
ページ ID では開始されません。div の子は、URL のコンテンツにより置き換えられます。組み込みターゲットとして使用できる div は、
ページにつき 1 つのみです。SWT 表示の場合、このフラグは単に無視されます。XHTML を概要コンテンツとして使用している場合は、これもサポートされません。3.1 以降。
showMessage - 標準情報ダイアログを使用して、ユーザーに対してメッセージを表示する。
message - ユーザーに対して表示するメッセージ。
showStandby - 概要部分を待機モードに設定し、指定した入力を使用して standbyContentPart を表示する。
partId - 表示する standbyContentPart の ID。
input - standbyContentPart で設定する入力。
showPage - 指定した ID の概要ページを表示する。
id - 表示する概要ページの ID。
standby (オプション) = ("true" | "false") "false" - ページを表示した後に概要を待機モードに
設定するかどうかを示す。
これらのアクションに渡されるパラメーターのいずれかに特殊文字 (すなわち、URL では不正となる文字) が含まれている場合は、それらの文字を UTF-8 URL エンコードを使用してエンコードする必要があります。これらのパラメーターをデコードされた状態で受け取るには、概要フレームワークがこれらのパラメーターを処理するときに、特殊なパラメーター decode = ("true" "false") を使用して、強制的にこれらのパラメーターをデコードすることができます。
例えば、概要 URL が
http://org.eclipse.ui.intro/showMessage?message=This+is+a+message
の場合、メッセージ・パラメーターは「This+is+a+message」として処理されます。
これに対して、
http://org.eclipse.ui.intro/showMessage?message=This+is+a+message&decode=true
の場合、メッセージ・パラメーターは「This is a message」として処理されます。
html
<!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 の断片が組み込まれます。
title
<!ELEMENT title EMPTY>
<!ATTLIST title
id CDATA #IMPLIED
style-id CDATA #IMPLIED
filteredFrom (swt|html) >
エスケープされた HTML タグを含むことのあるテキストの断片です。 ページ・タイトルとしてのみ使用されるため、指定したページが持つことができるタイトル・エレメントは最大 1 つです。
text
<!ELEMENT text EMPTY>
<!ATTLIST text
id CDATA #IMPLIED
style-id CDATA #IMPLIED
filteredFrom (swt|html) >
エスケープされた HTML タグを含むことのあるテキストの断片です。 b および li タグを組み込むことができます。 また、URL のアンカーを組み込むこともできます。 複数の段落が必要な場合、p タグで開始され、p タグで終了する複数のセクションにテキストを分割できます。
include
<!ELEMENT include EMPTY>
<!ATTLIST include
configId CDATA #IMPLIED
path CDATA #REQUIRED
merge-style (true | false) >
指定のパスまたは configId 属性 (オプション) のターゲットとなるエレメントを拡張します。 パスは、指定された構成内で 1 つのエレメントを一意的にアドレス指定する必要があります。 これは、構成レベルで定義された 1 つの共用グループ、またはページ内の任意のエレメントを指すことがあります。
true
の場合、組み込まれるエレメントを所有するページに属するスタイルが、
組み込むページのスタイル・リストに追加されます。
false
の場合 (デフォルト)、組み込むページが、組み込まれるエレメントのプロパティーを制御します。
head
<!ELEMENT head EMPTY>
<!ATTLIST head
src CDATA #REQUIRED>
encoding CDATA #IMPLIED
ページの HEAD コンテンツ・エリアに組み込むよう HTML に指示します。 これにより、HTML HEAD セクションに追加の HTML を追加できます。 これは、Java スクリプトまたは追加スタイル・シートを追加する場合に便利です。 このマークアップは、HTML ベースの概要部分の実装にのみ使用します。UI フォームの実装の場合は、無視されます。 ページには、複数の head エレメントがある場合があります。 ただし、実装できる head エレメントは 1 つのみです (head エレメントはすべてのページで共用されるため)。
img
<!ELEMENT img EMPTY>
<!ATTLIST img
id CDATA #REQUIRED
src CDATA #REQUIRED
alt CDATA #IMPLIED
style-id CDATA #IMPLIED
filteredFrom (swt|html) >
表示ではなく、概要コンテンツを表すイメージです (スタイルで定義されている文字飾りイメージとは異なる)。
extensionContent
<!ELEMENT extensionContent (text | group | link | html | include)>
<!ATTLIST extensionContent
style CDATA #IMPLIED
alt-style CDATA #IMPLIED
path CDATA #REQUIRED>
ターゲット・アンカーに追加されるコンテンツです。 拡張が解決できない場合は (構成が見つからないか、ターゲット・アンカー・エレメントが見つからない場合)、 拡張内のページおよび/またはグループは無視される必要があるため、指定された configExtension に 許可される extensionContent は 1 つのみになります。
anchor
<!ELEMENT anchor EMPTY>
<!ATTLIST anchor
id CDATA #REQUIRED>
アンカーとは、拡張性を宣言する場合に使用されるエレメントのことです。 アンカーは、構成内の、外部からのコントリビューションが可能なロケーションです。 extensionContent のパス属性では、アンカーのみが有効なターゲット値です。
contentProvider
<!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 以降)。
Copyright (c) 2004 IBM Corporation and others.
All rights reserved.
This program and the accompanying materials are made
available under the terms of the Eclipse Public License v1.0 which accompanies
this distribution, and is available at
http://www.eclipse.org/legal/epl-v10.html