Introduksjonsinnholdsfil i XML-format

Versjon 3.1.0

Dette dokumentet beskriver strukturen i introduksjonsinnholdsfilen som en serie av DTD-fragmenter.

introContent


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

introContent-elementet definerer hoveddelen av introduksjonsinnholdsfilen. Innholdsfilen består av sider, delte grupper som kan inkluderes på flere sider, og utvidelser av ankerpunkter som er definert i andre konfigurasjoner.



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>

Dette elementet brukes til å beskrive en side som skal vises. Introduksjonen kan vise både dynamiske og statiske sider.

Innhold til dynamiske sider genereres fra sidens underelementer, som beskrives nedenfor. Stil eller alternativ stil (alt-style) blir brukt avhengig av presentasjonen. Stilene kan utvides videre ved å referere til ID eller klasse-ID.

Statiske sider gjør det mulig å bruke eksisterende HTML-dokumenter på nytt i introduksjonen, og de kan linkes til fra en hvilken som helst statisk eller dynamisk side. Statiske sider er ikke definert i et sideelement, de er ganske enkelt HTML-sider som andre sider kan linkes til.

Startsiden, som har en ID som er oppgitt i presentasjonselementet for utvidelsespunktet intro config, kan ha en URL som oppgir at den er en statisk side. Hvis det ikke er oppgitt noen URL, blir det antatt at startsiden er dynamisk. Alle andre sider som beskrives som at de bruker sideelementet, er dynamiske.
Vær også oppmerksom på at når SWT-presentasjonen brukes og en statisk side skal vises, startes en ekstern nettleser og den gjeldende siden forblir synlig.

Dette er underelementene som brukes på en dynamisk side: Et group-underelement brukes til å gruppere beslektet innhold og bruke stil for hele det grupperte innholdet. Et link-underelement definerer en link som kan brukes til å linke til en statisk eller dynamisk side og kjøre en introduksjonshandling/-kommando. En link er vanligvis definert på sidenivå for å navigere mellom hovedsider kontra linker på en side. Et text-underelement definerer tekstinnhold på sidenivå. Et head-underelement kan bare brukes til den Web-baserte presentasjonen, og det tillater tilføying av ekstra HTML i head-seksjonen i HTML. Dette er nyttig ved tilføying av Java-skript eller ekstra stilark. Et img-underelement definerer bildeinnhold for sidenivået. Et include-underelement tillater gjenbruk av et hvilket som helst annet element enn en side. Et html-underelement gjelder bare for den Web-baserte presentasjonen, og det muliggjør innfelling eller inkludering av HTML i sidens innhold. Innfelling gjør det mulig for en fullstendig definert HTML-fil å bli innfelt i et HTML-objekt ved å referere til HTML-filen. Inkludering tillater at en HTML-snutt blir direkte inkludert fra en HTML-fil. Et title-underelement definerer sidens tittel. Et anchor-underelement definerer et punkt der det kan gjøres eksterne bidrag ved hjelp av et <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) >

Brukes til å gruppere beslektet innhold, innhold som det skal brukes liknende stil til, eller innhold som skal tas med på andre sider.


link


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

<!ATTLIST link

id           CDATA #IMPLIED

label        CDATA #IMPLIED

url          CDATA #REQUIRED

style-id     CDATA #IMPLIED

filteredFrom (swt|html) >

Kan linke til en statisk HTML-fil, et eksternt nettsted eller kan kjøre en introduksjons-URL-handling.




De forhåndsdefinerte handlingene kan beskrives med dette formatet:

action name - beskrivelse av handlingen
action parameter1 - beskrivelse av parameteren
action parameter2 (optional) - beskrivelse av parameteren
action parameter3 (optional) = ("true" | "false") "false" - beskrivelse av parameteren, velg enten true eller false, "false" er standardverdien


Følgende forhåndsdefinerte handlinger er inkludert i introduksjonsrammeverket:

close - Lukker introduksjonsdelen.
Ingen parametere er nødvendige.

execute - Utfører spesifisert kommando. Se metoden serialize() vedrørende org.eclipse.core.command.ParameterizedCommand for å få nærmere opplysninger om kommandoserialiseringsformatet. Siden 3.2.
command - En serialisert ParameterizedCommand
standby (optional) = ("true" | "false") "false" - Angi om intro skal defineres i ventemodus etter utførelse av kommandoen.

navigate - Naviger gjennom introsidene i en gitt retning eller returner til startsiden.
direction = ("backward" | "forward" | "home") - Angir retningen for navigeringen.

openBrowser - åpner URLen i en ekstern nettleser. Siden 3.1 har denne handlingen vært avhengig av støtten for arbeidsbenkens nettleser. Det betyr at hvilke som helst brukerpreferanser som er definert for nettleseren, blir overholdt.
url - en gyldig URL til et eksternt nettsted eller en statisk HTML-fil.
pluginId (optional) - bare nødvendig hvis det er oppgitt en statisk HTML-fil. Dette er IDen for plugin-modulen som inneholder filen.

