Wo findet man was / Listen mit Funktionen und Parametern?

[Ben]

Hi,

Wo findet man was?

wenn ich derzeit etwas suche geschieht das immer parallel auf der Website und im Wiki, weil ich im Wiki durchaus schonmal Hilfe fand und auf der Website eben nicht. Kann man das nicht trennen und Dokumentation komplett ins Wiki auslagern?

Die Website sollte anschließend allein der Präsentation (inkl. Download, Tests/Vergleiche usw.) und Publikation von Artikel(n) (-serien -> Tutorials / News) dienen. Was denkt Ihr?


Funktionslisten

Ich weiß aufgrund mangelnder Erfahrung mit Frameworks nicht ob es möglich ist, jedoch vermisse ich eine Funktions-Referenz ähnlich WP (http://codex.wordpress.org/Function_Reference). Es werden übersichtlich alle Funktionen (im Falle APFs Taglibs, Forms, usw.) aufgelistet und auf den jeweiligen Unterseiten (z.B. http://codex.wordpress.org/Function_Reference) eine Erklärung der Parameter und Anwendungsbeispiele geboten. Im Changelog könnte auf den (evtl. zukünftigen) Wiki-Eintrag der Migration gelinkt werden.


Was haltet Ihr davon? Würde natürlich einiges an Hirnschmalz und Zeit für eine Struktur kosten

[jprangenberg]

Hi,

Wo findet man was?

wenn ich derzeit etwas suche geschieht das immer parallel auf der Website und im Wiki, weil ich im Wiki durchaus schonmal Hilfe fand und auf der Website eben nicht. Kann man das nicht trennen und Dokumentation komplett ins Wiki auslagern?

Die Website sollte anschließend allein der Präsentation (inkl. Download, Tests/Vergleiche usw.) und Publikation von Artikel(n) (-serien -> Tutorials / News) dienen. Was denkt Ihr?

Das ist ein Wunsch den ich bereits seit Monaten habe. Scheint aber nicht der Wille von Christian zu sein.

Funktionslisten

Ich weiß aufgrund mangelnder Erfahrung mit Frameworks nicht ob es möglich ist, jedoch vermisse ich eine Funktions-Referenz ähnlich WP (http://codex.wordpress.org/Function_Reference). Es werden übersichtlich alle Funktionen (im Falle APFs Taglibs, Forms, usw.) aufgelistet und auf den jeweiligen Unterseiten (z.B. http://codex.wordpress.org/Function_Reference) eine Erklärung der Parameter und Anwendungsbeispiele geboten. Im Changelog könnte auf den (evtl. zukünftigen) Wiki-Eintrag der Migration gelinkt werden.


Was haltet Ihr davon? Würde natürlich einiges an Hirnschmalz und Zeit für eine Struktur kosten

http://files.adventure-php-framework.or ... tated.html

[Ben]

Oh, eine dritte Anlaufstelle. Danke dir

[jprangenberg]

Oh, eine dritte Anlaufstelle. Danke dir

Kein Problem! Mittlerweile "google" ich um die Dokumentation zu meinem APF-Thema zu finden. Hätte das auch lieber anders.

[dr.e.]

Das ist ein Wunsch den ich bereits seit Monaten habe. Scheint aber nicht der Wille von Christian zu sein.

"Wille" finde ich etwas zu hart formuliert. Es geht mir beim aktuellen Ansatz eher um Nachvollziehbarkeit hinsichtlich einer Version der Doku zu einer Version des Frameworks. Optimal ist das natürlich nicht, suboptimal wiederum aber auch nicht. Das Wiki ist derzeit als Ergänzung zur "offiziellen" Doku zu sehen.

Oh, eine dritte Anlaufstelle. Danke dir

Die generierte API-Dokumentation gehört zur offiziellen Dokumentation.

Ich weiß aufgrund mangelnder Erfahrung mit Frameworks nicht ob es möglich ist, jedoch vermisse ich eine Funktions-Referenz ähnlich WP (http://codex.wordpress.org/Function_Reference). Es werden übersichtlich alle Funktionen (im Falle APFs Taglibs, Forms, usw.) aufgelistet und auf den jeweiligen Unterseiten (z.B. http://codex.wordpress.org/Function_Reference) eine Erklärung der Parameter und Anwendungsbeispiele geboten. Im Changelog könnte auf den (evtl. zukünftigen) Wiki-Eintrag der Migration gelinkt werden.

Ich denke du suchst etwas wie die http://adventure-php-framework.org/Seit ... umentation. Sehe ich das richtig? Von dort kannst du dich in die einzelnen Bereiche navigieren und erhälst eine umfassende Prosa-Dokumentation. Als reine API-Übersicht ist die API-Dokumentation gedacht, die Jens auch schon gepostet hat.

Eine reine Funktionsübersicht wie bei WP ist aus meiner Sicht für das APF nicht adäquat, da das Framework einen objektorientierten Ansatz mit verschiedenen, zusammenspielenden Komponenten gewählt hat, wo du nicht einfach eine platte Liste von Funktionen aufschreiben kannst.

Solltest du noch etwas vermissen, gib mir Bescheid.

[Ben]

Eine reine Funktionsübersicht wie bei WP ist aus meiner Sicht für das APF nicht adäquat, da das Framework einen objektorientierten Ansatz mit verschiedenen, zusammenspielenden Komponenten gewählt hat, wo du nicht einfach eine platte Liste von Funktionen aufschreiben kannst.

Wenn eine Auflistung wie im WP Codex nicht möglich ist wird sich irgendwann bestimmt Zeit finden es zu sortieren oder was auch immer

[dr.e.]

Hilft dir den die Übersicht der Komponenten, die ich gepostet habe?

[MrNiceGuy]

Mal eine andere Idee: Besteht die Möglichkeit die Ansicht aus dem Doxygen als CHM-Datei zur Verfügung zu stellen? Ich glaube das wäre auch mal eine nette Alternative!?

[dr.e.]

Hallo Lutz,

das hatte ich in der Vergangenheit getan/versucht, war aber keine Gute Idee. Das Build dauert dadurch ungefähr doppelt so lange und bricht in 80% der Fälle ab, weil sich der CHM-Compiler aufhängt. Kannst' dir ja die ZIP-Datei herunterladen.