建立外掛程式的 .hep 檔

關於這項作業

若要向 IBM® Rational® Rhapsody® 提供載入外掛程式所需的資訊,必須建立 .hep 檔,或者如果您已建立 .hep 檔,則將此資訊新增至現有的 .hep 檔。

.hep 檔結構

關於這項作業

若要瞭解針對外掛程式必須包括在 .hep 檔中的資訊類型,最要從可以在 .hep 檔中說明的元素類型這個問題開始。

.hep 檔用來說明下列項目:

  • 說明程式
  • 外掛程式
  • 外掛程式指令

雖然這些項目各不相同,但是它們使用相同的 .hep 檔項目來向 Rational Rhapsody 提供必要的資訊。

說明程式還用於延伸產品中的功能,但是它們與外掛程式使用不同的機制。說明程式是獨立式應用程式。外掛程式使用回呼機制來回應事件。

外掛程式指令說明 Rational Rhapsody 新增以容許您開啟特定外掛程式的功能表項目。

對於外掛程式,.hep 檔必須包含下列資訊:

  • 在檔案中定義的項目數(外掛程式/說明程式/外掛程式指令)
  • 外掛程式的名稱
  • 實作必要方法的 Java™ 類別
  • 外掛程式使用的 Java 類別路徑
  • 項目是外掛程式(而不是說明程式或外掛程式指令)的指示
  • 是否必須將功能表項目新增至「工具」功能表的指示

說明 .hep 檔之必要語法的最佳方法是查看範例。

[Helpers]

跟在後面的項目種類

註: .hep 檔必須包含 [Helpers] 區段,因為說明程式識別機制是將說明程式定義包括在 rhapsody.ini 檔中時所用的識別機制,該識別機制還含有其他區段。外掛程式一般設計為供使用者群組使用,在大多數情況下,在 rhapsody.ini 檔(它對於每個使用者是唯一的)中包括外掛程式定義資訊沒有任何意義。
numberOfElements=2

在檔案中說明的外掛程式數/說明程式數

name1=Diagram Formatter

在「工具」功能表上顯示的名稱(如果 isVisible 設定為 1)

JavaMainClass1=JavaPlugin.PluginMainClass

包含外掛程式的程式碼的 Java 類別

JavaClassPath1=$OMROOT\..\Samples\JavaAPI Samples\Plug-in

用與尋找外掛程式所需 Java 類別的路徑。請記住,如果使用 .jar 檔,則類別路徑必須包括 .jar 檔的名稱。

isPlugin1=1

指出項目是外掛程式(相對於說明程式(預設值)或「外掛程式指令」)

isVisible1=1

指出必須在「工具」功能表中顯示名稱。

下面的項目說明「外掛程式指令」。

name2=Format Diagram

顯示在快速功能表中的文字

isPluginCommand2=1

指出外掛程式指令(相對於說明程式或指令)

command2=Diagram Formatter

此快速功能表項目開啟的外掛程式之名稱

applicableTo2=ObjectModelDiagram

指出將功能表新增至的環境定義。在此情況下,當您在瀏覽器中以滑鼠右鍵按一下 OMD 時,將會看到選項「格式化圖」。

isVisible2=1

指出必須顯示功能表項目

如果您要查看另一個範例 .hep 檔,請查看該外掛程式範例的 .hep 檔,其隨附於 <Rational Rhapsody 安裝路徑>\Samples\ExtensibilitySamples\
Simple Plug-in\SimplePluginProfile.hep

若要將您的 .hep 檔附加至設定檔,請執行下列其中一項動作:
  • 為 .hep 檔提供與設定檔相同的名稱,並將它放置在 .sbs 檔所在的相同目錄中
  • 在設定檔 General::Profile::AdditionalHelpersFiles 內容的值中指出 .hep 檔的路徑

回饋