Bevezető rész konfiguráció

org.eclipse.ui.intro.config

3.0

Ez a kiterjesztési pont szolgál bevezetőkonfigurációk bejegyzésére. Ez a konfiguráció megjelenítési megvalósításokat és tartalmat biztosít egy adott bevezető-hozzájáruláshoz. A bevezető a munkaterület első indításakor jelenik meg, valamint a Súgó menü megfelelő pontjának kiválasztására. A bevezető általában arra szolgál, hogy megismertesse a felhasználót valamely, az Eclipse-re épült termékkel.

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.



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



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



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



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



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



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

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.



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



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



Az alábbiakban bemutatjuk a konfigurációs kiterjesztési pont használatát:

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

További részletek az org.eclipse.ui.intro.config API csomag leírásában találhatók.

Az org.eclipse.platform bedolgozó által biztosított bevezető az egyetlen megvalósítás az Eclipse rendszeren belül.