Introduktionsdelskonfiguration

org.eclipse.ui.intro.config

3.0

Den här utökningspunkten används för att registrera en introduktionskonfiguration. Konfigurationen tillhandahåller presentationsimplementationer och innehåll för ett visst introduktionsbidrag. En introduktion visas när arbetsmiljön startas eller som ett val på menyn Hjälp. Introduktionen används vanligen för att introducera en produkt som skapats på Eclipse för en ny användare.

Introduktionerna ordnas i sidor som vanligen speglar en viss kategori av introduktionsmaterial. Sidan Nyheter kan t.ex. introducera nya begrepp eller funktioner jämfört med tidigare versioner. Innehållet som definierats av en introduktionskonfiguration kan hänvisas till och utökas från andra insticksprogram med hjälp av utökningspunkten org.eclipse.ui.intro.configExtension.

<!ELEMENT extension (config+)>

<!ATTLIST extension

point CDATA #REQUIRED

id    CDATA #IMPLIED

name  CDATA #IMPLIED>


<!ELEMENT config (presentation)>

<!ATTLIST config

introId    CDATA #REQUIRED

id         CDATA #REQUIRED

content    CDATA #REQUIRED

configurer CDATA #IMPLIED>

Ett config-element kan användas till att konfigurera en anpassningsbar introduktionsdel. Ett config-element måste ange ett ID, ett introId och en innehållsfil. Filen med introduktionsinnehållet är en XML-fil som beskriver de sidor, grupper och länkar som introduktionen har.



<!ELEMENT presentation (implementation+ , launchBar?)>

<!ATTLIST presentation

home-page-id    CDATA #REQUIRED

standby-page-id CDATA #IMPLIED>

Presentationselement som definierar alla möjliga implementationer av en introduktionsdels presentation. Det kan ha en eller flera implementationsdefinitioner. Endast en implementation väljs vid start, baserat på os/ws-attributen för implementationerna. Annars väljs den första som inte har några os/ws-attribut definierade.



<!ELEMENT implementation (head?)>

<!ATTLIST implementation

kind  (swt|html)

style CDATA #IMPLIED

os    CDATA #IMPLIED

ws    CDATA #IMPLIED>

Presentationen av plattformens direkta upplevelse har två implementationer. En av dem är SWT-webbläsarbaserad medan den andra baseras på användargränssnittsformulär. Den anpassningsbara introduktionsdelen kan konfigureras för att ta en av dessa två presentationer, baserat på aktuellt operativsystem och aktuell webbtjänst. Typ av implementation kan vara swt eller html.



<!ELEMENT launchBar (handle? , shortcut*)>

<!ATTLIST launchBar

location (left|bottom|right|fastview) "fastview"

bg       CDATA #IMPLIED

fg       CDATA #IMPLIED

computed (true | false) "false">

Startfältet fungerar tillsammans med kommandot 'switchToLaunchBar'. När det utförs stängs introduktionen och ett startfält skapas på ett av trimområdena i huvudfönstret. Startfältet innehåller minst en knapp som användare kan använda för att återgå till den senaste introduktionssidan. Det kan (valfritt) också innehålla ytterligare knappar som definierats med hjälp av elementet shortcut. Dessa knappar kan användas till att snabbt gå till en viss introduktionssida. Sedan version 3.1



<!ELEMENT shortcut EMPTY>

<!ATTLIST shortcut

tooltip CDATA #IMPLIED

icon    CDATA #REQUIRED

url     CDATA #REQUIRED>

en knapp skapas i introduktionsstartfältet för varje genvägselement. När knappen trycks ned visas den URL-adress som definierats i genvägen. Sedan version 3.1



handle-elementet är utkommenterat

<!ELEMENT handle EMPTY>

<!ATTLIST handle

close (true | false) "true"

image CDATA #IMPLIED>

ett valfritt element som styr hur startfältshandtaget återges. Sedan version 3.1



<!ELEMENT introContent (page+ , group* , extensionContent*)>

introContent-elementet definierar brödtexten i introContent-filen. Innehållsfilen består av sidor, delade grupper som kan inkluderas i flera sidor och utökningar till ankarpunkter som har definierats i andra konfigurationer.



<!ELEMENT page (group* | link* | text* | head* | img* | include* | html* | title? | anchor* | contentProvider*)>

<!ATTLIST page

url          CDATA #IMPLIED

id           CDATA #REQUIRED

style        CDATA #IMPLIED

alt-style    CDATA #IMPLIED

filteredFrom (swt|html)

content      CDATA #IMPLIED

style-id     CDATA #IMPLIED

shared-style (true | false)

bgImage      CDATA #IMPLIED>

