Paket vorstellen

Sie können Ihre eigene CitusCMS-Erweiterung (Komponente oder Frontend-Template) einer breiten Nutzerschicht zur Verfügung stellen. Teilen Sie Ihre Erweiterung mit vielen Menschen - stellen Sie die Erweiterung für die Paketquelle vor!

Die Paketquelle ist das zentrale Archiv der CitusCMS-Erweiterungen. Sie können Ihre eigene Erweiterung vorstellen - das bedeutet, Sie schicken Ihre Erweiterung mit den benötigten Informationen (siehe unten) an das CitusCMS-Team. Daraufhin wird die Erweiterung auf seine Funktionsfähigkeit überprüft - dies sorgt für eine gewisse Qualitätssicherung in der Paketquelle.

Wenn Ihre Erweiterung unserem Kriterien entspricht, werden wir diese zügig in die Paketquelle einstellen. Es wird bei den Paketvorstellungen unterschieden in Erstvorstellung und Aktualisierung. Wenn die Erweiterung noch nicht in der Paketquelle vorhanden ist, muss diese zur Erstvorstellung eingereicht werden. Hierbei müssen einige Informationen (siehe unten) angegeben werden, welche als Meta-Informationen zur Erweiterung benötigt werden.

Sollte die Erweiterung schon in der Paketquelle vorhanden sein, ist es sehr unkompliziert möglich, eine neue Paketversion einzureichen. Das Einreichen einer Aktualisierung in die Paketquelle bringt den Vorteil, dass bei allen CitusCMS-Installationen mit Ihrer installierten Erweiterung der Hinweis auf die neue Paketversion erscheint. Und die Aktualisierung auf die neue Paketversion kann der Endnutzer mit wenigen Klicks automatisch ausführen.

Wichtig: Bitte beachten Sie die unten stehenden Hinweise zur Qualitätssicherung, um die Paketvorstellung ohne viele Probleme abzuschließen. Sollten bei der Paketvorstellung aufgrund von nicht beachteten Hinweisen Rückfragen oder Probleme entstehen, wird sich die Paketvorstellung so lange verzögern, bis alle Ungereimtheiten beseitigt sind!

Vorgabe Paketvorstellung (Erstvorstellung)

Folgende Informationen müssen neben der eigentlichen Paket-Datei im Zip-Format (als Anhang) bei einer Paketvorstellung (Erstvorstellung) immer angegeben werden. Die Informationen werden per E-Mail verschickt.

An: Bastian (CitusCMS-Team)
Betreff: Paketvorstellung (Erstvorstellung)
Anhang: Paket-Datei als Zip-Archiv

Paketname: [Systemname des Paketes (Komponente = com_beispiel, Frontend-Template = tpl_beispiel)]
Pakettitel: [verständlicher Name des Paketes z.B. Beispielkomponente]
Pakettyp: [Typ der Erweiterung (Komponente = 1, Frontend-Template = 2)]
Autorenname: [Ihr vollständiger, korrekter Name]
Autorenname Community: [Ihr Benutzername in der CitusCMS-Community]
Paketlizenz: [Lizenz des Paketes]
Paketwebseite: [Ihre Webseite oder Paket-Webseite]
Paketbeschreibung (kurz): [kurze Beschreibung des Paketes (max. 255 Zeichen)]
Paketbeschreibung: [ausführliche Beschreibung des Paketes]
Paketversion: [Version des Paketes (bei 0.0.1 wird begonnen)]
Minimale CitusCMS-Version: [System-Version, die das Paket benötigt (mindestens 0.7.0)]

Vorgabe Paketvorstellung (Aktualisierung)

Folgende Informationen müssen neben der eigentlichen aktualisierten Paket-Datei im Zip-Format (als Anhang) bei einer Paketvorstellung (Aktualisierung) immer angegeben werden. Die Informationen werden per E-Mail verschickt.

An: Bastian (CitusCMS-Team)
Betreff: Paketvorstellung (Aktualisierung)
Anhang: aktualisierte
Paket-Datei als Zip-Archiv 

