Da es einige Unklarheiten darüber gibt, wie man erfolgreich einen Stil in den WoltLab Plugin-Store einstellt bzw. in einer Form, die freigeschalten wird, gibt es hiermit eine Checkliste, die man abarbeiten kann. Sollte dabei alles positiv geprüft sein, kann einer Freischaltung defacto nichts mehr im Wege stehen.
- Paket muss installierbar sein
Es gibt eine automatische Export-Funktion für Stile, die selbigen direkt als Paket exportiert. Diese Version sollte auf jeden Fall installierbar sein und sollte daher für Anfänger genutzt werden. Dennoch ist ein unabhängiger Test sinnvoll. Beim Upload prüft außerdem das System des Plugin-Stores das Paket automatisch nach offensichtlichen Fehlern. Sollten hier welche auftauchen, erhält man spätestens 5 Minuten nach dem Upload eine entsprechende Benachrichtigung.
- Ausschließungs-Anweisungen setzen
Im Normalfall sind Designs, spätestens bei Änderungen in Templates, nicht mit dem nächstgrößeren Release von Community Framework kompatibel. Aus diesem Grunde ist es Pflicht, entsprechende Anweisungen in diepackage.xml
einzutragen. Ein Stil für Community Framework 2.1 benötigt daher eine Ausschließung von Community Framework 2.2. Dies sähe folgendermaßen aus: - Update-Anweisungen setzen
Aktualisiert man einen bestehenden Stil, muss selbiger auch aktualisiert werden. Dafür benötigt man eine Update-Anweisung in derpackage.xml
, welche beispielsweise folgendermaßen aussehen kann:
- Nur notwendige Inhalte exportieren
Gibt man einen Bilder-Ordner an, welcher jedoch leer ist, erhält man später ein leeres Archiv in seinem Stil. Dasselbe gilt für Templates. Daher sollte man hier nur etwas angeben, wenn auch wirklich Inhalte mitgeliefert werden.
- Genutzte Bilder auch wirklich mitliefern
Im Umkehrschluss zum vorherigen Punkt müssen Grafiken, wenn welchem im Quellcode angegeben werden, auch mitgeliefert werden. Nicht vorhandene, aber benötigte, Bilder resultieren in einer unnötigen zusätzlichen Anfrage an den Server und lassen die Logs unter gewissen Konfigurationen erheblich an Größe gewinnen.
- Keine übergroßen Bilder nutzen
Bilder von über 300 KiB sind oftmals nicht sinnvoll. Man sollte sich daher überlegen, wie man eventuell andere Grafiken nutzen oder selbige komprimieren kann. Für.jpg
-Dateien empfielt sich z. B. die Funktion „Für das Web speichern“ in Photoshop mit einer Kompression von 60%. Wallpaper sind außerdem nicht als.png
zu speichern.
- Valider Code
Sowohl Templates als auch CSS-Code müssen valide sein. Nachprüfen kann man das selbst hiermit:
Beim CSS-Validator gilt der Vergleich mit dem Blue Temptation Stil von WoltLab, da das Grund-Design bereits einige invalide Inhalte besitzt.
- Template-Bearbeitung nur wenn notwendig
Templates sollte nur dann bearbeitet werden, wenn es absolut notwendig ist. Eine Lösung per CSS ist im Normalfall wesentlich eleganter und auch einfacher und weniger umfangreich in der Wartung. Außerdem passieren hier im Normalfall weniger Fehler.
- Kein normaler Text in Templates
In Templates wird einzig und allein mit Sprachvariablen gearbeitet. Da auch Stile ganz normale Pakete sind, kann man Sprachvariablen hierbei ebenfalls einfach mit installieren.
- Offensichtliche Design-Fehler vermeiden
Nicht lesbare Texte, das Entfernen von visuellen Rückmeldungen wie z. B. das Ändern der Hintergrundfarbe von markierten Inhalten sind offensichtliche Design-Fehler und zu vermeiden. Ist zudem die Schrift heller als der Hintergrund, muss ein eventuell eingesetzter Text-Schatten dunkler sein als der Hintergrund. Analog dazu muss er bei dunklerer Schrift heller sein als der Hintergrund.
- Lizenzen beachten
Besonders bei genutzten Bildern, aber auch bei Design-Bereichen selbst ist stets die Lizenz bzw. das Urheberrecht des jeweiligen Werkes zu beachten.
1.023 mal gelesen