Dokumentation, Widgets usw

Hallo zusammen,

sorry, dass ich schon wieder fragen muss, aber die Ressourcen, die ich finde, sind extrem verstreut/unklar formuliert oder für alte Versionen.

Ich möchte ein Theme umbauen und gehe vom Azure Theme als Basis aus. Der Code ist alles andere als gut Dokumentiert (gar nicht) und dadurch ist vieles unklar.

Ich suche eine [B]vollständige[/B] Dokumentation zum Erstellen von Themes. Ich möchte z.B. wissen, welches Template überhaupt als erstes geladen wird, damit ich nachverfolgen kann, was in welcher Reihenfolge passiert.

Momentan sehe ich auch überall in den Templatedateien einen Funktionsaufruf “oxid_include_widget”. Ich möchte wissen, was dieser Funktionsaufruf tut, welche widgets zur Verfügung stehen und ob/wo ich eigene Widgets hinzufügen kann bzw. wofür ich sie brauche. Da ich im Wiki eine Fehlermeldung bei Benutzung der SuFu bekomme und Google mir zu “oxid_include_widget” nur http://wiki.oxidforge.org/Tutorials/widgets_in_4.7_%2B_5.0 und http://wiki.oxidforge.org/Tutorials/widgets_from_4.8_5.1 bzw. einige Forenartikel hier ausgibt, die allesamt voraussetzen, dass man weiß, was ein widget in Oxid ist und wie man es einsetzt, komme ich nicht weiter.

Auch wäre eine Übersicht, welche Templatedatei wofür gebraucht wird, äußerst hilfreich. Bei einigen ist es recht offensichtlich (z.B. layout/footer.tpl), bei anderen eher nicht. Ich kann ja schlecht am HTML und CSS schrauben, wenn ich nicht weiß, wo dieser Codeabschnitt überhaupt herkommt. Das wäre alles nicht so dramatisch, wenn die inline-doku des Themes den Code erklären würde, aber bisher habe ich nicht einen einzigen Kommentar im Template-Code entdeckt.

Zwar kann man [{debug}] sich alle Variablen ausgeben lassen, diese sind aber dann auch nicht erklärt. Insbesondere auch hier wäre eine kurze Erklärung zu den einzelnen Variablen wichtig, damit verständlich wird, was man machen kann.

Ich arbeite zugegebenermaßen noch nicht lange im Bereich Anwendungsentwicklung, aber das aller erste, was mir sozusagen als “1. Gebot” vermittelt wurde: “Dokumentiere deinen Code!”. Einmal im Code selbst über Kommentare und ein mal als ein Dokument, Wiki oder Ähnliches. Ein Wiki gibt es zwar, lässt aber viele Fragen offen (siehe oben) und die SuFu meldet mir nur, ich hätte keine Editierrechte (will ich ja auch nicht, ich will suchen). Ich kann mir beim besten Willen nicht vorstellen, dass es sowas für den Teilbereich Themes von Oxid nicht gibt.

Ich entschuldige mich, wenn das hier nun “aggressiv” rüberkommt, ich will hier niemanden an den Karren pinkeln. Ich bin derzeit nur extrem frustriert, weil ich seit über 16 Stunden Beschäftigung nur mit den Themes keine nennenswerten Fortschritte machen konnte, obwohl ich mit Smarty und PHP schon viel gearbeitet habe, und wäre daher für Hilfe äußerst dankbar.

Vielleicht hilft Dir dies mal etwas weiter:

http://tarkka.ch/oxid_tpl_debug/

Die zwei Bücher die auf dem Markt sind, helfen auch weiter.

Danke schonmal für den Link. Der hilft auf jeden Fall.

Bücher stehen mir leider nicht zur Verfügung. Wie gesagt muss es doch irgendwo eine Doku geben. Das wäre das erste OSS-Projekt, mit dem ich zu tun habe, wo das nicht der Fall wäre.

Ich kann nachempfinden, wie du dich fühlst, genau das habe ich auch durchgemacht.

Und ich kann dir nur raten, dran zu bleiben und alles zu hinterfragen und selbst zu notieren. Ich habe wieder lange nichts mehr gemacht und fühle mich wieder wie du :wink:

Das erste der beiden Bücher brauchst du nicht, das Zweite ist etwas dünn geraten…

Gesendet von meinem iPhone mit Tapatalk