Det här elementet beskriver en sida som ska visas. Introduktionen kan visa både dynamiska och statiska sidor.
Innehåll för dynamiska sidor genereras från delelementen på sidan (beskrivs nedan). Hur style eller alt-style används beror på presentationen. Formaten kan ytterligare förbättras genom refererens till id eller klass-id.
På statiska sidor kan befintliga HTML-dokument återanvändas inuti en introduktion och länkas till från en statisk eller dynamisk sida. Statiska sidor definieras inte i ett sidelement, utan är helt enkelt HTML-filer som andra sidor kan länka till.
Startsidan, vars id anges i presentationselementet i utökningspunkten introConfig, kan ha en webbadress som talar om att det är en statisk sida. Om ingen webbadress anges antas startsidan vara dynamisk. Alla andra sidor som beskrivs med sidelementet är dynamiska.
Observera att när SWT-presentationen används och en statisk sida ska visas, öppnas en extern webbläsare och den aktuella sidan förblir synlig.
Delelementen som används på en dynamisk sida är följande: ett group-delelement grupperar relaterat innehåll och anger format för allt grupperat innehåll. Ett link-delelement definierar en länk som kan länka till en statisk eller dynamisk sida och köra en intro-åtgärd eller ett intro-kommando. En länk definieras vanligtvis på sidnivå för navigering mellan huvudsidor, jämfört med länkar på en och samma sida. Ett text-delelement definierar textinnehåll på sidnivå. Ett head-delelement är endast tillämpligt för den webbaserade presentationen och tillåter att ytterligare HTML-kod läggs till i HTML-avsnittet head. Detta är praktiskt när du vill lägga till JAVA-skript eller extra formatmallar. Ett img-delelement definierar bildinnehållet för sidnivån. Ett include-delelement tillåter att andra element än en sida återanvänds. Ett html-delelement är endast tillämpligt för den webbaserade presentationen och tillåter att HTML-kod bäddas in eller inkluderas i sidans innehåll. Med inbäddning kan en fullständigt definierad HTML-fil bäddas in i ett HTML-objekt genom att HTML-filen refereras. Med inkludering kan ett HTML-kodstycke inkluderas direkt från en HTML-fil. Ett title-delelement definierar rubriken på sidan. Ett anchor-delelement definierar en punkt där externa bidrag kan göras med ett <extensionContent>-element.



<!ELEMENT group (group* | link* | text* | img* | include* | html* | anchor* | contentProvider*)>

<!ATTLIST group

id           CDATA #REQUIRED

label        CDATA #IMPLIED

style-id     CDATA #IMPLIED

filteredFrom (swt|html)

computed     (true | false) "false"

bgImage      CDATA #IMPLIED>

Används för gruppering av relaterat innehåll, innehåll som liknande format borde tillämpas på eller innehåll som tillsammans ska inkluderas på andra sidor.



<!ELEMENT head EMPTY>

<!ATTLIST head

src      CDATA #REQUIRED

encoding CDATA #IMPLIED>

Anger att HTML ska inkluderas i en sidas HEAD-innehållsområde. Ytterligare HTML kan läggas till i HTML-sidans HEAD-avsnitt. Detta är praktiskt när JAVA-skript eller extra formatmallar ska läggas till. Om ersättningssegment i formatet $plugin:plugin_id$ ingår i innehållet ersätts de med den absoluta sökvägen till insticksprogrammet med ID:t plugin_id. Detta märkord ska endast användas med en HTML-baserad Intro-delimplementation. Det ignoreras i implementationen av användargränssnittsformulär. En sida kan ha flera head-element. En implementation kan endast ha ett head-element (eftersom det delas över alla sidor).



<!ELEMENT title EMPTY>

<!ATTLIST title

id           CDATA #IMPLIED

style-id     CDATA #IMPLIED

filteredFrom (swt|html) >

Ett textstycke som kan innehålla utlyfta HTML-märkord. Det används endast som en sidtitel. En viss sida kan ha högst ett rubrikelement.



<!ELEMENT link (text? , img?)>

<!ATTLIST link

id           CDATA #IMPLIED

label        CDATA #IMPLIED

url          CDATA #REQUIRED

style-id     CDATA #IMPLIED

filteredFrom (swt|html) >

Kan länka till en statisk HTML-fil, en extern webbplats eller köra en Intro URL-åtgärd.



<!ELEMENT text EMPTY>

<!ATTLIST text

id           CDATA #IMPLIED

style-id     CDATA #IMPLIED

filteredFrom (swt|html) >

Ett textstycke som kan innehålla utlyfta HTML-märkord. Det kan innehålla b- och li-märkord. Det kan också innehålla ankare för webbadresser. Om flera stycken krävs kan texten delas upp i flera delar som vart och ett börjar och slutar med p-märkordet.



<!ELEMENT img EMPTY>

