翻譯|使用教程|編輯:況魚杰|2019-08-02 15:13:22.810|閱讀 549 次
概述:本教程是幫助制作文檔工具Document! X 和HelpStudio的使用小技巧第七條:介紹如何使用Microsoft Help Viewer創建模塊化幫助。
# 界面/圖表報表/文檔/IDE等千款熱門軟控件火熱銷售中 >>
相關鏈接:
Innovasys是一家成立于1997年的文檔和幫助創作工具提供商,致力于使廣大開發人員和技術方面的作家能夠生成專業質量的文檔、幫助系統和程序。本系列教程主要討論Innovasys的實用性提示與技巧,有任何建議或提示請在下方評論區留言,我們會及時處理。
本主題包含有關Microsoft Help Viewer的信息,該幫助系統是Visual Studio 2010以上的幫助系統。Microsoft Help Viewer只能用于創建與Visual Studio幫助系統集成的幫助材料,不適用于通用幫助系統。
如果要將多個不同的幫助系統部署為單個產品的一部分,您可能希望創建一個父項目,包括登錄頁面或其他一些傘形主題,以便為用戶提供方便的鏈接鏈接到不同的幫助系統。在Microsoft Help Viewer中,可以通過在子幫助系統中的根主題上設置TocParentId來標識公共父主題,并使用特定的Microsoft Help Viewer鏈接格式從父主題鏈接到子幫助系統中的主題來實現。 。
創建父項目
父項目要包含在Microsoft Help Viewer目錄的根目錄中顯示的主題。編寫所需主題,并使用目錄編輯器組織所需層次結構中的主題。
在此示例中,組件文檔主的題是我們希望子項目中主題出現的位置。這可以是項目中的任何主題,這個由您決定哪個主題在您的方案中會比較有意義。
為了將子項目中的主題連接到父項目主題,我們將需要組件文檔主題的主題ID。我們可以通過構建項目,在生成的輸出中打開該主題,右鍵單擊內容并從幫助查看器上下文菜單中選擇查看源來實現此目的。在顯示的源中,您可以在Microsoft.Help.Id元標記中找到主題ID,例如 :
主題是content屬性中的值 - 在此示例中為53468d8a-a886-482e-8bce-90c32091a564。
配置子項目
現在,您需要設置子項目中每個根主題的TocParentId屬性,設置為您希望它們顯示在Microsoft幫助查看器目錄下面父項目中主題的主題ID。您可以通過在Project Explorer中選擇Topic來設置此屬性 - 然后在Properties窗口中顯示屬性。如果您有多個與同一TocParentId關聯的主題,則可以將TocOrdinal設置為將用于對子主題進行排序的數字。
注意:僅當您將構建配置文件配置為生成Microsoft Help Viewer輸出時(在構建配置文件編輯器中的格式頁面上),才會顯示這些屬性。
為了保持結構簡單,并避免在目錄中混淆,您可能需要在子幫助系統中創建單個根主題,在該主題下可以包含所有其他主題。這也將簡化配置 - 您只需要在該單個根節點上設置TocParentId即可。
建立兩個項目
您現在應該構建這兩個項目,并在Microsoft Help Viewer中檢查布局是否符合要求。
父與子主題之間的鏈接
您可以使用主題ID在父與子主題之間創建鏈接。
注意:通過在Microsoft Help Viewer中查看主題,右鍵單擊內容并從幫助查看器菜單中選擇查看源,可以在生成的輸出中找到給定主題的主題ID。在顯示的源中,您可以在Microsoft.Help.Id元標記的content屬性中找到主題ID。
例如,您可以在父項目中的主題內創建指向子項目中主題的鏈接。您可以通過在鏈接到網頁或其他Internet URL頁面上的鏈接設計器中鍵入Microsoft Help Viewer特定的鏈接格式來完成此操作。
鏈接格式為:ms-xhelp:///?method = page&id = [target_topic_id] ,其中[target_topic_id]是您要鏈接到的主題的主題ID。
您可以通過這種方式在Parent>Child、Child>Parent或者不同的Child項目中創建鏈接。
示例項目
下載父項目和子項目的示例,該項目說明了本主題中描述的模塊化Microsoft Help Viewer幫助的技術。以下是示例圖片:
關注慧聚IT微信公眾號 ???,了解產品的最新動態及最新資訊。
本站文章除注明轉載外,均為本站原創或翻譯。歡迎任何形式的轉載,但請務必注明出處、不得修改原文相關鏈接,如果存在內容上的異議請郵件反饋至chenjj@fc6vip.cn
文章轉載自: