WoltLab Plugin-Store

Infos für Pluginstore-Kunden

1) Was sind Plugins?

"Plugins" sind Erweiterungen für Ihre Burning Board Forensoftware. Sie erweitern entweder die Software um Funktionen, welche diese nicht von Haus aus mitbringt, oder verändern deren Funktionen. Plugins liegen in Form eines TAR-Archives vor, in welchem unterschiedliche Dateien und Unterordner, sowie Grafiken, je nach Plugin unterschiedlich enthalten sein können.

Burning Board enthält bereits eine Menge an praktischen Funktionen, da es aber den Entwicklern nicht möglich ist, eine Software zu entwickeln, welche die Wünsche aller Kunden berücksichtigt, und da jeder andere Vorstellungen vom notwendigen Funktionsumfang einer Forensoftware hat, sind Plugins die ideale Möglichkeit, ein Forum so anzupassen, dass es den eigenen Vorstellungen vom perfekten Forum nahe kommt.

Der Funktionsumfang eines Plugins kann ganz rudimentär sein und etwa einen zusätzlichen Button in Beiträgen einfügen, oder ein unbenötigtes Element entfernen, oder sehr umfangreich sein und ganz neue Funktionen und Module in die Software einfügen, wie etwa eine Galerie oder ein Portal. Dies ist lediglich der Phantasie des Plugin-Erstellers überlassen.

2) Womit sind Plugins kompatibel?

Auf der Vorstellungsseite jedes Plugins finden Sie in der Beschreibung Angaben zu der Kompatibilität des Plugins. Ein Plugin kann in allen Produkten und Versionen von Produkten lauffähig sein, oder nur auf ein bestimmtes Produkt oder eine bestimmte Version zugeschnitten sein. Werden mehrere Produkte und Produktversionen unterstützt, so finden sich in der Pluginbeschreibung mehrere Produktnamen oder -versionen als Aufzählung.

Installieren Sie niemals Plugins in eine nicht-kompatible Software, dies kann zu unvorhersehbaren Problemen führen!

3) Wie installiere ich ein Plugin?

Die Plugin-Installation ist in Burning Board 3 so einfach wie in keiner anderen Forensoftware! Sie verlangt vom Benutzer keinerlei Veränderungen am Quellcode oder anderen Dateien im Dateisystem.

Wir empfehlen sogar ausdrücklich, niemals an Dateien des Dateisystems Änderungen vorzunehmen, da dies nicht nachvollziehbare Zustände in Ihrer Installation auslösen kann, welche die Lösung von Problemen erschweren oder sogar unmöglich machen kann. Solche Änderungen auf Dateiebene sollte - wenn überhaupt notwendig - ausschließlich ein Entwickler vornehmen, der genau weiß, was er tut.

Ein Plugin lässt sich auf zweierlei Weisen installieren. Manuell durch Herunterladen des Installationspaketes, oder automatisch über die foreneigene Paketinstallation mittels Paketserver (nur bei freien Plugins). Im Folgenden werden die beiden Installationsarten kurz erklärt:

• Manuelle Installation

  1. Laden Sie das Plugin, welches Sie installieren möchten auf ihren Computer herunter
  2. Rufen Sie die Administrationsoberfläche ihres Forums auf und melden Sie sich an
  3. Rufen Sie die Paketinstallation auf (System -> Paketverwaltung -> Paket installieren)
  4. Klicken Sie auf die Dateiauswahl und wählen Sie das Paket, welches Sie zuvor heruntergeladen haben, und klicken Sie auf "Hochladen"
  5. Nun erscheint eine Seite, welche Ihnen Informationen zu dem Plugin liefert
  6. Klicken Sie auf "Weiter", um die Installation zu starten
  7. Die Installation läuft nun
  8. Möglicherweise müssen Sie währenddessen weitere Angaben machen
  9. Ist die Installation beendet, klicken Sie auf "Weiter"
  10. Fertig! Sie befinden sich nun wieder auf der Seite, wo Sie ein weiteres Plugin installieren können.

• Automatische Installation

  1. Administrationsoberfläche aufrufen
  2. Paket suchen (System -> Paketverwaltung -> Pakete suchen)
  3. Paketname in das Suchfeld eingeben
  4. "Paket installieren" anhaken
  5. Klicken Sie auf "Absenden", um die Installation zu starten
  6. Die Installation läuft nun
  7. Möglicherweise müssen Sie währenddessen weitere Angaben machen
  8. Ist die Installation beendet, klicken Sie auf "Weiter"
  9. Fertig!

