虎の巻の内容

org.eclipse.ui.cheatsheets.cheatSheetContent

3.0

この拡張ポイントは、虎の巻コンテンツのコントリビューションを登録する場合に使用します。 虎の巻は、「ヘルプ」メニューまたは虎の巻ビュー内の選択項目として表示されます。虎の巻は、全体的な目標を達成するために一連の複雑なタスクをガイドするためのものです。

虎の巻は、特定の問題領域を反映するカテゴリー別に編成されています。 例えば、Java 指向のプラグインは、さまざまな Java ツールを使用してユーザーを支援する虎の巻に適した「Java」と呼ばれるカテゴリーを定義することができます。 あるプラグインによって定義されているカテゴリーは、cheatsheet 要素の category 属性を使用してその他のプラグインによって参照できます。 カテゴリー化されていない虎の巻、および無効なカテゴリー・パスを持つ虎の巻は、「Other」カテゴリーに含まれることになります。

虎の巻では、オプションで、虎の巻に関する簡略テキストを本文に含む description サブ要素を指定することができます。

<!ELEMENT extension (category | cheatsheet | taskEditor | taskExplorer)>

<!ATTLIST extension

point CDATA #REQUIRED

id    CDATA #IMPLIED

name  CDATA #IMPLIED>


<!ELEMENT category EMPTY>

<!ATTLIST category

id             CDATA #REQUIRED

name           CDATA #REQUIRED

parentCategory CDATA #IMPLIED>

cheatsheetContent 拡張ポイントの category 要素によって、虎の巻メニュー内に新規カテゴリーが作成されます。この虎の巻メニューは、ワークベンチのヘルプ・メニューから使用できます。新規のカテゴリーを指定すると、虎の巻はこのカテゴリーのターゲットとなり、虎の巻の選択ダイアログ内でこのカテゴリーの下に表示されます。



<!ELEMENT cheatsheet (description?)>

<!ATTLIST cheatsheet

id          CDATA #REQUIRED

name        CDATA #REQUIRED

category    CDATA #IMPLIED

contentFile CDATA #IMPLIED

listener    CDATA #IMPLIED

composite   (true | false) "false">

ワークベンチにコントリビュートされる虎の巻が存在する場合、cheatsheetContent 拡張ポイントに cheatsheet 要素が配置されます。 虎の巻の要素では、ID、選択オプション内で表示する翻訳可能な名前、この虎の巻が組み込まれるカテゴリーを示すカテゴリー ID、およびコンテンツ・ファイルを指定する必要があります。虎の巻コンテンツ・ファイルは、虎の巻に含まれているステップおよびアクションを記述する XML ファイルです。



<!ELEMENT description (#PCDATA)>

虎の巻の簡略説明



<!ELEMENT taskEditor EMPTY>

<!ATTLIST taskEditor

id    CDATA #REQUIRED

class CDATA #REQUIRED

icon  CDATA #REQUIRED>

この拡張ポイントは一時的であり、一時的な API クラス TaskEditor をベースとしています。 taskEditor 拡張ポイントによって、カスタム UI がコンポジット虎の巻のエディター・ペイン内に表示されることが可能になります。この拡張機能の ID に一致する種類のコンポジット虎の巻内のタスクはどれも、エディター・エリアを作成するためにこの拡張ポイント内で定義されたクラスを使用します。



<!ELEMENT taskExplorer EMPTY>

<!ATTLIST taskExplorer

id    CDATA #REQUIRED

class CDATA #IMPLIED

icon  CDATA #IMPLIED

name  CDATA #REQUIRED>

この拡張ポイントは一時的であり、一時的な API クラス TaskExplorer をベースとしています。 この拡張ポイントによって、コンポジット虎の巻を開くときに使用されるタスク・エクスプローラーのコントリビューションが可能になります。



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

<extension point=

"org.eclipse.ui.cheatsheets.cheatSheetContent"

>

<category name=

"Example category"

id=

"com.example.category"

>

</category>

<cheatsheet name=

"Example cheat sheet"

category=

"com.example.category"

id=

"com.example.cheatSheet"

contentFile=

"ExampleCheatSheet.xml"

>

<description>

This is a descriptive bit of text for my cheat sheet description.

</description>

</cheatsheet>

</extension>

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

組み込みの虎の巻はありません。