Dokumentation - Entwicklung
Zugriff auf den aktuellen Entwicklungsstand (Versionskontrollsystem)
Die Entwicklung von COM.ON arbeit mit dem Versionskontrollsystem Subversion.Der Lesezugriff ist für jeden frei zugänglich!
D.h. um den aktuellen Entwicklungsstand einsehen zu können, wird ein Programm benötigt, dass die Versionskontrolle "Subversion" unterstützt.
URL zum Subversionserver: https://comon.svn.sourceforge.net/svnroot/comon
Der aktuelle Hauptentwicklungsbaum heißt in Subversion üblicher Art "trunk".
Wir empfehlen folgende Programme für den Zugriff auf das Subversion Repository:
Entwicklungsumgebung: Eclipse
Subversion-Plugin für Eclipse: Subclipse
PHP-Erweiterung für Eclipse: Eclipse Development Tools - PDT von Zend
Fragen oder Probleme können natürlich gerne im COM.ON Forum geklärt werden.
Vorlage für eigenes Modul (ZIP)
Das Modul "mod_EXAMPLE" kann als Vorlage für ein eigenes Modul verwendet werden.Um ein eigenes Modul zu schreiben, entpackt die ZIP-Datei, kopiert das entpacke Verzeichnis in das "mod/"-Verzeichnis von eurer Installation, in der ihr entwickeln wollt.
Im Verzeichnis liegt die Datei "readme_usagt.txt" - sie erklärt was, ersetzt werden muss, um die Basis für ein eigenes Modul zu schaffen.
Wichtig: Bevor ihr eurem Modul einen Namen gebt, überprüft auf der "Modul registrieren"-Seite, ob der Modulname noch frei ist. Sobald ihr einen freien Namen/Bezeichnung habt, könnt ihr es dann registrieren, um die Modul-ID ($MOD_ID) zu erhalten, die dafür notwendig ist.
Noch ein Tipp: Achtet unbedingt darauf, dass ihr immer mit der aktuellsten Version entwickelt.
Das Modul als ZIP-Datei zum Download:
Modul "mod_EXAMPLE" downloaden (ZIP)Fragen oder Probleme können natürlich gerne im COM.ON Forum geklärt werden.
WICHTIG - Regeln für sicheres und performantes Programmieren:
Diese Regeln mit Erklärungen und Beispielen sind Grundregeln für die Entwicklung von Programmcode bei COM.ON. Besonders der Aspekt des sicheren Programmierens wird hier erklärt. Für jede Regel wird außerdem immer der Grund erklärt.
Download: als Openoffice Dokument (ODT) | als PDF
Informationen zu Screencasts
Wenn Sie ein Modul entwickelt und registriert haben, ist es natürlich immer wünschenswert ein Tutorial in Form eines Screencasts erstellen. Gegenüber eines normalen textbasierten Tutorials hat dies den Vorteil, dass der Benutzer genau sieht was am Monitor geschieht und es zeitgleich auf dem eigenen System nachvollziehen kann. Zudem wird allgemein recht ungern am Bildschirm gelesen, sodass viele einfach drauflos probieren ohne sich näher mit der Materie vertraut gemacht zu haben.
Als Tool zum Erstellen von Screencasts verwenden wir die Software Wink.
Die Software ist kostenlos, steht für Linux und Windows bereit und kann unter http://www.debugmode.com/wink/ heruntergeladen werden.
Unter http://www.debugmode.com/userforums/viewforum.php?f=34 steht Ihnen zudem ein Wink-User-Forum zur Verfügung, in dem evtl. einige Fragen schon beantwortet wurden. Das Forum ist allerdings rein englisch-sprachig.
Desweiteren enthält Wink ein relativ ausführliches Benutzerhandbuch ('Hilfe > Benutzerhandbuch') im PDF-Format. Dieses ist leider ausschliesslich in Englisch verfügbar. Unter 'Hilfe' finden Sie zudem 2 Screencast-Tutorials, die das Erstellen von Screencasts in Wink zeigen.
Informationen zu Screencasts allgemein:
http://www.screencasting.de/
http://de.wikipedia.org/wiki/Screencast
In einem Dokument haben wir Vorgaben zum Erstellen eines Screencasts für Modul-Entwickler zusammengefasst.
Download: als Openoffice Dokument (ODT) | als PDF
Desweiteren haben wir ein ZIP-Archiv zusammengestellt, das Vorlagen-Dateien zum Erstellen eines Screencast-Tutorials enthält.
Download: ZIP-Archiv
