Versione 3.1.0
Questo documento descrive la struttura del file del contenuto dell'introduzione come una serie di frammenti DTD.
introContent
<!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.
page
<!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>
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>.
group
<!ELEMENT group (group* | link* | text* | img* | include* | html* | anchor*)>
<!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.
link
<!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.
action name - descrizione dell'azione
action parameter1 - descrizione del parametro
action parameter2 (facoltativo) - descrizione del parametro
action parameter3 (facoltativo) = ("true" | "false") "false" - descrizione del parametro, scegliere i valori true o false, "false" è il valore predefinito
close - consente di chiudere la parte introduttiva
nessun parametro obbligatorio
navigate - consente lo spostamento tra le pagine introduttive in una determinata direzione o ritorna alla pagina home
direction = ("backward" | "forward" | "home") - consente di specificare la direzione di spostamento
openBrowser - consente di aprire l'URL in un browser esterno. Dalla versione 3.1, questa azione si
basa sul supporto browser del workbench. Questo significa che tutte le preferenze utente impostate per il browser verranno rispettate.
url - un URL valido a un sito web esterno o un file HTML statico
pluginId (facoltativo) - richiesto solo se viene specificato un file HTML statico. Si tratta dell'id del plugin contenente il file.
openURL - apre l'URL incorporato nella pagina di benvenuto. Nel caso di una presentazione SWT, l'URL
viene visualizzato in un browser esterno (simile all'azione openBrowser sopra indicata).
Dalla
versione 3.1
url - un URL valido a un sito Web esterno o un file HTML locale.
pluginId (optional) - se l'URL è relativo, specifica l'id del plugin che contiene il file.
runAction - consente di eseguire l'azione specificata
class - nome completo della classe che implementa org.eclipse.ui.intro.config.IIntroAction
,
org.eclipse.jface.action.IAction
o org.eclipse.ui.IActionDelegate
pluginId - l'id del plugin contenente la classe.
standby (facoltativo) = ("true" | "false") "false" - indica se impostare l'introduzione in modalità standby dopo l'esecuzione dell'azione
parametri supplementari - tutti i parametri supplementari sono trasferiti alle azioni che implementano org.eclipse.ui.intro.config.IIntroAction
setStandbyMode - consente di impostare lo stato della parte introduttiva
standby = ("true" | "false") - true per inserire la parte introduttiva nella modalità standby parzialmente visibile e false per
rendere la parte completamente visibile
showHelp - consente di aprire il sistema della guida.
nessun parametro obbligatorio
showHelpTopic - consente di aprire un argomento della guida.
id - l'URL della risorsa della guida. Fare riferimento a Javadoc per org.eclipse.ui.help.WorkbenchHelp.displayHelpResource
embed (facoltativo) = ("true" | "false") "true" - indica se la risorsa della guida deve essere visualizzata incorporata come
parte delle pagine di benvenuto. L'impostazione predefinita è false. Viene semplicemente ignorato nel caso di una
presentazione SWT. Dalla
versione 3.1
embedTarget (facoltativo) - il percorso ad un div della pagina di benvenuto corrente che conterrà
gli argomenti della guida. Se specificato, embed è true per impostazione predefinita e l'URL
incorporato viene inserito in div con il percorso specificato. Il percorso è relativo alla pagina e non dovrebbe iniziare con l'id pagina. Gli elementi secondari di div sono
sostituiti dal contenuto dell'URL. Può essere utilizzato un solo div per pagina come destinazione incorporata. Viene semplicemente ignorato nel caso di una
presentazione SWT. È supportato anche quando si utilizza XHTML come contenuto introduttivo. Dalla
versione 3.1
showMessage visualizza un messaggio all'utente utilizzando informazioni standard
message - il messaggio da visualizzare all'utente
showStandby - Imposta la parte introduttiva nella modalità standby e visualizza l'elemento standbyContentPart con l'input fornito
partId - l'id dell'elemento standbyContentPart da visualizzare
input - l'input da impostare nell'elemento standbyContentPart
showPage - mostra la pagina introduttiva con l'id fornito
id - l'id della pagina introduttiva da visualizzare
standby (facoltativo) = ("true" | "false") "false" - indica se impostare l'introduzione in modalità standby dopo la visualizzazione della pagina
Se uno dei parametri passati a queste azioni presenta caratteri speciali (ad esempio, caratteri non ammessi
in un URL), questi devono essere codificati con la codifica URL UTF-8. Per
ricevere parametri nello stato decodificato, è possibile utilizzare un parametro speciale, decode =
("true" | "false") per forzare la decodifica dei parametri quando sono elaborati dal framework
dell'introduzione.
Ad esempio, l'URL di introduzione seguente:
http://org.eclipse.ui.intro/showMessage?message=This+is+a+message
elaborerà il parametro del messaggio come "This+is+a+message"
mentre
http://org.eclipse.ui.intro/showMessage?message=This+is+a+message&decode=true
elaborerà il parametro del messaggio come "This is a message"
html
<!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.
title
<!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.
text
<!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.
include
<!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.
true
, lo stile appartenente alla pagina che contiene l'elemento incluso viene aggiunto all'elenco di stili della pagina di inclusione. Se false
(impostazione predefinita), la pagina di inclusione è responsabile del controllo delle proprietà dell'elemento incluso.head
<!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).
img
<!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).
extensionContent
<!ELEMENT extensionContent (text | group | link | html | include)>
<!ATTLIST extensionContent
style CDATA #IMPLIED
alt-style CDATA #IMPLIED
path CDATA #REQUIRED>
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.
anchor
<!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
contentProvider
<!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
Copyright (c) 2004 IBM Corporation e altri.
Tutti i diritti riservati. Questo programma e il materiale di accompagnamento sono disponibili secondo i termini della Eclipse Public
License v1.0 che sono distribuiti con il prodotto, e disponibili all'indirizzo
http://www.eclipse.org/legal/epl-v10.html