範例 - Readme 工具

簡介

Readme 編輯器顯示了如何定義您自己的延伸點,讓其他外掛程式使用。 它亦顯示如何建立資源蹦現功能表項目的副檔名、新資源精靈、副檔名為 (.readme) 的檔案編輯器、 自訂檢視與內容頁面。

執行範例

若要開始使用此範例來建立具有 .readme 副檔名的檔案, 請使用檔案建立精靈,或使用範例建立精靈來建立。 可以選取視窗 > 顯示視圖 > 其他,並展開 Readme 區段檢視此範例所提供的其他視圖。可以按一下「導覽器視圖」 的 Readme 圖示檢視視圖動作。

建立新的 README 檔

建立具有副檔名 .readme 的新檔案。請從「檔案」功能表, 選取「新建」,然後從子功能表中選取「其他...」。在精靈中按一下「簡式」, 然後在左側的清單中選取「檔案」。按「下一步」以提供檔名(請確認副檔名為 .readme) 與包含檔案的資料夾名稱。

範例建立精靈

從「檔案」功能表,選取「新建」,然後從子功能表中選取「範例...」,現在,請選取「範例建立精靈」。選取 README 檔。按「下一步」。 選取要建立檔案的資料夾。輸入具有 .readme 副檔名的檔案名稱。按一下「完成」。

Readme 檢視副檔名動作

在「導覽器視圖」中,選取具有 .readme 副檔名的檔案。如果沒有的話,請建立 一個具有該副檔名的檔案。在「導覽器視圖」的本端工具列上, 您可以見到一個浮動說明為「執行 Readme 檢視副檔名」的按鈕。  按一下該按鈕。 會蹦現出一個對話框,說明已執行「檢視動作」。

蹦現功能表

在「導覽器視圖」中,選取具有 .readme 副檔名的檔案。如果沒有的話,請建立 一個具有該副檔名的檔案。選取檔案以帶出蹦現功能表。 請注意,蹦現功能表中會有一個功能表項目說明「顯示 Readme 動作」。 選擇此功能表項目,以開啟說明「蹦現功能表動作已執行」的對話框。

喜好設定頁面

從「視窗」功能表,選取「喜好設定」。按一下名為「Readme 範例」的頁面。會顯示喜好設定頁面的範例。

內容頁面

在「導覽器視圖」中,選取具有 .readme 副檔名的檔案。如果沒有的話,請建立 一個具有該副檔名的檔案。選取檔案以帶出蹦現功能表,然後選取內容功能表。 按一下名為「Readme 工具」的頁面,以檢視內容頁面的範例。

Readme 檔編輯器

「README 檔編輯器」是檔案類型 .readme 的預設編輯器。建立一個副檔名為 .readme 的檔案,並在檔案上按兩下開啟該檔, 或帶出蹦現功能表,選取「開啟工具」,然後從子功能表中選取「Readme 檔編輯器」。 請注意,編輯器有一個鉛筆圖示。這是 Readme 工具依預設為檔案類型 .readme 所使用的編輯器。

Readme 編輯器動作

在此處示範一個僅適用於特定編輯器的動作範例。 當焦點位於README 檔編輯器時,請注意 4 個其他的工具列按鈕 - 執行 README 編輯器副檔名、README 編輯器動作 1、 README 編輯器動作 2、README 編輯器動作 3。

當焦點位於 Readme 檔編輯器時,會出現名為 Readme 的下拉式功能表。 其中包含前述的動作:執行 README 編輯器副檔名、README 編輯器動作 1、 README 編輯器動作 2、README 編輯器動作 3。

Readme 區段視圖

若要檢視此「Readme 區段」視圖,請從「視窗」功能表選取「顯示視圖」, 然後從子功能表中選取「其他...」。展開 Readme 項目,然後選取「Readme 區段」。 當在「導覽器視圖」中選取 .readme 檔時,這將顯示目前 *.readme 檔中的區段清單。 您也可以在「概要」視圖中檢視 *.readme 檔的結構。

具有副檔名 .readme 的檔案可以細分為不同區段,每個區段以一個號碼開始。 例如,若在 README 檔編輯器中輸入以下文字,則 Readme 工具會偵測到兩個區段。 若要檢視 Readme 工具如何偵測不同區段, 請在 README 檔編輯器中輸入一些文字,輸入 CTRL-S 或選取「檔案->儲存」來儲存檔案。開啟「Readme 區段」檢視,並在「導覽器視圖」中選取 .readme 檔。