4) Wie deinstalliere ich ein Plugin?

Die Plugin-Deinstallation ist denkbar einfach! Auch hier muss der Benutzer keinerlei Veränderungen am Quellcode oder anderen Dateien im Dateisystem vornehmen.

Löschen Sie niemals manuell Dateien im Dateisystem! Solche Änderungen auf Dateiebene sind für eine Deinstallation normalerweise nicht nötig und sollten - wenn tatsächlich notwendig - ausschließlich von einem Entwickler vorgenommen werden, der genau weiß, was er tut.

Sollte die Deinstallation eines Plugins einmal wider Erwarten nicht funktionieren, wenden Sie sich bitte an den Pluginhersteller.

• Deinstallation

  1. Administrationsoberfläche aufrufen
  2. Paketverwaltung aufrufen (System -> Paketverwaltung -> Pakete auflisten)
  3. Gewünschtes Paket suchen und auf das rote "X" klicken
  4. Bestätigen Sie den erscheindenden Dialog mit "OK"
  5. Die Deinstallation läuft nun
  6. Fertig!

5) Informationen zu Plugin-Lizenzen

Eine Lizenz stellt ein Regelwerk dar, welches der Kunde akzeptieren muss, um das Plugin nutzen zu dürfen und welches er einhalten muss. Verstöße dagegen können rechtliche Folgen haben und sollte daher vermieden werden. Lesen Sie sich die Lizenzbestimmungen daher aufmerksam durch und entscheiden Sie selbst, ob Sie mit ihnen einverstanden sind!

Entwickler haben die Möglichkeit, ihre Plugins unter einer bestimmten Lizenz zu veröffentlichen. Beliebt sind hier etwa die GPL oder LGPL-Lizenz, aber auch Creative Commons oder ähnliche. Die Lizenzangaben im Pluginstore sind im Regelfall verlinkt, das heißt, sie enthalten einen Verweis zu der Seite, wo die Bestimmungen der jeweiligen Lizenz genau erklärt sind. Beachten Sie hierbei, dass je nach Lizenztyp möglicherweise nur Erklärungen in englischer Sprache verfügbar sind.

6) Hilfe bei Problemen mit Plugins

Wenn Sie Probleme mit einem Plugin haben, welches Sie von unserem Pluginstore bezogen haben, so ist der erste Schritt, die Vorstellungsseite des Plugins hier im Plugin-Store aufzurufen. Dort finden Sie in der Beschreibung in der Regel einen Verweis auf die Website des Entwicklers des Plugins. Normalerweise wird Ihnen dort bei Problemen mit einem Plugin geholfen.

Es ist möglich, dass manche Entwickler keinerlei Support für Ihre Plugins anbieten. Überlegen Sie gut, ob Sie ein Plugin installieren wollen, zu welchem Sie keinerlei Support erhalten!

7) Informationen zu Spenden

Bei freien Plugins hat der Plugin-Autor die Möglichkeit, anzugeben, dass er für seine Entwicklungsarbeit gerne Geld gespendet haben würde, um seine Entwicklungskosten abdecken zu können. Viele Entwickler geben ihre Plugins trotz aufwändiger Entwicklungsarbeit frei an die Community weiter, daher ist es für sie oft schwer, die Kosten für den eigenen Server und Entwicklungssoftware aufzubringen. Wenn Sie dem Autor eine Spende zukommen lassen, erleichtern Sie ihm nicht nur die weitere Arbeit am Plugin auch in der Zukunft, sondern sichern möglicherweise auch die weitere Verfügbarkeit dessen für die gesamte Community.

Sie können spenden, indem Sie den entsprechenden Button klicken. Darauf öffnet sich ein eigenes blaues Feld, in dem Sie einen Spendenbetrag eingeben können. Im Normalfall wird der Entwickler dort bereits einen Standardbetrag vorschlagen, den Sie aber gerne auch abändern können, wenn Sie weniger oder mehr spenden wollen.

Mit dem Absenden des Spendenformulars werden Sie zur Website von PayPal weitergeleitet, wo Sie die Spende erst auslösen müssen. Das Absenden unseres Formulars löst noch keine Finanztransaktion aus!

8) Was sind Versionen?

