Konfigurace části Intro

org.eclipse.ui.intro.config

3.0

Tento bod rozšíření se používá k registraci konfigurace části Intro. Tato konfigurace nabízí implementaci a obsah prezentace pro daný příspěvek části Intro. Část Intro se zobrazí, když je pracovní plocha poprvé vyvolána, a také jako volba z nabídky "Nápověda". Část Intro se zpravidla používá k seznámení uživatele s produktem sestaveným na základě platformy Eclipse.

Části Intro jsou uspořádány do stránek, které obvykle odrážejí konkrétní kategorii úvodního materiálu. Například stránka Novinky může seznamovat s novými koncepty nebo funkčností přidanými k předchozí verzi. Obsah definovaný jednou konfigurací části Intro může být odkazován a rozšířen z dalších modulů plug-in pomocí bodu rozšíření org.eclipse.ui.intro.configExtension.

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

Prvek config může být použit ke konfiguraci přizpůsobitelné části Intro. Prvek config musí určit ID, introId a soubor s obsahem. Soubor s obsahem části Intro je soubor XML, který popisuje stránky, skupiny a odkazy, které část Intro má.



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

<!ATTLIST presentation

home-page-id    CDATA #REQUIRED

standby-page-id CDATA #IMPLIED>

Prvek prezentace, který definuje všechny přijatelné implementace pro prezentaci části Intro. Může v něm být definována jedna nebo více implementací. Při spuštění se vybere pouze jedna implementace na základě atributů os/ws z implementace. Jinak bude vybrán první z definovaných atributů jiných než os/ws.



<!ELEMENT implementation (head?)>

<!ATTLIST implementation

kind  (swt|html)

style CDATA #IMPLIED

os    CDATA #IMPLIED

ws    CDATA #IMPLIED>

Prezentace zkušeností s vybalováním platformy má dvě implementace. Jedna z nich je založena na Prohlížeči SWT a druhá je založena na Formulářích uživatelského rozhraní (UI Forms). Přizpůsobitelná část Intro může být konfigurována, aby zvolila jednu ze dvou prezentací podle aktuálního operačního systému (OS) a systému oken (WS). Typ implementace může být swt nebo html.



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

<!ATTLIST launchBar

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

bg       CDATA #IMPLIED

fg       CDATA #IMPLIED>

Panel spuštění funguje ve spojení s příkazem 'switchToLaunchBar'. Při svém spuštění příkaz zavře část Intro a vytvoří panel spuštění v jedné z oblastí obruby hlavního okna. Panel spuštění bude obsahovat nejméně jedno tlačítko umožňující uživateli vrátit se na poslední stránku Intro. Volitelně může obsahovat další tlačítka definovaná pomocí prvků shortcut. Tato tlačítka lze použít pro rychlý přechod na konkrétní stránku Intro. Od verze 3.1



<!ELEMENT shortcut EMPTY>

<!ATTLIST shortcut

tooltip CDATA #IMPLIED

icon    CDATA #REQUIRED

url     CDATA #REQUIRED>

Tlačítko bude vytvořeno pro každý prvek zástupce (shortcut) v panelu spuštění části Intro. Při stisku tlačítka se provede adresa URL definovaná v zástupci. Od verze 3.1



<!ELEMENT handle EMPTY>

<!ATTLIST handle

close (true | false) "true"

image CDATA #IMPLIED>

Volitelný prvek, který řídí způsob vykreslení popisovače panelu spuštění. Od verze 3.1



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

Prvek introContent definuje tělo souboru s obsahem části Intro. Soubor s obsahem je tvořen stránkami, sdílenými skupinami, které je možné zahrnout do více stránek, a rozšíření k vztažným bodům definovaným v jiných konfiguracích.



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