openURL - åpner URLen som er innfelt på velkomstsiden. For SWT-presentasjoner blir URLen vist i en ekstern nettleser (likner på openBrowser-handlingen ovenfor). Siden 3.1
url - en gyldig URL til et eksternt nettsted eller en lokal HTML-fil.
pluginId (optional) - hvis URLen er relativ, oppgir dette IDen for plugin-modulen som inneholder filen.

runAction - kjører den oppgitte handlingen.
class - det fullt kvalifiserte klassenavnet for klassen som implementerer en av org.eclipse.ui.intro.config.IIntroAction, org.eclipse.jface.action.IAction eller org.eclipse.ui.IActionDelegate.
pluginId - IDen for plugin-modulen som inneholder klassen.
standby (optional) = ("true" | "false") "false" - oppgir om introduksjonen skal defineres til ventemodus etter utføring av handlingen.
tilleggsparametere - eventuelle tilleggsparametere sendes til handlinger som implementerer org.eclipse.ui.intro.config.IIntroAction.

setStandbyMode - definerer tilstanden for introduksjonsdelen.
standby = ("true" | "false") - true for å sette introduksjonsdelen i delvis synlig ventemodus, og false for å gjøre den fullstendig synlig.

showHelp - åpner hjelpefunksjonen.
Ingen parametere er nødvendige.

