建立自訂說明檔

自訂說明檔必須採用 HTML 格式。範例說明檔名稱:myhelp.htm

關於這項作業

如果您要與團隊成員共用自訂說明檔,請將它放置在網路上的共用位置。您在 Model::Stereotype::CustomHelpURL 內容中識別此檔案及其位置。

自訂說明檔的對映檔必須包含一個以上為其提供自訂說明的 IBM® Rational® Rhapsody® 資源 ID。資源 ID 對應於產品中的特定 GUID 元素。例如,對於屬性標籤,資源 ID 是 161328。

若要尋找資源 ID:

程序

  1. 將下列行新增至 rhapsody.ini 檔中的 [General] 區段並儲存變更:

    ShowActiveWindowHelpID=TRUE


    這表示現在當您按 F1 鍵以開啟 Rational Rhapsody 說明檔時,將會顯示具有該資源 ID 的視窗,如下一步中所示。
  2. 對於要與「新項目」模板相關聯的 GUID 元素(例如,如果「新項目」模板適用於類別,則「特性」視窗上的屬性標籤)按 F1 鍵。
  3. 將資源 ID 號碼新增至說明對映檔。每個號碼必須在它專屬的行上。下圖顯示名為 myhelp.map 的對映檔之內容。(對映檔名稱的另一個範例:myhelp.txt。)
    註: 為了測試方便,請將下圖中顯示的資源 ID 包括在對映檔中。日後可以刪除這些 ID。
    列出資源 ID 號碼的對映檔
    註: 您可能會發現,將元素的名稱新增至資源 ID 號碼旁邊很有用(例如,161328 Attributes tab)。
  4. 如果您要與團隊成員共用自訂說明檔,請將說明對映檔放置在網路上的共用位置。您在 Model::Stereotype::CustomHelpMapFile 內容中識別此檔案及其位置。
    註: 對映檔完成後,為了確保當按 F1 鍵時說明主題而不是資源 ID 號碼出現,可以註銷 rhapsody.ini 檔案中的 ShowActiveWindowHelpID=TRUE 行(例如,在該行的前面插入分號或井號),或者可以刪除該行。

回饋