Configurazione parte introduttiva

org.eclipse.ui.intro.config

3.0

Questo punto di estensione viene utilizzato per registrare una configurazione introduttiva. Questa configurazione fornisce le implementazioni e il contenuto di una presentazione per un contributo introduttivo dato. L'introduzione viene visualizzata quando il workbench viene avviato per la prima volta e come scelta del menu "Guida". L'introduzione viene generalmente utilizzata per presentare ad un utente un prodotto generato in Eclipse.

Le introduzioni sono organizzate in pagine che abitualmente riflettono una particolare categoria di materiale introduttivo. Ad esempio, una pagina Novità può introdurre nuovi concetti e funzionalità rispetto ad una versione precedente. Il contenuto definito da una configurazione introduttiva viene referenziato e esteso da altri plugin utilizzando il punto di estensione 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>

Un elemento config può essere utilizzato per configurare una parte introduttiva personalizzabile. Un elemento config deve specificare un id, un introId e un file di contenuto. Un file di contenuto introduttivo è un file XML che descrive le pagine, i gruppi e i collegamenti dell'introduzione.



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

<!ATTLIST presentation

home-page-id    CDATA #REQUIRED

standby-page-id CDATA #IMPLIED>

Elemento di presentazione che definisce tutte le possibili implementazioni di una presentazione della parte introduttiva. Possono essere definite una o più implementazioni. Una sola implementazione sarà scelta all'avvio, in base agli attributi os/ws delle implementazioni. Altrimenti verrà scelta la prima senza attributi os/ws definiti.



<!ELEMENT implementation (head?)>

<!ATTLIST implementation

kind  (swt|html)

style CDATA #IMPLIED

os    CDATA #IMPLIED

ws    CDATA #IMPLIED>

La presentazione delle esperienze della piattaforma presenta due implementazioni. Una è basata sul browser SWT, l'altra sui moduli dell'interfaccia utente. La parte introduttiva personalizzabile può essere configurata per utilizzare una di queste due presentazioni in base al sistema operativo (OS) o al sistema di gestione finestre (WS). Il tipo di implementazione è swt o html.



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

<!ATTLIST launchBar

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

bg       CDATA #IMPLIED

fg       CDATA #IMPLIED>

Il funzionamento della barra di avvio è associato al comando 'switchToLaunchBar'. Quando viene eseguito, il comando chiude l'introduzione e crea una barra di avvio in una delle aree di trim della finestra principale. La barra di avvio conterrà almeno un pulsante che consente all'utente di tornare all'ultima pagina introduttiva. Facoltativamente, può contenere altri pulsanti definiti utilizzando gli elementi shortcut. Questi pulsanti possono essere utilizzati per passare velocemente ad una determinata pagina introduttiva. Dalla versione 3.1



<!ELEMENT shortcut EMPTY>

<!ATTLIST shortcut

tooltip CDATA #IMPLIED

icon    CDATA #REQUIRED

url     CDATA #REQUIRED>

Verrà creato un pulsante nella barra di avvio dell'introduzione per ciascun elemento di collegamento. L'URL definito nel collegamento verrà eseguito quando si preme il pulsante. Dalla versione 3.1



<!ELEMENT handle EMPTY>

<!ATTLIST handle

close (true | false) "true"

image CDATA #IMPLIED>

Un elemento facoltativo che controlla il rendering degli handle della barra di avvio. Dalla versione 3.1



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

L'elemento introContent definisce il corpo del file del contenuto dell'introduzione. Il file del contenuto è costituito da pagine, gruppi condivisi che possono essere inclusi in più pagine ed estensioni a punti di ancoraggio definiti in altre configurazioni.



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

Questo elemento viene utilizzato per descrivere una pagina da visualizzare. L'introduzione può visualizzare pagine dinamiche e statiche.
Il contenuto delle pagine dinamiche viene generato dagli elementi secondari della pagina, descritti in basso. L'elemento style o alt-style verrà applicato in base alla presentazione. Gli stili possono essere ulteriormente migliorati facendo riferimento all'id o all'id della classe.
Le pagine statiche consentono il riutilizzo dei documenti HTML esistenti all'interno di un'introduzione e possono essere collegati da qualsiasi pagina statica o dinamica. Le pagine statiche non sono definite in un elemento pagina, sono semplicemente file html che possono essere collegati da altre pagine.
La pagina home, il cui id viene specificato nell'elemento di presentazione del punto di estensione della configurazione introduttiva, può presentare un url che indica che si tratta di una pagina statica. Se non viene specificato alcun url, la pagina home viene considerata come dinamica. Tutte le altre pagine descritte che utilizzano l'elemento pagina vengono considerate dinamiche.
Quando viene utilizzata la presentazione SWT e deve essere visualizzata una pagina statica, viene avviato un browser esterno e la pagina corrente resta visibile.
Gli elementi secondari utilizzati in una pagina dinamica sono i seguenti: un elemento secondario group viene utilizzato per raggruppare il contenuto correlato e applicare lo stile nel contenuto raggruppato. Un elemento secondario link definisce un collegamento che può essere utilizzato per collegarsi a una pagina statica o dinamica ed eseguire un'azione/un comando introduttivi. Un collegamento viene in genere definito a livello di pagina per spostarsi tra le pagine principali verso i collegamenti all'interno di una pagina. Un elemento secondario text definisce il contenuto testuale a livello di pagina. Un elemento secondario head è applicabile solo per la presentazione Web e consente di aggiungere altri documenti html alla sezione head HTML. Ciò è utile per aggiungere script java o fogli di stile supplementari. Un elemento secondario img definisce il contenuto di un'immagine per il livello di pagina. Un elemento secondario include consente il riutilizzo di qualsiasi elemento eccetto una pagina. Un elemento secondario html è applicabile solo per la presentazione Web e consente di inserire o includere documenti html al contenuto della pagina. La funzione di inserimento consente di inserire un file html completamente definito all'interno di un oggetto object HTML facendo riferimento al file html. La funzione di inclusione consente di includere un frammento html da un file html. Un elemento secondario title definisce il titolo della pagina. Un elemento secondario anchor definisce un punto in cui i contributi esterni possono essere effettuati da un elemento <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) >