<!ATTLIST img

id           CDATA #REQUIRED

src          CDATA #REQUIRED

alt          CDATA #IMPLIED

style-id     CDATA #IMPLIED

filteredFrom (swt|html) >

En bild som motsvarar introContent och inte presentationen (till skillnad mot dekorationsbilder som har definierats med formatmallar).



<!ELEMENT html (img | text)>

<!ATTLIST html

id           CDATA #REQUIRED

src          CDATA #REQUIRED

type         (inline|embed)

style-id     CDATA #IMPLIED

filteredFrom (swt|html)

encoding     CDATA #IMPLIED>

Anger att HTML ska inkluderas på sidan, antingen genom att hela dokumentet bäddas in eller genom att ett HTML-kodstycke infogas på plats. En reservbild eller -text måste definieras för en alternativ återgivning av en swt-presentation. Om ersättningssegment i formatet $plugin:plugin_id$ ingår i innehållet ersätts de med den absoluta sökvägen till insticksprogrammet med ID:t plugin_id.
Med inbäddning kan en fullständigt definierad HTML-fil bäddas in i den dynamiska sidans innehåll. Ett HTML-object-element skapas och refererar till HTML-filen.
Med inkludering inkluderas ett HTML-kodstycke direkt från en fil till den dynamiska HTML-sidan.



<!ELEMENT include EMPTY>

<!ATTLIST include

configId    CDATA #IMPLIED

path        CDATA #REQUIRED

merge-style (true | false) >

Expanderar ett element som har angetts med sökväg och valfria configId-attribut. Sökvägen ska på ett unikt sätt adressera ett element i den angivna konfigurationen. Den kan peka på en delad grupp som har definierats på konfigurationsnivå eller vilket element på en sida som helst.



<!ELEMENT anchor EMPTY>

<!ATTLIST anchor

id CDATA #REQUIRED>

Ett ankare är det element som används när utökning deklareras. Det är en sökväg i den konfiguration som tillåter externa bidrag. Ankare är de enda giltiga målvärdena för path-attributet i ett extensionContent.



<!ELEMENT extensionContent (text | group | link | html | include)>

<!ATTLIST extensionContent

style     CDATA #IMPLIED

alt-style CDATA #IMPLIED

path      CDATA #REQUIRED

content   CDATA #IMPLIED

id        CDATA #IMPLIED

name      CDATA #IMPLIED>

Innehållet som ska läggas till i målankaret. Endast ett extensionContent är tillåtet i en och samma configExtension. Det beror på att om utökningen inte skulle kunna lösas (om konfigurationen eller målankarelemetet inte kan hittas), måste sidorna och/eller grupperna i utökningen ignoreras.



<!ELEMENT contentProvider (text?)>

<!ATTLIST contentProvider

id       CDATA #REQUIRED

pluginId CDATA #IMPLIED

class    CDATA #REQUIRED>

En proxy för en introContent-provider, som gör att en intro-sida dynamiskt kan hämta data från olika källor (till exempel webben, Eclipse m.m.) och tillhanda innehåll vid körning, baserat på dessa dynamiska data. Om den IntroContentProvider-klass som har angetts i klassattributet inte kan läsas in, återges i stället innehållet i textelementet. Det här är en dynamisk version av intro-märkordet HTML. Medan HTML-märkordet tillåter inbäddning eller infogning av statiskt HTML-innehåll i den genererade html intro-sidan, tillåter contentProvider-märkordet att det innehållet skapas dynamiskt vid körning. En annan skillnad mellan märkorden är att HTML-märket endast stöds i HTML-presentationen, medan contentProvider-märkordet stöds i både HTML- och SWT-presentationer. Sedan version 3.0.1



<!!ELEMENT hr EMPTY>

<!ATTLIST hr

id           CDATA #IMPLIED

style-id     CDATA #IMPLIED

filteredFrom (swt|html) >

en horisontell regel.



Följande är en exempel på användning av utökningspunkten för konfigurationen.

<extension id=

"intro"

point=

"org.eclipse.ui.intro.config"

>

<config introId=

"com.org.xyz.intro"

id=

"com.org.xyz.introConfig"

content=

"introContent.xml"

>

<presentation home-page-id=

"root"

title=

"%intro.title"

>

<implementation ws=

"win32"

style=

"css/shared.css"

kind=

"html"

os=

"win32"

>

</implementation>

<implementation style=

"css/shared_swt.properties"

kind=

"swt"

>

</implementation>

</presentation>

</config>

</extension>

För ytterligare detaljer kan du se specifikationen för API-paketet org.eclipse.ui.intro.config.

Den introduktion som tillhandahålls av insticksprogrammet org.eclipse.platform är den enda implementationen inom Eclipse.