說明系統喜好設定

您可以為一些說明喜好設定指定自訂的預設值,配合產品來配置 Eclipse 說明系統並且設定品牌。

說明系統本身分為許多不同的外掛程式。 下列表格將列出可用的喜好設定,以及定義它們的外掛程式。 有關如何置換這些喜好設定,請參閱自訂產品
 

org.eclipse.help 外掛程式:

喜好設定鍵 用法
預設值
baseTOCS 排列目錄的順序。 根據說明目錄(書籍)在書架上的出現順序,來排列其順序。 其他所有的目錄,都會列在這些書籍後面。 清單中沒有出現的目錄,一律略過不管。 請把每一個 TOC 的位置設為 /pluginId/path/to/toc.xml。 /org.eclipse.platform.doc.user/toc.xml,
/org.eclipse.jdt.doc.user/toc.xml,
/org.eclipse.platform.doc.isv/toc.xml,
/org.eclipse.jdt.doc.isv/toc.xml,
/org.eclipse.pde.doc.user/toc.xml
ignoredTOCS 停用目錄。 說明系統會忽略的說明目錄(書籍)清單。 停用的目錄不會出現在書籍清單中,無法進行鏈結。無法搜尋已停用目錄所定義的主題。 清單中沒有出現的目錄,一律略過不管。 請把每一個 TOC 的位置設為 /pluginId/path/to/toc.xml。

org.eclipse.help.base 外掛程式:

喜好設定鍵 用法
預設值
banner 要顯示在頁框頂端橫幅頁的位置
範例:banner=/org.eclipse.help.webapp/advanced/banner.html

banner_height 橫幅頁框的高度
範例:banner_height=60

help_home 在開啟說明時,顯示在內容區的網頁。 請把您的 html 網頁指定為 /pluginId/path/to/home.html /org.eclipse.help.base/doc/help_home.html
linksView 請設為 truefalse, 來控制相關鏈結視圖的可見性。
附註:這個選項不會影響 InfoCenter。
true
bookmarksView 請設為 truefalse, 來控制書籤視圖的可見性。
附註:這個選項不會影響 InfoCenter。
true
windowTitlePrefix 請設為 truefalse, 來控制瀏覽器視窗的標題。 如果是 true, 則標題格式為「說明 - <PRODUCT_NAME>」, 否則,標題為「<PRODUCT_NAME>」, 其中 <PRODUCT_NAME> 是指主要特性所設定的 Eclipse 產品的名稱。 true
loadBookAtOnceLimit 一本書最多可以擁有的主題數目(針對瀏覽器要載入成一本書的導覽)。 大型書籍的導覽是屬於動態載入,一次只載入幾層。 當分支展開時,也會根據需求而下載更多主題。 1000
dynamicLoadDepthsHint 下載到大型書籍之瀏覽器的主題導覽的建議層次數目。 該值必須大於 0。 如果建議的層次數目含有大量主題,則實際的層次數可能與寬樹狀結構不同。
3
imagesDirectory 含有說明視圖所用影像的目錄。 影像必須與 org.eclipse.help.webapp 外掛程式中的影像同名。 請使用 /pluginID/directory 格式。 images
advanced.toolbarBackground 工具列的 CSS 背景。該值是用於顯示進階說明 UI 的瀏覽器。 ButtonFace
advanced.viewBackground 導覽視圖的 CSS 背景。 該值是用於顯示進階說明 UI 的瀏覽器。 Window
advanced.toolbarFont 工具列的 CSS 字型。該值是用於顯示進階說明 UI 的瀏覽器。 icon
advanced.viewFont 導覽視圖的 CSS 字型。該值是用於顯示進階說明 UI 的瀏覽器。 icon
basic.toolbarBackground 工具列的背景顏色。該值是用於顯示基本說明 UI 的瀏覽器。 #D4D0C8
basic.viewBackground 導覽視圖的背景顏色。該值是用於顯示基本說明 UI 的瀏覽器。 #FFFFFF
locales Infocenter 會辨識和提供自訂內容的語言環境清單; 如果用戶端瀏覽器接受的語言環境(或語言),沒有一個與清單中的語言環境一樣, 則提供給瀏覽器的,是預設語言環境(伺服器語言環境或 Eclipse -nl 指令行選項所指定的語言環境)的內容; 如果沒有指定清單, 則提供給瀏覽器的,是它的偏好語言環境內容; 附註:如果沒有這個選項,可能會產生大量的記憶體和磁碟空間需求,因為在存取 Infocenter 的瀏覽器中,每一個不同的偏好語言環境都會建立導覽和索引。
範例:locales=en ja zh_CN zh_TW