Wenn der Plugin-Autor ein Plugin zum ersten Mal hochlädt, legt er damit die erste Version seines Plugins an. Entwickelt der Autor sein Plugin weiter oder behebt er eventuell aufgetretene Fehler, dann hat er eine neue Version entwickelt. Er kann diese neue Version dann in das bereits bestehende Plugin-Projekt hochladen und zusätzliche Versionshinweise beifügen, in welchen er erklärt, was sich in der Version geändert hat.

Das Pluginstore-System listet alle Versionen übersichtlich auf und bietet zusätzlich die Möglichkeit an, diese alten Versionen für spezielle Verwendungszwecke herunterladen zu können. In der Regel sollten Sie Ihre Plugins aber immer aktuell halten und die aktuellste Version installiert haben.

9) Was sind Rezensionen?

Rezensionen sind Beschreibungen oder Beurteilungen sowie Bewertungen von Kunden, die das angezeigte Plugin benutzen und anderen Benutzern mitteilen möchten, was sie über das Plugin denken. Gleichzeitig bestimmen die Benutzer in einer Rezension auch die Bewertung mit dem bekannten 5 Sterne-System.

Hinweis: Rezensionen und Bewertungen sind aneinander gekoppelt, um Missbrauch zu vermeiden. Ein Benutzer kann daher immer nur eine Rezension verfassen und somit auch nur einmal eine Bewertung abgeben.

Sie können eine Rezension schreiben, indem Sie einfach den Button Rezension schreiben anklicken. Sie können Ihre Rezension und Bewertung später nicht mehr löschen, sondern lediglich ändern.

10) Wie entwickle ich eigene Plugins?

Die Entwicklung eigener Plugins ist zwar recht einfach, erfordert allerdings ein gewisses Grundwissen in (objektorientierter) PHP-Entwicklung und anderen Webtechniken. Wenn Sie über solche Kenntnisse verfügen, können Sie jederzeit loslegen! Klicken Sie auf den untenstehenden Link oder auf dieser Seite ganz oben auf den Tab "Entwickler".

Support für Ihre ersten Schritte in der Plugin-Entwicklung bietet Ihnen auch der spezielle Forenbereich für den Pluginstore und Entwickler darin. Die Community in unserem Supportforum kann Ihnen bei Problemen oft weiterhelfen.

Infos für Entwickler

1) Wie entwickle ich ein Plugin?

Sie haben in Burning Board eine Stelle gefunden, an der Sie eine bestimmte Funktion benötigen, wollen eine bestehende Funktion verändern oder ganz neue Funktionen in WoltLab-Software hinzufügen? Dann ist das meist eine gute Gelegenheit, ein Plugin daraus zu entwickeln. Mit Plugins erweitern Sie unsere Software ganz leicht um individuelle Funktionen, die nicht im Standardumfang enthalten sind. Der Vorteil von Plugins liegt auf der Hand: Leicht in- und deinstallierbar (keine Fummelei im Quellcode), leicht updatebar und mit anderen Benutzern teilbar oder verkaufbar.

"Plugins" sind Pakete für unser Paketverwaltungssystem und liegen in Form eines TAR-Archives vor, in welchem unterschiedliche Dateien und Unterordner, sowie Grafiken, je nach Plugin unterschiedlich enthalten sein können. Damit Plugins installierbar sind, muss das Paket einen bestimmten Aufbau besitzen und bestimmte Dateien enthalten, andere können optional beiliegen.

Das Erstellen von Plugins ist natürlich in erster Linie Programmierarbeit. Sie sollten allerdings kein Anfänger in Web-Programmierung sein, da unsere Vorgaben für Plugins eine gewisse Qualität voraussetzen. Wir orientieren uns an geltenden Standards und legen den Entwicklern auch die Einhaltung jener nahe. Prinzipiell sind Kenntnisse verschiedener Web-Scriptsprachen, objektorientierter Programmierung, Datenbanken sowie Paketverwaltungssystemen vorteilhaft.

Allgemein sind für die Entwicklung von Plugins Kenntnisse in der Anwendung von PHP, OOP, MySQL, XML, XHTML und CSS notwendig. Verschiedene Beispiele und Anleitungen für den konkreten Aufbau von Plugins bietet unter anderem die technische Dokumention.