Paketversion: [neue Version des Paketes (mindestens 0.0.2)]
Minimale CitusCMS-Version: [System-Version, die das Paket benötigt (mindestens 0.7.0)]

Hinweise zur Qualitätssicherung

Diese Hinweise müssen bei der Vorstellung eines Paketes strikt beachtet werden, um Rückfragen mit der Qualitätssicherung auszuschließen. Diese Hinweise müssen wie Vorschriften gesehen werden.

Allgemeine Hinweise

  • Die Erweiterung muss fehlerfrei funktionieren und ausführlich getestet sein, so dass ein produktiver Einsatz möglich ist!
  • Schädliche oder versteckte Funktionen dürfen unter keinen Umständen in der Erweiterung vorhanden sein!
  • Es dürfen keine groben Sicherheitsrisiken in der Erweiterung vorhanden sein! Die Wartung und Absicherung der Erweiterung liegt in der Aufgabe des Erweiterungs-Autors und sollte mit Verantwortung ausgeführt werden!
  • Es sollten auf Grund der Einheitlichkeit und Sicherheit vorhandene Funktionen des Frameworks genutzt werden!
  • Rechte, Copyrights oder Lizenzen Dritter dürfen nicht verletzt werden!

Hinweise zu Meta-Informationen

  1. Der Pakettitel ist ein eindeutiger Name, der die Funktion des Paketes in ein bis zwei Worten beschreibt. Bei einem Frontend-Template sollte ein passender Name gewählt werden, so dass das Paket als Template erkennbar ist.
  2. Die Paketlizenz ist eine selbst wählbare Lizenz, unter der das Paket veröffentlicht wird (vorzugsweise Open-Source).
  3. Die Paketbeschreibung muss einmal in knapper, aussagekräftiger Form vorliegen und einmal in ausführlicherer Form.

Technische Hinweise

  1. Der Paketname ist der Systemname (auch Ordnername) des Paketes, darf nicht länger als 64 Zeichen lang sein und darf nur aus Kleinbuchstaben, Zahlen und Unterstrichen bestehen. Andere Zeichen sind unzulässig!
  2. Der Pakettyp ist eine Zahl, die für den jeweiligen Pakettyp steht (Komponente = 1, Frontend-Template = 2). Die Einteilung in Typen ist wichtig, um die Erweiterungen in der Paketquelle unterscheiden zu können. Zudem muss in der Konfigurations-Datei des Paketes ("config.package.php") bei "package_type" dieser Typ korrekt angegeben sein!
  3. Die Paketversion ist die Version, die auch in der Konfigurations-Datei des Paketes bei "package_version" steht. Bei jeder Aktualisierung des Paketes wird die Version erhöht und muss auch in der Konfigurations-Datei geändert werden! Es wird bei "0.0.1" begonnen und bei einer Aktualisierung des Paketes wird hochgezählt ("0.0.2", "0.0.3", etc.).
  4. Die minimale CitusCMS-Version bezeichnet die CitusCMS-Framework-Version, die das Paket mindestens benötigt, um fehlerfrei zu funktionieren. Dieser Wert sollte sehr behutsam gewählt werden, da mit diesem Wert die Kompatibilitätsprüfung durchgeführt wird! In der Konfigurations-Datei des Paketes muss der Wert bei "minsystem_version" ebenso angegeben werden! Die CitusCMS-Version "0.7.0" ist der kleinste, mögliche Wert.

Jeder Erweiterungs-Autor ist für seine Erweiterung selbst verantwortlich, es wird keine Haftung für Erweiterungen in der Paketquelle übernommen! Bei groben Verstößen gegen diese Hinweise verweigert das CitusCMS-Team die Aufnahme eines Paketes in die Paketquelle, wenn der Erweiterungs-Autor diese nicht korrigiert. Ebenso kann das CitusCMS-Team Pakete aus der Paketquelle ausschließen, wenn grobe Verstöße begannen wurden! Dies sollte aber nur die Ausnahme darstellen.