Richtlinien für das Einreichen von Plugins im Store

26.03.2014 12:30
avatar  Christian
#1
avatar
Techniker

Diese gelten für alle neu eingereichten Plugins.
Wir behalten uns vor, die Liste gegebenenfalls zu erweitern oder anzupassen.


§1 Logo

Das Logobild muss einer Auflösung von 128 Pixel in der Höhe und 128 Pixel in der Breite entsprechen und darf nicht animiert sein.
Die Grafik darf nicht verzerrt oder verpixelt (aufgrund zu niedriger Auflösung) dargestellt werden.
Weiterhin ist das Verwenden geschützter Logos bzw. Marken nicht gestattet.
Auch dürfen die Logobilder nicht gegen geltendes Recht verstoßen oder die Rechte Dritter verletzen.

§2 Beschreibung

Jeder Entwickler ist dazu verpflichtet, alle Funktionen seines Plugins ausführlich in dem dafür vorgesehenen Feld genau zu beschreiben.
Nicht dokumentierte Funktionalitäten können zu einer Ablehnung des Plugins führen.

§2.1 Funktionalität der beschriebenen Funktionen
Alle dokumentierten Funktionen müssen vollständig funktionieren.

§2.2 Update
Im Falle eines Updates ist der Entwickler verpflichtet, alle Änderungen und Neuerungen in der Beschreibung unter Angabe der neuen Versionsnummer genau zu dokumentieren.
Nicht dokumentierte Funktionalitäten können zu einer Ablehnung des Plugins führen.

§3 Programmierrichtlinien

§3.1 DOM-Manipulation
Der Entwickler hat darauf zu achten, ausschließlich DOM-sichere Funktionen zu verwenden, falls er den DOM des Nutzers mit einem Plugin manipulieren möchte.
Andernfalls kann dies zu einer Ablehnung des Plugins führen.
Hierzu zählen z.B. „document.write“ oder $(html, body).html = ‚mein Text‘;

Xobor wird jedes eingereichte Plugin hinsichtlich solcher Passagen analysieren.
Für eine schnelle und einfache Manipulation des DOMs steht dem Entwickler standardmäßig JQuery zur Verfügung.

§3.2.1 Einbinden fremder Script-Ressourcen
Das Einbinden externer Libraries ist ausschließlich von anerkannten Quellen gestattet (z.B. Google Hosted Libraries).
Die Verlinkung eines privaten oder unbekannten „Webspaces“ wird nicht akzeptiert.
Alternativ kann der Entwickler eine Library auch direkt in sein Plugin integrieren, indem er dafür eine JS-Datei in seinem Plugin anlegt und diese mit einem relativen Link verlinkt.

§3.2.2
Der Entwickler muss sicherstellen, das externe Libraries keinen Einfluss bzw. Störungen von Standardfunktionen der Xobor-Software verursachen.

§3.3 Ajax
Plugins dürfen keine Benutzer- oder Forumsbezogenen Informationen an externe Server senden.

§3.4 Cookies
Cookies dienen lediglich der Speicherung von Zuständen.
Für größere Datenmengen sind diese (aufgrund von browserseitigen Limitierungen) nicht geeignet.
Jedes Plugin darf maximal 1 Cookie mit maximal 128 Zeichen verwenden.

§3.5. Variablen

§3.5.1 Globale-Variablen
Globale-Variablen stehen mit jedem Seitenaufruf auf jeder Seite des Forums zur Verfügung.
Je nach Anzahl solcher Variablen, ist es relativ aufwendig, diese mit jedem Seitenaufruf zu laden.
Von daher sollten Globale-Variablen nur dann verwendet werden, wenn man diese auch auf jeder Seite des Forums benötigt.
Ansonsten sollte eine Data-Var immer einer Global-Var vorgezogen werden, sofern dies möglich ist.

§3.5.2 Config-Variablen
Konfigurationsvariablen (Config-Vars) verhalten sich in der Regel genau wie Globale-Variablen.
Mit der Ausnahme, dass diese nur vom Administrator aus der Administration heraus verändert werden können und keine Zugriffsrechte besitzen.
Hierfür gelten die gleichen Richtwerte wie für Globale-Variablen.

§3.5.3 Data-Variablen
Im Regelfall werden Data-Variablen zu dem zugehörigen Element als Template- und JavaScript-Variable automatisch mit ausgegeben.
Es besteht allerdings auch die Möglichkeit, mittels API-Zugriff eine Data-Variable dynamisch von jeder x-beliebigen Forenseite aus aufzurufen oder zu beschreiben.
Diese Art von Zugriff darf nur über die von Xobor zur Verfügung gestellten Methoden aus der Plugin-API erfolgen und sollte sparsam eingesetzt werden.

§3.6 Ressourcenverbrauch
Scripte dürfen den Seitenaufbau nicht signifikant verlangsamen oder stören.
Animationen mittels JavaScript können je nach Anwendung relativ hohe Lasten auf den PCs der Besucher verursachen und somit das Surfverhalten negativ beeinträchtigen. Aus diesem Grund sollten derartige Scripte nur gezielt und sparsam eingesetzt werden.

Die Xobor-API bietet eine Vielzahl von Funktionen, um Daten aus bzw. im Forum zu verarbeiten.
Jeder Zugriff benötigt Ressourcen und sollte daher gut durchdacht sein.

Plugins die durch eine massive Abfrage von Variablen mit jedem Seitenaufruf unverhältnismäßig viele Ressourcen verbrauchen, können nicht im Store veröffentlicht werden (z.B. Programmierung eines Chats unter der Verwendung von Data- /Globalen-Variablen).

Plugins mit folgenden Inhalten erhalten generell keine Freigabe:
  • Plugins die den Seitenaufbau bzw. den Besuch eines Forums erschweren oder behindern.
  • Plugins ohne erkenntliche Funktion
  • Plugins ohne ersichtlichen Mehrwert (z.B. simples darstellen einer anderen Webseite in einem iframe)
  • Plugins die das Xobor-Label in Foren entfernen oder manipulieren, welche keinen White-Label-Tarif gebucht haben
  • Plugins die von Xobor definierte Limits umgehen bzw. aushebeln
  • Plugins die Werbeeinblendungen von Xobor in nicht werbefreien Foren entfernen oder manipulieren
  • Plugins, welche Xobor-Premiumfeatures nachahmen oder ermöglichen, ohne einen entsprechenden Tarif gebucht zu haben
  • Plugins deren Inhalte gegen geltendes Recht verstoßen oder die Rechte Dritter verletzt


 Antworten

 Beitrag melden
Bereits Mitglied?
Jetzt anmelden!
Mitglied werden?
Jetzt registrieren!