XML formátumú bevezető tartalomfájl

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



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>

Ez az elem a megjelenítendő oldalt írja le. A bevezető dinamikus és statikus oldalakat egyaránt 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 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, 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 cím, 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 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. 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 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 JavaScript-kód és további 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 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.


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

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 lefuttathat egy Bevezető URL tevékenységet.




Az előre meghatározott tevékenységek ezen formátum segítségével kerülnek leírásra:

action name - a tevékenység leírása
action parameter1 - a paraméter leírása
action 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


A bevezető keretrendszerben az alábbi előre meghatározott tevékenységek találhatók:

close - bezárja a bevezető részt
nincsenek kötelező paraméterek

execute - végrehajtja a megadott parancsot. A parancs sorosítási formátumával kapcsolatos részletekért tekintse meg az org.eclipse.core.command.ParameterizedCommand serialize() metódusát. A 3.2 változattól kezdve.
command - sorosított ParameterizedCommand
standby (elhagyható) = ("true" | "false") "false" - jelzi, hogy a parancs végrehajtása után a bevezetőt készenléti állapotba kell-e állítani

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 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özlő 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 - 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 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özlő 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 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&amp;decode=true
pedig "This is a message" karaktersorozatként.


  • style-id - A hivatkozás adott kategóriába csoportosítása, így egy közös stílus alkalmazható.
  • filteredFrom - elhagyható attribútum, amelynek segítségével a megadott elem kiszűrhető az adott megvalósításból. Ha például egy csoportnál a filteredFrom = swt érték van megadva, akkor az a csoport nem fog megjelenni tartalomként az swt megvalósításban.
  • 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

    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. Ha a tartalom a $plugin:plugin_id$ forma helyettesítő elemeit tartalmazza, akkor helyettesítésre kerülnek a plugin_id azonosítóval rendelkező bedolgozóval.
    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.


    hr


    <!ELEMENT hr EMPTY>

    <!ATTLIST hr

    id           CDATA #IMPLIED

    style-id     CDATA #IMPLIED

    filteredFrom (swt|html) >

    vízszintes szabály.


    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. Csak Oldalcímként használható, így egy adott oldal legfeljebb 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. 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 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. Konfigurációs szinten megadott osztott csoportra, illetve az oldal bármelyik elemére mutathat.


    head


    <!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 java parancsfájlok és extra stíluslapok hozzáadása esetén hasznos. Ha a tartalom a $plugin:plugin_id$ forma helyettesítő elemeit tartalmazza, akkor helyettesítésre kerülnek a plugin_id azonosítóval rendelkező bedolgozóval. 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).


    img


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


    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>

    A célhorgonyhoz hozzáadni kívánt 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é. Az extensionContent elem path attribútumának érvényes célértékei csak horgonyok lehetnek.


    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 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 verzió óta.