In diesem Artikel ist beschrieben, wie mit LoxBerry::Web die Webseite mit dem LoxBerry-Template aufgebaut wird. Neue Plugins in Perl sollten diese Methode verwenden.

Die Funktionen head, pagestart, pageend und foot übermitteln an den Webbrowser das Standard-Design für LoxBerry. Dazwischen muss die eigene Webseite, beispielsweise mittels eigenem Template oder mit print übertragen werden.

Die Funktion lbheader ist eine Kurzversion von head und pagestart. Die Funktion lbfooter ist eine Kurzversion von pageend und foot.

Die Funktion head erwartet als Parameter den Seitentitel.

Die Funktion pagestart erwartet als Parameter den Seitentitel, einen vollständigen Link zu einer Hilfeseite (z.B. ins Wiki) sowie einen Dateinamen eines Hilfe-Templates. 

Die Funktion pageend und foot erwarten keine Parameter.

Die Funktion lbheader erwartet als Parameter den Seitentitel, einen vollständigen Link zu einer Hilfeseite sowie einen Dateinamen eines Hilfe-Templates.

Ist im Programm eine globale Variable $template_title gesetzt, kann dieser Parameter mit undef an head, pagestart und lbheader übergeben werden. Es wird dann die globale Variable verwendet.

Statt $helptemplate kann auch ein Text übergeben werden. Bitte jedoch berücksichtigen, dass dieser Text sprachspezifisch sein muss.

Mit der Funktion head bzw. lbheader kann eine Navigation Bar unterhalb des Headers erzeugt werden. Siehe Navigarion Bar.

Alle Funktionen sind multilingual und geben die Templates in der Systemsprache des Benutzers aus.

use LoxBerry::Web;
my $plugintitle = "Mein Plugin";
my $helplink = "http://www.loxwiki.eu:80/x/2wzL";
my $helptemplate = "help.html";
 
LoxBerry::Web::lbheader($plugintitle, $helplink, $helptemplate);
 
# Hier die eigenen Ausgaben erzeugen
 
LoxBerry::Web::lbfooter();

Dies gibt einen Header und einen Footer mit deinem Titel, sowie der Hilfe und dem Hilfelink aus.

Unten findest du, wie sich die drei Parameter zusammenstellen.

use LoxBerry::Web;
my $plugintitle = "Mein Plugin";
my $helplink = "nopanels";
 
LoxBerry::Web::lbheader($plugintitle, $helplink, undef);
 
# Hier die eigenen Ausgaben erzeugen

Mittels $helplink = "nopanels"; wird der Header nur mit deinem Titel ausgegeben. Die Seiten-Panels (linkes Menü und rechtes Hilfepanel) werden nicht gerendert. Dies kann z. B. verwendet werden, wenn eine Art Pop-Up-Fenster generiert werden soll.

Diese Funktion ist erst ab LoxBerry V1.2.4 verfügbar. Setze LB_MINIMUM entsprechend in Deiner plugin.cfg, falls Du diese Funktion nutzt!

Der erste Parameter wird als Titel der Seite oben in der Mitte angezeigt. Der Titel enthält in der Regel den Plugin-Namen. Soll kein Titel angegeben sein, dann undef übergeben.

Existiert im Programm eine globale Variable our $template_title und der erste Parameter ist undef, wird diese globale Variable verwendet.

Der Link wird in der Schnellhilfe (rechts) angezeigt und führt bei den meisten Plugins auf die Hilfe-Webseite im LoxBerry-Wiki. 

Existiert im Programm eine globale Variable our $helplink und der zweite Parameter ist undef, wird diese globale Variable verwendet.

Wird $helplink auf "nopanels" gesetzt, wird eine Seite ohne das linke Menü und ohne die rechte Schnellhilfe gerendert (erst ab V1.2.4 verfügbar).

Die Hilfe kann im Templatesystem entweder mittels Template und Sprachfiles, oder fertigen HTMLs pro Sprache verwendet werden.

Außerdem kann $helptemplate ein String sein, der in der Hilfe ausgegeben wird.

Angabe eines Dateinamens: Dieser muss ohne Pfad angegeben sein, beispielsweise "pluginhelp.html".

Suchreihenfolge:

1. /templates/help/pluginhelp.html → multilinguales Template, das Template-Variablen (<TMPL_VAR HELP.MYTEXT>) enthält. Die Sprache wird im Verzeichnis templates/lang/pluginhelp_en.ini (bzw. je nach Sprache) gesucht. 
2. /templates/<lang>/pluginhelp.html → Hilfe als HTML. Das Hilfefile wird im Verzeichnis der Systemsprache (en, de, usw.) gesucht.
3. /templates/en/pluginhelp.html → Die englische Hilfe wird abgerufen.
4. /templates/de/pluginhelp.html → Die deutsche Hilfe wird abgerufen.

Wird in diesem Parameter ein String übergeben, wird dieser String ausgegeben. 

Wird dieser Parameter komplett weggelassen, wird ein Standardtext angezeigt.

Die Ordner sind ausgehend vom template-Verzeichnis. Beim Parameter für das Help-Template wird kein Ordner mit übergeben!

LoxBerry::Web::lbheader("Title", $url, "pluginhelp.html");

LoxBerry::Web::lbheader("Title", $url, "pluginhelp.html");