範例 - 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 檔有焦點時,請注意四個附加的工具列按鈕 - 「Run Readme Editor Extension」、「Readme Editor Action 1」、 「Readme Editor Action 2」和「Readme Editor Action 3」。

指名為 Readme 的下拉式功能表只在Readme 檔編輯器有焦點時出現。 包含之前描述的動作:「Readme Editor Action 1」、「Readme Editor Action 2」和「Readme Editor Action 3」。

Readme 區段檢視畫面

若要看到「Readme 區段」檢視畫面,請從視窗功能表選取檢視畫面,然後從 子功能表選取「其他...」。展開 Readme 項目,選取 Readme 區段。 在「導覽器」檢視畫面中已選取的 .readme 檔,將在現有的 *.readme 檔中顯示區段清單。 您也可以在「概要」檢視畫面中看到 *.readme 檔案的結構。

副檔名為 .readme 的檔案可將開頭為數字的區段分割為一節一節。 例如,輸入下列文字至 readme 檔案編輯器中,Readme 工具會偵測到 2 節區段。 要了解在 Readme 工具中如何偵測區段,請在 Readme 檔編輯器中輸入一些文字, 輸入 CTRL-S 或選取「檔案->儲存」儲存檔案。開啟「Readme 區段」檢視畫面並且從 「導覽器」檢視畫面中選取 .readme 檔案。

範例文字:

99.1 This is my first section
This is some text in my first section.

99.1.1 This is a sub section
This is some text in my sub-section.

拖放

在「概要」檢視畫面選取區段可以看見拖放功能然後拖曳選項至文字檔的頂端。 新增選項的內容至檔案中。

說明構成要素

「Readme 工具」範例也示範如何使用並實作它所提供所有延伸項目的環境定義說明 - 檢視畫面、多重動作和精靈頁面。 要取得動作的環境定義說明,將滑鼠橫越功能表項目,但不要選取它,按一下 F1 鍵。 您也可以在「Readme 選項」檢視畫面上取得環境定義說明(F1)和範例建立精靈 頁面(新建精靈中)。
 

詳細資料

Readme 工具範例宣告一個延伸點並提供延伸項目的號碼。 提供的延伸項目是綜合性的了解工作台如何作用,利用工作台宣告有關的延伸點項目。 提供的延伸項目併入在範例中為檢視畫面和檢視畫面動作、喜好設定頁面、內容頁面、 精靈、編輯器和編輯器動作、蹦現功能表、動作集、說明文字和拖放功能。

這範例也提供外掛程式中宣告的延伸點。 外掛程式所需的 IReadmeFileParser 類別,使用這個範例定義的 org.eclipse.ui.examples.readmetool.sectionParser 延伸項目。 類別 DefaultSectionParser 是 IReadmeFileParser 的範例實作。

類別 ReadmeEditor 實作 IEditorPart,被定義為在 plugin.xml 中使用 org.eclipse.ui.editors 延伸點 的延伸項目 .readme 檔案編輯器。 類別 ReadmeSectionsView 實作 IViewPart 使用 org.eclipse.ui.views 延伸點定義檢視畫面。 延伸點也定義檢視畫面種類供檢視畫面選項使用。

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

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

新增某些動作 Stub 至此範例中。動作集宣告功能表,標籤為 Readme File Editor ,使用延伸點 org.eclipse.ui.actionSets 被併入至工作台視窗功能表列中。 也使用標示 toolbarPath 和 manubarpath 為工作台工具列和功能表列定義動作。 它使用 WindowActionDelegate 類別實作 IWorkbenchWindowActionDelegate to 來實作這個動作。 這個蹦現功能表動作被 org.eclipse.ui.popupMenus 延伸點中的 PopupMenuActionDelegate 類別定義為 objectContribution。 PopupMenuActionDelegate 實作 IObjectActionDelegate 並使用提供的 IWorkbenchPart 來開啟訊息對話框。 檢視畫面動作 ViewActionDelegate 被定義於 org.eclipse.ui.viewActions 延伸點中並實作 IViewActionDelegate。 它所出現的檢視畫面為標示 targetID 所定義,在這個範例中為 org.eclipse.ui.views.ResourceNavigator。 編輯器動作為類別 EditorActionDelegate 所定義並實作 IEditorActionDelegate,而且使用 org.eclipse.ui.editorActions 延伸點來新增。 它所適用的編輯器為標示 targetID 所定義,在這個範例中定義在 org.eclipse.ui.examples.readmetool.ReadmeEditor。

實作 IDropDelegate 的類別 ReadmeDropActionDelegate。每一次工作台中執行了放置動作,就會通知 IDropDelegates。 這個動作的延伸點為 org.eclipse.ui.dropActions。

Copyright IBM Corp. 2000, 2001.  All Rights Reserved.