A bevezetők oldalakba vannak szervezve, amely oldalak általában a bevezető anyag egy adott kategóriájáról szólnak. Például az Újdonságok oldalon a korábbi verziókhoz képest megjelent új szempontok és funkciók tárgyalhatók. Az egyik bevezetőkonfiguráció által meghatározott tartalomra hivatkozhatnak más bedolgozók és bővíthetik az org.eclipse.ui.intro.configExtension kiterjesztési ponton keresztül.
<!ELEMENT extension (handle? , 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>
A config elem egy testreszabható bevezető rész beállítására használható. A config elemnek meg kell adnia egy azonosítót, egy introId azonosítót, valamint egy tartalomfájlt. A bevezető tartalom fájl egy XML fájl, amely leírja a bevezető oldalait, csoportjait és hivatkozásait.
<!ELEMENT presentation (implementation+ , launchBar?)>
<!ATTLIST presentation
home-page-id CDATA #REQUIRED
standby-page-id CDATA #IMPLIED>
A bevezető rész megjelenítésének összes lehetséges megvalósítását leíró megjelenítési elem. Egy vagy több megvalósítás lehet benne megadva. Indításkor csak egy megvalósítás kerül kiválasztásra, a megvalósítások os/ws (opeációs rendszer/ablakkezelő) attribútumaitól függően. Ellenkező esetben az első, os/ws attribútum nélküli kerül kiválasztásra.
<!ELEMENT implementation (head?)>
<!ATTLIST implementation
kind (swt|html)
style CDATA #IMPLIED
os CDATA #IMPLIED
ws CDATA #IMPLIED>
A platform "dobozból kivéve" bemutatója két megvalósítással rendelkezik. Az egyik SWT böngésző alapú, a másik UI űrlapokra épül. A testreszabható bevezető rész beállítható úgy, hogy az aktuális operációs rendszer és ablakkezelő alapján kiválassza a két bemutató egyikét. A megvalósítás típus swt vagy html.
org.eclipse.core.runtime.Platform
Javadocot).org.eclipse.core.runtime.Platform
Javadocot).<!ELEMENT launchBar (handle? , shortcut*)>
<!ATTLIST launchBar
location (left|bottom|right|fastview) "fastview"
bg CDATA #IMPLIED
fg CDATA #IMPLIED>
Az indítósáv a 'switchToLaunchBar' paranccsal együtt működik. A végrehajtáskor
a parancs bezárja a bevezetőt és létrehoz egy indítósávot a fő ablak egyik
szegélyterületén. Az indítósáv legkevesebb egy gombot fog tartalmazni, amely
lehetővé teszi a felhasználók számára a legutóbbi bevezetőoldalra visszatérést.
Nem kötelező módon tartalmazhat további gombokat is, amelyek a
shortcut
elemek használatával adhatók meg. Ezen gombok egy adott
bevezetőoldalra lépéshez használhatók. A 3.1 változat óta.
balra
, le
vagy
fönt
). Ha a lehetőség fastview
(az
alapértelmezett) értékre van állítva, akkor az indítósáv kezdetben ott jön
létre, ahol gyorsnézet sáv található.<!ELEMENT shortcut EMPTY>
<!ATTLIST shortcut
tooltip CDATA #IMPLIED
icon CDATA #REQUIRED
url CDATA #REQUIRED>
minden egyes parancsikon shortcut elemhez egy gomb létrehozásra kerül a bevezető indítósávban. A parancsikonban meghatározott URL akkor kerül futtatásra, amikor a gombot megnyomja a felhasználó. A 3.1 változat óta.
<!ELEMENT handle EMPTY>
<!ATTLIST handle
close (true | false) "true"
image CDATA #IMPLIED>
elhagyható elem, amely az indítósáv-kezelő előállításának módját irányítja. A 3.1 változat óta.
true
).<!ELEMENT introContent (page+ , group* , extensionContent*)>
Az introContent elem írja le a bevezető tartalomfájl törzsét. A tartalomfájl oldalakból, több oldalon is használható megosztott csoportokból, valamint más konfigurációkban meghatározott horgonypontokra mutató kiterjesztésekből áll.
<!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) >
Ez az elem írja le a megjelenítendő oldalakat. A bevezető dinamikus és
statikus oldalakat egyaránt megjeleníthet.
A dinamikus oldalak tartalma az oldal alább leírt részelemei alapján
kerülnek előállításra. A bemutatótól függőel a style vagy alt-style
elemben meghatározott stílus kerül alkalmazásra. A stílusok tovább finomíthatók az id vagy class-id elemekre hivatkozással.
A statikus oldalak lehetővé teszik meglévő HTML dokumentumok
felhasználását, és hivatkozhatók bármelyik statikus vagy dinamikus
oldalról. A statikus oldalak nem page
elemekben vannak megadva, ezek egyszerűen létező HTML fájlok, amelyekre
más oldalak hivatkozhatnak.
A kezdőlap, amelynek azonosítója a bevezető konfiguráció
kiterjesztési pont presentation elemében van megadva, rendelkezhet egy
URL címmel, jelezve, hogy ez egy statikus oldal. Ha nincs megadva URL
cím, akkor a rendszer feltételezi, hogy a kezdőlap dinamikus. A page elemmel leírt minden egyéb oldal dinamikus.
Ne feledje továbbá, hogy ha az SWT bemutatót használja és egy statikus
oldal kerül megjelenítésre, akkor elindul egy külső böngésző és az
aktuális oldal továbbra is látható marad.
A dinamikus oldalban használt részelemek a következők: a group
részelem használható a csoportokkal kapcsolatos tartalom leírására,
illetve a csoportosított tartalmon stílus alkalmazására. A link részelem egy hivatkozást határoz meg, amely használható
egy statikus vagy dinamikus oldalra hivatkozásra, valamint futtathat
egy bevezető tevékenységet/parancsot. A hivatkozás normál esetben
oldalszinten van megadva, a főoldalak közötti navigálás céljából (szemben
az oldalon belüli hivatkozásokkal). A text részelem szöveges
tartalmat határoz meg az oldal szintjén. A head részelem csak a
webalapú megjelenítés esetén használható, és lehetővé teszi a HTML
head szakasz további HTML-kóddal bővítését. Ez hasznos például
JavaScript-kód vagy extra stíluslapok hozzáadására. Az img részelem oldalszint képi elemet határoz meg. Az
include részelem lehetővé teszi az oldalakon kívül minden más
elem újrafelhasználását. A html részelem csak a webalapú
megjelenítés esetén használható és lehetővé teszi HTML-kód
beillesztését vagy beágyazását az oldal tartalmába. A beágyazás egy teljes HTML-fájl beágyazását jelenti egy
HTML-objektumba (object) a HTML-fájlra hivatkozással. A
beillesztés egy HTML-kódrészlet beillesztését jelenti, közvetlenül
egy HTML-fájlból. A title részelem az oldal címét adja meg. Az anchor részelem egy olyan pontot határoz meg, amelyen keresztül
külső bővítések vehetők fel egy <extensionContent> elem
segítségével.
true
(az
alapértelmezett), akkor a megosztott stílus hozzáadásra kerül az oldal
stílusaihoz. Ha false
, akkor a Bevezető konfigurációban megadott
megosztott stílus nem kerül be az oldal stílusai közé.<!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) >
A kapcsolódó tartalom, a hasonló stílust igénylő tartalom, illetve a más oldalakon együtt szereplő tartalom csoportosítására használatos.
<!ELEMENT head EMPTY>
<!ATTLIST head
src CDATA #REQUIRED
encoding CDATA #IMPLIED>
Közvetlen HTML egy oldal HEAD tartalomterületén belüli felhasználásra. Lehetővé teszi a HTML HEAD szakasz további HTML-kóddal bővítését. Ez hasznos például JavaScript-kód vagy extra stíluslapok hozzáadására. Ez a kód csak HTML alapú bevezetőrész-megvalósítás esetén használható. UI űrlapok alapú megvalósítás esetén egyszerűen figyelmen kívül marad. Egy oldalnak egynél több head eleme is lehet. Egy megvalósításnak azonban pontosan egy head elemmel kell rendelkeznie (mivel ez megosztásra kerül az oldalak között).
<!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. Csak Oldalcímként használatos, így egy oldalon belül maximum egyetlen title elem szerepelhet.
<!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 lefuttathat egy Bevezető URL tevékenységet.
tevékenység neve - tevékenység leírása
tevékenység parameter1 - a paraméter leírása
tevékenység parameter2 (elhagyható) - 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
nincs szükség paraméterekre
navigate - végignavigálás a bevezető oldalain egy adott irányban, vagy visszatérés 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 helyi HTML fájl érvényes URL címe
pluginId (elhagyható) - ha az URL relatív, akkor egy bedolgozóhoz
viszonyítva relatív. Itt a fájlt tartalmazó bedolgozó azonosítóját adja meg.
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 - A megadott tevékenység futtatása.
osztály - Az org.eclipse.ui.intro.config.IIntroAction
, org.eclipse.jface.action.IAction
vagy
org.eclipse.ui.IActionDelegate
felületek valamelyikét
megvalósító osztály teljes képzésű osztályneve.
pluginId - Az osztályt tartalmazó bedolgozó azonosítója.
standby (optional) = ("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 - Minden további paraméter az
org.eclipse.ui.intro.config.IIntroAction
felületet
megvalósító osztálynak kerül átadásra.
setStandbyMode - Beállítja a bevezető rész állapotát.
standby = ("true" "false") - A true esetén a bevezető rész a
részben látható készenléti módba kerül, false hatására teljesen látható
lesz.
showHelp - A súgórendszer megnyitása.
nincs szükség paraméterekre
showHelpTopic - Súgótémakör megnyitása.
id - A súgóerőforrás URL címe. (Lásd:
org.eclipse.ui.help.WorkbenchHelp.displayHelpResource Javadoc
dokumentáció)
embed (optional) = ("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. Ez egyenértékű az openURL()
paranccsal azzal a különbséggel, hogy ez a Súgórendszer témaköreire vonatkozik.
A beágyazott URL az aktuális oldal egészét elfoglalja. A 3.1 változat óta.
embedTarget (optional) - 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
a megadott elérési úttal beszúrásra kerül a div részbe. 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 bevezető tartalomként XHTML-t használ. A 3.1 változat óta.
showMessage - Szabványos információs párbeszédpanelen megjelenít
egy üzenetet a felhasználnak.
message - A felhasználónak megjelenítendő üzenet.
showStandby - A bevezető részt készenléti módba helyezi, és
megjeleníti standbyContentPart által megadott tartalmat a megadott
bemenettel.
partId - A megjelenítendő standbyContentPart azonosítója.
input - A standbyContentPart beállítandó bemenete.
showPage - Megjeleníti a megadott azonosítójú bevezető oldalt.
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.
<!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. B
és LI
címkéket tartalmazhat.
Emellett URL címek horgonyai is lehetnek benne.
Ha több bekezdésre van szükség, akkor a szöveg P
címkével
kezdődő és végződő szakaszokra bontható.
<!ELEMENT img EMPTY>
<!ATTLIST img
id CDATA #REQUIRED
src CDATA #REQUIRED
alt CDATA #IMPLIED
style-id CDATA #IMPLIED
filteredFrom (swt|html) >
A bevezető tartalmához, és nem megjelenéséhez tartozó kép (szemben a stílusokban meghatározott dekorációs képekkel).
<!ATTLIST html
id CDATA #REQUIRED
src CDATA #REQUIRED
type (inline|embed)
style-id CDATA #IMPLIED
filteredFrom (swt|html)
encoding CDATA #IMPLIED>
Az oldalba helyezendő közvetlen HTML, például teljes dokumentum beágyazása
vagy HTML részlet helyben meghatározása. Kötelezően meg kell adni egy
képet vagy szöveget, amelyhez az SWT megjelenítés vissza tud térni.
A beágyazás lehetővé teszi teljes HTML fájl befoglalását a dinamikus oldal
tartalmába. Ilyenkor HTML object elem jön létre, amely a HTML
fájlra hivatkozik.
A befoglalás HTML részletek közvetlen beillesztését teszi lehetővé egy
fájlból a dinamikus HTML oldalba.
embed
, akkor egy érvényes (teljes) HTML dokumentum kerül beágyazásra az OBJECT
HTML címkével. Az inline
megadásakor az src
értéke egy helyben megadott HTML kódrészletként kerül értelmezésre. (Ha a típus nincs megadva, akkor a HTML objektum figyelmen kívül marad a bevezetés konfigurációban.)type=inline
van megadva). Ha nincs megadva, akkor az alapértelmezés az UTF-8. A 3.0.1 óta.<!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. A path
attribútumnak egyedi módon kell azonosítania a megadott konfiguráció valamelyik elemét. Konfigurációs szinten megadott osztott csoportra, illetve az oldal
bármelyik elemére mutathat.
true
, akkor a tartalmazott elemet birtokló oldalhoz tartozó stílus bekerül a tartalmazó oldal stílusainak listájába. A false
beállítás esetén (ez az alapértelmezés) a tartalmazó oldal felelős a tartalmazott elem tulajdonságainak kezeléséért.<!ELEMENT anchor EMPTY>
<!ATTLIST anchor
id CDATA #REQUIRED>
A horgonyok a bővíthetőséget meghatározó elemek. A konfigurációnak olyan helyére utal, amely lehetővé teszi a külső hozzájárulásokat. A extensionContent
elem path
attribútumának érvényes célértékei csak horgonyok lehetnek.
<!ELEMENT extensionContent (text | group | link | html | include)>
<!ATTLIST extensionContent
style CDATA #IMPLIED
alt-style CDATA #IMPLIED
path CDATA #REQUIRED
content CDATA #IMPLIED>
A célhorgonyhoz hozzáadni kívánt tartalom. Minden configExtension csak egyetlen extensionContent
elemet tartalmazhat, mivel ha ez a kiterjesztés nem oldható fel (például mert a konfiguráció vagy a cél horgony elem nem található), akkor a kiterjesztés oldalait és/vagy csoportjait figyelmen kívül kell hagyni.
<!ELEMENT contentProvider (text?)>
<!ATTLIST contentProvider
id CDATA #REQUIRED
pluginId CDATA #IMPLIED
class CDATA #REQUIRED>
Egy bevezetőtartalom-szolgáltató proxy funkciója, amely lehetővé teszi a
bevezető oldalnak a különböző forrásokból (például Internet, Eclipse,
stb.) származó adatok dinamikus összegyűjtését és a tartalom dinamikus
adatok alapján történő kiszolgálását. Ha a class
attribútumban megadott IIntroContentProvider osztály nem tölthető be,
akkor helyette a szöveges elem tartalma kerül megjelenítésre.
Ez a HTML
bevezető dinamikus változata. Míg a HTML címke statikus HTML tartalom
beágyazását teszi lehetővé az előállított HTML bevezető oldalba, a
contentProvider
címke a tartalom dinamikus létrehozását teszi
lehetővé.
A címkék közötti másik különbség, hogy a html
címke
csak a HTML megjelenítés esetén érvényes, míg a
contentProvider
a HTML és SWT megjelenítésnél egyaránt. A 3.0.1 óta.
class
attribútummal meghatározott IContentProvider osztályt tartalmazó bedolgozó azonosítója. Az attribútum elhagyható, csak akkor kell használni, ha az osztály nem ugyanabból a bedolgozóból származik, mint amelyik a leírónyelvet meghatározta.
<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 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.