Tento prvek slouží k popisu stránky, která se má zobrazit. Část Intro může zobrazit dynamické a statické stránky.
Obsah pro dynamické stránky je generován z podřízených prvků stránky popsaných níže. V závislosti na prezentaci bude použit style nebo alt-style. Styly mohou být dále rozšířeny odkazy na id nebo class-id.
Statické stránky umožňují opětovné použití existujících dokumentů HTML v rámci vlastního úvodu a může na ně být odkazováno z libovolné statické nebo dynamické stránky. Statické stránky nejsou definovány v prvku stránky, jsou to v podstatě soubory HTML, na které může být odkazováno z jiných stránek.
Domovská stránka, jejíž ID je uvedeno v prezentačním prvku bodu rozšíření části Intro config, může mít adresu URL označující, že se jedná o statickou stránku. Pokud není zadána žádná adresa URL, je domovská stránka považována za dynamickou stránku. Všechny ostatní popsané stránky používající prvek stránky jsou dynamické.
- Rovněž vezměte na vědomí, že je-li použita prezentace SWT a má-li být zobrazena statická stránka, je spuštěn externí prohlížeč a aktuální stránka zůstane viditelná.
Podřízené prvky použité v dynamické stránce jsou následující: Dílčí prvek group slouží k seskupení souvisejícího obsahu a uplatnění stylu napříč seskupeným obsahem. Dílčí prvek link definuje odkaz, který lze použít k propojení na statickou nebo dynamickou stránku a ke spuštění akce nebo příkazu části Intro. Odkaz je obvykle definován na úrovni stránky pro navigaci mezi hlavními stránkami versus odkazy v rámci stránky. Dílčí prvek text definuje textový obsah na úrovni stránky. Dílčí prvek head se vztahuje pouze na webové prezentace a umožňuje přidání dalšího HTML do sekce HTML head. To je užitečné pro přidání skriptů Java nebo dalších seznamů stylů. Dílčí prvek img definuje obrázkový obsah pro úroveň stránky. Dílčí prvek include umožňuje opětovné použití jakéhokoli prvku vyjma stránky. Dílčí prvek html se vztahuje pouze na webové prezentace a umožňuje vložení nebo zahrnutí HTML do obsahu stránky. Vložení umožňuje zabudovat plně definovaný soubor html do objektu object HTML odkázáním na daný soubor HTML. Zahrnutí umožňuje včlenit úsek HTML přímo ze souboru HTML. Dílčí prvek title definuje název stránky. Dílčí prvek anchor definuje bod, kde mohou být prováděny externí příspěvky pomocí prvku <extensionContent>.



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

Používáno k seskupení souvisejícího obsahu, obsahu, na který by měl být použit podobný styl, nebo obsahu, který bude zahrnut dohromady na jiných stránkách.



<!ELEMENT head EMPTY>

<!ATTLIST head

src      CDATA #REQUIRED

encoding CDATA #IMPLIED>

Přímý kód HTML, který má být zahrnut do oblasti obsahu HEAD stránky. Umožňuje přidání dalšího html do sekce HTML HEAD. To je užitečné pro přidání java skriptů nebo dalších seznamů stylů. Tento markup může být používán pouze s implementací části Intro založené na HTML. V případě implementace Formulářů uživatelského rozhraní je jednoduše ignorován. Stránka může mít více než jeden prvek hlavičky (head). Implementace může mít pouze jediný prvek hlavičky (jelikož je sdílen mezi stránkami).



<!ELEMENT title EMPTY>

<!ATTLIST title

id           CDATA #IMPLIED

style-id     CDATA #IMPLIED

filteredFrom (swt|html) >

Úsek textu, který může volitelně obsahovat uvolněné značky HTML. Používá se pouze jako Titulek stránky, takže daná stránka může mít pouze jeden prvek titulku.



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

<!ATTLIST link

id           CDATA #IMPLIED

label        CDATA #IMPLIED

url          CDATA #REQUIRED

style-id     CDATA #IMPLIED

filteredFrom (swt|html) >

Může připojit ke statickému souboru HTML, k externí webové stránce nebo může spustit URL akce části Intro.



<!ELEMENT text EMPTY>

<!ATTLIST text

id           CDATA #IMPLIED

style-id     CDATA #IMPLIED

