Introduktionsdel - konfiguration

org.eclipse.ui.intro.config

3.0

Dette udvidelsespunkt bruges til at registrere en introduktionskonfiguration. Denne konfiguration leverer præsentationsimplementeringer og indhold til et bestemt introduktionsbidrag. Der vises en introduktion, første gang arbejdsbænken startes, og introduktionen kan også vælges på menuen "Hjælp". Introduktionen bruges til at introducere en bruger til et produkt, der bygger på Eclipse.

Introduktionerne er organiseret i sider, som normalt afspejler en særlig kategori af introduktionsmateriale. Siden Nye funktioner kan f.eks. introducere nye begreber eller ny funktionalitet siden tidligere versioner. Andre plugins kan referere til og udvide det indhold, der er defineret af én introduktionskonfiguration, vha. udvidelsespunktet org.eclipse.ui.intro.configExtension.

<!ELEMENT extension (config+)>

<!ATTLIST extension

point CDATA #REQUIRED

id    CDATA #IMPLIED

navn  CDATA #IMPLIED>


<!ELEMENT config (presentation)>

<!ATTLIST config

introId    CDATA #REQUIRED

id         CDATA #REQUIRED

content    CDATA #REQUIRED

configurer CDATA #IMPLIED>

Et config-element kan bruges ti at konfigurere en introduktionsdel, der kan tilpasses. Et config-element skal angive en id, en introId og en indholdsfil. Indholdsfilen til introduktionen er en XML-fil, der beskriver de sider, grupper og link, som introduktionen består af.



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

<!ATTLIST presentation

home-page-id    CDATA #REQUIRED

standby-page-id CDATA #IMPLIED>

Præsentationselement, der definerer alle de mulige implementeringer af præsentationen af en introduktionsdel. Den kan have en eller flere implementeringer defineret i sig. Kun én implementering bliver valgt ved start, baseret på implementeringernes styresystem/vinduessystem. Ellers vælges den første, hvor der ikke er defineret nogen styresystem-/vinduessystemattributter.



<!ELEMENT implementation (head?)>

<!ATTLIST implementation

kind  (swt|html)

style CDATA #IMPLIED

os    CDATA #IMPLIED

ws    CDATA #IMPLIED>

Præsentationen af platformens indledende brugergrænseflade har to implementeringer. Den ene er SWT Browser-baseret, mens den anden er UI Forms-baseret. Introduktionsdelen kan tilpasses, så den henter en af disse to præsentationer, baseret på det aktuelle styresystem og vinduessystem. Typen af implementeringen kan være 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">

LaunchBar fungerer sammen med kommandoen 'switchToLaunchBar'. Når kommandoen udføres, lukker den introduktionen og opretter en startlinje i et af hovedvinduets ryddede områder. Startlinjen indeholder mindst én knap, der giver brugerne mulighed for at vende tilbage til den sidste introduktionsside. Desuden kan den indeholde andre knapper, som er defineret vha. shortcut-elementerne. Disse knapper kan bruges til hurtigt at gå til en bestemt introduktionsside. Siden 3.1



<!ELEMENT shortcut EMPTY>

<!ATTLIST shortcut

tooltip CDATA #IMPLIED

icon    CDATA #REQUIRED

url     CDATA #REQUIRED>

Der oprettes en knap på introduktionens startlinje for hvert genvejselement. Den URL, der er defineret i genvejen, udføres, når der trykkes på knappen. Siden 3.1



Elementet handle er forældet.

<!ELEMENT handle EMPTY>

<!ATTLIST handle

close (true | false) "true"

image CDATA #IMPLIED>

Et valgfrit element, der styrer, hvordan startlinjebehandleren gengives. Siden 3.1



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

Elementet introContent definerer indholdet i indholdsfilen til introduktionen. Indholdsfilen består af sider, fælles grupper, der kan inkluderes på flere sider, og udvidelser til ankerpunkter, der er defineret i andre 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>

