Eclipse提供了一種用於顯示迷你型指南的內置機制稱為備忘單(cheat sheet)備忘單可以快速而有效地指導您如何在Eclipse中執行包含多個步驟的過程它顯示在工作台的邊角處您可以容易且快速地查看它們
本教程演示了如何為Eclipse構造備忘單構造完畢之後它們還可以運行在BEA Workshop StudioBEA Workshop for WebLogic和其他任何Eclipse系統之上或許能對您現有的工具和插件進行補充示例下載中提供了個准備好的備忘單其中一個備忘單用於說明如何構建您自己的備忘單
簡介
Eclipse為備忘單這個小而精致的功能提供了本地支持備忘單可以為標准而又詳細的任務提供快速指導為了在Eclipse環境中顯示可用的備忘單可以單擊Help > Cheat Sheets or Window > Show View > Other > Cheat Sheets > Cheat Sheets > OK
備忘單以視圖的形式出現在工作台的右側便於用戶同時閱讀和執行備忘單中的指導下面給出了一個示例
圖 備忘單視圖
使用備忘單的目的是引導您完成一個過程所以在完成備忘單中的某一個步驟之後可以單擊該步驟底部的圖標下一個步驟就會自動出現單擊 圖標可以打開與備忘單中當前步驟有關的幫助頁面
您可以使用其他人提供的備忘單也可以創建自己的備忘單是一種理想的方式可以讓團隊中的每個人了解如何進行標准但不是很頻繁的操作比如訪問內部(inhouse)API或連接到遺留應用程序您在便條上記下的一系列步驟也可以作為備忘單的候選內容備忘單保存在JAR文件中您可以很容易地與其他人共享它們
正如您期望的那樣Eclipse還提供了一些簡單的工具用於將備忘單組裝成插件並將得到的JAR文件放入當前安裝中簡言之在一個插件項目中可以創建許多備忘單(每個備忘單都在它們自己的XML文件中)然後以JAR文件的形式導出它們最後將它們放入本地eclipse/plugins文件夾中
您可以在支持插件開發功能的任意Eclipse實例中創建備忘單比如BEA Workshop for WebLogic
編寫自己的備忘單
本教程將引導您遍歷在Eclipse中從頭到尾創建一個備忘單的整個過程總的說來必須執行以下步驟
建立一個用於創建備忘單文件的項目
創建一個包含備忘單文本的XML文件
定義備忘單屬性
將備忘單導出為JAR文件
將JAR文件復制到Eclipse文件夾中
訪問備忘單
以上步驟均十分簡單請打開您的Eclipse讓我們開始吧
步驟 建立一個用於創建備忘單文件的項目
一開始選擇File > New > Project並從New Project wizard展開PlugIn Development然後選擇Plugin Project如圖所示使用BEA Workshop for WebLogic 時必須單擊Show All Wizards選項來查看這些項目類型
圖 創建一個插件項目
在下一個對話框上指定項目名稱確保沒有選中Create a Java project選項如圖所示在創建涉及Java動作的更加復雜的備忘單時必須選中這個選項而對於只做啟動向導這類簡單工作的備忘單則不需要創建Java項目
圖 新的插件項目
在下一個對話框上使用您或您公司的名稱填寫provider字段(參見圖)單擊Finish便可創建項目
圖 插件內容
向導還會提示您轉到Plugin Development您應該單擊Yes
至此您已經創建了一個空的備忘單項目現在可以開始給它填充內容了
步驟
創建一個備忘單XML文件
您創建的每個備忘單都必須有自己的XML文件這些文件包含備忘單的文本內容備忘備結構十分簡單一個<intro>塊後面跟著多個<item>塊每個<item>塊分別對應著備忘單中的每一個步驟格式選項被限制為<b></b>和<br />
以下示例提供了一個由兩個步驟組成的備忘單
<?xml version= encoding=UTF?>
<cheatsheet title=Demo Cheat Sheet> <intro >
<description> This cheat sheet is a demo
</description> </intro>
<item title=Hello world! > <description>
This is the <b>first</b> step in this cheat sheet
<br /> </description> </item>
<item title=Hello world again! > <description>
This is the <b>second</b> step in this cheat sheet
<br /> </description> </item></cheatsheet>
在您的Eclipse插件項目中創建一個XML文件然後將備忘單的文本內容復制到其中該XML文件可以位於任何位置但最簡單的做法是將它放在項目的根文件夾中
步驟 定義備忘單屬性
完成備忘單XML文件的創建之後必須給項目添加Eclipse備忘單擴展因為它不是必需的插件因此默認情況下沒有安裝它接著必須給備忘單創建一個分組並將您的備忘單插入該組中訪問備忘單時可以看到分組/分類名稱當您單擊展開它時可以看到所有的備忘單(在本教程中僅有一個備忘單)
在PlugIn Development透視圖中主視圖提供了一組用於設置插件屬性和選項的選項卡
步驟 給項目添加備忘單擴展
用於支持備忘單的Eclipse功能(擴展)在默認情況下沒有被選中在可以創建備忘單之前必須指定備忘單與該擴展有關要給項目添加備忘單擴展請單擊視圖底部的Extensions選項卡然後單擊Add
接著在New Extension對話框中確保Show only extension points from the required plugins選項是禁用的單擊orgeclipseuicheatsheetscheatSheetContent然後單擊Finish(參見圖)
圖 創建一個新擴展
您將會被請求確認是否想把這個擴展點添加為插件依賴項單擊Yes進行確認
步驟 給備忘單添加類別
創建的所有備忘單都將統一分組成一個類別(頂級分組)要創建該類別請在Extensions選項卡上右擊Cheat Sheet擴展然後選擇New> category如下所示
圖 新建類別
一個新的類別會出現而且您可以自定義這些設置一定要指定類別的name值因為這個名稱將會出現在描述該類別的Eclipse中
圖 擴展元素細節
要特別注意id因為您需要在備忘單的定義中指定ID字符串
步驟 將備忘單添加到類別中(每個備忘單一次)
要添加備忘單請右擊Extensions選項卡上的Cheat Sheet擴展然後選擇New > Cheat Sheet
圖 新建備忘單
一定要指定備忘單的名稱類別的類別ID以及包含備忘單內容的XML文件的名稱
對於每個希望添加到類別中的備忘單只需重復這個步驟即可
至此您已經創建了備忘單的內容並完成了使備忘單在Eclipse中可見的虛擬過程
步驟 導出備忘單JAR文件
要使用備忘單必須將它導出為JAR文件並將此JAR文件復制到Eclipse插件目錄下以便下一次啟動Eclipse時能夠找到它們
在導出備忘單之前通過單擊Build選項卡並確保在Binary Build部分中選中了所有的XML文件確保構建過程中包含所有的備忘單XML文件確保選中了除project和buildproperties之外的所有屬性因為這兩個屬性與Eclipse插件項目結構相關而不是與備忘單的內容相關
另外選擇 File > Save All 來確保所有文件和設置得到保存
要創建備忘單JAR文件請在Overview選項卡上單擊Export Wizard鏈接您需要做的只是指定應該用來存放JAR文件的位置並選中Package plugins as individual JAR archives選項單擊Finish便可導出該文件如圖所示
圖 導出JAR文件
步驟 將JAR文件復制到Eclipse插件文件夾中
對於Eclipse用戶需要將JAR文件復制到ECLIPSE_HOME/plugins文件夾中
對於 BEA Workshop for WebLogic 用戶需要將JAR文件放入WORKSHOP_HOME/workshop/workshopWP/eclipse/plugins文件夾中
對於 Workshop Studio用戶需要將JAR文件放入STUDIO_HOME/Workshop/eclipse/plugins文件夾中
現在重新啟動Eclipse以便找到這些備忘單JAR文件
步驟 : 訪問備忘單
單擊Help > Cheat Sheets來顯示Cheat Sheets 視圖
如果Help > Cheat Sheets命令不可用單擊Window > Show View > Other然後選擇Cheat Sheets > Cheat Sheets單擊OK現在通過單擊位於Cheat Sheet頂部的下拉式菜單並選擇Launch Other就可以打開您的備忘單您的備忘單類別將顯示在組的列表中而且您可以展開這個類別並選擇您的備忘單
結束語
本教程提供了創建一個備忘單的基本步驟事實上也沒有更多可以說的內容備忘單提供的格式選項不多因為它們的目標就是引導您完成一系列步驟我們沒有討論到的內容是如何讓備忘單啟動一個向導(例如創建一個新的項目)或者Eclipse中的一些其他動作如果大家有足夠的興趣我們以後還會發布有關這個主題的更多內容
From:http://tw.wingwit.com/Article/program/Java/ky/201311/28019.html