productIndex 如果預先產生以及預先建置的文件索引,是附隨在產品中一起提供, 則遞送索引的外掛程式 ID,必須指定給這裡的說明系統。
always_external_browser
可能的話,儘可能採用內嵌瀏覽器(Windows 或 Linux),否則就一律採用外部瀏覽器。 如果設為 true,則會強迫使用外部瀏覽器。 如果內嵌的瀏覽器不能用在給定的平台上,則選項沒有影響。
false
default_browser

預設外部瀏覽器。其中一個提供給說明系統所要用的 org.eclipse.help.base.browser 延伸點的外部 Web 瀏覽器 ID。 瀏覽器的配接器 available() 方法,必須在現行系統傳回 true。

在獨立式說明模式中,這個喜好設定控制外部瀏覽器。 在工作台模式中,說明使用工作台瀏覽器支援所提供的瀏覽器。

根據系統上所能使用的瀏覽器,而動態設定的預設值
custom_browser_path

自訂瀏覽器的執行路俓

在獨立式說明模式中,這個喜好設定控制外部瀏覽器。 在工作台模式中,說明使用工作台瀏覽器支援所提供的瀏覽器。

C:\Program Files\Internet Explorer\IEXPLORE.EXE" %1 - on Windows,
"konqueror %1" - on Linux
"mozilla %1" - on other platforms
showDisabledActivityTopics 說明系統是從停用的功能來過濾主題。 這個選項可以控制這項行為,以及「顯示所有的主題」按鈕的存在。
下面是它所接受的值:neveroffonalways
never - 不會顯示停用功能中的主題
off - 使用者可以選擇顯示所有的主題,最初隱藏的停用主題
 on - 使用者可以選擇顯示所有的主題,所有最初顯示的主題
always - 顯示停用功能中主題(停用的過濾)
off
activeHelp 可以啟用和停用作用說明的執行作業。 這個選項在停用作用說明的 InfoCenter 設定中,沒有任何影響。
接受的值:
true - 啟用預設作用說明動作
false - 停用作用說明組織架構
true
window_infopop 在工作台視窗中按下說明鍵時,容許啟用舊式蹦現資訊。如果為 false,則會開啟新的動態說明視圖。 false
dialog_infopop
在對話框中按下說明鍵時,容許啟用舊式蹦現資訊。如果為 false,則會開啟新的動態說明視窗。
false

org.eclipse.help.appserver 外掛程式:

喜好設定鍵 用法
預設值
port 伺服器接聽 HTTP 要求的埠號。 如果未給定埠,則系統會任意挑選一個埠。  
host

連接伺服器所用的主機位址或名稱。 它沒有預設值,Eclipse 會挑選一個可以使用的本端位址。

在本端模式中(工作台或獨立式,不是 InfoCenter)使用說明的產品,可以將這個喜好設定設為 "127.0.0.1", 確保網路上的其他使用者無法使用說明伺服器。


org.eclipse.tomcat 外掛程式:

喜好設定鍵 用法
預設值
acceptCount 當所有處理執行緒的要求在使用中時,後續連線要求的佇列長度上限。 佇列已滿時所接獲的任何要求,都會遭到拒絕。 100
maxProcessors
處理這個連接器所要建立之執行緒的要求數目上限,它代表可以同時處理的要求數目上限。
75
minProcessors
處理執行緒之要求的數目,這些執行緒是在這個連接器第一次啟動時所建立。 這個屬性值應該要比 maxProcessors 的值更小。
5