WebsiteBaker Support (2.8.x) > Diskussion über WB (closed)

Dokumentation / Hilfe zu Modulen

(1/3) > >>

Ralf Hertsch:
Hallo Leute,

wie Michael in einem anderen Thread richtig bemerkt hat, stellt jeder Modulautor ergänzende Informationen zu seinen Modulen auf die eine oder andere Weise zur Verfügung. Der Grund dafür ist, dass es keine entsprechende Regelung dafür gibt - entprechend schwierig ist es für die Anwender an die gewünschten Informationen zu gelangen. Dazu kommt vielleicht auch noch eine Sprachbarriere. Vielleicht gelingt es uns ja, eine bessere Lösung zu erarbeiten.

Meine Sicht:

Es beginnt damit, dass nach der Installation eines Moduls der Anwender das erste Mal alleine dasteht, wenn er z.B. wissen möchte wie er das Modul konfigurieren soll. Optimal wäre wohl: der Anwender klickt auf einen Link im Modulbackend und landet bei der allgemeinen Dokumentation zu diesem Modul und kommt bei Bedarf von dort aus weiter zu den relevanten Threads.

Realisieren läßt sich das über "Anlaufseite" für jedes einzelne Modul. Diese Seite enthält die Dokumentation oder einen externen Link. Eine solche Anlaufseite hätte noch eine Reihe von weiteren Vorteilen, so könnte Sie z.B. die Versionshistorie und den oder die eigentlichen Downloadlinks enthalten - Probleme wie beim Upgrade des Gästebuch wären dann passé. Eine solche Seite böte außerdem die Möglichkeit eine FAQ einzuführen und zu pflegen.

Was meint ihr dazu?

Gruß
Ralf

ruebenwurzel:
Hallo,

du sprichst da einen wichtigen und guten Punkt an. Davon ausgehend, dass die meisten WB user keine studierten Informatiker sind   :-D sollte es eine einfache Möglichkeit geben, an die Dokumentation der Module zu kommen. Das ist bisher total unterschiedlich gehandelt. Meine Vorstellungen gehen in folgende Richtung:

IM WB admin, dort wo die Module installiert werden (Erweiterungen) wird eine die unterste Zeile "Details zum Modul" dahingehend umgebaut, dass man über das dropdown direkt zu den Einführungsseiten (Hilfeseiten) für das Modul kommt. Damit kann der User das Modul installieren und sich auf der selben Seite gleich die Informationen (bevor er eine Seite anlegen muss wie bisher) holen wie es funktioniert ....

Wie diese Hilfeseiten aufgebaut sind (einfache einzeilige Erklärung bis zu mehrseitigen Abhandlungen) kann ja dann dem Modulentwickler bleiben.

Denselben Hilfe Link bekommt man dann auch, wenn man eine section mit dem Modul erstellt hat.

Die Hilfeseiten innerhalb des Moduls sollten dann im "languages" Verzeichnis liegen. Ob man sie direkt in die Sprachdateien (EN.php, DE.php ...) einbaut oder besser dort ne helpEN.php, helpDE.php .... sollte diskutiert werden.

Das ganze ist denke ich eine Sache, die man sich für WB 2.8 auf jeden Fall vornehmen muss. Wie auch immer die endgültige Lösung dann sein wird.

Matthias

Ralf Hertsch:
Hallo Matthias,


--- Quote ---IM WB admin, dort wo die Module installiert werden (Erweiterungen) wird eine die unterste Zeile "Details zum Modul" dahingehend umgebaut, dass man über das dropdown direkt zu den Einführungsseiten (Hilfeseiten) für das Modul kommt.
--- End quote ---

Das ist sicherlich der einfachste Weg: die info.php um einen Hinweis auf die Dokumentation ergänzen. Die info.php sollte dann allerdings sprachabhängig aufgebaut werden was bislang nicht üblich ist (warum eigentlich, frage ich mich gerade selbst???)


--- Quote ---Die Hilfeseiten innerhalb des Moduls sollten dann im "languages" Verzeichnis liegen. Ob man sie direkt in die Sprachdateien (EN.php, DE.php ...) einbaut oder besser dort ne helpEN.php, helpDE.php .... sollte diskutiert werden.
--- End quote ---

Auf keinen Fall direkt in die Sprachdateien, das würde diese unnötig aufblasen. Und auf keinen Fall in das /languages Verzeichnis - stell dir vor, der Autor und/oder die Übersetzer möchten Grafiken einbinden, die lägen dann alle in diesem Verzeichnis rum...

Wie wäre es mit einem Verzeichnis /help das Unterverzeichnisse für die jeweilige Sprache enthält, also z.B. /help/DE/ oder /help/EN/ und die Hilfedatei selbst heißt immer help.php?


--- Quote ---Das ganze ist denke ich eine Sache, die man sich für WB 2.8 auf jeden Fall vornehmen muss. Wie auch immer die endgültige Lösung dann sein wird.
--- End quote ---

Das können wir einführen, sobald wir uns einig sind und braucht nicht warten bis WB 2.8. Es wird ohnehin einige Zeit dauern bis alle Module umgestellt sind.


Gruß
Ralf

doc:
Hallo Ralf,

ab WB 2.7 ist die info.php sprachabhängig, die Module werden nach und nach upgedatet. Die in WB 2.7 vorinstallierten Module können das schon.

Nach dem Release von WB 2.7 wollen wir die Addons Seite (Templates/Module) überarbeiten. Wenn Du Lust und Zeit hast daran mitzuarbeiten, bitte melden.

Gruss Christian

Ralf Hertsch:
Hallo Christian,


--- Quote ---ab WB 2.7 ist die info.php sprachabhängig, die Module werden nach und nach upgedatet. Die in WB 2.7 vorinstallierten Module können das schon.
--- End quote ---

 :? Jetzt habe ich aber nicht schlecht aus der Wäsche geschaut. Warum werden denn die Sprachdateien nicht wie sonst eingebunden - Englisch ist nach wie vor hartcodiert? Das ist bei der Übersetzung schon sehr ungünstig, die wenigsten Übersetzer werden wissen, dass Sie $module_description zusätzlich aus der info.php einfügen und übersetzen müssen (schließlich ist die Ausgangsdatei für die Übersetzung die EN.php und in der ist $module_description erst gar nicht enthalten). Außerdem verhindert diese Lösung das Einfügen eines Sprachabhängigen Links auf die Hilfedatei (oder der Modulautor müsste den "Standard" direkt umbiegen).

Auch auf das Risiko mir den Vorwurf anzuhören "Du hättest ja mitarbeiten können" (es ging nun mal leider zeitlich nicht): Ich verstehe das nicht? Warum verwendet WB nicht die selbst gesetzten WB Standards? Warum schon wieder irgendwas Gestricktes, dass überhaupt nicht transparent ist?  :-P


--- Quote ---Nach dem Release von WB 2.7 wollen wir die Addons Seite (Templates/Module) überarbeiten. Wenn Du Lust und Zeit hast daran mitzuarbeiten, bitte melden.
--- End quote ---

Ganz laut und deutlich: Ja ich will.

Immer noch leicht irritiert und ratlos vor mich hinbrabbelnd...

Ralf

Navigation

[0] Message Index

[#] Next page