Dette element bruges til at beskrive en side, der skal vises. Introduktionen kan vise både dynamiske og statiske sider.
Indhold til dynamiske sider genereres fra sidens underelementer, beskrevet nedenfor. Typografien eller den alternative typografi anvendes afhængigt af præsentationen. Typografierne kan forbedres yderligere ved at referere til id'en eller klasse-id'en.
Statiske sider giver mulighed for genbrug af eksisterende HTML-dokumenter i introduktionen, og alle statiske eller dynamiske sider kan kædes sammen med dem. Statiske sider er ikke defineret i et sideelement. Det er simpelthen html-filer, som kan kædes sammen med andre sider.
Hjemmesiden, hvis id er angivet i præsentationselementet for udvidelsespunktet til introduktionen, kan have en URL, der angiver, at det er en statisk side. Hvis der ikke er angivet en URL, antages det, at hjemmesiden er dynamisk. Alle andre sider, der er beskrevet vha. sideelementet, er dynamiske.
Bemærk også, at når SWT-præsentationen bruges, og der skal vises en statisk side, startes en ekstern browser, og den aktuelle side forbliver synlig.
De underelementer, der anvendes på en dynamisk side, er som følger: Et group-underelement bruges til at gruppere relateret indhold og anvende typografi på tværs af det grupperede indhold. Et link-underelement definerer et link, som kan bruges til sammenkædning med en statisk eller dynamisk side og udføre en introduktionsfunktion/-kommando. Et link defineres normalt på sideniveau til at navigere mellem hovedsider i modsætning til link på en side. Et text-underelement definerer tekstindholdet på sideniveau. Et head-underelement er kun tilgængeligt for den webbaserede præsentation og giver mulighed for at tilføje yderligere html til HTML-afsnittet head. Dette er nyttigt, når du vil tilføje Java-scripts eller ekstra typografiark. Et img-underelement definerer billedindhold til sideniveauet. Et include-underelement giver mulighed for at genbruge ethvert element på en anden side. Et html-underelement er kun tilgængeligt for den webbaserede præsentation og giver mulighed for at indbygge eller inkludere html i sidens indhold. Ved indbygning kan en fuldt defineret html-fil indbygges i et HTML-object ved at referere til html-filen. Ved inkludering kan html-kode inkluderes direkte fra en html-fil. Et title-underelement definerer titlen på siden. Et anchor-underelement definerer et punkt, hvor eksterne bidrag kan tilføres vha. et <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>

Bruges til at gruppere relateret indhold - indhold, der skal anvende en ensartet typografi, eller indhold, der skal inkluderes samlet på andre sider.



<!ELEMENT head EMPTY>

<!ATTLIST head

src      CDATA #REQUIRED

encoding CDATA #IMPLIED>

Direkte HTML, der skal inkluderes i en sides HEAD-indholdsområde. Det giver mulighed for at tilføje yderligere html i HTML-afsnittet HEAD. Dette er nyttigt, når du vil tilføje Java-scripts eller ekstra typografiark. Hvis indholdet indeholder erstatningssegmenter af formen $plugin:plugin_id$, erstattes de med den absolutte sti til plugin'en med id'en plugin_id. Denne kode skal kun bruges med en HTML-baseret implementering af en introduktionsdel. Den ignoreres, hvis der er tale om en UI Forms-implementering. En side kan have mere end ét head-element. En implementering kan have ét og kun ét head-element (eftersom det deles af alle sider).



<!ELEMENT title EMPTY>

<!ATTLIST title

id           CDATA #IMPLIED

style-id     CDATA #IMPLIED

filteredFrom (swt|html) >

Et tekststykke, der kan indeholde HTML-koder med Escape-tegn. Det bruges kun som sidetitel, så derfor kan en side kun have ét titelelement.



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

<!ATTLIST link

id           CDATA #IMPLIED

label        CDATA #IMPLIED

url          CDATA #REQUIRED

style-id     CDATA #IMPLIED

filteredFrom (swt|html) >

Kan sammenkædes til en statisk HTML-fil eller et eksternt websted, eller kan udføre en URL-funktion for en introduktion.



<!ELEMENT text EMPTY>

<!ATTLIST text

id           CDATA #IMPLIED

