Exempel - Readme-verktyget

Introduktion

Readme-redigeraren visar hur du kan definiera egna utökningspunkter för användning av andra insticksprogram. Den visar också hur du kan skapa utökningar för resursens snabbmenyposter, nya resursguider, filredigerare för ett filtillägg (.readme), en anpassad vy och egenskapssidor.

Köra exemplet

Starta genom att skapa en fil med filtillägget .readme med hjälp av någon av guiderna för att skapa filer eller exempel. Den extra vyn i det här exemplet visas om du väljer Fönster > Visa vy > Övrigt och expanderar Readme-avsnittet. Vyåtgärden kan visas om du klickar på readme-ikonen i navigeringsvyn.

Skapa en ny readme-fil

Skapa en ny fil med filtillägget .readme.  På menyn Arkiv väljer du Ny, välj sedan Annan på undermenyn. Klicka på Enkel i guiden och välj sedan fil i listan till vänster.  Klicka på Nästa och ange ett filnamn (se till att filtillägget är .readme) och i vilken mapp filen ska finnas.

Guider för att skapa exempel

På menyn Arkiv väljer du Ny, från undermenyn väljer du Exempel... . Nu kan du välja guiderna för att skapa exempel. Markera Readme-fil. Klicka på Nästa. Markera i vilken mapp du vill att filen ska skapas. Ange namnet på filen, med filtillägget .readme. Klicka på Slutför.

Filtilläggsåtgärd på readme-vyn

I navigeringsvyn markerar du en fil med filtillägget .readme. Om det inte finns någon skapar du en fil med det filtillägget. I det lokala verktygsfältet i navigeringsvyn visas en knapp vars bubbelhjälp visar att Readme-vyutökningen körs.  Klicka på knappen.  En dialogruta visas med information om att vyåtgärden utförs.

Snabbmenyer

I navigeringsvyn markerar du en fil med filtillägget .readme.  Om det inte finns någon skapar du en fil med det filtillägget.  Markera filen så att snabbmenyn visas.  På snabbmenyn finns ett menyalternativ som heter Visa Readme-åtgärd.  Välj det här menyalternativet. En dialogruta öppnas med information om att snabbmenyåtgärden utförs.

Inställningssida

På menyn Fönster väljer du Inställningar.  Klicka på den sida som kallas Readme-exempel.  Ett exempel på en inställningssida visas.

Egenskapssida

I navigeringsvyn markerar du en fil med filtillägget .readme.  Om det inte finns någon skapar du en fil med det filtillägget.  Markera filen så att snabbmenyn visas och välj sedan menyalternativet Egenskaper.  Klicka på sidan med namnet Readme-verktyg så visas ett exempel på en egenskapssida.

Readme-filredigerare

Readme-filredigeraren är standardredigerare för filer av typen *.readme. Skapa en fil med filtillägget .readme och öppna filen. Du kan antingen dubbelklicka på den eller visa snabbmenyn, välja Öppna med och därefter Readme-filredigerare på undermenyn. Lägg märke till att redigeraren har en ikon med en penna. Detta är den redigerare som vanligen används av readme-verktyget för filer av typen *.readme.

Åtgärder i readme-redigeraren

Här visas ett exempel på åtgärder som bara gäller för en viss redigerare. När en Readme-filredigerare har fokus kan du lägga märke till fyra ytterligare knappar i verktygsfältet - Kör Readme-redigerarutökningen, Readme-redigeringsåtgärd 1, Readme-redigeringsåtgärd 2, Readme-redigeringsåtgärd 3.

En Readme-meny visas när en Readme-filredigerare har fokus. På den finns de åtgärder som tidigare beskrivits: Readme-redigeringsåtgärd 1, Readme-redigeringsåtgärd 2, Readme-redigeringsåtgärd 3.

Vy för readme-avsnitt

Du kan visa denna vy genom att välja menyn Fönster, därefter Visa vy och slutligen Övrigt... på undermenyn. Expandera readme-objektet och välj sedan readme-avsnitt. En lista visas över alla avsnitt i aktuell *.readme-fil när en .readme-fil har markerats i navigeringsvyn. *.readme-filens struktur visas också i dispositionsvyn.

En fil med filtillägget .readme kan delas upp i avsnitt, där varje avsnitt inleds med ett nummer. Om exempelvis följande text skrevs i Readme-filredigeraren skulle två avsnitt upptäckas i readme-verktyget. Om du vill visa hur avsnitt upptäcks i readme-verktyget skriver du in lite text i Readme-filredigeraren, sparar filen genom att antingen trycka på CTRL-S eller genom att välja Arkiv>Spara. Öppna Readme-avsnittsvyn och markera .readme-filen i navigeringsvyn.

Exempeltext:

99.1 Detta är mitt första avsnitt
Detta är lite text i mitt första avsnitt.

