Mit diesem Plugin kann der Entwickler seinem Paket zusätzliche Informationen in mehreren Sprachen hinzufügen.
Das Plugin ist
ausschliesslich für Entwickler gedacht und basiert auf dem
Plugin "Show License" von RouL, dem ich an dieser Stelle dafür ausdrücklich danken möchte.
Aus diesem Grund ist das Plugin auch im Wesentlichen identisch aufgebaut wie das von RouL.
Während der Installation des eigentlichen Plugins werden dann diese zusätzlichen Informationen angezeigt, wobei auch hier der Benutzer (i.d.R der Admin) die Sprache auch selbst wählen kann, sofern die Informationen in verschiedenen Sprachen vorliegen. Eine Bestätigung (im Gegensatz zur Lizenz) ist nicht notwendig, die Installation kann dann fortgesetzt oder abgebrochen werden.
Hat der User keine passende Sprache installiert, wird ein entsprechender Hinweis ausgegeben - die Installation kann jedoch auch in diesem Fall fortgesetzt werden.
Nach der Installation des eigentlichen Plugins findet der User die Informationsseite über Links in der Paket-Liste und/oder direkt auf der Seite der Plugin-Beschreibung (vgl. Screenshots). Damit bietet sich hier dem Entwickler die Möglichkeit, wichtige Informationen für den Anwender
dauerhaft zu hinterlegen, wie z.B. Hinweise zu den Optionen, Support, Versionen u.v.a.m.
Anwendung
Das Paket
de.sctools.pip.showinformation muss in der
package.xml des zu installierenden Plugins im Tag
requiredPackages angegeben werden. Im Block
instructions werden dann für jede Sprache die Pfade zu den Dateien angegeben. Eine Sprache (en) sollte dabei immer als 'default' gekennzeichnet werden (vgl. dazu auch RouL's ShowLicense-Plugin).
Beispiel:
<requiredpackages>
<requiredpackage minversion="1.0.0" file="required/de.sctools.pip.showinformation.tar.gz">de.sctools.pip.showinformation</requiredpackage>
<requiredpackage minversion="1.1.0">com.woltlab.wcf</requiredpackage>
</requiredpackages>
<instructions type="install">
<informationtexts languagecode="en" default="1">info/info-en.txt</informationtexts>
<informationtexts languagecode="de">info/info-de.txt</informationtexts>
<informationtexts languagecode="de-informal">info/info-de-informal.txt</informationtexts>
<files>files.tar</files>
</instructions>
Die Dateien mit den Informationen müssen dann natürlich zusammen mit den anderen notwendigen Dateien ins Paket gepackt werden.
Als Codierung der Textdateien empfehle ich UTF-8 (ANSI funktioniert aber auch). BBCode zur Formatierung und optischen Aufwertung kann verwendet werden, HTML jedoch nicht! Bei den BBCodes ist es ratsam, nur Standard-BBCodes zu verwenden da spezielle BBCodes kaum jeder installiert hat.
Wird eine in der
package.xml angegebene Datei nicht gefunden, erfolgt ein Abbruch der Installation.
Voraussetzungen
WCF v1.1.x
#1
Show plugin information
