手動整合在線幫助
如果你不喜歡使用自動幫助生成,你可以提供幫助文件并且鏈接到Patterns Help錨,這樣在線幫助中將出現與自動生成文件一樣的目錄表部分。本節描述鏈接你的模式幫助到Rational Software Architect的模式在線幫助的步驟。
本節引用 MyPatterns 例子項目。為了回顧一下,列表 5顯示在加入幫助前的PatternFiles 目錄樹:
PatternFiles/ Pattern1/ Pattern1.emx Pattern1.rmd Pattern2/ Pattern2.emx Pattern2.rmd MyPatterns.rmd列表 5. PatternFiles 目錄樹下面的步驟描述如何把目錄和文件加入項目,以便使幫助對于 Pattern1是可用的。
應用你的模式的任何人都可以通過在模式瀏覽器選擇特定模式并從相關菜單中選擇Show Pattern Documentation來獲得它的幫助。模式用戶界面開啟在線幫助,與在內容面板表中所選擇的模式主題一起,顯示關于模式的概覽頁面。
為了在不使用內建的幫助生成器的情況下提供這一能力,你必須提供一個以模式名附加Overview.html結尾的文件,以便應用程序界面可以顯示幫助。這一文件必須在預期的目錄結構中:一個以模式命名的目錄,一個名為PatternHelp的子目錄。為了使你的模式成為在線幫助窗囗的目錄表的一部分,你必須鏈接到模式幫助提供的錨。
按照這些步驟嵌入幫助: 創建一個作為你的模式幫助主頁的 HTML 文件。這個文件應該以模式名來命名,并附加上Overview.html。 把該頁放在上面描述的目錄結結構中:一個以模式名命名的目錄中的PatternHelp子目錄。 建立一個具有鏈接屬性的XML toc文件指向 /com.ibm.xtools.pttrn.user.doc/applypattern_TOC.xml#morePatterns。 增加你想要包括的任何主題的主題元素到XML toc 文件。確定包括了你在第 1 步中創建的主題概覽文件。 增加內容文件表的引用到你的 plugin.xml 文件。你可以通過Eclipse打開 plugin.xml 文件,單擊Extensions標簽,選擇org.eclipse.help.toc擴展,并使用關聯菜單來增加一個新的 toc 元素。
在接著為為Pattern1提供了幫助后,MyPatterns 例子項目看起來象在列表 6 中顯示的那樣:
PatternFiles/ Pattern1/ PatternHelp/ Pattern1Overview.html MyTableOfContents.xml Pattern1.emx Pattern1.rmd Pattern2/ Pattern2.emx Pattern2.rmd MyPatterns.rmd列表 6. MyPatterns 例子項目MyTableOfContents.xml 文件看起來應該象列表 7 這樣:
列表 7. MyTableOfContents.xml 文件在Eclipse Help目錄表中的 Pattern1 主題列表將與具用幫助生成功能的庫列表在同一級別出現。這是因為鏈接屬性指向由Rational Software ArchitectPatterns功能定義的錨點。如果你想要模仿生成的幫助的結構,你可以提供你的庫的幫助內容文件(HTML),并命名用鏈接屬性把它放到模式功能幫助中。然后,你可以使用標準的Eclipse幫助toc結構在你的庫主題下,為你的模式定義主題。
為了測試你的幫助,運行Rational Software Architect的調試工作臺。在模式瀏覽器視圖中右鍵點擊你的模式,并選擇Show Pattern Documentation。一個Eclipse Help窗囗將與你的文件一塊右邊面板中打開,同時你的文件的主題將在左邊面板中被選擇。如果文件在右邊出現,但是左邊的主題并未被選擇,可能是你的目錄文件表存在問題。如果你見到模式沒有幫助的信息,這意味模式用戶界面無法找你的概覽文件;檢查你已經在預期的目錄中建立它并且把它命名為先前第 1 步所描述的名字。
結論
本文描述了你可以如何為模式和模式庫生成在線幫助,及生成的幫助是如何與標準的在線幫助相連接。然后,它顯示了你如何通過定義一個類似的結構來為模式提供你自己的幫助目錄。
參考資料 您可以參閱本文在 developerWorks 全球站點上的英文原文。
Help -- Part 1: Contributing a Little Help (Revised for 2.0)一文提供關于開發在線幫助插件及在幫助系統中使用錨的信息。
從Trials and betas可以獲得Rational Software Architect的評價版本。
關于Rational產品的更多技術資源,請訪問developerWorks 中國網站 Rational 專區。你將會找到技術文檔、教程、下載、產品信息及更多的其他信息。關于Rational Software Architect的特定信息,請訪問RSA 技術資源頁面。
可以通過訪問Rational Software Architect的產品頁獲得更多與產品有關的信息。
關于Eclipse 3.0 平臺的細節及更多信息,請訪問Eclipse 主頁。
通過參與developerWorks blogs獲得有關developerWorks的交流。
在the Rational Software Architect, Software Modeler, Application Developer and Web Developer forum提出與Rational Software Architect相關的問題。
在Developer Bookstore 的 Rational 部分可以買到打折的Rational書籍。
請一定細讀 Rational Software Architect 中的幫助頁。這些頁的面提供大量的信息,包括多媒體導航和演示。
文章來源于領測軟件測試網 http://www.k11sc111.com/