Branding eines Features

Aus Eclipse
Wechseln zu: Navigation, Suche

Die Branding-Informationen aller Plug-Ins eines Features und des Features selbst sind teilweise im Feature selbst, aber auch teilweise im sogenannten Branding-Plug-In des Features abgelegt. Man muss aber kein zusätzliches Plug-In definieren, es reicht, das "Haupt"-Plug-In als BrandingPlug-In zu definieren. Das geschieht folgendermaßen:

Definieren des Branding-Plug-In


Was macht das gewählte Plug-In nun aber zum gebrandeten Plug-In? Ein gebrandetes Plug-In kann im root-Verzeichnis zusätzliche Dateien enthalten. Für Plug-Ins sind das:

  • about.html: ein einfache HTML-File, das die about-Informationen für das Plug-In hält und im Eclipse-about dialog erreichbar wird.
  • about.ini: ein Properties File siehe unten
  • about.properties: hält Lokalisierungs-Strings für about.ini
  • about.mappings: hält eventuelle Parameter für die about.ini Datei.
  • eine Bilddatei: Das Feature-Image im 32x32 Pixel format.


about.ini

Diese Properties-Datei enthält die Schlüssel=Wert Paare: aboutText, featureImage, tipsAndTricksHref. Sie haben folgenden Inhalt und folgendes Format:

aboutText: Enthält einen Multiline-Plain Text (Linefeeds also durch \n) mit Lizenzinformationen,
                 Copyrightinformationen, Versionsinfo, etc.. Eine Lokalisierung kann durch Parametrisierung 
                 mit vorangestelltem % erfolgen (bspw. %variablenname) und Besetzung dieser Variable im
                 about.properties-File. 
                 Weiterhin können noch Parameter im Format {<varname>} eingebracht werden, diese werden aus 
                 der about.mappings ersetzt.
featureImage: enthält den Dateinamen des 32x32 Pixel großen Bildes, das im Eclipse-Hilfe-About Fenster angezeigt werden soll. Bspw. HelloWorldIcon.gif
tipsAndTricksHref: enthält einen Link zu einer passenden tipsAndTricks Sektion in der Eclipse Hilfe.

Ein Beispiel für about.html, about.ini, about.properties, about.mappings und das FeatureIcon

Für unser HelloWorld-Feature erstellen wir diese Files in unserem BrandingPlug-In, also im Plug-In HelloWorldPlugin.

Als Beispiel für die about.html:

<html>
<head>
<title>Das HelloWorld-Feature
</title></head>
<body>
<!-- Hier referenzieren wir einfach nochmal das Icon, um ein Bild zu haben -->
<p><img src="HelloWorldIcon.gif"></img>
<h3>Hello World!</h3></p>
<p>Version: 1.0.0.0</p>
<p>Copyright: Hello World Provider</p></body></html>


Unser Beispiel für die about.ini, das % deutet an, dass der nachfolgende Parameter aus der about.properties stammt:

aboutText=%LokalisierterStringAusAboutProperties
featureImage=HelloWorldIcon.gif
#TipsAndTricksHref haben wir nicht definiert


Ein Beispiel für die about.properties, hier deuten die geschweiften Klammern eine Ersetzung aus about.mappings an:

LokalisierterStringAusAboutProperties=Hello World!\n\
\n\
Version: 1.0.0.0\n\
\n\
(c) 2010 vom Hello World Provider\n\
\n\
Lizensiert für {ausAboutMappings}\n


Und schließlich die about.mappings:

ausAboutMappings=You and Me

Das Thema Internationalisierung wird im weiteren Verlauf nicht weiter behandelt. Für weitere Informationen zum Thema Internationalisierung von Eclipse Plug-Ins sei auf: Artikel auf Eclipse.org verwiesen.

Das Feature in Eclipse

Unsere Feature-Einträge scheinen an diesen Stellen in der Eclipse Oberfläche durch (sofern wir vorher im Build-Script bekannt gegeben haben, dass die neuen files auch mit gepackaged werden sollen):

Das featureImage aus about.ini findet sich an prominenter Stelle direkt im Eclipse about Dialog wieder:

Das Feature Icon (die rote 8)

Beim Klick auf Installation-Details sehen wir unser Feature in der Software-Konfiguration:

Unser Feature in den InstallationDetails

Beim Klick auf unser Feature und Properties sehen wir die Information-Einträge aus der feature.xml:

Die Lizenz- und Copyrightinformationen unseres Features

aber auch im about-Dialog zum Feature selbst (den man durch Klick auf das Feature Logo im Eclipse-about erreicht). Hier findet sich auch der aboutText aus der about.ini des Branding-Plug-Ins wieder. Klickt man in diesem Dialog auf License, wird die URL geöffnet, die im feature.xml im element <license> hinterlegt wurde.

Das Feature Icon und der Text

In den Plug-In Details des Features findet man (nach einem Klick auf Legal Info) die Inhalte der about.html wieder.

Das about.html

Weiterführende Artikel

Erzeugen eines Features

Dokumentation und Hilfe

Links und Literatur zu Hilfe