說明系統
「說明系統」外掛程式 org.eclipse.help 定義兩個延伸點("contexts" 和 "toc"),
它們可讓個別外掛程式提供其元件的內容相關輔助說明及線上說明。
是一般提供文件的外掛程式,會使用延伸點。
其他的延伸點提供說明系統的擴充功能。
如果是更進階的應用程式,就會有另一個延伸點 ("support") 用來外掛說明系統 UI。
延伸點
下列延伸點可用來延伸說明系統:
喜好設定
可在說明系統中使用下列喜好設定:
-
log_level:表示寫入至說明日誌的資訊類型。使用其中之一的樹狀結構值。
- 0: 只記載錯誤
- 1: 記載錯誤和警告
- 2: 記載錯誤、警告和(除錯)資訊訊息
- banner:容許應用程式品牌化的說明檢視畫面。
如果您要在說明檢視畫面的頂端顯示公司標誌或其他東西,指定
您的 HTML 為 /pluginId/path/to/banner.html。
目前預設的 Banner 是 /org.eclipse.help.webapp/banner.html。
若您設定這個名稱為空字串,則不會顯示任何 Banner。
- banner_height:Banner 區域的高度。目前預設值為 45。
- help_home:這個頁面顯示開啟說明時的內容區域。指定 HTML 頁面為 /pluginId/path/to/home.html。
目前預設的首頁為 /org.eclipse.help/doc/help_home.html。
- linksView:設定為 True 或 False,以控制相關的鏈結檢視畫面的可見性。
- baseTOCS:說明 TOC(書籍) 的已排序的清單,如同他們出現在書架上。所有其他 TOC 將遵循這些書籍。忽略此清單上未出現的 TOC。每一個 TOC 所使用的位置為 /pluginId/path/to/toc.xml。