Die Einführungen sind in Seiten zusammengefasst, die üblicherweise eine bestimmte Kategorie des einführenden Materials widerspiegeln. Sie werden z.B, auf der Seite 'Neue Funktionen' neue Konzepte oder Funktionen seit der vorhergehenden Version vorgestellt. Der Inhalt, der durch eine Intro-Konfiguration definiert wird, kann durch andere Plug-ins unter Verwendung des Erweiterungspunkts org.eclipse.ui.intro.configExtension referenziert oder erweitert werden.
<!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>
Ein Element 'config' kann verwendet werden, um eine anpassungsfähige Intro-Komponente zu konfigurieren. Das Element 'config' muss eine ID, eine introID und eine Inhaltsdatei angeben. Bei der Inhaltsdatei der Einführung handelt es sich um eine XML-Datei, die die Seiten, Gruppen und Links der Einführung beschreibt.
<!ELEMENT presentation (implementation+ , launchBar?)>
<!ATTLIST presentation
home-page-id CDATA #REQUIRED
standby-page-id CDATA #IMPLIED>
Darstellungselement, das alle möglichen Implementierungen der Darstellung einer Intro-Komponente definiert. Darin können eine oder mehrere Implementierungen definiert sein. Beim Start wird nur eine Implementierung ausgewählt, basierend auf den Attributen für das Betriebssystem/Fenstertechniksystem der Implementierungen. Andernfalls wird die erste ohne Attribute für das Betriebssystem/Fenstertechniksystem ausgewählt.
<!ELEMENT implementation (head?)>
<!ATTLIST implementation
kind (swt|html)
style CDATA #IMPLIED
os CDATA #IMPLIED
ws CDATA #IMPLIED>
Die Darstellung der sofort einsatzfähigen Plattformfunktion hat zwei Implementierungen. Eine davon basiert auf dem SWT-Browser, die andere auf Benutzerschnittstellenformularen. Die anpassungsfähige Intro-Komponente kann so konfiguriert werden, dass sie eine der beiden Darstellungen, basierend auf dem aktuellen Betriebssystem und Fenstertechniksystem, auswählt. Die Art der Implementierung kann SWT oder HTML sein.
org.eclipse.core.runtime.Platform
).org.eclipse.core.runtime.Platform
).<!ELEMENT launchBar (handle? , shortcut*)>
<!ATTLIST launchBar
location (left|bottom|right|fastview) "fastview"
bg CDATA #IMPLIED
fg CDATA #IMPLIED>
Startleisten arbeiten in Verbindung mit dem Befehl 'switchToLaunchBar'. Nach der Ausführung schließt der Befehl das Intro und erstellt eine Startleiste in einem der Ausschnittsbereiche des Hauptfenster. Die Startleiste enthält mindestens eine Schaltfläche, die es den Benutzern ermöglicht, zur letzten Intro-Seite zurückzukehren. Optional kann sie weitere Schaltflächen enthalten, die mit Hilfe von Direktaufruf
-Elementen definiert werden. Diese Schaltflächen dienen dazu, schnell zu einer bestimmten Intro-Seite zu wechseln. Ab 3.1
links
, unten
oder rechts
). Wenn die Auswahl auf fastview
(Standardeinstellung) eingestellt ist, wird die Startleiste ursprünglich dort erstellt, wo sich die Leiste der Schnellanzeige befindet.<!ELEMENT shortcut EMPTY>
<!ATTLIST shortcut
tooltip CDATA #IMPLIED
icon CDATA #REQUIRED
url CDATA #REQUIRED>
Eine Schaltfläche wird in der Intro-Startleiste für jedes Direktaufrufelement erstellt. Die in dem Direktaufruf definierte URL wird ausgeführt, wenn die Schaltfläche betätigt wird. Ab 3.1
<!ELEMENT handle EMPTY>
<!ATTLIST handle
close (true | false) "true"
image CDATA #IMPLIED>
Ein optionales Element, das steuert, wie die Startleistenkennung übergeben wird. Ab 3.1
true
).<!ELEMENT introContent (page+ , group* , extensionContent*)>
Das Element introContent definiert den Hauptteil der Einführungsinhaltsdatei. Die Inhaltsdatei besteht aus Seiten, gemeinsam benutzten Gruppen, die in mehrere Seiten aufgenommen werden können, und Erweiterungen für Ankerpunkte, die in anderen Konfigurationen definiert sind.
<!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) >
Dieses Element beschreibt eine Seite, die angezeigt werden soll. Die Einführung kann sowohl dynamische als auch statische Seiten anzeigen.
Der Inhalt für dynamische Seiten wird aus den Unterelementen der Seite generiert, die im Folgenden beschrieben sind. Abhängig von der Darstellung kommt entweder das Attribut style oder das Attribut alt-style zu Anwendung. Die Darstellungen können weiter erweitert werden, indem auf das Attribut id oder class-id verwiesen wird.
In statischen Seiten können vorhandene HTML-Dokumente innerhalb einer Einführung wiederverwendet werden. Außerdem kann jede beliebige statische oder dynamische Seite Links zu statischen Seiten enthalten. Statische Seiten werden nicht in einem Element page definiert. Es handelt sich um einfache HTML-Dateien, zu denen andere Seiten Links enthalten können.
Die Homepage, deren id im Darstellungselement des Erweiterungspunktes für die Einführungskonfiguration angegeben ist, kann über eine URL verfügen, mit der angegeben wird, dass es sich um eine statische Seite handelt. Falls keine URL angegeben ist, wird davon ausgegangen, dass die Homepage eine dynamische Seite ist. Alle anderen Seiten, die mit dem Element page beschrieben werden, sind dynamische Seiten.
Außerdem ist bei Verwendung der SWT-Darstellung und dem Anzeigen einer statischen Seite zu beachten, dass ein externer Browser gestartet wird und die aktuelle Seite sichtbar bleibt.
In einer dynamischen Seite werden die folgenden Unterelemente verwendet: Mit einem Unterelement group wird zusammengehörender Inhalt gruppiert und eine bestimmte Darstellung auf den gruppierten Inhalt angewendet. Das Unterelement link definiert einen Link, mit dem ein Link zu einer statischen oder zu einer dynamischen Seite hergestellt und eine Aktion oder ein Befehl für die Einführung ausgeführt wird. Normalerweise wird ein Link auf der Seitenebene definiert, damit zwischen den Hauptseiten (gegenüber den Links auf einer Seite) navigiert werden kann. Ein Unterelement text definiert Textinhalt auf Seitenebene. Ein Unterelement head
kann nur bei der webbasierten Darstellung angewendet werden und ermöglicht das Hinzufügen weiterer html-Daten zum HTML-Abschnitt head. Dies ist für das Hinzufügen von Java-Scripts oder zusätzlicher Style-Sheets nützlich. Ein Unterelement
img definiert Imageinhalt für die Seitenebene. Mit einem Unterelement
include kann ein beliebiges anderes Element (mit Ausnahme einer Seite) wiederverwendet werden. Ein Unterelement html kann nur bei der webbasierten Darstellung angewendet werden und ermöglicht das Einbetten oder Aufnehmen von html-Daten in den Inhalt der Seite. Beim Einbetten kann eine vollständig definierte HTML-Datei in
ein HTML-Element object eingebettet werden, indem auf die HTML-Datei verwiesen wird. Mit einem Einschluss kann ein HTML-Ausschnitt direkt aus einer HTML-Datei integriert werden. Ein Unterelement title definiert den Titel der Seite. Ein Unterelementanchor definiert einen Punkt, an dem externe Ergänzungen durch ein Element <extensionContent> bereitgestellt werden können.
true
eingestellt (Standardeinstellung), so wird die gemeinsam genutzte Darstellung zu den Darstellungen dieser Seite hinzugefügt. Bei false
wird die in der Intro-Konfiguration definierte gemeinsam genutzte Darstellung nicht in die Darstellungen dieser Seite eingefügt.<!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) >
Mit diesem Element wird zusammengehörender Inhalt gruppiert sowie Inhalt, auf den eine ähnliche Darstellung angewendet werden soll, oder Inhalt, der zusammen in andere Seiten integriert werden soll.
<!ELEMENT head EMPTY>
<!ATTLIST head
src CDATA #REQUIRED
encoding CDATA #IMPLIED>
Dieses Element weist HTML an, Daten in den Inhaltsbereich HEAD einer Seite aufzunehmen. Auf diese Weise kann zusätzliches HTML zum HTML-Abschnitt HEAD hinzugefügt werden. Dies ist für das Hinzufügen von Java-Scripts oder zusätzlicher Style-Sheets nützlich. Diese Angabe kann nur bei einer HTML-basierten Implementierung der Einführungskomponente verwendet werden. Bei einer Implementierung mit Benutzerschnittstellenformularen wird sie einfach ignoriert. Eine Seite kann mehrere Elemente 'head' enthalten. Eine Implementierung kann lediglich ein Element 'head' enthalten (weil sie von allen Seiten gemeinsam benutzt wird).
<!ELEMENT title EMPTY>
<!ATTLIST title
id CDATA #IMPLIED
style-id CDATA #IMPLIED
filteredFrom (swt|html) >
Dieses Element ist ein Textausschnitt, der optional verlassene HTML-Tags enthalten kann. Es wird als Titel der Seite verwendet. Daher kann jede Seite maximal nur ein Element 'title' enthalten.
<!ELEMENT link (text? , img?)>
<!ATTLIST link
id CDATA #IMPLIED
label CDATA #IMPLIED
url CDATA #REQUIRED
style-id CDATA #IMPLIED
filteredFrom (swt|html) >
Dieses Element kann einen Link zu einer statischen HTML-Datei oder einer externen Website herstellen oder aber eine Aktion für die Einführungs-URL ausführen.
action name: Beschreibung der Aktion
action parameter1: Beschreibung des Parameters
action parameter2 (optional): Beschreibung des Parameters
action parameter3 (optional) = ("true"
"false") "false" - Beschreibung des Parameters. Zur Auswahl stehen "true" und "false"; "false" ist der Standardwert.
close: Schließt die Einführungskomponente.
Es sind keine Parameter erforderlich.
navigate: Navigiert in einer bestimmten Richtung durch die Einführungsseiten oder kehrt zur Homepage zurück.
direction = ("backward"
"forward"
"home") - Gibt die Richtung für die Navigation an.
openBrowser - Öffnet die URL in einem externen Browser. Ab Version 3.1 stützt sich diese Aktion auf die Browserunterstützung der Workbench. Das bedeutet, dass alle durch den Benutzer eingestellten Vorgaben für den Browser berücksichtigt werden.
url - Eine gültige URL zu einer externen Webseite oder einer lokalen HTML-Datei
pluginId (optional) - Wenn die URL relativ ist, bezieht sie sich auf ein Plug-in. Geben Sie hier die ID des Plug-ins an, das die Datei enthält.
openURL - Öffnet die URL eingebettet in der Startseite 'Willkommen'. Im falle der SWT-Darstellung wird die URL in einem externen Browser angezeigt (ähnlich der oben beschriebenen Aktion 'openBrowser'). Ab 3.1
url - Eine gültige URL zu einer externen Webseite oder einer lokalen HTML-Datei
pluginId (optional) - Wenn die URL relativ ist, wird hier die ID eines Plug-ins angegeben, das die Datei enthält.
runAction: Führt die angegebene Aktion aus.
class: Der vollständig qualifizierte Klassenname der Klasse, die org.eclipse.ui.intro.config.IIntroAction
,
org.eclipse.jface.actino.IAction
oder org.eclipse.ui.IActionDelegate
implementiert.
pluginId: Die ID des Plug-ins, das die Klasse enthält.
standby (optional) = ("true"
"false") "false" - Gibt an, ob die Einführung nach der Ausführung der Aktion in den Bereitschaftsmodus gesetzt werden soll.
Zusätzliche Parameter: Alle zusätzlichen Parameter werden an Aktionen übergeben, die org.eclipse.ui.intro.config.IIntroAction
implementieren.
setStandbyMode: Legt den Status der Einführungskomponente fest.
standby = ("true"
"false") - Bei "true" wird die Einführungskomponente in den teilweise sichtbaren Bereitschaftsmodus versetzt. Bei "false" ist die Komponente komplett sichtbar.
showHelp: Öffnet die Hilfefunktion.
Es sind keine Parameter erforderlich.
showHelpTopic: Öffnet ein Hilfethema.
id: Die URL der Hilferessource (siehe das Javadoc für org.eclipse.ui.help.WorkbenchHelp.displayHelpResource)
embed (optional) = ("true"
"false") "true" - Gibt an, dass die Hilferessource eingebettet als Teil der Startseite 'Willkommen' angezeigt werden muss. Der Standardwert ist "false". Im Falle der SWT-Darstellung wird dieses Attribut einfach ignoriert. Dies entspricht dem Befehl 'openURL()' jedoch für Themen der Hilfefunktion. Die eingebettete URL nimmt die gesamte aktuelle Seite ein. Ab 3.1
embedTarget (optional) - Der Pfad zu einer div in der aktuellen Startseite 'Willkommen', die den Inhalt des Hilfethemas enthalten wird. Wenn angegeben, ist einbetten standardmäßig 'true' und die eingebettete URL wird mit dem angegebenen Pfad innerhalb der div eingefügt. Der Pfad ist relativ zu der Seite und sollte daher mit der Seiten-ID nicht starten. Die untergeordneten Elemente der div werden durch den Inhalt der URL ersetzt. Pro Seite kann nur eine div als eingebettetes Ziel verwendet werden. Im Falle der SWT-Darstellung wird dieses Attribut einfach ignoriert. Es wird ebenfalls nicht unterstützt, wenn XHTML als Inhalt der Einführung verwendet wird. Ab 3.1
showMessage: Zeigt unter Verwendung eines Standardinformationsdialogs eine Nachricht für den Benutzer an.
message: Die Nachricht, die für den Benutzer angezeigt werden soll.
showStandby: Setzt die Einführungskomponente in den Bereitschaftsmodus und zeigt 'standbyContentPart' mit der angegebenen Eingabe an.
partId - Die ID des anzuzeigenden 'standbyContentPart'
input: Die Eingabe, die für 'standbyContentPart' festgelegt werden soll.
showPage: Zeigt die Einführungsseite mit der angegebenen ID an.
id: Die ID der anzuzeigenden Einführungsseite.
standby (optional) = ("true"
"false") "false" - Gibt an, ob die Einführung nach dem Anzeigen der Seite in den Bereitschaftsmodus gesetzt werden soll.
Wenn die an diese Aktion übergebene Parameter Sonderzeichen enthalten (d.h. Zeichen, die für eine URL nicht zulässig sind), so sollten sie anhand der Codierung 'UTF-8' codiert werden. Für den Empfang dieser Parameter in ihrem decodierten Zustand kann ein Sonderparameter decode = ("true" "false") verwendet werden, um eine Decodierung dieser Parameter zu erzwingen, wenn das Intro-Gerüst diese verarbeitet.
Die folgende Intro-URL:
http://org.eclipse.ui.intro/showMessage?message=Dies+ist+eine+Nachricht
verarbeitet beispielsweise den Nachrichtenparameter als "Dies+ist+eine+Nachricht"
während
http://org.eclipse.ui.intro/showMessage?message=Dies+ist+eine+Nachricht&decode=true
den Nachrichtenparameter als "Dies ist eine Nachricht" verarbeitet.
<!ELEMENT text EMPTY>
<!ATTLIST text
id CDATA #IMPLIED
style-id CDATA #IMPLIED
filteredFrom (swt|html) >
Dieses Element ist ein Textausschnitt, der optional verlassene HTML-Tags enthalten kann. Es kann die Tags "b" und "li" enthalten. Außerdem kann es Anker für URLs enthalten. Falls mehrere Absätze benötigt werden, kann der Text in mehrere Abschnitte unterteil werden, die jeweils mit dem Tag "p" beginnen und enden.
<!ELEMENT img EMPTY>
<!ATTLIST img
id CDATA #REQUIRED
src CDATA #REQUIRED
alt CDATA #IMPLIED
style-id CDATA #IMPLIED
filteredFrom (swt|html) >
Dieses Element gibt ein Image an, das Einführungsinhalt und (im Gegensatz zu den in Darstellungen definierten Dekorationsimages) keine Darstellung angibt.
<!ATTLIST html
id CDATA #REQUIRED
src CDATA #REQUIRED
type (inline|embed)
style-id CDATA #IMPLIED
filteredFrom (swt|html)
encoding CDATA #IMPLIED>
Dieses Element weist HTML an, die Seite entweder durch Einbettung des gesamten Dokuments oder durch die Integration eines vorhandenen HTML-Ausschnitts aufzunehmen. Es muss ein Image oder Text für das Zurücksetzen definiert werden, damit eine alternative SWT-Darstellung wiedergegeben werden kann.
Beim Einbetten kann eine vollständig definierte HTML-Datei in
den Inhalt einer dynamischen Seite eingebettet werden. Es wird ein HTML-Element object erstellt, das auf die HTML-Datei verweist.
Mit einem Einschluss kann ein HTML-Ausschnitt direkt aus einer Datei in die dynamische HTML-Seite integriert werden.
<!ELEMENT include EMPTY>
<!ATTLIST include
configId CDATA #IMPLIED
path CDATA #REQUIRED
merge-style (true | false) >
Ein Element include erweitert ein Element, das ein Ziel des angegebenen Pfades und einem optionalen Attribut configID ist. Der Pfad sollte ein Element in der angegebenen Konfiguration eindeutig adressieren. Er könnte auf eine gemeinsam benutzte Gruppe zeigen, die auf der Konfigurationsebene definiert ist, oder auf ein beliebiges Element in einer Seite.
true
gesetzt ist, wird die Darstellung, die zur Eignerseite des aufgenommenen Elements gehört, zur Liste der Darstellungen für die aufnehmende Seite hinzugefügt. Hat dieses Attribut den Wert false
, ist die aufnehmende Seite dafür zuständig, die Eigenschaften des aufgenommenen Elements zu steuern.<!ELEMENT anchor EMPTY>
<!ATTLIST anchor
id CDATA #REQUIRED>
Mit dem Element anchor wird die Erweiterungsfähigkeit deklariert. Es handelt sich um eine Position in der Konfiguration, an der externe Ergänzungen zulässig sind. Nur Elemente 'anchor' sind gültige Zielwerte für das Attribut 'path' in einem Objekt 'extensionContent'.
<!ELEMENT extensionContent (text | group | link | html | include)>
<!ATTLIST extensionContent
style CDATA #IMPLIED
alt-style CDATA #IMPLIED
path CDATA #REQUIRED
content CDATA #IMPLIED>
Dieses Element gibt den Inhalt an, der zum Zielanker hinzugefügt werden soll. In einem gegebenen Objekt 'configExtension' ist jeweils nur ein Element 'extensionContent' zulässig. Dies liegt daran, dass bei einer nicht erfolgreichen Auflösung der Erweiterung (falls die Konfiguration oder aber das Zielelement nicht gefunden werden kann) die Seiten und/oder Gruppen in der Erweiterung ignoriert werden müssen.
<!ELEMENT contentProvider (text?)>
<!ATTLIST contentProvider
id CDATA #REQUIRED
pluginId CDATA #IMPLIED
class CDATA #REQUIRED>
Ein Proxy für einen Einführungsinhalt-Provider, der ermöglicht, dass Einführungsseiten dynamisch Daten von verschiedenen Quellen (z.B. dem Web, Eclipse, usw.) extrahieren und, basierend auf diesen dynamischen Daten zur Laufzeit Inhalt zur Verfügung stellen. Wenn die Klasse 'IIntroContentProvider', die in dem Klassenattribut angegeben worden ist, nicht geladen werden kann, wird statt dessen der Inhalt des Texteleme nts übergeben. Dies ist eine dynamische Version des HTML-Einführungstags. Während das HTML-Tag ermöglicht, dass ein statischer HTML-Inhalt in die generierte HTML-Einführungsseite eingebettet oder integriert wird, ermöglicht das Tag 'contentProvider' die dynamische Erstellung dieses Inhalts zur Laufzeit. Ein weiterer Unterschied zwischen den Tags ist, dass das HTML-Tag nur für die HTML-Darstellung unterstützt wird, während das Tag 'contentProvider' sowohl für HTML- als auch für SWT-Darstellung unterstützt wird. Ab 3.0.1
<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>
Copyright (c) 2004 IBM Corporation und Andere.
Alle Rechte vorbehalten. Dieses Programm und sein Begleitmaterial werden gemäß den Bedingungen der "Eclipse Public License v1.0" zur Verfügung gestellt, die dieser Lieferung beiliegt und unter
http://www.eclipse.org/legal/epl-v10.html abgerufen werden kann.