Für die Plugin-Enwicklung kann je nach Projekt auch spezielle Software nötig sein, wie beispielsweise ein Codeeditor mit Syntaxeinfärbung und Codevervollständigung, Versionskontroll-, Bildbearbeitungs- und Kompressionssoftware für die Erstellung eines TAR-Archivs und selbstverständlich die Software von WoltLab. Gewöhnen Sie sich eine klare, geordnete und strukturierte Arbeitsweise an, sichern Sie regelmäßig Arbeitszustände und erstellen Sie Versionen, um bei Bedarf auf alte Zustände zurückgreifen zu können. Bringen Sie ausreichend Geduld mit! Zuletzt das Wichtigste: Testen Sie Ihr Plugin ausgiebig unter verschiedenen Umständen!

2) Vorgaben für Plugins

Gestalten Sie die Oberflächen Ihres Plugins optisch ansprechend! Halten Sie sich dabei immer so weit wie möglich an die vorhandenen Interfaceelemente. Dies kommt den Kunden zu Gute, die so ein einheitliches Bedienerlebnis haben.

In den Pluginstore hochgeladene Plugins werden von uns vor ihrer Freischaltung grob auf Fehler überprüft. Es erfolgt sowohl eine automatische Prüfung (Suche nach Syntax-Fehlern in PHP- und XML-Dateien; Suche nach fehlenden Dateien), als auch eine manuelle Kontrolle (Suche nach schweren Fehlern, insbesondere Sicherheitslücken wie SQL-Injections oder XSS-Lücken; schwere Verstöße gegen geltende Standards).

Hier eine Übersicht von wichtigen Punkten zur Beachtung:

• Korrekte Bezeichnung
• Korrekte Codesysntax
• XHTML 1.1 Standards einhalten
• CSS Standards einhalten
• Abhängigkeiten beachten
• SQL-Abfragen gering halten
• Auf Sicherheitslücken achten
• Alle benötigten Dateien dem Paket beilegen
• Keine versteckten Dateien im Paket
• Lizenzen von mitgelieferten Dateien beachten
• Barrierefreiheit beachten
• Klare optische Aufbereitung
• Anlehnung an WoltLab-Designvorgaben
• Lässt sich das Paket installieren?
• Funktioniert alles so wie geplant?
• Testen, testen, testen!

3) Wo finde ich Dokumentationen?

Auf der WoltLab Website finden Sie im Bereich Support unsere Dokumentationen und hilfreichen Dokumente. In unserem WoltLab Supportforum besteht ein eigener Bereich für den Pluginstore und Entwickler. Außerdem finden Sie in der WoltLab Community ein Entwicklerforum und einen "Wie-mache-ich-was?"-Bereich. Im Laufe der Zeit werden weitere Dokumente hinzukommen.

• WoltLab Dokumentationsseite aufrufen
• Supportbereich für Entwickler im WoltLab Supportforum aufrufen

4) Das Plugin-Icon

Das Plugin-Icon sollte die Ausmaße von 24x24 Pixeln aufweisen und im Idealfall als PNG-Grafik vorliegen.

Wenn Sie eine eigene Grafik erzeugen wollen, haben Sie die Möglichkeit, unsere Iconvorlage zu benutzen (erfordert Adobe Photoshop) und ihr Motiv zwischen die vorgegebenen gesperrten Ebenen zu legen. Speichern Sie die Grafik dann als PNG-Grafik, um die Transparenz zu erhalten. Alternativ können Sie natürlich auch ein eigenes Icon ohne unsere Vorlage gestalten. Dazu ein Tipp: Sie sollten die Grafik, wie unsere Vorlagen, mit abgerundeten Ecken gestalten, damit die Benutzer ein einheitliches Erlebnis beim Betrachten haben und Plugins sofort als Plugin erkennen können.

Sollten Sie im Umgang mit Grafiken nicht sicher sein, oder kein geeignetes Grafikprogramm besitzen, müssen Sie ihr Plugin nicht mit einem Icon versehen. Das System erkennt beim Upload, dass sie keine Grafik angegeben haben und versieht Ihr Plugin dann mit dem Plugin-Standardicon.

• Anleitung anzeigen (PDF-Dokument, 180kB)
• Icon-Template herunterladen (ZIP-Archiv, 750kB)

5) Die Plugin-Beschreibung

