Filen introContent (XML-format)

Version 3.1.0

Det här dokumentet beskriver filstrukturen för introContent-filen som en serie DTD-fragment.

introContent


<!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.



page


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

<!ATTLIST page

url          CDATA #IMPLIED

id           CDATA #REQUIRED

style        CDATA #IMPLIED

alt-style    CDATA #IMPLIED

filteredFrom (swt|html)
bgImage      CDATA #IMPLIED

content      CDATA #IMPLIED

style-id     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 delementen 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 från en statisk eller en 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.


group


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

<!ATTLIST group

id           CDATA #REQUIRED

label        CDATA #IMPLIED

style-id     CDATA #IMPLIED

computed     CDATA (true|false) "false"
bgImage      CDATA #IMPLIED

filteredFrom (swt|html) >

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.


link


<!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.




De fördefinierade åtgärderna beskrivs med följande format:

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, där "false" är standard


Följande fördefinierade åtgärder inkluderas i intro-ramverket:

close - stänger introduktionsdelen
inga parametrar krävs

execute - kör det angivna kommandot. Information om formatet för kommandoserialisering finns i avsnittet om metoden serialize() för org.eclipse.core.command.ParameterizedCommand. Sedan 3.2.
command - ett serialiserat ParameterizedCommand
standby (valfri) = ("true" | "false") "false" - anger om introduktionen ska ställas i vänteläge efter att kommandot har körts.

navigate - navigera genom introduktionssidor i en viss riktning eller gå tillbaka till startsidan
direction = ("backward" | "forward" | "home") - anger navigeringsriktning

openBrowser - Öppnar webbadressen i en 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 statisk HTML-fil.
pluginId (valfri) - Krävs endast om en statisk HTML-fil har angetts. Det här är id 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 - Det fullständiga klassnamnet på den klass som implementerar en av org.eclipse.ui.intro.config.IIntroAction, org.eclipse.jface.action.IAction eller org.eclipse.ui.IActionDelegate
pluginId - ID:t för det insticksprogram som innehåller klassen.
standby (valfri) = ("true" | "false") "false" - Anger om introduktionen ska ställas i vänteläge efter att åtgärden har kö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. 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 (valfri) = ("true" | "false") "false" - Anger om introduktionen ska ställas in till vänteläge eller inte efter att sidan har 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&amp;decode=true
bearbetar meddelandeparametern som "Ett meddelande".


  • style-id - Ett sätt att klassificera den här länken i en viss kategori så att ett enhetligt format kan tillämpas.
  • filteredFrom - ett valfritt attribut som tillåter att ett visst element filtreras bort från en viss implementation. Om en grupp till exempel har filteredFrom = swt, betyder det att gruppen inte kommer att visas som innehåll i swt-implementationen.
  • html


    <!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.


    hr


    <!ELEMENT hr EMPTY>

    <!ATTLIST hr

    id           CDATA #IMPLIED

    style-id     CDATA #IMPLIED

    filteredFrom (swt|html) >

    en horisontell regel.


    title


    <!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.


    text


    <!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.


    include


    <!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.


    head


    <!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).


    img


    <!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).


    extensionContent


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

    <!ATTLIST extensionContent

    style     CDATA #IMPLIED

    alt-style CDATA #IMPLIED
    id       CDATA #IMPLIED

    name     CDATA #IMPLIED

    path      CDATA #REQUIRED>

    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.


    anchor


    <!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.


    contentProvider

     

    <!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