style-id     CDATA #IMPLIED

filteredFrom (swt|html) >

Et tekststykke, der kan indeholde HTML-koder med Escape-tegn. Det kan indeholde b- og li-koder. Det kan også indeholde ankre til URL'er. Hvis der er brug for flere afsnit, kan teksten opdeles i flere afsnit, der alle starter og slutter med p-koden.



<!ELEMENT img EMPTY>

<!ATTLIST img

id           CDATA #REQUIRED

src          CDATA #REQUIRED

alt          CDATA #IMPLIED

style-id     CDATA #IMPLIED

filteredFrom (swt|html) >

Et billede, der repræsenterer introduktionsindhold og ikke præsentation (i modsætning til dekorationsbilleder, der er defineret i typografier).



<!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, der skal inkluderes på siden, enten ved at indbygge hele dokumentet eller ved at anbringe et inline HTML-kodestykke lokalt. Et reservebillede eller en reservetekst skal defineres til gengivelse af alternativ swt-præsentation. Hvis indholdet indeholder erstatningssegmenter af formen $plugin:plugin_id$, erstattes de med den absolutte sti til plugin'en med id'en plugin_id.
Ved indbygning kan en fuldt defineret html-fil indbygges i den dynamiske sides indhold. Der oprettes et HTML-baseret object-element, som refererer til html-filen.
Ved inkludering kan html-kode inkluderes direkte fra en fil til den dynamiske html-side.



<!ELEMENT include EMPTY>

<!ATTLIST include

configId    CDATA #IMPLIED

path        CDATA #REQUIRED

merge-style (true | false) >

Udvider et element, som den angivne sti og de valgfrie configId-attributter har som mål. Stien skal entydigt adressere et element i den angivne konfiguration. Den kan pege på en delt gruppe, der er defineret på konfigurationsniveau eller et element på en side.



<!ELEMENT anchor EMPTY>

<!ATTLIST anchor

id CDATA #REQUIRED>

Et anker er det element, der bruges til at erklære udvidelsesmuligheder. Det er en placering i konfigurationen, der giver mulighed for eksterne bidrag. Kun ankre er gyldige målværdier for stiattributten i en 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>

Det indhold, der skal tilføjes til målankeret. Kun én extensionContent er tilladt i en given configExtension, fordi hvis denne udvidelse ikke kan fortolkes (hvis konfigurationen ikke findes, eller målankerelementet ikke findes), så skal siderne og/eller grupperne i udvidelsen ignoreres.



<!ELEMENT contentProvider (text?)>

<!ATTLIST contentProvider

id       CDATA #REQUIRED

pluginId CDATA #IMPLIED

class    CDATA #REQUIRED>

En proxy til en udbyder af introduktionsindhold, som giver mulighed for, at introduktionssiden dynamisk kan hente data fra forskellige kilder (f.eks. internettet, eclipse osv.) og levere indhold ved runtime, der er baseret på disse dynamiske data. Hvis den IIntroContentProvider-klasse, der er angivet i klasseattributten, ikke kan indlæses, bliver indholdet af tekstelementet i stedet gengivet. Dette er en dynamisk version af den html-baserede introduktionskode. Mens html-koden giver mulighed for at indbygge statisk html-indhold eller anbringe det inline på den genererede html-introduktionsside, giver koden contentProvider mulighed for dynamisk oprettelse af dette indhold ved runtime. En anden forskel mellem koderne er, at html-koden kun understøttes for HTML-præsentationen, mens denne contentProvider-kode understøttes for både HTML- og SWT-præsentationer. Siden 3.0.1



<!ELEMENT hr EMPTY>

<!ATTLIST hr

id           CDATA #IMPLIED

style-id     CDATA #IMPLIED

filteredFrom (swt|html) >

En vandret regel.



Her er et eksempel på brugen af konfigurationsudvidelsespunktet.

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

Der er flere oplysninger i specifikationerne til API-pakken org.eclipse.ui.intro.config.

Den introduktion, der tilføres vha. org.eclipse.platform plugin, er den eneste implementering i Eclipse.