Plugins sollten so einfach wie möglich und dennoch ausreichend beschrieben werden. Eine zu detailreiche und umfangreiche Beschreibung macht es dem Benutzer schwer, zu finden was er sucht und kann mehr Verwirrung stiften als Klarheit.

Das Eingabefeld für die Beschreibung weist keinen WYSIWYG-Editor auf, weil die Beschreibung nicht zu sehr gestaltet werden sollte. Wenn Sie dennoch Formatierungen benötigen, können Sie manuell einige BBCodes die auch im Forum möglich sind, verwenden. Die folgenden BBCodes werden unterstützt: [b], [i], [u], [s], [size=x], [color=#xxx], [list] & [*].

Setzen Sie Formatierungen sparsam ein, benutzen Sie keine sehr großen Schriftgrößen und färben Sie Texte nicht komplett ein! Eine gute Beschreibung kommt in der Regel ohne Formatierungen aus. Wollen Sie Ihr Plugin genauer und mit wesentlich aufwändigerer Formatierung beschreiben, sollten Sie dies auf Ihrer eigenen Website tun.

Plugin-Beschreibungen müssen in Deutsch und Englisch angelegt werden. Bedenken Sie, dass Ihre Plugins von einer wachsenden Zahl internationaler Benutzer verwendet werden, was den Bekanntheitsgrad Ihrer Plugins steigert. International kann aber nur in Englisch kommuniziert werden und fremdsprachige Besucher des Pluginstores sind nur dann in der Lage Ihr Plugin zu finden und herunterzuladen, wenn die Beschreibung auch in Englisch zur Verfügung steht. Wenn Sie selbst nicht Englisch können, oder sich eine komplexe Beschreibung nicht zutrauen, benutzen Sie bitte Google Translate, die Ergebnisse sind teilweise sehr gut und oft völlig ausreichend. Eine schlechte englische Beschreibung ist besser als gar keine. Wenn Sie jemanden in Ihrem Umfeld kennen, der Englisch beherrscht, könnten Sie diesen auch fragen, ob er Ihren Text übersetzen, oder den Text aus Google Translate korrigieren könnte.

6) Plugin-Titelbild und Screenshots

Beim Hochladen eines Plugins besteht die Möglichkeit, Screenshots oder andere Bilder mit hochzuladen. Sie können bis zu 10 Grafiken hochladen.

Hinweis: Die erste Grafik in der Liste der Screenshots wird vom System automatisch als Titelbild für die Beschreibungsseite des Plugins verwendet.

Möchten Sie ein anderes Bild als Titelbild verwenden, dann sollten Sie die Bilder in der korrekten Reihenfolge hochladen. Haben Sie die Bilder versehentlich in der falschen Reihenfolge hochgeladen, können Sie das Pluginprojekt bearbeiten und die Screenshots durch Verschieben in die richtige Reihenfolge bringen, sodass ein aussagekräftiges Titelbild angezeigt wird.

7) Versionen und deren Verwaltung

Wenn Sie Ihr Plugin weiterentwickelt haben, dann haben Sie eine neue Version und können diese auch als solche in Ihr Pluginprojekt hochladen, damit Kunden diese Version auch herunterladen können. Ältere Plugin-Versionen werden auf einer eigenen Versionsseite aufgelistet und können nach wie vor heruntergeladen werden. Alle Versionen werden mit Datum und Versionsnummer versehen, um sie von aktuellen Versionen unterscheiden zu können.

Sie können zu jeder Version einen Versionshinweis verfassen, um den Benutzern zu erläutern, was sich in der aktuellen Version verändert hat. Hier gelten dieselben Hinweise wie für Plugin-Beschreibungen, weniger ist meist mehr. Die beste Darstellungsart für Versionshinweise ist eine Liste, die Zeile für Zeile die einzelnen Änderungen auflistet.

8) Informationen zu Plugin-Lizenzen

Eine Lizenz stellt ein Regelwerk dar, welches der Kunde akzeptieren muss, um das Plugin nutzen zu dürfen und welches er einhalten muss. Verstöße dagegen können rechtliche Folgen haben. Wählen Sie daher die Lizenz, unter der Sie Ihr Plugin veröffentlichen wollen sorgfältig!

Der Pluginstore bietet eine Reihe an vordefinierten Lizenzen in einem Dropdown-Menü zur Auswahl an. Sie können außerdem Ihre eigene Lizenz angeben und verlinken, sollte die benötigte Lizenz nicht zur Auswahl stehen.