Esittelyosan rakenne

org.eclipse.ui.intro.config

3.0

Tämän laajennuspisteen avulla voit rekisteröidä esittelyrakenteen. Tämä rakenne määrittää tietyn esittelyosan esittelytoteutukset ja sisällön. Esittely tulee näkyviin, kun työympäristö aloitetaan ensimmäisen kerran tai kun esittelyvaihtoehto valitaan Ohje-valikosta. Esittelyosaa käytetään yleensä Eclipse-ympäristöön perustuvan tuotteen esittelemiseen käyttäjille.

Esittelyt on järjestetty sivuiksi, jotka on yleensä jaoteltu esittelyaineiston mukaisiin luokkiin. Esimerkiksi Uudet ominaisuudet -sivulla voi olla tietoja tuotteen aiempiin versioihin tehdyistä käsite- ja toimintolisäyksistä. Muut lisäosat voivat viitata esittelyrakenteen määrittämään sisältöön ja laajentaa sitä käyttämällä org.eclipse.ui.intro.configExtension-laajennuspistettä.

<!ELEMENT extension (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

configurer CDATA #IMPLIED>

Config-elementin avulla voidaan määrittää mukautettava esittelyn osa. Config-elementissä on oltava tunnuksen (id), esittelyn tunnuksen (introId) ja sisältötiedoston (content) määritteet. Esittelyn sisältötiedosto on XML-tiedosto, johon on määritetty esittelyn sisältämät sivut, ryhmät ja linkit.



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

<!ATTLIST presentation

home-page-id    CDATA #REQUIRED

standby-page-id CDATA #IMPLIED>

Esityselementti (Presentation) määrittää kaikki esittelyosan esityksen mahdolliset toteutukset. Siihen voi määrittää yhden tai useita toteutuksia. Ohjelmakehys valitsee aloituksen yhteydessä yhden näistä toteutuksista niiden käyttöjärjestelmä- ja ikkunointijärjestelmämääritteiden (os/ws) perusteella. Muussa tapauksessa valitaan ensimmäinen toteutus, jolle ei ole määritetty os/ws-määritteitä.



<!ELEMENT implementation (head?)>

<!ATTLIST implementation

kind  (swt|html)

style CDATA #IMPLIED

os    CDATA #IMPLIED

ws    CDATA #IMPLIED>

Käyttöympäristön perusversiossa esityksen voi toteuttaa kahdella eri toteutustavalla. Toinen toteutustapa perustuu SWT-selaimeen ja toinen käyttöliittymän lomakkeisiin (UI Forms). Mukautettavan esittelyosan voi määrittää käyttämään jompaakumpaa näistä esitystavoista käytetyn käyttöjärjestelmän ja ikkunointijärjestelmän mukaan. Toteutuslaji voi olla swt- tai html-tiedostot.



<!ELEMENT launchBar (handle? , shortcut*)>

<!ATTLIST launchBar

location (left|bottom|right|fastview) "fastview"

bg       CDATA #IMPLIED

fg       CDATA #IMPLIED

computed (true | false) "false">

Aloituspalkkimääritystä (Launchbar) käytetään yhdessä switchToLaunchBar-komennon kanssa. Kun tämä komento suoritetaan, esittely suljetaan ja jollekin pääikkunan reuna-alueelle lisätään aloituspalkki. Aloituspalkissa on ainakin yksi painike, jonka avulla käyttäjä voi palata esittelyn viimeksi käytetylle sivulle. Lisäksi palkissa voi olla pikavalintoina käytettäviä lisäpainikkeita. Niiden avulla voi siirtyä suoraan tietylle esittelyn sivulle. Käytettävissä versiosta 3.1 alkaen.



<!ELEMENT shortcut EMPTY>

<!ATTLIST shortcut

tooltip CDATA #IMPLIED

icon    CDATA #REQUIRED

url     CDATA #REQUIRED>

Tämä määritys luo esittelyn aloituspalkkiin pikavalintaelementtiin liitettävän painikkeen, jota napsautettaessa suoritetaan pikavalinnan mukainen URL-osoite. Käytettävissä versiosta 3.1 alkaen.



Elementti handle on vanhentunut

<!ELEMENT handle EMPTY>

<!ATTLIST handle

close (true | false) "true"

image CDATA #IMPLIED>

Tämä valinnainen elementti määrittää aloituspalkin kahvan muodon. Käytettävissä versiosta 3.1 alkaen.



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

IntroContent-elementti määrittää esittelyn sisältötiedoston runko-osan. Sisältötiedosto koostuu sivuista, jaetuista ryhmistä, joita voi käyttää useilla sivuilla, ja muissa rakenteissa määritetyistä alkukohtien laajennuksista.



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

Tämä elementti määrittää näytettävän sivun. Esittelyssä voidaan näyttää sekä dynaamisia että staattisia sivuja.
Dynaamisten sivujen sisältö luodaan sivun alielementtien mukaisesti jäljempänä kuvatulla tavalla. Esityksessä käytetään style- tai alt-style-määritteen mukaista tyyliasetusta. Tyylejä voi tehostaa id- ja class-id-tunnusviittauksilla.
Staattisten sivujen avulla esittelyssä voi käyttää aiemmin luotuja HTML-asiakirjoja, jotka voi linkittää miltä tahansa staattiselta tai dynaamiselta sivulta. Staattisia sivuja ei määritetä page-elementissä, vaan ne ovat html-tiedostoja, joihin muut sivut voidaan linkittää.
Aloitussivu, jonka tunnus on määritetty esittelyn config-laajennuspisteen presentation-elementissä, voidaan määrittää staattiseksi sivuksi lisäämällä sivulle URL-määritys. Jos aloitussivulla ei ole URL-määritystä, se käsitellään dynaamisena. Muut page-elementissä määritetyt sivut ovat dynaamisia.
Huomaa, että kun SWT-esitystapaa käytettäessä näytetään staattinen sivu, käytössä oleva sivu pysyy näkyvissä ja staattinen sivu avataan ulkoiseen selaimeen.
Dynaamisella sivulla käytetään seuraavia alielementtejä: Group-alielementti ryhmittelee kytketyn sisällön ja määrittää saman ryhmän sisällölle yhteisen tyylin. Link-alielementti sisältää linkkimäärityksen, jolla sivuun voi linkittää staattisen tai dynaamisen sivun tai suorittaa esittelyn toimintoja tai komentoja. Linkki määritetään yleensä sivutasolla pääsivujen ja muiden sivujen linkkien välisiä siirtymiä varten. Text-alielementti määrittää sivun tekstisisällön. Head-alielementin voi määrittää vain Web-esityksiin. Sen avulla voi lisätä HTML-lisäkoodia HTML-koodin head-osaan. Tätä alielementtiä voi käyttää Java-komentosarjojen tai lisätyylisivujen lisäykseen. Img-alielementti määrittää sivun kuvasisällön. Include-alielementin avulla sivulle voi lisätä aiemmin määritettyjä elementtejä (muita kuin sivuja). HTML-alielementin voi määrittää vain Web-esityksiin. Sen avulla sivun sisältöön voi upottaa tai lisätä HTML-sisältöä. Upottamalla HTML-koodin object-määritykseen voidaan lisätä kokonainen HTML-tiedosto määrittämällä viittaus HTML-tiedostoon. Vaihtoehtoisesti koodiin voidaan lisätä vain HTML-katkelma jostakin HTML-tiedostosta. Title-alielementti määrittää sivun otsikon. Anchor-alielementti määrittää pisteen, johon voidaan lisätä ulkoisia muokkauksia <extensionContent>-elementin avulla.



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

Tämä elementti ryhmittelee kytketyn sisällön, sisällön, jolle on määritettävä samankaltainen tyyli, tai sisällön, joka lisätään yhdessä muille sivuille.



<!ELEMENT head EMPTY>

<!ATTLIST head

src      CDATA #REQUIRED

encoding CDATA #IMPLIED>

Sivun HEAD-sisältöalueelle lisättävä suora HTML-koodi. Tämän elementin avulla voi lisätä HTML-koodia HTML-ylätunnisteosaan (HTML HEAD). Tätä alielementtiä voi käyttää Java-komentosarjojen tai lisätyylisivujen lisäykseen. Jos sisällössä on $plugin:plugin_id$-muotoisia korvaussegmenttejä, ne korvataan sen lisäosan tarkalla polulla, jonka tunnus on plugin_id. Tätä merkintää voi käyttää vain HTML-muotoisissa esittelyosan toteutuksissa. Käyttöliittymän lomaketoteutuksessa se ohitetaan. Sivulla voi olla useampi kuin yksi head-elementti. Toteutuksella voi olla vain yksi head-elementti (joka on yhteinen kaikilla toteutuksen sivuilla).



<!ELEMENT title EMPTY>

<!ATTLIST title

id           CDATA #IMPLIED

style-id     CDATA #IMPLIED

filteredFrom (swt|html) >

Tekstikatkelma, johon voi valinnaisesti lisätä HTML-koodinvaihtotunnisteita. Tätä elementtiä käytetään vain sivun otsikkona. Yhdellä sivulla voi olla vain yksi title-elementti.



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

<!ATTLIST link

id           CDATA #IMPLIED

label        CDATA #IMPLIED

url          CDATA #REQUIRED

style-id     CDATA #IMPLIED

filteredFrom (swt|html) >

Tämän elementin avulla voi linkittää staattisen HTML-tiedoston tai ulkoisen Web-sivuston tai suorittaa esittelyn URL-toiminnon.



<!ELEMENT text EMPTY>

<!ATTLIST text

id           CDATA #IMPLIED

style-id     CDATA #IMPLIED

filteredFrom (swt|html) >

Tekstikatkelma, johon voi valinnaisesti lisätä HTML-koodinvaihtotunnisteita. Katkelmassa voi käyttää b- ja li-tunnisteita sekä URL-osoitteiden ankkureita. Tekstin voi jakaa useaan kappaleeseen lisäämällä haluttujen kappaleiden alkuun ja loppuun p-tunnisteen.



<!ELEMENT img EMPTY>

<!ATTLIST img

id           CDATA #REQUIRED

src          CDATA #REQUIRED

alt          CDATA #IMPLIED

style-id     CDATA #IMPLIED

filteredFrom (swt|html) >

Kuva, joka sisältää esittelyn sisältöä. Tämä kuva ei liity sisällön esitystapaan, kuten tyylien avulla määritetyt koristekuvat.



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

Tämä elementti lisää sivulle HTML-koodia joko upottamalla sivulle kokonaisen asiakirjan tai lisäämällä sen koodiin HTML-katkelman. Vaihtoehtoista SWT-esitysmuotoilua varten on määritettävä varakuva tai -teksti. Jos sisällössä on $plugin:plugin_id$-muotoisia korvaussegmenttejä, ne korvataan sen lisäosan tarkalla polulla, jonka tunnus on plugin_id.
Upottamalla dynaamisen sivun sisältöön voidaan lisätä kokonainen HTML-tiedosto. HTML-koodiin luodaan object-elementti, jossa on viittaus HTML-tiedostoon.
Dynaamiselle HTML-sivulle voidaan lisätä myös vain HTML-katkelma jostakin tiedostosta.



<!ELEMENT include EMPTY>

<!ATTLIST include

configId    CDATA #IMPLIED

path        CDATA #REQUIRED

merge-style (true | false) >

Tämä elementti lisää määritetyn polun ja valinnaisten configId-määritteiden mukaisen elementin laajennuksen. Polun on määritettävä määritetyn rakenteen yksilöllinen elementti. Polku voi olla viittaus kokoonpanotasolla määritettyyn jaettuun ryhmään tai jonkin sivun elementtiin.



<!ELEMENT anchor EMPTY>

<!ATTLIST anchor

id CDATA #REQUIRED>

Anchor-elementti määrittää laajennusmahdollisuuden. Se määrittää sen rakenteen sijainnin, johon voidaan lisätä ulkoisia muokkauksia. ExtensionContent-elementin polkumääritteen (path) arvoina voi käyttää vain anchor-määritteitä.



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

Anchor-kohtaan lisättävä sisältö. Kuhunkin configExtension-elementtiin voi määrittää vain yhden extensionContent-määritteen, koska jos laajennuksen selvitys ei onnistu (config-rakennetta tai anchor-kohde-elementtiä ei löydy), laajennuksen sivut ja/tai ryhmät on ohitettava.



<!ELEMENT contentProvider (text?)>

<!ATTLIST contentProvider

id       CDATA #REQUIRED

pluginId CDATA #IMPLIED

class    CDATA #REQUIRED>

Tämä on sen esittelyn sisällön toimittajan välitysmääritys, jonka avulla esittelysivulle voidaan noutaa tietoja dynaamisesti erilaisista lähteistä (kuten Web-sivuilta ja Eclipse-ympäristöstä). Tällaisista dynaamisista tiedoista voidaan tuottaa sisältöä ajonaikaisesti. Jos class-määritteen mukaisen IIntroContentProvider-luokan lataus ei onnistu, sisältö muodostetaan text-elementin arvon mukaisen tekstisisällön perusteella. Tämä on HTML-koodin intro-tunnisteen dynaaminen versio. HTML-tunnisteen avulla luodulle HTML-esittelysivulle voi upottaa tai lisätä staattista HTML-sisältöä. ContentProvider-tunnisteen avulla tämä sisältö voidaan luoda dynaamisesti ja ajonaikaisesti. Lisäksi tunnisteet eroavat toisistaan siten, että HTML-tunnistetta voi käyttää vain HTML-esityksissä mutta contentProvider-tunnistetta voi käyttää sekä HTML- että SWT-esityksissä. Käytettävissä versiosta 3.0.1 alkaen.



<!ELEMENT hr EMPTY>

<!ATTLIST hr

id           CDATA #IMPLIED

style-id     CDATA #IMPLIED

filteredFrom (swt|html) >

Vaakaviiva.



Seuraavassa on config-laajennuspisteen käyttöesimerkki.

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

Lisätietoja on API-paketin org.eclipse.ui.intro.config määrityksessä.

Org.eclipse.platform-lisäosaan kuuluva esittely on ainoa Eclipse-ympäristön toteutus.