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.
org.eclipse.ui.intro.IntroConfigurer
.<!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.
org.eclipse.core.runtime.Platform
).org.eclipse.core.runtime.Platform
).<!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
left
, bottom
eller right
). Om valet är fastview
(standard) skapas startfältet initialt där snabbvyfältet är.true
anges ignoreras statiska shortcut
-element som definierats i plugin.xml.<!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
<!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
true
)<!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.
true
(standard) läggs det delade formatet till i sidans format. Om värdet är false
läggs inte det format som definierats i introduktionskonfigurationen in i formaten för sidan.<!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.
true
anges tillhandahålls de underordnade objekten till gruppen av introduktionskonfigurationsprogrammet vid körning. Du bör inte definiera några underordnade objekt statistiskt i det här fallet.<!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.
action name - beskrivning av åtgärd
action parameter1 - beskrivning av parameter
action parameter2 (valfri) - beskrivning av parameter
action parameter3 (valfri) = ("true"
"false") "false" - beskrivning av parameter, val av true eller false, "false" är standard
close - stänger introduktionsdelen
inga parametrar krävs
navigate - navigera genom introduktionssidor i en viss riktning eller gå tillbaka till startsidan
direction = ("backward" "forward" "home") - anger riktning för navigeringen
openBrowser - öppna webbadress i extern webbläsare. Sedan version 3.1 är den här åtgärden beroende av arbetsmiljöns webbläsarsupport. Det innebär att eventuella användarinställningar som har gjorts för webbläsaren kommer att användas.
url - en giltig webbadress till en extern webbplats eller en lokal HTML-fil
pluginId (valfri) - om webbadressen är relativ motsvarar detta ett insticksprogram. Ange IDt för det insticksprogram som innehåller filen.
openURL - öppnar den webbadress som har bäddats in på välkomstsidan. Om det gäller en SWT-presentation, visas webbadressen i en extern webbläsare (ungefär som openBrowser-åtgärden ovan). Sedan version 3.1
url - en giltig webbadress till en extern webbplats eller en lokal HTML-fil.
pluginId (valfri) - om webbadressen är relativ anger det här ID:t för det insticksprogram som innehåller filen.
runAction - kör den angivna åtgärden.
class - ett fullständigt klassnamn på den klass som implementerar en av org.eclipse.ui.intro.config.IIntroAction
, org.eclipse.jface.actino.IAction
eller org.eclipse.ui.IActionDelegate
pluginId - ID:t för det insticksprogram som innehåller klassen.
standby (optional) = ("true" "false") "false" - anger om introduktionen ska ställas i vänteläge sedan åtgärden utförts
ytterligare parametrar - Eventuella ytterligare parametrar som överförs till åtgärder som implementerar org.eclipse.ui.intro.config.IIntroAction
setStandbyMode - anger läget för introduktionsdelen.
standby = ("true" | "false") - värdet ska vara true om intro-delen ska vara i delvis synligt
vänteläge och false om det ska vara helt synligt.
showHelp - öppnar hjälpsystemet.
inga parametrar krävs
showHelpTopic - öppnar ett hjälpavsnitt.
id - webbadressen till hjälpresursen. (Se Javadoc för org.eclipse.ui.help.WorkbenchHelp.displayHelpResource)
embed (valfri) = ("true"
"false") "true" - anger att hjälpresursen måste visas inbäddad som en del av välkomstsidorna. Standard är false. Den här flaggan ignoreras när det gäller SWT-presentationen. Detta motsvarar kommandot openURL() men för hjälpsystemavsnitten. Den inbäddade webbadressen upptar hela den fasta delen av aktuell sida. Sedan version 3.1
embedTarget (valfri) - Sökvägen till en div på den aktuella välkomstsidan som kommer att rymma innehållet i hjälpavsnittet. Om den anges är embed true som standard och den inbäddade webbadressen infogas inuti div-märkordet med den angivna sökvägen. Sökvägen är relativ till sidan och ska därför inte börja med sid-id. De underordnade objekten till div ersätts av innehållet i webbadressen. Endast en div per sida kan användas som ett inbäddat mål. Den här flaggan ignoreras när det gäller SWT-presentationen. Den stöds inte heller när XHTML används som intro-innehåll. Sedan version 3.1
showMessage - visar ett meddelande i en vanlig informationsdialogruta.
message - aktuellt meddelande
showStandby - ställer in intro-delen till vänteläge och visar standbyContentPart med en viss inmatning
partId - ID:t för det standbyContentPart som ska visas
input - inmatningen som ska anges i standbyContentPart
showPage - visar introduktionssidan med det angivna ID:t
id - ID:t för den introduktionssida som ska visas
standby (optional) = ("true"
"false") "false" - anger om introduktionen ska ställas i vänteläge sedan sidan visats
Om någon av parametrarna som överfördes till dessa åtgärder har specialtecken (dvs. tecken som är ogiltiga i en webbadress), måste de kodas med UTF-8. Om du vill att dessa parametrar ska tas emot i avkodat läge kan du använda specialparametern decode = ("true" "false") för att tvinga fram en avkodning av parametrarna när intro-ramverket bearbetar dem.
Exempel: Följande intro-webbadress:
http://org.eclipse.ui.intro/showMessage?message=Ett+meddelande
bearbetar meddelandeparametern som "Ett+meddelande"
medan
http://org.eclipse.ui.intro/showMessage?message=Ett+meddelande&decode=true
bearbetar meddelandeparametern som "Ett meddelande".
<!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).
<!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.
true
läggs format, som tillhör sidan som äger det inkluderade elementet, till i listan över format för den inkluderade sidan. Om värdet är false
(standard) är det den inkluderade sidan som styr egenskaperna i det inkluderade elementet.<!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.
<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>
Copyright (c) 2004, 2006 IBM Corporation and others.
All rights reserved. Detta program och medföljande material tillhandahålls under villkoren för Eclipse Public License v1.0 som medföljer denna distribution och finns tillgänglig på http://www.eclipse.org/legal/epl-v10.html