NetBeans教程：淺談Help System插件
NetBeans教程：擁有描述插件的 HTML 文件之后，您必須將它們包裝在插件中，該插件將它們集成在 NetBeans 文件系統(tǒng)中。要完成此操作，您需要?jiǎng)?chuàng)建一個(gè)幫助系統(tǒng)。除了 HTML 文件之外，幫助系統(tǒng)還包含以下文件：
映射文件。 指定映射 ID 的列表，每個(gè) ID 都鏈接到特定的 HTML 文件。
目錄文件。 使用映射 ID 將幫助文件安排到目錄中。
索引文件。 使用映射 ID 將幫助文件安排到索引中。
Helpset 文件。 通過(guò)參考映射文件、目錄文件和索引文件定義幫助系統(tǒng)。
在本教程中您將創(chuàng)建這些文件中的每個(gè)文件，以及在 NetBeans 文件系統(tǒng)中注冊(cè)幫助系統(tǒng)的文件。
您可以將幫助系統(tǒng)打包到包含 HTML 文件描述的代碼的插件中，您也可以創(chuàng)建一個(gè)僅包含幫助系統(tǒng)的單獨(dú)插件。本教程假設(shè)您想讓幫助系統(tǒng)包含在單獨(dú)的插件中。但是，如果您想讓它們包含在 HTML 文件描述的插件中，則可以跳過(guò)“創(chuàng)建 Plug-in 項(xiàng)目”部分的前三個(gè)步驟。
安裝完軟件之后，本教程可以在 20 分鐘之內(nèi)完成。
如果您在編寫(xiě)和集成幫助系統(tǒng)時(shí)有問(wèn)題，請(qǐng)參閱模塊 Helpset 集成常見(jiàn)問(wèn)題解答。這些常見(jiàn)問(wèn)題解答提供本教程中未涉及的很多其他詳細(xì)信息。有關(guān)常規(guī)使用 NetBeans 插件的詳細(xì)信息，請(qǐng)參閱 NetBeans 網(wǎng)站上的 NetBeans Development Project 主頁(yè)。如果有問(wèn)題，請(qǐng)使用本頁(yè)頂部的反饋鏈接。
安裝軟件
開(kāi)始之前，需要在您的計(jì)算機(jī)上安裝以下軟件：
NetBeans IDE 5.0（下載）
Java Standard Development Kit (JDK!") version 1.4.2（下載）或 5.0（下載）
安裝示例
采用以下步驟來(lái)安裝示例： 解壓縮附加的文件。
在 IDE 中，選擇 File>Open Project，然后瀏覽到包含已解壓縮文件的文件夾。打開(kāi)模塊項(xiàng)目。其形式如下：
在NetBeans 文件系統(tǒng)中注冊(cè)幫助系統(tǒng)涉及以下文件：
Helpset 參考文件（.xml 擴(kuò)展名）。
層文件（.xml 擴(kuò)展名）。
helpset 參考文件參考 myplugin.hs 文件并使其可用于 layer.xml 文件。layer.xml 文件在 NetBeans 文件系統(tǒng)中注冊(cè)幫助系統(tǒng)。
執(zhí)行以下操作以創(chuàng)建 helpset 參考文件：
在 org/myorg/myhelpsystem 包中創(chuàng)建名為 helpset 的 XML 文檔。
用以下內(nèi)容替換默認(rèn) "-//NetBeans//DTD JavaHelp Help Set Reference 1.0//EN"
"http://www.netbeans.org/dtds/helpsetref-1_0.dtd">
按 Ctrl-S 保存文件。
如上所示，您在 layer.xml 文件中使用 Services/JavaHelp 文件夾結(jié)構(gòu)以注冊(cè) helpset 參考文件以及指定順序?qū)傩浴Ｔ擁樞驅(qū)傩灾付ㄔ诂F(xiàn)有幫助系統(tǒng)中放置該幫助系統(tǒng)的位置。例如，下例中的 helpset 文件放置在 org-netbeans-modules-usersguide-below-regular.txt 之后。
執(zhí)行以下操作以在 layer.xml 文件中注冊(cè) helpset 參考文件：
在 Projects 窗口中，展開(kāi) Source Packages 節(jié)點(diǎn)，展開(kāi) org.myorg.myhelpsystem 節(jié)點(diǎn)，雙擊 layer.xml 文件將它在 Source Editor 中打開(kāi)。在 layer.xml 文件中的
- < FONT face=NSimsun>< FOLDER name="Services">
- < FOLDER name="JavaHelp">
-
- < ATTR name="org-netbeans-modules-usersguide-below-regular.txt
- /org-myorg-myhelpsystem-helpset.xml" boolvalue="true" />
- < /FOLDER>
- < /FOLDER>< /FONT>< /CODE>
按 Ctrl-S 保存文件。
如果您想隱藏 IDE 的現(xiàn)有 helpset，則可以在 layer.xml 文件的 JavaHelp 文件夾中添加以下內(nèi)容：
- < CODE>< FONT face=NSimsun>
- < FILE name="com-sun-enterprise-tools-studio-j2ee-helpset.xml_hidden" />
- < FILE name="org-netbeans-modules-j2ee-helpset.xml_hidden" />
- < FILE name="org-netbeans-modules-usersguide-helpset.xml_hidden" />
- < FILE name="org-netbeans-modules-apisupport-project-helpset.xml_hidden" />
- < FILE name="org-netbeans-modules-web-monitor-resources-helpset.xml_hidden" />
- < FILE name="org-netbeans-modules-db-helpset.xml_hidden" />
- < FILE name="org-netbeans-modules-tomcat5-helpset.xml_hidden" />
- < FILE name="org-netbeans-modules-dbschema-helpset.xml_hidden" />
- < FILE name="org-netbeans-modules-versioning-system-cvss-resources-helpset.xml_hidden" />
- < /FONT>< /CODE>
構(gòu)建和安裝插件
IDE 使用 Ant 構(gòu)建腳本來(lái)構(gòu)建和安裝您的插件模塊。構(gòu)建腳本是在您創(chuàng)建 Plug-in 項(xiàng)目時(shí)為您創(chuàng)建的。
安裝 NetBeans 插件
在 Projects 窗口，右鍵單擊項(xiàng)目節(jié)點(diǎn)并在 Target Platform 中選擇 Install/Reload。
插件即在目標(biāo) IDE 或 Platform 中構(gòu)建和安裝。打開(kāi)目標(biāo) IDE 或 Platform 以便您可以試用新插件。默認(rèn)目標(biāo) IDE 或 Platform 是由開(kāi)發(fā) IDE 的當(dāng)前實(shí)例使用的安裝平臺(tái)。注意到當(dāng)您運(yùn)行插件時(shí)，您將使用臨時(shí)測(cè)試用戶(hù)目錄，而不是開(kāi)發(fā) IDE 的用戶(hù)目錄。
使用 NetBeans 插件
選擇 Help > Help Contents。
選擇新的“About My Plugin”主題：
單擊 Index 選項(xiàng)卡，向下滾動(dòng)到“M”部分，然后選擇您創(chuàng)建的索引：
創(chuàng)建可共享的插件二進(jìn)制文件
在 Projects 窗口中，右鍵單擊項(xiàng)目節(jié)點(diǎn)，并選擇 Create NBM。
將創(chuàng)建 NBM 文件并且可以在 Files 窗口中查看它 (Ctrl-2)：
通過(guò)電子郵件使其他人也可以使用。
【編輯推薦】