showHelpTopic - åpner et hjelpeemne.
id - URLen for hjelperessursen. (Se Javadoc for org.eclipse.ui.help.WorkbenchHelp.displayHelpResource.
embed (optional) = ("true" | "false") "true" - oppgir at hjelperessursen må vises innfelt som en del av velkomstsiden. Standardverdien er false. Dette flagget blir ignorert ved SWT-presentasjon. Siden 3.1
embedTarget (optional) - banen til en div på den gjeldende velkomstsiden som skal romme innholdet i hjelpeemnet. Hvis oppgitt, er embed som standard true, og den innfelte URLen blir satt inn i div med den oppgitte banen. Banen er relativ for siden, så den bør ikke starte med side-IDen. Underordnede for div blir erstattet med innholdet av URLen. Bare en div per side kan brukes som et innebyggingsmål. Dette flagget blir ignorert ved SWT-presentasjon. Det støttes heller ikke når XHTML brukes som introduksjonsinnhold. Siden 3.1


showMessage - viser en melding til brukeren ved hjelp av en standard informasjonsdialogboks.
message - meldingen som skal vises til brukeren.

showStandby - setter introduksjonsdelen i ventemodus, og viser standbyContentPart med de oppgitte inndataene.
partId - IDen for standbyContentPart som skal vises.
input - inndataene som skal defineres i standbyContentPart.

showPage - viser introduksjonssiden med den oppgitte IDen.
id - IDen for introduksjonssiden som skal vises.
standby (optional) = ("true" | "false") "false" - oppgir om introduksjonen skal settes i ventemodus etter at siden er vist.

Hvis en hvilken som helst av parameterne som sendes til disse handlingene, har spesialtegn (det vil si tegn som er ulovlige i en URL), bør de kodes med URL-kodingen UTF-8. For å motta disse parameterne i den dekodede tilstanden, kan det brukes en spesialparameter, decode = ("true" "false"), til å fremtvinge en dekoding av disse parameterne når introduksjonsrammeverket behandler dem.
Den følgende introduksjons-URLen:
http://org.eclipse.ui.intro/showMessage?message=This+is+a+message
vil for eksempel tolke meldingsparameteren som "This+is+a+message",
mens
http://org.eclipse.ui.intro/showMessage?message=This+is+a+message&amp;decode=true
vil tolke meldingsparameteren som "This is a message".


  • style-id - en metode for å klassifisere denne linken i en gitt kategori, slik at det kan brukes en felles stil.
  • filteredFrom - et valgfritt attributt som tillater filtrering av et gitt element ut av en bestemt implementering. Hvis en gruppe for eksempel har filteredFrom = swt, betyr det at denne gruppen ikke blir vist som innhold i swt-implementeringen.
  • 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

    Direkte HTML som skal inkluderes på siden enten ved å innfelle hele dokumentet eller ved å bygge inn en snutt av HTML på stedet. Et reservebilde eller en reservetekst må defineres for alternativ gjengivelse av swt-presentasjonen. Hvis innholdet inneholder erstatningssegmenter i formen $plugin:plugin_id$, blir de erstattet med den absolutte banen til plugin-modulen med IDen plugin_id.
    Innfelling muliggjør innfelling av en fullstendig definert HTML-fil i den dynamiske sidens innhold. Det blir opprettet et HTML-object-element som refererer til HTML-filen.
    Med inkludering kan en HTML-snutt inkluderes direkte fra en fil til den dynamiske HTML-siden.


    hr


    <!ELEMENT hr EMPTY>

    <!ATTLIST hr

    id           CDATA #IMPLIED

    style-id     CDATA #IMPLIED

    filteredFrom (swt|html) >

    En vannrett regel.


    title


    <!ELEMENT title EMPTY>

    <!ATTLIST title

    id           CDATA #IMPLIED

    style-id     CDATA #IMPLIED

    filteredFrom (swt|html) >

    En snutt med tekst som valgfritt kan inneholde avsluttede HTML-koder. Den brukes bare som en sidetittel, og en gitt side kan ha maksimalt ett title-element.


    text


    <!ELEMENT text EMPTY>

    <!ATTLIST text

    id           CDATA #IMPLIED

    style-id     CDATA #IMPLIED

    filteredFrom (swt|html) >

    En snutt med tekst som valgfritt kan inneholde avsluttede HTML-koder. Den kan omfatte b- og li-koder. Den kan også inneholde ankere for URLer. Hvis det er nødvendig med flere avsnitt, kan teksten deles i flere seksjoner som alle begynner og slutter med koden p.


    include


    <!ELEMENT include EMPTY>

    <!ATTLIST include

    configId    CDATA #IMPLIED

    path        CDATA #REQUIRED

    merge-style (true | false) >

    Utvider et element som blir brukt som mål av den oppgitte banen og valgfrie configId-attributter. Banen skal inneholde et unik element i den oppgitte konfigurasjonen. Den kan peke på en delt gruppe som er definert på konfigurasjonsnivået, eller et hvilket som helst element på en side.


    head


    <!ELEMENT head EMPTY>

    <!ATTLIST head

    src CDATA #REQUIRED>

    encoding     CDATA #IMPLIED

    Direkte HTML som skal inkluderes i sidens HEAD-innholdsområde. Det tillater tilføying av ekstra HTML i HTML HEAD-seksjonen. Dette er nyttig ved tilføying av Java-skript eller ekstra stilark. Hvis innholdet inneholder erstatningssegmenter i formen $plugin:plugin_id$, blir de erstattet med den absolutte banen til plugin-modulen med IDen plugin_id. Denne kodingen brukes bare med en HTML-basert introduksjonsdelimplementering. Den blir ignorert ved brukergrensesnittskjemaimplementering. En side kan ha mer enn ett HEAD-element. En implementering kan ha ett og bare ett HEAD-element (siden det deles for alle sider).


    img


    <!ELEMENT img EMPTY>

    <!ATTLIST img

    id           CDATA #REQUIRED

    src          CDATA #REQUIRED

    alt          CDATA #IMPLIED

    style-id     CDATA #IMPLIED

    filteredFrom (swt|html) >

    Et bilde som representerer introduksjonsinnhold og ikke presentasjon (i motsetning til dekorasjonsbilder som er definert i stiler).


    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>

    Innholdet som skal legges til i målankeret. Bare et extensionContent er tillatt i en oppgitt configExtension, fordi hvis utvidelsen ikke kan behandles (hvis konfigurasjonen ikke blir funnet eller hvis målankerelementet ikke blir funnet), må sidene og/eller gruppene i utvidelsen ignoreres.


    anchor


    <!ELEMENT anchor EMPTY>

    <!ATTLIST anchor

    id CDATA #REQUIRED>

    Et anker er elementet som brukes til å deklarere utvidbarhet. Det er plassert i en konfigurasjon som tillater eksterne bidrag. Bare ankere er gyldige målverdier for baneattributtet i et extensionContent.


    contentProvider

     

    <!ELEMENT contentProvider (text)>

    <!ATTLIST contentProvider

    id       CDATA #REQUIRED

    pluginId CDATA #IMPLIED

    class    CDATA #REQUIRED>

     

    En proxy for en introduksjonsinnholdsleverandør, som tillater at en introduksjonside henter data fra forskjellige kilder (for eksempel nettet eller Eclipse) og leverer innhold under kjøring basert på disse dynamiske dataene. Hvis IIntroContentProvider-klassen som er oppgitt i klasseattributtet, ikke kan lastes inn, blir innholdet i tekstelementet gjengitt i stedet. Dette er en dynamisk versjon av HTML-koden intro. Mens HTML-koden tillater gjengivelse eller innebygging av statisk HTML-innhold i den genererte introduksjonssiden i HTML, tillater contentProvider-koden dynamisk oppretting av dette innholdet under kjøring. En annen forskjell mellom kodene er at html-koden bare støttes for HTML-presentasjon, mens denne contentProvider-koden støttes både for HTML- og SWT-presentasjoner. Siden 3.0.1