Utilizzato per raggruppare il contenuto correlato, il contenuto a cui deve essere applicato uno stile simile o il contenuto che verrà incluso in altre pagine.



<!ELEMENT head EMPTY>

<!ATTLIST head

src      CDATA #REQUIRED

encoding CDATA #IMPLIED>

HTML diretto da includere nell'area contenuti HEAD di una pagina. Consente di aggiungere altri documenti html alla sezione HEAD HTML. Ciò è utile per aggiungere script java o fogli di stile supplementari. Questo tag deve essere utilizzato solo con un'implementazione della parte introduttiva basata su HTML. Viene semplicemente ignorato nel caso di un'implementazione di moduli dell'interfaccia utente. Una pagina può avere più elementi head. Un'implementazione può avere uno ed un solo elemento head (dal momento che è condivisa tra tutte le pagine).



<!ELEMENT title EMPTY>

<!ATTLIST title

id           CDATA #IMPLIED

style-id     CDATA #IMPLIED

filteredFrom (swt|html) >

un frammento di testo che può contenere tag HTML escape. Viene utilizzato solo come un titolo di pagina, per cui una determinata pagina può avere un massimo di un elemento title.



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

<!ATTLIST link

id           CDATA #IMPLIED

label        CDATA #IMPLIED

url          CDATA #REQUIRED

style-id     CDATA #IMPLIED

filteredFrom (swt|html) >

È possibile collegarsi a un file HTML statico, a un sito Web esterno o è possibile eseguire un'azione introduttiva URL.



<!ELEMENT text EMPTY>

<!ATTLIST text

id           CDATA #IMPLIED

style-id     CDATA #IMPLIED

filteredFrom (swt|html) >

un frammento di testo che può contenere tag HTML escape. Può includere i tag b e li. Può contenere inoltre gli ancoraggi per gli URL. Se sono necessari più paragrafi, il testo può essere diviso in più sezioni, ciascuna che inizia e finisce con il tag p.



<!ELEMENT img EMPTY>

<!ATTLIST img

id           CDATA #REQUIRED

src          CDATA #REQUIRED

alt          CDATA #IMPLIED

style-id     CDATA #IMPLIED

filteredFrom (swt|html) >

Un'immagine che rappresenta il contenuto introduttivo e non la presentazione (al contrario delle immagini di decorazione definite negli stili).



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

HTML diretto da includere nella pagina inserendo l'intero documento o incorporando un frammento HTML. Un'immagine o un testo fallback deve essere definito per il rendering della presentazione swt alternativa.
La funzione di inserimento consente di inserire un file html completamente definito all'interno della pagina dinamica. Viene creato un elemento object HTML che fa riferimento al file html.
La funzione di inclusione consente di includere un frammento html da un file in una pagina html dinamica.



<!ELEMENT include EMPTY>

<!ATTLIST include

configId    CDATA #IMPLIED

path        CDATA #REQUIRED

merge-style (true | false) >

espande un elemento destinazione del percorso fornito e gli attributi configId facoltativi. Il percorso deve indirizzare un elemento in modo univoco all'interno della configurazione specificata. Può indicare un gruppo condiviso definito a livello di configurazione o un elemento qualsiasi di una pagina.



<!ELEMENT anchor EMPTY>

<!ATTLIST anchor

id CDATA #REQUIRED>

l'anchor è l'elemento utilizzato per dichiarare l'estendibilità. Si tratta di un percorso nella configurazione che consente contributi esterni. Solo gli anchor sono valori di destinazione validi per l'attributo path in un extensionContent



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

<!ATTLIST extensionContent

style     CDATA #IMPLIED

alt-style CDATA #IMPLIED

path      CDATA #REQUIRED

content   CDATA #IMPLIED>

Il contenuto da aggiungere all'ancoraggio di destinazione. È consentito solo un elemento extensionContent in un determinato configExtension, in quanto se l'estensione non può essere risolta (se è impossibile individuare la configurazione o l'ancoraggio di destinazione), le pagine e/o i gruppi dell'estensione devono essere ignorati.



<!ELEMENT contentProvider (text?)>

<!ATTLIST contentProvider

id       CDATA #REQUIRED

pluginId CDATA #IMPLIED

class    CDATA #REQUIRED>

Un proxy per un fornitore di contenuto introduttivo, che consente ad una pagina introduttiva di acquisire dinamicamente dati da più origini (ad esempio, web, eclipse, ecc.) e di fornire il contenuto al runtime in base a questi dati dinamici. Se non è possibile caricare la classe IIntroContentProvider specificata nell'attributo class, sarà invece effettuato il rendering del contenuto dell'elemento text. Questa è una versione dinamica del tag intro html. Mentre il tag html consente di incorporare un contenuto html statico nella pagina di introduzione html generata, il tag contentProvider consente la creazione dinamica di questo contenuto al runtime. Un'altra differenza tra i tag è che il tag html è supportato solo per la presentazione HTML, mentre il tag contentProvider è supportato sia per la presentazione HTML che per la presentazione SWT. Dalla versione 3.0.1



Di seguito è riportato un utilizzo esemplificativo del punto di estensione 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>

Per ulteriori dettagli fare riferimento alle specifiche per il pacchetto API org.eclipse.ui.intro.config.

Il contributo del plugin org.eclipse.platform è l'unica implementazione fornita in Eclipse.