xForm als Addon besser dokumentieren ...

Alles über die Anwendung und Entwicklung von AddOns.

xForm als Addon besser dokumentieren ...

Beitragvon ovo » 25. Nov 2011, 11:52

Ich bin der Meinung, dass die xForm als Addon - im Verhältnis zu deren Bedeutung - viel zu schlecht dokumentiert ist. Grundsätzlich funktioniert das Addon für mich super, will ich aber ein bisschen etwas spezielles damit anstellen, finde ich mich immer wieder grübelnd und suchend im Quellcode der Actions, Values etc. (die leider nicht selten etwas buggy sind - hätte auch ein paar Beispiele dafür).
Am Ende artet es oft in eine lange, ärgerliche Probiererei aus ...

z.B. getDescription gibt zwar die Parameter zurück, oft aber keinen Aufschluss, was man von der Fuktion zu erwarten hat. Und das Lesen des Quellcodes kostet enorm Zeit.

Langer Rede kurzer Sinn: Wie könnte man ein Projekt starten die xForm zu dokumentieren und Bugs zu entfernen? Zudem könnte man ein eigenes Plugin eröffnen, welches benutzerspezifische Actions, Values etc. enthalten kann.

Zudem fände ich es in Anbetracht der Anzahl der Einträge sinnvoll eine eigene Section für xform im Forum zu eröffnen.

Was meint Ihr?
LG
Stefan
ovo
 
Beiträge: 40
Registriert: 13. Okt 2010, 11:56

Re: xForm als Addon besser dokumentieren ...

Beitragvon Xong » 25. Nov 2011, 12:51

Hi!

Ein eigenes Subforum finde ich nicht unbedingt notwendig.

Mit der Dokumentation hast du nicht nur recht, sondern dir gerade auch die Initiativstrafe eingehandelt. :twisted:

Was du mit dem Plugin für spezielle Klassen meinst, verstehe ich nicht so wirklich. Ein allgemeines Plugin wird es nicht geben, weil allgemeine Klassen, in die Standardverzeichnisse kommen. Wenn du aber oft eigene Klassen verwendest, kannst du dir ja solch ein Plugin zurechtlegen.

Für die Beseitigung von Bugs solltest du Github verwenden. Dort findest du XForm für Redaxo 4 und XForm für Redaxo 5.
LG,
Xong

Bild Määääääääääääääääääääääääh!
Benutzeravatar
Xong
 
Beiträge: 1560
Registriert: 5. Jun 2008, 07:30
Wohnort: Hohndorf in Sachsen

Re: xForm als Addon besser dokumentieren ...

Beitragvon Markus.Lorch » 25. Nov 2011, 14:23

Nebenbei gesagt, kann man eigene xform Klassen die bei einem eigenen AddOn mitgeliefert werden zum beispiel so "einhängen" (was viel schöner als ein extra Plugin ist):


$REX['ADDON']['xform']['classpaths']['value'][] = $REX["INCLUDE_PATH"]."/addons/deinaddon/xform/value/";
$REX['ADDON']['xform']['classpaths']['action'][] = $REX["INCLUDE_PATH"]."/addons/deinaddon/xform/action/";
$REX['ADDON']['xform']['classpaths']['validate'][] = $REX["INCLUDE_PATH"]."/addons/deinaddon/xform/validate/";


Das reicht. Den Rest macht das xform Addon selbst. Dadurch werden alle Klassen die sich in diesen Ordnern befinden reingenommen.
Grüße,
Markus Lorch

Tschüssle sagt Herr Nüssle
Benutzeravatar
Markus.Lorch
 
Beiträge: 634
Registriert: 21. Okt 2007, 16:22
Wohnort: Walheim

Re: xForm als Addon besser dokumentieren ...

Beitragvon ovo » 25. Nov 2011, 15:09

Markus.Lorch hat geschrieben:Nebenbei gesagt, kann man eigene xform Klassen die bei einem eigenen AddOn mitgeliefert werden zum beispiel so "einhängen" (was viel schöner als ein extra Plugin ist):

$REX['ADDON']['xform']['classpaths']['value'][] = $REX["INCLUDE_PATH"]."/addons/deinaddon/xform/value/";
$REX['ADDON']['xform']['classpaths']['action'][] = $REX["INCLUDE_PATH"]."/addons/deinaddon/xform/action/";
$REX['ADDON']['xform']['classpaths']['validate'][] = $REX["INCLUDE_PATH"]."/addons/deinaddon/xform/validate/";

Das reicht. Den Rest macht das xform Addon selbst. Dadurch werden alle Klassen die sich in diesen Ordnern befinden reingenommen.

Das mache ich bereits so und ist eine feine Sache. Ich dachte da an ein Addon, wo interessante Actions etc. von verschiedenen Usern gesammelt werden - ohne alle in den "xform-Core" zu integrieren - war nur so eine Idee - ist auch nicht sooo wichtig.
LG
Stefan
ovo
 
Beiträge: 40
Registriert: 13. Okt 2010, 11:56

Re: xForm als Addon besser dokumentieren ...

Beitragvon Markus.Staab » 25. Nov 2011, 16:55

Hi Stefan,

Jan wird sich sicher ueber deine hilfe freuen,... Forke des Projekt auf github und stelle PullRequests ein, dann kannst du da sehr einfach etwas beitragen.

Die urls dazu hat dir ja xong bereits oben gepostet,..

Hilfe zu github gibts unter
http://help.github.com/

Gruß Markus
Benutzeravatar
Markus.Staab
Entwickler
 
Beiträge: 9781
Registriert: 29. Jan 2005, 14:50
Wohnort: Aschaffenburg/Germany


Zurück zu AddOns [R4]

Wer ist online?

Mitglieder in diesem Forum: 0 Mitglieder und 2 Gäste