文件和幫助創作工具提供商Innovasys實用教程(二)

ymy_666666發表於2019-02-14

Innovasys是一家成立於1997年的文件和幫助創作工具提供商,致力於使廣大開發人員和技術方面的作家能夠生成專業質量的文件、幫助系統和程式。

本系列教程主要討論Innovasys的實用性提示與技巧,有任何建議或提示請在下方評論區留言,我們會及時處理。

建立自定義模板

方法一:通過構建配置檔案編輯器建立自定義模板

這種方法需要轉到構建配置檔案編輯器,然後選擇Templates。單擊要編輯的模板型別旁邊的下拉選單,然後選擇Create New,這將開啟已填充了基本模板的新模板對話方塊。最後您需要為自定義模板命名,自定義模板將在您建立的構建配置檔案中自動選擇。

方法二:通過Options選單建立自定義模板

您還可以從Options選單(位於Application選單中)中建立新的自定義模板。這需要在Options選單的模板部分中導航,然後單擊工具欄中的Create New按鈕,並選擇相關的基本模板,建立自定義模板後它將自動開啟以進行編輯。注意:如果從選項選單中建立自定義模板,則必須選擇新的自定義模板,以便建立後在構建配置檔案編輯器中使用。

編輯自定義模板

如果要編輯當前在構建配置檔案編輯器中選擇的自定義模板,則需要點選自定義模板旁邊的Edit Template按鈕。如果要編輯當前未選擇的模板,則需要導航到Options選單的Custom Templates。然後選擇自定義模板,從工具欄中選擇Edit按鈕。

使Web服務架構圖可摺疊

這裡將解釋如何使Web服務模式中的圖表可摺疊,如果您有非常大的圖並希望避免使用垂直滾動條,這將對您非常有用。在進行這一步操作前建議先參考上文提到的如何建立自定義模板。

在這種情況下,相關的基本模板是Classic Web Service Documentation。建立模板並進行編輯後,您需要導航到模板編輯器中的Scraps頁面並找到_REQUEST_LIST_BODY和_SUCCESS_RESPONSE_LIST_BODY檔案。然後單擊頂部的Edit按鈕對REQUEST_LIST_BODY和SUCCESS_RESPONSE_LIST_BODY進行編輯。

它圍繞響應和請求部分中的圖表以及可摺疊標題。您最終需要確保在構建配置檔案中使用這些模板,右鍵單擊構建配置檔案,選擇Edit,然後在出現的Build Profile Editor中導航到Templates。最後從Web Service Documentation下拉框中選擇Custom template,重建後您的圖表現在應該如下所示:

文件和幫助創作工具提供商Innovasys實用教程(二)

如何刪除目錄圖示

如果您希望為瀏覽器輸出建立簡約的外觀,瞭解如何刪除目錄圖示將非常有用。內建的選項無法從材質模板中的目錄中刪除圖示,但您可以使用自定義模板實現此目的。 介於此建議參考上文介紹的如何建立自定義模板。

在這種情況下,瀏覽器材料模板將是基本模板。建立自己的自定義模板後,開啟進行編輯。然後導航到Other files部分並找到toc.css檔案(位於Other Files > template > packages > core-web > css)。您需要在toc.css的底部包含以下CSS :

/* Remove Icon Image */
ul#i-root a > ins.i-icon {
 display: none;
 }複製程式碼

最後您需要儲存自定義模板,然後開啟構建配置檔案編輯器,並在Browser Help Navigation的Template頁面下選擇新的自定義模板。您的目錄將如下所示:

文件和幫助創作工具提供商Innovasys實用教程(二)

更多Innovasys實用教程敬請關注!


相關文章