Aufgabe
Mit diesem Element wird ein Portlet in einem HTML-Dokument referenziert. Mit Hilfe des Instanzenbezeichners können bei Bedarf unterschiedliche Instanzen des Portlets generiert werden. Möchten Sie beispielsweise ein Portlet einbinden, mit dem Ihre Website bewertet werden kann, so ist eine Instanz ausreichend und der Instanzenname braucht nicht angegeben zu werden, selbst wenn das Portlet auf mehr als einer Seite eingebunden wird. Verwenden Sie dieses Portlet jedoch, um einzelne Seiten bewerten zu lassen, so muss für jede Seite eine eigene Portlet-Instanz verwendet werden. In diesem Fall kann beispielsweise der Pfad der Seite als Instanzenname verwendet werden, da er eindeutig ist. Der Pfad kann mit Hilfe einer @-Referenz ermittelt werden (siehe das Beispiel unten).
Syntax
<npspm includePortlet="urlPath" instance="instanceId" language="lang" withBorder="borderFlag" />
Wenn das einzufügende Portlet in der gleichen Web-Applikation liegt wie
der Portal Manager, ist urlPath der Name des Portlets oder der
Alias-Pfad, der als portletPathMapping in der Datei
pm.xml angegeben wurde. Dieser Name darf nicht / sein. Liegt das
Portlet dagegen in einer anderen Web-Applikation, ist urlPath
der URL-Pfad des Portlets, bezogen auf das Web-Applikationen-Verzeichnis
(normalerweise webapps).
Mit dem Attribut instanceId kann ein Instanzenbezeichner
angegeben werden, um mehrere gleiche Portlets auf einer Website verwenden zu
können. Der Bezeichner kann aus beliebigen Zeichen bestehen.
Die Sprache, in der ein Portlet sich anzeigt, entspricht normalerweise der
Sprache, die der Benutzer im Browser eingestellt hat. Mit dem Parameter
language kann diese Voreinstellung übergangen werden.
Der Wert von language, lang, ist ein
Kürzel wie de oder en, das für eine der vom Portlet
unterstützten Sprachen steht. Diese Sprachen sind in der Datei
portlet.xml definiert, die sich im
WEB-INF-Verzeichnis der Portlet-Web-Applikation befindet.
withBorder legt mit den Werten true und
false für borderFlag fest, ob das Portlet
mit einem Rahmen, Titelzeile und Buttons in der Titelzeile ausgegeben werden
soll.
Beispiel
<npspm includePortlet="/myportlets/ranking" instance="@visiblePath" withBorder="false" />