模式庫內容文件表
模式庫內容文件表是一個以Eclipse中的 toc 格式存儲的XML文件。該文件提供三種服務: 它鏈接庫的生成幫助文件到Rational Software Architect Pattern的在線幫助 它為庫描述幫助主題 它提供一個錨,以便在庫中的模式可以插入幫助
模式庫內容文件表儲存在 PatternHelp 目錄中,而且它以模式的名字附加上 ToC.xml 作為名字。在你的例子項目中,模式庫內容文件表是 MyPatternsToC.xml 。
因為目錄表如此重要,讓我們更深入地探討。列表 3顯示 MyPatternsToC.xml 文件的內容:
列表 3. MyPatternsToC.xml 文件生成的模式庫的內容文件表規定了一個為模式庫命名的主題。模工庫主題指向生成的模式庫幫助內容文件。在模式庫主題里面,目錄表定義了它自己的錨點。
toc 元素包含一個鏈接屬性。該屬性在Rational Software Architect中的模式功能幫助下面顯示MyPatterns 庫的幫助。模式的在線幫助提供一個在標準在線幫助toc文件中稱為morePatterns的錨。所有的模式庫可以鏈接到這個錨,所以,所有的已安裝的模式都在相同的在線幫助集裝箱(或工作。┲斜灰黄痫@示。結果是,所有的模式信息和相關的在線幫助在相同的位置被統一起來。
模式幫助內容文件
對于每個模式,有三個內容文件被建立,它們包含來自模式的 RAS 的聲明文件的信息。關于模式的 RAS 聲明是在以模式命名的目錄中,包含關于模式和參數的信息。在例子項目中,Pattern1.rmd 和 Pattern2.rmd 是關于 Pattern1 和 Pattern2 RAS 的聲明文件。
所有的內容文件都可以在以模式命名的目錄下的 PatternHelp 目錄中找到。下面是關于這些文件的一個簡短描述: 概覽內容文件:這一文件包括關于模式的一般信息,如簡短描述,版本,作者和模式所屬的組列表。當模式應用者在模式瀏覽器或應用模式向導中觸發Show Pattern Documentation命令時,概覽文件被顯示出來。它的文件名是在模式名后面附加 Overview.html 。在例子項目中,Pattern1Overview.html 和 Pattern2Overview.html 分別是 Pattern1 和 Pattern2 的概覽文件。 描述內容文件:該文件允許你提供如何應用模式的細節描述。如果你沒有使用模式作者視圖中的Import Description File相關菜單引入描述,該頁將只包含模式的名稱。該文件的名字通過在模式名后附加 Description.html 生成。在例子項目中,Pattern1Description.html 和 Pattern2Description.html 是描述文件。 參數內容文件:該文件包含關于模式參數的信息。文件被分成幾部分,每部分說明一個參數。每個部分均包含類型,可見性,多樣性,ID 和參數描述。如果你沒有使用Import Description File相關菜單命令來導入描述,描述區域將是空白的。該文件通過在模式名后增加 Parameters.html 命名。在例子項目中,參數內容文件是 Pattern1Parameters.html 和 Pattern2Parameters.html 。
模式內容文件表
模式內容文件表是一個XML文件,它符合Eclipse中的 toc 文件格式。該文件鏈接到在模式庫內容文件表中定義的錨。它包含為模式命名的標題,就如在前一節中描述的三個幫助內容文件。
讓我們看看 Pattern1 的目錄表,你會發現主題是如何被安排的。列表 4顯示 Pattern1ToC.xml 文件的內容:
列表 4. Pattern1ToC.xml 文件的內容注意,toc 元素包含一個向后鏈接屬性,它指向在模式庫目錄表中定義的錨點。因此,Pattern1 的幫助是嵌在Eclipse 幫助系統的模式庫預定中。
在plugin.xml 中引用內容文件表
為模式庫插入的 plugin.xml 文件必須為每個模式內容文件表包含 toc 元素。每當生成內容文件表時,幫助生成過程增加 toc 元素。
文章來源于領測軟件測試網 http://www.k11sc111.com/