99.1.1 Detta är ett underavsnitt
Detta är lite text i mitt underavsnitt.

Dra och släpp

Dra och släpp-funktionen kan visas om du markerar ett avsnitt i dispositionsvyn och drar markeringen till en textfil. Innehållet i markeringen läggs till i filen.

Hjälpbidrag

I readme-verktygsexemplet visas också hur du använder och implementerar kontexthjälp för alla de utökningar som tillhandahålls: en vy, olika åtgärder och en guidesida. Om du vill visa kontexthjälp till en åtgärd hovrar du över menyalternativet, utan att markera det, och sedan trycker på F1. Du kan också visa kontextberoende hjälp (F1) för readme-avsnittsvyn och sidan i guiden för att skapa exempel (i den nya guiden).
 

Detaljer

I Readme-verktygsexemplet deklareras en utökningspunkt och ett antal utökningar tillhandahålls. Tillhandahållna utökningar är ganska omfattande när det gäller att förstå arbetsmiljöfunktioner, eftersom ett antal av de mer intressanta utökningspunkterna deklareras i arbetsmiljön. Tillhandahållna utökningar i det här exemplet är vyer och vyåtgärder, inställningssidor, egenskapssidor, guider, redigerare och redigeraråtgärder, snabbmenyer, åtgärdsuppsättningar, hjälpbidrag, hjälpkontext och släpp-åtgärder.

I exemplet ges också en utökningspunkt som deklareras i insticksprogrammet. Klassen IReadmeFileParser behövs för alla insticksprogram som använder utökningen org.eclipse.ui.examples.readmetool.sectionParser som definieras i det här exemplet. Klassen DefaultSectionParser är en exempelimplementation av IReadmeFileParser.

Klassen ReadmeEditor implementerar IEditorPart och definieras som en redigerare för filer med filtillägget .readme i plugin.xml med hjälp av utökningspunkten org.eclipse.ui.editors. Klassen ReadmeSectionsView implementerar IViewPart och definieras som en vy med hjälp av utökningspunkten org.eclipse.ui.views. I utökningspunkten definieras också en kategori för vyn för användning i vyurvalet.

Två typer av inställningar definieras i det här exemplet, arbetsmiljö och resursegenskaper. Arbetsmiljöinställningen definieras i klassen ReadmePreferencePage som implementerar IWorkbenchPreferencePage så att den läggs till i dialogrutan Fönster->Inställningar. Klassen definieras i utökningspunkten org.eclipse.ui.preferencePages i plugin.xml. De två resursegenskapssidorna är ReadmeFilePropertyPage och ReadmeFilePropertyPage2, vilka båda implementerarIWorkbenchPropertyPage. De definieras båda genom att anropa IFile-typen med objectClass-märkordet i plugin.xml i utökningspunkten org.eclipse.ui.propertyPages.

Klassen ReadmeCreationWizard implementerar INewWizard och definieras i utökningspunkten org.eclipse.ui.newWizards i plugin.xml. Med den här utökningspunkten definieras också kategorin där guiden visas när användaren väljer Arkiv->Ny->Exempel....

Vissa åtgärdsstycken läggs till i det här exemplet. Med åtgärdsuppsättningen deklareras en meny med namnet Readme-filredigerare som ska tas med på arbetsmiljöns fönstermeny med hjälp av utökningspunkten org.eclipse.ui.actionSets. Den definierar också en åtgärd för arbetsmiljöns verktygsfält och menyrad med hjälp av märkorden toolbarPath och menubarPath. Den använder klassen WindowActionDelegate som implementerar IWorkbenchWindowActionDelegate för att implementera åtgärden. Åtgärden för snabbmenyn definieras som en objectContribution av klassen PopupMenuActionDelegate i utökningspunkten org.eclipse.ui.popupMenus. PopupMenuActionDelegate implementerar IObjectActionDelegate och använder IWorkbenchPart, som tillhandahålls för att öppna en meddelandedialogruta. Vyåtgärden ViewActionDelegate definieras i utökningspunkten org.eclipse.ui.viewActions och implementerar IViewActionDelegate. Den vy den visas i definieras med märkordet targetID, vilket i det här exemplet är org.eclipse.ui.views.ResourceNavigator. Redigeraråtgärden definieras med klassen EditorActionDelegate som implementerar IEditorActionDelegate och läggs till med hjälp av utökningspunkten org.eclipse.ui.editorActions. Redigeraren som den läggs till i definieras med märkordet targetID, vilket i det här exemplet definieras i org.eclipse.ui.examples.readmetool.ReadmeEditor.

Klassen ReadmeDropActionDelegate implementerar IDropDelegate. IDropDelegates informeras varje gång en släpp-åtgärd utförs i arbetsmiljön. Utökningspunkten för den här åtgärden är is org.eclipse.ui.dropActions.