Forum Sefrengo.org > Anleitung Module veröffentlichen

Vollansicht: Anleitung Module veröffentlichen

mistral

Wed. 28. June 2006, 21:23

Diese Leitlinie stellt eine Möglichkeit dar, wie Module veröffentlicht werden sollten.
Es ist sehr erwünscht, das sich Modulbauer an diese Leitlinie halten. Kommentare und Verbesserungsvorschläge erwünscht.

Allgemeines

# Ein Modul wird grundsätzlich als *.zip Datei veröffentlicht.
# Der Name der Zipdatei ergibt sich aus Modulnamen und Version des Moduls, jeweils getrennt mit Unsterstrichen (Modulname_vXX_XX_XX.zip).
# Die Versionsnummer ergibt sich aus einer Folge von drei, jeweils zweistelligen Ziffernfolgen. Die erste Folge gibt die Hauptversionsnummer an, die zweite Ziffernfolge die Unterversion und die dritte Ziffernfolge steht für sehr kleine Veränderungen oder Bugfixes. So würde das zip- Archivs des Moduls Druckversion in der Version 1.3.1 den Archivnamen "Druckversion_v01_03_01.zip" bekommen.
# Innerhalb der *.zip Datei sind grundsätzlich mindestens drei Dateien enthalten. Das sind readme.txt (allgemeine Informationen zum Modul), changelog.txt (Versionshistorie mit Listung der Veränderungen) und das eigentliche Modul als *.cmsmod Datei.
# Readme und Changelog folgen Konventionen die weiter unten näher definiert sind
# Die "changelog.txt" ist chronologisch von "neu" nach "alt" aufgebaut. Neuste Änderungen erscheinen als Erstes, damit oben in der Datei.
# Das *.cmsmod- Modul hat den selben Namen, wie das zip- Archiv. In unseren Druckversionbeispiel wäre das "Druckversion_v01_03_01.cmsmod"
# Bei der Veröffentlichung im Forum ist im Betreff der Modulname und die Modulversion anzugeben

In welchem Forum posten
Stable-Versionen sollten im entsprechenden Forum "Module", "Plugins" oder "Hacks" der jeweiligen Sefrengo-Version gepostet werden.
Beta-, Alpha- oder andere Unstable-Versionen sollten im Forum "Alpha, Beta ... Vorabversionen" gepostet werden.
Veraltete Stable-Versionen bitte ins Archiv verschieben oder die Forum-Admins dazu auffordern.

Aufbau der Datei "readme.txt"

QUELLTEXT

Modulname:
---------------------------------------------------------------------------
Name des Moduls

Status:
---------------------------------------------------------------------------
Status des Moduls, mögliche Werte sind:
stable  - das Modul ist für den produktiven Einsatz geeignet und getestet
beta    - das Modul ist weitgehend fertig und getestet. Bis zu einer stabilen
          Version wird es nur noch kleinere Änderungen/ Bugfixes geben. Das
          Modul ist unter vorbehalt produktiv einsetzbar.
alpha   - das Modul befindet sich in Entwicklung. Es ist noch mit massiven
          Änderungen zu rechenen. Das Modul ist weitgehend ungetestet. Es
          ist nicht für den produktiven Einsatz geeignet
broken  - das Modul funktioniert nicht.

Bechreibung:
---------------------------------------------------------------------------
Kurze Beschreibung des Moduls. Es soll mit wenigen Sätzen ersichtlich
werden, wofür das Modul benutzt werden kann.

Features:
---------------------------------------------------------------------------
Stichpunktartige Listung der wichtigsten Merkmale des Moduls
- Feature 1
- Feature 2
.
.
.

Autor(en):
---------------------------------------------------------------------------
Listung der einzelnen Autoren
Autor 1
Autor 2
.
.
.

Lizenz:
---------------------------------------------------------------------------
Kurze Angabe über die Lizenz, die für das Modul gilt (zb. GPL, LGPL,
FREE BSD...

Benötigte Sefrengo Version:
---------------------------------------------------------------------------
>= 01.91.00 (Sefrengo 1.2 alpha2)

Installation:
---------------------------------------------------------------------------
Beschreibung der Installation. Im einfachsten Falle wäre das:
Wechseln Sie in Ihrer Sefrengo Version in den Bereich "Design->Module". Am
unteren Ende des Bereichs befindet sich ein Uploadfeld. Wählen Sie hier die
gewünschte "*.cmsmod"- Datei aus. Mit einem Klick auf das Diskettensymbol
wird das Modul in das CMS importiert. Das Modul ist nun innerhalb des CMS
nutzbar.

Update/ Migration:
---------------------------------------------------------------------------
Falls notwendig, Informationen, was bei einem Update zu beachten ist.

Dokumentation:
---------------------------------------------------------------------------
Dokumentation oder verweis auf die Moduldokumentation. Wenn keine
Dokumentation vorhanden ist, hinweis "Keine vorhanden"

Aufbau der Datei "changelog.txt"

QUELLTEXT

Changelog legend:
# -> Bug Fix
+ -> Addition
^ -> Change
- -> Removed
! -> Note

Current versionnumber is XX.XX.XX - released DD.MM.YYYY
------------------------------------------------------------------------------------------------
+ add feature ...
# fix bug ...

Anbei alle Vorlagendateien als *.zip Archiv.

MaZderMind

Tue. 28. November 2006, 00:45

Im Template für die Datei readme.txt fehlt die Versionsangabe.

Gruß, Peter

bjoern

Tue. 28. November 2006, 01:32

Die habe ich da extra nicht reingeschrieben, den die Information kann dem Changelog entnommen werden. So muß bei einem Update eines vorhandenen Moduls nur eine Datei angepasst werden.

MaZderMind

Tue. 28. November 2006, 07:18

Okay dann wird ich das in Zukunft rauslassen *g*

Gruß, Peter

Dieses ist eine vereinfachte Darstellung unseres Foreninhaltes. Um die detaillierte Vollansicht mit Formatierung und Bildern zu betrachten, bitte hier klicken.