3.1.0 verzió
Ez a dokumentum leírja a bevezető-tartalomfájl struktúráját DTD töredékek sorozataként.
introContent
<!ELEMENT introContent (page+ , group* , extensionContent*)>
Az introContent elem a bevezető tartalomfájl törzsét adja meg. A tartalomfájl oldalakból, több oldalon megadható megosztott csoportokból, és más konfiogurációkban megadott horgonypontok kiterjesztéseiből áll.
page
<!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>
Ez az elem a megjelenítendő oldalt írja le. A bevezető dinamikus és
statikus oldalakat is megjeleníthet.
A dinamikus oldalak tartalma az oldalak részelemeiből kerülnek
előállításra, az alább leírt módon. A megjelenítéstől függően a stílus
vagy az alternatív stílus kerül alkalmazásra. A stílusok az azonosítóra
vagy osztályazonosítóra hivatkozással tovább bővíthetők.
A statikus oldalak lehetővé teszik a meglévő HTML dokumentum
újrafelhasználást egy bevezetésben, és tetszőleges statikus vagy dinamikus
oldal hivatkozhat rájuk. A statikus oldalak nem page elemekben vannak
megadva, hanem egyszerű html fájlok, amelyekre más oldalak hivatkozhatnak.
A kezdőlap, amelynek azonosítója a bevezető konfigurációs kiterjesztési
pont presentation elemében van megadva, rendelkezhet olyan url címmel,
amely jelzi, hogy ez egy statikus oldal. Ha nincs megadva url, akkor a rendszer
feltételezi, hogy a kezdőlap dinamikus. A page elemmel leírt többi oldal
dinamikus.
SWT megjelenítés alkalmazásakor, valamint statikus oldal megjelenítésekor
egy külső böngésző kerül elindításra, és az aktuális oldal látható marad.
A dinamikus oldalon használt részelemek az alábbiak: A group
részelem csoportosítja a kapcsolódó tartalmat és egy stílust alkalmaz a
csoportosított tartalomra. A link részelem egy hivatkozást ad
meg, amely egy statikus vagy dinamikus oldalra mutat, és egy bevezető
tevékenységet/parancsot futtat. Az oldalon belüli hivatkozásokkal szemben
a link általában oldalszinten kerül megadásra a főoldalak közötti
navigáláshoz. A text részelem egy szöveges tartalmat ad
meg oldalszinten. A head részelem csak webes alapú megjelenítéshez
alkalmazható, és lehetővé teszi további html hozzáadását a HTML
head részhez. Ez java parancsfájlok és extra stíluslapok
hozzáadásánál hasznos. Az img részelem képtartalmat ad meg az
oldalszinthez. Az include részelem lehetővé teszi az oldaltól
különböző elemek újrafelhasználását. A html részelem csak webes alapú
megjelenítéshez alkalmazható, valamint a html oldal tartalmába beágyazásához
vagy belefoglalásához. A beágyazás lehetővé teszi egy teljesen megadott
html fájl HTML object elembe ágyazását a html fájlra hivatkozással. A
belefoglalás segítségével megadható közvetlenül egy html fájlból származó
html részlet. A title részelem az oldal címét írja le. Az
anchor részelem megad egy pontot, amelyben az
<extensionContent> elem külső kiegészítéseket adhat meg.
group
<!ELEMENT group (group* | link* | text* | img* | include* | html* | anchor*)>
<!ATTLIST group
id CDATA #REQUIRED
label CDATA #IMPLIED
style-id CDATA #IMPLIED
filteredFrom (swt|html) >
Csoportosítja a kapcsolódó tartalmat, a hasonló stílust alkalmazó tartalmat vagy az egy oldalon együtt megjelenítendő tartalmat.
link
<!ELEMENT link (text? , img?)>
<!ATTLIST link
id CDATA #IMPLIED
label CDATA #IMPLIED
url CDATA #REQUIRED
style-id CDATA #IMPLIED
filteredFrom (swt|html) >
Hivatkozhat egy statikus HTML fájlra, egy külső webhelyre, vagy futtathat egy Bevezető URL tevékenységet.
action name - a tevékenység leírása
action parameter1 - a paraméter leírása
action parameter2 (optional) - a paraméter leírása
action parameter3 (optional) = ("true" | "false") "false" - a
paraméter leírása, true vagy false érték választható, és a "false" az
alapértelmezett
close - bezárja a bevezető részt
nincsenek kötelező paraméterek
navigate - átvezet a bevezetőoldalakon egy adott irányban, vagy
visszavisz a kezdőlapra
direction = ("backward" | "forward" | "home") - megadja a navigáció
irányát
openBrowser - az URL-cím megnyitása egy külső böngészőben. A 3.1
verzió óta ez a művelet a munkaterület böngészőtámogatására épül. Ez azt
jelenti, hogy a böngésző számára megadott felhasználói beállítások elfogadásra
kerülnek.
url - egy külső webhely vagy statikus HTML fájl érvényes URL címe
pluginId (elhagyható) - csak statikus HTML fájl megadásakor
szükséges. Ez a fájlt tartalmazó bedolgozó azonosítója.
openURL - az Üdvözlet oldalba beágyazott
URL megnyitása. SWT megjelenítése esetén az URL egy külső böngészőben kerül
megjelenítésre (a fenti openBrowser művelethez hasonlóan).
A 3.1 változat óta.
url - egy külső webhely vagy a helyi HTML fájl érvényes URL címe
pluginId (elhagyható) - ha az URL relatív, akkor a fájlt
tartalmazó bedolgozó azonosítóját adja meg.
runAction - futtatja a megadott tevékenységet
class - az osztály teljes képzésű osztályneve, amely megvalósítja
az org.eclipse.ui.intro.config.IIntroAction
,
org.eclipse.jface.action.IAction
vagy
org.eclipse.ui.IActionDelegate
elemek egyikét.
pluginId - Az osztályt tartalmazó bedolgozó azonosítója.
standby (elhagyható) = ("true" | "false") "false" - jelzi, hogy a
tevékenység végrehajtása után a bevezetőt készenléti állapotba kell-e
állítani
további paraméterek - a további paraméterek átkerülnek az
org.eclipse.ui.intro.config.IIntroAction
elemet megvalósító
tevékenységhez
setStandbyMode - beállítja a bevezetőrész állapotát
standby = ("true" | "false") - A true a bevezetőrészt a részlegesen
látható készenléti módba teszi, a false pedig teljesen láthatóvá teszi
showHelp - Megnyitja a súgórendszert.
nincsenek kötelező paraméterek
showHelpTopic - Megnyit egy súgótémakört.
id - a súgóerőforrás URL címe. (Lásd:
org.eclipse.ui.help.WorkbenchHelp.displayHelpResource
Javadoc
dokumentuma
embed (elhagyható) = ("true" | "false") "true" - azt jelzi, hogy
a súgóerőforrást meg kell-e jeleníteni az Üdvözlet oldalak részeként. Az alapértelmezett értéke hamis.
Ez a jelző egyszerűen figyelmen kívül marad SWT megjelenítése esetén. A 3.1 változat óta.
embedTarget (nem kötelező) - az aktuális üdvözlő oldalon lévő div
elérési útja a Súgó témakör tartalmát tartalmazza.
Ha meg van adva, akkor az embed alapértelmezés szerint true
értékű és a beágyazott URL beszúrásra kerül a div részbe a megadott
elérési úttal. Az elérési út az oldalhoz viszonyítva relatív, így nem kezdődhet
az oldalazonosítóval. A div rész utódjai kicserélésre kerülnek az URL
tartalmára. Oldalanként csak egy div rész használható beágyazási célként.
Ez a jelző egyszerűen figyelmen kívül marad SWT megjelenítése esetén. Ez
nem támogatott, ha a bevezető tartalom XHTML. A 3.1 változat óta.
showMessage - Egy szokásos információs párbeszédablak segítségével
megjelenít egy üzenetet a felhasználó számára.
message - a felhasználó számára megjelenő üzenet
showStandby - A bevezetőrészt készenléti módba állítja, és
megjeleníti a standbyContentPart elemet az adott bemenettel
partId - a megjelenítendő standbyContentPart azonosítója
input - a standbyContentPart elemen beállítandó bemenet
showPage - megjeleníti a bevezetőoldalt az adott azonosítóval
id - a megjelenítendő bevezetőoldal azonosítója
standby (elhagyható) = ("true" | "false") "false" - jelzi, hogy az
oldal megjelenítése után a bevezető készenléti módba kerül-e
Ha ezen műveleteknek átadott paraméterek
bármelyike speciális karaktereket tartalmaz (azaz olyan karaktereket,
amelyek az URL címben illegálisak), akkor ezeket UTF-8 url kódolással kell
kódolni. Ha a paramétereket dekódolt állapotban kívánja megkapni, akkor a
decode = ("true" "false") speciális paraméter segítségével
kikényszerítheti a paraméterek dekódolását, amikor a Bevezetés
keretrendszer feldolgozza őket.
Az alábbi bevezető URL például:
http://org.eclipse.ui.intro/showMessage?message=This+is+a+message
az üzenetparamétert "This+is+a+message" karaktersorozatként dolgozza fel,
a
http://org.eclipse.ui.intro/showMessage?message=This+is+a+message&decode=true
pedig "This is a message" karaktersorozatként.
html
<!ATTLIST html
id CDATA #REQUIRED
src CDATA #REQUIRED
type (inline|embed)
style-id CDATA #IMPLIED
filteredFrom (swt|html) >
encoding CDATA #IMPLIED
közvetlen HTML az oldalon a teljes dokumentum beágyazásával, vagy a HTML
in-place egy részének beemelésével megadáshoz. Az alternatív swt
megjelenítés előállításhoz meg kell adni egy visszalépési képet vagy
szöveget.
A beágyazás lehetővé teszi egy teljesen megadott html fájl dinamikus oldal
tartalmába ágyazását. Létrejön egy HTML object elem, amely a html
fájlra hivatkozik.
A belefoglalás segítségével egy fájlból származó html részlet közvetlenül
egy dinamikus html oldalban adható meg.
title
<!ELEMENT title EMPTY>
<!ATTLIST title
id CDATA #IMPLIED
style-id CDATA #IMPLIED
filteredFrom (swt|html) >
Szövegrészlet, amely tartalmazhat escape-szekvenciákkal kódolt HTML címkéket is. Ez csak Oldalcímként használható, és így egy adott oldal maximum egy title elemet tartalmazhat.
text
<!ELEMENT text EMPTY>
<!ATTLIST text
id CDATA #IMPLIED
style-id CDATA #IMPLIED
filteredFrom (swt|html) >
Szövegrészlet, amely tartalmazhat escape-szekvenciákkal kódolt HTML címkéket is. Ez b és li címkéket tartalmazhat. URL-horgonyokat is tartalmazhat. Ha több bekezdésre van szükség, akkor a szöveg több részre osztható, amelyek mindegyike p címkével kezdődik és végződik.
include
<!ELEMENT include EMPTY>
<!ATTLIST include
configId CDATA #IMPLIED
path CDATA #REQUIRED
merge-style (true | false) >
Kibontja a megadott path
és elhagyható configId
attribútumokkal meghatározott elemet.
Az elérési útnak egyedien kell megcímeznie egy elemet a megadott
konfigurációban. Ez a konfigurációs szintet megadott megosztott csoportra
mutathat, vagy az oldal tetszőleges elemére.
true
, akkor a tartalmazott elemet
birtokló oldalhoz tartozó stílus hozzáadódik a tartalmazó oldal stílusok
listájához. Ha false
(az alapértelmezett), akkor a tartalmazó
oldal felelős a tartalmazott elem tulajdonságainak vezérléséért.head
<!ELEMENT head EMPTY>
<!ATTLIST head
src CDATA #REQUIRED>
encoding CDATA #IMPLIED
Közvetlen HTML az oldal HEAD tartalomterültén megadásához. Ennek segítségével további html adható hozzá a HTML HEAD részhez. Ez java parancsfájlok és extra stíluslapok hozzáadása esetén hasznos. Ez a leírónyelv csak HTML alapú bevezetőrész-megvalósításban használható. UI formátumok megvalósítás esetén ez egyszerűen figyelmen kívül marad. Az oldal több head elemmel rendelkezhet. A megvalósítás csak egy head elemmel rendelkezhet (mivel ez megosztásra kerül az összes oldalon).
img
<!ELEMENT img EMPTY>
<!ATTLIST img
id CDATA #REQUIRED
src CDATA #REQUIRED
alt CDATA #IMPLIED
style-id CDATA #IMPLIED
filteredFrom (swt|html) >
Egy bevezetőtartalmat, nem megjelenítést ábrázoló kép (a stílusokban megadott dekorációs képekkel ellentétben).
extensionContent
<!ELEMENT extensionContent (text | group | link | html | include)>
<!ATTLIST extensionContent
style CDATA #IMPLIED
alt-style CDATA #IMPLIED
path CDATA #REQUIRED>
A célhorgonyhoz adandó tartalom. Egy adott configExtension elemben csak egy extensionContent engedélyezett, mivel ha a kiterjesztés nem oldható fel (illetve ha a config vagy a cél anchor elem nem található), akkor a kiterjesztésben lévő oldalakat és/vagy csoportokat figyelmen kívül kell hagyni.
anchor
<!ELEMENT anchor EMPTY>
<!ATTLIST anchor
id CDATA #REQUIRED>
Az anchor a kiterjeszthetőség meghatározásához használt elem. Ez a konfiguráció azon helye, amely külső közreadásokat tesz lehetővé. A aextensionContent path attribútumának érvényes célértékei csak a horgonyok
contentProvider
<!ELEMENT contentProvider (text)>
<!ATTLIST contentProvider
id CDATA #REQUIRED
pluginId CDATA #IMPLIED
class CDATA #REQUIRED>
A bevezető-tartalomszolgáltató proxyja, amelynek segítségével a bevezetőoldal adatokat vehet át dinamikusan a különböző forrásokból (például web, eclipse, stb.), és tartalmat biztosíthat a futási környezet alapján ezekkel a dinamikus adatokkal. Ha az osztályattribútumban megadott IIntroContentProvider osztály nem tölthető be, akkor a szövegelem tartalma kerül előállításra. Ez a html bevezető címke dinamikus változata. A html címke lehetővé teszi statikus html tartalom beágyazását és beemelését az előállított html bevezetőoldalba, a contentProvider címke pedig lehetővé teszi ezen tartalom dinamikus létrehozását futás közben. Másik különbség a címkék között, hogy a html címkét csak a HTML megjelenítés támogatja, a contentProvider címkét pedig a HTML és SWT megjelenítés egyaránt. A 3.0.1 verzió óta.
Copyright (c) 2004 IBM Corporation és mások.
Minden jog fenntartva. Jelen program és annak kísérőanyagai a csomaghoz
tartozó, illetve a
http://www.eclipse.org/legal/epl-v10.html
címen is elérhető Eclipse Public License 1.0 verziójának hatálya alatt lettek
közzétéve.