Aufbau eines Widgets (veraltet)
Ein Widget verwendet eine Reihe verschiedener Dateien.
iWidget-XML
IBM® Business Monitor definiert seine Widgets mithilfe von XML-Dateien, die der Spezifikation iWidget 2.1 entsprechen.
Die iWidget-XML-Datei beschreibt die Eigenschaften des Widgets. Die Eigenschaften umfassen Name, Beschreibung und Attribute des Widgets sowie die Ereignisse, die von ihm ausgelöst oder akzeptiert werden können.
Widgetattribute steuern die äußere Darstellung eines Widgets sowie die Zuteilung der Datenquellen. Attribute werden oft als Konfigurationspunkte für ein Widget angesehen. Beispielsweise kann ein Widget, das Hotels auflistet, ein Attribut zum Ermitteln der Anzahl der Hotels definieren, die aufgelistet werden.
Widgets verwenden Ereignisse als kurzzeitige Möglichkeit zum Nutzen von gemeinsamen Informationen mit anderen Widgets. Von Widgets können Ereignisse gesendet und empfangen werden. Von jedem Widget wird entschieden, wann Ereignisse gesendet und welche Ereignisse empfangen werden. Dieses Senden und Empfangen geschieht mit einem Publish/Subscribe-Modell in der Definition des Widgets. Die Definition gibt an, welche Ereignisse das Widget veröffentlichen (senden) und welche es verarbeiten (empfangen) kann.
Die iWidget-XML-Datei definiert mithilfe des Elements <iw:resource> verschiedene Ressourcen, die von den Widgets verwendet werden, wie beispielsweise Scripts und CSS (Cascading Style Sheets).
Die iWidget-XML-Datei definiert darüber hinaus die Modi, die das Widget aufweist. Ein Modus gibt den Typ der Formatierung an, die für den Benutzer generiert werden soll. Ein Modus kann zum Beispiel ein Anzeigemodus (normale Benutzerformatierung) oder ein Bearbeitungsmodus (Formatierung für die Bearbeitung der Attribute des Widgets) sein.
Katalog-XML
Die Katalogdatei registriert das Widget und gibt die Kategorie an, zu der das Widget gehört. Wenn Benutzer die Widgets in der Palette anzeigen, können sie die Widgets filtern. Durch das Filtern werden in der Palette nur die Widgets angezeigt, die zu einer bestimmten Kategorie gehören. Die Katalogdatei definiert auch die Positionen der unterschiedlichen Ressourcen, die das Widget verwendet, wie beispielsweise die Position der iWidget-Definition, die Position des Symbols und der Vorschaubilder des Widgets und die Position, an der sich die Hilfedokumentation befindet.
XML-Datei für Endpunktregistrierung
Die XML-Datei für die Endpunktregistrierung definiert die Kontextstammverzeichnisse für die verschiedenen Endpunkte. Ein Endpunkt ist ein Service, der mithilfe von REST-APIs auf einem Server aktiv ist. Die Endpunktregistrierungsdatei registriert diesen Service im System, sodass Widgets mit dem Service kommunizieren können.
Plug-ins für die Dokumentation
- Die Datei plugin.xml, die das Plug-in definiert.
- Die Navigationsdatei, die den Inhalt des Navigationsrahmens im Hilfesystem definiert.
- Die Datei doc.zip, die den Inhalt des Dokumentations-Plug-in enthält.
Ein Plug-in für die Dokumentation kann auch im Format einer JAR-Datei vorliegen; der interne Inhalt ist jedoch identisch.