說明伺服器和檔案位置

平台利用自己的文件伺服器提供實際網頁給外掛程式文件。自訂伺服器可讓平台 採取與瀏覽器無關的方式處理 HTML 內容,並提供外掛程式方面的(知識)支援。對於您 身為外掛程式開發人員來說,主要差異是您在建構檔案和指定鏈結的方法上會有多一點 彈性。

文件外掛程式可以從 Jar 檔執行,或於安裝期間解開套裝到外掛程式目錄中。當特性 Manifestplugin 元素的 unpack 屬性值指定為 true 時,外掛程式保存檔 JAR 不會展開到外掛程式目錄中。在這類的外掛程式中,文件是和其他的外掛程式檔案一起壓縮在外掛程式的 jar 中。

在執行解開套裝的外掛程式中,您可以將文件放在 zip 檔中遞送,以避免在外掛程式目錄中有大量檔案時可能導致問題。在範例外掛程式中,我們建立一個稱為 html 的子目錄。另外,我們可以將 html 檔放在一個稱為 doc.zip 的 zip 檔中。 這個 zip 檔必須模擬外掛程式目錄下面的檔案結構。 在我們的案例中, 它必須包含子目錄 html 以及 html 下面的所有內容。

請注意,針對從 JAR 執行的外掛程式,文件並不需要另外包含在 doc.zip 中,且說明系統也不支援未解開之外掛程式 JAR 中 doc.zip 的這類設定。

在解析解開後執行之外掛程式中的檔案名稱時,說明伺服器會先查看 doc.zip 檔以找出文件,再查看外掛程式目錄本身。href 中的引數若作為鏈結使用時,是假設它相對於現行外掛程式。請考量下列鏈結:

   <topic label="Ref1" href="html/ref/ref1.html"/>

下列說明外掛程式將尋找這個檔案:

可用來參閱 Web 上任何內容的完整鏈結。

   <topic label="Ref1" href="http://www.example.com/myReference.html"/>

國家語言文件及翻譯文件

平台說明系統使用與其他平台相同的國家語言目錄查閱綱要,以找出翻譯的檔案。(請參閱本端特定檔案 以取得目錄結構的詳細解釋。)如果您正在使用 doc.zip 檔, 應該為每一個語言環境產生 doc.zip 檔,並將它放置在正確的語言環境目錄中。 (您不應該在 doc.zip 檔中複製 nl 語言環境目錄結構。)

除了語言環境專屬的目錄之外,在尋找說明資源時,說明系統還會檢查視窗化的系統和作業系統目錄。請以下列順序執行查閱: wsosnl 子目錄,接著是外掛程式的根目錄, 直到找到資源為止。文件和其他資源(像是在系統之間有所不同的影像), 應該放在特定平台的 ws 或 os 目錄下。

跨外掛程式參照

href 引數可參閱其他外掛程式的內容。請使用說明伺服器所解析的特殊跨外掛程式參照註釋來完成:

   <topic label="Ref1" href="../"another_plugin_id"/ref/ref1.html"/>

例如,您可以使用下列主題鏈結至程式設計師手冊的這一章節:

   <topic label="Help Chapter in Platform Doc" href="../org.eclipse.platform.doc.isv/guide/help.html"/>

附註:從其他外掛程式參照內容時,請確定外掛程式的 ID,如同在它的 plugin.xml 檔中所宣告的, 而不是它的目錄名稱。當練習時這些都是相同的,所以檢查您是使用 ID 而非目錄名稱是很重要的。

參照「產品」外掛程式

品牌行銷資訊通常會放在一個定義產品的外掛程式中(如定義產品的說明)。產品外掛程式中的說明資源可以使用特殊 ID "PRODUCT_PLUGIN" 作為外掛程式 ID, 從目錄或主題中參照。例如:

   href="../PRODUCT_PLUGIN/book.css"

請參考位於目前執行產品之外掛程式中的樣式表。