Wo findet man was / Listen mit Funktionen und Parametern?

Hier finden sich Fragen und Ergänzung zur Dokumentation. // All questions and discussions about the documentation.
Antworten
Ben
Beiträge: 11
Registriert: 11.03.2012, 10:28:32

Wo findet man was / Listen mit Funktionen und Parametern?

Beitrag von Ben » 27.03.2013, 09:29:12

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
Beiträge: 410
Registriert: 16.08.2010, 22:14:54

Re: Wo findet man was / Listen mit Funktionen und Parametern

Beitrag von jprangenberg » 27.03.2013, 09:57:59

Ben hat geschrieben: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.
Ben hat geschrieben: 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
Beiträge: 11
Registriert: 11.03.2012, 10:28:32

Re: Wo findet man was / Listen mit Funktionen und Parametern

Beitrag von Ben » 27.03.2013, 10:30:41

Oh, eine dritte Anlaufstelle. Danke dir :)
...

jprangenberg
Beiträge: 410
Registriert: 16.08.2010, 22:14:54

Re: Wo findet man was / Listen mit Funktionen und Parametern

Beitrag von jprangenberg » 27.03.2013, 10:42:15

Ben hat geschrieben: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.

Benutzeravatar
dr.e.
Administrator
Beiträge: 4555
Registriert: 04.11.2007, 16:13:53

Re: Wo findet man was / Listen mit Funktionen und Parametern

Beitrag von dr.e. » 28.03.2013, 18:00:43

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.
Viele Grüße,
Christian

Ben
Beiträge: 11
Registriert: 11.03.2012, 10:28:32

Re: Wo findet man was / Listen mit Funktionen und Parametern

Beitrag von Ben » 28.03.2013, 20:15:00

dr.e. hat geschrieben: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 :)
...

Benutzeravatar
dr.e.
Administrator
Beiträge: 4555
Registriert: 04.11.2007, 16:13:53

Re: Wo findet man was / Listen mit Funktionen und Parametern

Beitrag von dr.e. » 28.03.2013, 20:56:47

Hilft dir den die Übersicht der Komponenten, die ich gepostet habe?
Viele Grüße,
Christian

Benutzeravatar
MrNiceGuy
Beiträge: 749
Registriert: 03.02.2009, 16:49:42
Wohnort: Nienburg / Weser

Re: Wo findet man was / Listen mit Funktionen und Parametern

Beitrag von MrNiceGuy » 21.06.2013, 09:02:54

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!?
There are only 10 Types of people in the world:
Those who understand binary and those who don't.

Benutzeravatar
dr.e.
Administrator
Beiträge: 4555
Registriert: 04.11.2007, 16:13:53

Re: Wo findet man was / Listen mit Funktionen und Parametern

Beitrag von dr.e. » 22.06.2013, 11:07:00

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.
Viele Grüße,
Christian

Antworten

Wer ist online?

Mitglieder in diesem Forum: 0 Mitglieder und 1 Gast