範例文字:

99.1 這是我的第一個區段
這是第一個區段中的部份文字。

99.1.1 這是一個子區段。
這是子區段中的部份文字。

拖放

可以在「概要視圖」中選取區段,並拖曳該選項至文字檔的頂端,可以檢視「拖放」功能。 選項的內容將會附加至檔案中。

說明構成要素

Readme 工具範例亦示範了如何在所有提供的副檔名使用與實作環境定義說明 - 一個視圖、不同動作與精靈頁面。 若要取得動作的環境定義說明,將游標移至功能表項目上方, 但不要進行選取,然後按 F1 鍵。您也可以在「Readme 區段」視圖以及 「範例建立精靈」頁面(在「新建」精靈中)取得環境定義相關 (F1) 的說明。
 

詳細資料

「Readme 工具」範例宣告一個延伸點,並提供一些副檔名。 提供的副檔名是綜合性的,以瞭解「工作台」功能,因為它利用了由工作台所宣告的 更有趣的延伸點。此範例中提供的副檔名為檢視與檢視動作、喜好設定頁面、內容頁面、 精靈、編輯器和編輯器動作、蹦現功能表、動作集、說明構成要素,以及除去動作。

此範例亦提供外掛程式中所宣告的延伸點。 此範例中所定義的使用 org.eclipse.ui.examples.readmetool.sectionParser 副檔名的外掛程式皆需類別 IReadmeFileParser。類別 DefaultSectionParser 是一個 IReadmeFileParser 實作範例。

類別 ReadmeEditor 實作 IEditorPart,且在 plugin.xml 檔中使用 org.eclipse.ui.editors 延伸點定義為具有 .readme 副檔名的檔案之編輯器。類別 ReadmeSectionsView 實作 IViewPart, 且使用 org.eclipse.ui.views 延伸點定義為一個視圖。這個延伸點也定義了視圖選項中所使用的視圖之種類。

此範例定義了兩個類型之喜好設定,工作台喜好設定及資源內容。 工作台喜好設定在類別 ReadmePreferencePage 中定義,該類別實作 IWorkbenchPreferencePage, 這樣,它將會被新增至「視窗->喜好設定」對話框。該類別定義於 plugin.xml 中的延伸點 org.eclipse.ui.preferencePages。兩個資源內容頁面為 ReadmeFilePropertyPage 與 ReadmeFilePropertyPage2,兩者皆實作 IWorkbenchPropertyPage。 兩者皆定義為在 IFile 中,由 org.eclipse.ui.propertyPages 延伸點 plugin.xml 中的 objectClass 標示所呼叫。

類別 ReadmeCreationWizard 實作 INewWizard,且定義於 plugin.xml 中的 org.eclipse.ui.newWizards 延伸點中。這個延伸點也定義了當使用者選取「檔案->新建->範例....」時,精靈所顯示的種類。

數個動作 Stub 新增至此範例中。動作集宣告了使用延伸點 org.eclipse.ui.actionSets, 將標示為「README 檔編輯器」的功能表併入工作台視窗功能表列。 它也使用標示 toolbarPath 與 menubarPath,定義了工作台工具列與功能表列的動作。 它使用了實作 IWorkbenchWindowActionDelegate 的類別 WindowActionDelegate 來實作動作。 蹦現功能表的動作由類別 PopupMenuActionDelegate 在延伸點 org.eclipse.ui.popupMenus 中定義為 objectContribution。 PopupMenuActionDelegate 實作 IObjectActionDelegate 並使用提供的 IWorkbenchPart 以開啟訊息對話框。檢視動作 ViewActionDelegate 在延伸點 org.eclipse.ui.viewActions 中定義,並實作 IViewActionDelegate。出現的檢視是由標示 targetID 所定義,在這個範例中,targetID 定義於 org.eclipse.ui.views.ResourceNavigator 中。編輯器動作由實作 IEditorActionDelegate 的類別 EditorActionDelegate 所定義,且使用 org.eclipse.ui.editorActions 延伸點新增。所套用的編輯器由標示 targetID 所定義,在這個範例中,targetID 定義於 org.eclipse.ui.examples.readmetool.ReadmeEditor 中。

類別 ReadmeDropActionDelegate 實作 IDropDelegate。每次都會通知 IDropDelegates 工作台中執行了除去動作。此動作的延伸點為 org.eclipse.ui.dropActions。