EStudy Wiki:FAQ-Link

Aus THM-Wiki
Wechseln zu: Navigation, Suche

Der FAQ-Link wird in der Fusszeile von eStudy angezeigt, wenn eine Webseite mit entsprechenden Hilfestellungen angegeben wurde.

Aufgabe

Der FAQ-Link soll eine Hilfestellung für neue Benutzer sein. Um diesem Anspruch gerecht zu werden, ist der Link immer entweder

  • Login-FAQ im Loginbereich,
  • Portal-FAQ im Foyer oder
  • Kurs-FAQ wenn man in einem Kurs agiert

Login-und Portal-FAQ können in den Einstellungen des Administrators definiert werden. Ausserdem kann festgelegt werden, ob sie die FAQ im eigenen Fenster öffnen soll, im selben oder im IFrame angezeigt wird.

Die Kurs-FAQ ist kursspezifisch und kann in den Einstellungen zum Kurs festgelegt werden. Für längerfristig gepflegte Kurs-FAQs besteht auch die Möglichkeit, diese in einer Kursvorlage einzustellen, so dass die FAQ bei Wiederholung der Veranstaltung im nächsten Semester übernommen werden kann. Wenn keine Kurs-FAQ definiert ist, wird -wenn vorhanden- die eStudy-FAQ eingeblendet.

Die FAQs werden lediglich als URL hinterlegt, es empfielt sich eventuell der Einsatz eines Tools wie phpMyFAQ zur Verwaltung. Ein Verweis in dieses Wiki ist natürlich auch möglich.

Vorgehensweise

Der relativ kleine Umfang ermöglichte eine Aufteilung in Vorbereitung (im Prinzip Refactoring, das trifft hier aber nicht den Kern) und Implementierung. Die wesentliche Infrastruktur war vorhanden: Zentrale Admin-Einstellungen, eine Sauber gegliederte Fusszeile, und ein DAL für Kursdaten.

Vorbereitung

Der DAL für Kursinformationen wurde um die Zugriffsmethodik für die neu eingeführte Tabellenspalte 'faqurl' erweitert. Um die Ausgabe der Links zu vereinheitlichen, wurde die Funktion echoFAQLink eingeführt, die mit ihrer Fähigkeit, die Link-und Trennerausgabe bei leerer URL komplett zu unterdrücken, einiges an fehleranfälliger Detailarbeit erspart.

Implementierung

In der Datei footer.inc.php ist der Fusszeilenbereich implementiert. Die Ausgabe des Links folgt der Unterscheidungslogik, die von den drei FAQ-Arten (siehe oben) erfordert wird. Die Logik ist in der Klasse FAQLink implementiert.

Das hinzufügen von Einstellungen für den Kurs wird in der course.settings.php gemacht. Auch hier gilt, das die vorhandene Infrastruktur absolut ausreichend war und das Hinzufügen problemlos gelang.

Die Einstellungen für den Admin, also Portal-FAQ und Login-FAQ, sind einfach in einem Array hinzuzufügen und in der Datenbank in der Tabelle settings zu hinterlegen. Optional kann eine Help-Id vergeben werden, was auch genutzt wurde.

Die Kursvorlagen zu erweitern funktioniert sehr ähnlich, es wird eine Id vergeben, die im Beispiel die CA_FAQ_URL = 9 identifiziert. Dann kann man den Dialog anpassen, die Datenvalidierung, das Speichern und die übernahme in einen bestehenden Kurs.

Aus Wunsch wurde noch das Anzeigen in IFrames hinzugefügt, wofür die Dateien infos/faq.php und courses/faq.php zuständig sind. Letztere muss als Modul registriert sein, um die FAQ anzeigen zu können.

Abschluss

Die Änderungen wurden im November/Dezember 2006 im Branch MSP-Passwords durchgeführt, der später in IAT mündete. Das Migrationskript befindet sich im entsprechenden Forum des Kurses MSP WS 06/07.

-- Simon Thum