filteredFrom (swt|html) >

Úsek textu, který může volitelně obsahovat uvolněné značky HTML. Může zahrnovat značky b a li. Může také obsahovat kotvy pro adresy URL. Pokud jsou potřeba vícenásobné odstavce, může být text rozdělen do více oddílů, z nichž každý bude začínat a končit značkou p.



<!ELEMENT img EMPTY>

<!ATTLIST img

id           CDATA #REQUIRED

src          CDATA #REQUIRED

alt          CDATA #IMPLIED

style-id     CDATA #IMPLIED

filteredFrom (swt|html) >

Obrázek představující obsah části Intro a nikoli prezentaci (v protikladu k dekoračním obrázkům definovaným ve stylech).



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

Přímý HTML pro zahrnutí do stránky buď prostřednictvím vložení celého dokumentu, nebo prostřednictvím nahrazení úseku HTML. Obrázek nebo text stavu nouze musí být definován pro alternativní vykreslení prezentace SWT.
Vložení umožňuje zabudovat plně definovaný soubor html do obsahu dynamické stránky. Je vytvořen prvek object HTML odkazující na soubor HTML.
Zahrnutí umožňuje včlenit úsek html přímo ze souboru do dynamické html stránky.



<!ELEMENT include EMPTY>

<!ATTLIST include

configId    CDATA #IMPLIED

path        CDATA #REQUIRED

merge-style (true | false) >

Rozbalí prvek zaměřený v dané cestě a volitelné atributy configId. Cesta by měla jednoznačně adresovat prvek v rámci dané konfigurace. Může ukazovat na sdílenou skupinu definovanou na úrovni konfigurace nebo na libovolný prvek na stránce.



<!ELEMENT anchor EMPTY>

<!ATTLIST anchor

id CDATA #REQUIRED>

Kotva je prvek používaný pro deklarování rozšiřitelnosti. Jedná se o umístění v konfiguraci, které umožňuje externí příspěvky. Pouze kotvy jsou platnými cílovými hodnotami pro atribut cesty v prvku extensionContent.



<!ELEMENT extensionContent (text | group | link | html | include)>

<!ATTLIST extensionContent

style     CDATA #IMPLIED

alt-style CDATA #IMPLIED

path      CDATA #REQUIRED

content   CDATA #IMPLIED>

Obsah, který má být přidán do cílové kotvy. Pouze jeden prvek extensionContent je povolen v daném prvku configExtension, protože pokud by toto rozšíření nemohlo být vyřešeno (pokud nelze najít konfiguraci nebo prvek cílové kotvy), musely by být stránky anebo skupiny v rozšíření ignorovány.



<!ELEMENT contentProvider (text?)>

<!ATTLIST contentProvider

id       CDATA #REQUIRED

pluginId CDATA #IMPLIED

class    CDATA #REQUIRED>

Proxy pro poskytovatele obsahu části Intro, který umožňuje stránce Intro dynamicky natahovat data z různých zdrojů (např. z webu, eclipse atd.) a poskytovat obsah za běhu v závislosti na těchto dynamických datech. Pokud nemůže být třída IIntroContentProvider uvedená v atributu třídy načtena, bude namísto toho použit obsah textového prvku. Jedná se o dynamickou verzi značky HTML části Intro. Zatímco značka html umožňuje vložení nebo začlenění statického obsahu html do vygenerované stránky Intro ve formátu html, značka contentProvider umožňuje dynamické vytváření tohoto obsahu za běhu. Dalším rozdílem mezi značkami je, že značka html je podporována pouze pro HTML prezentaci, zatímco tato značka contentProvider je podporována jak prezentacemi HTML, tak i SWT. Od 3.0.1



Zde je příklad užití bodu rozšíření config.

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

Další podrobnosti viz specifikace pro balíček rozhraní API org.eclipse.ui.intro.config.

Část Intro vkládaná prostřednictvím modulu plug-inorg.eclipse.platform je jediná implementace v rámci platformy Eclipse.