Posted on 2007-10-25 10:30
寒武紀 閱讀(8950)
評論(3) 編輯 收藏 所屬分類:
Eclipse
開發基于Eclipse開的RCP軟件可以直接加入Eclipse的幫助系統，使您的產品更加完善。Eclipse幫助系統提供的良好組織模式以及基于lucene的全文搜索功能。在Eclipse的網站上有一篇文章專門介紹如何為Mail示例RCP添加幫助系統的，但是寫的不完全，按照里面的說明添加后無法正常地顯示幫助框架。網上有少部分文章也提及這個主題，但是都沒有說明白。
經過一翻摸索，最后終于折騰出來，在這里記錄下面，與大家分享。如果你做過RCP產品，下面這些內容應該很熟悉。
1. 添加幫助的菜單。
在ApplicationActionBarAdvisor類中加入幫助菜單項。代碼片斷如下：
//幫助
private IWorkbenchAction helpAction;
/**
* 創建操作
*/
protected void makeActions(IWorkbenchWindow window) {
....
/* 幫助 */
.....
helpAction = ActionFactory.HELP_CONTENTS.create(window);
register(helpAction);
.....
}
/**
* 填充主菜單
*/
protected void fillMenuBar(IMenuManager menuBar) {
/* 主菜單欄 */
IMenuManager mainMenu = getActionBarConfigurer().getMenuManager();
MenuManager helpMenu = new MenuManager("幫助(&H)", IWorkbenchActionConstants.M_HELP);
helpMenu.add(introAction);
helpMenu.add(helpAction);
....
mainMenu.add(helpMenu);
}
2. 添加相關的依賴項。
打開plugin.xml，轉到"依賴項"的tab頁,點擊"添加"按鈕，需要加入下面的這些依賴項：
1. org.apache.lucene
2.org.eclipse.help.appserver
3.org.eclipse.help.base
4.org.eclipse.help.ui
5.org.eclipse.help.webapp
6.org.eclipse.tomcat
7.org.eclipse.ui.forms
3. 添加org.eclipse.help.toc擴展點
這個非常容易，轉到"擴展"tab頁，點擊“添加”按鈕。網上或是相關的書籍有很多關于添加help內容的介紹，為了節省篇幅，這里直接添加一個擴展向導來完成。選擇"擴展向導"-->"幫助內容"，確定后可以看到“所有擴展”的列表中多了一個org.eclipse.help.toc擴展，這里可能需要修改一下，生成的toc.xml和testToc.xml里面的label屬性標簽不能是亂碼，不然幫助框架會讀不出，到時候顯示不出幫助的組織結構。
結構如下：
<extension
point="org.eclipse.help.toc">
<toc file="toc.xml"/>
<toc
file="testToc.xml"
primary="true"/>
</extension>
4. 部署產品配置
為您的RCP添加一個產品配置，打開產品配置編輯器（xxx.product），轉到"配置"tab頁，點擊“添加”，加入你的插件，然后點擊“添加必需的插件”,這樣在“插件和段”列表會看到你的插件以及你的RCP要完整啟動的所有必需相關插件。在這里你應該看到你在plugin.xml中依賴的那七個help相關的插件，以及一些以nl1結尾的插件，這些是語言插件。保存，轉到“概述”tab頁，點擊"啟動產品"。然后打開“幫助--> 幫助內容”，就可能看到你的幫助系統了。
到此一個完整的幫助系統就完成了。下面是一個截圖：
剛進場的時候戲就落幕